anfischer/specification

A package containing base classes to be used as a starting ground for implementing the Specification pattern in PHP.

v0.1.0 2018-06-26 13:29 UTC

Requires

• php: >=7.1

Requires (Dev)

• phpunit/phpunit: >=7.2.6
• squizlabs/php_codesniffer: ^2.3

MIT

• Andreas Fischer

• specification
• anfischer

README

A package containing base classes to be used as a starting ground for implementation of the Specification pattern in PHP (for more information see https://martinfowler.com/apsupp/spec.pdf).

This package includes the typical set of and(), or() and not() specifications as well as specifications for allOf(), anyOf() and noneOf().

Install

Via Composer

$ composer require anfischer/specification

Usage

General usage of this package can be inferred from its test cases.
However a very basic and simplified example of usage with a single specification to (not) satisfy might look like this:

use Anfischer\Specification\Specification;

class Invoice
{
    public function isOverdue()
    {
        /* Logic snip */
        return true;
    }
}

class OverdueInvoiceSpecification extends Specification
{
    public function isSatisfiedBy($invoice): bool
    {
        return $invoice->isOverdue();
    }
}

$overdue = new OverdueInvoiceSpecification;

// Will return true
$overdue->isSatisfiedBy(new Invoice);

// Will return false
$overdue->not()->isSatisfiedBy(new Invoice);

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Andreas Fischer
• All Contributors

License

The MIT License (MIT). Please see License File for more information.