WordPress 3.4
[autoinstalls/wordpress.git] / wp-includes / cache.php
index f285be3a9093da1e0d9d70ccba0264eca613c00e..bb61249cfb3d2470572911b68d920abd77dcad2e 100644 (file)
@@ -51,7 +51,7 @@ function wp_cache_close() {
  * @see WP_Object_Cache::decr()
  *
  * @param int|string $key The cache key to increment
- * @param int $offset The amount by which to decrement the item's value.  Default is 1.
+ * @param int $offset The amount by which to decrement the item's value. Default is 1.
  * @param string $group The group the key is in.
  * @return false|int False on failure, the item's new value on success.
  */
@@ -103,13 +103,14 @@ function wp_cache_flush() {
  * @param int|string $key What the contents in the cache are called
  * @param string $group Where the cache contents are grouped
  * @param bool $force Whether to force an update of the local cache from the persistent cache (default is false)
+ * @param &bool $found Whether key was found in the cache. Disambiguates a return of false, a storable value.
  * @return bool|mixed False on failure to retrieve contents or the cache
  *             contents on success
  */
-function wp_cache_get( $key, $group = '', $force = false ) {
+function wp_cache_get( $key, $group = '', $force = false, &$found = null ) {
        global $wp_object_cache;
 
-       return $wp_object_cache->get( $key, $group, $force );
+       return $wp_object_cache->get( $key, $group, $force, $found );
 }
 
 /**
@@ -120,7 +121,7 @@ function wp_cache_get( $key, $group = '', $force = false ) {
  * @see WP_Object_Cache::incr()
  *
  * @param int|string $key The cache key to increment
- * @param int $offset The amount by which to increment the item's value.  Default is 1.
+ * @param int $offset The amount by which to increment the item's value. Default is 1.
  * @param string $group The group the key is in.
  * @return false|int False on failure, the item's new value on success.
  */
@@ -204,7 +205,7 @@ function wp_cache_add_non_persistent_groups( $groups ) {
 }
 
 /**
- * Reset internal cache keys and structures.  If the cache backend uses global blog or site IDs as part of its cache keys,
+ * Reset internal cache keys and structures. If the cache backend uses global blog or site IDs as part of its cache keys,
  * this function instructs the backend to reset those keys and perform any cleanup since blog or site IDs have changed since cache init.
  *
  * @since 2.6.0
@@ -272,7 +273,7 @@ class WP_Object_Cache {
        /**
         * Adds data to the cache if it doesn't already exist.
         *
-        * @uses WP_Object_Cache::get Checks to see if the cache already has data.
+        * @uses WP_Object_Cache::_exists Checks to see if the cache already has data.
         * @uses WP_Object_Cache::set Sets the data after the checking the cache
         *              contents existence.
         *
@@ -288,10 +289,10 @@ class WP_Object_Cache {
                if ( wp_suspend_cache_addition() )
                        return false;
 
-               if ( empty ($group) )
+               if ( empty( $group ) )
                        $group = 'default';
 
-               if (false !== $this->get($key, $group))
+               if ( $this->_exists($key, $group) )
                        return false;
 
                return $this->set($key, $data, $group, $expire);
@@ -317,12 +318,12 @@ class WP_Object_Cache {
         * @since 3.3.0
         *
         * @param int|string $key The cache key to increment
-        * @param int $offset The amount by which to decrement the item's value.  Default is 1.
+        * @param int $offset The amount by which to decrement the item's value. Default is 1.
         * @param string $group The group the key is in.
         * @return false|int False on failure, the item's new value on success.
         */
        function decr( $key, $offset = 1, $group = 'default' ) {
-               if ( ! isset( $this->cache[ $group ][ $key ] ) )
+               if ( ! $this->_exists( $key, $group ) )
                        return false;
 
                if ( ! is_numeric( $this->cache[ $group ][ $key ] ) )
@@ -354,13 +355,13 @@ class WP_Object_Cache {
         * @return bool False if the contents weren't deleted and true on success
         */
        function delete($key, $group = 'default', $force = false) {
-               if (empty ($group))
+               if ( empty( $group ) )
                        $group = 'default';
 
-               if (!$force && false === $this->get($key, $group))
+               if ( ! $force && ! $this->_exists( $key, $group ) )
                        return false;
 
-               unset ($this->cache[$group][$key]);
+               unset( $this->cache[$group][$key] );
                return true;
        }
 
@@ -394,11 +395,12 @@ class WP_Object_Cache {
         * @return bool|mixed False on failure to retrieve contents or the cache
         *              contents on success
         */
-       function get( $key, $group = 'default', $force = false) {
-               if ( empty ($group) )
+       function get( $key, $group = 'default', $force = false, &$found = null ) {
+               if ( empty( $group ) )
                        $group = 'default';
 
-               if ( isset ($this->cache[$group][$key]) ) {
+               if ( $this->_exists( $key, $group ) ) {
+                       $found = true;
                        $this->cache_hits += 1;
                        if ( is_object($this->cache[$group][$key]) )
                                return clone $this->cache[$group][$key];
@@ -406,6 +408,7 @@ class WP_Object_Cache {
                                return $this->cache[$group][$key];
                }
 
+               $found = false;
                $this->cache_misses += 1;
                return false;
        }
@@ -416,12 +419,15 @@ class WP_Object_Cache {
         * @since 3.3.0
         *
         * @param int|string $key The cache key to increment
-        * @param int $offset The amount by which to increment the item's value.  Default is 1.
+        * @param int $offset The amount by which to increment the item's value. Default is 1.
         * @param string $group The group the key is in.
         * @return false|int False on failure, the item's new value on success.
         */
        function incr( $key, $offset = 1, $group = 'default' ) {
-               if ( ! isset( $this->cache[ $group ][ $key ] ) )
+               if ( empty( $group ) )
+                       $group = 'default';
+
+               if ( ! $this->_exists( $key, $group ) )
                        return false;
 
                if ( ! is_numeric( $this->cache[ $group ][ $key ] ) )
@@ -450,10 +456,10 @@ class WP_Object_Cache {
         * @return bool False if not exists, true if contents were replaced
         */
        function replace($key, $data, $group = 'default', $expire = '') {
-               if (empty ($group))
+               if ( empty( $group ) )
                        $group = 'default';
 
-               if ( false === $this->get($key, $group) )
+               if ( ! $this->_exists( $key, $group ) )
                        return false;
 
                return $this->set($key, $data, $group, $expire);
@@ -493,12 +499,9 @@ class WP_Object_Cache {
         * @return bool Always returns true
         */
        function set($key, $data, $group = 'default', $expire = '') {
-               if ( empty ($group) )
+               if ( empty( $group ) )
                        $group = 'default';
 
-               if ( NULL === $data )
-                       $data = '';
-
                if ( is_object($data) )
                        $data = clone $data;
 
@@ -526,6 +529,14 @@ class WP_Object_Cache {
                echo '</ul>';
        }
 
+       /**
+        * Utility function to determine whether a key exists in the cache.
+        * @access private
+        */
+       protected function _exists($key, $group) {
+               return isset( $this->cache[$group] ) && is_array( $this->cache[$group] ) && array_key_exists( $key, $this->cache[$group] );
+       }
+
        /**
         * Sets up object properties; PHP 5 style constructor
         *
@@ -553,4 +564,3 @@ class WP_Object_Cache {
                return true;
        }
 }
-?>