<!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>[GlotPress][1110] trunk: Meta: Cache metadata in `gp_get_meta()`.</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 { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { 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" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://glotpress.trac.wordpress.org/changeset/1110">1110</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://glotpress.trac.wordpress.org/changeset/1110","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>ocean90</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-08-20 21:33:42 +0000 (Thu, 20 Aug 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Meta: Cache metadata in `gp_get_meta()`.
Adds unit tests.
props dd32, ocean90.
see <a href="http://glotpress.trac.wordpress.org/ticket/480">#480</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkgpincludesmetaphp">trunk/gp-includes/meta.php</a></li>
<li><a href="#trunktlibtestcasephp">trunk/t/lib/testcase.php</a></li>
<li><a href="#trunktteststest_metaphp">trunk/t/tests/test_meta.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkgpincludesmetaphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/gp-includes/meta.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/gp-includes/meta.php 2015-08-12 18:52:16 UTC (rev 1109)
+++ trunk/gp-includes/meta.php 2015-08-20 21:33:42 UTC (rev 1110)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -14,25 +14,45 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieves and returns a meta value from the database
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param $meta_type object type
- * @param $object_id
- * @param $meta_key
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $object_type The object type.
+ * @param int $object_id ID of the object metadata is for.
+ * @param string|null $meta_key Optional. Metadata key. Default null.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return mixed|null
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return mixed|false Metadata or false.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function gp_get_meta( $meta_type, $object_id, $meta_key ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function gp_get_meta( $object_type, $object_id, $meta_key = null ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $gpdb;
</span><span class="cx" style="display: block; padding: 0 10px"> $meta_key = gp_sanitize_meta_key( $meta_key );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! $meta_type ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $object_type ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_numeric( $object_id ) || empty( $object_id ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $object_id = (int) $object_id;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $gpdb->get_var( $gpdb->prepare( "SELECT `meta_value` FROM `$gpdb->meta` WHERE `object_type` = %s AND `object_id` = %d AND `meta_key` = %s", $meta_type, $object_id, $meta_key ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $object_meta = wp_cache_get( $object_id, $object_type );
+
+ if ( false === $object_meta ) {
+ $db_object_meta = $gpdb->get_results( $gpdb->prepare( "SELECT `meta_key`, `meta_value` FROM `$gpdb->meta` WHERE `object_type` = %s AND `object_id` = %d", $object_type, $object_id ) );
+
+ $object_meta = array();
+ foreach ( $db_object_meta as $meta ) {
+ $object_meta[ $meta->meta_key ] = maybe_unserialize( $meta->meta_value );
+ }
+
+ wp_cache_add( $object_id, $object_meta, $object_type );
+ }
+
+ if ( $meta_key && isset( $object_meta[ $meta_key ] ) ) {
+ return $object_meta[ $meta_key ];
+ } elseif ( ! $meta_key ) {
+ return $object_meta;
+ } else {
+ return false;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -222,8 +242,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string The option to be echoed
</span><span class="cx" style="display: block; padding: 0 10px"> * @return void
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function gp_option( $option )
-{
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function gp_option( $option ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> echo apply_filters( 'gp_option_' . $option, gp_get_option( $option ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktlibtestcasephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/t/lib/testcase.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/t/lib/testcase.php 2015-08-12 18:52:16 UTC (rev 1109)
+++ trunk/t/lib/testcase.php 2015-08-20 21:33:42 UTC (rev 1110)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -129,6 +129,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function assertEqualSets( $expected, $actual ) {
+ sort( $expected );
+ sort( $actual );
+ $this->assertEquals( $expected, $actual );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> function assertDiscardWhitespace( $expected, $actual ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( preg_replace( '/\s*/', '', $expected ), preg_replace( '/\s*/', '', $actual ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktteststest_metaphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/t/tests/test_meta.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/t/tests/test_meta.php 2015-08-12 18:52:16 UTC (rev 1109)
+++ trunk/t/tests/test_meta.php 2015-08-20 21:33:42 UTC (rev 1110)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -23,4 +23,36 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertNotEquals( null, gp_get_meta( 'thing', '1', 'foo' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-}
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of file
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @ticket 480
+ */
+ function test_get_meta_uses_cache() {
+ global $gpdb;
+
+ gp_update_meta( '1', 'foo', 'bar', 'thing' );
+
+ $num_queries = $gpdb->num_queries;
+
+ // Cache is not primed, expect 1 query.
+ gp_get_meta( 'thing', '1', 'foo' );
+ $this->assertEquals( $num_queries + 1, $gpdb->num_queries );
+
+ $num_queries = $gpdb->num_queries;
+
+ // Cache is primed, expect no queries.
+ gp_get_meta( 'thing', '1', 'foo' );
+ $this->assertEquals( $num_queries, $gpdb->num_queries );
+ }
+
+ /**
+ * @ticket 480
+ */
+ function test_get_meta_without_meta_key() {
+ gp_update_meta( '1', 'key1', 'foo', 'thing' );
+ gp_update_meta( '1', 'key2', 'foo', 'thing' );
+
+ $meta = gp_get_meta( 'thing', '1' );
+ $this->assertCount( 2, $meta );
+ $this->assertEqualSets( array( 'key1', 'key2' ), array_keys( $meta ) );
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>