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

Inherits Job.

Collaboration diagram for PublishStashedFileJob:

[legend]

Public Member Functions

__construct (Title $title, array $params)

allowRetries ()

Returns: bool Whether this job can be retried on failure by job runners

Since: 1.21

Stability: stable: to override

getDeduplicationInfo ()

Subclasses may need to override this to make duplication detection work.

run ()

Run the job.

Public Member Functions inherited from Job

__construct ( $command, $params=null)

getLastError ()

Returns: string

getMetadata ( $field=null)

getParams ()

Returns: array Parameters that specify sources, targets, and options for execution

getQueuedTimestamp ()

getReadyTimestamp ()

Returns: int|null UNIX timestamp of when the job was runnable, or null

Since: 1.26

getReleaseTimestamp ()

getRequestId ()

Returns: string|null Id of the request that created this job. Follows jobs recursively, allowing to track the id of the request that started a job when jobs insert jobs which insert other jobs.

Since: 1.27

getRootJobParams ()

getTitle ()

getType ()

Returns: string Job type that defines what sort of changes this job makes

hasExecutionFlag ( $flag)

Parameters

int $flag JOB_* class constant

Returns: bool

Since: 1.31

hasRootJobParams ()

ignoreDuplicates ()

Whether the queue should reject insertion of this job if a duplicate exists.

isRootJob ()

setMetadata ( $field, $value)

teardown ( $status)

toString ()

Returns: string Debugging string describing the job

workItemCount ()

Public Member Functions inherited from RunnableJob

tearDown ( $status)

Do any final cleanup after run(), deferred updates, and all DB commits happen.

Additional Inherited Members
Static Public Member Functions inherited from Job
static	factory ( $command, $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 = false
	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 30 of file PublishStashedFileJob.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 31 of file PublishStashedFileJob.php.

References $title.

Member Function Documentation

◆ allowRetries()

PublishStashedFileJob::allowRetries ( )

Returns: bool Whether this job can be retried on failure by job runners

Since: 1.21

Stability: stable: to override

Stability: stable: to override

Reimplemented from Job.

Definition at line 148 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.

Stability: stable: to override

Returns: array Map of key/values

Since: 1.21

Reimplemented from Job.

Definition at line 139 of file PublishStashedFileJob.php.

◆ run()

PublishStashedFileJob::run ( )

Run the job.

Returns: bool Success

Implements RunnableJob.

Definition at line 36 of file PublishStashedFileJob.php.

References Job\addTeardownCallback(), and Job\setLastError().

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

includes/jobqueue/jobs/PublishStashedFileJob.php