From 76f5de3d0fb3962e20a91d175ec13d9fa06957da Mon Sep 17 00:00:00 2001
From: Bocki <henning@bocklage.com>
Date: Tue, 22 Mar 2022 21:33:29 +0100
Subject: [Documentation] Move all wiki pages into the repo and make it pretty
 (#2494)

---
 docs/07_Cache_API/02_CacheInterface.md | 73 ++++++++++++++++++++++++++++++++++
 1 file changed, 73 insertions(+)
 create mode 100644 docs/07_Cache_API/02_CacheInterface.md

(limited to 'docs/07_Cache_API/02_CacheInterface.md')

diff --git a/docs/07_Cache_API/02_CacheInterface.md b/docs/07_Cache_API/02_CacheInterface.md
new file mode 100644
index 00000000..609925a2
--- /dev/null
+++ b/docs/07_Cache_API/02_CacheInterface.md
@@ -0,0 +1,73 @@
+The `CacheInterface` interface defines functions that need to be implemented. To create a new cache that implements `CacheInterface` you must implement following functions:
+
+* [loadData](#the-loaddata-function)
+* [saveData](#the-savedata-function)
+* [getTime](#the-gettime-function)
+* [purgeCache](#the-purgecache-function)
+
+Find a [template](#template) at the end of this file.
+
+# Functions
+
+## The `loadData` function
+
+This function loads data from the cache and returns the data in the same format provided to the [saveData](#the-savedata-function) function.
+
+```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
+
+This function returns the last write time for the cache, or `false` if the cache does not yet exist. Please notice that 'cache' refers to one specific item in the cache repository and might require additional data to identify a specific item (introduce custom functions where necessary!).
+
+```PHP
+getTime(): int, false
+```
+
+## 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!
+    }
+}
+// Imaginary empty line!
+```
\ No newline at end of file
-- 
cgit v1.2.3