]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-includes/cache.php
Wordpress 3.3.1
[autoinstalls/wordpress.git] / wp-includes / cache.php
index 895c43161a0b607bacbe7c15991fb38a29aa7053..f285be3a9093da1e0d9d70ccba0264eca613c00e 100644 (file)
@@ -9,29 +9,29 @@
  */
 
 /**
- * Adds data to the cache, if the cache key doesn't aleady exist.
+ * Adds data to the cache, if the cache key doesn't already exist.
  *
  * @since 2.0.0
  * @uses $wp_object_cache Object Cache Class
  * @see WP_Object_Cache::add()
  *
- * @param int|string $key The cache ID to use for retrieval later
+ * @param int|string $key The cache key to use for retrieval later
  * @param mixed $data The data to add to the cache store
- * @param string $flag The group to add the cache to
+ * @param string $group The group to add the cache to
  * @param int $expire When the cache data should be expired
  * @return unknown
  */
-function wp_cache_add($key, $data, $flag = '', $expire = 0) {
+function wp_cache_add($key, $data, $group = '', $expire = 0) {
        global $wp_object_cache;
 
-       return $wp_object_cache->add($key, $data, $flag, $expire);
+       return $wp_object_cache->add($key, $data, $group, $expire);
 }
 
 /**
  * Closes the cache.
  *
  * This function has ceased to do anything since WordPress 2.5. The
- * functionality was removed along with the rest of the persistant cache. This
+ * functionality was removed along with the rest of the persistent cache. This
  * does not mean that plugins can't implement this function when they need to
  * make sure that the cache is cleaned up after WordPress no longer needs it.
  *
@@ -44,20 +44,38 @@ function wp_cache_close() {
 }
 
 /**
- * Removes the cache contents matching ID and flag.
+ * Decrement numeric cache item's value
+ *
+ * @since 3.3.0
+ * @uses $wp_object_cache Object Cache Class
+ * @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 string $group The group the key is in.
+ * @return false|int False on failure, the item's new value on success.
+ */
+function wp_cache_decr( $key, $offset = 1, $group = '' ) {
+       global $wp_object_cache;
+
+       return $wp_object_cache->decr( $key, $offset, $group );
+}
+
+/**
+ * Removes the cache contents matching key and group.
  *
  * @since 2.0.0
  * @uses $wp_object_cache Object Cache Class
  * @see WP_Object_Cache::delete()
  *
- * @param int|string $id What the contents in the cache are called
- * @param string $flag Where the cache contents are grouped
+ * @param int|string $key What the contents in the cache are called
+ * @param string $group Where the cache contents are grouped
  * @return bool True on successful removal, false on failure
  */
-function wp_cache_delete($id, $flag = '') {
+function wp_cache_delete($key, $group = '') {
        global $wp_object_cache;
 
-       return $wp_object_cache->delete($id, $flag);
+       return $wp_object_cache->delete($key, $group);
 }
 
 /**
@@ -76,21 +94,40 @@ function wp_cache_flush() {
 }
 
 /**
- * Retrieves the cache contents from the cache by ID and flag.
+ * Retrieves the cache contents from the cache by key and group.
  *
  * @since 2.0.0
  * @uses $wp_object_cache Object Cache Class
  * @see WP_Object_Cache::get()
  *
- * @param int|string $id What the contents in the cache are called
- * @param string $flag Where the cache contents are grouped
+ * @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)
  * @return bool|mixed False on failure to retrieve contents or the cache
  *             contents on success
  */
-function wp_cache_get($id, $flag = '') {
+function wp_cache_get( $key, $group = '', $force = false ) {
+       global $wp_object_cache;
+
+       return $wp_object_cache->get( $key, $group, $force );
+}
+
+/**
+ * Increment numeric cache item's value
+ *
+ * @since 3.3.0
+ * @uses $wp_object_cache Object Cache Class
+ * @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 string $group The group the key is in.
+ * @return false|int False on failure, the item's new value on success.
+ */
+function wp_cache_incr( $key, $offset = 1, $group = '' ) {
        global $wp_object_cache;
 
-       return $wp_object_cache->get($id, $flag);
+       return $wp_object_cache->incr( $key, $offset, $group );
 }
 
 /**
@@ -100,7 +137,7 @@ function wp_cache_get($id, $flag = '') {
  * @global WP_Object_Cache $wp_object_cache WordPress Object Cache
  */
 function wp_cache_init() {
-       $GLOBALS['wp_object_cache'] =& new WP_Object_Cache();
+       $GLOBALS['wp_object_cache'] = new WP_Object_Cache();
 }
 
 /**
@@ -112,14 +149,14 @@ function wp_cache_init() {
  *
  * @param int|string $key What to call the contents in the cache
  * @param mixed $data The contents to store in the cache
- * @param string $flag Where to group the cache contents
+ * @param string $group Where to group the cache contents
  * @param int $expire When to expire the cache contents
- * @return bool False if cache ID and group already exists, true on success
+ * @return bool False if cache key and group already exist, true on success
  */
-function wp_cache_replace($key, $data, $flag = '', $expire = 0) {
+function wp_cache_replace($key, $data, $group = '', $expire = 0) {
        global $wp_object_cache;
 
-       return $wp_object_cache->replace($key, $data, $flag, $expire);
+       return $wp_object_cache->replace($key, $data, $group, $expire);
 }
 
 /**
@@ -131,14 +168,14 @@ function wp_cache_replace($key, $data, $flag = '', $expire = 0) {
  *
  * @param int|string $key What to call the contents in the cache
  * @param mixed $data The contents to store in the cache
- * @param string $flag Where to group the cache contents
+ * @param string $group Where to group the cache contents
  * @param int $expire When to expire the cache contents
- * @return bool False if cache ID and group already exists, true on success
+ * @return bool False if cache key and group already exist, true on success
  */
-function wp_cache_set($key, $data, $flag = '', $expire = 0) {
+function wp_cache_set($key, $data, $group = '', $expire = 0) {
        global $wp_object_cache;
 
-       return $wp_object_cache->set($key, $data, $flag, $expire);
+       return $wp_object_cache->set($key, $data, $group, $expire);
 }
 
 /**
@@ -205,15 +242,6 @@ class WP_Object_Cache {
         */
        var $cache = array ();
 
-       /**
-        * Cache objects that do not exist in the cache
-        *
-        * @var array
-        * @access private
-        * @since 2.0.0
-        */
-       var $non_existent_objects = array ();
-
        /**
         * The amount of times the cache data was already stored in the cache.
         *
@@ -246,24 +274,27 @@ class WP_Object_Cache {
         *
         * @uses WP_Object_Cache::get Checks to see if the cache already has data.
         * @uses WP_Object_Cache::set Sets the data after the checking the cache
-        *              contents existance.
+        *              contents existence.
         *
         * @since 2.0.0
         *
-        * @param int|string $id What to call the contents in the cache
+        * @param int|string $key What to call the contents in the cache
         * @param mixed $data The contents to store in the cache
         * @param string $group Where to group the cache contents
         * @param int $expire When to expire the cache contents
-        * @return bool False if cache ID and group already exists, true on success
+        * @return bool False if cache key and group already exist, true on success
         */
-       function add( $id, $data, $group = 'default', $expire = '' ) {
+       function add( $key, $data, $group = 'default', $expire = '' ) {
+               if ( wp_suspend_cache_addition() )
+                       return false;
+
                if ( empty ($group) )
                        $group = 'default';
 
-               if (false !== $this->get($id, $group))
+               if (false !== $this->get($key, $group))
                        return false;
 
-               return $this->set($id, $data, $group, $expire);
+               return $this->set($key, $data, $group, $expire);
        }
 
        /**
@@ -281,32 +312,55 @@ class WP_Object_Cache {
        }
 
        /**
-        * Remove the contents of the cache ID in the group
+        * Decrement numeric cache item's value
+        *
+        * @since 3.3.0
         *
-        * If the cache ID does not exist in the group and $force parameter is set
+        * @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 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 ] ) )
+                       return false;
+
+               if ( ! is_numeric( $this->cache[ $group ][ $key ] ) )
+                       $this->cache[ $group ][ $key ] = 0;
+
+               $offset = (int) $offset;
+
+               $this->cache[ $group ][ $key ] -= $offset;
+
+               if ( $this->cache[ $group ][ $key ] < 0 )
+                       $this->cache[ $group ][ $key ] = 0;
+
+               return $this->cache[ $group ][ $key ];
+       }
+
+       /**
+        * Remove the contents of the cache key in the group
+        *
+        * If the cache key does not exist in the group and $force parameter is set
         * to false, then nothing will happen. The $force parameter is set to false
         * by default.
         *
-        * On success the group and the id will be added to the
-        * $non_existent_objects property in the class.
-        *
         * @since 2.0.0
         *
-        * @param int|string $id What the contents in the cache are called
+        * @param int|string $key What the contents in the cache are called
         * @param string $group Where the cache contents are grouped
         * @param bool $force Optional. Whether to force the unsetting of the cache
-        *              ID in the group
+        *              key in the group
         * @return bool False if the contents weren't deleted and true on success
         */
-       function delete($id, $group = 'default', $force = false) {
+       function delete($key, $group = 'default', $force = false) {
                if (empty ($group))
                        $group = 'default';
 
-               if (!$force && false === $this->get($id, $group))
+               if (!$force && false === $this->get($key, $group))
                        return false;
 
-               unset ($this->cache[$group][$id]);
-               $this->non_existent_objects[$group][$id] = true;
+               unset ($this->cache[$group][$key]);
                return true;
        }
 
@@ -327,62 +381,82 @@ class WP_Object_Cache {
         * Retrieves the cache contents, if it exists
         *
         * The contents will be first attempted to be retrieved by searching by the
-        * ID in the cache group. If the cache is hit (success) then the contents
+        * key in the cache group. If the cache is hit (success) then the contents
         * are returned.
         *
-        * On failure, the $non_existent_objects property is checked and if the
-        * cache group and ID exist in there the cache misses will not be
-        * incremented. If not in the nonexistent objects property, then the cache
-        * misses will be incremented and the cache group and ID will be added to
-        * the nonexistent objects.
+        * On failure, the number of cache misses will be incremented.
         *
         * @since 2.0.0
         *
-        * @param int|string $id What the contents in the cache are called
+        * @param int|string $key What the contents in the cache are called
         * @param string $group Where the cache contents are grouped
+        * @param string $force Whether to force a refetch rather than relying on the local cache (default is false)
         * @return bool|mixed False on failure to retrieve contents or the cache
         *              contents on success
         */
-       function get($id, $group = 'default') {
+       function get( $key, $group = 'default', $force = false) {
                if ( empty ($group) )
                        $group = 'default';
 
-               if ( isset ($this->cache[$group][$id]) ) {
+               if ( isset ($this->cache[$group][$key]) ) {
                        $this->cache_hits += 1;
-                       if ( is_object($this->cache[$group][$id]) )
-                               return wp_clone($this->cache[$group][$id]);
+                       if ( is_object($this->cache[$group][$key]) )
+                               return clone $this->cache[$group][$key];
                        else
-                               return $this->cache[$group][$id];
+                               return $this->cache[$group][$key];
                }
 
-               if ( isset ($this->non_existent_objects[$group][$id]) )
-                       return false;
-
-               $this->non_existent_objects[$group][$id] = true;
                $this->cache_misses += 1;
                return false;
        }
 
+       /**
+        * Increment numeric cache item's value
+        *
+        * @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 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 ] ) )
+                       return false;
+
+               if ( ! is_numeric( $this->cache[ $group ][ $key ] ) )
+                       $this->cache[ $group ][ $key ] = 0;
+
+               $offset = (int) $offset;
+
+               $this->cache[ $group ][ $key ] += $offset;
+
+               if ( $this->cache[ $group ][ $key ] < 0 )
+                       $this->cache[ $group ][ $key ] = 0;
+
+               return $this->cache[ $group ][ $key ];
+       }
+
        /**
         * Replace the contents in the cache, if contents already exist
         *
         * @since 2.0.0
         * @see WP_Object_Cache::set()
         *
-        * @param int|string $id What to call the contents in the cache
+        * @param int|string $key What to call the contents in the cache
         * @param mixed $data The contents to store in the cache
         * @param string $group Where to group the cache contents
         * @param int $expire When to expire the cache contents
         * @return bool False if not exists, true if contents were replaced
         */
-       function replace($id, $data, $group = 'default', $expire = '') {
+       function replace($key, $data, $group = 'default', $expire = '') {
                if (empty ($group))
                        $group = 'default';
 
-               if ( false === $this->get($id, $group) )
+               if ( false === $this->get($key, $group) )
                        return false;
 
-               return $this->set($id, $data, $group, $expire);
+               return $this->set($key, $data, $group, $expire);
        }
 
        /**
@@ -402,7 +476,7 @@ class WP_Object_Cache {
         * Sets the data contents into the cache
         *
         * The cache contents is grouped by the $group parameter followed by the
-        * $id. This allows for duplicate ids in unique groups. Therefore, naming of
+        * $key. This allows for duplicate ids in unique groups. Therefore, naming of
         * the group should be used with care and should follow normal function
         * naming guidelines outside of core WordPress usage.
         *
@@ -412,13 +486,13 @@ class WP_Object_Cache {
         *
         * @since 2.0.0
         *
-        * @param int|string $id What to call the contents in the cache
+        * @param int|string $key What to call the contents in the cache
         * @param mixed $data The contents to store in the cache
         * @param string $group Where to group the cache contents
         * @param int $expire Not Used
         * @return bool Always returns true
         */
-       function set($id, $data, $group = 'default', $expire = '') {
+       function set($key, $data, $group = 'default', $expire = '') {
                if ( empty ($group) )
                        $group = 'default';
 
@@ -426,13 +500,9 @@ class WP_Object_Cache {
                        $data = '';
 
                if ( is_object($data) )
-                       $data = wp_clone($data);
-
-               $this->cache[$group][$id] = $data;
-
-               if ( isset($this->non_existent_objects[$group][$id]) )
-                       unset ($this->non_existent_objects[$group][$id]);
+                       $data = clone $data;
 
+               $this->cache[$group][$key] = $data;
                return true;
        }
 
@@ -456,17 +526,6 @@ class WP_Object_Cache {
                echo '</ul>';
        }
 
-       /**
-        * PHP4 constructor; Calls PHP 5 style constructor
-        *
-        * @since 2.0.0
-        *
-        * @return WP_Object_Cache
-        */
-       function WP_Object_Cache() {
-               return $this->__construct();
-       }
-
        /**
         * Sets up object properties; PHP 5 style constructor
         *