PHPackages pion/laravel-support-eloquent - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Database & ORM](/categories/database) 4. / 5. pion/laravel-support-eloquent ActiveLibrary[Database & ORM](/categories/database) pion/laravel-support-eloquent ============================= Package with small support traits and classes for the Laravel Eloquent models v1.4.2(4y ago)36.6k↓50%2[1 PRs](https://github.com/pionl/laravel-support-eloquent/pulls)MITPHP Since May 4Pushed 1y ago1 watchersCompare [ Source](https://github.com/pionl/laravel-support-eloquent)[ Packagist](https://packagist.org/packages/pion/laravel-support-eloquent)[ RSS](/packages/pion-laravel-support-eloquent/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (10)Dependencies (1)Versions (19)Used By (0) Laravel's Eloquent support package ================================== [](#laravels-eloquent-support-package) Contains a set of traits for the eloquent model. In future can contain more set of classes/traits for the eloquent database. Installation ------------ [](#installation) ``` composer require pion/laravel-support-eloquent ``` Attribute value altering traits ------------------------------- [](#attribute-value-altering-traits) Set of traits that will change the attribute value. ### CleanHTMLFromAttributeTrait [](#cleanhtmlfromattributetrait) Enables automatic attribute value cleaning from HTML for all attributes, by limiting only desired by `$cleanAttributes`property or by limiting which attributes can have html `$dontCleanAttributes`. You can use the `$stripHtmlTags` property to specify tags which should not be stripped. For manual usage use `CleanHTMLTrait` with `tryToCleanAttributeValue($key, $value)` method. #### Null only given attributes: [](#null-only-given-attributes) ``` public $cleanAttributes = [ "name" ]; ``` #### Don't null provided attributes: [](#dont-null-provided-attributes) ``` public $dontCleanAttributes = [ "name" ]; ``` ### NullEmptyStringAttributeTrait [](#nullemptystringattributetrait) Enables the automatic nulling of empty string value (like from post or set). You can provide list of columns keys to allow only specified columns (use `$nullEmptyAttributes`) to be set to null or you can provide a list of columns keys to ignore while trying to null the value (use `$dontNullEmptyAttributes`). They can be set in construct or as property. For manual usage use `NullEmptyStringTrait` with `tryToNullAttributeValue($key, $value)` method. #### Null only given attributes: [](#null-only-given-attributes-1) ``` public $nullEmptyAttributes = [ "name" ]; ``` #### Don't null provided attributes: [](#dont-null-provided-attributes-1) ``` public $dontNullEmptyAttributes = [ "name" ]; ``` ### NormalizeFloatAttributeTrait [](#normalizefloatattributetrait) Converts float string to float value with comma support (floatval fails to convert 13,3 to 13.3) by setting list of attributes via `$normalizeFloatAttributes`. ``` public $normalizeFloatAttributes = [ 'price', 'discount', ]; ``` For manual usage use `NormalizeFloatTrait ` with `tryToNormalizeFloatAttributeValue($key, $value)` method. ### DateAttributeValueTrait [](#dateattributevaluetrait) Converts allowed attributes (by settings `$dateAttributes`) to carbon instance without any format limitation. Tries to parse any format. ``` public $dateAttributes = ['custom_date']; ``` For manual usage use `DateAttributeTrait` with `tryToConvertAttributeValueToDate($key, $value)` method. All values are converted via `toArray` method to default format. You can customize date formats by attribute by setting `dateFormats`: ``` public $dateFormats = [ 'born' => 'Y-m-d' ]; ``` ### Running multiple trait functions [](#running-multiple-trait-functions) #### Using all attributes traits [](#using-all-attributes-traits) To apply all traits that are currently implemented use `AlterAttributeValueTrait`. #### Manual [](#manual) Unfortunately traits can't override same method (in this case `setAttribute`). For this purpose, you must override the `setAttribute`method by your self and call the desired trait method by your self. Every trait has own **manual** method that tries to alter the value. Use appropriate trait (`NullEmptyStringTrait`, `CleanHTMLTrait`, etc). For chaining the value you can use helper function `alter_attribute_value`. ``` /** * Set a given attribute on the model. * * @param string $key * @param mixed $value */ public function setAttribute($key, $value) { parent::setAttribute($key, alter_attribute_value($key, $value, $this, [ 'tryToCleanAttributeValue', 'tryToNullAttributeValue' ])); } ``` Relation Traits --------------- [](#relation-traits) ### RelationJoinTrait [](#relationjointrait) Enables to create a join SQL statement that will construct the relation model and stores it into relations (so you don't need to eager load the relation). The model is created from the relation function (the key you provide). You can create a custom aliases to fix custom relation naming. In default usage will load all columns from schema, for better perfomance you can provide a set of columns to load from the relation. You can't provide a '\*' as column. `$relationAliases` - A list of relations that has different method name than the table. Can be defined in model like this: ``` protected $relationAliases = [ "activity_type" => "type" ]; ``` Then you can call it in standard way `modelJoin("type")` for a ActivityType model class. #### Example [](#example) The basic method support custom columns, where condition, join operator and join type. ##### All columns [](#all-columns) ``` Model::modelJoin("type")->get() ``` ##### Desired columns (recommended) [](#desired-columns-recommended) ``` Model::modelJoin("type", ["name", "id", "color"])->get(); ``` Then you can get the object by standard relation way: ``` $model->type->color ``` But be carefull, can be null (default is LEFT connection)! ##### Desired columns with inner join [](#desired-columns-with-inner-join) ``` Model::modelJoin("type", ["name", "id", "color"], "inner")->get(); ``` ##### Method [](#method) Docs is provided in code. ``` modelJoin($query, $relation_name, $operatorOrColumns = '=', $type = 'left', $where = false, $columns = array()) ``` #### Advanced example [](#advanced-example) Docs is provided in code. Uses table as a relation function. ``` joinWithSelect($query, $table, $one, $operatorOrColumns, $two, $type = "left", $where = false, $columns = array()) ``` ### RelationCountTrait [](#relationcounttrait) Enables to count a related models. In future will prepare better docs. #### Example [](#example-1) Usage of where: ``` $count = $model->relationCountWithWhere("user_permission", "user_id", $user, "App\\Models\\User"); ``` Calling the function again will use the cache in relations array. After this call you can also use ``` $model->user_permission_{ForeignKey}_{userIdValueForWhere} which will the object of User model with count attribute. ``` You can also get the where index by passing variable which will be overided by the reference: ``` $index = "user_permission"; $model->relationCountWithWhere($index, "user_id", $user, "App\\Models\\User"); ``` Simple call will return count and the index will be stored in $model->user ``` $model->relationCount("user", "App\\Models\\User") ``` ### Health Score 40 — FairBetter than 88% of packages Maintenance32 Infrequent updates — may be unmaintained Popularity27 Limited adoption so far Community12 Small or concentrated contributor base Maturity72 Established project with proven stability Bus Factor1 Top contributor holds 78.6% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~156 days Recently: every ~290 days Total 17 Last Release 1161d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/ad0f2a11e630f5f386cb8544d42f0c56c2b89258172dae581a33dddcc5de1d83?d=identicon)[pionl](/maintainers/pionl) --- Top Contributors [![pionl](https://avatars.githubusercontent.com/u/1878831?v=4)](https://github.com/pionl "pionl (22 commits)")[![jakubdibala](https://avatars.githubusercontent.com/u/7672104?v=4)](https://github.com/jakubdibala "jakubdibala (5 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (1 commits)") --- Tags eloquenthtmlhtml-cleanerlaravellaravel-5-packagenullablerelational-modeltrait ### Embed Badge ![Health badge](/badges/pion-laravel-support-eloquent/health.svg) ``` [![Health](https://phpackages.com/badges/pion-laravel-support-eloquent/health.svg)](https://phpackages.com/packages/pion-laravel-support-eloquent) ``` ### Alternatives [owen-it/laravel-auditing Audit changes of your Eloquent models in Laravel 3.4k33.0M95](/packages/owen-it-laravel-auditing)[staudenmeir/eloquent-json-relations Laravel Eloquent relationships with JSON keys 1.1k5.8M24](/packages/staudenmeir-eloquent-json-relations)[bavix/laravel-wallet It's easy to work with a virtual wallet. 1.3k1.1M11](/packages/bavix-laravel-wallet)[dragon-code/migrate-db Easy data transfer from one database to another 15717.4k](/packages/dragon-code-migrate-db)[gearbox-solutions/eloquent-filemaker A package for getting FileMaker records as Eloquent models in Laravel 6454.8k2](/packages/gearbox-solutions-eloquent-filemaker)[cybercog/laravel-ownership Laravel Ownership simplify management of Eloquent model's owner. 9126.6k3](/packages/cybercog-laravel-ownership) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)