FileDependency
API reference › yii › caching › FileDependency
FileDependency represents a dependency based on a file’s last modification time.
If the last modification time of the file specified via $fileName is changed,
the dependency is considered as changed.
For more details and usage information on Cache, see the guide article on caching.
Properties
Section titled “Properties”| Property | Type | Description | Defined by |
|---|---|---|---|
$data | mixed | The dependency data that is saved in cache and later is compared with the latest dependency data. Default: null. | Dependency |
$fileName | string | The file path or path alias whose last modification time is used to check if the dependency has been changed. Default: null. | FileDependency |
$reusable | bool | Whether this dependency is reusable or not. Default: false. | Dependency |
Methods
Section titled “Methods”| Method | Description | Defined by |
|---|---|---|
__construct() | Constructor. | yii\ |
__call() | Calls the named method which is not a class method. | yii\ |
__get() | Returns the value of an object property. | yii\ |
__isset() | Checks if a property is set, i.e. defined and not null. | yii\ |
__set() | Sets value of an object property. | yii\ |
__unset() | Sets an object property to null. | yii\ |
canGetProperty() | Returns a value indicating whether a property can be read. | yii\ |
canSetProperty() | Returns a value indicating whether a property can be set. | yii\ |
className() static | Returns the fully qualified name of this class. | yii\ |
evaluateDependency() | Evaluates the dependency by generating and saving the data related with dependency. | Dependency |
hasMethod() | Returns a value indicating whether a method is defined. | yii\ |
hasProperty() | Returns a value indicating whether a property is defined. | yii\ |
init() | Initializes the object. | yii\ |
isChanged() | Checks whether the dependency is changed. | Dependency |
resetReusableData() static | Resets all cached data for reusable dependencies. | Dependency |
generateDependencyData() protected | Generates the data needed to determine if dependency has been changed. | FileDependency |
generateReusableHash() protected | Generates a unique hash that can be used for retrieving reusable dependency data. | Dependency |
Method details
Section titled “Method details”generateDependencyData()
Section titled “generateDependencyData() ”protected function generateDependencyData(yii\caching\CacheInterface $cache): mixedGenerates the data needed to determine if dependency has been changed.
This method returns the file’s last modification time.
Parameters
| Parameter | Type | Description |
|---|---|---|
$cache | CacheInterface | The cache component that is currently evaluating this dependency |
Returns
mixed: The data needed to determine if dependency has been changed.
Throws
yii\base\InvalidConfigException: if$fileNameis not set