PHPackages alnutile/entity\_decorator - 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. [Utility & Helpers](/categories/utility) 4. / 5. alnutile/entity\_decorator ActiveLibrary[Utility & Helpers](/categories/utility) alnutile/entity\_decorator ========================== A Drupal 7 Module to beautifully decorate your entities. 09PHP Since Jun 24Pushed 11y agoCompare [ Source](https://github.com/alnutile/entity_decorator)[ Packagist](https://packagist.org/packages/alnutile/entity_decorator)[ RSS](/packages/alnutile-entity-decorator/feed)WikiDiscussions master Synced 1mo ago READMEChangelogDependenciesVersions (1)Used By (0) entity decorator ================ [](#entity-decorator) A Drupal 7 Module to beautifully decorate your entities. Packagist is here [https://packagist.org/packages/alnutile/entity\_decorator](https://packagist.org/packages/alnutile/entity_decorator) Preamble -------- [](#preamble) Tired of typing code with deep nested arrays like this to work with your fields? ``` $item_id = $node->{$this->field_name}[LANGUAGE_NONE][0]['value']; ``` Of course you are, so you use the [Entity API](https://drupal.org/project/entity). Which is an improvement but you may find yourself typing `entity_metadata_wrapper` a lot! ``` $wrapper = entity_metadata_wrapper('node', $node); ``` You also may get the urge to want to treat your entities as objects and extend them with your own custom methods. Entity decorator is designed to allow you to create decorator objects for any entity or node type, and presents them with a beautiful, concise interface. It also creates a new interface to querying for entities and node types which, hopefully, is more concise and intuitive. A common use case may be you want to create custom entity types with [ECK](https://drupal.org/project/eck) but then create custom methods for those types based on the fields and properties you have created. Entity decorator should work equally well with custom entities and node types, whichever you prefer to decorate. Usage ----- [](#usage) Install and update composer using [composer\_manager](https://www.drupal.org/project/composer_manager) Creating the decorator class is simple. Create a class like this. ``` use EntityDecorator; class MyDecoratedNodeType extends EntityDecorator { static public $entityType = 'node'; static public $bundle = 'my_node_type'; } ``` And that's it. All the entity decorator goodness is immediately available provided by your new class! Plus, you can add any custom methods to your class that you like. Now you can write code like this: ``` $node = new MyDecoratedNodeType(); $node->set_title('The title'); $node->set_field_my_custom_field('My value'); $node->callACustomMethod(); $node->save(); ``` Wasn't that concise? Not a deep nested array or entity\_metadata\_wrapper invocation in site. **Note**: a bit of metaprogramming magic creates some of those methods. Calling `set_*` or `get_*` will act as a get or setter to any property OR field. Entity decorator abstracts the distinction between properties and fields away for most purposes. As this implements the [decorator pattern](http://en.wikipedia.org/wiki/Decorator_pattern) you still have access to all your entity's properties and methods as if your decorator class was the instance it wraps. Relations and references ------------------------ [](#relations-and-references) If you have a field that is a reference to an entity, then Entity Decorator returns the entity as expected if you call ``` $node->get_field_my_entity(); ``` or ``` $node->get('field_my_entity'); ``` If the entity you are getting also has an entity\_decorator class to wrap it, you can call ``` $node->getDecorated('field_my_entity', 'class_name_that_decorates_it'); ``` And you will be returned the decorated entity. This also works on arrays of entities, e.g with a field\_collection. So: ``` $node->getDecorated('field_my_field_collection', 'class_name_that_decorates_it'); ``` Would return an array of decorated field\_collection items. Querying -------- [](#querying) `EntityFieldQuery` has a somewhat verbose interface, and tricky to remember syntax. While entity decorator's finders don't yet implement the complete functionality of EntityFieldQuery, they should be simpler and easier to use. Unlike EntityFieldQuery, these finders return EntityDecorators with instantiated entities. We think that's nice. **Examples** ``` MyDecoratedNodeType::find(12345); ``` Returns the MyDecoratedNodeType with nid 12345 or null if no such node exists. ``` MyDecoratedNodeType::find_by_field_my_custom_field('Some value')->execute(); ``` Returns an array of MyDecoratedNodeTypes where the value of 'field\_my\_custom\_field' has the value 'Some value'. ``` MyDecoratedNodeType::find_by_field_my_custom_field(array('Some value', 'another value'))->execute(); ``` Returns an array of MyDecoratedNodeTypes where the value of 'field\_my\_custom\_field' has the value 'Some value' or 'another value'. And you can chain them as well... ``` MyDecoratedNodeType::find_by_field_my_custom_field('Some value')->find_by_title('other value')->execute(); ``` Returns an array of MyDecoratedNodeTypes where 'field\_my\_custom\_field' has the value 'Some value' and the 'title' has the value 'other value'. (Yes the finders also abstract away the property / field distinction). And sorting... ``` MyDecoratedNodeType::find_by_field_my_custom_field('Some value')->orderBy('field_another_field', 'ASC'); ``` Returns an array of MyDecoratedNodeType where 'field\_my\_custom\_field' has the value 'Some value' and is sorted by the value of field\_another\_field. You may also only want one record ``` MyDecoratedNodeType::find_first_by_field_my_custom_field('Some value'); ``` Which will return the first record where 'field\_my\_custom\_field' has the value 'Some value'. **Note** you don't need to call the execute method with find\_first\_by\_\* as by definition the query can be executed immediately. ### Health Score 20 — LowBetter than 14% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity4 Limited adoption so far Community11 Small or concentrated contributor base Maturity41 Maturing project, gaining track record Bus Factor1 Top contributor holds 71.9% 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. ### Community Maintainers ![](https://www.gravatar.com/avatar/da51f2fb140a4e118e94dd59ff819c11dd9a656b9c0ff8b2074c5fd2c07978ee?d=identicon)[alnutile](/maintainers/alnutile) --- Top Contributors [![dansingerman](https://avatars.githubusercontent.com/u/457786?v=4)](https://github.com/dansingerman "dansingerman (23 commits)")[![alnutile](https://avatars.githubusercontent.com/u/365385?v=4)](https://github.com/alnutile "alnutile (3 commits)")[![stewsnooze](https://avatars.githubusercontent.com/u/196643?v=4)](https://github.com/stewsnooze "stewsnooze (3 commits)")[![longwave](https://avatars.githubusercontent.com/u/197817?v=4)](https://github.com/longwave "longwave (2 commits)")[![pris54](https://avatars.githubusercontent.com/u/5442972?v=4)](https://github.com/pris54 "pris54 (1 commits)") ### Embed Badge ![Health badge](/badges/alnutile-entity-decorator/health.svg) ``` [![Health](https://phpackages.com/badges/alnutile-entity-decorator/health.svg)](https://phpackages.com/packages/alnutile-entity-decorator) ``` ### Alternatives [kaufmanndigital/gdpr-cookieconsent A ready-to-run package, that integrates an advanced cookie consent banner into your Neos CMS site. 2540.7k](/packages/kaufmanndigital-gdpr-cookieconsent)[selective/transformer A strictly typed array transformer with dot-access, fluent interface and filters. 3817.8k1](/packages/selective-transformer)[derhansen/sf_banners Banner-Management Extension based on Extbase and Fluid. Loads banners asynchronously using JavaScript. 1144.5k](/packages/derhansen-sf-banners)[martin/wn-forms-plugin Create easy (and almost magic) AJAX forms 212.3k](/packages/martin-wn-forms-plugin) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)