zfcampus/zf-doctrine-querybuilder

Apigility Doctrine QueryBuilder module

ZF Doctrine QueryBuilder

Repository abandoned 2019-12-31

This repository has moved to laminas-api-tools/api-tools-doctrine-querybuilder., _(*1)

, _(*2)

This library provides query builder directives from array parameters. This library was designed to apply filters from an HTTP request to give an API fluent filter and order-by dialects., _(*3)

Philosophy

Given developers identified A and B: A == B with respect to ability and desire to filter and sort the entity data., _(*4)

The Doctrine entity to share contains, _(*5)

id integer,
name string,
startAt datetime,
endAt datetime,

Developer A or B writes the API. The resource is a single Doctrine Entity and the data is queried using a Doctrine QueryBuilder $objectManager->createQueryBuilder(). This module gives the other developer the same filtering and sorting ability to the Doctrine query builder, but accessed through request parameters, as the API author. For instance, startAt between('2015-01-09', '2015-01-11'); and name like ('%arlie') are not common API filters for hand rolled APIs and perhaps without this module the API author would choose not to implement it for their reason(s). With the help of this module the API developer can implement complex queryability to resources without complicated effort thereby maintaining A == B., _(*6)

Installation

Installation of this module uses composer. For composer documentation, please refer to getcomposer.org., _(*7)

$ composer require zfcampus/zf-doctrine-querybuilder

Once installed, add ZF\Doctrine\QueryBuilder to your list of modules inside config/application.config.php., _(*8)

zf-component-installer

If you use zf-component-installer, that plugin will install zf-doctrine-querybuilder as a module for you., _(*9)

Configuring the Module

Copy config/zf-doctrine-querybuilder.global.php.dist to config/autoload/zf-doctrine-querybuilder.global.php and edit the list of aliases for orm and odm to those you want enabled by default., _(*10)

Use With Apigility Doctrine

To enable all filters you may override the default query providers in zf-apigility-doctrine. Add this to your zf-doctrine-querybuilder.global.php config file and filters and order-by will be applied if they are in $_GET['filter'] or $_GET['order-by'] request. These $_GET keys are customizable through zf-doctrine-querybuilder-options:, _(*11)

'zf-apigility-doctrine-query-provider' => [
    'aliases' => [
        'default_orm' => \ZF\Doctrine\QueryBuilder\Query\Provider\DefaultOrm::class,
        'default_odm' => \ZF\Doctrine\QueryBuilder\Query\Provider\DefaultOdm::class,
    ],
    'factories' => [
        \ZF\Doctrine\QueryBuilder\Query\Provider\DefaultOrm::class => \ZF\Doctrine\QueryBuilder\Query\Provider\DefaultOrmFactory::class,
        \ZF\Doctrine\QueryBuilder\Query\Provider\DefaultOdm::class => \ZF\Doctrine\QueryBuilder\Query\Provider\DefaultOdmFactory::class,
    ],
],

Use

Configuration example, _(*12)

'zf-doctrine-querybuilder-orderby-orm' => [
    'aliases' => [
        'field' => \ZF\Doctrine\QueryBuilder\OrderBy\ORM\Field::class,
    ],
    'factories' => [
        \ZF\Doctrine\QueryBuilder\OrderBy\ORM\Field::class => \Zend\ServiceManager\Factory\InvokableFactory::class,
    ],
],
'zf-doctrine-querybuilder-filter-orm' => [
    'aliases' => [
        'eq' => \ZF\Doctrine\QueryBuilder\Filter\ORM\Equals::class,
    ],
    'factories' => [
        \ZF\Doctrine\QueryBuilder\Filter\ORM\Equals::class => \Zend\ServiceManager\Factory\InvokableFactory::class,
    ],
],

Request example, _(*13)

$_GET = [
    'filter' => [
        [
            'type'  => 'eq',
            'field' => 'name',
            'value' => 'Tom',
        ],
    ],
    'order-by' => [
        [
            'type'      => 'field',
            'field'     => 'startAt',
            'direction' => 'desc',
        ],
    ],
];

Resource example, _(*14)

$serviceLocator = $this->getApplication()->getServiceLocator();
$objectManager = $serviceLocator->get('doctrine.entitymanager.orm_default');

$filterManager = $serviceLocator->get('ZfDoctrineQueryBuilderFilterManagerOrm');
$orderByManager = $serviceLocator->get('ZfDoctrineQueryBuilderOrderByManagerOrm');

$queryBuilder = $objectManager->createQueryBuilder();
$queryBuilder->select('row')
    ->from($entity, 'row')
;

$metadata = $objectManager->getMetadataFactory()->getMetadataFor(ENTITY_NAME); // $e->getEntity() using doctrine resource event
$filterManager->filter($queryBuilder, $metadata, $_GET['filter']);
$orderByManager->orderBy($queryBuilder, $metadata, $_GET['order-by']);

$result = $queryBuilder->getQuery()->getResult();

Filters

Filters are not simple key/value pairs. Filters are a key-less array of filter definitions. Each filter definition is an array and the array values vary for each filter type., _(*15)

Each filter definition requires at a minimum a 'type'. A type references the configuration key such as 'eq', 'neq', 'between'., _(*16)

Each filter definition requires at a minimum a 'field'. This is the name of a field on the target entity., _(*17)

Each filter definition may specify 'where' with values of either 'and', 'or'., _(*18)

Embedded logic such as and(x or y) is supported through AndX and OrX filter types., _(*19)

Building HTTP GET query:

Javascript Example:, _(*20)

$(function () {
    $.ajax({
        url: "http://localhost:8081/api/db/entity/user_data",
        type: "GET",
        data: {
            'filter': [
                {
                    'field': 'cycle',
                    'where': 'or',
                    'type': 'between',
                    'from': '1',
                    'to': '100'
                },
                {
                    'field': 'cycle',
                    'where': 'or',
                    'type': 'gte',
                    'value': '1000'
                }
            ]
        },
        dataType: "json"
    });
});

Querying Relations

Single valued

It is possible to query collections by relations - just supply the relation name as fieldName and identifier as value., _(*21)

Assuming we have defined 2 entities, User and UserGroup..., _(*22)

/**
 * @Entity
 */
class User {
    /**
     * @ManyToOne(targetEntity="UserGroup")
     * @var UserGroup
     */
    protected $group;
}

/**
 * @Entity
 */
class UserGroup {}

find all users that belong to UserGroup id #1 by querying the user resource with the following filter:, _(*23)

['type' => 'eq', 'field' => 'group', 'value' => '1']

Collection valued

To match entities A that have entity B in a collection use ismemberof. Assuming User has a ManyToMany (or OneToMany) association with UserGroup..., _(*24)

/**
 * @Entity
 */
class User {
    /**
     * @ManyToMany(targetEntity="UserGroup")
     * @var UserGroup[]|ArrayCollection
     */
    protected $groups;
}

find all users that belong to UserGroup id #1 by querying the user resource with the following filter:, _(*25)

['type' => 'ismemberof', 'field' => 'groups', 'value' => '1']

Format of Date Fields

When a date field is involved in a filter you may specify the format of the date using PHP date formatting options. The default date format is Y-m-d H:i:s If you have a date field which is just Y-m-d, then add the format to the filter. For complete date format options see DateTime::createFromFormat, _(*26)

[
    'format' => 'Y-m-d',
    'value' => '2014-02-04',
]

Joining Entities and Aliasing Queries

There is an included ORM Query Type for Inner Join so for every filter type there is an optional alias. The default alias is 'row' and refers to the entity at the heart of the REST resource. There is not a filter to add other entities to the return data. That is, only the original target resource, by default 'row', will be returned regardless of what filters or order by are applied through this module., _(*27)

Inner Join is not included by default in the zf-doctrine-querybuilder.global.php.dist., _(*28)

This example joins the report field through the inner join already defined on the row entity then filters for r.id = 2:, _(*29)

    ['type' => 'innerjoin', 'field' => 'report', 'alias' => 'r'],
    ['type' => 'eq', 'alias' => 'r', 'field' => 'id', 'value' => '2']

You can inner join tables from an inner join using parentAlias:, _(*30)

    ['type' => 'innerjoin', 'parentAlias' => 'r', 'field' => 'owner', 'alias' => 'o'],

Inner Join is commented by default in the zf-doctrine-querybuilder.global.php.dist., _(*31)

There is also an ORM Query Type for LeftJoin. This join type is commonly used to fetch an empty right side of a relationship., _(*32)

Left Join is commented by default in the zf-doctrine-querybuilder.global.php.dist., _(*33)

    ['type' => 'leftjoin', 'field' => 'report', 'alias' => 'r'],
    ['type' => 'isnull', 'alias' => 'r', 'field' => 'id']

Included Filter Types

ORM and ODM

Equals:, _(*34)

['type' => 'eq', 'field' => 'fieldName', 'value' => 'matchValue']

Not Equals:, _(*35)

['type' => 'neq', 'field' => 'fieldName', 'value' => 'matchValue']

Less Than:, _(*36)

['type' => 'lt', 'field' => 'fieldName', 'value' => 'matchValue']

Less Than or Equals:, _(*37)

['type' => 'lte', 'field' => 'fieldName', 'value' => 'matchValue']

Greater Than:, _(*38)

['type' => 'gt', 'field' => 'fieldName', 'value' => 'matchValue']

Greater Than or Equals:, _(*39)

['type' => 'gte', 'field' => 'fieldName', 'value' => 'matchValue']

Is Null:, _(*40)

['type' => 'isnull', 'field' => 'fieldName']

Is Not Null:, _(*41)

['type' => 'isnotnull', 'field' => 'fieldName']

Note: Dates in the In and NotIn filters are not handled as dates. It is recommended you use multiple Equals statements instead of these filters for date datatypes., _(*42)

In:, _(*43)

['type' => 'in', 'field' => 'fieldName', 'values' => [1, 2, 3]]

NotIn:, _(*44)

['type' => 'notin', 'field' => 'fieldName', 'values' => [1, 2, 3]]

Between:, _(*45)

['type' => 'between', 'field' => 'fieldName', 'from' => 'startValue', 'to' => 'endValue']

Like (% is used as a wildcard):, _(*46)

['type' => 'like', 'field' => 'fieldName', 'value' => 'like%search']

ORM Only

Is Member Of:, _(*47)

['type' => 'ismemberof', 'field' => 'fieldName', 'value' => 1]

AndX:, _(*48)

In AndX queries, the conditions is an array of filter types for any of those described here. The join will always be and so the where parameter inside of conditions is ignored. The where parameter on the AndX filter type is not ignored., _(*49)

[
    'type' => 'andx',
    'conditions' => [
        ['field' =>'name', 'type'=>'eq', 'value' => 'ArtistOne'],
        ['field' =>'name', 'type'=>'eq', 'value' => 'ArtistTwo'],
    ],
    'where' => 'and',
]

OrX:, _(*50)

In OrX queries, the conditions is an array of filter types for any of those described here. The join will always be or so the where parameter inside of conditions is ignored. The where parameter on the OrX filter type is not ignored., _(*51)

[
    'type' => 'orx',
    'conditions' => [
        ['field' =>'name', 'type'=>'eq', 'value' => 'ArtistOne'],
        ['field' =>'name', 'type'=>'eq', 'value' => 'ArtistTwo'],
    ],
    'where' => 'and',
]

ODM Only

Regex:, _(*52)

['type' => 'regex', 'field' => 'fieldName', 'value' => '/.*search.*/i']

Included Order By Type

Field:, _(*53)

['type' => 'field', 'field' => 'fieldName', 'direction' => 'desc']