PHP 클래스 Airship\Hangar\Commands\Help

상속: extends Airship\Hangar\Command
파일 보기 프로젝트 열기: paragonie/airship 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$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