CFileCacheDependency
| Package | system.caching.dependencies |
|---|---|
| Inheritance | class CFileCacheDependency » CCacheDependency » CComponent |
| Implements | ICacheDependency |
| Since | 1.0 |
| Source Code | framework/caching/dependencies/CFileCacheDependency.php |
CFileCacheDependency represents a dependency based on a file's last modification time.
CFileCacheDependency performs dependency checking based on the last modification time of the file specified via fileName. The dependency is reported as unchanged if and only if the file's last modification time remains unchanged.
CFileCacheDependency performs dependency checking based on the last modification time of the file specified via fileName. The dependency is reported as unchanged if and only if the file's last modification time remains unchanged.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| dependentData | mixed | the data used to determine if dependency has been changed. | CCacheDependency |
| fileName | string | the name of the file whose last modification time is used to check if the dependency has been changed. | CFileCacheDependency |
| 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 |
| __construct() | Constructor. | CFileCacheDependency |
| __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. | CFileCacheDependency |
Property Details
fileName property
public string $fileName;
the name of the file whose last modification time is used to check if the dependency has been changed.
Method Details
__construct() method
public void __construct(string $fileName=NULL) | ||
| $fileName | string | name of the file whose change is to be checked. |
Source Code: framework/caching/dependencies/CFileCacheDependency.php#35 (show)
public function __construct($fileName=null)
{
$this->fileName=$fileName;
}
Constructor.
generateDependentData() method
protected mixed generateDependentData() | ||
| {return} | mixed | the data needed to determine if dependency has been changed. |
Source Code: framework/caching/dependencies/CFileCacheDependency.php#46 (show)
protected function generateDependentData()
{
if($this->fileName!==null)
return @filemtime($this->fileName);
else
throw new CException(Yii::t('yii','CFileCacheDependency.fileName cannot be empty.'));
}
Generates the data needed to determine if dependency has been changed. This method returns the file's last modification time.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CFileCacheDependency