API Reference

This document provides complete API documentation for all public classes, interfaces, and methods in the Hypervel Validation package. It serves as a technical reference for developers implementing custom validation rules, integrating validators into applications, or extending the validation framework.

For implementation details of built-in validation rules, see page 3.1. For guidance on creating custom rules, see page 4.2. For configuration and dependency injection setup, see page 5.

Core Framework Contracts

The validation system is built around two primary contracts that define the main entry points for creating and using validators.

Factory Contract

The Factory interface defines how validator instances are created and how custom validation extensions are registered.

src/Contracts/Factory.php9-30

Method	Parameters	Return Type	Purpose
make	array $data, array $rules, array $messages = [], array $attributes = []	Validator	Creates a new validator instance
extend	string $rule, Closure|string $extension, ?string $message = null	void	Registers custom validator extension
extendImplicit	string $rule, Closure|string $extension, ?string $message = null	void	Registers implicit validator extension
replacer	string $rule, Closure|string $replacer	void	Registers custom message replacer

Validator Contract

The Validator interface extends MessageProvider and defines the complete validation lifecycle and result access methods.

src/Contracts/Validator.php12-74

Method	Parameters	Return Type	Purpose
validate	-	array	Runs validation, throws on failure
validated	-	array	Gets validated attributes, throws on failure
fails	-	bool	Checks if validation failed
failed	-	array	Gets failed validation rules
sometimes	array|string $attribute, array|string $rules, callable $callback	static	Adds conditional rules
after	callable|string $callback	static	Adds after validation callback
errors	-	MessageBag	Gets validation error messages
getTranslator	-	Translator	Gets translator instance
getData	-	array	Gets data under validation
setData	array $data	static	Sets data under validation
getException	-	string	Gets exception class name

Implementation Classes:

• src/Factory.php13-260 - Factory implementation
• src/Validator.php30-1755 - Validator implementation

Sources: src/Contracts/Factory.php9-30 src/Contracts/Validator.php12-74

Rule Contracts

The validation system supports multiple types of custom rules through different contracts, each optimized for specific use cases.

Basic Rule Contract

The Rule interface provides the traditional boolean-based validation approach.

src/Contracts/Rule.php7-18

Method	Parameters	Return Type	Purpose
passes	string $attribute, mixed $value	bool	Determines if validation passes
message	-	array|string	Gets validation error message

ValidationRule Contract

The ValidationRule interface uses a failure closure pattern for more flexible error handling.

src/Contracts/ValidationRule.php9-17

Method	Parameters	Return Type	Purpose
validate	string $attribute, mixed $value, Closure $fail	void	Runs validation with failure callback

The $fail closure signature: Closure(string, ?string=): \Hypervel\Translation\PotentiallyTranslatedString

InvokableRule Contract

The InvokableRule interface allows rules to be called directly as functions.

src/Contracts/InvokableRule.php9-17

Method	Parameters	Return Type	Purpose
__invoke	string $attribute, mixed $value, Closure $fail	void	Direct invocation for validation

The $fail closure signature matches ValidationRule for consistency.

ImplicitRule Contract

Rules implementing ImplicitRule are validated even when the attribute is missing from the data.

src/Contracts/ImplicitRule.php

This interface extends Rule but has no additional methods. The marker interface indicates that the rule should execute even for absent attributes (like required, filled, present).

DataAwareRule Contract

Rules implementing DataAwareRule can access the complete validation dataset for cross-field validation.

Method	Parameters	Return Type	Purpose
setData	array $data	static	Provides access to all validation data

ValidatorAwareRule Contract

Rules implementing ValidatorAwareRule can access the validator instance for complex validation scenarios.

Method	Parameters	Return Type	Purpose
setValidator	Validator $validator	static	Provides access to validator instance

Sources: src/Contracts/Rule.php7-18 src/Contracts/ValidationRule.php9-17 src/Contracts/InvokableRule.php9-17 src/Contracts/ImplicitRule.php src/Contracts/DataAwareRule.php src/Contracts/ValidatorAwareRule.php

Contract Relationship Architecture

Sources: src/Contracts/Factory.php9-30 src/Contracts/Validator.php12-74 src/Contracts/Rule.php7-18 src/Contracts/ValidationRule.php9-17 src/Contracts/InvokableRule.php9-17

Method Signatures and Integration Points

Factory Integration Pattern

Validation Execution Flow

Sources: src/Contracts/Factory.php11-29 src/Contracts/Validator.php14-73

Rule Implementation Patterns

Rule Contract Selection Guide

Contract	Use Case	Error Handling	Invocation Style
Rule	Simple boolean validation	Return string/array from message()	Traditional OOP
ValidationRule	Complex validation with context	Call $fail() closure	Modern closure-based
InvokableRule	Functional-style rules	Call $fail() closure	Direct function call

Closure Signature Reference

Both ValidationRule and InvokableRule use the same failure closure signature:

• $failureMessage: The validation error message
• $errorKey: Optional translation key for internationalization
• Returns: PotentiallyTranslatedString for translation system integration

Extension Registration Methods

Method	Rule Type	Behavior	Message Handling
extend	Explicit	Only validates when field is present	Custom message optional
extendImplicit	Implicit	Validates even when field is missing	Custom message optional
replacer	Message	Customizes placeholder replacement	N/A - message processing only

Sources: src/Contracts/Rule.php11-17 src/Contracts/ValidationRule.php14-16 src/Contracts/InvokableRule.php14-16 src/Contracts/Factory.php18-29