PHP Class lithium\console\command\Help

Inheritance: extends lithium\console\Command
显示文件 Open project: unionofrad/lithium Class Usage Examples

Public Methods

Method Description
api ( string $class = null, string $type = null, string $name = null ) : array Gets the API for the class.
run ( string $command = null ) : boolean Auto run the help command.

Protected Methods

Method Description
_methods ( string $class, array $options = [] ) : array Get the methods for the class.
_pad ( string $message, integer | string $level = 1 ) : string Add left padding for prettier display.
_properties ( string $class, array $options = [] ) : array Get the properties for the class.
_render ( array $params ) : void Output the formatted properties or methods.
_renderCommands ( ) : void Output the formatted available commands.
_renderDescription ( array $info ) : void Output the formatted command description.
_renderUsage ( string $command, array $method, array $properties = [] ) : void Output the formatted usage.

Method Details

_methods() protected method

Get the methods for the class.
protected _methods ( string $class, array $options = [] ) : array
$class string
$options array
return array

_pad() protected method

Add left padding for prettier display.
protected _pad ( string $message, integer | string $level = 1 ) : string
$message string the text to render.
$level integer | string the level of indentation.
return string

_properties() protected method

Get the properties for the class.
protected _properties ( string $class, array $options = [] ) : array
$class string
$options array
return array

_render() protected method

Output the formatted properties or methods.
See also: lithium\console\command\Help::_properties()
See also: lithium\console\command\Help::_methods()
protected _render ( array $params ) : void
$params array From `_properties()` or `_methods()`.
return void

_renderCommands() protected method

Output the formatted available commands.
protected _renderCommands ( ) : void
return void

_renderDescription() protected method

Output the formatted command description.
protected _renderDescription ( array $info ) : void
$info array Info from inspecting the class of the command.
return void

_renderUsage() protected method

Output the formatted usage.
See also: lithium\console\command\Help::_methods()
See also: lithium\console\command\Help::_properties()
protected _renderUsage ( string $command, array $method, array $properties = [] ) : void
$command string The name of the command.
$method array Information about the method of the command to render usage for.
$properties array From `_properties()`.
return void

api() public method

Gets the API for the class.
public api ( string $class = null, string $type = null, string $name = null ) : array
$class string fully namespaced class in dot notation.
$type string method|property
$name string the name of the method or property.
return array

run() public method

Auto run the help command.
public run ( string $command = null ) : boolean
$command string Name of the command to return help about.
return boolean