MediaWiki  master
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. More...
 
 run ()
 Run the job. More...
 
- Public Member Functions inherited from Job
 __construct ( $command, $params=null)
 
 allowRetries ()
 
 getDeduplicationInfo ()
 Subclasses may need to override this to make duplication detection work. More...
 
 getLastError ()
 
 getMetadata ( $field=null)
 
 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. More...
 
 isRootJob ()
 
 setMetadata ( $field, $value)
 
 teardown ( $status)
 
 toString ()
 
 workItemCount ()
 
- Public Member Functions inherited from RunnableJob
 tearDown ( $status)
 Do any final cleanup after run(), deferred updates, and all DB commits happen. More...
 

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

Detailed Description

Job for asynchronous rendering of thumbnails.

Definition at line 31 of file ThumbnailRenderJob.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 32 of file ThumbnailRenderJob.php.

Member Function Documentation

◆ allowRetries()

ThumbnailRenderJob::allowRetries ( )

Whether to retry the job.

Returns
bool

Implements RunnableJob.

Definition at line 146 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 77 of file ThumbnailRenderJob.php.

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

Referenced by run().

◆ run()

ThumbnailRenderJob::run ( )

Run the job.

Returns
bool Success

Implements RunnableJob.

Definition at line 36 of file ThumbnailRenderJob.php.

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


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