Download the PHP package mvieira/collection-json without Composer
On this page you can find all versions of the php package mvieira/collection-json. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mvieira/collection-json
More information about mvieira/collection-json
Files in mvieira/collection-json
Package collection-json
Short Description PHP implementation of the Collection+JSON Media Type
License MIT
Homepage https://github.com/mickaelvieira/CollectionJson
Informations about the package collection-json
Collection Json
PHP implementation of the Collection+JSON Media Type
Specification:
Installation
CollectionJson requires php >= 7.0
Install CollectionJson with Composer
or
Contributing
Please see CONTRIBUTING for details.
License
The MIT License (MIT). Please see License File for more information.
Documentation
Creating a collection
Creating an entity
All entities , , , , , , can be created by using the static method ...
...or by using the accessors (Note that entities are immutable)
...or via the constructor
Printing the data
Note: Apart from the data's value property, which allows having a NULL value (see. specification), All properties and empty arrays will be excluded from the JSON and Array representation.
Printing a JSON representation
All entities implement the JsonSerializable interface, you can therefore call at any time the method .
Printing an Array representation
All entities implement a custom interface named , so you can call at any time the method . This method will be called recursively on all nested entities.
Wrapping
The entity will be wrapped...
...however others entities will not be wrapped when they are converted in a JSON or an Array.
But you can wrap the json or the array representation by calling the method
Examples
Examples are available in the directory , you can execute them on the command line by running:
Or separately
Working with data and links
In order to work with CollectionJson Arrays Data, Links, the API provides 2 interfaces that implement a similar logic.
- The interface implemented by , and entities, provides the methods , , , , and
- The interface implemented by and entities, provides the methods , , , , and
They allows you to add the corresponding entities to objects that implement them.
Validation
It is now possible to validate the data entering your API by using the Symfony validator.
It will return the list of errors.