MediaWiki  1.23.13
PublishStashedFileJob Class Reference

Upload a file from the upload stash into the local file repo. More...

Inheritance diagram for PublishStashedFileJob:
Collaboration diagram for PublishStashedFileJob:

Public Member Functions

 __construct ( $title, $params)
 
 allowRetries ()
 
 getDeduplicationInfo ()
 Subclasses may need to override this to make duplication detection work. More...
 
 run ()
 Run the job. More...
 
- Public Member Functions inherited from Job
 __construct ( $command, $title, $params=false)
 
 getLastError ()
 
 getParams ()
 
 getReleaseTimestamp ()
 
 getRootJobParams ()
 
 getTitle ()
 
 getType ()
 
 hasRootJobParams ()
 
 ignoreDuplicates ()
 
 insert ()
 Insert a single job into the queue. More...
 
 toString ()
 
 workItemCount ()
 

Additional Inherited Members

- Static Public Member Functions inherited from Job
static batchInsert ( $jobs)
 Batch-insert a group of jobs into the queue. More...
 
static factory ( $command, Title $title, $params=false)
 Create the appropriate object to handle a specific job. More...
 
static newRootJobParams ( $key)
 
static pop ()
 Pop a job off the front of the queue. More...
 
static pop_type ( $type)
 Pop a job of a certain type. More...
 
static safeBatchInsert ( $jobs)
 Insert a group of jobs into the queue. More...
 
- Public Attributes inherited from Job
string $command
 
array $metadata = array()
 Additional queue metadata *. More...
 
array bool $params
 Array of job parameters or false if none *. More...
 
- Protected Member Functions inherited from Job
 setLastError ( $error)
 
- Protected Attributes inherited from Job
string $error
 Text for error that occurred last *. More...
 
bool $removeDuplicates
 Expensive jobs may set this to true *. More...
 
Title $title
 

Detailed Description

Upload a file from the upload stash into the local file repo.

Definition at line 29 of file PublishStashedFileJob.php.

Constructor & Destructor Documentation

◆ __construct()

PublishStashedFileJob::__construct (   $title,
  $params 
)

Definition at line 30 of file PublishStashedFileJob.php.

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

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 147 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 138 of file PublishStashedFileJob.php.

References array().

◆ run()

PublishStashedFileJob::run ( )

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