W3cubDocs

/CakePHP 4.1

Class ConsoleInputArgument

An object to represent a single argument used in the command line.

ConsoleOptionParser creates these when you use addArgument()

Namespace: Cake\Console

Properties summary

  • $_choices protected
    string[]

    An array of valid choices for this argument.

  • $_help protected
    string

    Help string

  • $_name protected
    string

    Name of the argument.

  • $_required protected
    bool

    Is this option required?

Method Summary

  • __construct() public

    Make a new Input Argument

  • help() public

    Generate the help for this argument.

  • isEqualTo() public

    Checks if this argument is equal to another argument.

  • isRequired() public

    Check if this argument is a required argument

  • name() public

    Get the value of the name attribute.

  • usage() public

    Get the usage value for this argument

  • validChoice() public

    Check that $value is a valid choice for this argument.

  • xml() public

    Append this arguments XML representation to the passed in SimpleXml object.

Method Detail

__construct() public 

__construct(mixed $name, mixed $help, mixed $required, mixed $choices)

Make a new Input Argument

Parameters

string|array $name

The long name of the option, or an array with all the properties.

string $help optional

The help text for this option

bool $required optional

Whether this argument is required. Missing required args will trigger exceptions

string[] $choices optional

Valid choices for this option.

help() public 

help(int $width)

Generate the help for this argument.

Parameters

int $width optional

The width to make the name of the option.

Returns

string

isEqualTo() public 

isEqualTo(\Cake\Console\ConsoleInputArgument $argument)

Checks if this argument is equal to another argument.

Parameters

\Cake\Console\ConsoleInputArgument $argument

ConsoleInputArgument to compare to.

Returns

bool

isRequired() public 

isRequired()

Check if this argument is a required argument

Returns

bool

name() public 

name()

Get the value of the name attribute.

Returns

string

Value of this->_name.

usage() public 

usage()

Get the usage value for this argument

Returns

string

validChoice() public 

validChoice(string $value)

Check that $value is a valid choice for this argument.

Parameters

string $value

The choice to validate.

Returns

true

Throws

Cake\Console\Exception\ConsoleException

xml() public 

xml(\SimpleXMLElement $parent)

Append this arguments XML representation to the passed in SimpleXml object.

Parameters

\SimpleXMLElement $parent

The parent element.

Returns

\SimpleXMLElement

The parent with this argument appended.

Property Detail

$_choices protected

An array of valid choices for this argument.

Type

string[]

$_help protected

Help string

Type

string

$_name protected

Name of the argument.

Type

string

$_required protected

Is this option required?

Type

bool

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.Console.ConsoleInputArgument.html