Class ConsoleInputArgument

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

Package: Cake\Console
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
See: ConsoleOptionParser::addArgument()
Located at Cake/Console/ConsoleInputArgument.php

Method Detail

__constructsource public

__construct( string|array $name , string $help '' , boolean $required false , array $choices array() )

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 array(): Valid choices for this option.

helpsource 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
string

isRequiredsource public

isRequired( )

Check if this argument is a required argument

Returns

boolean
bool

namesource public

name( )

Get the value of the name attribute.

Returns

string
Value of this->_name.

usagesource public

usage( )

Get the usage value for this argument

Returns

string
string

validChoicesource public

validChoice( string $value )

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

Parameters

string $value: The choice to validate.

Returns

boolean
bool

Throws

ConsoleException
ConsoleException

xmlsource 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 summary

$_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–2016 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.
http://api.cakephp.org/2.7/class-ConsoleInputArgument.html