Zend Framework
Back to top  

 Methods

Initializes a new instance of this class.

__construct() 
Inherited

inherited_from \Zend\Stdlib\Hydrator\AbstractHydrator::__construct()

Add a new filter to take care of what needs to be hydrated.

addFilter(string $name, \Zend\Stdlib\Hydrator\callable | \Zend\Stdlib\Hydrator\Filter\FilterInterface $filter, int $condition) : \Zend\Stdlib\Hydrator\Filter\FilterComposite
Inherited

To exclude e.g. the method getServiceLocator:

$composite->addFilter("servicelocator",
    function($property) {
        list($class, $method) = explode('::', $property);
        if ($method === 'getServiceLocator') {
            return false;
        }
        return true;
    }, FilterComposite::CONDITION_AND
);

inherited_from \Zend\Stdlib\Hydrator\AbstractHydrator::addFilter()

Parameters

$name

string

Index in the composite

$filter

\Zend\Stdlib\Hydrator\callable\Zend\Stdlib\Hydrator\Filter\FilterInterface

$condition

int

Returns

\Zend\Stdlib\Hydrator\Filter\FilterComposite

Adds the given strategy under the given name.

addStrategy(string $name, \Zend\Stdlib\Hydrator\Strategy\StrategyInterface $strategy) : \Zend\Stdlib\Hydrator\HydratorInterface
Inherited

inherited_from \Zend\Stdlib\Hydrator\AbstractHydrator::addStrategy()

Parameters

$name

string

The name of the strategy to register.

$strategy

\Zend\Stdlib\Hydrator\Strategy\StrategyInterface

The strategy to register.

Returns

\Zend\Stdlib\Hydrator\HydratorInterface

Extract values from an object

extract(object $object) : array

Parameters

$object

object

Returns

array

Converts a value for extraction.

extractValue(string $name, mixed $value) : mixed
Inherited

If no strategy exists the plain value is returned.

inherited_from \Zend\Stdlib\Hydrator\AbstractHydrator::extractValue()

Parameters

$name

string

The name of the strategy to use.

$value

mixed

The value that should be converted.

Returns

mixed

Get the filter instance

getFilter() : \Zend\Stdlib\Hydrator\Filter\FilterComposite
Inherited

inherited_from \Zend\Stdlib\Hydrator\AbstractHydrator::getFilter()

Returns

\Zend\Stdlib\Hydrator\Filter\FilterComposite

Gets the strategy with the given name.

getStrategy(string $name) : \Zend\Stdlib\Hydrator\Strategy\StrategyInterface
Inherited

inherited_from \Zend\Stdlib\Hydrator\AbstractHydrator::getStrategy()

Parameters

$name

string

The name of the strategy to get.

Returns

\Zend\Stdlib\Hydrator\Strategy\StrategyInterface

Check whether a specific filter exists at key $name or not

hasFilter(string $name) : bool
Inherited

inherited_from \Zend\Stdlib\Hydrator\AbstractHydrator::hasFilter()

Parameters

$name

string

Index in the composite

Returns

bool

Checks if the strategy with the given name exists.

hasStrategy(string $name) : bool
Inherited

inherited_from \Zend\Stdlib\Hydrator\AbstractHydrator::hasStrategy()

Parameters

$name

string

The name of the strategy to check for.

Returns

bool

Hydrate $object with the provided $data.

hydrate(array $data, object $object) : object

Parameters

$data

array

$object

object

Returns

object

Converts a value for hydration.

hydrateValue(string $name, mixed $value) : mixed
Inherited

If no strategy exists the plain value is returned.

inherited_from \Zend\Stdlib\Hydrator\AbstractHydrator::hydrateValue()

Parameters

$name

string

The name of the strategy to use.

$value

mixed

The value that should be converted.

Returns

mixed

Remove a filter from the composition.

removeFilter($name) : \Zend\Stdlib\Hydrator\Filter\FilterComposite
Inherited

To not extract "has" methods, you simply need to unregister it

$filterComposite->removeFilter('has');

inherited_from \Zend\Stdlib\Hydrator\AbstractHydrator::removeFilter()

Parameters

$name

Returns

\Zend\Stdlib\Hydrator\Filter\FilterComposite

Removes the strategy with the given name.

removeStrategy(string $name) : \Zend\Stdlib\Hydrator\HydratorInterface
Inherited

inherited_from \Zend\Stdlib\Hydrator\AbstractHydrator::removeStrategy()

Parameters

$name

string

The name of the strategy to remove.

Returns

\Zend\Stdlib\Hydrator\HydratorInterface

Get a reflection properties from in-memory cache and lazy-load if class has not been loaded.

getReflProperties(string | object $input) : array

static

Parameters

$input

stringobject

Exceptions

\Zend\Stdlib\Exception\InvalidArgumentException

Returns

array

 Properties

 

Composite to filter the methods, that need to be hydrated

$filterComposite : \Zend\Stdlib\Hydrator\Filter\FilterComposite
Inherited

inherited_from \Zend\Stdlib\Hydrator\AbstractHydrator::$$filterComposite
 

Simple in-memory array cache of ReflectionProperties used.

$reflProperties : array

 

The list with strategies that this hydrator has.

$strategies : \ArrayObject
Inherited

inherited_from \Zend\Stdlib\Hydrator\AbstractHydrator::$$strategies