zend-hydrator

Hydration is the act of populating an object from a set of data.

zend-hydrator is a simple component to provide mechanisms both for hydrating objects, as well as extracting data sets from them.

The component consists of interfaces, and several implementations for common use cases.

Base Interfaces

ExtractionInterface

namespace Zend\Hydrator;

interface ExtractionInterface
{
    /**
     * Extract values from an object
     *
     * @return mixed[]
     */
    public function extract(object $object) : array;
}

HydrationInterface

namespace Zend\Hydrator;

interface HydrationInterface
{
    /**
     * Hydrate $object with the provided $data.
     *
     * @param mixed[] $data
     * @return object The implementation should return an object of any type.
     *     By purposely omitting the return type from the signature,
     *     implementations may choose to specify a more specific type.
     */
    public function hydrate(array $data, object $object);
}

HydratorInterface

namespace Zend\Hydrator;

interface HydratorInterface extends
    ExtractionInterface,
    HydrationInterface
{
}

Usage

Usage involves instantiating the hydrator, and then passing information to it.

use Zend\Hydrator;
$hydrator = new Hydrator\ArraySerializableHydrator();

// To hydrate an object from values in an array:
$object = $hydrator->hydrate($data, new ArrayObject());

// or, going the other way and extracting the values from an object as an array:
$data = $hydrator->extract($object);

Available Implementations

Zend\Hydrator\ArraySerializableHydrator

Follows the definition of ArrayObject. Objects must implement either the exchangeArray() or populate() methods to support hydration, and the getArrayCopy() method to support extraction.

Zend\Hydrator\ClassMethodsHydrator

Any data key matching a setter method will be called in order to hydrate; any method matching a getter method will be called for extraction, according to the following rules:

• is*(), has*(), and get*() methods will be extracted, and the method prefix will be removed from the property name.
• set*() methods will be used when hydrating properties.

Zend\Hydrator\DelegatingHydrator

Composes a hydrator locator, and will delegate hydrate() and extract() calls to the appropriate one based upon the class name of the object being operated on.

// Instantiate each hydrator you wish to delegate to
$albumHydrator = new Zend\Hydrator\ClassMethodsHydrator();
$artistHydrator = new Zend\Hydrator\ClassMethodsHydrator();

// Map the entity class name to the hydrator using the HydratorPluginManager.
// In this case we have two entity classes, "Album" and "Artist".
$hydrators = new Zend\Hydrator\HydratorPluginManager;
$hydrators->setService('Album', $albumHydrator);
$hydrators->setService('Artist', $artistHydrator);

// Create the DelegatingHydrator and tell it to use our configured hydrator locator
$delegating = new Zend\Hydrator\DelegatingHydrator($hydrators);

// Now we can use $delegating to hydrate or extract any supported object
$array  = $delegating->extract(new Artist());
$artist = $delegating->hydrate($data, new Artist());

Zend\Hydrator\ObjectPropertyHydrator

Any data key matching a publicly accessible property will be hydrated; any public properties will be used for extraction.

Zend\Hydrator\ReflectionHydrator

Similar to the ObjectPropertyHydrator, but uses PHP's reflection API to hydrate or extract properties of any visibility. Any data key matching an existing property will be hydrated; any existing properties will be used for extraction.