nilportugues/serializer-eloquent

Eloquent Driver for NilPortugues Serializer outputting valid API responses in JSON, JSON API and HAL+JSON API formats.

1.0.12 2017-03-30 08:24 UTC

Requires

• php: >=5.5.0
• illuminate/database: ^5.1
• illuminate/pagination: ^5.1
• nilportugues/serializer: ^1

Requires (Dev)

• fabpot/php-cs-fixer: ^1.9
• phpunit/phpunit: 4.4.*

MIT

• Nil Portugués Calderó

• orm
• json
• api
• response
• serializer
• laravel
• transformer
• eloquent
• jsonapi
• nilportugues
• psr7

README

What?

This is a driver for the Serializer library caring of Eloquent ORM model serialization.

Why?

Due to the popularity of Eloquent, specially in Laravel apps, a driver has been develop to unite all Eloquent serialization edge-cases for Serializer in a single library.

Installation

Use Composer to install the package:

$ composer require nilportugues/serializer-eloquent

Usage

This will return an array following the Serializer format.

use NilPortugues\Serializer\Drivers\Eloquent\EloquentDriver;

$serialized = EloquentDriver::serialize($value);

Todo

Code all examples provided in the Eloquent documentation for relationships as tests:

• One To One
• One To Many
• Has Many Through
• Polymorphic Relations
• Many To Many
• Many To Many Polymorphic Relations

Contribute

Contributions to the package are always welcome!

• Report any bugs or issues you find on the issue tracker.
• You can grab the source code at the package's Git repository.

Support

Get in touch with me using one of the following means:

• Emailing me at [e-mail]
• Opening an Issue

Authors

• Nil Portugués Calderó
• The Community Contributors

License

The code base is licensed under the MIT license.