PHP Interface Webmozart\Console\Api\Args\RawArgs

Implementations of this class represent the arguments that a user passes when calling the console. For example: $ console server add --port 80 localhost In this case, the raw arguments contain the tokens: * "server" * "add" * "--port" * "80" * "localhost" With an implementation of {@link ArgsParser} and a configured {@link ArgsFormat}, the {@link RawArgs} instance can be converted into an {@link Args} instance: php $format = ArgsFormat::build() ->addCommandName(new CommandName('server')) ->addCommandName(new CommandName('add')) ->addOption(new Option('port', 'p', Option::VALUE_REQUIRED | Option::INTEGER)) ->addArgument(new Argument('host', Argument::REQUIRED)) ->getFormat(); $args = $parser->parseArgs($rawArgs, $format); The {@link Args} instance can be used to access the options and arguments of a command in a convenient way.
Since: 1.0
Author: Bernhard Schussek ([email protected])
ファイルを表示 Open project: webmozart/console Interface Usage Examples

Public Methods

Method Description
getScriptName ( ) : string | null Returns the PHP script as it was called on the console.
getTokens ( ) : string[] Returns the tokens of the console arguments.
hasToken ( string $token ) : boolean Returns whether the console arguments contain a given token.
toString ( boolean $scriptName = true ) : string Returns the console arguments as string.

Method Details

getScriptName() public method

Returns the PHP script as it was called on the console.
public getScriptName ( ) : string | null
return string | null The script name or null if no script name is available.

getTokens() public method

Returns the tokens of the console arguments.
public getTokens ( ) : string[]
return string[] The argument tokens.

hasToken() public method

Returns whether the console arguments contain a given token.
public hasToken ( string $token ) : boolean
$token string The token to look for.
return boolean Returns `true` if the arguments contain the token and `false` otherwise.

toString() public method

Returns the console arguments as string.
public toString ( boolean $scriptName = true ) : string
$scriptName boolean Whether to include the script name in the output.
return string The arguments as string.