1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92:
<?php
/*
* This file is part of the webmozart/console package.
*
* (c) Bernhard Schussek <bschussek@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Webmozart\Console\Api\Args;
/**
* The unparsed console arguments.
*
* 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 <bschussek@gmail.com>
*
* @see Args, ArgsFormat, ArgsParser
*/
interface RawArgs
{
/**
* Returns the PHP script as it was called on the console.
*
* @return string|null The script name or null if no script name is
* available.
*/
public function getScriptName();
/**
* Returns the tokens of the console arguments.
*
* @return string[] The argument tokens.
*/
public function getTokens();
/**
* Returns whether the console arguments contain a given token.
*
* @param string $token The token to look for.
*
* @return bool Returns `true` if the arguments contain the token and
* `false` otherwise.
*/
public function hasToken($token);
/**
* Returns the console arguments as string.
*
* @param bool $scriptName Whether to include the script name in the output.
*
* @return string The arguments as string.
*/
public function toString($scriptName = true);
}