Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. RecipeInfoCommand.php

class RecipeInfoCommand

Shows information about a particular recipe.

@internal This API is experimental.

Hierarchy

  • class \Symfony\Component\Console\Command\Command
    • class \Drupal\Core\Recipe\RecipeInfoCommand extends \Symfony\Component\Console\Command\Command uses \Drupal\Core\Command\BootableCommandTrait

Expanded class hierarchy of RecipeInfoCommand

File

core/lib/Drupal/Core/Recipe/RecipeInfoCommand.php, line 20

Namespace

Drupal\Core\Recipe
View source
final class RecipeInfoCommand extends Command {
    use BootableCommandTrait;
    public function __construct($class_loader) {
        parent::__construct('recipe:info');
        $this->classLoader = $class_loader;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function configure() : void {
        $this->setDescription('Shows information about a recipe.')
            ->addArgument('path', InputArgument::REQUIRED, 'The path to the recipe\'s folder');
    }
    
    /**
     * {@inheritdoc}
     */
    protected function execute(InputInterface $input, OutputInterface $output) : int {
        $io = new SymfonyStyle($input, $output);
        $recipe_path = $input->getArgument('path');
        if (!is_string($recipe_path) || !is_dir($recipe_path)) {
            $io->error(sprintf('The supplied path %s is not a directory', $recipe_path));
            return 1;
        }
        $this->boot();
        $recipe = Recipe::createFromDirectory($recipe_path);
        $io->section('Description');
        $io->text($recipe->description);
        $io->section('Inputs');
        $descriptions = $recipe->input
            ->describeAll();
        if ($descriptions) {
            // Passing NULL as the callable to array_map() makes it act like a Python
            // zip() operation.
            // @see https://docs.python.org/3.8/library/functions.html#zip
            $rows = array_map(NULL, array_keys($descriptions), $descriptions);
            $io->table([
                'Name',
                'Description',
            ], $rows);
        }
        else {
            $io->writeln("This recipe does not accept any input.");
        }
        return 0;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
BootableCommandTrait::$classLoader protected property The class loader.
BootableCommandTrait::boot protected function Boots up a Drupal environment.
BootableCommandTrait::getSitePath protected function Gets the site path.
Command::$aliases private property 1
Command::$application private property
Command::$code private property
Command::$definition private property
Command::$description private property 1
Command::$fullDefinition private property
Command::$help private property
Command::$helperSet private property
Command::$hidden private property
Command::$ignoreValidationErrors private property 2
Command::$name private property
Command::$processTitle private property
Command::$synopsis private property
Command::$usages private property
Command::addArgument public function Adds an argument. 2
Command::addOption public function Adds an option. 2
Command::addUsage public function Add a command usage example, it'll be prefixed with the command name. 2
Command::complete public function Supplies suggestions when resolving possible completion options for input (e.g. option or argument). 5
Command::FAILURE public constant
Command::getAliases public function Returns the aliases for the command.
Command::getApplication public function Gets the application instance for this command. 2
Command::getDefaultDescription public static function
Command::getDefaultName public static function
Command::getDefinition public function Gets the InputDefinition attached to this Command. 2
Command::getDescription public function Returns the description for the command.
Command::getHelp public function Returns the help for the command. 2
Command::getHelper public function Gets a helper instance by name. 2
Command::getHelperSet public function Gets the helper set. 1
Command::getName public function Returns the command name.
Command::getNativeDefinition public function Gets the InputDefinition to be used to create representations of this Command. 2
Command::getProcessedHelp public function Returns the processed help for the command replacing the %command.name% and
%command.full_name% patterns with the real values dynamically.
2
Command::getSynopsis public function Returns the synopsis for the command. 2
Command::getUsages public function Returns alternative usages of the command. 2
Command::ignoreValidationErrors public function Ignores validation errors. 2
Command::initialize protected function Initializes the command after the input has been bound and before the input
is validated.
4
Command::interact protected function Interacts with the user. 5
Command::INVALID public constant
Command::isEnabled public function Checks whether the command is enabled or not in the current environment. 2
Command::isHidden public function
Command::mergeApplicationDefinition public function Merges the application definition with the command definition. 2
Command::run public function Runs the command. 4
Command::setAliases public function Sets the aliases for the command.
Command::setApplication public function 2
Command::setCode public function Sets the code to execute when running this command. 2
Command::setDefinition public function Sets an array of argument and option instances. 2
Command::setDescription public function Sets the description for the command.
Command::setHelp public function Sets the help for the command. 2
Command::setHelperSet public function 2
Command::setHidden public function
Command::setName public function Sets the name of the command.
Command::setProcessTitle public function Sets the process title of the command. 2
Command::SUCCESS public constant
Command::validateName private function Validates a command name.
RecipeInfoCommand::configure protected function Configures the current command. Overrides Command::configure
RecipeInfoCommand::execute protected function Executes the current command. Overrides Command::execute
RecipeInfoCommand::__construct public function Overrides Command::__construct

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal