1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace SilverStripe\Core; |
4
|
|
|
|
5
|
|
|
use BadMethodCallException; |
6
|
|
|
use SilverStripe\ORM\DataObject; |
7
|
|
|
|
8
|
|
|
/** |
9
|
|
|
* Add extension that can be added to an object with {@link Object::add_extension()}. |
10
|
|
|
* For {@link DataObject} extensions, use {@link DataExtension}. |
11
|
|
|
* Each extension instance has an "owner" instance, accessible through |
12
|
|
|
* {@link getOwner()}. |
13
|
|
|
* Every object instance gets its own set of extension instances, |
14
|
|
|
* meaning you can set parameters specific to the "owner instance" |
15
|
|
|
* in new Extension instances. |
16
|
|
|
*/ |
17
|
|
|
abstract class Extension |
18
|
|
|
{ |
19
|
|
|
/** |
20
|
|
|
* This is used by extensions designed to be applied to controllers. |
21
|
|
|
* It works the same way as {@link Controller::$allowed_actions}. |
22
|
|
|
*/ |
23
|
|
|
private static $allowed_actions = []; |
24
|
|
|
|
25
|
|
|
/** |
26
|
|
|
* The object this extension is applied to. |
27
|
|
|
* |
28
|
|
|
* @var Object |
29
|
|
|
*/ |
30
|
|
|
protected $owner; |
31
|
|
|
|
32
|
|
|
/** |
33
|
|
|
* The base class that this extension was applied to; $this->owner must be one of these |
34
|
|
|
* |
35
|
|
|
* @var DataObject |
36
|
|
|
*/ |
37
|
|
|
protected $ownerBaseClass; |
38
|
|
|
|
39
|
|
|
/** |
40
|
|
|
* Ownership stack for recursive methods. |
41
|
|
|
* Last item is current owner. |
42
|
|
|
* |
43
|
|
|
* @var array |
44
|
|
|
*/ |
45
|
|
|
private $ownerStack = []; |
46
|
|
|
|
47
|
|
|
public function __construct() |
48
|
|
|
{ |
49
|
|
|
} |
50
|
|
|
|
51
|
|
|
/** |
52
|
|
|
* Called when this extension is added to a particular class |
53
|
|
|
* |
54
|
|
|
* @param string $class |
55
|
|
|
* @param string $extensionClass |
56
|
|
|
* @param mixed $args |
57
|
|
|
*/ |
58
|
|
|
public static function add_to_class($class, $extensionClass, $args = null) |
|
|
|
|
59
|
|
|
{ |
60
|
|
|
// NOP |
61
|
|
|
} |
62
|
|
|
|
63
|
|
|
/** |
64
|
|
|
* Set the owner of this extension. |
65
|
|
|
* |
66
|
|
|
* @param object $owner The owner object, |
67
|
|
|
* @param string $ownerBaseClass The base class that the extension is applied to; this may be |
68
|
|
|
* the class of owner, or it may be a parent. For example, if Versioned was applied to SiteTree, |
69
|
|
|
* and then a Page object was instantiated, $owner would be a Page object, but $ownerBaseClass |
70
|
|
|
* would be 'SiteTree'. |
71
|
|
|
*/ |
72
|
|
|
public function setOwner($owner, $ownerBaseClass = null) |
73
|
|
|
{ |
74
|
|
|
if ($owner) { |
75
|
|
|
$this->ownerStack[] = $owner; |
76
|
|
|
} |
77
|
|
|
$this->owner = $owner; |
78
|
|
|
|
79
|
|
|
// Set ownerBaseClass |
80
|
|
|
if ($ownerBaseClass) { |
|
|
|
|
81
|
|
|
$this->ownerBaseClass = $ownerBaseClass; |
|
|
|
|
82
|
|
|
} elseif (!$this->ownerBaseClass && $owner) { |
83
|
|
|
$this->ownerBaseClass = get_class($owner); |
|
|
|
|
84
|
|
|
} |
85
|
|
|
} |
86
|
|
|
|
87
|
|
|
/** |
88
|
|
|
* Clear the current owner, and restore extension to the state prior to the last setOwner() |
89
|
|
|
*/ |
90
|
|
|
public function clearOwner() |
91
|
|
|
{ |
92
|
|
|
if (empty($this->ownerStack)) { |
93
|
|
|
throw new BadMethodCallException("clearOwner() called more than setOwner()"); |
94
|
|
|
} |
95
|
|
|
array_pop($this->ownerStack); |
96
|
|
|
if ($this->ownerStack) { |
|
|
|
|
97
|
|
|
$this->owner = end($this->ownerStack); |
98
|
|
|
} else { |
99
|
|
|
$this->owner = null; |
100
|
|
|
} |
101
|
|
|
} |
102
|
|
|
|
103
|
|
|
/** |
104
|
|
|
* Returns the owner of this extension. |
105
|
|
|
* |
106
|
|
|
* @return Object |
107
|
|
|
*/ |
108
|
|
|
public function getOwner() |
109
|
|
|
{ |
110
|
|
|
return $this->owner; |
111
|
|
|
} |
112
|
|
|
|
113
|
|
|
/** |
114
|
|
|
* Helper method to strip eval'ed arguments from a string |
115
|
|
|
* that's passed to {@link DataObject::$extensions} or |
116
|
|
|
* {@link Object::add_extension()}. |
117
|
|
|
* |
118
|
|
|
* @param string $extensionStr E.g. "Versioned('Stage','Live')" |
119
|
|
|
* @return string Extension classname, e.g. "Versioned" |
120
|
|
|
*/ |
121
|
|
|
public static function get_classname_without_arguments($extensionStr) |
122
|
|
|
{ |
123
|
|
|
$parts = explode('(', $extensionStr); |
124
|
|
|
return $parts[0]; |
125
|
|
|
} |
126
|
|
|
} |
127
|
|
|
|
This check looks from parameters that have been defined for a function or method, but which are not used in the method body.