Download the PHP package aegisora/numeric-range-rule without Composer

Aegisora Numeric Range Rule

Numeric Range Rule provides a simple, rule-based numeric range validation implementation for the Aegisora ecosystem.

It is built on top of aegisora/rule-contract and follows its strict validation architecture, ensuring consistent and predictable behavior across applications.

This rule is useful for validating user input, form fields, prices, quantities, ages, percentages, API request parameters, configuration values, and any other numeric value that must satisfy a range boundary.

📑 Table of Contents

• Features
• Installation
• Core Concept
• Basic Usage
• Valid vs Invalid
• Validation Result
• Guardian Usage
• Real-World Examples
• Factory Methods
• Architecture
• License
• Contributing
• Support

✨ Features

• 🔹 Lightweight and dependency-free except aegisora/rule-contract
• 🔹 Validates a numeric value against a lower bound, an upper bound, or a range
• 🔹 Supports strict (>, <) and inclusive (>=, <=) comparisons
• 🔹 Accepts integers, floats, and numeric strings via native is_numeric()
• 🔹 Rejects non-numeric input as an invalid context
• 🔹 Rejects an impossible range configuration (e.g. min > max) at construction time
• 🔹 Fully compatible with Aegisora validation pipeline
• 🔹 Strict Context → Result validation flow
• 🔹 No raw booleans — only structured results
• 🔹 Safe execution via base Rule abstraction
• 🔹 Expressive factory API for every boundary variation
• 🔹 Ready to use out of the box

📦 Installation

🚀 Core Concept

This package implements a single validation rule with several factory variations:

• accepts a numeric value via Context
• checks whether the value satisfies the configured boundary
• returns a standardized Result

Under the hood it wraps the common boilerplate:

into a reusable rule that reports its outcome through a Result object instead of a raw boolean.

🏗️ Basic Usage

✅ Valid vs Invalid

The rule passes when the numeric value satisfies the configured boundary and fails otherwise. Integers, floats, and numeric strings are all accepted as input.

Lower bound

Upper bound

Range

🧪 Validation Result

If the value satisfies the boundary, the rule returns a valid result.

$result->isValid(); // true

If the value is out of the boundary, the rule returns an invalid result.

If the context value is not numeric, the rule throws:

Aegisora\RuleContract\Exceptions\InvalidRuleContextException

The same exception is thrown at construction time when the range configuration is impossible, e.g. NumericRangeRule::createBetween(4, 2) ($min > $max) or an empty exclusive range such as NumericRangeRule::createBetweenExclusive(3, 3).

🔗 Guardian Usage

This rule can be used together with aegisora/guardian to build fluent validation pipelines.

If the value is out of the allowed boundary, Guardian throws the provided domain exception.

🧭 Real-World Examples

Numeric Range Rule is useful for enforcing range constraints before values are persisted or processed.

Examples

🧩 Factory Methods

NumericRangeRule::createGreaterThan($min);

• passes when the value is strictly greater than $min

NumericRangeRule::createGreaterThanOrEqualTo($min);

• passes when the value is greater than or equal to $min

NumericRangeRule::createLessThan($max);

• passes when the value is strictly less than $max

NumericRangeRule::createLessThanOrEqualTo($max);

• passes when the value is less than or equal to $max

NumericRangeRule::createBetween($min, $max);

• passes when the value is between $min and $max, both boundaries inclusive ($min <= value <= $max)

NumericRangeRule::createBetweenExclusive($min, $max);

• passes when the value is between $min and $max, both boundaries exclusive ($min < value < $max)

NumericRangeRule::createBetweenMinExclusive($min, $max);

• passes when the value is between $min (exclusive) and $max (inclusive) ($min < value <= $max)

NumericRangeRule::createBetweenMaxExclusive($min, $max);

• passes when the value is between $min (inclusive) and $max (exclusive) ($min <= value < $max)

NumericRangeRule::createBetween($min, $max)->validate($context);

• $context — Context wrapping the numeric value to validate

🏛️ Architecture

This package relies on aegisora/rule-contract.

Flow:

1. validate() is called
2. Context is passed in
3. The value is extracted from context (non-numeric values raise InvalidRuleContextException)
4. The value is compared against the configured boundary
5. Result is returned — valid on success, invalid with the numeric_range_rule code on failure

All logic is safely handled by Rule contract.

⚖️ 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.