<!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][9325] trunk/src/bp-activity: Move activity scopes adjustment in filters</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/9325">9325</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/9325","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>imath</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-01-09 08:30:52 +0000 (Fri, 09 Jan 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'>Move activity scopes adjustment in filters
Separate the hardcoded scopes away from `BP_Activity_Activity::get_scope_query_sql()` to manage scope adjustments within components and to allow developers to make adjustments to them if needed.
See <a href="http://buddypress.trac.wordpress.org/ticket/4988">#4988</a>
See <a href="http://buddypress.trac.wordpress.org/ticket/6040">#6040</a>
props r-a-y</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpactivitybpactivityclassesphp">trunk/src/bp-activity/bp-activity-classes.php</a></li>
<li><a href="#trunksrcbpactivitybpactivityfiltersphp">trunk/src/bp-activity/bp-activity-filters.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpactivitybpactivityclassesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-activity/bp-activity-classes.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-activity/bp-activity-classes.php 2015-01-09 05:48:38 UTC (rev 9324)
+++ trunk/src/bp-activity/bp-activity-classes.php 2015-01-09 08:30:52 UTC (rev 9325)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -867,90 +867,32 @@
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $scopes as $scope ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $scope_args = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- switch ( $scope ) {
- case 'just-me' :
- $scope_args = array(
- 'column' => 'user_id',
- 'value' => $r['user_id']
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Plugins can hook here to set their activity arguments for custom scopes.
+ *
+ * This is a dynamic filter based on the activity scope. eg:
+ * - 'bp_activity_set_groups_scope_args'
+ * - 'bp_activity_set_friends_scope_args'
+ *
+ * To see how this filter is used, plugin devs should check out:
+ * - bp_groups_filter_activity_scope() - used for 'groups' scope
+ * - bp_friends_filter_activity_scope() - used for 'friends' scope
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @param array {
+ * Activity query clauses.
+ *
+ * @type array {
+ * Activity arguments for your custom scope.
+ * See {@link BP_Activity_Query::_construct()} for more details.
+ * }
+ * @type array $override Optional. Override existing activity arguments passed by $r.
+ * }
+ * @param array $r Current activity arguments passed in BP_Activity_Activity::get()
+ */
+ $scope_args = apply_filters( "bp_activity_set_{$scope}_scope_args", array(), $r );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $scope_args['override']['display_comments'] = 'stream';
-
- // wipe out the user ID
- $scope_args['override']['filter']['user_id'] = 0;
-
- break;
-
- case 'favorites':
- $favs = bp_activity_get_user_favorites( $r['user_id'] );
- if ( empty( $favs ) ) {
- return $scope_args;
- }
-
- $scope_args = array(
- 'column' => 'id',
- 'compare' => 'IN',
- 'value' => (array) $favs
- );
- $scope_args['override']['display_comments'] = true;
-
- // wipe out the user ID
- $scope_args['override']['filter']['user_id'] = 0;
-
- break;
-
- case 'mentions':
- // Are mentions disabled?
- if ( ! bp_activity_do_mentions() ) {
- return $scope_args;
- }
-
- $scope_args = array(
- 'column' => 'content',
- 'compare' => 'LIKE',
-
- // Start search at @ symbol and stop search at closing tag delimiter.
- 'value' => '@' . bp_activity_get_user_mentionname( $r['user_id'] ) . '<'
- );
-
- // wipe out current search terms if any
- // this is so the 'mentions' scope can be combined with other scopes
- $scope_args['override']['search_terms'] = false;
-
- $scope_args['override']['display_comments'] = 'stream';
- $scope_args['override']['filter']['user_id'] = 0;
-
- break;
-
- default :
- /**
- * Plugins can hook here to set their activity arguments for custom scopes.
- *
- * This is a dynamic filter based on the activity scope. eg:
- * - 'bp_activity_set_groups_scope_args'
- * - 'bp_activity_set_friends_scope_args'
- *
- * To see how this filter is used, plugin devs should check out:
- * - bp_groups_filter_activity_scope() - used for 'groups' scope
- * - bp_friends_filter_activity_scope() - used for 'friends' scope
- *
- * @since BuddyPress (2.2.0)
- *
- * @param array {
- * Activity query clauses.
- *
- * @type array {
- * Activity arguments for your custom scope.
- * See {@link BP_Activity_Query::_construct()} for more details.
- * }
- * @type array $override Optional. Override existing activity arguments passed by $r.
- * }
- * @param array $r Current activity arguments passed in BP_Activity_Activity::get()
- */
- $scope_args = apply_filters( "bp_activity_set_{$scope}_scope_args", array(), $r );
- break;
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $scope_args ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // merge override properties from other scopes
</span><span class="cx" style="display: block; padding: 0 10px"> // this might be a problem...
</span></span></pre></div>
<a id="trunksrcbpactivitybpactivityfiltersphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-activity/bp-activity-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-activity/bp-activity-filters.php 2015-01-09 05:48:38 UTC (rev 9324)
+++ trunk/src/bp-activity/bp-activity-filters.php 2015-01-09 08:30:52 UTC (rev 9325)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -638,3 +638,93 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $strings;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'bp_core_get_js_strings', 'bp_activity_heartbeat_strings', 10, 1 );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/** SCOPES **************************************************************/
+
+/**
+ * Set up activity arguments for use with the 'just-me' scope.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @param array $retval Empty array by default
+ * @param array $filter Current activity arguments
+ * @return array
+ */
+function bp_activity_filter_just_me_scope( $retval, $filter ) {
+ $retval = array(
+ 'column' => 'user_id',
+ 'value' => $filter['user_id']
+ );
+
+ $retval['override']['display_comments'] = 'stream';
+
+ // wipe out the user ID
+ $retval['override']['filter']['user_id'] = 0;
+
+ return $retval;
+}
+add_filter( 'bp_activity_set_just-me_scope_args', 'bp_activity_filter_just_me_scope', 10, 2 );
+
+/**
+ * Set up activity arguments for use with the 'favorites' scope.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @param array $retval Empty array by default
+ * @param array $filter Current activity arguments
+ * @return array
+ */
+function bp_activity_filter_favorites_scope( $retval, $filter ) {
+ $favs = bp_activity_get_user_favorites( $filter['user_id'] );
+ if ( empty( $favs ) ) {
+ return $retval;
+ }
+
+ $retval = array(
+ 'column' => 'id',
+ 'compare' => 'IN',
+ 'value' => (array) $favs
+ );
+ $retval['override']['display_comments'] = true;
+
+ // wipe out the user ID
+ $retval['override']['filter']['user_id'] = 0;
+
+ return $retval;
+}
+add_filter( 'bp_activity_set_favorites_scope_args', 'bp_activity_filter_favorites_scope', 10, 2 );
+
+
+/**
+ * Set up activity arguments for use with the 'favorites' scope.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @param array $retval Empty array by default
+ * @param array $filter Current activity arguments
+ * @return array
+ */
+function bp_activity_filter_mentions_scope( $retval, $filter ) {
+ // Are mentions disabled?
+ if ( ! bp_activity_do_mentions() ) {
+ return $retval;
+ }
+
+ $retval = array(
+ 'column' => 'content',
+ 'compare' => 'LIKE',
+
+ // Start search at @ symbol and stop search at closing tag delimiter.
+ 'value' => '@' . bp_activity_get_user_mentionname( $filter['user_id'] ) . '<'
+ );
+
+ // wipe out current search terms if any
+ // this is so the 'mentions' scope can be combined with other scopes
+ $retval['override']['search_terms'] = false;
+
+ $retval['override']['display_comments'] = 'stream';
+ $retval['override']['filter']['user_id'] = 0;
+
+ return $retval;
+}
+add_filter( 'bp_activity_set_mentions_scope_args', 'bp_activity_filter_mentions_scope', 10, 2 );
</ins></span></pre>
</div>
</div>
</body>
</html>