djsmithme / Cache

Src/Cache/Cache.php

Doc Comments +6 added lines, -6 removed lines

@@ -24,7 +24,7 @@ 
      * Persists data in the cache, uniquely referenced by a key with an optional expiration TTL time.
      *
      * @param string                $key   The key of the item to store.
-     * @param mixed                 $value The value of the item to store, must be serializable.
+     * @param string                 $value The value of the item to store, must be serializable.
      * @param null|int|\DateInterval $ttl   Optional. The TTL value of this item. If no value is sent and
      *                                     the driver supports TTL then the library may set a default value
      *                                     for it or let the driver take care of that.
@@ -75,7 +75,7 @@ 
      * Fetches a value from the cache.
      *
      * @param string $key     The unique key of this item in the cache.
-     * @param mixed  $default Default value to return if the key does not exist.
+     * @param string  $default Default value to return if the key does not exist.
      *
      * @return mixed The value of the item from the cache, or $default in case of cache miss.
      *
@@ -113,7 +113,7 @@ 
     /**
      * Obtains multiple cache items by their unique keys.
      *
-     * @param \iterable $keys    A list of keys that can obtained in a single operation.
+     * @param string[] $keys    A list of keys that can obtained in a single operation.
      * @param mixed    $default Default value to return for keys that do not exist.
      *
      * @return \iterable A list of key => value pairs. Cache keys that do not exist or are stale will have $default as value.
@@ -139,7 +139,7 @@ 
      * Persists a set of key => value pairs in the cache, with an optional TTL.
      *
      * @param \iterable              $values A list of key => value pairs for a multiple-set operation.
-     * @param null|int|DateInterval $ttl    Optional. The TTL value of this item. If no value is sent and
+     * @param integer $ttl    Optional. The TTL value of this item. If no value is sent and
      *                                      the driver supports TTL then the library may set a default value
      *                                      for it or let the driver take care of that.
      *
@@ -168,7 +168,7 @@ 
     /**
      * Deletes multiple cache items in a single operation.
      *
-     * @param \iterable $keys A list of string-based keys to be deleted.
+     * @param string[] $keys A list of string-based keys to be deleted.
      *
      * @return bool True if the items were successfully removed. False if there was an error.
      *
@@ -205,7 +205,7 @@ 
     /**
      * Check that provided key is valid.
      *
-     * @param $key
+     * @param string $key
      * @throws InvalidArgumentException
      */
     private function _isValidKey($key){

Src/Cache/Storage/FileStorage.php

Spacing +20 added lines, -20 removed lines

@@ -38,13 +38,13 @@ 
      */
     public function __construct($file, DateInterval $ttl)
     {
-        if (!is_string($file)){
+        if (!is_string($file)) {
             throw new \Exception('Directory must be a valid string');
         }
 
         $this->fs = $file;
 
-        if(!@mkdir($this->fs, 0755) && !is_dir($this->fs)){
+        if (!@mkdir($this->fs, 0755) && !is_dir($this->fs)) {
             throw new \Exception('unable to create directory');
         }
 
@@ -68,9 +68,9 @@ 
 
         $cacheItem = $this->_createCacheItem($key, $value, $ttl);
 
-        \file_put_contents($cacheItem['file'],$cacheItem['data']);
+        \file_put_contents($cacheItem['file'], $cacheItem['data']);
 
-        if (!file_exists($cacheItem['file'])){
+        if (!file_exists($cacheItem['file'])) {
             return false;
         }
 
@@ -86,16 +86,16 @@ 
      * @return array
      * @throws \Exception
      */
-    private function _createCacheItem($key, $value, $ttl){
+    private function _createCacheItem($key, $value, $ttl) {
 
-        if (!is_string($key)){
+        if (!is_string($key)) {
             throw new \Exception('$key must be a valid string');
         }
 
-        $filename = implode('.',[$key,$this->ext]);
+        $filename = implode('.', [$key, $this->ext]);
 
         return [
-            'file' => $this->fs . DIRECTORY_SEPARATOR . $filename,
+            'file' => $this->fs.DIRECTORY_SEPARATOR.$filename,
             'data' => json_encode([$ttl, $value])
         ];
     }
@@ -112,12 +112,12 @@ 
      *
      * @return bool
      */
-    public function has($key){
+    public function has($key) {
 
-       $cacheFile = implode('.',[$key,$this->ext]);
-       $cacheLocation = $this->fs . DIRECTORY_SEPARATOR . $cacheFile;
+       $cacheFile = implode('.', [$key, $this->ext]);
+       $cacheLocation = $this->fs.DIRECTORY_SEPARATOR.$cacheFile;
 
-       if (!file_exists($cacheLocation)){
+       if (!file_exists($cacheLocation)) {
            return false;
        }
 
@@ -125,7 +125,7 @@ 
        $cacheData = json_decode($data, TRUE);
 
        //cache has expired
-       if ($cacheData[0] < time() ){
+       if ($cacheData[0] < time()) {
            \unlink($cacheLocation);
            return false;
        }
@@ -141,12 +141,12 @@ 
      * @return mixed The value of the item from the cache, or $default in case of cache miss.
      *
      */
-    public function get($key){
+    public function get($key) {
 
-        $cacheFile = implode('.',[$key,$this->ext]);
-        $cacheLocation = $this->fs . DIRECTORY_SEPARATOR . $cacheFile;
+        $cacheFile = implode('.', [$key, $this->ext]);
+        $cacheLocation = $this->fs.DIRECTORY_SEPARATOR.$cacheFile;
 
-        if ($this->has($key)){
+        if ($this->has($key)) {
             $data = \file_get_contents($cacheLocation);
             $cacheData = json_decode($data, TRUE);
             return $cacheData[1];
@@ -174,14 +174,14 @@ 
      *
      * @return bool True on success and false on failure.
      */
-    public function clear(){
-        if (is_dir( $this->fs )){
+    public function clear() {
+        if (is_dir($this->fs)) {
             array_map('unlink', glob("$this->fs/*.*"));
         }
 
         $data = glob("$this->fs/*.*");
 
-        if (!empty($data)){
+        if (!empty($data)) {
             return false;
         }