PHP Класс ConsoleKit\Help

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$args array
$description string
$flags array
$options array
$subCommands array
$usage string

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

Метод Описание
__toString ( )
fromCommandClass ( string $name, string $subCommand = null ) : Help Creates an Help object from a class subclassing Command
fromFQDN ( string $fqdn, string $subCommand = null ) : Help Creates an Help object from a FQDN
fromFunction ( string $name ) : Help Creates an Help object from a function
getArgs ( ) : array
getDescrition ( ) : string
getFlags ( ) : array
getOptions ( ) : array
getSubCommands ( ) : array
getUsage ( ) : string
hasSubCommands ( ) : boolean
render ( ) : string

Защищенные методы

Метод Описание
__construct ( string $text = '' )
parse ( )

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

__construct() защищенный Метод

protected __construct ( string $text = '' )
$text string

__toString() публичный Метод

public __toString ( )

fromCommandClass() публичный статический Метод

Creates an Help object from a class subclassing Command
public static fromCommandClass ( string $name, string $subCommand = null ) : Help
$name string
$subCommand string
Результат Help

fromFQDN() публичный статический Метод

Creates an Help object from a FQDN
public static fromFQDN ( string $fqdn, string $subCommand = null ) : Help
$fqdn string
$subCommand string
Результат Help

fromFunction() публичный статический Метод

Creates an Help object from a function
public static fromFunction ( string $name ) : Help
$name string
Результат Help

getArgs() публичный Метод

public getArgs ( ) : array
Результат array

getDescrition() публичный Метод

public getDescrition ( ) : string
Результат string

getFlags() публичный Метод

public getFlags ( ) : array
Результат array

getOptions() публичный Метод

public getOptions ( ) : array
Результат array

getSubCommands() публичный Метод

public getSubCommands ( ) : array
Результат array

getUsage() публичный Метод

public getUsage ( ) : string
Результат string

hasSubCommands() публичный Метод

public hasSubCommands ( ) : boolean
Результат boolean

parse() защищенный Метод

protected parse ( )

render() публичный Метод

public render ( ) : string
Результат string

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

$args защищенное свойство

protected array $args
Результат array

$description защищенное свойство

protected string $description
Результат string

$flags защищенное свойство

protected array $flags
Результат array

$options защищенное свойство

protected array $options
Результат array

$subCommands защищенное свойство

protected array $subCommands
Результат array

$usage защищенное свойство

protected string $usage
Результат string