| extends | XoopsCacheEngine | 
|---|
File Storage engine for cache
| Methods | ||||||||
|---|---|---|---|---|---|---|---|---|
| 
					
	public
					
					
				 | init(array $settings = []): boolean
		Initialize the Cache Engine
	 Initialize the Cache Engine Called automatically by the cache frontend To reinitialize the settings call Cache::engine('EngineName', [optional] settings = array()); Parameters
 ReturnsTrue if the engine has been successfully initialized, false if not Overrides | # | ||||||
| 
					
	public
					
					
				 | gc(): boolean
		Garbage collection. Permanently remove all expired and deleted data
	 Garbage collection. Permanently remove all expired and deleted data ReturnsTrue if garbage collection was successful, false on failure Overrides | # | ||||||
| 
					
	public
					
					
				 | write(string $key, mixed $data = null, mixed $duration = null): boolean
		Write data for key into cache
	 Write data for key into cache Parameters
 ReturnsTrue if the data was successfully cached, false on failure Overrides | # | ||||||
| 
					
	public
					
					
				 | read(string $key): mixed
		Read a key from the cache
	 Read a key from the cache Parameters
 ReturnsThe cached data, or false if the data doesn't exist, has expired, or if there was an error fetching it Overrides | # | ||||||
| 
					
	public
					
					
				 | delete(string $key): boolean
		Delete a key from the cache
	 Delete a key from the cache Parameters
 ReturnsTrue if the value was successfully deleted, false if it didn't exist or couldn't be removed Overrides | # | ||||||
| 
					
	public
					
					
				 | clear(boolean $check = true): boolean
		Delete all values from the cache
	 Delete all values from the cache Parameters
 ReturnsTrue if the cache was successfully cleared, false otherwise Overrides | # | ||||||
| Methods inherited from XoopsCacheEngine | 
|---|
| settings() | 
| Properties | |||
|---|---|---|---|
| 
	public
					
					
				 | array | $settings = [] | # |