You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
290 lines
10 KiB
290 lines
10 KiB
<?php |
|
/** |
|
* @link http://www.yiiframework.com/ |
|
* @copyright Copyright (c) 2008 Yii Software LLC |
|
* @license http://www.yiiframework.com/license/ |
|
*/ |
|
|
|
namespace yii\base; |
|
|
|
use Yii; |
|
|
|
/** |
|
* Object is the base class that implements the *property* feature. |
|
* |
|
* A property is defined by a getter method (e.g. `getLabel`), and/or a setter method (e.g. `setLabel`). For example, |
|
* the following getter and setter methods define a property named `label`: |
|
* |
|
* ~~~ |
|
* private $_label; |
|
* |
|
* public function getLabel() |
|
* { |
|
* return $this->_label; |
|
* } |
|
* |
|
* public function setLabel($value) |
|
* { |
|
* $this->_label = $value; |
|
* } |
|
* ~~~ |
|
* |
|
* Property names are *case-insensitive*. |
|
* |
|
* A property can be accessed like a member variable of an object. Reading or writing a property will cause the invocation |
|
* of the corresponding getter or setter method. For example, |
|
* |
|
* ~~~ |
|
* // equivalent to $label = $object->getLabel(); |
|
* $label = $object->label; |
|
* // equivalent to $object->setLabel('abc'); |
|
* $object->label = 'abc'; |
|
* ~~~ |
|
* |
|
* If a property has only a getter method and has no setter method, it is considered as *read-only*. In this case, trying |
|
* to modify the property value will cause an exception. |
|
* |
|
* One can call [[hasProperty()]], [[canGetProperty()]] and/or [[canSetProperty()]] to check the existence of a property. |
|
* |
|
* Besides the property feature, Object also introduces an important object initialization life cycle. In particular, |
|
* creating an new instance of Object or its derived class will involve the following life cycles sequentially: |
|
* |
|
* 1. the class constructor is invoked; |
|
* 2. object properties are initialized according to the given configuration; |
|
* 3. the `init()` method is invoked. |
|
* |
|
* In the above, both Step 2 and 3 occur at the end of the class constructor. It is recommended that |
|
* you perform object initialization in the `init()` method because at that stage, the object configuration |
|
* is already applied. |
|
* |
|
* In order to ensure the above life cycles, if a child class of Object needs to override the constructor, |
|
* it should be done like the following: |
|
* |
|
* ~~~ |
|
* public function __construct($param1, $param2, ..., $config = []) |
|
* { |
|
* ... |
|
* parent::__construct($config); |
|
* } |
|
* ~~~ |
|
* |
|
* That is, a `$config` parameter (defaults to `[]`) should be declared as the last parameter |
|
* of the constructor, and the parent implementation should be called at the end of the constructor. |
|
* |
|
* @author Qiang Xue <qiang.xue@gmail.com> |
|
* @since 2.0 |
|
*/ |
|
class Object implements Configurable |
|
{ |
|
/** |
|
* Returns the fully qualified name of this class. |
|
* @return string the fully qualified name of this class. |
|
*/ |
|
public static function className() |
|
{ |
|
return get_called_class(); |
|
} |
|
|
|
/** |
|
* Constructor. |
|
* 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 = []) |
|
{ |
|
if (!empty($config)) { |
|
Yii::configure($this, $config); |
|
} |
|
$this->init(); |
|
} |
|
|
|
/** |
|
* Initializes the object. |
|
* This method is invoked at the end of the constructor after the object is initialized with the |
|
* given configuration. |
|
*/ |
|
public function init() |
|
{ |
|
} |
|
|
|
/** |
|
* Returns the value of an object property. |
|
* |
|
* 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 |
|
* @throws UnknownPropertyException if the property is not defined |
|
* @throws InvalidCallException if the property is write-only |
|
* @see __set() |
|
*/ |
|
public function __get($name) |
|
{ |
|
$getter = 'get' . $name; |
|
if (method_exists($this, $getter)) { |
|
return $this->$getter(); |
|
} elseif (method_exists($this, 'set' . $name)) { |
|
throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name); |
|
} else { |
|
throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name); |
|
} |
|
} |
|
|
|
/** |
|
* Sets value of an object property. |
|
* |
|
* 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 |
|
* @throws UnknownPropertyException if the property is not defined |
|
* @throws InvalidCallException if the property is read-only |
|
* @see __get() |
|
*/ |
|
public function __set($name, $value) |
|
{ |
|
$setter = 'set' . $name; |
|
if (method_exists($this, $setter)) { |
|
$this->$setter($value); |
|
} elseif (method_exists($this, 'get' . $name)) { |
|
throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name); |
|
} else { |
|
throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name); |
|
} |
|
} |
|
|
|
/** |
|
* Checks if a property is set, i.e. defined and 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). |
|
* @see http://php.net/manual/en/function.isset.php |
|
*/ |
|
public function __isset($name) |
|
{ |
|
$getter = 'get' . $name; |
|
if (method_exists($this, $getter)) { |
|
return $this->$getter() !== null; |
|
} else { |
|
return false; |
|
} |
|
} |
|
|
|
/** |
|
* Sets an object property to null. |
|
* |
|
* 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 |
|
* @throws InvalidCallException if the property is read only. |
|
* @see http://php.net/manual/en/function.unset.php |
|
*/ |
|
public function __unset($name) |
|
{ |
|
$setter = 'set' . $name; |
|
if (method_exists($this, $setter)) { |
|
$this->$setter(null); |
|
} elseif (method_exists($this, 'get' . $name)) { |
|
throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name); |
|
} |
|
} |
|
|
|
/** |
|
* Calls the named method which is not a class method. |
|
* |
|
* 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 |
|
* @throws UnknownMethodException when calling unknown method |
|
* @return mixed the method return value |
|
*/ |
|
public function __call($name, $params) |
|
{ |
|
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()"); |
|
} |
|
|
|
/** |
|
* Returns a value indicating whether a property is defined. |
|
* 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 `$checkVars` is true); |
|
* |
|
* @param string $name the property name |
|
* @param boolean $checkVars whether to treat member variables as properties |
|
* @return boolean whether the property is defined |
|
* @see canGetProperty() |
|
* @see canSetProperty() |
|
*/ |
|
public function hasProperty($name, $checkVars = true) |
|
{ |
|
return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false); |
|
} |
|
|
|
/** |
|
* Returns a value indicating whether a property can be read. |
|
* 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 `$checkVars` is true); |
|
* |
|
* @param string $name the property name |
|
* @param boolean $checkVars whether to treat member variables as properties |
|
* @return boolean whether the property can be read |
|
* @see canSetProperty() |
|
*/ |
|
public function canGetProperty($name, $checkVars = true) |
|
{ |
|
return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name); |
|
} |
|
|
|
/** |
|
* Returns a value indicating whether a property can be set. |
|
* 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 `$checkVars` is true); |
|
* |
|
* @param string $name the property name |
|
* @param boolean $checkVars whether to treat member variables as properties |
|
* @return boolean whether the property can be written |
|
* @see canGetProperty() |
|
*/ |
|
public function canSetProperty($name, $checkVars = true) |
|
{ |
|
return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name); |
|
} |
|
|
|
/** |
|
* Returns a value indicating whether a method is defined. |
|
* |
|
* The default implementation is a call to php function `method_exists()`. |
|
* You may override this method when you implemented the php magic method `__call()`. |
|
* @param string $name the method name |
|
* @return boolean whether the method is defined |
|
*/ |
|
public function hasMethod($name) |
|
{ |
|
return method_exists($this, $name); |
|
} |
|
}
|
|
|