Download the PHP package aegisora/is-callable-rule-guardian without Composer
On this page you can find all versions of the php package aegisora/is-callable-rule-guardian. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download aegisora/is-callable-rule-guardian
More information about aegisora/is-callable-rule-guardian
Files in aegisora/is-callable-rule-guardian
Package is-callable-rule-guardian
Short Description Is Callable Rule Guardian provides a simple shortcut for callable validation using aegisora/guardian and aegisora/is-callable-rule
License MIT
Homepage https://github.com/Aegisora/is-callable-rule-guardian
Informations about the package is-callable-rule-guardian
Aegisora Is Callable Rule Guardian
Is Callable Rule Guardian provides a simple shortcut for callable validation using aegisora/guardian and aegisora/is-callable-rule.
It is designed for cases where you want to quickly check whether a value is callable, without manually building an IsCallableRule and a validation pipeline by hand.
This package is built on top of:
โจ Features
- ๐น Simple shortcut API for
IsCallableRule - ๐น Validates that a value is callable via
check() - ๐น Works with closures, invokable objects, function names and array callables
- ๐น Uses
aegisora/guardianinternally - ๐น Uses
aegisora/is-callable-ruleinternally - ๐น Supports a custom validation exception
- ๐น Keeps rule execution errors separated from validation errors
- ๐น Fully compatible with the Aegisora ecosystem
- ๐น Ready to use out of the box
๐ฆ Installation
๐ Core Concept
This package wraps the common callable validation flow:
into a dedicated shortcut class:
Instead of manually creating an IsCallableRule and passing it to Guardian, you can use IsCallableRuleGuardian directly.
๐๏ธ Basic Usage
check() passes when $value is callable, and fails otherwise.
โ How the callable check works
A value is considered callable when it can be invoked as a function:
An object is also callable when it implements the __invoke() magic method.
๐งฉ Usage with Custom Exception
You may provide your own exception for validation failure. It must be the last argument.
If the value is not callable, the provided exception will be thrown instead of GuardianValidationException.
This is useful when validation errors should have domain-specific meaning.
๐งช Example in Application Service
๐จ Exceptions
The package raises validation-related exceptions, all delegated to Guardian (the outcome of running the rule):
GuardianValidationException
Thrown when validation fails and no custom exception is provided.
The rule code for a failed callable check is is_callable_rule.
Custom exception
When a custom exception is passed as the last argument, it is thrown instead of GuardianValidationException on validation failure.
GuardianExecutingRuleException
Thrown when the underlying rule fails to execute (raises a RuleException during validation), as opposed to simply reporting an invalid result.
The callable check accepts any value type and reports non-callable values as an invalid result, so this exception is not triggered by the input itself โ it is surfaced only if Guardian fails to execute the rule.
๐งฉ API
IsCallableRuleGuardian::check()
Validates that $value is callable.
Arguments:
$valueโ the value to validate$exceptionโ an optional custom\Throwableto be thrown on validation failure
The method returns void. It communicates results through exceptions only โ it returns nothing on success and throws on failure:
GuardianValidationExceptionโ the callable check failed and no custom exception was provided- the provided custom exception โ the check failed and a custom exception was passed
GuardianExecutingRuleExceptionโ the rule could not be executed
๐๏ธ Architecture
This package is a small shortcut layer over the Aegisora validation pipeline.
Flow:
IsCallableRuleGuardian::check()is called with a value and an optional exception- An
IsCallableRuleis created (create()) Guardianexecutes the rule against the value- If the check passes, execution continues normally
- If the check fails, the custom exception or
GuardianValidationExceptionis thrown - If the rule could not be executed,
GuardianExecutingRuleExceptionis thrown
Internal flow:
๐ Related Packages
- aegisora/guardian โ validation execution orchestrator
- aegisora/is-callable-rule โ is callable rule
- aegisora/rule-contract โ base rule contract and validation result architecture
โ๏ธ License
This package is open-source and licensed under the MIT License. See the LICENSE for details.
๐ฑ Contributing
Contributions are welcome and greatly appreciated!. See the CONTRIBUTING for details.
๐ Support
If you find this project useful, please consider giving it a star on GitHub!
It helps the project grow and motivates further development.