UserOptionsUpdateJob Class Reference

Job that updates a user's preferences. More...

Inheritance diagram for UserOptionsUpdateJob:

Collaboration diagram for UserOptionsUpdateJob:

Public Member Functions
	__construct (array $params)
	run ()
	Run the job.
Public Member Functions inherited from Job
	__construct ( $command, $params=null)
	Stable to call.
	allowRetries ()
	Returns bool Whether this job can be retried on failure by job runners Since 1.21 Stable to override
	getDeduplicationInfo ()
	Subclasses may need to override this to make duplication detection work.
	getLastError ()
	Returns string Stable to override
	getMetadata ( $field=null)
	Stable to override.
	getParams ()
	Returns array Parameters that specify sources, targets, and options for execution Stable to override
	getQueuedTimestamp ()
	getReadyTimestamp ()
	Returns int|null UNIX timestamp of when the job was runnable, or null Since 1.26 Stable to override
	getReleaseTimestamp ()
	Stable to override.
	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 Stable to override
	getRootJobParams ()
	Stable to override.
	getTitle ()
	getType ()
	Returns string Job type that defines what sort of changes this job makes Stable to override
	hasExecutionFlag ( $flag)
	Parameters int $flag JOB_* class constant Returns bool Since 1.31 Stable to override
	hasRootJobParams ()
	Stable to override.
	ignoreDuplicates ()
	Whether the queue should reject insertion of this job if a duplicate exists.
	isRootJob ()
	Stable to override.
	setMetadata ( $field, $value)
	Stable to override.
	teardown ( $status)
	Stable to override
	toString ()
	Returns string Debugging string describing the job Stable to override
	workItemCount ()
	Stable to override.
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

Job that updates a user's preferences.

The following job parameters are required:

• userId: the user ID
• options: a map of (option => value)

Since

1.33

Definition at line 33 of file UserOptionsUpdateJob.php.

Constructor & Destructor Documentation

__construct()

UserOptionsUpdateJob::__construct

(

array

$params

)

Parameters

array

$params

JSON-serializable map of parameters

Implements GenericParameterJob.

Definition at line 34 of file UserOptionsUpdateJob.php.

References Job\$params.

Member Function Documentation

run()

UserOptionsUpdateJob::run

(

)

Run the job.

Returns

bool Success

Implements RunnableJob.

Definition at line 39 of file UserOptionsUpdateJob.php.

References User\newFromId().

---

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

• includes/jobqueue/jobs/UserOptionsUpdateJob.php