Console Command Generation

Purpose and Scope

This document details the make:command generator, which creates custom console commands for the Hypervel framework. Console commands are CLI tools that extend the application's command-line interface, allowing developers to build custom administrative tasks, maintenance scripts, and automation tools.

For information about other utility generators, see:

• Validation rule generation: 11.2
• Exception generation: 11.3
• Test generation: 11.4

---

Command Overview

The make:command generator creates console command classes that extend Hypervel\Console\Command. These commands integrate with the framework's console kernel and can be invoked via the command-line interface.

Command Signature: make:command <name>

Primary Class: Hypervel\Devtool\Generator\ConsoleCommand

Output Location: App\Console\Commands\ (configurable)

Sources: src/Generator/ConsoleCommand.php1-52

---

Architecture and Class Structure

ConsoleCommand Class Hierarchy

The ConsoleCommand class follows the standard generator pattern, extending Hyperf's GeneratorCommand base class. It overrides key methods to customize behavior for console command generation.

Key Method Overrides:

Method	Purpose	Line Reference
configure()	Sets command description	src/Generator/ConsoleCommand.php18-23
getStub()	Returns path to console.stub template	src/Generator/ConsoleCommand.php36-39
getDefaultNamespace()	Returns default namespace for commands	src/Generator/ConsoleCommand.php41-44
replaceClass()	Processes stub placeholders, including signature	src/Generator/ConsoleCommand.php28-34
getOptions()	Adds --command option	src/Generator/ConsoleCommand.php46-51

Sources: src/Generator/ConsoleCommand.php11-52

---

Generation Flow

Command Execution Pipeline

The generation process involves:

1. Namespace resolution via getDefaultNamespace()
2. Stub selection via getStub()
3. Placeholder replacement via replaceClass() and inherited methods
4. File writing to the determined namespace path

Sources: src/Generator/ConsoleCommand.php28-44

---

Usage and Options

Basic Usage

Available Options

Option	Type	Description	Line Reference
--command	Optional	Explicitly set the terminal command signature	src/Generator/ConsoleCommand.php49
--force	Flag	Overwrite existing file (inherited)	From GeneratorCommand

Signature Auto-Generation

When the --command option is omitted, the signature is automatically generated using the following algorithm:

Implementation: The signature generation occurs in replaceClass() using Hyperf's Str helper:

Examples:

• SendEmails → app:send-emails
• GenerateReport → app:generate-report
• ProcessQueue → app:process-queue

Sources: src/Generator/ConsoleCommand.php31

---

Generated Command Structure

Stub Template Anatomy

Generated File Structure

The output file contains three key components:

1. Command Signature (src/Generator/stubs/console.stub14)

The $signature property defines how the command is invoked from the terminal. It can include:

• Command name
• Arguments
• Options
• Input descriptions

2. Command Description (src/Generator/stubs/console.stub19)

The $description appears in the command list (php bin/hypervel.php list).

3. Handle Method (src/Generator/stubs/console.stub24-27)

The handle() method contains the command's execution logic. It is invoked when the command runs.

Complete Example Output

For make:command SendEmails --command=email:send, the generated file at App/Console/Commands/SendEmails.php:

Sources: src/Generator/stubs/console.stub1-28

---

Signature Configuration Patterns

Advanced Signature Syntax

While the generator creates a basic signature, the $signature property supports advanced syntax after generation:

Arguments:

Optional Arguments:

Arguments with Defaults:

Options:

Options with Values:

Options with Defaults:

Signature Resolution Logic

Sources: src/Generator/ConsoleCommand.php28-34

---

Configuration and Customization

Configuration Options

The ConsoleCommand class supports configuration through the getConfig() method inherited from GeneratorCommand:

Available Configuration Keys:

Key	Purpose	Default	Line Reference
stub	Custom stub file path	__DIR__ . '/stubs/console.stub'	src/Generator/ConsoleCommand.php38
namespace	Custom namespace for commands	App\Console\Commands	src/Generator/ConsoleCommand.php43

Custom Namespace Example

To generate commands in a different namespace, configure the generator in your application's configuration:

Custom Stub Example

To use a custom stub template:

Configuration Resolution Flow

Sources: src/Generator/ConsoleCommand.php36-44

---

Stub Placeholder System

Available Placeholders

The console command stub uses three placeholders that are replaced during generation:

Placeholder	Replacement Source	Processing Method	Line Reference
%NAMESPACE%	getDefaultNamespace()	Inherited from GeneratorCommand	src/Generator/stubs/console.stub5
%CLASS%	Class basename from input	replaceClass() (parent)	src/Generator/stubs/console.stub9
%COMMAND%	--command option or auto-generated	replaceClass() (override)	src/Generator/stubs/console.stub14

Placeholder Processing Pipeline

Sources: src/Generator/ConsoleCommand.php28-34 src/Generator/stubs/console.stub5-14

---

Integration with Command Registration

After generation, console commands must be registered in the application's console kernel to be executable. This typically involves:

1. Auto-discovery: Commands in App\Console\Commands may be auto-discovered by the framework
2. Manual registration: Commands can be registered in the console kernel configuration

The generated command extends Hypervel\Console\Command, which provides:

• Input/output handling
• Option and argument parsing
• Integration with the console application lifecycle

Sources: src/Generator/stubs/console.stub7-9

---

Related Generators

The console command generator is part of the "Additional Generators" subsystem. Related generators include:

Generator	Purpose	Page Reference
make:rule	Validation rule classes	11.2
make:exception	Exception handler classes	11.3
make:test	PHPUnit test classes	11.4

Sources: src/Generator/ConsoleCommand.php1-52