PHP Класс lithium\console\command\Help

Наследование: extends lithium\console\Command

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

Метод	Описание
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.

Метод	Описание
_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.

Get the methods for the class.

protected _methods ( string $class, array $options = [] ) : array
$class	string
$options	array
Результат	array

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.
Результат	string

Get the properties for the class.

protected _properties ( string $class, array $options = [] ) : array
$class	string
$options	array
Результат	array

Output the formatted properties or methods.

См. также: lithium\console\command\Help::_properties()

См. также: lithium\console\command\Help::_methods()

protected _render ( array $params ) : void
$params	array	From `_properties()` or `_methods()`.
Результат	void

Output the formatted available commands.

protected _renderCommands ( ) : void
Результат	void

Output the formatted command description.

protected _renderDescription ( array $info ) : void
$info	array	Info from inspecting the class of the command.
Результат	void

Output the formatted usage.

См. также: lithium\console\command\Help::_methods()

См. также: 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()`.
Результат	void

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.
Результат	array

Auto run the help command.

public run ( string $command = null ) : boolean
$command	string	Name of the command to return help about.
Результат	boolean