Source for file Object.php

Documentation is available at Object.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__) . '/exceptions.php';
24:
25: require_once dirname(__FILE__) . '/ObjectMixin.php';
26:
27:
28:
29: /**
30: * Nette\Object is the ultimate ancestor of all instantiable classes.
31: *
32: * It defines some handful methods and enhances object core of PHP:
33: * - access to undeclared members throws exceptions
34: * - support for conventional properties with getters and setters
35: * - support for event raising functionality
36: * - ability to add new methods to class (extension methods)
37: *
38: * Properties is a syntactic sugar which allows access public getter and setter
39: * methods as normal object variables. A property is defined by a getter method
40: * and optional setter method (no setter method means read-only property).
41: * <code>
42: * $val = $obj->label; // equivalent to $val = $obj->getLabel();
43: * $obj->label = 'Nette'; // equivalent to $obj->setLabel('Nette');
44: * </code>
45: * Property names are case-sensitive, and they are written in the camelCaps
46: * or PascalCaps.
47: *
48: * Event functionality is provided by declaration of property named 'on{Something}'
49: * Multiple handlers are allowed.
50: * <code>
51: * public $onClick; // declaration in class
52: * $this->onClick[] = 'callback'; // attaching event handler
53: * if (!empty($this->onClick)) ... // are there any handlers?
54: * $this->onClick($sender, $arg); // raises the event with arguments
55: * </code>
56: *
57: * Adding method to class (i.e. to all instances) works similar to JavaScript
58: * prototype property. The syntax for adding a new method is:
59: * <code>
60: * MyClass::extensionMethod('newMethod', function(MyClass $obj, $arg, ...) { ... });
61: * $obj = new MyClass;
62: * $obj->newMethod($x);
63: * </code>
64: *
65: * @author David Grudl
66: * @copyright Copyright (c) 2004, 2009 David Grudl
67: * @package Nette
68: */
69: abstract class Object
70: {
71:
72: /**
73: * Returns the name of the class of this object.
74: *
75: * @return string
76: */
77: final public function getClass()
78: {
79: return get_class($this);
80: }
81:
82:
83:
84: /**
85: * Access to reflection.
86: *
87: * @return ReflectionObject
88: */
89: final public function getReflection()
90: {
91: return new ReflectionObject($this);
92: }
93:
94:
95:
96: /**
97: * Call to undefined method.
98: *
99: * @param string method name
100: * @param array arguments
101: * @return mixed
102: * @throws MemberAccessException
103: */
104: public function __call($name, $args)
105: {
106: return ObjectMixin::call($this, $name, $args);
107: }
108:
109:
110:
111: /**
112: * Call to undefined static method.
113: *
114: * @param string method name (in lower case!)
115: * @param array arguments
116: * @return mixed
117: * @throws MemberAccessException
118: */
119: public static function __callStatic($name, $args)
120: {
121: $class = get_called_class();
122: throw new MemberAccessException("Call to undefined static method $class::$name().");
123: }
124:
125:
126:
127: /**
128: * Adding method to class.
129: *
130: * @param string method name
131: * @param mixed callback or closure
132: * @return mixed
133: */
134: public static function extensionMethod($name, $callback = NULL)
135: {
136: if (strpos($name, '::') === FALSE) {
137: $class = get_called_class();
138: } else {
139: list($class, $name) = explode('::', $name);
140: }
141: return ObjectMixin::extensionMethod($class, $name, $callback);
142: }
143:
144:
145:
146: /**
147: * Returns property value. Do not call directly.
148: *
149: * @param string property name
150: * @return mixed property value
151: * @throws MemberAccessException if the property is not defined.
152: */
153: public function &__get($name)
154: {
155: return ObjectMixin::get($this, $name);
156: }
157:
158:
159:
160: /**
161: * Sets value of a property. Do not call directly.
162: *
163: * @param string property name
164: * @param mixed property value
165: * @return void
166: * @throws MemberAccessException if the property is not defined or is read-only
167: */
168: public function __set($name, $value)
169: {
170: return ObjectMixin::set($this, $name, $value);
171: }
172:
173:
174:
175: /**
176: * Is property defined?
177: *
178: * @param string property name
179: * @return bool
180: */
181: public function __isset($name)
182: {
183: return ObjectMixin::has($this, $name);
184: }
185:
186:
187:
188: /**
189: * Access to undeclared property.
190: *
191: * @param string property name
192: * @return void
193: * @throws MemberAccessException
194: */
195: public function __unset($name)
196: {
197: throw new MemberAccessException("Cannot unset the property $this->class::\$$name.");
198: }
199:
200: }

Source for file Object.php

Namespaces