Skip to content

A PHP implementation of the Specification Pattern, a pattern that is frequently used in the context of domain-driven design

License

Notifications You must be signed in to change notification settings

Phauthentic/specification-pattern

Repository files navigation

Specification Pattern

PHP >= 8.1 phpstan Level 8 License: MIT

A PHP implementation of the Specification Pattern, a pattern that is frequently used in the context of domain-driven design.


In computer programming, the specification pattern is a particular software design pattern, whereby business rules can be recombined by chaining the business rules together using boolean logic.

A specification pattern outlines a business rule that is combinable with other business rules. In this pattern, a unit of business logic inherits its functionality from the abstract aggregate Composite Specification class. The Composite Specification class has one function called IsSatisfiedBy that returns a boolean value. After instantiation, the specification is "chained" with other specifications, making new specifications easily maintainable, yet highly customizable business logic. Furthermore, upon instantiation the business logic may, through method invocation or inversion of control, have its state altered in order to become a delegate of other classes such as a persistence repository.

As a consequence of performing runtime composition of high-level business/domain logic, the Specification pattern is a convenient tool for converting ad-hoc user search criteria into low level logic to be processed by repositories.

Since a specification is an encapsulation of logic in a reusable form it is very simple to thoroughly unit test, and when used in this context is also an implementation of the humble object pattern.

Example

$overDue = new OverDueSpecification();
$noticeSent = new NoticeSentSpecification();
$inCollection = new InCollectionSpecification();

// Example of specification pattern logic chaining
$sendToCollection = $overDue
    ->and($noticeSent)
    ->and($inCollection->not());

$invoiceCollection = $service->getInvoices();

foreach ($invoiceCollection as $invoice) {
    if ($sendToCollection->isSatisfiedBy($invoice)) {
        $invoice->sendToCollection();
    }
}

License

The MIT License (MIT)

About

A PHP implementation of the Specification Pattern, a pattern that is frequently used in the context of domain-driven design

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages