MediaWiki master
MediaWiki\JobQueue\Jobs Namespace Reference

Namespaces

namespace  Hook

Classes

class  AssembleUploadChunksJob
 Assemble the segments of a chunked upload. More...
class  CategoryCountUpdateJob
 Job to update category membership counts. More...
class  CdnPurgeJob
 Job to purge a set of URLs from CDN. More...
class  DoubleRedirectJob
 Fix any double redirects after moving a page. More...
class  DuplicateJob
 No-op job that does nothing. More...
class  HTMLCacheUpdateJob
 Job to purge the HTML/file cache for all pages that link to or use another page or file. More...
class  NullJob
 No-op job that does nothing. More...
class  PublishStashedFileJob
 Upload a file from the upload stash into the local file repo. More...
class  RefreshLinksJob
 Job to update link tables for rerendered wiki pages. More...
class  RevertedTagUpdateJob
 Job for deferring the execution of RevertedTagUpdate. More...
class  ThumbnailRenderJob
 Job for asynchronous rendering of thumbnails, e.g. More...
class  UploadFromUrlJob
 Upload a file by URL, via the jobqueue. More...

Functions

 addTeardownCallback ( $callback)
 This is actually implemented in the Job class.
 allowRetries ()
 Do not allow retries on jobs by default.
 fetchFile ()
 Ensure we have the file available.
 getCacheKey ()
 Get the cache key used to store status.
 getUpload ()
 Getter for the upload.
 initialiseUploadJob ( $cacheKey)
 Set up the job.
 logJobParams ( $status)
 Get the job parameters for logging.
 run ()
 Run the job.
 setLastError ( $error)
 This is actually implemented in the Job class.

Variables

array $params
 The job parameters.
trait UploadJobTrait
 Common functionality for async uploads.

Function Documentation

◆ addTeardownCallback()

MediaWiki\JobQueue\Jobs\addTeardownCallback ( $callback)
abstractprotected

This is actually implemented in the Job class.

Parameters
callable$callback
Returns
void

References addTeardownCallback().

Referenced by addTeardownCallback().

◆ allowRetries()

Do not allow retries on jobs by default.

Definition at line 53 of file UploadJobTrait.php.

References allowRetries(), and return.

Referenced by allowRetries().

◆ fetchFile()

MediaWiki\JobQueue\Jobs\fetchFile ( )
protected

Ensure we have the file available.

A noop here.

Definition at line 175 of file UploadJobTrait.php.

References fetchFile(), getUpload(), and setLastError().

Referenced by fetchFile().

◆ getCacheKey()

Get the cache key used to store status.

Returns
string

Definition at line 123 of file UploadJobTrait.php.

References getCacheKey().

Referenced by getCacheKey().

◆ getUpload()

MediaWiki\JobQueue\Jobs\getUpload ( )
abstractprotected

Getter for the upload.

Needs to be implemented by the job class

Returns
UploadBase

References getUpload().

Referenced by fetchFile(), and getUpload().

◆ initialiseUploadJob()

MediaWiki\JobQueue\Jobs\initialiseUploadJob ( $cacheKey)
protected

Set up the job.

Parameters
string$cacheKey
Returns
void

Definition at line 45 of file UploadJobTrait.php.

References initialiseUploadJob().

Referenced by MediaWiki\JobQueue\Jobs\PublishStashedFileJob\__construct(), and initialiseUploadJob().

◆ logJobParams()

MediaWiki\JobQueue\Jobs\logJobParams ( $status)
abstractprotected

Get the job parameters for logging.

Needs to be implemented by the job class.

Parameters
Status[]$status
Returns
array

References logJobParams().

Referenced by logJobParams().

◆ run()

MediaWiki\JobQueue\Jobs\run ( )

Run the job.

Definition at line 60 of file UploadJobTrait.php.

References run().

Referenced by run().

◆ setLastError()

MediaWiki\JobQueue\Jobs\setLastError ( $error)
abstractprotected

This is actually implemented in the Job class.

Parameters
mixed$error
Returns
void

References setLastError().

Referenced by fetchFile(), and setLastError().

Variable Documentation

◆ $params

The job parameters.

Definition at line 37 of file UploadJobTrait.php.