Command Registration System

Purpose and Overview

The Command Registration System is the core mechanism that makes all 30 commands available to the Hyperf framework through the ConfigProvider class. This system implements a fail-safe registration pattern that conditionally registers commands only when the required base dependency (Hyperf\Devtool\Generator\GeneratorCommand) is available, ensuring graceful degradation if dependencies are missing.

The ConfigProvider class located at src/ConfigProvider.php serves as the single registration point for:

• 2 development utility commands (WatchCommand, EventListCommand)
• 28 code generation commands (extending GeneratorCommand)

For information about the generator command architecture, see page 3.2. For the code generation system details, see page 4.

Sources: src/ConfigProvider.php1-82

ConfigProvider Class Structure

The Hypervel\Devtool\ConfigProvider class implements Hyperf's package discovery pattern through a single __invoke() method. This method is automatically called during application bootstrapping when Hyperf scans the composer.json file's extra.hyperf.config section.

Class Signature and Imports

Sources: src/ConfigProvider.php1-38

The class imports 30 command classes (lines 8-37) and one external base class for dependency checking (line 7). The namespace Hypervel\Devtool (line 5) indicates this is a Hypervel-specific extension.

Conditional Registration Logic

The __invoke() method implements a fail-safe pattern:

Sources: src/ConfigProvider.php41-81

The dependency check at src/ConfigProvider.php43-45 prevents fatal errors if the hyperf/devtool package is not installed or the GeneratorCommand base class is unavailable. This allows the package to be installed without breaking the application, though no commands will be available.

Return Structure

When dependencies are satisfied, the method returns an associative array with a commands key containing all 30 command class names:

Array Key	Value Type	Description
commands	array<int, class-string>	Array of fully-qualified command class names

Sources: src/ConfigProvider.php47-80

Command Organization and Categories

The 30 commands registered in src/ConfigProvider.php48-79 are organized into functional categories. The registration order in the code does not follow these categories, but the logical grouping helps understand the package's scope.

Command Registration Order and Categories

Sources: src/ConfigProvider.php48-79

Category Distribution

Category	Command Count	Primary Purpose
Database Migrations	7	Generate framework infrastructure table migrations
HTTP Layer	8	Generate controllers, middleware, requests, resources, and related HTTP components
Event System	6	Generate events, listeners, jobs, notifications, and messaging components
Model System	4	Generate models, factories, seeders, and observers
Development Utilities	2	Development tools (watch, event inspection)
Authorization	1	Generate policy classes
Testing	1	Generate test cases
CLI	1	Generate console commands

Sources: src/ConfigProvider.php48-79

Registration Process Flow

The registration process integrates with Hyperf's package discovery and command loading mechanisms:

Discovery and Registration Sequence

Sources: src/ConfigProvider.php41-81

Integration Points

The registration system integrates with Hyperf through these key points:

Integration Point	Location	Mechanism
Package Discovery	composer.json	extra.hyperf.config field lists ConfigProvider
Provider Invocation	Bootstrap phase	Hyperf calls ConfigProvider::__invoke()
Command Array	Return value	['commands' => [class-string, ...]] structure
Dependency Check	src/ConfigProvider.php43	class_exists(GeneratorCommand::class)
Command Instantiation	Runtime	DI container resolves command classes on demand

Sources: src/ConfigProvider.php41-81

Runtime Command Execution

When a developer executes a command (e.g., php bin/hyperf.php make:model User):

The command registry uses the class names registered by ConfigProvider to resolve command instances through the DI container.

Sources: src/ConfigProvider.php47-80

Complete Command Reference

All 30 commands registered by ConfigProvider are listed below with their registration line numbers and primary purposes:

Development Utilities (2 commands)

Command Class	Line	CLI Signature	Purpose
WatchCommand	49	watch	Monitors file changes and auto-restarts server
EventListCommand	63	event:list	Lists all registered events and their listeners

Database Migration Generators (7 commands)

Command Class	Line	CLI Signature	Purpose
SessionTableCommand	55	make:session-table	Generates session storage table migration
CacheTableCommand	56	make:cache-table	Generates cache table migration
CacheLocksTableCommand	57	make:cache-locks-table	Generates cache locks table migration
NotificationTableCommand	65	make:notifications-table	Generates notification storage table migration
QueueTableCommand	67	make:queue-table	Generates queue jobs table migration
QueueFailedTableCommand	68	make:queue-failed-table	Generates failed jobs table migration
BatchesTableCommand	66	make:batches-table	Generates job batches table migration

Model System Generators (4 commands)

Command Class	Line	CLI Signature	Purpose
ModelCommand	60	make:model	Generates model classes (can orchestrate factory, seeder, controller)
FactoryCommand	61	make:factory	Generates model factory classes
SeederCommand	62	make:seeder	Generates database seeder classes
ObserverCommand	71	make:observer	Generates model observer classes

HTTP Layer Generators (8 commands)

Command Class	Line	CLI Signature	Purpose
ControllerCommand	76	make:controller	Generates HTTP controller classes
MiddlewareCommand	75	make:middleware	Generates middleware classes (standard/PSR-15)
RequestCommand	64	make:request	Generates form request validation classes
ResourceCommand	77	make:resource	Generates API resource transformer classes
ComponentCommand	53	make:component	Generates view component classes
ProviderCommand	50	make:provider	Generates service provider classes
RuleCommand	58	make:rule	Generates custom validation rule classes
ExceptionCommand	78	make:exception	Generates exception handler classes

Event System Generators (6 commands)

Command Class	Line	CLI Signature	Purpose
EventCommand	51	make:event	Generates event classes
ListenerCommand	52	make:listener	Generates event listener classes
JobCommand	69	make:job	Generates job classes for queue processing
ChannelCommand	70	make:channel	Generates broadcasting channel classes
NotificationCommand	72	make:notification	Generates notification classes
MailCommand	73	make:mail	Generates mailable classes

Other Generators (3 commands)

Command Class	Line	CLI Signature	Purpose
PolicyCommand	74	make:policy	Generates authorization policy classes
TestCommand	54	make:test	Generates test case classes
ConsoleCommand	59	make:command	Generates custom console command classes

Sources: src/ConfigProvider.php48-79

Dependency Management

The ConfigProvider implements a defensive dependency check pattern to handle missing dependencies gracefully.

External Dependency: GeneratorCommand

Sources: src/ConfigProvider.php7-45

The dependency check at src/ConfigProvider.php43 uses class_exists(GeneratorCommand::class) to verify that the external base class from the hyperf/devtool package is available. This class is imported at src/ConfigProvider.php7

Fail-Safe Behavior

Condition	Return Value	Result
GeneratorCommand exists	['commands' => [...]]	All 30 commands registered
GeneratorCommand missing	[]	Empty array, no commands registered

This pattern ensures that:

1. The application doesn't crash if hyperf/devtool is not installed
2. No fatal class-not-found errors occur during bootstrapping
3. The package can be safely installed without breaking existing applications

Sources: src/ConfigProvider.php43-45

Summary

The Command Registration System is a critical foundation for the Hypervel Devtool package, making all code generation commands available to developers within a Hyperf application. Through the ConfigProvider class, approximately 24 different commands are registered, covering a wide range of application development needs from models and controllers to jobs, events, and database migrations.

This registration system demonstrates the integration capabilities of the Hyperf framework, allowing packages to seamlessly extend the framework's functionality while maintaining a consistent developer experience.

Sources: src/ConfigProvider.php33-70