• Home
• Resque

PHP Class Resque, php-resque

ファイルを表示 Open project: chrisboulton/php-resque Class Usage Examples

Public Properties

Property	Type	Description
$redis		Instance of Resque_Redis that talks to redis.

Protected Properties

Property	Type	Description
$redisDatabase		ID of Redis database to select.
$redisServer		Host/port conbination separated by a colon, or a nested array of server swith host/port pairs

Public Methods

Method	Description
blpop ( array $queues, integer $timeout ) : null | array	Pop an item off the end of the specified queues, using blocking list pop, decode it and return it.
dequeue ( string $queue, array $items = [] ) : integer	Remove items of the specified queue
enqueue ( string $queue, string $class, array $args = null, boolean $trackStatus = false ) : string | boolean	Create a new job and save it to the specified queue.
fork ( ) : integer	fork() helper method for php-resque that handles issues PHP socket and phpredis have with passing around sockets between child/parent processes.
generateJobId ( )	* Generate an identifier to attach to a job for status tracking.
pop ( string $queue ) : array	Pop an item off the end of the specified queue, decode it and return it.
push ( string $queue, array $item )	Push a job to the end of a specific queue. If the queue does not exist, then create it as well.
queues ( ) : array	Get an array of all known queues.
redis ( ) : Resque_Redis	Return an instance of the Resque_Redis class instantiated for Resque.
removeQueue ( string $queue ) : integer	Remove specified queue
reserve ( string $queue ) : Resque_Job	Reserve and return the next available job in the specified queue.
setBackend ( mixed $server, integer $database )	Given a host/port combination separated by a colon, set it as the redis server that Resque will talk to.
size ( string $queue ) : integer	Return the size (number of pending jobs) of the specified queue.

Private Methods

Method	Description
matchItem ( $string, $items ) : (bool)	matching item item can be ['class'] or ['class' => 'id'] or ['class' => {:foo => 1, :bar => 2}]
removeItems ( string $queue, array $items = [] ) : integer	Remove Items from the queue Safely moving each item to a temporary queue before processing it If the Job matches, counts otherwise puts it in a requeue_queue which at the end eventually be copied back into the original queue
removeList ( $queue ) : integer	Remove List

Method Details

Property Details