blob: 1ec9eaa62702b01a877cd78e07a12c2833367ba9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
|
<?php
/**
* This file deals with RAII style scoped callbacks.
*
* 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
*/
/**
* Class for asserting that a callback happens when an dummy object leaves scope
*
* @since 1.21
*/
class ScopedCallback {
/** @var callable */
protected $callback;
/** @var array */
protected $params;
/**
* @param callable|null $callback
* @param array $params Callback arguments (since 1.25)
* @throws Exception
*/
public function __construct( $callback, array $params = array() ) {
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 is 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 this leaves scope
*/
function __destruct() {
if ( $this->callback !== null ) {
call_user_func_array( $this->callback, $this->params );
}
}
}
|
