|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/** |
|
4
|
|
|
* @copyright 2016 Vladimir Jimenez |
|
5
|
|
|
* @license https://github.com/allejo/stakx/blob/master/LICENSE.md MIT |
|
6
|
|
|
*/ |
|
7
|
|
|
|
|
8
|
|
|
namespace allejo\stakx\Object; |
|
9
|
|
|
|
|
10
|
|
|
/** |
|
11
|
|
|
* Class JailObject |
|
12
|
|
|
* |
|
13
|
|
|
* A wrapper object to only allow certain functions on the white list to be called. This is used in order to limit which |
|
14
|
|
|
* functions a user can call from Twig templates to prevent unexpected behavior. |
|
15
|
|
|
* |
|
16
|
|
|
* @package allejo\stakx\Object |
|
17
|
|
|
*/ |
|
18
|
|
|
class JailObject implements \ArrayAccess |
|
19
|
|
|
{ |
|
20
|
|
|
/** |
|
21
|
|
|
* @var string[] |
|
22
|
|
|
*/ |
|
23
|
|
|
private $whiteListFunctions; |
|
24
|
|
|
|
|
25
|
|
|
/** |
|
26
|
|
|
* @var string[] |
|
27
|
|
|
*/ |
|
28
|
|
|
private $jailedFunctions; |
|
29
|
|
|
|
|
30
|
|
|
/** |
|
31
|
|
|
* @var Jailable |
|
32
|
|
|
*/ |
|
33
|
|
|
private $object; |
|
34
|
|
|
|
|
35
|
|
|
/** |
|
36
|
|
|
* JailObject constructor. |
|
37
|
|
|
* |
|
38
|
|
|
* @param Jailable $object The object that will be jailed |
|
39
|
|
|
* @param array $whiteListFunctions A list of function names that can be called |
|
40
|
|
|
* @param array $jailedFunctions |
|
41
|
|
|
*/ |
|
42
|
4 |
|
public function __construct (&$object, array $whiteListFunctions, array $jailedFunctions = array()) |
|
43
|
|
|
{ |
|
44
|
4 |
|
if (!($object instanceof Jailable) && !($object instanceof \ArrayAccess)) |
|
45
|
4 |
|
{ |
|
46
|
|
|
throw new \InvalidArgumentException('Must implement the ArrayAccess and Jailable interfaces'); |
|
47
|
|
|
} |
|
48
|
|
|
|
|
49
|
4 |
|
$this->object = &$object; |
|
50
|
4 |
|
$this->whiteListFunctions = $whiteListFunctions; |
|
51
|
4 |
|
$this->jailedFunctions = $jailedFunctions; |
|
52
|
4 |
|
} |
|
53
|
|
|
|
|
54
|
3 |
|
public function __call ($name, $arguments) |
|
55
|
|
|
{ |
|
56
|
|
|
// White listed functions will always be getter functions, so somehow get the name of a possible getter function |
|
57
|
|
|
// name. |
|
58
|
3 |
|
$lcName = lcfirst($name); |
|
59
|
3 |
|
$getFxnCall = ($lcName[0] === 'g' && strpos($lcName, 'get') === 0) ? $lcName : sprintf('get%s', ucfirst($name)); |
|
60
|
|
|
|
|
61
|
|
|
// Check if our function call is a jailed call, meaning the function should be mapped to special "jailed" |
|
62
|
|
|
// jailed version of the function call. |
|
63
|
3 |
View Code Duplication |
if (in_array($getFxnCall, $this->jailedFunctions)) |
|
|
|
|
|
|
64
|
3 |
|
{ |
|
65
|
|
|
return call_user_func_array(array($this->object, $this->jailedFunctions[$getFxnCall]), $arguments); |
|
66
|
|
|
} |
|
67
|
|
|
|
|
68
|
|
|
// Otherwise, test to see if the function call is in our white list and call it |
|
69
|
3 |
View Code Duplication |
if (in_array($getFxnCall, $this->whiteListFunctions)) |
|
|
|
|
|
|
70
|
3 |
|
{ |
|
71
|
2 |
|
return call_user_func_array(array($this->object, $getFxnCall), $arguments); |
|
72
|
|
|
} |
|
73
|
|
|
|
|
74
|
|
|
// Functions should take precedence over __get(), so if it's not a function we'll search to see if the __get() |
|
75
|
|
|
// handles it |
|
76
|
1 |
|
if ($this->object->isMagicGet($name)) |
|
77
|
1 |
|
{ |
|
78
|
|
|
return $this->object->$name; |
|
79
|
|
|
} |
|
80
|
|
|
|
|
81
|
1 |
|
throw new \BadMethodCallException(); |
|
82
|
|
|
} |
|
83
|
|
|
|
|
84
|
1 |
|
public function __get ($name) |
|
85
|
|
|
{ |
|
86
|
1 |
|
if ($this->object->isMagicGet($name)) |
|
87
|
1 |
|
{ |
|
88
|
1 |
|
return $this->object->$name; |
|
89
|
|
|
} |
|
90
|
|
|
|
|
91
|
|
|
return NULL; |
|
92
|
|
|
} |
|
93
|
|
|
|
|
94
|
|
|
public function coreInstanceOf ($class) |
|
95
|
|
|
{ |
|
96
|
|
|
return is_subclass_of($this->object, $class); |
|
97
|
|
|
} |
|
98
|
|
|
|
|
99
|
|
|
// |
|
100
|
|
|
// ArrayAccess Implementation |
|
101
|
|
|
// |
|
102
|
|
|
|
|
103
|
|
|
/** |
|
104
|
|
|
* {@inheritdoc} |
|
105
|
|
|
*/ |
|
106
|
1 |
|
public function offsetExists($offset) |
|
107
|
|
|
{ |
|
108
|
1 |
|
return $this->object->offsetExists($offset); |
|
109
|
|
|
} |
|
110
|
|
|
|
|
111
|
|
|
/** |
|
112
|
|
|
* {@inheritdoc} |
|
113
|
|
|
*/ |
|
114
|
1 |
|
public function offsetGet($offset) |
|
115
|
|
|
{ |
|
116
|
1 |
|
return $this->object->offsetGet($offset); |
|
117
|
|
|
} |
|
118
|
|
|
|
|
119
|
|
|
/** |
|
120
|
|
|
* {@inheritdoc} |
|
121
|
|
|
*/ |
|
122
|
|
|
public function offsetSet($offset, $value) |
|
123
|
|
|
{ |
|
124
|
|
|
return $this->object->offsetSet($offset, $value); |
|
125
|
|
|
} |
|
126
|
|
|
|
|
127
|
|
|
/** |
|
128
|
|
|
* {@inheritdoc} |
|
129
|
|
|
*/ |
|
130
|
|
|
public function offsetUnset($offset) |
|
131
|
|
|
{ |
|
132
|
|
|
return $this->object->offsetUnset($offset); |
|
133
|
|
|
} |
|
134
|
|
|
} |
stakx-io /
stakx
Loading history...
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.