 |
VOOZH | about |
|
VOOZH | about |
This document describes the command replacement and aliasing system in the Hypervel Console package. The CommandReplacer class provides a mechanism to rename, alias, and remove console commands during application bootstrap. This system enables standardization of command naming conventions (such as converting gen:* commands to make:*) while maintaining backward compatibility through aliases, and allows removal of unwanted commands from the application's command registry.
For information about the base Command class and command execution lifecycle, see Command System. For details about the Application class that integrates with the replacer, see Application System.
The command replacement system operates as a transparent transformation layer between command registration and execution. When the application discovers commands, the CommandReplacer evaluates each command against a static replacement map and applies transformations as needed.
Sources: src/CommandReplacer.php50-71
The CommandReplacer class is a static utility that maintains a centralized mapping of command transformations.
| Component | Type | Purpose |
|---|---|---|
$commands | static array | Maps original command names to replacements |
replace() | static method | Applies transformation to a Command instance |
The $commands array supports three replacement patterns:
Sources: src/CommandReplacer.php11-48
The majority of replacements are simple string mappings that rename a command while preserving its original functionality and description. The original command name is retained as an alias for backward compatibility.
| Original Command | Replacement | Pattern |
|---|---|---|
gen:amqp-consumer | make:amqp-consumer | gen:* → make:* |
gen:amqp-producer | make:amqp-producer | gen:* → make:* |
gen:aspect | make:aspect | gen:* → make:* |
gen:class | make:class | gen:* → make:* |
gen:command | make:command | gen:* → make:* |
gen:kafka-consumer | make:kafka-consumer | gen:* → make:* |
gen:listener | make:listener | gen:* → make:* |
gen:middleware | make:middleware | gen:* → make:* |
gen:migration | make:migration | gen:* → make:* |
gen:nats-consumer | make:nats-consumer | gen:* → make:* |
gen:nsq-consumer | make:nsq-consumer | gen:* → make:* |
gen:process | make:process | gen:* → make:* |
gen:swagger | make:swagger | gen:* → make:* |
gen:migration-from-database | make:migration-from-database | gen:* → make:* |
gen:swagger-schema | make:swagger-schema | gen:* → make:* |
gen:view-engine-cache | view:cache | Special case |
describe:aspects | aspect:list | describe:* → *:list |
Sources: src/CommandReplacer.php18-46
Array-based replacements allow modification of both the command name and description. This pattern is used when renaming a command requires clarifying its purpose.
| Original Command | New Name | New Description |
|---|---|---|
start | serve | Start Hypervel servers |
describe:routes | route:list | List all registered routes |
Sources: src/CommandReplacer.php12-45
Commands mapped to null are removed from the application's command registry. This mechanism allows the package to disable commands that are not applicable to the Hypervel environment or have been deprecated.
| Command | Reason for Removal |
|---|---|
info | Not applicable to Hypervel |
server:watch | Not applicable to Hypervel |
gen:job | Replaced by different queue system |
gen:model | Custom model generation approach |
gen:seeder | Custom seeding approach |
gen:observer | Custom observer pattern |
gen:request | Custom request handling |
gen:resource | Custom resource approach |
describe:listeners | Not implemented |
Sources: src/CommandReplacer.php16-47
The replace() method implements the transformation logic, taking a Command instance and optionally maintaining the original name as an alias.
public static function replace(Command $command, bool $remainAlias = true): ?Command
| Parameter | Type | Default | Description |
|---|---|---|---|
$command | Command | required | The command instance to potentially transform |
$remainAlias | bool | true | Whether to keep the original name as an alias |
| Return Type | Condition | Meaning |
|---|---|---|
Command | No match in map | Original command unchanged |
Command | String/array replacement | Modified command with new name |
null | Null replacement | Command should be removed |
Sources: src/CommandReplacer.php50-71
The CommandReplacer is invoked by the Application class during command registration. According to the high-level architecture diagrams, the replacement occurs in the command parsing phase before the command is added to the registry.
Sources: src/CommandReplacer.php50-71
When remainAlias is true (the default), the original command name is preserved as an alias. This ensures backward compatibility:
Example:
php artisan gen:aspect MyAspect → executes make:aspectphp artisan make:aspect MyAspect → executes make:aspectSources: src/CommandReplacer.php62-64
The CommandReplacer uses a static array for its replacement map, which means the mappings are fixed at the package level. To customize command replacements:
Applications that need custom replacement behavior should extend the CommandReplacer class and override the $commands property:
// Custom replacer class structure
class CustomCommandReplacer extends CommandReplacer
{
protected static array $commands = [
// Add custom replacements
'my:command' => 'new:command',
// Remove unwanted mappings by omitting them
];
}
To rename commands without maintaining backward compatibility, pass false for the $remainAlias parameter:
CommandReplacer::replace($command, false);
This will rename the command without creating an alias, making only the new name available for invocation.
Sources: src/CommandReplacer.php50-64
The command replacement and aliasing system provides:
gen:* commands to make:* patternThe system operates as a simple but effective transformation layer, requiring no runtime overhead once commands are registered.
Sources: src/CommandReplacer.php1-72
Refresh this wiki