The CacheInterface interface defines functions that need to be implemented. To create a new cache that implements CacheInterface you must implement following functions:
Find a template at the end of this file.
-loadData functionThis function loads data from the cache and returns the data in the same format provided to the saveData function.
-loadData(): mixed
-saveData functionThis function stores the given data into the cache and returns the object instance.
-saveData(mixed $data): self
-getTime functionpurgeCache functionThis function removes any data from the cache that is not within the given duration. The duration is specified in seconds and defines the period between now and the oldest item to keep.
-purgeCache(int $duration): null
-This is the bare minimum template for a new cache:
-<?php
-class MyTypeCache implements CacheInterface {
- public function loadData(){
- // Implement your algorithm here!
- return null;
- }
+ See CacheInterface.
+interface CacheInterface
+{
+ public function setScope(string $scope): void;
- public function saveData($data){
- // Implement your algorithm here!
+ public function setKey(array $key): void;
- return $this;
- }
+ public function loadData();
- public function getTime(){
- // Implement your algorithm here!
+ public function saveData($data): void;
- return false;
- }
+ public function getTime(): ?int;
- public function purgeCache($duration){
- // Implement your algorithm here!
- }
+ public function purgeCache(int $seconds): void;
}
-// Imaginary empty line!
Create a new file in the caches/ folder (see Folder structure).
The file must be named according to following specification:
-Examples:
-| Type | -Filename | -
|---|---|
| File | -FileCache.php | -
| MySQL | -MySQLCache.php | -
The file must start with the PHP tags and end with an empty line. The closing tag ?> is omitted.
Example:
-<?PHP
- // PHP code here
-// This line is empty (just imagine it!)
-See NullCache and SQLiteCache for examples.