Current File : //www/varak.net/wiki.varak.net/vendor/wikimedia/scoped-callback/src/ScopedCallback.php
<?php
/**
* This file deals with RAII style scoped callbacks.
*
* Copyright (C) 2016 Aaron Schulz <aschulz@wikimedia.org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace Wikimedia;
/**
* Class for asserting that a callback happens when a dummy object leaves scope
*/
class ScopedCallback {
/** @var callable */
protected $callback;
/** @var array */
protected $params;
/**
* @param callable|null $callback
* @param array $params Callback arguments (since 1.0.0, MediaWiki 1.25)
* @throws \InvalidArgumentException
*/
public function __construct( $callback, array $params = [] ) {
if ( $callback !== null && !is_callable( $callback ) ) {
throw new \InvalidArgumentException( "Provided callback is not valid." );
}
$this->callback = $callback;
$this->params = $params;
}
/**
* Trigger a scoped callback and destroy it.
* This is the same as just setting it to null.
*
* @param ScopedCallback &$sc
*/
public static function consume( ScopedCallback &$sc = null ) {
$sc = null;
}
/**
* Destroy a scoped callback without triggering it.
*
* @param ScopedCallback &$sc
*/
public static function cancel( ScopedCallback &$sc = null ) {
if ( $sc ) {
$sc->callback = null;
}
$sc = null;
}
/**
* Trigger the callback when it leaves scope.
*/
function __destruct() {
if ( $this->callback !== null ) {
call_user_func_array( $this->callback, $this->params );
}
}
/**
* Do not allow this class to be serialized
*/
function __sleep() {
throw new \UnexpectedValueException( __CLASS__ . ' cannot be serialized' );
}
/**
* Protect the caller against arbitrary code execution
*/
function __wakeup() {
$this->callback = null;
throw new \UnexpectedValueException( __CLASS__ . ' cannot be unserialized' );
}
}
Mini Shell