CCacheDependency
Package | system.caching.dependencies |
---|---|
Inheritance | class CCacheDependency » CComponent |
Implements | ICacheDependency |
Subclasses | CDbCacheDependency, CDirectoryCacheDependency, CExpressionDependency, CFileCacheDependency, CGlobalStateCacheDependency |
Since | 1.0 |
Source Code | framework/caching/dependencies/CCacheDependency.php |
CCacheDependency implements the ICacheDependency interface. Child classes should override its generateDependentData for actual dependency checking.
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
dependentData | mixed | the data used to determine if dependency has been changed. | CCacheDependency |
hasChanged | boolean | whether the dependency has changed. | CCacheDependency |
reuseDependentData | boolean | Whether this dependency is reusable or not. | CCacheDependency |
Public Methods
Method | Description | Defined By |
---|---|---|
__call() | Calls the named method which is not a class method. | CComponent |
__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. | CCacheDependency |
evaluateExpression() | Evaluates a PHP expression or callback under the context of this component. | CComponent |
getDependentData() | Returns the data used to determine if dependency has been changed. This data is available after evaluateDependency is called. | CCacheDependency |
getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
getHasChanged() | Returns whether the dependency has changed. | CCacheDependency |
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 |
resetReusableData() | Resets cached data for reusable dependencies. | CCacheDependency |
Protected Methods
Method | Description | Defined By |
---|---|---|
generateDependentData() | Generates the data needed to determine if dependency has been changed. | CCacheDependency |
Property Details
dependentData property read-only
public mixed getDependentData()
the data used to determine if dependency has been changed. This data is available after evaluateDependency is called.
hasChanged property read-only
public boolean getHasChanged()
whether the dependency has changed.
reuseDependentData property (available since v1.1.11)
public boolean $reuseDependentData;
Whether this dependency is reusable or not. If set to true, dependent data for this cache dependency will only be generated once per request. You can then use the same cache dependency for multiple separate cache calls on the same page without the overhead of re-evaluating the dependency each time. Defaults to false;
Method Details
evaluateDependency() method
public void evaluateDependency() |
public function evaluateDependency()
{
if ($this->reuseDependentData)
{
$hash=$this->getHash();
if(!isset(self::$_reusableData[$hash]['dependentData']))
self::$_reusableData[$hash]['dependentData']=$this->generateDependentData();
$this->_data=self::$_reusableData[$hash]['dependentData'];
}
else
$this->_data=$this->generateDependentData();
}
Evaluates the dependency by generating and saving the data related with dependency. This method is invoked by cache before writing data into it.
generateDependentData() method
protected mixed generateDependentData() | ||
{return} | mixed | the data needed to determine if dependency has been changed. |
protected function generateDependentData()
{
return null;
}
Generates the data needed to determine if dependency has been changed. Derived classes should override this method to generate actual dependent data.
getDependentData() method
public mixed getDependentData() | ||
{return} | mixed | the data used to determine if dependency has been changed. This data is available after evaluateDependency is called. |
public function getDependentData()
{
return $this->_data;
}
getHasChanged() method
public boolean getHasChanged() | ||
{return} | boolean | whether the dependency has changed. |
public function getHasChanged()
{
if ($this->reuseDependentData)
{
$hash=$this->getHash();
if(!isset(self::$_reusableData[$hash]['dependentData']))
self::$_reusableData[$hash]['dependentData']=$this->generateDependentData();
return self::$_reusableData[$hash]['dependentData']!=$this->_data;
}
else
return $this->generateDependentData()!=$this->_data;
}
resetReusableData() method (available since v1.1.14)
public static void resetReusableData() |
public static function resetReusableData()
{
self::$_reusableData=array();
}
Resets cached data for reusable dependencies.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CCacheDependency