MediaWiki REL1_32
ThumbnailRenderJob Class Reference

Job for asynchronous rendering of thumbnails. More...

Inheritance diagram for ThumbnailRenderJob:
Collaboration diagram for ThumbnailRenderJob:

Public Member Functions

 __construct (Title $title, array $params)
 
 allowRetries ()
 Whether to retry the job.
 
 run ()
 Run the job.
 
- Public Member Functions inherited from Job
 __construct ( $command, $title, $params=false)
 
 getDeduplicationInfo ()
 Subclasses may need to override this to make duplication detection work.
 
 getLastError ()
 
 getParams ()
 
 getQueuedTimestamp ()
 
 getReadyTimestamp ()
 
 getReleaseTimestamp ()
 
 getRequestId ()
 
 getRootJobParams ()
 
 getTitle ()
 
 getType ()
 
 hasExecutionFlag ( $flag)
 
 hasRootJobParams ()
 
 ignoreDuplicates ()
 Whether the queue should reject insertion of this job if a duplicate exists.
 
 isRootJob ()
 
 teardown ( $status)
 Do any final cleanup after run(), deferred updates, and all DB commits happen.
 
 toString ()
 
 workItemCount ()
 

Protected Member Functions

 hitThumbUrl (LocalFile $file, $transformParams)
 
- Protected Member Functions inherited from Job
 addTeardownCallback ( $callback)
 
 setLastError ( $error)
 

Additional Inherited Members

- Static Public Member Functions inherited from Job
static factory ( $command, Title $title, $params=[])
 Create the appropriate object to handle a specific job.
 
static newRootJobParams ( $key)
 Get "root job" parameters for a task.
 
- Public Attributes inherited from Job
string $command
 
array $metadata = []
 Additional queue metadata.
 
array $params
 Array of job parameters.
 
- Protected Attributes inherited from Job
string $error
 Text for error that occurred last.
 
int $executionFlags = 0
 Bitfield of JOB_* class constants.
 
bool $removeDuplicates
 Expensive jobs may set this to true.
 
callable[] $teardownCallbacks = []
 
Title $title
 

Detailed Description

Job for asynchronous rendering of thumbnails.

Definition at line 29 of file ThumbnailRenderJob.php.

Constructor & Destructor Documentation

◆ __construct()

ThumbnailRenderJob::__construct ( Title  $title,
array  $params 
)

Definition at line 30 of file ThumbnailRenderJob.php.

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

Member Function Documentation

◆ allowRetries()

ThumbnailRenderJob::allowRetries ( )

Whether to retry the job.

Returns
bool

Reimplemented from Job.

Definition at line 142 of file ThumbnailRenderJob.php.

◆ hitThumbUrl()

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 74 of file ThumbnailRenderJob.php.

References $handler, $request, $wgUploadThumbnailRenderHttpCustomDomain, $wgUploadThumbnailRenderHttpCustomHost, File\getHandler(), File\getThumbUrl(), Job\setLastError(), File\thumbName(), wfDebug(), and wfParseUrl().

Referenced by run().

◆ run()

ThumbnailRenderJob::run ( )

Run the job.

Returns
bool Success

Reimplemented from Job.

Definition at line 34 of file ThumbnailRenderJob.php.

References $wgUploadThumbnailRenderMethod, hitThumbUrl(), File\RENDER_NOW, Job\setLastError(), title, and wfLocalFile().


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