Beanstalk\Command¶| Description: | Abstract beanstalk command. |
|---|---|
| Author: | Joshua Dechant <jdechant@shapeup.com> |
All commands must extends this class
Class Methods
Command::getCommand – Get the command to send to the beanstalkd serverCommand::getData – Get data, if any, to send with the command.Command::parseResponse – Parse the response for success or failure.Command::returnsData – Does the command return data?Beanstalk\Command::getCommand()¶| Description: | Get the command to send to the beanstalkd server |
|---|---|
| Returns: | string |
Beanstalk\Command::getData()¶| Description: | Get data, if any, to send with the command. |
|---|---|
| Returns: | mixed Data string to send with command or boolean false if none |
Not all commands have data; in fact, most do not.
Beanstalk\Command::parseResponse($response[, $data = null, $conn = null])¶| Description: | Parse the response for success or failure. |
|---|---|
| Parameters: |
|
| Returns: | mixed On success |
| Throws: | BeanstalkException On failure |
Failures should throw a BeanstalkException with the error message.
Beanstalk\Command::returnsData()¶| Description: | Does the command return data? |
|---|---|
| Returns: | boolean |