Source for file ObjectMixin.php

Documentation is available at ObjectMixin.php

1: <?php
2:
3: /**
4: * Nette Framework
5: *
6: * Copyright (c) 2004, 2009 David Grudl (http://davidgrudl.com)
7: *
8: * This source file is subject to the "Nette license" that is bundled
9: * with this package in the file license.txt.
10: *
11: * For more information please see https://nette.org
12: *
13: * @copyright Copyright (c) 2004, 2009 David Grudl
14: * @license https://nette.org/license Nette license
15: * @link https://nette.org
16: * @category Nette
17: * @package Nette
18: * @version $Id$
19: */
20:
21:
22:
23: require_once dirname(__FILE__) . '/compatibility.php';
24:
25: require_once dirname(__FILE__) . '/exceptions.php';
26:
27:
28:
29: /**
30: * Nette\Object behaviour mixin.
31: *
32: * @author David Grudl
33: * @copyright Copyright (c) 2004, 2009 David Grudl
34: * @package Nette
35: */
36: final class ObjectMixin
37: {
38: /** @var array (method => array(type => callback)) */
39: private static $extMethods;
40:
41: /** @var array */
42: private static $methods;
43:
44:
45:
46: /**
47: * Static class - cannot be instantiated.
48: */
49: final public function __construct()
50: {
51: throw new LogicException("Cannot instantiate static class " . get_class($this));
52: }
53:
54:
55:
56: /**
57: * Call to undefined method.
58: *
59: * @param string method name
60: * @param array arguments
61: * @return mixed
62: * @throws MemberAccessException
63: */
64: public static function call($_this, $name, $args)
65: {
66: $class = get_class($_this);
67:
68: if ($name === '') {
69: throw new MemberAccessException("Call to class '$class' method without name.");
70: }
71:
72: // event functionality
73: if (preg_match('#^on[A-Z]#', $name)) {
74: $rp = new ReflectionProperty($class, $name);
75: if ($rp->isPublic() && !$rp->isStatic()) {
76: $list = $_this->$name;
77: if (is_array($list) || $list instanceof Traversable) {
78: foreach ($list as $handler) {
79: fixCallback($handler);
80: if (!is_callable($handler)) {
81: $able = is_callable($handler, TRUE, $textual);
82: throw new InvalidStateException("Event handler '$textual' is not " . ($able ? 'callable.' : 'valid PHP callback.'));
83: }
84: call_user_func_array($handler, $args);
85: }
86: }
87: return NULL;
88: }
89: }
90:
91: // extension methods
92: if ($cb = self::extensionMethod($class, $name)) {
93: array_unshift($args, $_this);
94: return call_user_func_array($cb, $args);
95: }
96:
97: throw new MemberAccessException("Call to undefined method $class::$name().");
98: }
99:
100:
101:
102: /**
103: * Adding method to class.
104: *
105: * @param string class name
106: * @param string method name
107: * @param mixed callback or closure
108: * @return mixed
109: */
110: public static function extensionMethod($class, $name, $callback = NULL)
111: {
112: if (self::$extMethods === NULL || $name === NULL) { // for backwards compatibility
113: $list = get_defined_functions();
114: foreach ($list['user'] as $fce) {
115: $pair = explode('_prototype_', $fce);
116: if (count($pair) === 2) {
117: self::$extMethods[$pair[1]][$pair[0]] = $fce;
118: self::$extMethods[$pair[1]][''] = NULL;
119: }
120: }
121: if ($name === NULL) return NULL;
122: }
123:
124: $class = strtolower($class);
125: $l = & self::$extMethods[strtolower($name)];
126:
127: if ($callback !== NULL) { // works as setter
128: fixCallback($callback);
129: if (!is_callable($callback)) {
130: $able = is_callable($callback, TRUE, $textual);
131: throw new InvalidArgumentException("Extension method handler '$textual' is not " . ($able ? 'callable.' : 'valid PHP callback.'));
132: }
133: $l[$class] = $callback;
134: $l[''] = NULL;
135: return NULL;
136: }
137:
138: // works as getter
139: if (empty($l)) {
140: return FALSE;
141:
142: } elseif (isset($l[''][$class])) { // cached value
143: return $l[''][$class];
144: }
145:
146: $cl = $class;
147: do {
148: $cl = strtolower($cl);
149: if (isset($l[$cl])) {
150: return $l[''][$class] = $l[$cl];
151: }
152: } while (($cl = get_parent_class($cl)) !== FALSE);
153:
154: foreach (class_implements($class) as $cl) {
155: $cl = strtolower($cl);
156: if (isset($l[$cl])) {
157: return $l[''][$class] = $l[$cl];
158: }
159: }
160: return $l[''][$class] = FALSE;
161: }
162:
163:
164:
165: /**
166: * Returns property value.
167: *
168: * @param string property name
169: * @return mixed property value
170: * @throws MemberAccessException if the property is not defined.
171: */
172: public static function & get($_this, $name)
173: {
174: $class = get_class($_this);
175:
176: if ($name === '') {
177: throw new MemberAccessException("Cannot read a class '$class' property without name.");
178: }
179:
180: if (!isset(self::$methods[$class])) {
181: // get_class_methods returns ONLY PUBLIC methods of objects
182: // but returns static methods too (nothing doing...)
183: // and is much faster than reflection
184: // (works good since 5.0.4)
185: self::$methods[$class] = array_flip(get_class_methods($class));
186: }
187:
188: // property getter support
189: $name[0] = $name[0] & "\xDF"; // case-sensitive checking, capitalize first character
190: $m = 'get' . $name;
191: if (isset(self::$methods[$class][$m])) {
192: // ampersands:
193: // - uses &__get() because declaration should be forward compatible (e.g. with Nette\Web\Html)
194: // - doesn't call &$_this->$m because user could bypass property setter by: $x = & $obj->property; $x = 'new value';
195: $val = $_this->$m();
196: return $val;
197: }
198:
199: $m = 'is' . $name;
200: if (isset(self::$methods[$class][$m])) {
201: $val = $_this->$m();
202: return $val;
203: }
204:
205: $name = func_get_arg(1);
206: throw new MemberAccessException("Cannot read an undeclared property $class::\$$name.");
207: }
208:
209:
210:
211: /**
212: * Sets value of a property.
213: *
214: * @param string property name
215: * @param mixed property value
216: * @return void
217: * @throws MemberAccessException if the property is not defined or is read-only
218: */
219: public static function set($_this, $name, $value)
220: {
221: $class = get_class($_this);
222:
223: if ($name === '') {
224: throw new MemberAccessException("Cannot assign to a class '$class' property without name.");
225: }
226:
227: if (!isset(self::$methods[$class])) {
228: self::$methods[$class] = array_flip(get_class_methods($class));
229: }
230:
231: // property setter support
232: $name[0] = $name[0] & "\xDF"; // case-sensitive checking, capitalize first character
233: if (isset(self::$methods[$class]['get' . $name]) || isset(self::$methods[$class]['is' . $name])) {
234: $m = 'set' . $name;
235: if (isset(self::$methods[$class][$m])) {
236: $_this->$m($value);
237: return;
238:
239: } else {
240: $name = func_get_arg(1);
241: throw new MemberAccessException("Cannot assign to a read-only property $class::\$$name.");
242: }
243: }
244:
245: $name = func_get_arg(1);
246: throw new MemberAccessException("Cannot assign to an undeclared property $class::\$$name.");
247: }
248:
249:
250:
251: /**
252: * Is property defined?
253: *
254: * @param string property name
255: * @return bool
256: */
257: public static function has($_this, $name)
258: {
259: if ($name === '') {
260: return FALSE;
261: }
262:
263: $class = get_class($_this);
264: if (!isset(self::$methods[$class])) {
265: self::$methods[$class] = array_flip(get_class_methods($class));
266: }
267:
268: $name[0] = $name[0] & "\xDF";
269: return isset(self::$methods[$class]['get' . $name]) || isset(self::$methods[$class]['is' . $name]);
270: }
271:
272: }

Source for file ObjectMixin.php

Namespaces