https://github.com/gpslab/specification-query

The simple infrastructure component for use a Doctrine specification as query in CQRS architecture
https://github.com/gpslab/specification-query

cqrs doctrine doctrine-orm infrastructure php query specification

Last synced: about 12 hours ago
JSON representation

The simple infrastructure component for use a Doctrine specification as query in CQRS architecture

• Host: GitHub
• URL: https://github.com/gpslab/specification-query
• Owner: gpslab
• License: mit
• Created: 2017-05-25T08:24:17.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-01-01T12:32:20.000Z (almost 5 years ago)
• Last Synced: 2024-04-15T10:04:18.969Z (8 months ago)
• Topics: cqrs, doctrine, doctrine-orm, infrastructure, php, query, specification
• Language: PHP
• Homepage:
• Size: 14.6 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Latest Stable Version](https://img.shields.io/packagist/v/gpslab/specification-query.svg?maxAge=3600&label=stable)](https://packagist.org/packages/gpslab/specification-query)

[![Total Downloads](https://img.shields.io/packagist/dt/gpslab/specification-query.svg?maxAge=3600)](https://packagist.org/packages/gpslab/specification-query)

[![Build Status](https://img.shields.io/travis/gpslab/specification-query.svg?maxAge=3600)](https://travis-ci.org/gpslab/specification-query)

[![Coverage Status](https://img.shields.io/coveralls/gpslab/specification-query.svg?maxAge=3600)](https://coveralls.io/github/gpslab/specification-query?branch=master)

[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/gpslab/specification-query.svg?maxAge=3600)](https://scrutinizer-ci.com/g/gpslab/specification-query/?branch=master)

[![SensioLabs Insight](https://img.shields.io/sensiolabs/i/a9e2cde7-1cbf-45bc-b89d-65c54f377967.svg?maxAge=3600&label=SLInsight)](https://insight.sensiolabs.com/projects/a9e2cde7-1cbf-45bc-b89d-65c54f377967)

[![StyleCI](https://styleci.io/repos/92381746/shield?branch=master)](https://styleci.io/repos/92381746)

[![License](https://img.shields.io/packagist/l/gpslab/specification-query.svg?maxAge=3600)](https://github.com/gpslab/specification-query)

# Doctrine Specification as query in CQRS architecture

The simple infrastructure component for use a [Doctrine Specification](https://github.com/Happyr/Doctrine-Specification) as query in [CQRS](https://github.com/gpslab/cqrs) architecture.

## Installation

Pretty simple with [Composer](http://packagist.org), run:

```sh

composer require gpslab/specification-query

```

## Usage

You can use Specifications as a simple query.

```php

use GpsLab\Component\Query\Bus\HandlerLocatedQueryBus;

use GpsLab\Component\Query\Handler\Locator\DirectBindingQueryHandlerLocator;

use GpsLab\Component\Query\Specification\SpecificationQueryHandler;

use GpsLab\Component\Query\Specification\ObviousSpecificationQuery;

// register query handler in handler locator

$locator = new DirectBindingQueryHandlerLocator();

$locator->registerHandler(ObviousSpecificationQuery::class, [new SpecificationQueryHandler($em), 'handleSpecification']);

// create bus with query handler locator

$bus = new HandlerLocatedQueryBus($locator);

// specification for get contact with id = 123

$spec = Spec::eq('id', 123);

// cache the result by 1 hour

$modifier = Spec::cache(3600);

// make specification query

$query = new ObviousSpecificationQuery('AcmeDemo:Contact', $spec, $modifier);

// get contact

$contact = $query_bus->handle($query);

```

### Custom query

You can create custom query for this case.

```php

class ContactWithIdentityQuery implements SpecificationQuery

{

    /**

     * @var int

     */

    private $id;

    /**

     * @param int $id

     */

    public function __construct($id)

    {

        $this->id = $id;

    }

    /**

     * @return string

     */

    public function entity()

    {

        return 'AcmeDemo:Contact';

    }

    /**

     * @return Specification

     */

    public function spec()

    {

        return Spec::eq('id', $this->id);

    }

    /**

     * @return ResultModifier|null

     */

    public function modifier()

    {

        return Spec::cache(3600);

    }

}

```

And use it

```php

use GpsLab\Component\Query\Bus\HandlerLocatedQueryBus;

use GpsLab\Component\Query\Handler\Locator\DirectBindingQueryHandlerLocator;

use GpsLab\Component\Query\Specification\SpecificationQueryHandler;

use GpsLab\Component\Query\Specification\ObviousSpecificationQuery;

// register query handler in handler locator

$locator = new DirectBindingQueryHandlerLocator();

$locator->registerHandler(ContactWithIdentityQuery::class, [new SpecificationQueryHandler($em), 'handleSpecification']);

// create bus with query handler locator

$bus = new HandlerLocatedQueryBus($locator);

// make specification query

$query = new ContactWithIdentityQuery(123);

// get contact

$contact = $query_bus->handle($query);

```

## License

This bundle is under the [MIT license](http://opensource.org/licenses/MIT). See the complete license in the file: LICENSE