PHP 클래스 Disque\Command\BaseCommand

상속: implements Disque\Command\CommandInterface, use trait Disque\Command\Argument\StringChecker

보호된 프로퍼티들

프로퍼티	타입	설명
$arguments	array	Arguments
$argumentsType	integer	Tells the argument types for this command
$availableArguments	array	All available optional arguments must be defined here. If they are processed by the method toArguments(), the $this->options variable will automatically provide the default values.
$options	array	Provide default argument values. If the value for the argument is not provided, is null, or is false, the option will not be used.
$responseHandler	string	Tells which class handles the response

공개 메소드들

메소드	설명
getArguments ( ) : array	Get processed arguments for command
getCommand ( ) : string	Get command
isBlocking ( ) : boolean	Tells if this command blocks while waiting for a response, to avoid being affected by connection timeouts.
parse ( mixed $body ) : mixed	Parse response
setArguments ( array $arguments ) : void	Set arguments for the command

보호된 메소드들

메소드	설명
toArguments ( array $options ) : array	Build command arguments out of options

메소드 상세

getArguments() 공개 메소드

Get processed arguments for command

public getArguments ( ) : array
리턴	array	Arguments

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

Get command

abstract public getCommand ( ) : string
리턴	string	Command

isBlocking() 공개 메소드

Tells if this command blocks while waiting for a response, to avoid being affected by connection timeouts.

public isBlocking ( ) : boolean
리턴	boolean	If true, this command blocks

parse() 공개 메소드

Parse response

public parse ( mixed $body ) : mixed
$body	mixed	Response body
리턴	mixed	Parsed response

setArguments() 공개 메소드

Set arguments for the command

public setArguments ( array $arguments ) : void
$arguments	array	Arguments
리턴	void

toArguments() 보호된 메소드

Client-supplied options are amended with the default options defined in $this->options. Options whose value is set to null or false are ignored

protected toArguments ( array $options ) : array
$options	array	Command options
리턴	array	Command arguments

프로퍼티 상세

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

Arguments

protected array $arguments
리턴	array

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

Tells the argument types for this command

protected int $argumentsType
리턴	integer

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

All available optional arguments must be defined here. If they are processed by the method toArguments(), the $this->options variable will automatically provide the default values.

protected array $availableArguments
리턴	array

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

Provide default argument values. If the value for the argument is not provided, is null, or is false, the option will not be used.

protected array $options
리턴	array

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

Tells which class handles the response

protected string $responseHandler
리턴	string