UseCommand
extends AbstractCommand
in package
implements
ResponseParser
The 'use' command.
The "use" command is for producers. Subsequent put commands will put jobs into the tube specified by this command. If no use command has been issued, jobs will be put into the tube named "default".
Tags
Interfaces, Classes and Traits
- ResponseParser
- A parser for response data sent from the beanstalkd server.
Table of Contents
- $_tube : string
- __construct() : mixed
- __toString() : string
- The string representation of the object.
- getCommandLine() : mixed
- getData() : string
- The binary data to follow the command.
- getDataLength() : int
- The length of the binary data in bytes.
- getResponseParser() : ResponseParser
- The response parser for the command.
- hasData() : bool
- Whether the command is followed by data.
- parseResponse() : object
- Parses raw response data into a Response object.
- _createResponse() : object
- Creates a Response for the given data.
Properties
$_tube
private
string
$_tube
Methods
__construct()
public
__construct(string $tube) : mixed
Parameters
- $tube : string
-
The name of the tube to use
Return values
mixed —__toString()
The string representation of the object.
public
__toString() : string
Return values
string —getCommandLine()
public
getCommandLine() : mixed
Return values
mixed —getData()
The binary data to follow the command.
public
getData() : string
Return values
string —getDataLength()
The length of the binary data in bytes.
public
getDataLength() : int
Return values
int —getResponseParser()
The response parser for the command.
public
getResponseParser() : ResponseParser
Return values
ResponseParser —hasData()
Whether the command is followed by data.
public
hasData() : bool
Return values
bool —parseResponse()
Parses raw response data into a Response object.
public
parseResponse(mixed $responseLine, mixed $responseData) : object
Parameters
- $responseLine : mixed
-
Without trailing CRLF
- $responseData : mixed
-
(null if no data)
Return values
object —Response
_createResponse()
Creates a Response for the given data.
protected
_createResponse(mixed $name[, mixed $data = array() ]) : object
Parameters
- $name : mixed
- $data : mixed = array()
Return values
object —Response