PHP Class ConsoleKit\Help

Afficher le fichier Open project: maximebf/consolekit Class Usage Examples

Protected Properties

Свойство Type Description
$args array
$description string
$flags array
$options array
$subCommands array
$usage string

Méthodes publiques

Méthode Description
__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

Méthodes protégées

Méthode Description
__construct ( string $text = '' )
parse ( )

Method Details

__construct() protected méthode

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

__toString() public méthode

public __toString ( )

fromCommandClass() public static méthode

Creates an Help object from a class subclassing Command
public static fromCommandClass ( string $name, string $subCommand = null ) : Help
$name string
$subCommand string
Résultat Help

fromFQDN() public static méthode

Creates an Help object from a FQDN
public static fromFQDN ( string $fqdn, string $subCommand = null ) : Help
$fqdn string
$subCommand string
Résultat Help

fromFunction() public static méthode

Creates an Help object from a function
public static fromFunction ( string $name ) : Help
$name string
Résultat Help

getArgs() public méthode

public getArgs ( ) : array
Résultat array

getDescrition() public méthode

public getDescrition ( ) : string
Résultat string

getFlags() public méthode

public getFlags ( ) : array
Résultat array

getOptions() public méthode

public getOptions ( ) : array
Résultat array

getSubCommands() public méthode

public getSubCommands ( ) : array
Résultat array

getUsage() public méthode

public getUsage ( ) : string
Résultat string

hasSubCommands() public méthode

public hasSubCommands ( ) : boolean
Résultat boolean

parse() protected méthode

protected parse ( )

render() public méthode

public render ( ) : string
Résultat string

Property Details

$args protected_oe property

protected array $args
Résultat array

$description protected_oe property

protected string $description
Résultat string

$flags protected_oe property

protected array $flags
Résultat array

$options protected_oe property

protected array $options
Résultat array

$subCommands protected_oe property

protected array $subCommands
Résultat array

$usage protected_oe property

protected string $usage
Résultat string