obviux/criteria

This package is abandoned and no longer maintained. No replacement package was suggested.

Create agnostic filtering criteria

1.1.1 2019-10-07 09:09 UTC

Requires

• ext-mongodb: *
• mongodb/mongodb: ^1.1.2
• nesbot/carbon: >=1.15.0

Requires (Dev)

• phpunit/phpunit: ^7.5

MIT

• David Sukkot

README

Use this library to create agnostic query filters. This enables loose coupling between the business code and the underlying datasets.

Installation

You can install the package via composer:

composer require obviux/critera

Basic criteria creation

Create a basic filter that will find any elements where the name property is equal to anonymous:

$criteria = Criteria::where()->name->eq('May B. Wright');

Create a filter with multiple requirements:

$criteria = Criteria::where()->name->eq('Justin Case')
    ->and->age->gte(20)
    ->and->age->lt(30)
;

This filter will match on any of the criterion:

$criteria = Criteria::where()->shape->eq('square')
    ->or->color->eq('red')
    ->or->size('medium')
;

Match on any or none of a list of multiple values. The list can either be provided as multiple arguments or as an array:

$criteria = Criteria::where()->rank->in(1, 2, 3);

$criteria = Criteria::where()->rank->nin([1, 2, 3);

Nesting is required to mix and/or criteria:

$criteria = Criteria::where(Criteria::where()->created->gte('2017-01-01')->and->created->lt('2018-01-01'))
    ->or(Criteria::where()->created->gte('2015-01-01')->and->created->lt('2016-01-01'))
;

If one of the elements is a single criterion, the initial criteria can be skipped:

$criteria = Criteria::where()->created->gte('2019-01-01')
    ->or(Criteria::where()->color->ne('white')->and->size->in('small', 'medium'))
;

Transformation of criteria

Use a transformer to generate output the criteria in a specific format. For example use the Mongo transformer to generate a query filter for MongoDB\Collection::find():

use Criteria\Criteria;
use Criteria\Transformers\Mongo;

$criteria = Criteria::where()->type->eq('desktop')
    ->and->bit->eq(64)
    ->and(Criteria::where(Criteria::where()->OS->eq('ubuntu')->and->version->gte("18.04"))
        ->or(Criteria::where(Criteria::where()->OS->eq('fedora')->and->version->gte(30)))
    )->and->release_date->gte(Carbon::parse('2019-01-01', 'UTC'))
;

echo json_encode($criteria->transform(new Mongo()), JSON_PRETTY_PRINT);

The above example will output:

{
    "$and": [
        {
            "type": {
                "$eq": "desktop"
            }
        },
        {
            "bit": {
                "$eq": 64
            }
        },
        {
            "$or": [
                {
                    "$and": [
                        {
                            "OS": {
                                "$eq": "ubuntu"
                            }
                        },
                        {
                            "version": {
                                "$gte": "18.04"
                            }
                        }
                    ]
                },
                {
                    "$and": [
                        {
                            "OS": {
                                "$eq": "fedora"
                            }
                        },
                        {
                            "version": {
                                "$gte": 30
                            }
                        }
                    ]
                }
            ]
        },
        {
            "release_date": {
                "$gte": {
                    "$date": {
                        "$numberLong": "1546300800000"
                    }
                }
            }
        }
    ]
}

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT