Download the PHP package nimbly/remodel without Composer
On this page you can find all versions of the php package nimbly/remodel. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download nimbly/remodel
More information about nimbly/remodel
Files in nimbly/remodel
Package remodel
Short Description A simple data transformer for your API responses
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package remodel
Remodel
A simple data transformer for your API responses.
Installation
Basic usage
Create a transformer that extends the Nimbly\Remodel\Transformer abstract. The transform method is required and should accept
a single thing to transform. This thing could be a model object or a simple associative array or something else entirely - it really doesn"t matter.
Inside this method you will define and return the transformed data as an associative array.
With our UserTransformer now defined, let's pull a user from the database and transform it. In order to transform the user data, we must map the data to be transformed to a specific transformer.
To do this we create a new Item subject since we are transforming a single item. If this were a collection of users, we would use the Collection subject.
Including related data automatically
What good is a transformer if it can only transform the object you've given it? Real use cases are far more complex. What if you need to transform a book whose author is stored in a separate model instance and needs its own transformation? What if we need the most recent user reviews posted about the book?
Add the protected $defaultIncludes array property on the transformer containing all the default includes you would like.
Remodel will then look for a method on the transformer with name "{include}Include". For example:
Now let's create the Transformer for our Author object.
Nested includes
What if you need an optional include on another include? For example, if the Author also has an Address object that is not included by default?
You can nest includes by using a dot notation.
This will include an Author and its Address object.
You can nest as many includes as you"d like and to an unlimited depth.
Transforming a collection of subjects
You can transform a collection or array of subjects in a similar fashion.
Adding includes at run time
What if you don"t always need a related subject included with every transformation? Maybe it's a resource provided only when the requesting client needs it?
You can pass run-time user supplied includes into the Transformer instance using the setIncludes method.
Overriding default includes at run time
You can override the default includes at runtime by calling the setDefaultIncludes method.
