MediaWiki
master
RunnableJob.php
Go to the documentation of this file.
1
<?php
21
namespace
MediaWiki\JobQueue
;
22
38
interface
RunnableJob
extends
IJobSpecification
{
40
public
const
JOB_NO_EXPLICIT_TRX_ROUND = 1;
41
55
public
function
run
();
56
61
public
function
getMetadata
( $field =
null
);
62
68
public
function
setMetadata
( $field, $value );
69
75
public
function
hasExecutionFlag
( $flag );
76
83
public
function
getRequestId
();
84
94
public
function
allowRetries
();
95
101
public
function
workItemCount
();
102
107
public
function
getReadyTimestamp
();
108
114
public
function
tearDown
( $status );
115
119
public
function
getLastError
();
120
124
public
function
toString
();
125
}
126
128
class_alias( RunnableJob::class,
'RunnableJob'
);
MediaWiki\JobQueue\IJobSpecification
Interface for serializable objects that describe a job queue task.
Definition
IJobSpecification.php:42
MediaWiki\JobQueue\RunnableJob
Job that has a run() method and metadata accessors for JobQueue::pop() and JobQueue::ack().
Definition
RunnableJob.php:38
MediaWiki\JobQueue\RunnableJob\toString
toString()
MediaWiki\JobQueue\RunnableJob\getReadyTimestamp
getReadyTimestamp()
MediaWiki\JobQueue\RunnableJob\getLastError
getLastError()
MediaWiki\JobQueue\RunnableJob\setMetadata
setMetadata( $field, $value)
MediaWiki\JobQueue\RunnableJob\allowRetries
allowRetries()
Whether to retry execution of this job if run() returned false or threw an exception.
MediaWiki\JobQueue\RunnableJob\workItemCount
workItemCount()
MediaWiki\JobQueue\RunnableJob\getRequestId
getRequestId()
MediaWiki\JobQueue\RunnableJob\run
run()
Run the job.
MediaWiki\JobQueue\RunnableJob\hasExecutionFlag
hasExecutionFlag( $flag)
MediaWiki\JobQueue\RunnableJob\tearDown
tearDown( $status)
Do any final cleanup after run(), deferred updates, and all DB commits happen.
MediaWiki\JobQueue\RunnableJob\getMetadata
getMetadata( $field=null)
MediaWiki\JobQueue
includes
jobqueue
RunnableJob.php
Generated on Mon Jun 16 2025 18:24:06 for MediaWiki by
1.10.0