PHPackages laminas-api-tools/api-tools-doctrine - 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. laminas-api-tools/api-tools-doctrine ActiveLibrary[Database & ORM](/categories/database) laminas-api-tools/api-tools-doctrine ==================================== Laminas API Tools Doctrine module 2.4.0(4y ago)10633.9k↑29.4%25[4 PRs](https://github.com/laminas-api-tools/api-tools-doctrine/pulls)5BSD-3-ClausePHPPHP ^7.3 || ~8.0.0 Since Dec 31Pushed 1y ago13 watchersCompare [ Source](https://github.com/laminas-api-tools/api-tools-doctrine)[ Packagist](https://packagist.org/packages/laminas-api-tools/api-tools-doctrine)[ Docs](https://api-tools.getlaminas.org)[ Fund](https://funding.communitybridge.org/projects/laminas-project)[ RSS](/packages/laminas-api-tools-api-tools-doctrine/feed)WikiDiscussions 2.5.x Synced 1mo ago READMEChangelog (1)Dependencies (26)Versions (37)Used By (5) Doctrine in Laminas API Tools ============================= [](#doctrine-in-laminas-api-tools) [![Build Status](https://github.com/laminas-api-tools/api-tools-doctrine/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/laminas-api-tools/api-tools-doctrine/actions/workflows/continuous-integration.yml)[![Total Downloads](https://camo.githubusercontent.com/5ccc935d1e87bf3055d146cdc818ea84400ce82ca7d31dfef3acaae790b641c2/68747470733a2f2f706f7365722e707567782e6f72672f6c616d696e61732d6170692d746f6f6c732f6170692d746f6f6c732d646f637472696e652f646f776e6c6f616473)](https://packagist.org/packages/laminas-api-tools/api-tools-doctrine) > ## 🇷🇺 Русским гражданам > > [](#-русским-гражданам) > > Мы, участники Laminas, родились и живем в разных странах. У многих из нас есть друзья, родственники и коллеги как в России, так и в Украине. Некоторые из нас родились в России. Некоторые из нас живут в России. У некоторых бабушки и дедушки сражались с фашистами во Второй мировой войне. Здесь никто не поддерживает фашизм. > > У одного из нас есть украинская родственница, которая спаслась из дома вместе с сыном. Поезд задержался из-за бомбежки на дороге впереди. У нас есть друзья, которые прячутся в бомбоубежищах. Мы с тревогой ждем весточки от них после воздушных налетов, которые беспорядочно наносят удары и попадают по больницам, школам, детским садам и домам. Мы не берем это из каких-либо СМИ. Мы наблюдаем это напрямую. > > Вы доверяете нам достаточно, чтоб использовать наши программы, и мы просим вас довериться нам вновь. Мы нуждаемся в помощи. Выходите и протестуйте против этой бесполезной войны. Остановите кровопролитие. Скажите "Нет войне!" > > ## 🇺🇸 To Citizens of Russia > > [](#-to-citizens-of-russia) > > We at Laminas come from all over the world. Many of us have friends, family and colleagues in both Russia and Ukraine. Some of us were born in Russia. Some of us currently live in Russia. Some have grandparents who fought Nazis in World War II. Nobody here supports fascism. > > One team member has a Ukrainian relative who fled her home with her son. The train was delayed due to bombing on the road ahead. We have friends who are hiding in bomb shelters. We anxiously follow up on them after the air raids, which indiscriminately fire at hospitals, schools, kindergartens and houses. We're not taking this from any media. These are our actual experiences. > > You trust us enough to use our software. We ask that you trust us to say the truth on this. We need your help. Go out and protest this unnecessary war. Stop the bloodshed. Say "stop the war!" This module provides the classes for integrating Doctrine with Laminas API Tools. Installation ------------ [](#installation) Installation of this module uses composer. For composer documentation, please refer to [getcomposer.org](http://getcomposer.org/). ``` $ composer require laminas-api-tools/api-tools-doctrine ``` This library provides two modules. The first, `Laminas\ApiTools\Doctrine\Server` provides the classes to serve data created by the second, `Laminas\ApiTools\Doctrine\Admin`. The *Admin* module is used to create api-tools resources and the Server serves those created resources. Generally you would include *Admin* in your `config/development.config.php`and *Server* in your `config/application.config.php`. `Laminas\ApiTools\Doctrine\Server` has a dependency with `Phpro\DoctrineHydrationModule` to handle entity hydration. See [documentation and instructions](https://github.com/phpro/zf-doctrine-hydration-module)on how to set up this module. > ### laminas-component-installer > > [](#laminas-component-installer) > > If you use [laminas-component-installer](https://github.com/laminas/laminas-component-installer), that plugin will install api-tools-doctrine, and all modules it depends on, as a module in your application configuration for you. For Apache installations it is recommended the [AllowEncodedSlashes-directive is set to On](http://httpd.apache.org/docs/2.4/mod/core.html#allowencodedslashes)so the configuration can be read. API Resources ------------- [](#api-resources) **NOTE!** This section was/is intended for the authors of [api-tools-admin-ui](https://github.com/laminas-api-tools/api-tools-admin-ui). While it is possible to use these instructions to manually create Laminas API Tools Doctrine resources it is strongly recommended to use the UI. `/api-tools/api/doctrine[/:object_manager_alias]/metadata[/:name]` This will return metadata for the named entity which is a member of the named object manager. Querying without a name will return all metadata for the object manager. `/api-tools/api/module[/:name]/doctrine[/:controller_service_name]` This is a Doctrine resource route *like* Laminas API Tools Rest `/api-tools/api/module[/:name]/rest[/:controller_service_name]`To create a resource do not include `[/:controller_service_name]` POST Parameters ``` { "objectManager": "doctrine.entitymanager.orm_default", "serviceName": "Artist", "entityClass": "Db\\Entity\\Artist", "routeIdentifierName": "artist_id", "entityIdentifierName": "id", "routeMatch": "/api/artist", "pageSizeParam": "limit", // optional, default null "hydratorName": "DbApi\\V1\\Rest\\Artist\\ArtistHydrator", // optional, default generated "hydrateByValue": true // optional, default true } ``` Hydrating Entities by Value or Reference ---------------------------------------- [](#hydrating-entities-by-value-or-reference) By default the admin tool hydrates entities by reference by setting `$config['doctrine-hydrator']['hydrator_class']['by_value']` to `false`. Custom Events ============= [](#custom-events) It is possible to hook in on specific doctrine events of the type `DoctrineResourceEvent`. This way, it is possible to alter the doctrine entities or collections before or after a specific action is performed. Supported events: ``` EVENT_FETCH_PRE = 'fetch.pre'; EVENT_FETCH_POST = 'fetch.post'; EVENT_FETCH_ALL_PRE = 'fetch-all.pre'; EVENT_FETCH_ALL_POST = 'fetch-all.post'; EVENT_CREATE_PRE = 'create.pre'; EVENT_CREATE_POST = 'create.post'; EVENT_UPDATE_PRE = 'update.pre'; EVENT_UPDATE_POST = 'update.post'; EVENT_PATCH_PRE = 'patch.pre'; EVENT_PATCH_POST = 'patch.post'; EVENT_PATCH_LIST_PRE = 'patch-all.pre'; EVENT_PATCH_LIST_POST = 'patch-all.post'; EVENT_DELETE_PRE = 'delete.pre'; EVENT_DELETE_POST = 'delete.post'; EVENT_DELETE_LIST_PRE = 'delete-list.pre'; EVENT_DELETE_LIST_POST = 'delete-list.post'; ``` Attach to events through the *Shared Event Manager*: ``` use Laminas\ApiTools\Doctrine\Server\Event\DoctrineResourceEvent; $sharedEvents = $this->getApplication()->getEventManager()->getSharedManager(); $sharedEvents->attach( 'Laminas\ApiTools\Doctrine\DoctrineResource', DoctrineResourceEvent::EVENT_CREATE_PRE, function(DoctrineResourceEvent $e) { $e->stopPropagation(); return new ApiProblem(400, 'Stop API Creation'); } ); ``` It is also possible to add custom event listeners to the configuration of a single doctrine-connected resource: ``` 'api-tools' => [ 'doctrine-connected' => [ 'Api\\V1\\Rest\\User\\UserResource' => [ // ... 'listeners' => [ 'key.of.aggregate.listener.in.service_manager', ], ], ], ], ``` Querying Single Entities ======================== [](#querying-single-entities) Multi-keyed entities -------------------- [](#multi-keyed-entities) You may delimit multi keys through the route parameter. The default delimiter is a period `.` (e.g. `1.2.3`). You may change the delimiter by setting the `DoctrineResource::setMultiKeyDelimiter($value)`. Complex queries through route parameters ---------------------------------------- [](#complex-queries-through-route-parameters) **NO LONGER SUPPORTED.** As of version 2.0.4 this functionality has been removed from this module. The intended use of this module is a 1:1 mapping of entities to resources and using subroutes is not in the spirit of this intention. It is STRONGLY recommended you use [laminas-api-tools/api-tools-doctrine-querybuilder](https://github.com/laminas-api-tools/api-tools-doctrine-querybuilder)for complex query-ability. Query Providers =============== [](#query-providers) Query Providers are available for all find operations. The find query provider is used to fetch an entity before it is acted upon for all *DoctrineResource* methods except create. A query provider returns a *QueryBuilder* object. By using a custom query provider you may inject conditions specific to the resource or user without modifying the resource. For instance, you may add a `$queryBuilder->andWhere('user = ' . $event->getIdentity());`in your query provider before returning the *QueryBuilder* created therein. Other uses include soft deletes so the end user can only see the active records. A custom plugin manager is available to register your own query providers. This can be done through this configuration: ``` 'api-tools-doctrine-query-provider' => [ 'aliases' => [ 'entity_name_fetch_all' => \Application\Query\Provider\EntityName\FetchAll::class, ], 'factories' => [ \Application\Query\Provider\EntityName\FetchAll::class => \Laminas\ServiceManager\Factory\InvokableFactory::class, ], ], ``` When the query provider is registered attach it to the doctrine-connected resource configuration. The default query provider is used if no specific query provider is set. You may set query providers for these keys: - default - fetch - fetch\_all - update - patch - delete ``` 'api-tools' => [ 'doctrine-connected' => [ 'Api\\V1\\Rest\\....' => [ 'query_providers' => [ 'default' => 'default_orm', 'fetch_all' => 'entity_name_fetch_all', // or fetch, update, patch, delete ], ], ], ], ``` Query Create Filters ==================== [](#query-create-filters) In order to filter or change data sent to a create statement before it is used to hydrate the entity you may use a query create filter. Create filters are very similar to *Query Providers* in their implementation. Create filters take the data as a parameter and return the data, modified or filtered. A custom plugin manager is available to register your own create filters. This can be done through following configuration: ``` 'api-tools-doctrine-query-create-filter' => [ 'aliases' => [ 'entity_name' => \Application\Query\CreateFilter\EntityName::class, ], 'factories' => [ \Application\Query\CreateFilter\EntityName::class => \Laminas\ServiceManager\Factory\InvokableFactory::class, ], ], ``` Register your Query Create Filter as: ``` 'api-tools' => [ 'doctrine-connected' => [ 'Api\\V1\\Rest\\....' => [ 'query_create_filter' => 'entity_name', ... ], ], ], ``` Using Entity Factories ====================== [](#using-entity-factories) By default, Doctrine entities are instantiated by FQCN without arguments. If you need anything different than that, for example if your entities require arguments in their constructors, you may specify the name of a `Doctrine\Instantiator\InstantiatorInterface` factory registered in the Service Manager in order to delegate instantiation to that service. Currently this can only be done by directly editing the config for your resources as follows: ``` 'api-tools' => [ 'doctrine-connected' => [ 'Api\\V1\\Rest\\...Resource' => [ 'entity_factory' => 'key_in_service_manager', ... ], ], ], ``` ### Health Score 48 — FairBetter than 95% of packages Maintenance27 Infrequent updates — may be unmaintained Popularity47 Moderate usage in the ecosystem Community36 Small or concentrated contributor base Maturity74 Established project with proven stability Bus Factor2 2 contributors hold 50%+ of commits 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 ~23 days Recently: every ~199 days Total 36 Last Release 1532d ago Major Versions 0.4.1 → 1.0.02019-12-31 1.1.1 → 2.0.02019-12-31 PHP version history (5 changes)0.1.0PHP >=5.4 0.3.0PHP >=5.3 2.0.4PHP >=5.4 || ^7.0 2.1.0PHP ^5.6 || ^7.0 2.4.0PHP ^7.3 || ~8.0.0 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/25943?v=4)[Matthew Weier O'Phinney](/maintainers/weierophinney)[@weierophinney](https://github.com/weierophinney) ![](https://avatars.githubusercontent.com/u/296074?v=4)[Zend Framework](/maintainers/zendframework)[@zendframework](https://github.com/zendframework) --- Top Contributors [![TomHAnderson](https://avatars.githubusercontent.com/u/493920?v=4)](https://github.com/TomHAnderson "TomHAnderson (195 commits)")[![michalbundyra](https://avatars.githubusercontent.com/u/7423207?v=4)](https://github.com/michalbundyra "michalbundyra (148 commits)")[![weierophinney](https://avatars.githubusercontent.com/u/25943?v=4)](https://github.com/weierophinney "weierophinney (79 commits)")[![veewee](https://avatars.githubusercontent.com/u/1618158?v=4)](https://github.com/veewee "veewee (42 commits)")[![jguittard](https://avatars.githubusercontent.com/u/5320213?v=4)](https://github.com/jguittard "jguittard (17 commits)")[![thomasvargiu](https://avatars.githubusercontent.com/u/732012?v=4)](https://github.com/thomasvargiu "thomasvargiu (6 commits)")[![gsomoza](https://avatars.githubusercontent.com/u/106219?v=4)](https://github.com/gsomoza "gsomoza (6 commits)")[![Hounddog](https://avatars.githubusercontent.com/u/1188248?v=4)](https://github.com/Hounddog "Hounddog (6 commits)")[![neeckeloo](https://avatars.githubusercontent.com/u/1768645?v=4)](https://github.com/neeckeloo "neeckeloo (3 commits)")[![ildanno](https://avatars.githubusercontent.com/u/8035078?v=4)](https://github.com/ildanno "ildanno (3 commits)")[![bartbrinkman](https://avatars.githubusercontent.com/u/8309358?v=4)](https://github.com/bartbrinkman "bartbrinkman (3 commits)")[![Thinkscape](https://avatars.githubusercontent.com/u/270528?v=4)](https://github.com/Thinkscape "Thinkscape (3 commits)")[![akomm](https://avatars.githubusercontent.com/u/2409779?v=4)](https://github.com/akomm "akomm (2 commits)")[![baptistemanson](https://avatars.githubusercontent.com/u/5444992?v=4)](https://github.com/baptistemanson "baptistemanson (2 commits)")[![Maks3w](https://avatars.githubusercontent.com/u/1301698?v=4)](https://github.com/Maks3w "Maks3w (2 commits)")[![matwright](https://avatars.githubusercontent.com/u/4989280?v=4)](https://github.com/matwright "matwright (2 commits)")[![pietervogelaar](https://avatars.githubusercontent.com/u/1067483?v=4)](https://github.com/pietervogelaar "pietervogelaar (2 commits)")[![royopa](https://avatars.githubusercontent.com/u/442991?v=4)](https://github.com/royopa "royopa (2 commits)")[![takethefake](https://avatars.githubusercontent.com/u/3123354?v=4)](https://github.com/takethefake "takethefake (2 commits)")[![datasage](https://avatars.githubusercontent.com/u/826651?v=4)](https://github.com/datasage "datasage (1 commits)") --- Tags hacktoberfestapilaminasdoctrineapi-tools ### Code Quality TestsPHPUnit Static AnalysisPsalm Type Coverage Yes ### Embed Badge ![Health badge](/badges/laminas-api-tools-api-tools-doctrine/health.svg) ``` [![Health](https://phpackages.com/badges/laminas-api-tools-api-tools-doctrine/health.svg)](https://phpackages.com/packages/laminas-api-tools-api-tools-doctrine) ``` ### Alternatives [doctrine/doctrine-orm-module Laminas Module that provides Doctrine ORM functionality 4407.3M293](/packages/doctrine-doctrine-orm-module)[doctrine/doctrine-module Laminas Module that provides Doctrine basic functionality required for ORM and ODM modules 3957.9M116](/packages/doctrine-doctrine-module)[laminas-api-tools/api-tools-admin Laminas API Tools Admin module 13794.3k5](/packages/laminas-api-tools-api-tools-admin)[doctrine/doctrine-laminas-hydrator Doctrine hydrators for Laminas applications 362.8M19](/packages/doctrine-doctrine-laminas-hydrator)[laminas-api-tools/api-tools Laminas API Tools module for Laminas 371.7M10](/packages/laminas-api-tools-api-tools)[laminas-api-tools/api-tools-skeleton Skeleton Application for Laminas API Tools 5520.7k](/packages/laminas-api-tools-api-tools-skeleton) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)