HTMLCacheUpdate Class Reference

HTML file cache invalidation all the pages linking to a given title. More...

Inheritance diagram for HTMLCacheUpdate:

Collaboration diagram for HTMLCacheUpdate:

Public Member Functions
	__construct (PageReference $pageTo, $table, $causeAction='unknown', $causeAgent='unknown')
	doUpdate ()
	Perform the actual work.
Public Member Functions inherited from DataUpdate
	__construct ()
	getCauseAction ()
	getCauseAgent ()
	setCause ( $action, $user)
	setTransactionTicket ( $ticket)

Private Attributes
PageReference	$pageTo
string	$table

Additional Inherited Members
Static Public Member Functions inherited from DataUpdate
static	runUpdates (array $updates)
	Convenience method, calls doUpdate() on every DataUpdate in the array.
Protected Attributes inherited from DataUpdate
string	$causeAction = 'unknown'
	Short update cause action description.
string	$causeAgent = 'unknown'
	Short update cause user description.
mixed	$ticket
	Result from LBFactory::getEmptyTransactionTicket()

Detailed Description

HTML file cache invalidation all the pages linking to a given title.

Deprecated:

Since 1.34; Enqueue jobs from HTMLCacheUpdateJob::newForBacklinks instead

Definition at line 29 of file HTMLCacheUpdate.php.

Constructor & Destructor Documentation

__construct()

HTMLCacheUpdate::__construct	(	PageReference	$pageTo,
			$table,
			$causeAction = 'unknown',
			$causeAgent = 'unknown'
	)

Parameters

PageReference	$pageTo
string	$table
string	$causeAction	Triggering action
string	$causeAgent	Triggering user

Definition at line 41 of file HTMLCacheUpdate.php.

References DataUpdate\$causeAction, DataUpdate\$causeAgent, $pageTo, and $table.

Member Function Documentation

doUpdate()

HTMLCacheUpdate::doUpdate

(

)

Perform the actual work.

Implements DeferrableUpdate.

Definition at line 50 of file HTMLCacheUpdate.php.

References $job, DataUpdate\getCauseAction(), DataUpdate\getCauseAgent(), and HTMLCacheUpdateJob\newForBacklinks().

Member Data Documentation

$pageTo

PageReference HTMLCacheUpdate::$pageTo

private

Definition at line 31 of file HTMLCacheUpdate.php.

Referenced by __construct().

$table

string HTMLCacheUpdate::$table

private

Definition at line 33 of file HTMLCacheUpdate.php.

Referenced by __construct().

---

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

• includes/deferred/HTMLCacheUpdate.php