0 follower

CGlobalStateCacheDependency

Package	system.caching.dependencies
Inheritance	class CGlobalStateCacheDependency » CCacheDependency » CComponent
Implements	ICacheDependency
Since	1.0
Source Code	framework/caching/dependencies/CGlobalStateCacheDependency.php

CGlobalStateCacheDependency represents a dependency based on a global state value.

CGlobalStateCacheDependency checks if a global state is changed or not. If the global state is changed, the dependency is reported as changed. To specify which global state this dependency should check with, set stateName to the name of the global state.

Public Properties

Hide inherited 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
stateName	string	the name of the global state whose value is to check if the dependency has changed.	CGlobalStateCacheDependency

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	CComponent
__construct()	Constructor.	CGlobalStateCacheDependency
__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

Hide inherited methods

Method	Description	Defined By
generateDependentData()	Generates the data needed to determine if dependency has been changed.	CGlobalStateCacheDependency

Property Details

stateName property

public string $stateName;

the name of the global state whose value is to check if the dependency has changed.

Method Details

__construct() method

public void __construct(string $name=NULL)
$name	string	the name of the global state

Source Code: framework/caching/dependencies/CGlobalStateCacheDependency.php#36 (show)


public function __construct($name=null)
{
    $this->stateName=$name;
}

Constructor.

generateDependentData() method

protected mixed generateDependentData()
{return}	mixed	the data needed to determine if dependency has been changed.

Source Code: framework/caching/dependencies/CGlobalStateCacheDependency.php#47 (show)


protected function generateDependentData()
{
    if($this->stateName!==null)
        return Yii::app()->getGlobalState($this->stateName);
    else
        throw new CException(Yii::t('yii','CGlobalStateCacheDependency.stateName cannot be empty.'));
}

Generates the data needed to determine if dependency has been changed. This method returns the value of the global state.