chore: Run CS Fixer

Author: usernane

webfiori/framework/cache/Cache.php

@@ -15,83 +15,106 @@
  */
 class Cache {
     /**
-     * 
+     *
      * @var Storage
      */
     private $driver;
     private static $inst;
     /**
-     * Creates and returns a single instance of the class.
-     * 
-     * @return Cache
+     * Removes an item from the cache given its unique identifier.
+     *
+     * @param string $key
      */
-    private static function getInst() : Cache {
-        if (self::$inst === null) {
-            self::$inst = new Cache();
-            self::setDriver(new FileStorage());
-        }
-        return self::$inst;
+    public static function delete(string $key) {
+        self::getDriver()->delete($key);
     }
     /**
-     * Sets storage engine which is used to store, read, update and delete items
-     * from the cache.
-     * 
-     * @param Storage $driver 
+     * Removes all items from the cache.
      */
-    public static function setDriver(Storage $driver) {
-        self::getInst()->driver = $driver;
+    public static function flush() {
+        self::getDriver()->flush();
+    }
+    /**
+     * Returns or creates a cache item given its key.
+     *
+     *
+     * @param string $key The unique identifier of the item.
+     *
+     * @param callable $generator A callback which is used as a fallback to
+     * create new cache entry or re-create an existing one if it was expired.
+     * This callback must return the data that will be cached.
+     *
+     * @param int $ttl Time to live of the item in seconds.
+     *
+     * @param array $params Any additional parameters to be passed to the callback
+     * which is used to generate cache data.
+     * @return null
+     */
+    public static function get(string $key, callable $generator = null, int $ttl = 60, array $params = []) {
+        $data = self::getDriver()->read($key);
+
+        if ($data !== null && $data !== false) {
+            return $data;
+        }
+
+        if (!is_callable($generator)) {
+            return null;
+        }
+        $newData = call_user_func_array($generator, $params);
+        $item = new Item($key, $newData, $ttl, defined('CACHE_SECRET') ? CACHE_SECRET : '');
+        self::getDriver()->cache($item);
+
+        return $newData;
     }
     /**
      * Returns storage engine which is used to store, read, update and delete items
      * from the cache.
-     * 
+     *
      * @return Storage
      */
     public static function getDriver() : Storage {
         return self::getInst()->driver;
     }
     /**
-     * Removes an item from the cache given its unique identifier.
-     * 
-     * @param string $key
+     * Reads an item from the cache and return its information.
+     *
+     * @param string $key The unique identifier of the item.
+     *
+     * @return Item|null If such item exist and not yet expired, an object
+     * of type 'Item' is returned which has all cached item information. Other
+     * than that, null is returned.
      */
-    public static function delete(string $key) {
-        self::getDriver()->delete($key);
+    public static function getItem(string $key) {
+        return self::getDriver()->readItem($key);
     }
     /**
      * Checks if the cache has in item given its unique identifier.
-     * 
+     *
      * @param string $key
-     * 
+     *
      * @return bool If the item exist and is not yet expired, true is returned.
      * Other than that, false is returned.
      */
     public static function has(string $key) : bool {
         return self::getDriver()->has($key);
     }
-    /**
-     * Removes all items from the cache.
-     */
-    public static function flush() {
-        self::getDriver()->flush();
-    }
     /**
      * Creates new item in the cache.
-     * 
+     *
      * Note that the item will only be added if it does not exist or already
      * expired or the override option is set to true in case it was already
      * created and not expired.
-     * 
+     *
      * @param string $key The unique identifier of the item.
-     * 
+     *
      * @param mixed $data The data that will be cached.
-     * 
+     *
      * @param int $ttl The time at which the data will be kept in the cache (in seconds).
-     * 
+     *
      * @param bool $override If cache item already exist which has given key and not yet
      * expired and this one is set to true, the existing item will be overridden by
      * provided data and ttl.
-     * 
+     *
      * @return bool If successfully added, the method will return true. False
      * otherwise.
      */
@@ -100,68 +123,50 @@ public static function set(string $key, $data, int $ttl = 60, bool $override = f
             $item = new Item($key, $data, $ttl, defined('CACHE_SECRET') ? CACHE_SECRET : '');
             self::getDriver()->cache($item);
         }
+
         return false;
     }
     /**
-     * Reads an item from the cache and return its information.
-     * 
-     * @param string $key The unique identifier of the item.
-     * 
-     * @return Item|null If such item exist and not yet expired, an object
-     * of type 'Item' is returned which has all cached item information. Other
-     * than that, null is returned.
+     * Sets storage engine which is used to store, read, update and delete items
+     * from the cache.
+     *
+     * @param Storage $driver
      */
-    public static function getItem(string $key) {
-        return self::getDriver()->readItem($key);
+    public static function setDriver(Storage $driver) {
+        self::getInst()->driver = $driver;
     }
     /**
      * Updates TTL of specific cache item.
-     * 
+     *
      * @param string $key The unique identifier of the item.
-     * 
+     *
      * @param int $ttl The new value for TTL.
-     * 
+     *
      * @return bool If item is updated, true is returned. Other than that, false
      * is returned.
      */
     public static function setTTL(string $key, int $ttl) {
         $item = self::getItem($key);
+
         if ($item === null) {
             return false;
         }
         $item->setTTL($ttl);
         self::getDriver()->cache($item);
+
         return true;
     }
     /**
-     * Returns or creates a cache item given its key.
-     * 
-     * 
-     * @param string $key The unique identifier of the item.
-     * 
-     * @param callable $generator A callback which is used as a fallback to
-     * create new cache entry or re-create an existing one if it was expired.
-     * This callback must return the data that will be cached.
-     * 
-     * @param int $ttl Time to live of the item in seconds.
-     * 
-     * @param array $params Any additional parameters to be passed to the callback
-     * which is used to generate cache data.
-     * @return null
+     * Creates and returns a single instance of the class.
+     *
+     * @return Cache
      */
-    public static function get(string $key, callable $generator = null, int $ttl = 60, array $params = []) {
-        $data = self::getDriver()->read($key);
-        
-        if ($data !== null && $data !== false) {
-            return $data;
+    private static function getInst() : Cache {
+        if (self::$inst === null) {
+            self::$inst = new Cache();
+            self::setDriver(new FileStorage());
         }
 
-        if (!is_callable($generator)) {
-            return null;
-        }
-        $newData = call_user_func_array($generator, $params);
-        $item = new Item($key, $newData, $ttl, defined('CACHE_SECRET') ? CACHE_SECRET : '');
-        self::getDriver()->cache($item);
-        return $newData;
+        return self::$inst;
     }
 }