Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

jobqueue: mention more methods in RunnableJob to fix various IDEA warnings

Browse source 
Change-Id: I156411062ae7831c935869d226fc4934bde55107
This commit is contained in:
Aaron Schulz 2019-07-05 21:02:17 -07:00
parent a0307e8fa0
commit 2c74f7205b
2 changed files with 54 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
includes/jobqueue/Job.php
View file

@ -52,9 +52,6 @@ abstract class Job implements RunnableJob {
/** @var int Bitfield of JOB_* class constants */
protected $executionFlags = 0;
/** @var int Job must not be wrapped in the usual explicit LBFactory transaction round */
const JOB_NO_EXPLICIT_TRX_ROUND = 1;
/**
* Create the appropriate object to handle a specific job
*
@ -154,11 +151,6 @@ abstract class Job implements RunnableJob {
}
}
/**
* @param int $flag JOB_* class constant
* @return bool
* @since 1.31
*/
public function hasExecutionFlag( $flag ) {
return ( $this->executionFlags & $flag ) === $flag;
}
@ -234,20 +226,10 @@ abstract class Job implements RunnableJob {
: null;
}
/**
* @return string|null Id of the request that created this job. Follows
* jobs recursively, allowing to track the id of the request that started a
* job when jobs insert jobs which insert other jobs.
* @since 1.27
*/
public function getRequestId() {
return $this->params['requestId'] ?? null;
}
/**
* @return int|null UNIX timestamp of when the job was runnable, or null
* @since 1.26
*/
public function getReadyTimestamp() {
return $this->getReleaseTimestamp() ?: $this->getQueuedTimestamp();
}
@ -267,19 +249,10 @@ abstract class Job implements RunnableJob {
return $this->removeDuplicates;
}
/**
* @return bool Whether this job can be retried on failure by job runners
* @since 1.21
*/
public function allowRetries() {
return true;
}
/**
* @return int Number of actually "work items" handled in this job
* @see $wgJobBackoffThrottling
* @since 1.23
*/
public function workItemCount() {
return 1;
}
@ -380,20 +353,12 @@ abstract class Job implements RunnableJob {
$this->teardownCallbacks[] = $callback;
}
/**
* Do any final cleanup after run(), deferred updates, and all DB commits happen
* @param bool $status Whether the job, its deferred updates, and DB commit all succeeded
* @since 1.27
*/
public function teardown( $status ) {
foreach ( $this->teardownCallbacks as $callback ) {
call_user_func( $callback, $status );
}
}
/**
* @return string
*/
public function toString() {
$paramString = '';
if ( $this->params ) {

54
includes/jobqueue/RunnableJob.php
View file

@ -33,6 +33,9 @@
* @since 1.33
*/
interface RunnableJob extends IJobSpecification {
/** @var int Job must not be wrapped in the usual explicit LBFactory transaction round */
const JOB_NO_EXPLICIT_TRX_ROUND = 1;
/**
* Run the job
* @return bool Success
@ -51,4 +54,55 @@ interface RunnableJob extends IJobSpecification {
* @return mixed|null The prior field value; null if missing
*/
public function setMetadata( $field, $value );
/**
* @param int $flag JOB_* class constant
* @return bool
* @since 1.31
*/
public function hasExecutionFlag( $flag );
/**
* @return string|null Id of the request that created this job. Follows
* jobs recursively, allowing to track the id of the request that started a
* job when jobs insert jobs which insert other jobs.
* @since 1.27
*/
public function getRequestId();
/**
* @return bool Whether this job can be retried on failure by job runners
* @since 1.21
*/
public function allowRetries();
/**
* @return int Number of actually "work items" handled in this job
* @see $wgJobBackoffThrottling
* @since 1.23
*/
public function workItemCount();
/**
* @return int|null UNIX timestamp of when the job was runnable, or null
* @since 1.26
*/
public function getReadyTimestamp();
/**
* Do any final cleanup after run(), deferred updates, and all DB commits happen
* @param bool $status Whether the job, its deferred updates, and DB commit all succeeded
* @since 1.27
*/
public function tearDown( $status );
/**
* @return string
*/
public function getLastError();
/**
* @return string Debugging string describing the job
*/
public function toString();
}