Download the PHP package aegisora/instanceof-rule-guardian without Composer

Aegisora Instanceof Rule Guardian

Instanceof Rule Guardian provides a simple shortcut for object type validation using aegisora/guardian and aegisora/instanceof-rule.

It is designed for cases where you want to quickly check whether a value is an instance of a given class without manually creating validation pipelines.

This package is built on top of:

• aegisora/guardian
• aegisora/instanceof-rule

✨ Features

• 🔹 Simple shortcut API for InstanceofRule
• 🔹 Validates whether a value is an instance of a given class
• 🔹 Uses aegisora/guardian internally
• 🔹 Uses aegisora/instanceof-rule internally
• 🔹 Supports custom validation exceptions
• 🔹 Fully compatible with the Aegisora ecosystem
• 🔹 Ready to use out of the box

📦 Installation

🚀 Core Concept

This package wraps the common validation flow:

into a dedicated shortcut class:

Instead of manually creating InstanceofRule and passing it to Guardian, you can use InstanceofRuleGuardian directly.

🏗️ Basic Usage

🧩 Usage with Custom Exception

You may provide your own exception for validation failure.

If the value is not an instance of User, the provided exception will be thrown.

This is useful when validation errors should have domain-specific meaning.

🧪 Example in Application Service

🚨 Exceptions

This package does not define its own exception types. All errors are raised by the underlying aegisora/guardian package.

Both exceptions extend the abstract base class Aegisora\Guardian\Exceptions\GuardianException, so you can catch every validation error with a single catch:

GuardianValidationException

Thrown when validation fails and no custom exception is provided.

GuardianExecutingRuleException

Thrown when the underlying rule execution fails.

Aegisora\Guardian\Exceptions\GuardianExecutingRuleException

🧩 API

InstanceofRuleGuardian::check()

Parameters:

• $value (mixed) — value to validate
• $targetClassName (string) — fully qualified class name to check against
• $exception (?\Throwable, default null) — optional custom exception thrown on validation failure

Returns void. The method communicates results through exceptions only — it returns nothing on success and throws on failure:

• GuardianValidationException — validation failed and no custom exception was provided
• GuardianExecutingRuleException — the underlying rule failed to execute
• the provided custom exception — validation failed and a custom exception was passed

Example:

With custom exception:

🏛️ Architecture

This package is a small shortcut layer over the Aegisora validation pipeline.

Flow:

1. InstanceofRuleGuardian::check() is called
2. InstanceofRule::create($targetClassName) is created
3. Guardian executes the rule
4. If validation succeeds, execution continues normally
5. If validation fails, custom exception or GuardianValidationException is thrown
6. If rule execution fails, GuardianExecutingRuleException is thrown

Internal flow:

🔗 Related Packages

• aegisora/guardian — validation execution orchestrator
• aegisora/instanceof-rule — rule-based object type validation
• 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.