Download the PHP package vdhicts/conditions without Composer
On this page you can find all versions of the php package vdhicts/conditions. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package conditions
Conditions
This package offers a way to handle conditions for actions in your application. For example to check if a record has the required state (and which conditions are considered valid and/or invalid) or if a certain transition would be possible. See the Usage section for more examples.
Requirements
This package requires PHP 8.1+.
Installation
You can install the package via composer:
composer require vdhicts/conditions
Usage
Terms
- Condition: A condition is a single check which can be fulfilled or not. A condition can have a level, message and additional data.
- ConditionCollection: A collection of conditions.
- ConditionLevel: A condition level is a level which can be used to indicate the severity of a condition. Useful for displaying or filtering the conditions. Does not affect the fulfillment of a condition, so an info level condition which is not fulfilled is still a not fulfilled condition.
- ConditionTransformer: A condition transformer is used to transform a condition to another presentation or create the condition from another presentation.
Condition
First create a condition. A condition has at least a name. When the fulfilled parameter is not provided, the condition is considered fulfilled.
Condition collection
When you have multiple conditions, you can add them to a condition collection. A condition collection is considered fulfilled when all conditions in it are fulfilled or there aren't any conditions provided.
The collection can be checked if it is fulfilled or not.
To easily process the conditions, there are also some methods available to retrieve the conditions based on certain requirements.
It's also possible to merge multiple collections to one.
Transformer
A transformer can be used to transform a condition to another presentation or create the condition from another presentation.
Contribution
Found a bug or want to add a new feature? Great! There are also many other ways to make meaningful contributions such as reviewing outstanding pull requests and writing documentation. Even opening an issue for a bug you found is appreciated.
Security
If you discover any security related issues in this or other packages of Vdhicts, please email [email protected] instead of using the issue tracker.
License
This package is open-sourced software licensed under the MIT license.
About Vdhicts
Vdhicts develops and implements IT solutions for businesses based on the Laravel framework.