happyr / serializer-bundle
A bundle on top of Symfony's serializer. This supports annotations
Installs: 84
Dependents: 0
Suggesters: 0
Security: 0
Stars: 21
Watchers: 3
Forks: 0
Open Issues: 1
Type:symfony-bundle
Requires
- php: ^5.5|^7.0
- doctrine/annotations: ^1.2
- symfony/finder: ^2.7|^3.0
- symfony/serializer: ^2.7.10|^3.0
- twig/twig: ^1.18|^2.0
Requires (Dev)
- phpunit/phpunit: ^4.8
- symfony/symfony: ^2.7|^3.0
This package is auto-updated.
Last update: 2024-10-25 07:13:41 UTC
README
Make the Symfony's serializer easy to use.
Install
Via Composer
$ composer require happyr/serializer-bundle
Enable the bundle in your kernel:
<?php // app/AppKernel.php public function registerBundles() { $bundles = array( // ... new Happyr\SerializerBundle\HappyrSerializerBundle(), ); }
Usage
use \Happyr\SerializerBundle\Annotation as Serializer; /** * @Serializer\ExclusionPolicy("all") */ class Car { /** * @Serializer\Expose */ private $size = 'Small'; /** * @Serializer\Expose * @Serializer\Accessor({"getter":"getModel"}) */ private $model = 'Volvo'; private $color = 'Red'; public function getModel() { return 'This is model: '.$this->model; } } class Owner { private $name; /** * @Serializer\Type("Car") */ private $car; /** * @Serializer\ReadOnly */ private $birthday; public function __construct() { $this->name = 'Tobias'; $this->car = new Car(true); $this->birthday = new \DateTime('1989-04-30'); } } $json = $this->container->get('serializer')->serialize(new Owner(), 'json'); var_dump($json);
{ "name":"Tobias", "car":{ "size":"Small", "model":"This is model: Volvo" }, "birthday":"1989-04-30T00:00:00+02:00" }
Under the hood
This bundle provides a custom normalizer to Symfony's serializer component. This makes this serializer very flexible. If you want to serialize an object in a very custom way, add your own serializer as discibed in the Symfony documentation.
Configuration
You need to provide one or more paths to where your source code is.
// app/config/config.yml happyr_serializer: source: ['%kernel.root_dir%/../src'] # default twig_extension: false # default
Adding metadata
Currently you may only configure the normalizer with Annotations. These annotations are very similar to JmsSerializer.
@ExclusionPolicy
This annotation can be defined on a class to indicate the exclusion strategy that should be used for the class.
@Exclude
This annotation can be defined on a property to indicate that the property should not be serialized/unserialized. Works only in combination with ExclusionPolicy = "NONE".
@Expose
This annotation can be defined on a property to indicate that the property should be serialized/unserialized. Works only in combination with ExclusionPolicy = "ALL".
@SerializedName
This annotation can be defined on a property to define the serialized name for a property. If this is not defined, the property will be translated from camel-case to a lower-cased underscored name, e.g. camelCase -> camel_case.
@Groups
This annotation can be defined on a property to specifiy to if the property should be serialized when only serializing specific groups. If this is excluded the property/method will get group "Default".
@Accessor
This annotation can be defined on a property to specify which public method should be called to retrieve, or set the value of the given property. By default we access properties by reflection.
<?php use \Happyr\SerializerBundle\Annotation as Serializer; class User { private $id; /** * @Serializer\Accessor(getter="getTrimmedName",setter="setName") */ private $name; // ... public function getTrimmedName() { return trim($this->name); } public function setName($name) { $this->name = $name; } }
@ReadOnly
This annotation can be defined on a property to indicate that the data of the property is read only and cannot be set during deserialization.
A property can be marked as non read only with @ReadOnly(false)
annotation (useful when a class is marked as read only).