CChainedCacheDependency
| Package | system.caching.dependencies |
|---|---|
| Inheritance | class CChainedCacheDependency » CComponent |
| Implements | ICacheDependency |
| Since | 1.0 |
| Source Code | framework/caching/dependencies/CChainedCacheDependency.php |
CChainedCacheDependency represents a list of cache dependencies.
If any of the dependencies reports a dependency change, CChainedCacheDependency will return true for the checking.
To add dependencies to CChainedCacheDependency, use Dependencies which gives a CTypedList instance and can be used like an array (see CList for more details}).
If any of the dependencies reports a dependency change, CChainedCacheDependency will return true for the checking.
To add dependencies to CChainedCacheDependency, use Dependencies which gives a CTypedList instance and can be used like an array (see CList for more details}).
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| dependencies | CTypedList | list of dependency objects | CChainedCacheDependency |
| hasChanged | boolean | Performs the actual dependency checking. | CChainedCacheDependency |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | CComponent |
| __construct() | Constructor. | CChainedCacheDependency |
| __get() | Returns a property value, an event handler list or a behavior based on its name. | CComponent |
| __isset() | Checks if a property value is null. | CComponent |
| __set() | Sets value of a component property. | CComponent |
| __unset() | Sets a component property to be null. | CComponent |
| asa() | Returns the named behavior object. | CComponent |
| attachBehavior() | Attaches a behavior to this component. | CComponent |
| attachBehaviors() | Attaches a list of behaviors to the component. | CComponent |
| attachEventHandler() | Attaches an event handler to an event. | CComponent |
| canGetProperty() | Determines whether a property can be read. | CComponent |
| canSetProperty() | Determines whether a property can be set. | CComponent |
| detachBehavior() | Detaches a behavior from the component. | CComponent |
| detachBehaviors() | Detaches all behaviors from the component. | CComponent |
| detachEventHandler() | Detaches an existing event handler. | CComponent |
| disableBehavior() | Disables an attached behavior. | CComponent |
| disableBehaviors() | Disables all behaviors attached to this component. | CComponent |
| enableBehavior() | Enables an attached behavior. | CComponent |
| enableBehaviors() | Enables all behaviors attached to this component. | CComponent |
| evaluateDependency() | Evaluates the dependency by generating and saving the data related with dependency. | CChainedCacheDependency |
| evaluateExpression() | Evaluates a PHP expression or callback under the context of this component. | CComponent |
| getDependencies() | Returns list of dependency objects | CChainedCacheDependency |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getHasChanged() | Performs the actual dependency checking. | CChainedCacheDependency |
| hasEvent() | Determines whether an event is defined. | CComponent |
| hasEventHandler() | Checks whether the named event has attached handlers. | CComponent |
| hasProperty() | Determines whether a property is defined. | CComponent |
| raiseEvent() | Raises an event. | CComponent |
| setDependencies() | Sets list of dependency objects or configurations to be added to this chain. If a dependency is specified as a configuration, it must be an array that can be recognized by YiiBase::createComponent. | CChainedCacheDependency |
Property Details
dependencies property
public CTypedList getDependencies()
public void setDependencies(array $values)
list of dependency objects
hasChanged property read-only
public boolean getHasChanged()
Performs the actual dependency checking. This method returns true if any of the dependency objects reports a dependency change.
Method Details
__construct() method (available since v1.1.4)
public void __construct(array $dependencies=array ( )) | ||
| $dependencies | array | the dependencies to be added to this chain. |
Source Code: framework/caching/dependencies/CChainedCacheDependency.php#37 (show)
public function __construct($dependencies=array())
{
if(!empty($dependencies))
$this->setDependencies($dependencies);
}
Constructor.
evaluateDependency() method
public void evaluateDependency() |
Source Code: framework/caching/dependencies/CChainedCacheDependency.php#72 (show)
public function evaluateDependency()
{
if($this->_dependencies!==null)
{
foreach($this->_dependencies as $dependency)
$dependency->evaluateDependency();
}
}
Evaluates the dependency by generating and saving the data related with dependency.
getDependencies() method
public CTypedList getDependencies() | ||
| {return} | CTypedList | list of dependency objects |
Source Code: framework/caching/dependencies/CChainedCacheDependency.php#46 (show)
public function getDependencies()
{
if($this->_dependencies===null)
$this->_dependencies=new CTypedList('ICacheDependency');
return $this->_dependencies;
}
getHasChanged() method
public boolean getHasChanged() | ||
| {return} | boolean | whether the dependency is changed or not. |
Source Code: framework/caching/dependencies/CChainedCacheDependency.php#87 (show)
public function getHasChanged()
{
if($this->_dependencies!==null)
{
foreach($this->_dependencies as $dependency)
if($dependency->getHasChanged())
return true;
}
return false;
}
Performs the actual dependency checking. This method returns true if any of the dependency objects reports a dependency change.
setDependencies() method
public void setDependencies(array $values) | ||
| $values | array | list of dependency objects or configurations to be added to this chain. If a dependency is specified as a configuration, it must be an array that can be recognized by YiiBase::createComponent. |
Source Code: framework/caching/dependencies/CChainedCacheDependency.php#58 (show)
public function setDependencies($values)
{
$dependencies=$this->getDependencies();
foreach($values as $value)
{
if(is_array($value))
$value=Yii::createComponent($value);
$dependencies->add($value);
}
}
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CChainedCacheDependency