MediaWiki  1.27.1
ScopedCallback Class Reference

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

Inheritance diagram for ScopedCallback:

Public Member Functions

 __construct ($callback, array $params=[])
 
 __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
 
array $params
 

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

ScopedCallback::__construct (   $callback,
array  $params = [] 
)
Parameters
callable | null$callback
array$paramsCallback arguments (since 1.25)
Exceptions
Exception

Definition at line 39 of file ScopedCallback.php.

References $callback, and $params.

ScopedCallback::__destruct ( )

Trigger the callback when this leaves scope.

Definition at line 72 of file ScopedCallback.php.

Member Function Documentation

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

Destroy a scoped callback without triggering it.

Parameters
ScopedCallback$sc

Definition at line 62 of file ScopedCallback.php.

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 53 of file ScopedCallback.php.

Referenced by User\doLogout(), EditPage\getPreviewText(), MediaWiki\Session\SessionManager\getSessionFromInfo(), DatabaseBase\query(), MessageCache\replace(), AssembleUploadChunksJob\run(), PublishStashedFileJob\run(), ResourceLoaderModule\saveFileDependencies(), User\setCookies(), MediaWiki\Auth\AuthManager\setSessionDataForUser(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProviderTest\testAccountCreationEmail(), WatchedItemUnitTest\testBatchAddWatch(), MediaWiki\Auth\AuthManagerTest\testBeginAuthentication(), MediaWiki\Auth\AuthManagerTest\testCanAuthenticateNow(), MediaWiki\Auth\AuthManagerTest\testCheckAccountCreatePermissions(), MediaWiki\Session\SessionBackendTest\testDelaySave(), WatchedItemUnitTest\testDuplicateEntries(), WatchedItemUnitTest\testFromUserTitle(), WikiCategoryPageTest\testHiddenCategory_PropertyIsSet(), WikiCategoryPageTest\testHiddenCategory_PropertyNotSet(), RecentChangeTest\testHiddenCategoryChange(), BotPasswordTest\testLogin(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProviderTest\testProviderChangeAuthenticationData(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProviderTest\testProviderChangeAuthenticationDataEmail(), WatchedItemUnitTest\testResetNotificationTimestamp(), WatchedItemStoreUnitTest\testResetNotificationTimestamp_futureNotificationTimestampForced(), WatchedItemStoreUnitTest\testResetNotificationTimestamp_futureNotificationTimestampNotForced(), WatchedItemStoreUnitTest\testResetNotificationTimestamp_item(), WatchedItemStoreUnitTest\testResetNotificationTimestamp_noItemForced(), WatchedItemStoreUnitTest\testResetNotificationTimestamp_notWatchedPageForced(), WatchedItemStoreUnitTest\testResetNotificationTimestamp_oldidSpecifiedLatestRevisionForced(), WatchedItemStoreUnitTest\testResetNotificationTimestamp_oldidSpecifiedNotLatestRevisionForced(), and MediaWiki\Auth\AuthManagerTest\testSecuritySensitiveOperationStatus().

Member Data Documentation

callable ScopedCallback::$callback
protected

Definition at line 30 of file ScopedCallback.php.

Referenced by __construct().

array ScopedCallback::$params
protected

Definition at line 32 of file ScopedCallback.php.

Referenced by __construct().


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