DeferredUpdatesScopeStack Class Reference

DeferredUpdates helper class for tracking DeferrableUpdate::doUpdate() nesting levels caused by nested calls to DeferredUpdates::doUpdates() More...

Public Member Functions
	__construct ()
	ascend ()
	Pop the innermost scope from the stack.
	current ()
	descend ( $activeStage, DeferrableUpdate $update)
	Make a new child scope, push it onto the stack, and return it.
	getRecursiveDepth ()
	Get the depth of the scope stack below the root scope.

Detailed Description

DeferredUpdates helper class for tracking DeferrableUpdate::doUpdate() nesting levels caused by nested calls to DeferredUpdates::doUpdates()

Access: internal

For use by DeferredUpdates only

Since

1.36

Definition at line 28 of file DeferredUpdatesScopeStack.php.

Constructor & Destructor Documentation

__construct()

DeferredUpdatesScopeStack::__construct

(

)

Definition at line 32 of file DeferredUpdatesScopeStack.php.

References DeferredUpdatesScope\newRootScope().

Member Function Documentation

ascend()

DeferredUpdatesScopeStack::ascend

(

)

Pop the innermost scope from the stack.

Returns

DeferredUpdatesScope

Definition at line 62 of file DeferredUpdatesScopeStack.php.

Referenced by DeferredUpdates\doUpdates().

current()

DeferredUpdatesScopeStack::current

(

)

Returns

DeferredUpdatesScope The innermost scope

Definition at line 39 of file DeferredUpdatesScopeStack.php.

Referenced by descend().

descend()

DeferredUpdatesScopeStack::descend	(		$activeStage,
		DeferrableUpdate	$update )

Make a new child scope, push it onto the stack, and return it.

Parameters

int	$activeStage	The in-progress stage; one of DeferredUpdates::STAGES
DeferrableUpdate	$update	The deferred update that owns this scope

Returns

DeferredUpdatesScope Scope for the case of an in-progress deferred update

Definition at line 50 of file DeferredUpdatesScopeStack.php.

References current(), and DeferredUpdatesScope\newChildScope().

Referenced by DeferredUpdates\doUpdates().

getRecursiveDepth()

DeferredUpdatesScopeStack::getRecursiveDepth

(

)

Get the depth of the scope stack below the root scope.

Returns

int

Definition at line 75 of file DeferredUpdatesScopeStack.php.

---

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

• includes/deferred/DeferredUpdatesScopeStack.php