当前位置：极客教程 > PHP > Symfony 教程 > Symfony 控制台命令

Symfony 控制台命令

Symfony 控制台命令教程介绍了如何在 Symfony 中创建控制台命令。 我们将在控制台应用中创建几个命令。

Symfony 控制台组件

Symfony 控制台组件使我们可以创建命令行命令。 控制台命令可用于创建 cronjob，导入，批处理作业或某些支持性任务。 Symfony 控制台命令可以在 Symfony 控制台应用或 Web 应用中使用。 在本教程中，我们将为控制台应用创建命令。

Symfony 控制台命令示例

在以下示例中，我们使用 Symfony Console 组件创建 Symfony 控制台应用。

$ mkdir commands
$ cd commands
PHP

我们创建一个项目目录并找到它。

$ composer require symfony/console
PHP

我们安装console软件包。

composer.json

{
    "name": "Symfony command application",
    "description": 
    "This application demonstrates the usage of a Symfony command in a console application",
    "require": {
        "symfony/console": "^4.2"
    },
    "autoload": {
        "psr-4": {
            "App\\": "src"
        }
    }
}
PHP

我们更新composer.json文件。 我们启用App名称空间下src目录中的 PHP 类的自动加载。

$ composer dump-autoload -o
PHP

创建文件后，我们需要调用composer dump-autoload -o命令，该命令将创建一个将类映射到 PHP 文件的文件。

在应用中，我们将有五个命令：

  • TimeCommand-显示当前日期和时间
  • MessageCommand-显示来自用户输入的消息
  • ColorCommand-以彩色显示消息
  • BooksCommand-在表格中显示书籍列表
  • AskNameCommand-交互式询问用户名

这些命令在src/Command目录中创建。 社区必须扩展Symfony\Component\Console\Command并实现其configure()和execute()方法。

之后，将命令与add()一起添加到Symfony\Component\Console\Application。

src/Command/TimeCommand.php

<?php

namespace App\Command;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

class TimeCommand extends Command 
{
    protected function configure()
    {
        this->setName('time')
        ->setDescription('Shows current date and time')
        ->setHelp('This command prints the current date and time');
    }

    protected function execute(InputInterfaceinput, OutputInterface output)
    {now = date('c');
        message = sprintf("Current date and time: %s",now);

        output->writeln(message);
    }
}
PHP

TimeCommand显示当前日期和时间。

protected function configure()
{
    $this->setName('time')
    ->setDescription('Shows current date and time')
    ->setHelp('This command prints the current date and time');
}
PHP

在configure()中，我们使用setName()设置命令的名称。 名称将显示在可用命令列表中。 我们还为命令添加了描述和帮助。

protected function execute(InputInterface input, OutputInterfaceoutput)
{
    now = date('c');message = sprintf("Current date and time: %s", now);output->writeln($message);
}
PHP

InputInterface用于从用户获取输入，OutputInterface用于显示输出。 在我们的例子中，我们使用标准 ISO 格式的date()获取当前日期和时间，并使用writeln()将其输出到控制台。

src/Command/MessageCommand.php

<?php

namespace App\Command;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Input\InputArgument;

class MessageCommand extends Command
{
    protected function configure()
    {
        this->setName('msg')
            ->setDescription('Prints a user provided message')
            ->setHelp('This command prints a message provided by the user')
            ->addArgument('msg', InputArgument::REQUIRED, 'Pass a message');
    }

    protected function execute(InputInterfaceinput, OutputInterface output)
    {message = sprintf('The message is: %s', input->getArgument('msg'));output->writeln($message);
    }
}
PHP

MessageCommand打印从用户的参数检索到的消息，并将其输出到控制台。

$this->setName('msg')
    ->setDescription('Prints a user provided message')
    ->setHelp('This command prints a message provided by the user')
    ->addArgument('msg', InputArgument::REQUIRED, 'Pass a message');
PHP

该参数可以是必需的，也可以是可选的。 InputArgument::REQUIRED值使该参数成为必需参数。

$message = sprintf('The message is: %s', $input->getArgument('msg'));
$output->writeln($message);
PHP

我们从输入中检索带有getArgument()的参数，然后使用writeln()将该参数写入控制台。

src/Command/ColorCommand.php

<?php

namespace App\Command;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Formatter\OutputFormatterStyle;

class ColorCommand extends Command
{
    protected function configure()
    {
        this->setName('colc')
            ->setDescription('Shows output in color')
            ->setHelp('This command shows output in color');
    }

    protected function execute(InputInterfaceinput, OutputInterface output)
    {output->writeln("<info>Today is a windy day</info>");

        outputStyle = new OutputFormatterStyle('red');output->getFormatter()->setStyle('redt', outputStyle);output->writeln('<redt>Tomorrow will be snowing</redt>');
    }
}
PHP

ColorCommand以彩色输出文本。

$output->writeln("<info>Today is a windy day</info>");
PHP

在这种情况下，我们使用内置的info格式样式。

$outputStyle = new OutputFormatterStyle('red');
$output->getFormatter()->setStyle('redt', $outputStyle);

$output->writeln('<redt>Tomorrow will be snowing</redt>');
PHP

我们还可以使用OutputFormatterStyle创建自定义输出样式。 我们的redt以红色显示文字。

src/Command/BooksCommand.php

<?php

namespace App\Command;

use Symfony\Component\Console\Helper\Table;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

class BooksCommand extends Command
{
    protected function configure() 
    {
        this->setName('books')
            ->setDescription('Shows books in a table')
            ->setHelp('This command demonstrates the usage of a table helper');
    }

    protected function execute(InputInterfaceinput, OutputInterface output)
    {table = new Table(output);table->setHeaderTitle('Books')
            ->setHeaders(['Title', 'ISBN', 'Author', 'Publisher'])
            ->setRows([
                ['Java Language Features', '978-1-4842-3347-4', 'Kishori Sharan', 'Apress' ],
                ['Python Testing with pytest', '978-1-68-050-240-4', 'Brian Okken', 'The Pragmatic Programmers' ],
                ['Deep Learning with Python', '978-1-61729-443-3', 'Francois Chollet', 'Manning' ],
                ['Laravel up & Running', '978-1-491-93698-5', 'Matt Stauffer', 'O\'Reilly' ],
                ['Sams Teach Yourself TCP/IP', '978-0-672-33789-5', 'Joe Casad', 'SAMS' ]
            ]);

          $table->render();
    }   
}
PHP

BooksCommand使用表格助手以表格格式输出数据。

$table = new Table($output);
PHP

我们创建一个Table帮助器的实例。

$table->setHeaderTitle('Books')
    ->setHeaders(['Title', 'ISBN', 'Author', 'Publisher'])
    ->setRows([
        ['Java Language Features', '978-1-4842-3347-4', 'Kishori Sharan', 'Apress' ],
        ['Python Testing with pytest', '978-1-68-050-240-4', 'Brian Okken', 'The Pragmatic Programmers' ],
        ['Deep Learning with Python', '978-1-61729-443-3', 'Francois Chollet', 'Manning' ],
        ['Laravel up & Running', '978-1-491-93698-5', 'Matt Stauffer', 'O\'Reilly' ],
        ['Sams Teach Yourself TCP/IP', '978-0-672-33789-5', 'Joe Casad', 'SAMS' ]
    ]);
PHP

我们建立表。 表标题标题由setHeaderTitle()指定。 header名称由setHeaders()指定。 最后，将数据与setRows()相加。

$table->render();
PHP

该表使用render()呈现。

src/Command/AskNameCommand.php

<?php

namespace App\Command;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Question\Question;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

class AskNameCommand extends Command
{
    protected function configure() 
    {
        this->setName('ask')
            ->setDescription('Interactively asks name from the user')
            ->setHelp('This command asks a user name interactively and prints it');
    }

    protected function execute(InputInterfaceinput, OutputInterface output)
    {helper = this->getHelper('question');question = new Question("Enter your name: ", "guest");

        name =helper->ask(input,output, question);message = sprintf("Hello %s!", name);output->writeln($message);
    }
}
PHP

AskNameCommand使用问题助手来请求用户输入。

$helper = $this->getHelper('question');
PHP

使用getHelper()创建一个问题帮助器。

$question = new Question("Enter your name: ", "guest");
PHP

创建一个新的Question问题。 第二个参数是默认值。

$name = $helper->ask($input, $output, $question);
PHP

问题通过ask()激活。 用户输入存储在$name变量中。

$message = sprintf("Hello %s!", $name);
PHP

我们使用sprintf()从用户输入构建消息。

$output->writeln($message);
PHP

最后，该消息在终端中显示为writeln()。

使用Symfony\Component\Console\Application创建一个新的 Symfony 应用。

Application.php

<?php

require __DIR__ . '/vendor/autoload.php';

use App\Command\TimeCommand;
use App\Command\BooksCommand;
use App\Command\ColorCommand;
use App\Command\AskNameCommand;
use App\Command\MessageCommand;
use Symfony\Component\Console\Application;

app = new Application();app->add(new MessageCommand());
app->add(new TimeCommand());app->add(new AskNameCommand());
app->add(new BooksCommand());app->add(new ColorCommand());

$app->run();
PHP

我们用五个命令创建一个 Symfony 控制台应用。

$app = new Application();
PHP

创建一个新的控制台应用。

$app->add(new MessageCommand());
$app->add(new TimeCommand());
$app->add(new AskNameCommand());
$app->add(new BooksCommand());
$app->add(new ColorCommand());
PHP

我们向应用添加命令。

$app->run();
PHP

应用从run()启动。

$ php application.php list
Console Tool
...
Available commands:
    ask    Interactively asks name from the user
    books  Shows books in a table
    colc   Shows output in color
    help   Displays help for a command
    list   Lists commands
    msg    Prints a user provided message
    time   Shows current date and time
PHP

我们可以获得命令列表。

$ php application.php books
+----------------------------+--------------- Books -----------------+---------------------------+
| Title                      | ISBN               | Author           | Publisher                 |
+----------------------------+--------------------+------------------+---------------------------+
| Java Language Features     | 978-1-4842-3347-4  | Kishori Sharan   | Apress                    |
| Python Testing with pytest | 978-1-68-050-240-4 | Brian Okken      | The Pragmatic Programmers |
| Deep Learning with Python  | 978-1-61729-443-3  | Francois Chollet | Manning                   |
| Laravel up & Running       | 978-1-491-93698-5  | Matt Stauffer    | O'Reilly                  |
| Sams Teach Yourself TCP/IP | 978-0-672-33789-5  | Joe Casad        | SAMS                      |
+----------------------------+--------------------+------------------+---------------------------+
PHP

我们运行 books 命令。

$ php application.php time
Current date and time: 2018-12-20T23:27:16+01:00
PHP

我们运行时间命令。

在本教程中，我们在 Symfony 控制台应用中创建了五个控制台命令。

$ php application.php ask
Enter your name: Peter
Hello Peter!
PHP

我们运行 ask 命令。

您可能也对以下相关教程感兴趣： Symfony 简介， Symfony 验证教程， Symfony Flash 消息， Symfony 服务教程 ， Symfony 表单教程， PHP 教程。

Python教程

Python 教程

Python 教程
Tkinter 教程

Tkinter 教程
Pandas 教程

Pandas 教程
NumPy 教程

NumPy 教程
Flask 教程

Flask 教程
Django 教程

Django 教程
PySpark 教程

PySpark 教程
wxPython 教程

wxPython 教程
SymPy 教程

SymPy 教程
Seaborn 教程

Seaborn 教程
SciPy 教程

SciPy 教程
RxPY 教程

RxPY 教程
Pycharm 教程

Pycharm 教程
Pygame 教程

Pygame 教程
PyGTK 教程

PyGTK 教程
PyQt 教程

PyQt 教程
PyQt5 教程

PyQt5 教程
PyTorch 教程

PyTorch 教程
Matplotlib 教程

Matplotlib 教程
Web2py 教程

Web2py 教程
BeautifulSoup 教程

BeautifulSoup 教程

Java教程

Java 教程

Java 教程

Web教程

HTML 教程

HTML 教程
CSS 教程

CSS 教程
CSS3 教程

CSS3 教程
jQuery 教程

jQuery 教程
Ajax 教程

Ajax 教程
AngularJS 教程

AngularJS 教程
TypeScript 教程

TypeScript 教程
WordPress 教程

WordPress 教程
Laravel 教程

Laravel 教程
Next.js 教程

Next.js 教程
PhantomJS 教程

PhantomJS 教程
Three.js 教程

Three.js 教程
Underscore.JS 教程

Underscore.JS 教程
WebGL 教程

WebGL 教程
WebRTC 教程

WebRTC 教程
VueJS 教程

VueJS 教程

数据库教程

SQL 教程

SQL 教程
MySQL 教程

MySQL 教程
MongoDB 教程

MongoDB 教程
PostgreSQL 教程

PostgreSQL 教程
SQLite 教程

SQLite 教程
Redis 教程

Redis 教程
MariaDB 教程

MariaDB 教程

图形图像教程

Vulkan 教程

Vulkan 教程
OpenCV 教程

OpenCV 教程

大数据教程

R语言 教程

R语言 教程

开发工具教程

Git 教程

Git 教程
VSCode 教程

VSCode 教程
Docker 教程

Docker 教程
Gerrit 教程

Gerrit 教程
Excel 教程

Excel 教程

计算机教程

Go语言 教程

Go语言 教程
C++ 教程

C++ 教程

Symfony 教程

登录

找回密码？

注册