W3cubDocs

/CakePHP 3.4

Class ConsoleInputArgument

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

Namespace: Cake\Console
See: \Cake\Console\ConsoleOptionParser::addArgument()
Location: Console/ConsoleInputArgument.php

Properties summary

  • $_choices protected
    array
    An array of valid choices for this argument.
  • $_help protected
    string
    Help string
  • $_name protected
    string
    Name of the argument.
  • $_required protected
    boolean
    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()source public 

__construct( string|array $name , string $help '' , boolean $required false , array $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
boolean $required optional false
Whether this argument is required. Missing required args will trigger exceptions
array $choices optional []
Valid choices for this option.

help()source public 

help( integer $width 0 )

Generate the help for this argument.

Parameters

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

Returns

string

isEqualTo()source 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

boolean

isRequired()source public 

isRequired( )

Check if this argument is a required argument

Returns

boolean

name()source public 

name( )

Get the value of the name attribute.

Returns

string
Value of this->_name.

usage()source public 

usage( )

Get the usage value for this argument

Returns

string

validChoice()source public 

validChoice( string $value )

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

Parameters

string $value
The choice to validate.

Returns

boolean

Throws

Cake\Console\Exception\ConsoleException

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

Properties detail

$_choicessource

protected array

An array of valid choices for this argument.

$_helpsource

protected string

Help string

$_namesource

protected string

Name of the argument.

$_requiredsource

protected boolean

Is this option required?

© 2005–2017 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.4/class-Cake.Console.ConsoleInputArgument.html