ScopedCallback Class Reference

Class for asserting that a callback happens when an dummy object leaves scope. More...

Public Member Functions
	__construct ( $callback)
	__destruct ()
	Trigger the callback when this leaves scope. More...

Static Public Member Functions
static	cancel (ScopedCallback &$sc=null)
	Destroy a scoped callback without triggering it. More...
static	consume (ScopedCallback &$sc=null)
	Trigger a scoped callback and destroy it. More...

Protected Attributes
callable	$callback

Detailed Description

Class for asserting that a callback happens when an dummy object leaves scope.

Since

1.21

Definition at line 28 of file ScopedCallback.php.

Constructor & Destructor Documentation

__construct()

ScopedCallback::__construct

(

$callback

)

Parameters

callable

$callback

Exceptions

Exception

Definition at line 35 of file ScopedCallback.php.

References $callback.

__destruct()

ScopedCallback::__destruct

(

)

Trigger the callback when this leaves scope.

Definition at line 67 of file ScopedCallback.php.

Member Function Documentation

cancel()

static ScopedCallback::cancel ( ScopedCallback &  $sc = null )

static

Destroy a scoped callback without triggering it.

Parameters

ScopedCallback

$sc

Definition at line 57 of file ScopedCallback.php.

consume()

static ScopedCallback::consume ( ScopedCallback &  $sc = null )

static

Trigger a scoped callback and destroy it.

This is the same is just setting it to null.

Parameters

ScopedCallback

$sc

Definition at line 48 of file ScopedCallback.php.

Referenced by MessageCache\load().

Member Data Documentation

$callback

callable ScopedCallback::$callback

protected

Definition at line 29 of file ScopedCallback.php.

Referenced by __construct().

---

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

• includes/libs/ScopedCallback.php