Beanstalk\Command\Delete Class Ref

class Beanstalk\Command\Delete
Extends:Beanstalk\Command
Description:Delete command
Author:Joshua Dechant <jdechant@shapeup.com>

The delete command removes a job from the server entirely. It is normally used by the client when the job has successfully run to completion. A client can delete jobs that it has reserved, ready jobs, and jobs that are buried.

Class Methods

Beanstalk\Command\Delete::__construct($id)
Description:

Constructor

Parameters:
  • $id (integer) – The job id to delete
Beanstalk\Command\Delete::getCommand()
Description:Get the delete command to send to the beanstalkd server
Returns:string
Beanstalk\Command\Delete::parseResponse($response[, $data = null, $conn = null])
Description:

Parse the response for success or failure.

Parameters:
  • $response (string) – Response line, i.e, first line in response
  • $data (string) – Data recieved with reponse, if any, else null
  • $conn (BeanstalkConnection) – BeanstalkConnection use to send the command
Returns:

boolean True if command was successful

Throws:

BeanstalkException When the job cannot be found or has already timed out

Throws:

BeanstalkException When any other error occurs