W3cubDocs

/CakePHP 3.8

Class ConsoleInputOption

An object to represent a single option used in the command line. ConsoleOptionParser creates these when you use addOption()

Namespace: Cake\Console
See: \Cake\Console\ConsoleOptionParser::addOption()
Location: Console/ConsoleInputOption.php

Properties summary

  • $_boolean protected
    boolean
    Is the option a boolean option. Boolean options do not consume a parameter.
  • $_choices protected
    array
    An array of choices for the option.
  • $_default protected
    mixed
    Default value for the option
  • $_help protected
    string
    Help text for the option.
  • $_multiple protected
    boolean
    Can the option accept multiple value definition.
  • $_name protected
    string
    Name of the option
  • $_short protected
    string
    Short (1 character) alias for the option.

Method Summary

  • __construct() public
    Make a new Input Option
  • Check if this option accepts multiple values.
  • 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
  • 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()source public 

__construct( string|array $name , string $short = '' , string $help = '' , boolean $boolean = false , string $default = '' , array $choices = [] , boolean $multiple = false )

Make a new Input Option

Parameters

string|array $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
boolean $boolean optional false
Whether this option is a boolean option. Boolean options don't consume extra tokens
string $default optional ''
The default value for this option.
array $choices optional []
Valid choices for this option.
boolean $multiple optional false
Whether this option can accept multiple value definition.

Throws

Cake\Console\Exception\ConsoleException

acceptsMultiple()source public 

acceptsMultiple( )

Check if this option accepts multiple values.

Returns

boolean

defaultValue()source public 

defaultValue( )

Get the default value for this option

Returns

mixed

help()source public 

help( integer $width = 0 )

Generate the help for this this option.

Parameters

integer $width optional 0
The width to make the name of the option.

Returns

string

isBoolean()source public 

isBoolean( )

Check if this option is a boolean option

Returns

boolean

name()source public 

name( )

Get the value of the name attribute.

Returns

string
Value of this->_name.

short()source public 

short( )

Get the value of the short attribute.

Returns

string
Value of this->_short.

usage()source public 

usage( )

Get the usage value for this option

Returns

string

validChoice()source public 

validChoice( string $value )

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

Parameters

string $value
The choice to validate.

Returns

boolean

Throws

Cake\Console\Exception\ConsoleException

xml()source 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.

Properties detail

$_booleansource

protected boolean

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

$_choicessource

protected array

An array of choices for the option.

$_defaultsource

protected mixed

Default value for the option

$_helpsource

protected string

Help text for the option.

$_multiplesource

protected boolean

Can the option accept multiple value definition.

$_namesource

protected string

Name of the option

$_shortsource

protected string

Short (1 character) alias for the option.

© 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/3.8/class-Cake.Console.ConsoleInputOption.html