PHPackages                             dcwq/api-tools-doctrine-hydration-module - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. dcwq/api-tools-doctrine-hydration-module

ActiveLibrary[Database & ORM](/categories/database)

dcwq/api-tools-doctrine-hydration-module
========================================

v4.1.3(5y ago)041MITPHPPHP ^5.6 || ^7.0

Since May 22Pushed 5y agoCompare

[ Source](https://github.com/dcwq/api-tools-doctrine-hydration-module)[ Packagist](https://packagist.org/packages/dcwq/api-tools-doctrine-hydration-module)[ RSS](/packages/dcwq-api-tools-doctrine-hydration-module/feed)WikiDiscussions master Synced 5d ago

READMEChangelogDependencies (13)Versions (16)Used By (0)

[![Build status](https://camo.githubusercontent.com/a6213ad9f1f7969c3f0e57d808517a8c75c355f17ebe914d4896971fe3126122/68747470733a2f2f6170692e7472617669732d63692e6f72672f706870726f2f7a662d646f637472696e652d687964726174696f6e2d6d6f64756c652e737667)](http://travis-ci.org/phpro/zf-doctrine-hydration-module)[![Packagist](https://camo.githubusercontent.com/71226cbc919aac44fb034e95f242e96732f7d4947d071d82e978eb422cb33a45/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f706870726f2f7a662d646f637472696e652d687964726174696f6e2d6d6f64756c652e737667)](https://packagist.org/packages/phpro/zf-doctrine-hydration-module)[![Downloads](https://camo.githubusercontent.com/34a444f7a95a80d9f0df181dd6684910bde9767843f82c80766bb5d5450679d0/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f706870726f2f7a662d646f637472696e652d687964726174696f6e2d6d6f64756c652e737667)](https://packagist.org/packages/phpro/zf-doctrine-hydration-module)

Doctrine Hydration Module
=========================

[](#doctrine-hydration-module)

This module provides a configurable way to create new doctrine hydrators. By using the configurable API, it is easy to create a custom hydrator for any use case you want.

For ORM, the basic hydrator from the doctrine module is being used. It is possible to configure your own strategies for complex objects like referenced entities.

For MongoDB ODM, a specific hydrator is added. This hydrator will be able to handle Referenced documents and Embedded Documents. It is also possible to hydrate advanced documents with discriminator maps.

Supported features
==================

[](#supported-features)

- 4.0.x: Contains zend-servicemanager >=3.3.2 support requiring PHP 5.6+.
- 3.0.x: Contains zend-servicemanager >=3 support requiring PHP 5.6+.
- 2.0.x: Contains zend-hydrator support requiring PHP 5.6+.
- 1.0.x: Contains zend-stdlib <2.7 support requiring PHP 5.4+.

Make sure to commit on the correct branch if you want your changes to get merged into the project.

Installation
============

[](#installation)

Add to composer.json
--------------------

[](#add-to-composerjson)

```
composer require phpro/zf-doctrine-hydration-module

```

Add to application config
-------------------------

[](#add-to-application-config)

```
return array(
    'modules' => array(
        'Phpro\\DoctrineHydrationModule',
        // other libs...
    ),
    // Other config
);
```

### Hydrator configuration

[](#hydrator-configuration)

```
return array(
    'doctrine-hydrator' => array(
        'hydrator-manager-key' => array(
            'entity_class' => 'App\Entity\EntityClass',
            'object_manager' => 'doctrine.objectmanager.key.in.servicelocator',
            'by_value' => true,
            'use_generated_hydrator' => true,
            'naming_strategy' => 'custom.naming.strategy.key.in.servicemanager',
            'hydrator' => 'custom.hydrator.key.in.hydratormanager',
            'strategies' => array(
                'fieldname' => 'custom.strategy.key.in.servicemanager',
            ),
            'filters' => array(
                'custom_filter_name' => array(
                    'condition' => 'and', // optional, default is 'or'
                    'filter'    => 'custom.hydrator.filter.key.in.servicemanager',
                ),
            ),
        ),
    ),
);
```

**`entity_class`**

This property is used to specify the class of the entity that will be hydrated. You need to make sure that this entity is a mapped doctrine class.

**`object_manager`**

You can specify which object manager you want to use for the hydrator. The value is the key of the desired object manager in the service manager.

**`by_value`**

Specify if you want the hydrator to hydrate the entity by value or by reference.

**`use_generated_hydrator`**

This property will only be used with mongoDB ODM and will use the generated hydrators instead of the Doctrine Module Hydrator. Strategies will not work when this option is set to `true`.

**`naming_strategy`**

You can use a custom naming strategy for the hydrator. Specify the key of the naming strategy in the service manager. Note that this naming strategy needs to implement `NamingStrategyInterface`.

**`hydrator`**You can use a custom hydrator instead of the default `DoctrineObject` hydrator. Make sure this hydrator implements `HydratorInterface`.

**`strategies`**

It is possible to customize the hydration strategy of specific properties. Configure the property you want to customize with the key of the strategy in the service manager; Note that this strategy needs to implement `StrategyInterface`.

**`filters`**

This property can be used to apply filters on the Hydrator. You can specify a list of custom filters by defining the key of the filter in the service manager and the filter condition as described in the hydrator filter documentation. Note that this filter needs to implement `FilterInterface`.

From here on, you can get the hydrator by calling `get('hydrator-manager-key')` on the HydratorManager.

Custom strategies:
==================

[](#custom-strategies)

MongoDB ODM
-----------

[](#mongodb-odm)

- DateTimeField: Used for DateTime objects
- DefaultRelation: Leave the relation AS-IS. Does not perform any modifications on the field.
- EmbeddedCollection: Used for embedded collections
- EmbeddedField: Used for embedded fields
- ReferencedCollection: Used for referenced collections
- ReferencedField: Used for referenced fields.
- EmbeddedReferenceCollection: This is a custom strategy that can be used in an API to display all fields in a referenced object. The hydration works as a regular referenced object.
- EmbeddedReferenceField: This is a custom strategy that can be used in an API to display all fields in a referenced object. The hydration works as a regular referenced object.

Custom Filters
==============

[](#custom-filters)

Custom filters allow you to fine-tune the results of the hydrator's `extract` functionality by determining which fields should be extracted.

To configure custom filters:

```
return array(
    'doctrine-hydrator' => array(
        'custom-hydrator' => array(
            // other config
            'filters' => array(
                'custom.filter.name' => array(
                    'condition' => 'and', //optional, default: FilterComposite::CONDITION_OR,
                    'filter' => 'custom.filter', // a name in the Service Manager
                ),
            ),
        ),
    ),
);
```

In this example configuration, the hydrator factory will retrieve `custom.filter` from the Service Manager and inject it as a filter into the hydrator. The filter must implement `Laminas\Hydrator\Filter\FilterInterface`.

The service's `filter($fieldName)` function will be called by the hydrator during `extract` and the field name being extracted will be passed as an argument. The `filter()` function must return a truthy value: if `true` then the field will NOT be extracted.

Override hydrator:
==================

[](#override-hydrator)

If the standard DoctrineHydrator is not flexible enough, you can set a custom `hydrator`. This allows you to use an extended DoctrineHydrator or another existing hydrator, and configure it with this module. This setting will override `use_generated_hydrator`.

```
return array(
    'doctrine-hydrator' => array(
        'custom-hydrator' => array(
            // other config
            'hydrator' => 'Laminas\Hydrator\ArraySerializable'
        ),
    ),
);
```

Testing
=======

[](#testing)

This package is fully tested with Cs fixer and PhpUnit. The MongoDB tests require mongodb to be installed on your machine. You can skip these tests by adding a testsuite to the command:

```
# Php coding standards:
# (The files are loaded according to the PSR-4 standard. The PSR-0 fix will fail!)
./vendor/bin/php-cs-fixer fix . --dry-run  --fixers=-psr0

# Phpunit:
./vendor/bin/phpunit

# Testing one testsuite:
./vendor/bin/phpunit --testsuite="Main"
./vendor/bin/phpunit --testsuite="ODM"
```

###  Health Score

29

—

LowBetter than 59% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity4

Limited adoption so far

Community17

Small or concentrated contributor base

Maturity66

Established project with proven stability

 Bus Factor1

Top contributor holds 76.7% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~162 days

Recently: every ~204 days

Total

16

Last Release

1944d ago

Major Versions

0.1.6 → v1.0.02016-01-14

v1.0.0 → v2.0.02016-06-14

v2.0.1 → v3.0.02016-10-05

v3.0.0 → v4.0.02018-10-25

PHP version history (2 changes)0.1.5PHP >=5.3.23

v3.0.0PHP ^5.6 || ^7.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/1bf8f1940e49bbb83e2a4161855e5a4e76efc4c10e9aa86e2cc86c0f5d3e937b?d=identicon)[dcwiklik](/maintainers/dcwiklik)

---

Top Contributors

[![veewee](https://avatars.githubusercontent.com/u/1618158?v=4)](https://github.com/veewee "veewee (138 commits)")[![michalbundyra](https://avatars.githubusercontent.com/u/7423207?v=4)](https://github.com/michalbundyra "michalbundyra (12 commits)")[![TomHAnderson](https://avatars.githubusercontent.com/u/493920?v=4)](https://github.com/TomHAnderson "TomHAnderson (8 commits)")[![boukeversteegh](https://avatars.githubusercontent.com/u/53926?v=4)](https://github.com/boukeversteegh "boukeversteegh (6 commits)")[![dcwq](https://avatars.githubusercontent.com/u/1905968?v=4)](https://github.com/dcwq "dcwq (4 commits)")[![thc87](https://avatars.githubusercontent.com/u/107407081?v=4)](https://github.com/thc87 "thc87 (3 commits)")[![alcaeus](https://avatars.githubusercontent.com/u/383198?v=4)](https://github.com/alcaeus "alcaeus (2 commits)")[![matwright](https://avatars.githubusercontent.com/u/4989280?v=4)](https://github.com/matwright "matwright (1 commits)")[![fabiocarneiro](https://avatars.githubusercontent.com/u/1375034?v=4)](https://github.com/fabiocarneiro "fabiocarneiro (1 commits)")[![phpboyscout](https://avatars.githubusercontent.com/u/175238?v=4)](https://github.com/phpboyscout "phpboyscout (1 commits)")[![eziofra](https://avatars.githubusercontent.com/u/30832750?v=4)](https://github.com/eziofra "eziofra (1 commits)")[![dorongutman](https://avatars.githubusercontent.com/u/719298?v=4)](https://github.com/dorongutman "dorongutman (1 commits)")[![tom-pryor](https://avatars.githubusercontent.com/u/1273529?v=4)](https://github.com/tom-pryor "tom-pryor (1 commits)")[![Bilge](https://avatars.githubusercontent.com/u/470626?v=4)](https://github.com/Bilge "Bilge (1 commits)")

---

Tags

doctrinehydratorzf

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/dcwq-api-tools-doctrine-hydration-module/health.svg)

```
[![Health](https://phpackages.com/badges/dcwq-api-tools-doctrine-hydration-module/health.svg)](https://phpackages.com/packages/dcwq-api-tools-doctrine-hydration-module)
```

###  Alternatives

[doctrine/doctrine-orm-module

Laminas Module that provides Doctrine ORM functionality

4407.3M293](/packages/doctrine-doctrine-orm-module)[doctrine/doctrine-mongo-odm-module

Laminas Module which provides Doctrine MongoDB ODM functionality

86676.6k35](/packages/doctrine-doctrine-mongo-odm-module)[doctrine/doctrine-laminas-hydrator

Doctrine hydrators for Laminas applications

362.8M19](/packages/doctrine-doctrine-laminas-hydrator)[zfc-datagrid/zfc-datagrid

Laminas Module that provides a datagrid for different datasources and output formats

1223.2k](/packages/zfc-datagrid-zfc-datagrid)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)