W3cubDocs

/CakePHP 4.1

Class ConsoleInputOption

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

ConsoleOptionParser creates these when you use addOption()

Namespace: Cake\Console

Properties summary

  • $_boolean protected
    bool

    Is the option a boolean option. Boolean options do not consume a parameter.

  • $_choices protected
    string[]

    An array of choices for the option.

  • $_default protected
    string|bool|null

    Default value for the option

  • $_help protected
    string

    Help text for the option.

  • $_multiple protected
    bool

    Can the option accept multiple value definition.

  • $_name protected
    string

    Name of the option

  • $_short protected
    string

    Short (1 character) alias for the option.

  • $required protected
    bool

    Is the option required.

Method Summary

  • __construct() public

    Make a new Input Option

  • acceptsMultiple() public

    Check if this option accepts multiple values.

  • defaultValue() public

    Get the default value for this option

  • help() public

    Generate the help for this this option.

  • isBoolean() public

    Check if this option is a boolean option

  • isRequired() public

    Check if this option is required

  • name() public

    Get the value of the name attribute.

  • short() public

    Get the value of the short attribute.

  • usage() public

    Get the usage value for this option

  • validChoice() public

    Check that a value is a valid choice for this option.

  • xml() public

    Append the option's XML into the parent.

Method Detail

__construct() public 

__construct(string $name, string $short, string $help, bool $isBoolean, mixed $default, array $choices, bool $multiple, bool $required)

Make a new Input Option

Parameters

string $name

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

string $short optional

The short alias for this option

string $help optional

The help text for this option

bool $isBoolean optional

Whether this option is a boolean option. Boolean options don't consume extra tokens

string|bool|null $default optional

The default value for this option.

string[] $choices optional

Valid choices for this option.

bool $multiple optional

Whether this option can accept multiple value definition.

bool $required optional

Whether this option is required or not.

Throws

Cake\Console\Exception\ConsoleException

acceptsMultiple() public 

acceptsMultiple()

Check if this option accepts multiple values.

Returns

bool

defaultValue() public 

defaultValue()

Get the default value for this option

Returns

string|bool|null

help() public 

help(int $width)

Generate the help for this this option.

Parameters

int $width optional

The width to make the name of the option.

Returns

string

isBoolean() public 

isBoolean()

Check if this option is a boolean option

Returns

bool

isRequired() public 

isRequired()

Check if this option is required

Returns

bool

name() public 

name()

Get the value of the name attribute.

Returns

string

Value of this->_name.

short() public 

short()

Get the value of the short attribute.

Returns

string

Value of this->_short.

usage() public 

usage()

Get the usage value for this option

Returns

string

validChoice() public 

validChoice(mixed $value)

Check that a value is a valid choice for this option.

Parameters

string|bool $value

The choice to validate.

Returns

true

Throws

Cake\Console\Exception\ConsoleException

xml() public 

xml(\SimpleXMLElement $parent)

Append the option's XML into the parent.

Parameters

\SimpleXMLElement $parent

The parent element.

Returns

\SimpleXMLElement

The parent with this option appended.

Property Detail

$_boolean protected

Is the option a boolean option. Boolean options do not consume a parameter.

Type

bool

$_choices protected

An array of choices for the option.

Type

string[]

$_default protected

Default value for the option

Type

string|bool|null

$_help protected

Help text for the option.

Type

string

$_multiple protected

Can the option accept multiple value definition.

Type

bool

$_name protected

Name of the option

Type

string

$_short protected

Short (1 character) alias for the option.

Type

string

$required protected

Is the 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.ConsoleInputOption.html