Upload a file from the upload stash into the local file repo. More...
Public Member Functions | |
| __construct (Title $title, array $params) | |
| allowRetries () | |
| getDeduplicationInfo () | |
| Subclasses may need to override this to make duplication detection work. | |
| run () | |
| Run the job. | |
 Public Member Functions inherited from Job | |
| __construct ( $command, $title, $params=false) | |
| 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. | |
| insert () | |
| Insert a single job into the queue. | |
| isRootJob () | |
| teardown ( $status) | |
| Do any final cleanup after run(), deferred updates, and all DB commits happen. | |
| toString () | |
| workItemCount () | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Job | |
| static | batchInsert ( $jobs) |
| Batch-insert a group of jobs into the queue. | |
| 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 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
Upload a file from the upload stash into the local file repo.
Definition at line 32 of file PublishStashedFileJob.php.
Constructor & Destructor Documentation
◆ __construct()
| PublishStashedFileJob::__construct | ( | Title | $title, |
| array | $params ) |
Definition at line 33 of file PublishStashedFileJob.php.
References Job\$params.
Member Function Documentation
◆ allowRetries()
| PublishStashedFileJob::allowRetries | ( | ) |
- Returns
- bool Whether this job can be retried on failure by job runners
- Since
- 1.21
Reimplemented from Job.
Definition at line 149 of file PublishStashedFileJob.php.
◆ getDeduplicationInfo()
| PublishStashedFileJob::getDeduplicationInfo | ( | ) |
Subclasses may need to override this to make duplication detection work.
The resulting map conveys everything that makes the job unique. This is only checked if ignoreDuplicates() returns true, meaning that duplicate jobs are supposed to be ignored.
- Returns
- array Map of key/values
- Since
- 1.21
Reimplemented from Job.
Definition at line 140 of file PublishStashedFileJob.php.
◆ run()
| PublishStashedFileJob::run | ( | ) |
Run the job.
- Returns
- bool Success
Reimplemented from Job.
Definition at line 38 of file PublishStashedFileJob.php.
References $context, $e, Job\addTeardownCallback(), RequestContext\getMain(), RequestContext\importScopedSession(), UploadBase\OK, Job\setLastError(), and UploadBase\setSessionStatus().
The documentation for this class was generated from the following file:
- includes/jobqueue/jobs/PublishStashedFileJob.php
