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

Aegisora Email Rule Guardian

Email Rule Guardian provides a simple shortcut for email validation using aegisora/guardian and aegisora/email-rule.

It is designed for cases where you want to quickly check whether a value is a valid email address without manually creating validation pipelines.

This package is built on top of:

• aegisora/guardian
• aegisora/email-rule

✨ Features

• 🔹 Simple shortcut API for EmailRule
• 🔹 Validates whether a value is a valid email address
• 🔹 Uses aegisora/guardian internally
• 🔹 Uses aegisora/email-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 EmailRule and passing it to Guardian, you can use EmailRuleGuardian directly.

🏗️ Basic Usage

🧩 Usage with Custom Exception

You may provide your own exception for validation failure.

If the value is not a valid email, 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 email validation is email_rule.

Custom exception

When a custom exception is passed as the second argument, it is thrown instead of GuardianValidationException on validation failure.

GuardianExecutingRuleException

Thrown when the underlying rule execution fails.

🧩 API

EmailRuleGuardian::check()

Parameters:

• $value (mixed) — value to validate as an email address
• $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
• 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. EmailRuleGuardian::check() is called
2. EmailRule::create() 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/email-rule — rule-based email 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.