PHP Class Webmozart\Console\Api\Args\Format\CommandName

The command name determines which command should be executed. The console input may contain one or several command names. In the example below, the console arguments contain the two command names "server" and "add": $ console server add localhost The last part "localhost" is the argument to the "server add" command.

Since: 1.0

Author: Bernhard Schussek ([email protected])

Show file Open project: webmozart/console Class Usage Examples

Public Methods

Method	Description
__construct ( string $string, array $aliases = [] )	Creates a new command name.
__toString ( ) : string	Casts the command name to a string.
getAliases ( ) : string[]	Returns the alias names.
match ( string $string ) : boolean	Returns whether a string matches the command name or one of its aliases.
toString ( ) : string	Returns the command name as string.

Method Details

__construct() public method

Creates a new command name.

public __construct ( string $string, array $aliases = [] )
$string	string	The command name.
$aliases	array	The alias names.

__toString() public method

Casts the command name to a string.

public __toString ( ) : string
return	string	The command name.

getAliases() public method

Returns the alias names.

public getAliases ( ) : string[]
return	string[]	The aliases of the command name.

match() public method

Returns whether a string matches the command name or one of its aliases.

public match ( string $string ) : boolean
$string	string	The string to test.
return	boolean	Returns `true` if the given string matches the command name or one of its aliases and `false` otherwise.

toString() public method

Returns the command name as string.

public toString ( ) : string
return	string	The command name.