<!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>[BuddyPress][9253] trunk/src/bp-core/bp-core-classes.php: Core: Introduce new class - `BP_Recursive_Query`.</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="http://buddypress.trac.wordpress.org/changeset/9253">9253</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/9253","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>r-a-y</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2014-12-22 18:38:04 +0000 (Mon, 22 Dec 2014)</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'>Core: Introduce new class - `BP_Recursive_Query`.
`BP_Recursive_Query` is a new abstract class based off of work done in
WordPress 4.1 to support the creation of advanced SQL clauses (nested
clauses and multiple operators). See:
https://core.trac.wordpress.org/ticket/29642#comment:6
The `BP_XProfile_Query` class already uses a version of this class. The
goal is for `BP_XProfile_Query` to extend `BP_Recursive_Query` in a future
commit (see https://buddypress.trac.wordpress.org/ticket/5839#comment:9).
Also, the activity component will be the next to use the class to support
advanced filtering (<a href="http://buddypress.trac.wordpress.org/ticket/4988">#4988</a>).
Props boonebgorges.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcoreclassesphp">trunk/src/bp-core/bp-core-classes.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcorebpcoreclassesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/bp-core-classes.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-classes.php 2014-12-22 15:24:39 UTC (rev 9252)
+++ trunk/src/bp-core/bp-core-classes.php 2014-12-22 18:38:04 UTC (rev 9253)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2754,3 +2754,228 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_members_suggestions_get_suggestions', $results, $this );
</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">+
+/**
+ * Base class for creating query classes that generate SQL fragments for filtering results based on recursive query params.
+ *
+ * @since BuddyPress (2.2.0)
+ */
+abstract class BP_Recursive_Query {
+
+ /**
+ * Query arguments passed to the constructor.
+ *
+ * @since BuddyPress (2.2.0)
+ * @access public
+ * @var array
+ */
+ public $queries = array();
+
+ /**
+ * Generate SQL clauses to be appended to a main query.
+ *
+ * Extending classes should call this method from within a publicly
+ * accessible get_sql() method, and manipulate the SQL as necessary.
+ * For example, {@link BP_XProfile_Query::get_sql()} is merely a wrapper for
+ * get_sql_clauses(), while {@link BP_Activity_Query::get_sql()} discards
+ * the empty 'join' clause, and only passes the 'where' clause.
+ *
+ * @since BuddyPress (2.2.0)
+ * @access protected
+ *
+ * @param string $primary_table
+ * @param string $primary_id_column
+ * @return array
+ */
+ protected function get_sql_clauses() {
+ $sql = $this->get_sql_for_query( $this->queries );
+
+ if ( ! empty( $sql['where'] ) ) {
+ $sql['where'] = ' AND ' . "\n" . $sql['where'] . "\n";
+ }
+
+ return $sql;
+ }
+
+ /**
+ * Generate SQL clauses for a single query array.
+ *
+ * If nested subqueries are found, this method recurses the tree to
+ * produce the properly nested SQL.
+ *
+ * Subclasses generally do not need to call this method. It is invoked
+ * automatically from get_sql_clauses().
+ *
+ * @since BuddyPress (2.2.0)
+ * @access protected
+ *
+ * @param array $query Query to parse.
+ * @param int $depth Optional. Number of tree levels deep we
+ * currently are. Used to calculate indentation.
+ * @return array
+ */
+ protected function get_sql_for_query( $query, $depth = 0 ) {
+ $sql_chunks = array(
+ 'join' => array(),
+ 'where' => array(),
+ );
+
+ $sql = array(
+ 'join' => '',
+ 'where' => '',
+ );
+
+ $indent = '';
+ for ( $i = 0; $i < $depth; $i++ ) {
+ $indent .= "\t";
+ }
+
+ foreach ( $query as $key => $clause ) {
+ if ( 'relation' === $key ) {
+ $relation = $query['relation'];
+ } else if ( is_array( $clause ) ) {
+ // This is a first-order clause
+ if ( $this->is_first_order_clause( $clause ) ) {
+ $clause_sql = $this->get_sql_for_clause( $clause, $query );
+
+ $where_count = count( $clause_sql['where'] );
+ if ( ! $where_count ) {
+ $sql_chunks['where'][] = '';
+ } else if ( 1 === $where_count ) {
+ $sql_chunks['where'][] = $clause_sql['where'][0];
+ } else {
+ $sql_chunks['where'][] = '( ' . implode( ' AND ', $clause_sql['where'] ) . ' )';
+ }
+
+ $sql_chunks['join'] = array_merge( $sql_chunks['join'], $clause_sql['join'] );
+ // This is a subquery
+ } else {
+ $clause_sql = $this->get_sql_for_query( $clause, $depth + 1 );
+
+ $sql_chunks['where'][] = $clause_sql['where'];
+ $sql_chunks['join'][] = $clause_sql['join'];
+
+ }
+ }
+ }
+
+ // Filter empties
+ $sql_chunks['join'] = array_filter( $sql_chunks['join'] );
+ $sql_chunks['where'] = array_filter( $sql_chunks['where'] );
+
+ if ( empty( $relation ) ) {
+ $relation = 'AND';
+ }
+
+ if ( ! empty( $sql_chunks['join'] ) ) {
+ $sql['join'] = implode( ' ', array_unique( $sql_chunks['join'] ) );
+ }
+
+ if ( ! empty( $sql_chunks['where'] ) ) {
+ $sql['where'] = '( ' . "\n\t" . $indent . implode( ' ' . "\n\t" . $indent . $relation . ' ' . "\n\t" . $indent, $sql_chunks['where'] ) . "\n" . $indent . ')' . "\n";
+ }
+
+ return $sql;
+ }
+
+ /**
+ * Recursive-friendly query sanitizer.
+ *
+ * Ensures that each query-level clause has a 'relation' key, and that
+ * each first-order clause contains all the necessary keys from
+ * $defaults.
+ *
+ * Extend this method if your class uses different sanitizing logic.
+ *
+ * @since BuddyPress (2.2.0)
+ * @access public
+ *
+ * @param array $queries Array of query clauses.
+ * @return array Sanitized array of query clauses.
+ */
+ protected function sanitize_query( $queries ) {
+ $clean_queries = array();
+
+ if ( ! is_array( $queries ) ) {
+ return $clean_queries;
+ }
+
+ foreach ( $queries as $key => $query ) {
+ if ( 'relation' === $key ) {
+ $relation = $query;
+
+ } else if ( ! is_array( $query ) ) {
+ continue;
+
+ // First-order clause.
+ } else if ( $this->is_first_order_clause( $query ) ) {
+ if ( isset( $query['value'] ) && array() === $query['value'] ) {
+ unset( $query['value'] );
+ }
+
+ $clean_queries[] = $query;
+
+ // Otherwise, it's a nested query, so we recurse.
+ } else {
+ $cleaned_query = $this->sanitize_query( $query );
+
+ if ( ! empty( $cleaned_query ) ) {
+ $clean_queries[] = $cleaned_query;
+ }
+ }
+ }
+
+ if ( empty( $clean_queries ) ) {
+ return $clean_queries;
+ }
+
+ // Sanitize the 'relation' key provided in the query.
+ if ( isset( $relation ) && 'OR' === strtoupper( $relation ) ) {
+ $clean_queries['relation'] = 'OR';
+
+ /*
+ * If there is only a single clause, call the relation 'OR'.
+ * This value will not actually be used to join clauses, but it
+ * simplifies the logic around combining key-only queries.
+ */
+ } else if ( 1 === count( $clean_queries ) ) {
+ $clean_queries['relation'] = 'OR';
+
+ // Default to AND.
+ } else {
+ $clean_queries['relation'] = 'AND';
+ }
+
+ return $clean_queries;
+ }
+
+ /**
+ * Generate JOIN and WHERE clauses for a first-order clause.
+ *
+ * Must be overridden in a subclass.
+ *
+ * @since BuddyPress (2.2.0)
+ * @access protected
+ *
+ * @param array $clause Array of arguments belonging to the clause.
+ * @param array $parent_query Parent query to which the clause belongs.
+ * @return array {
+ * @type array $join Array of subclauses for the JOIN statement.
+ * @type array $where Array of subclauses for the WHERE statement.
+ * }
+ */
+ abstract protected function get_sql_for_clause( $clause, $parent_query );
+
+ /**
+ * Determine whether a clause is first-order.
+ *
+ * Must be overridden in a subclass.
+ *
+ * @since BuddyPress (2.2.0)
+ * @access protected
+ *
+ * @param array $q Clause to check.
+ * @return bool
+ */
+ abstract protected function is_first_order_clause( $query );
+}
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of file
</span></span></pre>
</div>
</div>
</body>
</html>