PHP Класс Airship\Hangar\Commands\Help

Наследование: extends Airship\Hangar\Command
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$description string
$display integer
$essential boolean
$name string
$showAll boolean

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

Метод Описание
__construct ( array $commands = [] ) Preamble before firing is done here
fire ( array $args = [] ) : boolean Execute the help command
helpMenu ( ) : void Display the main help menu
sortCommands ( array $a, array $b ) : integer Used for uasort() calls in this class
usageInfo ( array $args = [] ) : void Display the usage information for this command.

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

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

Preamble before firing is done here
public __construct ( array $commands = [] )
$commands array

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

Execute the help command
public fire ( array $args = [] ) : boolean
$args array - CLI arguments
Результат boolean

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

Display the main help menu
public helpMenu ( ) : void
Результат void

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

Used for uasort() calls in this class
public sortCommands ( array $a, array $b ) : integer
$a array
$b array
Результат integer

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

Display the usage information for this command.
public usageInfo ( array $args = [] ) : void
$args array - CLI arguments
Результат void

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

$description публичное свойство

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

$display публичное свойство

public int $display
Результат integer

$essential публичное свойство

public bool $essential
Результат boolean

$name публичное свойство

public string $name
Результат string

$showAll публичное свойство

public bool $showAll
Результат boolean