How to use command line application with Aura framework?

The Aura framework is a lightweight framework based on the PHP language. It provides many tools and functions to help developers quickly build high-quality web applications. One of the very practical features is to use command line applications to speed up the development process. This article will introduce how to use command line applications in the Aura framework.

What is a command line application?

A command line application is a program that is executed through a console command (such as the command prompt in Windows or the terminal in Linux). Using command line applications is convenient for batch processing and automation tasks, and can also be used for rapid testing and debugging during development.

Create a command line application in the Aura framework

In order to create a command line application, we need to install the Aura.Cli component, which can be installed using Composer:

composer require aura/cli

After the installation is complete, perform the following initialization in the application's entry file:

// Initialize Aura.Di
$di = new AuraDiContainerBuilder();
$di->newInstance();

// Initialize Aura.Cli
$context = new AuraCliContextOptionFactory();
$stdio   = new AuraCliStdioHandle();

$cli = new AuraCliCliFactory($context);
$runner = $cli->newRunner([
    'stdio' => $stdio,
]);

Here we use Aura.Di to create a dependency injection container, and use Aura.Cli to create a CLI application runner (Runner).

Next, we can use the $runner->append() method to add the action of the command line application. For example, we created an operation named "hello" with the following code:

// Create a 'hello' action
class HelloWorldAction extends AuraCliActionAbstractAction
{
    public function __invoke()
    {
        $this->getStdout()->outln("Hello, world!");
    }
}
$runner->append('hello', new HelloWorldAction);

The operation created with the above method can be called on the command line:

php application.php hello

This command will Output the sentence "Hello, world!".

Next, we can add parameters and options to the operation, for example:

// Create a 'greet' action
class GreetAction extends AuraCliActionAbstractAction
{
    public function __invoke($name = null)
    {
        if (!$name) {
            $name = $this->getStdin()->in('What is your name? ');
        }

        $this->getStdout()->outln("Hello, {$name}!");
    }

    public function defineOptions($opts)
    {
        $opts->addOpt('n|name:', 'Your name');
    }

    public function defineArgs($args)
    {
        $args->add('name', 'Your name', true);
    }
}
$runner->append('greet', new GreetAction);

The operation created with the above code can be called like this on the command line:

php application.php greet --name John

This This command will output the sentence "Hello, John!" If the --name option is not provided, the user will be prompted for a name.

Conclusion

It is very convenient to use command line applications in the Aura framework. We can use the above methods to easily create our own command line applications and use them to speed up our development process. If you haven't tried using a command line application, now is a good time.

The above is the detailed content of How to use command line application with Aura framework?. For more information, please follow other related articles on the PHP Chinese website!