MediaWiki  1.33.0
CreatePdfThumbnailsJob Class Reference
Inheritance diagram for CreatePdfThumbnailsJob:
Collaboration diagram for CreatePdfThumbnailsJob:

Public Member Functions

 __construct ( $title, $params)
 Construct a thumbnail job. More...
 run ()
 Run a thumbnail job on a given PDF file. More...
- Public Member Functions inherited from Job
 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)
 Do any final cleanup after run(), deferred updates, and all DB commits happen. More...
 toString ()
 workItemCount ()

Static Public Member Functions

static insertJobs ( $upload, $mime, &$error)
- 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

const BIG_THUMB = 1
 Flags for thumbnail jobs. More...
const SMALL_THUMB = 2
- Public Attributes inherited from Job
string $command
array $metadata = []
 Additional queue metadata. More...
array $params
 Array of job parameters. More...

Additional Inherited Members

- Protected Member Functions inherited from Job
 addTeardownCallback ( $callback)
 setLastError ( $error)
- 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

Definition at line 3 of file CreatePdfThumbnailsJob.php.

Constructor & Destructor Documentation

◆ __construct()

CreatePdfThumbnailsJob::__construct (   $title,

Construct a thumbnail job.

Title$titleTitle object
array$paramsAssociative array of options: page: page number for which the thumbnail will be created jobtype: CreatePDFThumbnailsJob::BIG_THUMB or CreatePDFThumbnailsJob::SMALL_THUMB BIG_THUMB will create a thumbnail visible for full thumbnail view, SMALL_THUMB will create a thumbnail shown in "previous page"/"next page" boxes

Reimplemented from Job.

Definition at line 20 of file CreatePdfThumbnailsJob.php.

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

Member Function Documentation

◆ insertJobs()

static CreatePdfThumbnailsJob::insertJobs (   $upload,

Definition at line 95 of file CreatePdfThumbnailsJob.php.

References Job\$metadata, Job\$title, MediaWiki\MediaWikiServices\getInstance(), JobQueueGroup\singleton(), unserialize(), and wfDebugLog().

◆ run()

CreatePdfThumbnailsJob::run ( )

Run a thumbnail job on a given PDF file.

bool true

Reimplemented from Job.

Definition at line 28 of file CreatePdfThumbnailsJob.php.

References $file, $wgImageLimits, BIG_THUMB, User\getDefaultOption(), Linker\makeThumbLinkObj(), SMALL_THUMB, title, wfDebugLog(), and wfLocalFile().

Member Data Documentation


const CreatePdfThumbnailsJob::BIG_THUMB = 1

Flags for thumbnail jobs.

Definition at line 7 of file CreatePdfThumbnailsJob.php.

Referenced by run().


const CreatePdfThumbnailsJob::SMALL_THUMB = 2

Definition at line 8 of file CreatePdfThumbnailsJob.php.

Referenced by run().

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