Download the PHP package azaan/laravel-scene without Composer
On this page you can find all versions of the php package azaan/laravel-scene. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
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 laravel-scene
Laravel Scene
Laravel library to convert your models into API responses.
Why a transformation library?
By default you can use the default implementation which converts your models to json based on toArray(). This approach starts to get messy once you start having different responses for your models for different endpoints (Eg: based on user permissions, endpoint types, etc).
This library also allows you to seperate your object transformation logic from your Models. Your models do not need to concern themselves with how they get represented over the wire at different endpoints. The same way you can use the transformers to transform objects or arrays. They don't have to be eloquent models.
Note: Laravel API Resource is a great start if you're using >= 5.5. In that case you should carefully evaluate your needs and how your complexity will grow before choosing this.
Installation
Install using composer.
Usage
Create a transformer class to transform your model. You can use the same transform method to transform an array/collection of objects or a single object.
Example.
Now in your controller method.
You can use the SceneRespond::respond method with either a collection of data or a single object. The transformer will handle it appropriately. It can also handle a LengthAwarePaginator.
In this example it is assumed your model (Person) has the attributes id, name, email and created_at. For the field fullname the method getFullname is used to resolve the value.
Keys are resolved using the following steps:
- If a getter method exists in the transformer it is called
- Check if the key exists on the object
- Check if a getter method for the key exists on the object
- Returns
null
Nesting Transformers
You can nest transformers within another transformer. For example if you had a Company model with a relation called owner which resolves to a Person object your Company transformer can look like this.
This way your transform logic for every model is compartmentalised and can easily be reused.
Hooks
Several hook methods are defined which you can override to get desired behaviour.
Injecting from Laravel Container
If you need to inject classes from the laravel container you can override the method inject. All parameters of the inject method will be resolved from the Laravel Container.
Minimum Structure
When you're responding with a collection of objects (Eg: for a listing) you might want to respond with different fields. You can use this by overriding the method getMinStructure(). In this case when you're instantiating the transformer in the controller use the method ::createMinTransformer()
Preload Eloquent relations
When responding with a collection of eloquent objects and accessing relations which haven't been loaded it will lead to the N+1 query problem. You can override the method getPreloadRelations and return an array of relations to be preloaded by the transformer. The transformer will take care of only loading the relations which haven't been loaded and will load them whenever appropriate. You can also use dot notation to preload nested relations. (Eg: person.address)
Pre process
Override the methods preProcessSingle and preProcessCollection to run any pre process logic before the transformer starts transforming the objects.
Null State
Override the method getNullState to return the default state if the object is null. Default implementation returns null
Ordering
Usually it is better to do your ordering before passing into the transformer. However in cases where you require to order by a field which is only present after the transformation you can override getOrderBy to provide ordering. You should return the field name as a string to order by. If you require direction return an array. (Eg: ['field_name', 'DESC'])
Post process hook.
To do any changes after all transformations you can override the method transformObject. The transformed output array will be passed in as the first argument and original object as the second.
Licence
MIT
