Job that purges expired user group memberships. More...

Inherits Job, and GenericParameterJob.

Collaboration diagram for UserGroupExpiryJob:

[legend]

Public Member Functions

__construct (array $params)

run ()

Run the job.

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

getDeduplicationInfo ()

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

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

Job that purges expired user group memberships.

Access: internal: For use by \MediaWiki\User\UserGroupManager

Definition at line 29 of file UserGroupExpiryJob.php.

Constructor & Destructor Documentation

◆ __construct()

UserGroupExpiryJob::__construct ( array $params )

Parameters

array $params JSON-serializable map of parameters

Implements GenericParameterJob.

Definition at line 30 of file UserGroupExpiryJob.php.

References $params.

Member Function Documentation

◆ run()

UserGroupExpiryJob::run ( )

Run the job.

Returns: bool Success

Implements RunnableJob.

Definition at line 39 of file UserGroupExpiryJob.php.

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