byjg / cache-engine-php

src/FileSystemCacheEngine.php

Doc Comments +4 added lines, -2 removed lines

@@ -118,9 +118,8 @@ 
 
     /**
      * @param string $key The object Key
-     * @param object $object The object to be cached
      * @param int $ttl The time to live in seconds of this objects
-     * @return bool If the object is successfully posted
+     * @return boolean|null If the object is successfully posted
      */
     public function append($key, $content, $ttl = 0)
     {
@@ -175,6 +174,9 @@ 
         }
     }
 
+    /**
+     * @param string $key
+     */
     protected function fixKey($key)
     {
         return sys_get_temp_dir() . '/'

src/SessionCacheEngine.php

Doc Comments +3 added lines

@@ -12,6 +12,9 @@
         }
     }
 
+    /**
+     * @param string $key
+     */
     protected function keyName($key)
     {
         return (isset($this->configKey) ? $this->configKey : "default") . '-' . $key;

src/ShmopCacheEngine.php

Doc Comments +13 added lines, -4 removed lines

@@ -37,18 +37,27 @@ 
         return $this->config;
     }
 
+    /**
+     * @return integer
+     */
     protected function getMaxSize()
     {
         $config = $this->getConfig();
         return isset($config['max-size']) ? $config['max-size'] : 524288;
     }
 
+    /**
+     * @return integer
+     */
     protected function getDefaultPermission()
     {
         $config = $this->getConfig();
         return isset($config['default-permission']) ? $config['default-permission'] : '0700';
     }
 
+    /**
+     * @param string $key
+     */
     protected function getKeyId($key)
     {
         $file = $this->getFTok($key);
@@ -61,7 +70,7 @@ 
     /**
      * @param string $key The object KEY
      * @param int $ttl The time to live in seconds of the object. Depends on implementation.
-     * @return object The Object
+     * @return string The Object
      */
     public function get($key, $ttl = 0)
     {
@@ -116,9 +125,9 @@ 
 
     /**
      * @param string $key The object Key
-     * @param object $object The object to be cached
+     * @param string $object The object to be cached
      * @param int $ttl The time to live in seconds of the object. Depends on implementation.
-     * @return bool If the object is successfully posted
+     * @return boolean|null If the object is successfully posted
      * @throws \Exception
      */
     public function set($key, $object, $ttl = 0)
@@ -160,7 +169,7 @@ 
      *
      * @param string $key
      * @param string $str
-     * @return bool
+     * @return boolean|null
      */
     public function append($key, $str)
     {

example-psr.php

Spacing +1 added lines, -1 removed lines

@@ -25,7 +25,7 @@
 
 print_r($_SESSION);
 
-for ($i=0; $i<4; $i++) {
+for ($i = 0; $i < 4; $i++) {
     $item = $pool->getItem('key' . $i);
     $item->set('value - ' . $i);
     $pool->saveDeferred($item);