Object.php 7.19 KB
Newer Older
1 2 3
<?php
/**
 * @link http://www.yiiframework.com/
Qiang Xue committed
4
 * @copyright Copyright (c) 2008 Yii Software LLC
5 6 7 8 9
 * @license http://www.yiiframework.com/license/
 */

namespace yii\base;

Qiang Xue committed
10 11
use Yii;

12
/**
Qiang Xue committed
13
 * @include @yii/base/Object.md
14 15 16
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
17
class Object implements Arrayable
18
{
19 20 21 22 23 24 25 26
	/**
	 * @return string the fully qualified name of this class.
	 */
	public static function className()
	{
		return get_called_class();
	}

Qiang Xue committed
27 28
	/**
	 * Constructor.
Qiang Xue committed
29 30 31 32 33 34 35 36 37 38 39 40 41 42
	 * The default implementation does two things:
	 *
	 * - Initializes the object with the given configuration `$config`.
	 * - Call [[init()]].
	 *
	 * If this method is overridden in a child class, it is recommended that
	 *
	 * - the last parameter of the constructor is a configuration array, like `$config` here.
	 * - call the parent implementation at the end of the constructor.
	 *
	 * @param array $config name-value pairs that will be used to initialize the object properties
	 */
	public function __construct($config = array())
	{
Qiang Xue committed
43 44
		if (!empty($config)) {
			Yii::configure($this, $config);
Qiang Xue committed
45 46 47 48 49 50 51 52
		}
		$this->init();
	}

	/**
	 * Initializes the object.
	 * This method is invoked at the end of the constructor after the object is initialized with the
	 * given configuration.
Qiang Xue committed
53
	 */
Qiang Xue committed
54
	public function init()
Qiang Xue committed
55 56 57
	{
	}

58
	/**
mdomba (mdlap) committed
59
	 * Returns the value of an object property.
60 61 62 63 64 65
	 *
	 * Do not call this method directly as it is a PHP magic method that
	 * will be implicitly called when executing `$value = $object->property;`.
	 * @param string $name the property name
	 * @return mixed the property value, event handlers attached to the event,
	 * the named behavior, or the value of a behavior's property
Qiang Xue committed
66
	 * @throws UnknownPropertyException if the property is not defined
67 68 69 70 71 72 73
	 * @see __set
	 */
	public function __get($name)
	{
		$getter = 'get' . $name;
		if (method_exists($this, $getter)) {
			return $this->$getter();
Qiang Xue committed
74
		} else {
Qiang Xue committed
75
			throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
76 77 78 79
		}
	}

	/**
mdomba (mdlap) committed
80
	 * Sets value of an object property.
81 82 83 84 85
	 *
	 * Do not call this method directly as it is a PHP magic method that
	 * will be implicitly called when executing `$object->property = $value;`.
	 * @param string $name the property name or the event name
	 * @param mixed $value the property value
86 87
	 * @throws UnknownPropertyException if the property is not defined
	 * @throws InvalidCallException if the property is read-only.
88 89 90 91 92 93
	 * @see __get
	 */
	public function __set($name, $value)
	{
		$setter = 'set' . $name;
		if (method_exists($this, $setter)) {
Qiang Xue committed
94
			$this->$setter($value);
Qiang Xue committed
95
		} elseif (method_exists($this, 'get' . $name)) {
Qiang Xue committed
96
			throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
Qiang Xue committed
97
		} else {
Qiang Xue committed
98
			throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
		}
	}

	/**
	 * Checks if the named property is set (not null).
	 *
	 * Do not call this method directly as it is a PHP magic method that
	 * will be implicitly called when executing `isset($object->property)`.
	 *
	 * Note that if the property is not defined, false will be returned.
	 * @param string $name the property name or the event name
	 * @return boolean whether the named property is set (not null).
	 */
	public function __isset($name)
	{
		$getter = 'get' . $name;
115
		if (method_exists($this, $getter)) {
116
			return $this->$getter() !== null;
Qiang Xue committed
117
		} else {
Qiang Xue committed
118
			return false;
119 120 121 122
		}
	}

	/**
mdomba (mdlap) committed
123
	 * Sets an object property to null.
124 125 126 127 128 129 130
	 *
	 * Do not call this method directly as it is a PHP magic method that
	 * will be implicitly called when executing `unset($object->property)`.
	 *
	 * Note that if the property is not defined, this method will do nothing.
	 * If the property is read-only, it will throw an exception.
	 * @param string $name the property name
131
	 * @throws InvalidCallException if the property is read only.
132 133 134 135
	 */
	public function __unset($name)
	{
		$setter = 'set' . $name;
136
		if (method_exists($this, $setter)) {
137
			$this->$setter(null);
Qiang Xue committed
138
		} elseif (method_exists($this, 'get' . $name)) {
Qiang Xue committed
139
			throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
140 141 142
		}
	}

Qiang Xue committed
143 144 145 146 147 148 149 150 151
	/**
	 * Calls the named method which is not a class method.
	 * If the name refers to a component property whose value is
	 * an anonymous function, the method will execute the function.
	 *
	 * Do not call this method directly as it is a PHP magic method that
	 * will be implicitly called when an unknown method is being invoked.
	 * @param string $name the method name
	 * @param array $params method parameters
Qiang Xue committed
152
	 * @throws UnknownMethodException when calling unknown method
Qiang Xue committed
153 154 155 156
	 * @return mixed the method return value
	 */
	public function __call($name, $params)
	{
Qiang Xue committed
157 158 159
		$getter = 'get' . $name;
		if (method_exists($this, $getter)) {
			$func = $this->$getter();
Qiang Xue committed
160 161 162 163
			if ($func instanceof \Closure) {
				return call_user_func_array($func, $params);
			}
		}
Qiang Xue committed
164
		throw new UnknownMethodException('Unknown method: ' . get_class($this) . "::$name()");
Qiang Xue committed
165 166
	}

167 168
	/**
	 * Returns a value indicating whether a property is defined.
Qiang Xue committed
169 170 171 172 173 174
	 * A property is defined if:
	 *
	 * - the class has a getter or setter method associated with the specified name
	 *   (in this case, property name is case-insensitive);
	 * - the class has a member variable with the specified name (when `$checkVar` is true);
	 *
175
	 * @param string $name the property name
Qiang Xue committed
176
	 * @param boolean $checkVar whether to treat member variables as properties
177 178 179 180
	 * @return boolean whether the property is defined
	 * @see canGetProperty
	 * @see canSetProperty
	 */
Qiang Xue committed
181
	public function hasProperty($name, $checkVar = true)
182
	{
Qiang Xue committed
183
		return $this->canGetProperty($name, $checkVar) || $this->canSetProperty($name, false);
184 185 186 187
	}

	/**
	 * Returns a value indicating whether a property can be read.
Qiang Xue committed
188 189 190 191 192 193
	 * A property is readable if:
	 *
	 * - the class has a getter method associated with the specified name
	 *   (in this case, property name is case-insensitive);
	 * - the class has a member variable with the specified name (when `$checkVar` is true);
	 *
194
	 * @param string $name the property name
Qiang Xue committed
195
	 * @param boolean $checkVar whether to treat member variables as properties
196 197 198
	 * @return boolean whether the property can be read
	 * @see canSetProperty
	 */
Qiang Xue committed
199
	public function canGetProperty($name, $checkVar = true)
200
	{
Qiang Xue committed
201
		return method_exists($this, 'get' . $name) || $checkVar && property_exists($this, $name);
202 203 204 205
	}

	/**
	 * Returns a value indicating whether a property can be set.
Qiang Xue committed
206 207 208 209 210 211
	 * A property is writable if:
	 *
	 * - the class has a setter method associated with the specified name
	 *   (in this case, property name is case-insensitive);
	 * - the class has a member variable with the specified name (when `$checkVar` is true);
	 *
212
	 * @param string $name the property name
Qiang Xue committed
213
	 * @param boolean $checkVar whether to treat member variables as properties
214 215 216
	 * @return boolean whether the property can be written
	 * @see canGetProperty
	 */
Qiang Xue committed
217
	public function canSetProperty($name, $checkVar = true)
218
	{
Qiang Xue committed
219
		return method_exists($this, 'set' . $name) || $checkVar && property_exists($this, $name);
220
	}
Qiang Xue committed
221 222

	/**
223 224 225
	 * Converts the object into an array.
	 * The default implementation will return all public property values as an array.
	 * @return array the array representation of the object
Qiang Xue committed
226
	 */
227
	public function toArray()
Qiang Xue committed
228
	{
229
		return Yii::getObjectVars($this);
Qiang Xue committed
230
	}
231
}