anfischer/specification

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

PHP Specification pattern

![Software License][ico-license] ![Coverage Status][ico-scrutinizer] ![Total Downloads][ico-downloads], _(*1)

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)., _(*2)

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

Install

Via Composer, _(*4)

``` bash $ composer require anfischer/specification, <sub>(*5)</sub>

## 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:
``` php
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., <sub>(*6)</sub>

Testing

bash $ composer test, <sub>(*7)</sub>

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details., <sub>(*8)</sub>

Security

If you discover any security related issues, please email kontakt@season.dk instead of using the issue tracker., <sub>(*9)</sub>

Credits

• Andreas Fischer
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*10)</sub>