PHP 클래스 Airship\Hangar\Command

파일 보기 프로젝트 열기: paragonie/airship 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$cache array Cache references to other commands
$description string
$display integer
$essential boolean
$name string
$session array hangar.session.json
$tag array
$userConfig Current user's configuration

보호된 프로퍼티들

프로퍼티 타입 설명
$c array BASH COLORS
$config array hangar.json

공개 메소드들

메소드 설명
fire ( array $args = [] ) : boolean Execute a command
getCommandObject ( string $name, boolean $cache = true ) : self Return a command
getCommandStatic ( string $name, boolean $cache = true ) : Command Return a command (statically callable)
getScreenSize ( ) : array Return the size of the current terminal window
getToken ( string $supplier ) : string Get a token for HTTP requests
saveConfig ( ) Save the configuration
storeConfig ( array $data = [] )
usageInfo ( array $args = [] ) : boolean Display the usage information for this command.

보호된 메소드들

메소드 설명
getSession ( ) : mixed Get the session data
prompt ( string $text ) : string Prompt the user for an input value
silentPrompt ( string $text = "Enter Password:" ) : string Interactively prompts for input without echoing to the terminal.

메소드 상세

fire() 추상적인 공개 메소드

Execute a command
abstract public fire ( array $args = [] ) : boolean
$args array
리턴 boolean

getCommandObject() 공개 메소드

Return a command
public getCommandObject ( string $name, boolean $cache = true ) : self
$name string
$cache boolean
리턴 self (derived class)

getCommandStatic() 공개 정적인 메소드

Return a command (statically callable)
public static getCommandStatic ( string $name, boolean $cache = true ) : Command
$name string
$cache boolean
리턴 Command

getScreenSize() 공개 메소드

Return the size of the current terminal window
public getScreenSize ( ) : array
리턴 array (int, int)

getSession() 최종 보호된 메소드

Get the session data
final protected getSession ( ) : mixed
리턴 mixed

getToken() 공개 메소드

Get a token for HTTP requests
public getToken ( string $supplier ) : string
$supplier string
리턴 string

prompt() 최종 보호된 메소드

Prompt the user for an input value
final protected prompt ( string $text ) : string
$text string
리턴 string

saveConfig() 최종 공개 메소드

Save the configuration
final public saveConfig ( )

silentPrompt() 최종 보호된 메소드

Requires a bash shell or Windows and won't work with safe_mode settings (Uses shell_exec)
final protected silentPrompt ( string $text = "Enter Password:" ) : string
$text string
리턴 string

storeConfig() 최종 공개 메소드

final public storeConfig ( array $data = [] )
$data array

usageInfo() 공개 메소드

Display the usage information for this command.
public usageInfo ( array $args = [] ) : boolean
$args array - CLI arguments
리턴 boolean

프로퍼티 상세

$c 보호되어 있는 프로퍼티

BASH COLORS
protected array $c
리턴 array

$cache 공개적으로 정적으로 프로퍼티

Cache references to other commands
public static array $cache
리턴 array

$config 보호되어 있는 프로퍼티

hangar.json
protected array $config
리턴 array

$description 공개적으로 프로퍼티

public string $description
리턴 string

$display 공개적으로 프로퍼티

public int $display
리턴 integer

$essential 공개적으로 프로퍼티

public bool $essential
리턴 boolean

$name 공개적으로 프로퍼티

public string $name
리턴 string

$session 공개적으로 프로퍼티

hangar.session.json
public array $session
리턴 array

$tag 공개적으로 프로퍼티

public array $tag
리턴 array

$userConfig 공개적으로 정적으로 프로퍼티

Current user's configuration
public static $userConfig