DataDecorator

This package can be used to do post-processing on a set of data. It looks for templates and calls the specified method to get the output. It is useful especially when data is retrieved from a database and post-processing needs to be applied on every record.

Use Case

Database Structure id: unsignedInteger, name: string

Database Data {id: 1, name: 'one'}, {id: 2, name: 'two'}, {id: 3, name: 'three'}, {id: four, name: 'four'}

Let's say you are querying this data (using eloquent ORM here) MyModel::select('id', 'name')->get(); but you need to apply some processing on the value of name for each record. Below we have a function called MyClass::myStaticMethod($record['name']) which appends _modified to the input string.

BEFORE: Traditional Way

$records = MyModel::select('id', 'name')->get()->toArray();
foreach($records as &$record) {
   $record['name'] = MyClass::myStaticMethod($record['name']);
}

// output: ``{id: 1, name: 'one_modified'}, {id: 2, name: 'two_modified'}, {id: 3, name: 'three_modified'}, {id: four, name: 'four_modified'}``

AFTER: DataDecorator Way

With the DataRecorator way, you can specify within the select string how the data should be processed. The syntax follows conventions and should not be read as raw PHP code. The two formats are explained in the next section.

$records = MyModel::select('id', 'name AS ${MyClass.myStaticMethod(?)}:name')->get()->toArray();
$records = DataDecorator::processCollection($records);

// output: ``{id: 1, name: 'one_modified'}, {id: 2, name: 'two_modified'}, {id: 3, name: 'three_modified'}, {id: four, name: 'four_modified'}``

the decorator needs to be wrapped in ${ }
the value of name will be bound ?
the ending :name means to apply the resulting value back to the key name, this could be changed to any other name
the results needs to be run through DataDecorator::processCollection($records)

Supported Formats

Presenter

format: ${Model({attribute to set on model}).presenterMethod()}:outputKey
example: ``${Profile({username: ?})->presentLogoSrc()}:icon``

Object method

format: ${Class({attr: ?}).method()}:outputKey
example: ``${Foo({name: ?}).bar()}:baz``

Class method

format: ${ClassName.staticMethod(?)}:outputKey
example: ``${Avatar.getAvatarPath(profile_photo_small, ?)}:final_key_name``

Function call

format: ${myFunc(?)}:outputKey
example: ``${strtoupper(?)}:final_key_name``

License

The MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

garagesocial / gs-data-decorator