繁体   English   中英

覆盖symfony2控制台命令?

[英]Override symfony2 console commands?

是否可以覆盖symfony2 app / console命令? 例如,在FOS UserBundle中,我想添加一些字段,当它使用console create user命令创建用户时会询问它。 这是可能的,还是我需要在自己的捆绑包中创建自己的控制台命令?

向命令添加更多字段的整个过程是:

1.在AcmeDemoBundle类中,您必须将FOSUser设置为父级:

<?php

namespace Acme\UserBundle;

use Symfony\Component\HttpKernel\Bundle\Bundle;
use Symfony\Component\DependencyInjection\ContainerBuilder;

class AcmeUserBundle extends Bundle
{
    public function getParent()
    {
        return 'FOSUserBundle';
    }
}

2.一旦你这样做,你可以在你的包中重新创建CreateUserCommand:

<?php

namespace Acme\UserBundle\Command;

use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use FOS\UserBundle\Model\User;

/**
 * @author Matthieu Bontemps <matthieu@knplabs.com>
 * @author Thibault Duplessis <thibault.duplessis@gmail.com>
 * @author Luis Cordova <cordoval@gmail.com>
 */
class CreateUserCommand extends ContainerAwareCommand
{
    /**
     * @see Command
     */
    protected function configure()
    {
        $this
            ->setName('fos:user:create')
            ->setDescription('Create a user.')
            ->setDefinition(array(
                new InputArgument('username', InputArgument::REQUIRED, 'The username'),
                new InputArgument('email', InputArgument::REQUIRED, 'The email'),
                new InputArgument('password', InputArgument::REQUIRED, 'The password'),
                new InputArgument('name', InputArgument::REQUIRED, 'The name'),
                new InputOption('super-admin', null, InputOption::VALUE_NONE, 'Set the user as super admin'),
                new InputOption('inactive', null, InputOption::VALUE_NONE, 'Set the user as inactive'),
            ))
            ->setHelp(<<<EOT
The <info>fos:user:create</info> command creates a user:

  <info>php app/console fos:user:create matthieu</info>

This interactive shell will ask you for an email and then a password.

You can alternatively specify the email and password as the second and third arguments:

  <info>php app/console fos:user:create matthieu matthieu@example.com mypassword</info>

You can create a super admin via the super-admin flag:

  <info>php app/console fos:user:create admin --super-admin</info>

You can create an inactive user (will not be able to log in):

  <info>php app/console fos:user:create thibault --inactive</info>

EOT
            );
    }

    /**
     * @see Command
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $username   = $input->getArgument('username');
        $email      = $input->getArgument('email');
        $password   = $input->getArgument('password');
        $name       = $input->getArgument('name');
        $inactive   = $input->getOption('inactive');
        $superadmin = $input->getOption('super-admin');

        $manipulator = $this->getContainer()->get('acme.util.user_manipulator');
        $manipulator->create($username, $password, $email, $name, !$inactive, $superadmin);

        $output->writeln(sprintf('Created user <comment>%s</comment>', $username));
    }

    /**
     * @see Command
     */
    protected function interact(InputInterface $input, OutputInterface $output)
    {
        if (!$input->getArgument('username')) {
            $username = $this->getHelper('dialog')->askAndValidate(
                $output,
                'Please choose a username:',
                function($username) {
                    if (empty($username)) {
                        throw new \Exception('Username can not be empty');
                    }

                    return $username;
                }
            );
            $input->setArgument('username', $username);
        }

        if (!$input->getArgument('email')) {
            $email = $this->getHelper('dialog')->askAndValidate(
                $output,
                'Please choose an email:',
                function($email) {
                    if (empty($email)) {
                        throw new \Exception('Email can not be empty');
                    }

                    return $email;
                }
            );
            $input->setArgument('email', $email);
        }

        if (!$input->getArgument('password')) {
            $password = $this->getHelper('dialog')->askAndValidate(
                $output,
                'Please choose a password:',
                function($password) {
                    if (empty($password)) {
                        throw new \Exception('Password can not be empty');
                    }

                    return $password;
                }
            );
            $input->setArgument('password', $password);
        }

        if (!$input->getArgument('name')) {
            $name = $this->getHelper('dialog')->askAndValidate(
                $output,
                'Please choose a name:',
                function($name) {
                    if (empty($name)) {
                        throw new \Exception('Name can not be empty');
                    }

                    return $name;
                }
            );
            $input->setArgument('name', $name);
        }
    }
}

注意我添加了一个名为name的新输入参数,在命令中我使用的是acme.util.user_manipulator服务,而不是原来的那个操作系统,我将处理用户的名字。

3.创建自己的UserManipulator:

<?php

namespace Acme\UserBundle\Util;

use FOS\UserBundle\Model\UserManagerInterface;

/**
 * Executes some manipulations on the users
 *
 * @author Christophe Coevoet <stof@notk.org>
 * @author Luis Cordova <cordoval@gmail.com>
 */
class UserManipulator
{
    /**
     * User manager
     *
     * @var UserManagerInterface
     */
    private $userManager;

    public function __construct(UserManagerInterface $userManager)
    {
        $this->userManager = $userManager;
    }

    /**
     * Creates a user and returns it.
     *
     * @param string  $username
     * @param string  $password
     * @param string  $email
     * @param string  $name
     * @param Boolean $active
     * @param Boolean $superadmin
     *
     * @return \FOS\UserBundle\Model\UserInterface
     */
    public function create($username, $password, $email, $name, $active, $superadmin)
    {
        $user = $this->userManager->createUser();
        $user->setUsername($username);
        $user->setEmail($email);
        $user->setName($name);
        $user->setPlainPassword($password);
        $user->setEnabled((Boolean)$active);
        $user->setSuperAdmin((Boolean)$superadmin);
        $this->userManager->updateUser($user);

        return $user;
    }
}

在这个类中我只需要create函数,所以其他命令如promote,demote ..不知道你的用户的新属性,所以我不需要创建一个CompilerPass来覆盖整个服务。

4.最后,在Resources / config目录中定义这个新的UserManipulator服务,并将其添加到DependencyInjection扩展:

services:
    acme.util.user_manipulator:
        class:      Acme\UserBundle\Util\UserManipulator
        arguments:  [@fos_user.user_manager]

完成!

如果您创建(或已经拥有)您自己的捆绑包(该捆绑包的子 ),则可以覆盖捆绑包的控制台命令(请参阅捆绑包继承 )。 然后,通过在您的包中放置一个与原始命令具有相同位置/名称的类,您可以有效地覆盖它。

因此,例如,要覆盖FOS / UserBundle / Command / CreateUserCommand.php,请创建MyCompany / UserBundle / Command / CreateUserCommand,其中MyCompanyUserBundle具有FOSUserBundle作为其父级。

您的命令类可以扩展FOS命令类,以便重用它(位)。 但是,看了FOS CreateUserCommand后,我认为您需要覆盖所有方法来添加更多输入字段,在这种情况下,这样做没有任何好处。 当然这也意味着您可以在任何捆绑中创建自己的命令,但在我看来,最好将FOSUserBundle的自定义保存在子捆绑中。

Symfony 4已经删除了bundle继承 ,但你仍然可以通过修改它们来覆盖命令。 它更干净,不需要捆绑。 只需将其添加到services.yaml

services:
    App\Command\MyCustomCommand:
        decorates: command_you_want_to_override

请注意, command_you_want_to_override是服务名称。 对于较早的Symfony 3.3命令,它将是带小点和下划线的小写字母(例如doctrine_migrations.diff_command ),对于较新的命令,它将是类名。 您可以通过检查其bundle的服务配置或通过搜索debug:container输出来找到此名称。 在Linux或macOS上它将是:

php bin/console debug:container | grep Command

在Symfony (3.3)中,您可以通过以下链接覆盖控制台命令。 https://symfony.com/doc/current/console/calling_commands.html并在选项https://symfony.com/doc/current/console/input.html

来自symfony doc的代码:

use Symfony\Component\Console\Input\ArrayInput;
// ...

protected function execute(InputInterface $input, OutputInterface $output)
{
    $command = $this->getApplication()->find('demo:greet');

    $arguments = array(
        'command' => 'demo:greet',
        'name'    => 'Fabien',
        '--yell'  => true,
    );

    $greetInput = new ArrayInput($arguments);
    $returnCode = $command->run($greetInput, $output);

    // ...
}

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM