MediaWiki master
UploadFromUrlJob Class Reference

Upload a file by URL, via the jobqueue. More...

Inherits Job, and GenericParameterJob.

Collaboration diagram for UploadFromUrlJob:

Public Member Functions

 __construct (array $params)
 
 getDeduplicationInfo ()
 Deduplicate on title, url alone.
 
 logJobParams ( $status)
 Get the parameters for job logging.
 
- Public Member Functions inherited from Job
 __construct ( $command, $params=null)
 
 allowRetries ()
 
Warning
In some setups (i.e. when using change-propagation) jobs may still be retried even when this is false if the job fails due to a timeout unless it is also configured in change-prop config (T358939).
Returns
bool Whether this job can be retried on failure by job runners
Since
1.21

 
 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$flagJOB_* 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
 run ()
 Run the job.
 
 tearDown ( $status)
 Do any final cleanup after run(), deferred updates, and all DB commits happen.
 

Protected Member Functions

 getUpload ()
 getter for the upload
 
- Protected Member Functions inherited from Job
 addTeardownCallback ( $callback)
 
 setLastError ( $error)
 

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 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 by URL, via the jobqueue.

Definition at line 27 of file UploadFromUrlJob.php.

Constructor & Destructor Documentation

◆ __construct()

UploadFromUrlJob::__construct ( array $params)
Parameters
array$paramsJSON-serializable map of parameters

Implements GenericParameterJob.

Definition at line 30 of file UploadFromUrlJob.php.

References $params.

Member Function Documentation

◆ getDeduplicationInfo()

UploadFromUrlJob::getDeduplicationInfo ( )

Deduplicate on title, url alone.

Please note that this could cause some edge case failure, when the image at the same remote url is changed before the first upload is ran.

Returns
array

Reimplemented from Job.

Definition at line 48 of file UploadFromUrlJob.php.

◆ getUpload()

UploadFromUrlJob::getUpload ( )
protected

getter for the upload

Returns
UploadBase

Definition at line 62 of file UploadFromUrlJob.php.

References UploadFromUrl\initialize().

◆ logJobParams()

UploadFromUrlJob::logJobParams ( $status)

Get the parameters for job logging.

Parameters
Status[]$status
Returns
array

Definition at line 76 of file UploadFromUrlJob.php.


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