<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[20089] trunk/wp-includes/cache.php: Fix NULL and FALSE in WP_Object_Cache and make found/not-found unambiguous.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg > ul, #logmsg > ol { margin-left: 0; margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/20089">20089</a></dd>
<dt>Author</dt> <dd>ryan</dd>
<dt>Date</dt> <dd>2012-03-02 21:10:37 +0000 (Fri, 02 Mar 2012)</dd>
</dl>
<h3>Log Message</h3>
<pre>Fix NULL and FALSE in WP_Object_Cache and make found/not-found unambiguous. Props andy. fixes <a href="http://core.trac.wordpress.org/ticket/20004">#20004</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpincludescachephp">trunk/wp-includes/cache.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpincludescachephp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/cache.php (20088 => 20089)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/cache.php 2012-03-02 21:07:31 UTC (rev 20088)
+++ trunk/wp-includes/cache.php 2012-03-02 21:10:37 UTC (rev 20089)
</span><span class="lines">@@ -103,13 +103,14 @@
</span><span class="cx"> * @param int|string $key What the contents in the cache are called
</span><span class="cx"> * @param string $group Where the cache contents are grouped
</span><span class="cx"> * @param bool $force Whether to force an update of the local cache from the persistent cache (default is false)
</span><ins>+ * @param &bool $found Whether key was found in the cache. Disambiguates a return of false, a storable value.
</ins><span class="cx"> * @return bool|mixed False on failure to retrieve contents or the cache
</span><span class="cx"> * contents on success
</span><span class="cx"> */
</span><del>-function wp_cache_get( $key, $group = '', $force = false ) {
</del><ins>+function wp_cache_get( $key, $group = '', $force = false, &$found = null ) {
</ins><span class="cx"> global $wp_object_cache;
</span><span class="cx">
</span><del>- return $wp_object_cache->get( $key, $group, $force );
</del><ins>+ return $wp_object_cache->get( $key, $group, $force, $found );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -272,7 +273,7 @@
</span><span class="cx"> /**
</span><span class="cx"> * Adds data to the cache if it doesn't already exist.
</span><span class="cx"> *
</span><del>- * @uses WP_Object_Cache::get Checks to see if the cache already has data.
</del><ins>+ * @uses WP_Object_Cache::_exists Checks to see if the cache already has data.
</ins><span class="cx"> * @uses WP_Object_Cache::set Sets the data after the checking the cache
</span><span class="cx"> * contents existence.
</span><span class="cx"> *
</span><span class="lines">@@ -288,10 +289,10 @@
</span><span class="cx"> if ( wp_suspend_cache_addition() )
</span><span class="cx"> return false;
</span><span class="cx">
</span><del>- if ( empty ($group) )
</del><ins>+ if ( empty( $group ) )
</ins><span class="cx"> $group = 'default';
</span><span class="cx">
</span><del>- if (false !== $this->get($key, $group))
</del><ins>+ if ( $this->_exists($key, $group) )
</ins><span class="cx"> return false;
</span><span class="cx">
</span><span class="cx"> return $this->set($key, $data, $group, $expire);
</span><span class="lines">@@ -322,7 +323,7 @@
</span><span class="cx"> * @return false|int False on failure, the item's new value on success.
</span><span class="cx"> */
</span><span class="cx"> function decr( $key, $offset = 1, $group = 'default' ) {
</span><del>- if ( ! isset( $this->cache[ $group ][ $key ] ) )
</del><ins>+ if ( ! $this->_exists( $key, $group ) )
</ins><span class="cx"> return false;
</span><span class="cx">
</span><span class="cx"> if ( ! is_numeric( $this->cache[ $group ][ $key ] ) )
</span><span class="lines">@@ -354,13 +355,13 @@
</span><span class="cx"> * @return bool False if the contents weren't deleted and true on success
</span><span class="cx"> */
</span><span class="cx"> function delete($key, $group = 'default', $force = false) {
</span><del>- if (empty ($group))
</del><ins>+ if ( empty( $group ) )
</ins><span class="cx"> $group = 'default';
</span><span class="cx">
</span><del>- if (!$force && false === $this->get($key, $group))
</del><ins>+ if ( ! $force && ! $this->_exists( $key, $group ) )
</ins><span class="cx"> return false;
</span><span class="cx">
</span><del>- unset ($this->cache[$group][$key]);
</del><ins>+ unset( $this->cache[$group][$key] );
</ins><span class="cx"> return true;
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -394,11 +395,12 @@
</span><span class="cx"> * @return bool|mixed False on failure to retrieve contents or the cache
</span><span class="cx"> * contents on success
</span><span class="cx"> */
</span><del>- function get( $key, $group = 'default', $force = false) {
- if ( empty ($group) )
</del><ins>+ function get( $key, $group = 'default', $force = false, &$found = null ) {
+ if ( empty( $group ) )
</ins><span class="cx"> $group = 'default';
</span><span class="cx">
</span><del>- if ( isset ($this->cache[$group][$key]) ) {
</del><ins>+ if ( $this->_exists( $key, $group ) ) {
+ $found = true;
</ins><span class="cx"> $this->cache_hits += 1;
</span><span class="cx"> if ( is_object($this->cache[$group][$key]) )
</span><span class="cx"> return clone $this->cache[$group][$key];
</span><span class="lines">@@ -406,6 +408,7 @@
</span><span class="cx"> return $this->cache[$group][$key];
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ $found = false;
</ins><span class="cx"> $this->cache_misses += 1;
</span><span class="cx"> return false;
</span><span class="cx"> }
</span><span class="lines">@@ -421,7 +424,10 @@
</span><span class="cx"> * @return false|int False on failure, the item's new value on success.
</span><span class="cx"> */
</span><span class="cx"> function incr( $key, $offset = 1, $group = 'default' ) {
</span><del>- if ( ! isset( $this->cache[ $group ][ $key ] ) )
</del><ins>+ if ( empty( $group ) )
+ $group = 'default';
+
+ if ( ! $this->_exists( $key, $group ) )
</ins><span class="cx"> return false;
</span><span class="cx">
</span><span class="cx"> if ( ! is_numeric( $this->cache[ $group ][ $key ] ) )
</span><span class="lines">@@ -450,10 +456,10 @@
</span><span class="cx"> * @return bool False if not exists, true if contents were replaced
</span><span class="cx"> */
</span><span class="cx"> function replace($key, $data, $group = 'default', $expire = '') {
</span><del>- if (empty ($group))
</del><ins>+ if ( empty( $group ) )
</ins><span class="cx"> $group = 'default';
</span><span class="cx">
</span><del>- if ( false === $this->get($key, $group) )
</del><ins>+ if ( ! $this->_exists( $key, $group ) )
</ins><span class="cx"> return false;
</span><span class="cx">
</span><span class="cx"> return $this->set($key, $data, $group, $expire);
</span><span class="lines">@@ -493,12 +499,9 @@
</span><span class="cx"> * @return bool Always returns true
</span><span class="cx"> */
</span><span class="cx"> function set($key, $data, $group = 'default', $expire = '') {
</span><del>- if ( empty ($group) )
</del><ins>+ if ( empty( $group ) )
</ins><span class="cx"> $group = 'default';
</span><span class="cx">
</span><del>- if ( null === $data )
- $data = '';
-
</del><span class="cx"> if ( is_object($data) )
</span><span class="cx"> $data = clone $data;
</span><span class="cx">
</span><span class="lines">@@ -527,6 +530,14 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Utility function to determine whether a key exists in the cache.
+ * @access private
+ */
+ protected function _exists($key, $group) {
+ return is_array( $this->cache[$group] ) && array_key_exists( $key, $this->cache[$group] );
+ }
+
+ /**
</ins><span class="cx"> * Sets up object properties; PHP 5 style constructor
</span><span class="cx"> *
</span><span class="cx"> * @since 2.0.8
</span></span></pre>
</div>
</div>
</body>
</html>