PHPFUI/InstaDoc

Responsible for providing the values to the shell completion.

author Wouter de Jong
attribute Symfony\Component\Console\Attribute\AsCommand ( name: '|_complete', description: 'Internal command to provide shell completion suggestions')

CloneableFinalInstantiable

Extends
Symfony\Component\Console\Command\Command
Attributes
Symfony\Component\Console\Attribute\AsCommand ( name: '|_complete', description: 'Internal command to provide shell completion suggestions')

Constants

public Symfony\Component\Console\Command\CompleteCommand::COMPLETION_API_VERSION = '1'

public Symfony\Component\Console\Command\Command::FAILURE = 1

public Symfony\Component\Console\Command\Command::INVALID = 2

public Symfony\Component\Console\Command\Command::SUCCESS = 0

Methods

public __construct(array $completionOutputs = [])

param phpDocumentor\Reflection\Types\Array_ $completionOutputs A list of additional completion outputs, with shell name as key and FQCN as value

public Symfony\Component\Console\Command\Command::addArgument(string $name, ?int $mode = NULL, string $description = '', ?mixed $default = NULL) : static

Adds an argument.

param $mode The argument mode: InputArgument::REQUIRED or InputArgument::OPTIONAL
param $default The default value (for InputArgument::OPTIONAL mode only)
return phpDocumentor\Reflection\Types\This
throws phpDocumentor\Reflection\Types\Object_ When argument mode is not valid

public Symfony\Component\Console\Command\Command::addOption(string $name, array|string|?null $shortcut = NULL, ?int $mode = NULL, string $description = '', ?mixed $default = NULL) : static

Adds an option.

param $shortcut The shortcuts, can be null, a string of shortcuts delimited by | or an array of shortcuts
param $mode The option mode: One of the InputOption::VALUE_* constants
param $default The default value (must be null for InputOption::VALUE_NONE)
return phpDocumentor\Reflection\Types\This
throws phpDocumentor\Reflection\Types\Object_ If option mode is invalid or incompatible

public Symfony\Component\Console\Command\Command::addUsage(string $usage) : static

Add a command usage example, it'll be prefixed with the command name.

return phpDocumentor\Reflection\Types\This

public Symfony\Component\Console\Command\Command::complete(Symfony\Component\Console\Completion\CompletionInput $input, Symfony\Component\Console\Completion\CompletionSuggestions $suggestions) : void

Adds suggestions to $suggestions for the current completion input (e.g. option or argument).

public Symfony\Component\Console\Command\Command::getAliases() : array

Returns the aliases for the command.

public Symfony\Component\Console\Command\Command::getApplication() : ?Symfony\Component\Console\Application

Gets the application instance for this command.

public static Symfony\Component\Console\Command\Command::getDefaultDescription() : ?string

public static Symfony\Component\Console\Command\Command::getDefaultName() : ?string

public Symfony\Component\Console\Command\Command::getDefinition() : Symfony\Component\Console\Input\InputDefinition

Gets the InputDefinition attached to this Command.

public Symfony\Component\Console\Command\Command::getDescription() : string

Returns the description for the command.

public Symfony\Component\Console\Command\Command::getHelp() : string

Returns the help for the command.

public Symfony\Component\Console\Command\Command::getHelper(string $name) : ?mixed

Gets a helper instance by name.

return phpDocumentor\Reflection\Types\Object_
throws phpDocumentor\Reflection\Types\Object_ if no HelperSet is defined
throws phpDocumentor\Reflection\Types\Object_ if the helper is not defined

public Symfony\Component\Console\Command\Command::getHelperSet() : ?Symfony\Component\Console\Helper\HelperSet

Gets the helper set.

public Symfony\Component\Console\Command\Command::getName() : ?string

Returns the command name.

public Symfony\Component\Console\Command\Command::getNativeDefinition() : Symfony\Component\Console\Input\InputDefinition

Gets the InputDefinition to be used to create representations of this Command.

Can be overridden to provide the original command representation when it would otherwise
be changed by merging with the application InputDefinition.

This method is not part of public API and should not be used directly.

public Symfony\Component\Console\Command\Command::getProcessedHelp() : string

Returns the processed help for the command replacing the %command.name% and
%command.full_name% patterns with the real values dynamically.

public Symfony\Component\Console\Command\Command::getSynopsis(bool $short = false) : string

Returns the synopsis for the command.

param phpDocumentor\Reflection\Types\Boolean $short Whether to show the short version of the synopsis (with options folded) or not

public Symfony\Component\Console\Command\Command::getUsages() : array

Returns alternative usages of the command.

public Symfony\Component\Console\Command\Command::ignoreValidationErrors()

Ignores validation errors.

This is mainly useful for the help command.

public Symfony\Component\Console\Command\Command::isEnabled()

Checks whether the command is enabled or not in the current environment.

Override this to check for x or y and return false if the command cannot
run properly under the current conditions.

return phpDocumentor\Reflection\Types\Boolean

public Symfony\Component\Console\Command\Command::isHidden() : bool

return phpDocumentor\Reflection\Types\Boolean whether the command should be publicly shown or not

public Symfony\Component\Console\Command\Command::mergeApplicationDefinition(bool $mergeArgs = true)

Merges the application definition with the command definition.

This method is not part of public API and should not be used directly.

param phpDocumentor\Reflection\Types\Boolean $mergeArgs Whether to merge or not the Application definition arguments to Command definition arguments
internal

public Symfony\Component\Console\Command\Command::run(Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output) : int

Runs the command.

The code to execute is either defined directly with the
setCode() method or by overriding the execute() method
in a sub-class.

return phpDocumentor\Reflection\Types\Integer The command exit code
throws phpDocumentor\Reflection\Types\Object_ When input binding fails. Bypass this by calling {@link ignoreValidationErrors()}.
see \setCode()
see \execute()

public Symfony\Component\Console\Command\Command::setAliases(iterable $aliases) : static

Sets the aliases for the command.

param phpDocumentor\Reflection\Types\Array_ $aliases An array of aliases for the command
return phpDocumentor\Reflection\Types\This
throws phpDocumentor\Reflection\Types\Object_ When an alias is invalid

public Symfony\Component\Console\Command\Command::setApplication(?Symfony\Component\Console\Application $application = NULL)

public Symfony\Component\Console\Command\Command::setCode(callable $code) : static

Sets the code to execute when running this command.

If this method is used, it overrides the code defined
in the execute() method.

param phpDocumentor\Reflection\Types\Callable_ $code A callable(InputInterface $input, OutputInterface $output)
return phpDocumentor\Reflection\Types\This
throws phpDocumentor\Reflection\Types\Object_
see \execute()

public Symfony\Component\Console\Command\Command::setDefinition(Symfony\Component\Console\Input\InputDefinition|array $definition) : static

Sets an array of argument and option instances.

return phpDocumentor\Reflection\Types\This

public Symfony\Component\Console\Command\Command::setDescription(string $description) : static

Sets the description for the command.

return phpDocumentor\Reflection\Types\This

public Symfony\Component\Console\Command\Command::setHelp(string $help) : static

Sets the help for the command.

return phpDocumentor\Reflection\Types\This

public Symfony\Component\Console\Command\Command::setHelperSet(Symfony\Component\Console\Helper\HelperSet $helperSet)

public Symfony\Component\Console\Command\Command::setHidden(bool $hidden = true) : static

param phpDocumentor\Reflection\Types\Boolean $hidden Whether or not the command should be hidden from the list of commands
return phpDocumentor\Reflection\Types\This

public Symfony\Component\Console\Command\Command::setName(string $name) : static

Sets the name of the command.

This method can set both the namespace and the name if
you separate them by a colon (:)

$command->setName('foo:bar');

return phpDocumentor\Reflection\Types\This
throws phpDocumentor\Reflection\Types\Object_ When the name is invalid

public Symfony\Component\Console\Command\Command::setProcessTitle(string $title) : static

Sets the process title of the command.

This feature should be used only when creating a long process command,
like a daemon.

return phpDocumentor\Reflection\Types\This

Properties

protected static $defaultDescription = 'Internal command to provide shell completion suggestions'

deprecated since Symfony 6.1

protected static $defaultName = '|_complete'

deprecated since Symfony 6.1

Methods

protected configure() : void

protected execute(Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output) : int

protected initialize(Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output)

Properties

private $completionOutputs

private $isDebug

Methods

private createCompletionInput(Symfony\Component\Console\Input\InputInterface $input) : Symfony\Component\Console\Completion\CompletionInput

private findCommand(Symfony\Component\Console\Completion\CompletionInput $completionInput, Symfony\Component\Console\Output\OutputInterface $output) : ?Symfony\Component\Console\Command\Command

private log( $messages) : void

Properties

protected static $defaultDescription = 'Internal command to provide shell completion suggestions'

deprecated since Symfony 6.1

protected static $defaultName = '|_complete'

deprecated since Symfony 6.1

Methods

ConfigurationCode Formating StyleTab Stop SpacesNumbers (0-9.) only