<!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][11413] trunk: Activity: Add parameter to `bp_activity_get_comment_depth()`.</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/11413">11413</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/11413","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>2017-02-06 19:26:44 +0000 (Mon, 06 Feb 2017)</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'>Activity: Add parameter to `bp_activity_get_comment_depth()`.
Previously, `bp_activity_get_comment_depth()` only supported looking for an
activity comment's depth during a queried activity comment loop.
This commit allows a developer to pass either a comment object or an
activity ID to the function so the activity comment depth can be fetched
outside the activity comment loop.
This fixes an issue with a notice displaying in the BuddyPress Activity
admin dashboard.
See <a href="http://buddypress.trac.wordpress.org/ticket/7329">#7329</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpactivitybpactivitytemplatephp">trunk/src/bp-activity/bp-activity-template.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestcasesactivityfunctionsbpActivityGetCommentDepthphp">trunk/tests/phpunit/testcases/activity/functions/bpActivityGetCommentDepth.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpactivitybpactivitytemplatephp"></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-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-activity/bp-activity-template.php 2017-02-06 12:36:30 UTC (rev 11412)
+++ trunk/src/bp-activity/bp-activity-template.php 2017-02-06 19:26:44 UTC (rev 11413)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2227,20 +2227,62 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Output the depth of the current activity comment.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.0.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 2.8.0 Added $comment as a parameter.
+ *
+ * @param object|int $comment Object of the activity comment or activity comment ID. Usually unnecessary
+ * when used in activity comment loop.
</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 bp_activity_comment_depth() {
- echo bp_activity_get_comment_depth();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function bp_activity_comment_depth( $comment = 0 ) {
+ echo bp_activity_get_comment_depth( $comment );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Return the current activity comment depth.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.0.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 2.8.0 Added $comment as a parameter.
</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 int $depth Depth for the current activity comment.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param object|int $comment Object of the activity comment or activity comment ID. Usually unnecessary
+ * when used in activity comment loop.
+ * @return int
</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 bp_activity_get_comment_depth() {
- global $activities_template;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function bp_activity_get_comment_depth( $comment = 0 ) {
+ $depth = 0;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Activity comment loop takes precedence.
+ if ( isset( $GLOBALS['activities_template']->activity->current_comment->depth ) ) {
+ $depth = $GLOBALS['activities_template']->activity->current_comment->depth;
+
+ // Get depth for activity comment manually.
+ } elseif ( ! empty( $comment ) ) {
+ // We passed an activity ID, so fetch the activity object.
+ if ( is_int( $comment ) ) {
+ $comment = new BP_Activity_Activity( $comment );
+ }
+
+ // Recurse through activity tree to find the depth.
+ if ( is_object( $comment ) && isset( $comment->type ) && 'activity_comment' === $comment->type ) {
+ // Fetch the entire root comment tree... ugh.
+ $comments = BP_Activity_Activity::get_activity_comments( $comment->item_id, 1, constant( 'PHP_INT_MAX' ) );
+
+ // Recursively find our comment object from the comment tree.
+ $iterator = new RecursiveArrayIterator( $comments );
+ $recursive = new RecursiveIteratorIterator( $iterator, RecursiveIteratorIterator::SELF_FIRST );
+ foreach ( $recursive as $cid => $cobj ) {
+ // Skip items that are not a comment object.
+ if ( ! is_numeric( $cid ) || ! is_object( $cobj ) ) {
+ continue;
+ }
+
+ // We found the activity comment! Set the depth.
+ if ( $cid === $comment->id && isset( $cobj->depth ) ) {
+ $depth = $cobj->depth;
+ break;
+ }
+ }
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the comment depth of the current activity comment.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2248,7 +2290,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $depth Depth for the current activity comment.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return apply_filters( 'bp_activity_get_comment_depth', $activities_template->activity->current_comment->depth );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return apply_filters( 'bp_activity_get_comment_depth', $depth );
</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">@@ -2884,7 +2926,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Fall back on current comment in activity loop.
</span><span class="cx" style="display: block; padding: 0 10px"> $comment_depth = isset( $comment->depth )
</span><span class="cx" style="display: block; padding: 0 10px"> ? intval( $comment->depth )
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- : bp_activity_get_comment_depth();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ : bp_activity_get_comment_depth( $comment );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Threading is turned on, so check the depth.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( get_option( 'thread_comments' ) ) {
</span></span></pre></div>
<a id="trunktestsphpunittestcasesactivityfunctionsbpActivityGetCommentDepthphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/testcases/activity/functions/bpActivityGetCommentDepth.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/activity/functions/bpActivityGetCommentDepth.php (rev 0)
+++ trunk/tests/phpunit/testcases/activity/functions/bpActivityGetCommentDepth.php 2017-02-06 19:26:44 UTC (rev 11413)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,111 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group activity
+ * @group bp_activity_get_comment_depth
+ */
+class BP_Tests_Activity_Functions_BpActivityGetCommentDepth extends BP_UnitTestCase {
+ /**
+ * @ticket BP7329
+ */
+ public function test_depth_inside_activity_comment_loop() {
+ $u = $this->factory->user->create();
+
+ // create an activity update
+ $parent_activity = $this->factory->activity->create( array(
+ 'type' => 'activity_update',
+ 'user_id' => $u
+ ) );
+
+ // create some activity comments
+ $comment_one = bp_activity_new_comment( array(
+ 'user_id' => $u,
+ 'activity_id' => $parent_activity,
+ 'content' => 'depth 1'
+ ) );
+
+ $comment_one_one = bp_activity_new_comment( array(
+ 'user_id' => $u,
+ 'activity_id' => $parent_activity,
+ 'parent_id' => $comment_one,
+ 'content' => 'depth 2'
+ ) );
+
+ $comment_two = bp_activity_new_comment( array(
+ 'user_id' => $u,
+ 'activity_id' => $parent_activity,
+ 'content' => 'depth 1'
+ ) );
+
+ // Instantiate activity loop, which also includes activity comments.
+ bp_has_activities( 'display_comments=threaded' );
+
+ // Loop through activity comments generated in activity loop.
+ $recursive = new RecursiveIteratorIterator( new RecursiveArrayIterator( $GLOBALS['activities_template']->activities[0]->children ), RecursiveIteratorIterator::SELF_FIRST );
+ foreach ( $recursive as $aid => $a ) {
+ if ( ! is_numeric( $aid ) || ! is_object( $a ) ) {
+ continue;
+ }
+
+ /*
+ * Emulate activity comment loop global, which bp_activity_get_comment_depth()
+ * relies on by default.
+ */
+ $GLOBALS['activities_template']->activity = new stdClass;
+ $GLOBALS['activities_template']->activity->current_comment = $a;
+
+ // $aid is the activity ID for the current activity comment.
+ switch ( $aid ) {
+ case $comment_one :
+ case $comment_two :
+ $this->assertSame( bp_activity_get_comment_depth(), 1 );
+ break;
+
+ case $comment_one_one :
+ $this->assertSame( bp_activity_get_comment_depth(), 2 );
+ break;
+ }
+
+ }
+
+ // Clean up after ourselves!
+ $GLOBALS['activities_template'] = null;
+ }
+
+ /**
+ * @ticket BP7329
+ */
+ public function test_depth_outside_of_activity_comment_loop() {
+ $u = $this->factory->user->create();
+
+ // create an activity update
+ $parent_activity = $this->factory->activity->create( array(
+ 'type' => 'activity_update',
+ 'user_id' => $u
+ ) );
+
+ // create some activity comments
+ $comment_one = bp_activity_new_comment( array(
+ 'user_id' => $u,
+ 'activity_id' => $parent_activity,
+ 'content' => 'depth 1'
+ ) );
+
+ $comment_one_one = bp_activity_new_comment( array(
+ 'user_id' => $u,
+ 'activity_id' => $parent_activity,
+ 'parent_id' => $comment_one,
+ 'content' => 'depth 2'
+ ) );
+
+ $comment_two = bp_activity_new_comment( array(
+ 'user_id' => $u,
+ 'activity_id' => $parent_activity,
+ 'content' => 'depth 1'
+ ) );
+
+ $this->assertSame( bp_activity_get_comment_depth( $comment_one ), 1 );
+ $this->assertSame( bp_activity_get_comment_depth( $comment_one_one ), 2 );
+ $this->assertSame( bp_activity_get_comment_depth( $comment_two ), 1 );
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>