Job for asynchronous rendering of thumbnails, e.g. More...

Inherits MediaWiki\JobQueue\Job.

Collaboration diagram for MediaWiki\JobQueue\Jobs\ThumbnailRenderJob:

[legend]

Public Member Functions

__construct (Title $title, array $params)

allowRetries ()

Whether to retry the job.

run ()

Run the job.

Public Member Functions inherited from MediaWiki\JobQueue\Job

__construct ( $command, $params=null)

getDeduplicationInfo ()

Subclasses may need to override this to make duplication detection work.

getLastError ()

Returns: string

getMetadata ( $field=null)

getParams ()

Returns: array Parameters that specify sources, targets, and options for execution

getQueuedTimestamp ()

getReadyTimestamp ()

Returns: int|null UNIX timestamp of when the job was runnable, or null

Since: 1.26

getReleaseTimestamp ()

getRequestId ()

Returns: 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

getRootJobParams ()

getTitle ()

getType ()

Returns: string Job type that defines what sort of changes this job makes

hasExecutionFlag ( $flag)

Parameters

int $flag JOB_* class constant

Returns: bool

Since: 1.31

hasRootJobParams ()

ignoreDuplicates ()

Whether the queue should reject insertion of this job if a duplicate exists.

isRootJob ()

setMetadata ( $field, $value)

teardown ( $status)

toString ()

Returns: string Debugging string describing the job

workItemCount ()

Public Member Functions inherited from MediaWiki\JobQueue\RunnableJob

tearDown ( $status)

Do any final cleanup after run(), deferred updates, and all DB commits happen.

Protected Member Functions
	hitThumbUrl (LocalFile $file, $transformParams)

Protected Member Functions inherited from MediaWiki\JobQueue\Job
	addTeardownCallback ( $callback)

	setLastError ( $error)

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\JobQueue\Job
static	factory ( $command, $params=[])
	Create the appropriate object to handle a specific job.

static	newRootJobParams ( $key)
	Get "root job" parameters for a task.

Public Attributes inherited from MediaWiki\JobQueue\Job
string	$command

array	$metadata = []
	Additional queue metadata.

array	$params
	Array of job parameters.

Protected Attributes inherited from MediaWiki\JobQueue\Job
string	$error
	Text for error that occurred last.

int	$executionFlags = 0
	Bitfield of JOB_* class constants.

bool	$removeDuplicates = false
	Expensive jobs may set this to true.

callable[]	$teardownCallbacks = []

Title	$title

Detailed Description

Job for asynchronous rendering of thumbnails, e.g.

after new uploads.

Definition at line 38 of file ThumbnailRenderJob.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\JobQueue\Jobs\ThumbnailRenderJob::__construct	(	Title	$title,
		array	$params )

Definition at line 39 of file ThumbnailRenderJob.php.

References MediaWiki\JobQueue\Job\$params, and MediaWiki\JobQueue\Job\$title.

Member Function Documentation

◆ allowRetries()

MediaWiki\JobQueue\Jobs\ThumbnailRenderJob::allowRetries ( )

Whether to retry the job.

Returns: bool

Reimplemented from MediaWiki\JobQueue\Job.

Definition at line 179 of file ThumbnailRenderJob.php.

◆ hitThumbUrl()

MediaWiki\JobQueue\Jobs\ThumbnailRenderJob::hitThumbUrl	(	LocalFile	$file,
			$transformParams )

protected

Parameters

LocalFile	$file
array	$transformParams

Returns: bool Success status (error will be set via setLastError() when false)

Definition at line 88 of file ThumbnailRenderJob.php.

References MediaWiki\FileRepo\File\File\getHandler(), MediaWiki\MediaWikiServices\getInstance(), MediaWiki\FileRepo\File\File\getThumbUrl(), MediaWiki\JobQueue\Job\setLastError(), MediaWiki\FileRepo\File\File\thumbName(), MediaWiki\MainConfigNames\UploadThumbnailRenderHttpCustomDomain, MediaWiki\MainConfigNames\UploadThumbnailRenderHttpCustomHost, wfDebug(), and wfGetUrlUtils().

Referenced by MediaWiki\JobQueue\Jobs\ThumbnailRenderJob\run().

◆ run()

MediaWiki\JobQueue\Jobs\ThumbnailRenderJob::run ( )

Run the job.

If this method returns false or completes exceptionally, the job runner will retry executing this job unless the number of retries has exceeded its configured retry limit. Retries are allowed by default, unless allowRetries() is overridden to disable retries.

See the architecture doc for more information.

Returns: bool Return false to instruct the job runner to retry a failed job. Otherwise return true to indicate that a job completed (i.e. succeeded, or failed in a way that's deterministic or redundant).

Implements MediaWiki\JobQueue\RunnableJob.

Definition at line 43 of file ThumbnailRenderJob.php.

References MediaWiki\MediaWikiServices\getInstance(), MediaWiki\JobQueue\Jobs\ThumbnailRenderJob\hitThumbUrl(), MediaWiki\JobQueue\Job\setLastError(), and MediaWiki\MainConfigNames\UploadThumbnailRenderMethod.

The documentation for this class was generated from the following file:

includes/jobqueue/jobs/ThumbnailRenderJob.php