This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. More...

Functions
	addTeardownCallback ( $callback)
	This is actually implemented in the Job class.

	allowRetries ()
	Do not allow retries on jobs by default.

	fetchFile ()
	Ensure we have the file available.

	getCacheKey ()
	Get the cache key used to store status.

	getUpload ()
	Getter for the upload.

	initialiseUploadJob ( $cacheKey)
	Set up the job.

	logJobParams ( $status)
	Get the job parameters for logging.

	run ()
	Run the job.

	setLastError ( $error)
	This is actually implemented in the Job class.

Variables
array	$params
	The job parameters.

trait	UploadJobTrait
	Common functionality for async uploads.

Detailed Description

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html

Definition in file UploadJobTrait.php.

Function Documentation

◆ addTeardownCallback()

addTeardownCallback ( $callback )

abstractprotected

This is actually implemented in the Job class.

Parameters

callable $callback

Returns: void

Referenced by AssembleUploadChunksJob\run().

◆ allowRetries()

allowRetries ( )

Do not allow retries on jobs by default.

Returns: bool

Definition at line 64 of file UploadJobTrait.php.

◆ fetchFile()

fetchFile ( )

protected

Ensure we have the file available.

A noop here.

Returns: bool

Definition at line 188 of file UploadJobTrait.php.

References setLastError().

◆ getCacheKey()

getCacheKey ( )

Get the cache key used to store status.

Returns: string

Definition at line 133 of file UploadJobTrait.php.

Referenced by MediaWiki\Cache\LinkCache\addBadLinkObj(), MediaWiki\Cache\LinkCache\addGoodLinkObjFromRow(), JobQueueDB\claimRandom(), MediaWiki\Cache\LinkCache\clearBadLink(), MediaWiki\User\UserGroupManager\clearCache(), MediaWiki\User\TalkPageNotificationManager\clearForPageView(), MediaWiki\Cache\LinkCache\clearLink(), MediaWiki\User\User\clearSharedCache(), MediaWiki\User\Options\UserOptionsManager\clearUserOptionsCache(), JobQueueDB\doFlushCaches(), JobQueueDB\doGetAbandonedCount(), JobQueueDB\doGetAcquiredCount(), JobQueueDB\doGetSize(), MediaWiki\Storage\SqlBlobStore\expandBlob(), MediaWiki\Storage\SqlBlobStore\getBlob(), UploadFromUrl\getCacheKeyFromRequest(), MediaWiki\Cache\LinkCache\getGoodLinkFieldObj(), MediaWiki\Cache\LinkCache\getGoodLinkID(), LocalFile\invalidateCache(), InfoAction\invalidateCache(), MediaWiki\Cache\LinkCache\isBadLink(), MediaWiki\User\Options\UserOptionsManager\isOptionGlobal(), MediaWiki\User\User\loadFromCache(), MediaWiki\User\UserGroupManager\loadGroupMembershipsFromArray(), and MediaWiki\User\Options\UserOptionsManager\setOption().

◆ getUpload()

getUpload ( )

abstractprotected

Getter for the upload.

Needs to be implemented by the job class

Returns: UploadBase

Referenced by MediaWiki\Request\WebRequest\getFileName(), MediaWiki\Request\WebRequest\getFileTempname(), MediaWiki\Request\WebRequest\getUploadError(), and MediaWiki\Api\ApiUpload\selectUploadModule().

◆ initialiseUploadJob()

initialiseUploadJob ( $cacheKey )

protected

Set up the job.

Parameters

string $cacheKey

Returns: void

Definition at line 54 of file UploadJobTrait.php.

Referenced by PublishStashedFileJob\__construct().

◆ logJobParams()

logJobParams ( $status )

abstractprotected

Get the job parameters for logging.

Needs to be implemented by the job class.

Parameters

Status[] $status

Returns: array

◆ run()

run ( )

Run the job.

Returns: bool

Definition at line 73 of file UploadJobTrait.php.

◆ setLastError()

setLastError ( $error )

abstractprotected

This is actually implemented in the Job class.

Parameters

mixed $error

Returns: void

Referenced by fetchFile(), Wikimedia\ObjectCache\RedisBagOStuff\handleException(), ThumbnailRenderJob\hitThumbUrl(), AssembleUploadChunksJob\run(), CategoryMembershipChangeJob\run(), DeleteLinksJob\run(), DoubleRedirectJob\run(), RefreshLinksJob\run(), ThumbnailRenderJob\run(), and RefreshLinksJob\runForTitle().

Variable Documentation

◆ $params

array $params

The job parameters.

Definition at line 46 of file UploadJobTrait.php.

Functions

Variables

Detailed Description

Function Documentation

◆ addTeardownCallback()

◆ allowRetries()

◆ fetchFile()

◆ getCacheKey()

◆ getUpload()

◆ initialiseUploadJob()

◆ logJobParams()

◆ run()

◆ setLastError()

Variable Documentation

◆ $params