Reference
Migration from version 2
This document details changes made between version 2 and version 3 that could affect end-users.
Minimum supported versions
PHP
Version 3 bumps the minimum supported PHP version to version 7.2. We chose this
version in particular as it provides the object
typehint, which allows us to
enforce at the engine level what we were previously enforcing only at the
documentation level.
Additionally, we have enabled strict types in all class files shipped with this component.
zend-eventmanager
The minimum supported version of zend-eventmanager (used by the
AggregateHydrator
)is now 3.2.1.
zend-serializer
The minimum supported version of zend-serializer (used by the
SerializableStrategy
) is now 2.9.0.
zend-servicemanager
The minimum supported version of zend-servicemanager (used by the
HydratorPluginManager
) is now 3.3.2.
Renamed interfaces
The following interfaces were renamed:
Zend\Hydrator\FilterEnabledInterface
becomesZend\Hydrator\Filter\FilterEnabledInterface
.Zend\Hydrator\NamingStrategyEnabledInterface
becomesZend\Hydrator\NamingStrategy\NamingStrategyEnabledInterface
.Zend\Hydrator\StrategyEnabledInterface
becomesZend\Hydrator\Strategy\StrategyEnabledInterface
.
Renamed classes
The following classes were renamed:
Zend\Hydrator\ArraySerializable
becomesZend\Hydrator\ArraySerializableHydrator
Zend\Hydrator\ClassMethods
becomesZend\Hydrator\ClassMethodsHydrator
Zend\Hydrator\ObjectProperty
becomesZend\Hydrator\ObjectPropertyHydrator
Zend\Hydrator\Reflection
becomesZend\Hydrator\ReflectionHydrator
In each case, a class named after the original has been created as a deprecated extension of the new class. This means you can continue to use the old class names, but only until version 4, at which point they will be removed.
Additionally, aliases for the old class names have been added to the
HydratorPluginManager
, pointing to services named after the new class names.
Interface changes
Each of the interfaces provided by this package have been updated to add typehints where they were previously omitted (due to engine limitations), both on parameters and return values. These include:
Zend\Hydrator\ExtractionInterface
:extract($object)
becomesextract(object $object) : array
Zend\Hydrator\Filter\FilterEnabledInterface
(wasZend\Hydrator\FilterEnabledInterface
):addFilter($name, $filter, $condition = Zend\Hydrator\Filter\FilterComposite::CONDITION_OR)
becomesaddFilter(string $name, $filter, int $condition = Zend\Hydrator\Filter\FilterComposite::CONDITION_OR) : void
hasFilter($name)
becomeshasFilter(string $name) : bool
removeFilter($name)
becomesremoveFilter(string $name) : void
Zend\Hydrator\HydrationInterface
:hydrate(array $data, $object)
becomeshydrate(array $data, object $object)
Zend\Hydrator\HydratorAwareInterface
:setHydrator(Zend\Hydrator\HydratorInterface $hydrator)
becomessetHydrator(Zend\Hydrator\HydratorInterface $hydrator) : void
getHydrator()
becomesgetHydrator() : ?Zend\Hydrator\HydratorInterface
Zend\Hydrator\HydratorAwareTrait
was updated to follow the interface; if you use the trait to implement the interface, no changes will be necessary.Zend\Hydrator\HydratorOptionsInterface
:setOptions($options)
becomessetOptions(iterable $options) : void
Zend\Hydrator\HydratorProviderInterface
:getHydratorConfig()
becomesgetHydratorConfig() : array
Zend\Hydrator\NamingStrategy\NamingStrategyEnabledInterface
(wasZend\Hydrator\NamingStrategyEnabledInterface
):setNamingStrategy(Zend\Hydrator\NamingStrategy\NamingStrategyInterface $strategy)
becomessetNamingStrategy(Zend\Hydrator\NamingStrategy\NamingStrategyInterface $strategy) : void
getNamingStrategy()
becomesgetNamingStrategy() : Zend\Hydrator\NamingStrategy\NamingStrategyInterface
removeNamingStrategy()
becomesremoveNamingStrategy() : void
Zend\Hydrator\Strategy\StrategyEnabledInterface
(wasZend\Hydrator\StrategyEnabledInterface
):addStrategy($name, Zend\Hydrator\Strategy\StrategyInterface $strategy)
becomesaddStrategy(string $name, Zend\Hydrator\Strategy\StrategyInterface $strategy) : void
getStrategy($name)
becomesgetStrategy(string $name) : Zend\Hydrator\Strategy\StrategyInterface
hasStrategy($name)
becomeshasStrategy(string $name) : bool
removeStrategy($name)
becomesremoveStrategy(string $name) : void
Zend\Hydrator\Filter\FilterInterface
:filter($property)
becomesfilter(string $property) : bool
Zend\Hydrator\Filter\FilterProviderInterface
:getFilter()
becomesgetFilter() : Zend\Hydrator\Filter\FilterInterface
Zend\Hydrator\Iterator\HydratingIteratorInterface
:setPrototype($prototype)
becomessetPrototype($prototype) : void
($prototype
continues to allow either astring
or object)setHydrator(Zend\Hydrator\HydratorInterface $hydrator)
becomessetHydrator(Zend\Hydrator\HydratorInterface $hydrator) : void
Zend\Hydrator\NamingStrategy\NamingStrategyInterface
:extract($name)
becomesextract(string $name, ?object $object = null) : string
hydrate($name)
becomeshydrate(string $name, ?array $data = null) : string
Zend\Hydrator\Strategy\StrategyInterface
:hydrate($value)
becomeshydrate($value, ?array $data = null)
(the$value
parameter and return value can be any PHP type)extract($value)
becomesextract($value, ?object $object = null)
(the$value
parameter and return value can be any PHP type)
All implementations of these interface shipped in the component have been updated to ensure signatures match.
If you are providing custom implementations, or extending the implementations provided in this package, you may need to update signatures per the above.
Typehints
As noted in the above section, typehints were added to all interfaces. In addition to those changes, the following methods were also updated to add typehints:
Zend\Hydrator\Aggregate\AggregateHydrator
:-
add(Zend\Hydrator\HydratorInterface $hydrator, $priority = self::DEFAULT_PRIORITY)
becomesadd(Zend\Hydrator\HydratorInterface $hydrator, int $priority = self::DEFAULT_PRIORITY) : void
-
Zend\Hydrator\Aggregate\ExtractEvent
: __construct($target, $extractionObject)
becomes__construct(object $target, object $extractionObject)
getExtractionObject()
becomesgetExtractionObject() : object
setExtractionObject($extractionObject)
becomessetExtractionObject(object $extractionObject) : void
getExtractedData()
becomesgetExtractedData() : array
setExtractedData(array $extractedData)
becomessetExtractedData(array $extractedData) : void
-
mergeExtractedData(array $additionalData)
becomesmergeExtractedData(array $additionalData) : void
-
Zend\Hydrator\Aggregate\HydrateEvent
: __construct($target, $hydratedObject, array $hydrationData)
becomes__construct(object $target, object $hydratedObject, array $hydrationData)
getHydratedObject()
becomesgetHydratedObject() : object
setHydratedObject($hydratedObject)
becomessetHydratedObject(object $hydratedObject) : void
getHydrationData()
becomesgetHydrationData() : array
-
setHydrationData(array $hydrationData)
becomessetHydrationData(array $hydrationData) : void
-
Zend\Hydrator\Aggregate\HydratorListener
: onHydrate(HydrateEvent $event)
becomesonHydrate(HydrateEvent $event) : object
-
onExtract(ExtractEvent $event)
becomesonExtract(ExtractEvent $event) : array
-
Zend\Hydrator\ClassMethodsHydrator
(wasZend\Hydrator\ClassMethods
): __construct($underscoreSeparatedKeys = true, $methodExistsCheck = false)
becomes__construct(bool $underscoreSeparatedKeys = true, bool $methodExistsCheck = false)
setUnderscoreSeparatedKeys($underscoreSeparatedKeys)
becomessetUnderscoreSeparatedKeys(bool $underscoreSeparatedKeys) : void
getUnderscoreSeparatedKeys()
becomesgetUnderscoreSeparatedKeys() : bool
setMethodExistsCheck($methodExistsCheck)
becomessetMethodExistsCheck(bool $methodExistsCheck) : void
-
getMethodExistsCheck()
becomesgetMethodExistsCheck() : bool
-
Zend\Hydrator\ConfigProvider
: __invoke()
becomes__invoke() : array
-
getDependencyConfig()
becomesgetDependencyConfig() : array
-
Zend\Hydrator\DelegatingHydratorFactory
: - no longer implements
Zend\ServiceManager\FactoryInterface
-
__invoke(Interop\Container\ContainerInterface $container, $requestedName, array $options = null)
becomes__invoke(Psr\Container\ContainerInterface $container) : Zend\Hydrator\DelegatingHydrator
-
Zend\Hydrator\Filter\FilterComposite
: -
__construct($orFilters = [], $andFilters = [])
becomes__construct(array $orFilters = [], array $andFilters = [])
-
Zend\Hydrator\Filter\MethodMatchFilter
: -
__construct($method, $exclude = true)
becomes__construct(string $method, bool $exclude = true)
-
Zend\Hydrator\Filter\NumberOfParameterFilter
: -
__construct($numberOfParameters = 0)
becomes__construct(int $numberOfParameters = 0)
-
Zend\Hydrator\HydratorPluginManagerFactory
: - no longer implements
Zend\ServiceManager\FactoryInterface
-
__invoke(Interop\Container\ContainerInterface $container, $requestedName, array $options = null)
becomes__invoke(Psr\Container\ContainerInterface $container, string $name, ?array $options = []) : Zend\Hydrator\HydratorPluginManager
-
Zend\Hydrator\Module
: getConfig()
becomesgetConfig() : array
-
init($moduleManager)
becomesinit(Zend\ModuleManager\ModuleManager $moduleManager) : void
-
Zend\Hydrator\NamingStrategy\CompositeNamingStrategy
: -
__construct(array $strategies, Zend\Hydrator\NamingStrategy\NamingStrategyInterface $defaultNamingStrategy = null)
becomes__construct(array $strategies, ?Zend\Hydrator\NamingStrategy\NamingStrategyInterface $defaultNamingStrategy = null)
-
Zend\Hydrator\NamingStrategy\UnderscoreNamingStrategy\CamelCaseToUnderscoreFilter
: -
filter($value)
becomesfilter(string $value) : string
-
Zend\Hydrator\NamingStrategy\UnderscoreNamingStrategy\UnderscoreToCamelCaseFilter
: -
filter($value)
becomesfilter(string $value) : string
-
Zend\Hydrator\Strategy\ClosureStrategy
: -
__construct($extractFunc = null, $hydrateFunc = null)
becomes__construct(?callable $extractFunc = null, ?callable $hydrateFunc = null)
-
Zend\Hydrator\Strategy\CollectionStrategy
: -
__construct(Zend\Hydrator\HydratorInterface $objectHydrator, $objectClassName)
becomes__construct(Zend\Hydrator\HydratorInterface $objectHydrator, string $objectClassName)
-
Zend\Hydrator\Strategy\DateTimeFormatterStrategy
: -
__construct($format = DateTime::RFC3339, DateTimeZone $timezone = null, $dateTimeFallback = false)
becomes__construct(string $format = DateTime::RFC3339, ?DateTimeZone $timezone = null, bool $dateTimeFallback = false)
-
Zend\Hydrator\Strategy\ExplodeStrategy
: -
__construct($delimiter = ',', $explodeLimit = null)
becomes__construct(string $delimiter = ',', ?int $explodeLimit = null)
-
Zend\Hydrator\Strategy\SerializableStrategy
: __construct($serializer, $serializerOptions = null)
becomes__construct($serializer, ?iterable $serializerOptions = null)
setSerializer($serializer)
becomessetSerializer($serializer) : void
getSerializer()
becomesgetSerializer($serializer) : Zend\Serializer\Adapter\AdapterInterface
setSerializerOptions($serializerOptions)
becomessetSerializerOptions(iterable $serializerOptions) : void
-
getSerializerOptions()
becomesgetSerializerOptions() : array
-
Zend\Hydrator\Strategy\StrategyChain
: __construct($extractionStrategies)
becomes__construct(iterable $extractionStrategies)
ArrayMapNamingStrategy and MapNamingStrategy merged
ArrayMapNamingStrategy
and MapNamingStrategy
were performing essentially the
same duties, but in reverse. As such, for version 3, we have merged the two into
MapNamingStrategy
. To accommodate the three different use cases, we provide
three "named constructors":
public static function createFromExtractionMap(array $extractionMap) : MapNamingStrategy;
public static function createFromHydrationMap(array $hydrationMap) : MapNamingStrategy;
public static function createFromAsymmetricMap(array $extractionMap, array $hydrationMap) : MapNamingStrategy;
In the first two cases, the constructor will flip the arrays for purposes of the
opposite interaction; e.g., using createFromExtractionMap()
will create a
hydration map based on an array_flip()
of the extraction map provided.
You MUST use one of these methods to create an instance, as the constructor
is now marked private
.
HydratorPluginManager
This version removes support for zend-servicemanager v2 service names. Under zend-servicemanager v2, most special characters were removed, and the name normalized to all lowercase. Now, only fully qualified class names are mapped to factories, and short names (names omitting the namespace and/or "Hydrator" suffix) are mapped as aliases.
Additionally, version 3 ships a standalone, PSR-11 compliant version,
Zend\Hydrator\StandaloneHydratorPluginManager
. By default, the HydratorManager
service alias will point to the StandaloneHydratorPluginManager
if
zend-servicemanager is not installed, and the HydratorPluginManager
otherwise.
See the plugin managers chapter for more details.
Found a mistake or want to contribute to the documentation? Edit this page on GitHub!