From caac7f572cf335e96ee99f8a3af7395df471baf8 Mon Sep 17 00:00:00 2001
From: Dag <me@dvikan.no>
Date: Thu, 6 Jul 2023 15:10:30 +0200
Subject: refacor: improve cache interface (#3492)

* fix: proper typehint on setScope

* refactor: type hint setKey()

* typehint
---
 docs/07_Cache_API/01_How_to_create_a_new_cache.md | 23 +-------
 docs/07_Cache_API/02_CacheInterface.md            | 71 ++++-------------------
 2 files changed, 12 insertions(+), 82 deletions(-)

(limited to 'docs/07_Cache_API')

diff --git a/docs/07_Cache_API/01_How_to_create_a_new_cache.md b/docs/07_Cache_API/01_How_to_create_a_new_cache.md
index fe171718..cfc30308 100644
--- a/docs/07_Cache_API/01_How_to_create_a_new_cache.md
+++ b/docs/07_Cache_API/01_How_to_create_a_new_cache.md
@@ -1,24 +1,3 @@
 Create a new file in the `caches/` folder (see [Folder structure](../04_For_Developers/03_Folder_structure.md)).
 
-The file must be named according to following specification:
-
-* It starts with the type
-* The file name must end with 'Cache'
-* The file type must be PHP, written in small letters (seriously!) ".php"
-
-**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](http://php.net/basic-syntax.instruction-separation).
-
-Example:
-
-```PHP
-<?PHP
-    // PHP code here
-// This line is empty (just imagine it!)
-```
\ No newline at end of file
+See `NullCache` and `SQLiteCache` for examples.
\ No newline at end of file
diff --git a/docs/07_Cache_API/02_CacheInterface.md b/docs/07_Cache_API/02_CacheInterface.md
index bc343ff1..61127a0d 100644
--- a/docs/07_Cache_API/02_CacheInterface.md
+++ b/docs/07_Cache_API/02_CacheInterface.md
@@ -1,67 +1,18 @@
-The `CacheInterface` interface defines functions that need to be implemented. To create a new cache that implements `CacheInterface` you must implement following functions:
+See `CacheInterface`.
 
-* [loadData](#the-loaddata-function)
-* [saveData](#the-savedata-function)
-* [getTime](#the-gettime-function)
-* [purgeCache](#the-purgecache-function)
+```php
+interface CacheInterface
+{
+    public function setScope(string $scope): void;
 
-Find a [template](#template) at the end of this file.
+    public function setKey(array $key): void;
 
-# Functions
+    public function loadData();
 
-## The `loadData` function
+    public function saveData($data): void;
 
-This function loads data from the cache and returns the data in the same format provided to the [saveData](#the-savedata-function) function.
+    public function getTime(): ?int;
 
-```PHP
-loadData(): mixed
-```
-
-## The `saveData` function
-
-This function stores the given data into the cache and returns the object instance.
-
-```PHP
-saveData(mixed $data): self
-```
-
-## The `getTime` function
-
-## The `purgeCache` function
-
-This 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.
-
-```PHP
-purgeCache(int $duration): null
-```
-
-# Template
-
-This is the bare minimum template for a new cache:
-
-```PHP
-<?php
-class MyTypeCache implements CacheInterface {
-    public function loadData(){
-        // Implement your algorithm here!
-        return null;
-    }
-
-    public function saveData($data){
-        // Implement your algorithm here!
-
-        return $this;
-    }
-
-    public function getTime(){
-        // Implement your algorithm here!
-
-        return false;
-    }
-
-    public function purgeCache($duration){
-        // Implement your algorithm here!
-    }
+    public function purgeCache(int $seconds): void;
 }
-// Imaginary empty line!
-```
+```
\ No newline at end of file
-- 
cgit v1.2.3