state-inspector
![Software License][ico-license]
![Coverage Status][ico-scrutinizer]
![Total Downloads][ico-downloads], (*1)
Use Case:
Inspect if a state tree, a nested object or any object has certain states or values., (*2)
An Inspector can take n Inspections and an Inspection can produce several Issues.
The Inspector iterates Inspections which inspect the given object., (*3)
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., (*4)
Install
Via Composer, (*5)
``` bash
$ composer require freshcells/state-inspector, (*6)
## Usage
$inspector = new StateInspector();
$inspector->addInspection(new FooInspection());
$issues = $inspector->inspect($object);
See tests.
## Change log
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Testing
``` bash
$ composer test
Contributing
Please see CONTRIBUTING and CONDUCT for details., (*7)
Security
If you discover any security related issues, please email ivo.bathke@gmail.com instead of using the issue tracker., (*8)
Credits
License
The MIT License (MIT). Please see License File for more information., (*9)