• Главная
• Commando
• Command

PHP Класс Commando\Command

This is merely for intellisense purposes! Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$methods		Valid "option" options, mapped to their aliases

Открытые методы

Метод	Описание
__call ( string $name, array $arguments ) : Command	This is the meat of Command. Any time we are operating on an individual option for command (e.g. $cmd->option()->require().
__construct ( array | null $tokens = null )
__destruct ( )
__toString ( ) : string
beepOnError ( boolean $beep = true ) : Command	Terminal beep on error
current ( ) : mixed
define ( array $tokens = null ) : Command	Factory style reads a little nicer
doNotTrapErrors ( ) : Command
error ( Exception $e )
getArgumentValues ( ) : array
getArguments ( ) : array
getFlagValues ( ) : array
getFlags ( ) : array
getHelp ( ) : string
getOption ( string $option ) : Option
getOptions ( ) : array
getSize ( ) : integer
hasOption ( string $option ) : boolean
isParsed ( ) : boolean	Has this Command instance parsed its arguments?
key ( ) : integer
next ( )
offsetExists ( string $offset ) : boolean
offsetGet ( string $offset ) : mixed
offsetSet ( string $offset, string $value )
offsetUnset ( string $offset )
parse ( ) : void
printHelp ( )
rewind ( )
setHelp ( string $help ) : Command
setTokens ( array $cli_tokens ) : Command	Rare that you would need to use this other than for testing, allows defining the cli tokens, instead of using $argv
trapErrors ( boolean $trap = true ) : Command
useDefaultHelp ( boolean $help = true )
valid ( ) : boolean

Приватные методы

Метод	Описание
_alias ( Option $option, string $alias ) : Option
_argument ( Option | null $option, integer $index = null ) : Option
_boolean ( Option $option, boolean $boolean = true ) : Option
_default ( Option $option, mixed $value ) : Option
_describe ( Option $option, string $description ) : Option
_file ( Option $option, boolean $require_exists = true, boolean $allow_globbing = false ) : void
_flag ( Option | null $option, string $name ) : Option
_increment ( Option $option, integer $max ) : Option
_map ( Option $option, Closure $callback ) : Option
_must ( Option $option, Closure $callback ) : Option
_needs ( Option $option, string $name ) : Option	Set a requirement on an option
_option ( Option | null $option, string | integer $name = null ) : Option
_parseOption ( string $token ) : array
_require ( Option $option, boolean $require = true ) : Option
_title ( Option $option, string $title ) : Option
attachHelp ( )
dedupeFlags ( ) : array
parseIfNotParsed ( ) : void

Описание методов

Описание свойств