Validation Rule Generation

Purpose and Scope

This document describes the validation rule generation system provided by the make:rule command. This generator creates custom validation rule classes that implement Hypervel's validation interface, allowing developers to define reusable validation logic for form requests and validation operations.

For generating form request validation classes that use these rules, see Request and Resource Generation. For other code generators, see Additional Generators.

---

Command Overview

The validation rule generator is implemented by the RuleCommand class, which extends the base GeneratorCommand infrastructure to create validation rule classes.

RuleCommand Class Structure

The RuleCommand class src/Generator/RuleCommand.php9-32 provides a minimal implementation focused on rule generation:

Method	Purpose	Return Value
__construct()	Registers command name make:rule	void
configure()	Sets description "Create a new validation rule"	void
getStub()	Returns path to rule.stub template	string
getDefaultNamespace()	Returns default namespace App\Rules	string

Sources: src/Generator/RuleCommand.php1-32

---

Class Hierarchy and Dependencies

Sources: src/Generator/RuleCommand.php9-32 src/Generator/stubs/rule.stub1-22

---

Stub Template Structure

The validation rule stub src/Generator/stubs/rule.stub1-22 defines the generated class structure:

Template Components

Key Template Features

Feature	Implementation	Line Reference
Strict typing	declare(strict_types=1)	src/Generator/stubs/rule.stub3
Namespace placeholder	%NAMESPACE%	src/Generator/stubs/rule.stub5
Class placeholder	%CLASS%	src/Generator/stubs/rule.stub10
Interface implementation	implements ValidationRule	src/Generator/stubs/rule.stub10
Validation method	validate(string $attribute, mixed $value, Closure $fail): void	src/Generator/stubs/rule.stub17
Fail closure type	Closure(string, ?string=): \Hypervel\Translation\PotentiallyTranslatedString	src/Generator/stubs/rule.stub15

Sources: src/Generator/stubs/rule.stub1-22

---

Generation Process Flow

Sources: src/Generator/RuleCommand.php9-32 src/Generator/stubs/rule.stub1-22

---

Generated Validation Rule Specification

Output File Structure

When executing make:rule UppercaseRule, the generator produces:

File Location: app/Rules/UppercaseRule.php

Class Structure:

Validation Method Contract

The validate() method src/Generator/stubs/rule.stub17-20 receives three parameters:

Parameter	Type	Purpose
$attribute	string	The name of the field being validated
$value	mixed	The value to validate
$fail	Closure	Callback to invoke when validation fails

The $fail closure accepts:

• First parameter: Error message (string)
• Second parameter: Translation parameters (optional string)
• Returns: PotentiallyTranslatedString instance

Sources: src/Generator/stubs/rule.stub15-20

---

Command Usage Patterns

Basic Usage

Common Validation Rule Patterns

Use Case	Example Class Name	Implementation Purpose
Custom format validation	PhoneNumberRule	Validate phone number format
Business logic validation	UniqueEmailRule	Check email uniqueness with custom logic
Complex conditional validation	ConditionalRequiredRule	Require field based on other fields
External API validation	RecaptchaRule	Validate reCAPTCHA token
Database constraint validation	ExistsInActiveRecordsRule	Check existence with additional constraints

Sources: src/Generator/RuleCommand.php9-32

---

Configuration Options

Namespace Configuration

The RuleCommand supports namespace customization through configuration src/Generator/RuleCommand.php28-31:

Stub Template Configuration

The stub template location can be customized src/Generator/RuleCommand.php23-26:

Configuration Resolution Flow

Sources: src/Generator/RuleCommand.php23-31

---

Integration with Validation System

Usage in Form Requests

Generated validation rules integrate with Hypervel's form request validation:

Manual Validator Usage

Rules can also be used with manual validator instances:

Validation Flow

Sources: src/Generator/stubs/rule.stub8-21

---

Command Registration

The RuleCommand is registered through the ConfigProvider src/ConfigProvider.php as part of the 28 generator commands:

This registration occurs only when Hyperf\Devtool\Generator\GeneratorCommand exists, ensuring graceful degradation if the base generator infrastructure is unavailable.

Sources: src/Generator/RuleCommand.php9-14

---

Comparison with Other Generators

Similarities to ConsoleCommand

Both RuleCommand and ConsoleCommand src/Generator/ConsoleCommand.php11-52 follow the same generator pattern:

Aspect	RuleCommand	ConsoleCommand
Base class	GeneratorCommand	GeneratorCommand
Stub location	stubs/rule.stub	stubs/console.stub
Custom options	None	--command for signature
Placeholder replacement	Standard	Adds %COMMAND%
Default namespace	App\Rules	App\Console\Commands

Key Differences

Sources: src/Generator/RuleCommand.php9-32 src/Generator/ConsoleCommand.php11-52