PHP Class ConsoleKit\Help

Show file Open project: maximebf/consolekit Class Usage Examples

Protected Properties

Property Type Description
$args array
$description string
$flags array
$options array
$subCommands array
$usage string

Public Methods

Method 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

Protected Methods

Method Description
__construct ( string $text = '' )
parse ( )

Method Details

__construct() protected method

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

__toString() public method

public __toString ( )

fromCommandClass() public static method

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

fromFQDN() public static method

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

fromFunction() public static method

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

getArgs() public method

public getArgs ( ) : array
return array

getDescrition() public method

public getDescrition ( ) : string
return string

getFlags() public method

public getFlags ( ) : array
return array

getOptions() public method

public getOptions ( ) : array
return array

getSubCommands() public method

public getSubCommands ( ) : array
return array

getUsage() public method

public getUsage ( ) : string
return string

hasSubCommands() public method

public hasSubCommands ( ) : boolean
return boolean

parse() protected method

protected parse ( )

render() public method

public render ( ) : string
return string

Property Details

$args protected property

protected array $args
return array

$description protected property

protected string $description
return string

$flags protected property

protected array $flags
return array

$options protected property

protected array $options
return array

$subCommands protected property

protected array $subCommands
return array

$usage protected property

protected string $usage
return string