freshcells/state-inspector

inspects the state of a given object

2.1.0 2022-03-29 11:52 UTC

Requires

• php: ^7.4|^8.0|^8.1

Requires (Dev)

• phpunit/phpunit: ^9.0
• squizlabs/php_codesniffer: ^3

MIT

• Ivo Bathke

• state-inspector

README

Use Case:
Inspect if a state tree, a nested object or any object has certain states or values.

An Inspector can take n Inspections and an Inspection can produce several Issues. The Inspector iterates Inspections which inspect the given object.

When the bubble option is true it will throw an exception immediatly if one occurs. If bubble is false it will collect issues and they can be retrieved after Inspector has finished.

Install

Via Composer

$ composer require freshcells/state-inspector

Usage

    $inspector = new StateInspector();
    $inspector->addInspection(new FooInspection());
    $issues = $inspector->inspect($object);

See tests.

Change log

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

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

Credits

• Ivo Bathke
• All Contributors

License

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