XOOPS / XoopsCore25

htdocs/class/cache/xoopscache.php

Doc Comments +7 added lines, -7 removed lines

@@ -79,7 +79,7 @@ 
      * Tries to find and include a file for a cache engine and returns object instance
      *
      * @param  $name Name of the engine
-     * @return mixed $engine object or null
+     * @return boolean $engine object or null
      * @access private
      */
     private function loadEngine($name)
@@ -206,7 +206,7 @@ 
      *
      * @param  string $key       Identifier for the data
      * @param  mixed  $value     Data to be cached - anything except a resource
-     * @param  mixed  $duration  Optional - string configuration name OR how long to cache the data, either in seconds or a
+     * @param  string  $duration  Optional - string configuration name OR how long to cache the data, either in seconds or a
      *                           string that can be parsed by the strtotime() function OR array('config' => 'default', 'duration' => '3600')
      * @return boolean True if the data was successfully cached, false on failure
      * @access public
@@ -384,7 +384,7 @@ 
      * generates a safe key
      *
      * @param  string $key the key passed over
-     * @return mixed  string $key or false
+     * @return false|string  string $key or false
      * @access private
      */
     public function key($key)
@@ -449,7 +449,7 @@ 
      * @param  string $key      Identifier for the data
      * @param  mixed  $value    Data to be cached
      * @param  mixed  $duration How long to cache the data, in seconds
-     * @return boolean True if the data was successfully cached, false on failure
+     * @return boolean|null True if the data was successfully cached, false on failure
      * @access public
      */
     public function write($key, $value, $duration = null)
@@ -473,7 +473,7 @@ 
      * Delete a key from the cache
      *
      * @param  string $key Identifier for the data
-     * @return boolean True if the value was successfully deleted, false if it didn't exist or couldn't be removed
+     * @return boolean|null True if the value was successfully deleted, false if it didn't exist or couldn't be removed
      * @access public
      */
     public function delete($key)
@@ -484,7 +484,7 @@ 
      * Delete all keys from the cache
      *
      * @param  boolean $check if true will check expiration, otherwise delete all
-     * @return boolean True if the cache was successfully cleared, false otherwise
+     * @return boolean|null True if the cache was successfully cleared, false otherwise
      * @access public
      */
     public function clear($check)
@@ -494,7 +494,7 @@ 
     /**
      * Cache Engine settings
      *
-     * @return array settings
+     * @return integer settings
      * @access public
      */
     public function settings()