www.aleph1.co.uk Git - yaffs-website/blob - vendor/drupal/console/src/Command/DevelDumperCommand.php

   1 <?php
   2
   3 namespace Drupal\Console\Command;
   4
   5 use Drupal\Core\Config\Config;
   6 use Drupal\Core\Config\ConfigFactory;
   7 use Symfony\Component\Console\Input\InputArgument;
   8 use Symfony\Component\Console\Input\InputInterface;
   9 use Symfony\Component\Console\Output\OutputInterface;
  10 use Drupal\Console\Core\Command\ContainerAwareCommand;
  11 use Drupal\devel\DevelDumperPluginManager;
  12 use Drupal\devel\DevelDumperManager;
  13
  14 /**
  15  * Class DevelDumperCommand.
  16  * Command to quickly change between devel dumpers from the command line
  17  *
  18  * @package Drupal\Console\Command
  19  *
  20  * @todo Inject services using \Drupal
  21  * @todo Move to namespace Devel
  22  * @todo Load devel.module legacy file
  23  */
  24 class DevelDumperCommand extends ContainerAwareCommand
  25 {
  26     /**
  27      * @var DevelDumperPluginManager
  28      */
  29     protected $develDumperPluginManager;
  30
  31     /**
  32      * DevelDumperCommand constructor.
  33      */
  34     public function __construct(
  35         DevelDumperPluginManager $develDumperPluginManager = null
  36     ) {
  37         $this->develDumperPluginManager = $develDumperPluginManager;
  38
  39         parent::__construct();
  40     }
  41
  42     /**
  43      * {@inheritdoc}
  44      */
  45     protected function configure()
  46     {
  47         $this
  48             ->setName('devel:dumper')
  49             ->setDescription($this->trans('commands.devel.dumper.messages.change-devel-dumper-plugin'))
  50             ->addArgument(
  51                 'dumper',
  52                 InputArgument::OPTIONAL,
  53                 $this->trans('commands.devel.dumper.messages.name-devel-dumper-plugin')
  54             )->setAliases(['dd']);
  55     }
  56
  57     /**
  58      * {@inheritdoc}
  59      */
  60     protected function interact(InputInterface $input, OutputInterface $output)
  61     {
  62         if (!\Drupal::moduleHandler()->moduleExists('devel')) {
  63             $this->getIo()->error($this->trans('commands.devel.dumper.messages.devel-must-be-installed'));
  64
  65             return 1;
  66         }
  67
  68         $dumper = $input->getArgument('dumper');
  69         if (!$dumper) {
  70             /* @var string[] $dumpKeys */
  71             $dumpKeys = $this->getDumperKeys();
  72
  73             $dumper = $this->getIo()->choice(
  74                 $this->trans('commands.devel.dumper.messages.select-debug-dumper'),
  75                 $dumpKeys,
  76                 'kint', //Make kint the default for quick 'switchback'
  77                 false
  78             );
  79
  80             $input->setArgument('dumper', $dumper);
  81         }
  82     }
  83
  84     /**
  85      * {@inheritdoc}
  86      */
  87     protected function execute(InputInterface $input, OutputInterface $output)
  88     {
  89         //Check the dumper actually exists
  90         $dumper = $input->getArgument('dumper');
  91         $dumpKeys = $this->getDumperKeys();
  92         if (!in_array($dumper, $dumpKeys)) {
  93             $this->getIo()->error($this->trans('commands.devel.dumper.messages.dumper-not-exist'));
  94
  95             return 1;
  96         }
  97         /* @var ConfigFactory $configFactory */
  98         $configFactory = \Drupal::configFactory();
  99         /* @var Config $develSettings */
 100         $develSettings = $configFactory->getEditable('devel.settings');
 101         $develSettings->set('devel_dumper', $dumper)->save();
 102         $this->getIo()->info(
 103             sprintf(
 104                 $this->trans('commands.devel.dumper.messages.devel-dumper-set'),
 105                 $configFactory->get('devel.settings')->get('devel_dumper')
 106             )
 107         );
 108     }
 109
 110     protected function getDumperKeys()
 111     {
 112         /* @var DevelDumperPluginManager $manager */
 113         $plugins = $this->develDumperPluginManager->getDefinitions();
 114         return array_keys($plugins);
 115     }
 116 }