Download the PHP package aegisora/in-array-rule-guardian without Composer

Aegisora In-Array Rule Guardian

In-Array Rule Guardian provides a simple shortcut for in-array value validation using aegisora/guardian and aegisora/in-array-rule.

It is designed for cases where you want to quickly check whether a value is contained in a given array without manually creating validation pipelines.

This package is built on top of:

• aegisora/guardian
• aegisora/in-array-rule

✨ Features

• 🔹 Simple shortcut API for InArrayRule
• 🔹 Validates whether a value is present in an array
• 🔹 Supports both strict and soft (loose) comparison
• 🔹 Uses aegisora/guardian internally
• 🔹 Uses aegisora/in-array-rule internally
• 🔹 Supports custom validation exceptions
• 🔹 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 validation flow:

into a dedicated shortcut class:

Instead of manually creating InArrayRule and passing it to Guardian, you can use InArrayRuleGuardian directly.

🏗️ Basic Usage

⚖️ Strict vs Soft Comparison

The package exposes two methods that differ only in how values are compared.

checkStrict()

Uses strict comparison (===). Both the type and the value must match.

checkSoft()

Uses loose comparison (==). Only the value must match after type juggling.

Both methods share the same signature and behaviour regarding exceptions — only the comparison mode changes.

🧩 Usage with Custom Exception

You may provide your own exception for validation failure.

If the value is not present in the array, 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. It delegates execution to Guardian and re-throws the exceptions raised by the underlying pipeline.

GuardianValidationException

Thrown when validation fails and no custom exception is provided.

The rule code for failed in-array validation is in_array_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 execution fails.

🧩 API

InArrayRuleGuardian::checkStrict()

Validates that $value is present in $actualArray using strict comparison (===).

InArrayRuleGuardian::checkSoft()

Validates that $value is present in $actualArray using loose comparison (==).

Parameters (both methods):

• $value (mixed) — value to look for in the array
• $actualArray (mixed[]) — array of allowed values (the haystack)
• $exception (?\Throwable, default null) — optional custom exception thrown on validation failure

Both methods return void. They communicate results through exceptions only — they return nothing on success and throw on failure:

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

Example:

With custom exception:

🏛️ Architecture

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

Flow:

1. InArrayRuleGuardian::checkStrict() / checkSoft() is called
2. InArrayRule::createStrict() / InArrayRule::createSoft() is created
3. Guardian executes the rule
4. If validation succeeds, execution continues normally
5. If validation fails, the custom exception or GuardianValidationException is thrown
6. If rule execution fails, GuardianExecutingRuleException is thrown

Internal flow:

🔗 Related Packages

• aegisora/guardian — validation execution orchestrator
• aegisora/in-array-rule — rule-based in-array 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.