CreatePdfThumbnailsJob Class Reference
Inheritance diagram for CreatePdfThumbnailsJob:
Collaboration diagram for CreatePdfThumbnailsJob:
Public Member Functions | |
| __construct ( $title, $params) | |
| Construct a thumbnail job. | |
| run () | |
| Run a thumbnail job on a given PDF file. | |
 Public Member Functions inherited from Job | |
| __construct ( $command, $title, $params=false) | |
| allowRetries () | |
| 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 () | |
Static Public Member Functions | |
| static | insertJobs ( $upload, $mime, &$error) |
| 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 | |
| const | BIG_THUMB = 1 |
| Flags for thumbnail jobs. | |
| const | SMALL_THUMB = 2 |
| Public Attributes inherited from Job | |
| string | $command |
| array | $metadata = [] |
| Additional queue metadata. | |
| array | $params |
| Array of job parameters. | |
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. | |
| int | $executionFlags = 0 |
| Bitfield of JOB_* class constants. | |
| bool | $removeDuplicates |
| Expensive jobs may set this to true. | |
| callable[] | $teardownCallbacks = [] |
| Title | $title |
Detailed Description
Definition at line 3 of file CreatePdfThumbnailsJob.php.
Constructor & Destructor Documentation
◆ __construct()
| CreatePdfThumbnailsJob::__construct | ( | $title, | |
| $params ) |
Construct a thumbnail job.
- Parameters
-
Title $title Title object array $params Associative 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
Definition at line 20 of file CreatePdfThumbnailsJob.php.
References Job\$params.
Member Function Documentation
◆ insertJobs()
|
static |
- Parameters
-
UploadBase $upload string $mime string &$error
- Returns
- bool
Definition at line 95 of file CreatePdfThumbnailsJob.php.
References Job\$metadata, $mime, unserialize(), and wfDebugLog().
◆ run()
| CreatePdfThumbnailsJob::run | ( | ) |
Run a thumbnail job on a given PDF file.
- Returns
- bool true
Reimplemented from Job.
Definition at line 28 of file CreatePdfThumbnailsJob.php.
References $wgImageLimits, BIG_THUMB, User\getDefaultOption(), Linker\makeThumbLinkObj(), SMALL_THUMB, wfDebugLog(), and wfLocalFile().
Member Data Documentation
◆ BIG_THUMB
| const CreatePdfThumbnailsJob::BIG_THUMB = 1 |
Flags for thumbnail jobs.
Definition at line 7 of file CreatePdfThumbnailsJob.php.
Referenced by run().
◆ SMALL_THUMB
| 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:
- extensions/PdfHandler/includes/CreatePdfThumbnailsJob.php
