<!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][13150] trunk: Group the `BP_Activity_Activity::get_id()` method params into an array</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 { white-space: pre-line; 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/13150">13150</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/13150","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>2021-11-14 15:51:15 +0000 (Sun, 14 Nov 2021)</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'>Group the `BP_Activity_Activity::get_id()` method params into an array
Deprecate old arguments and add backward compatibility for users still using these.
Props oztaser
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/8596">#8596</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpactivitybpactivityfunctionsphp">trunk/src/bp-activity/bp-activity-functions.php</a></li>
<li><a href="#trunksrcbpactivityclassesclassbpactivityactivityphp">trunk/src/bp-activity/classes/class-bp-activity-activity.php</a></li>
<li><a href="#trunktestsphpunittestcasesactivityclassBP_Activity_Activityphp">trunk/tests/phpunit/testcases/activity/class.BP_Activity_Activity.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpactivitybpactivityfunctionsphp"></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-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-activity/bp-activity-functions.php 2021-11-14 15:16:38 UTC (rev 13149)
+++ trunk/src/bp-activity/bp-activity-functions.php 2021-11-14 15:51:15 UTC (rev 13150)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2868,16 +2868,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $r Parsed function arguments.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Arguments passed to the function.
</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_activity_id', BP_Activity_Activity::get_id(
- $r['user_id'],
- $r['component'],
- $r['type'],
- $r['item_id'],
- $r['secondary_item_id'],
- $r['action'],
- $r['content'],
- $r['date_recorded']
- ), $r, $args );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return apply_filters( 'bp_activity_get_activity_id', BP_Activity_Activity::get_id( $r ), $r, $args );
</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></pre></div>
<a id="trunksrcbpactivityclassesclassbpactivityactivityphp"></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/classes/class-bp-activity-activity.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-activity/classes/class-bp-activity-activity.php 2021-11-14 15:16:38 UTC (rev 13149)
+++ trunk/src/bp-activity/classes/class-bp-activity-activity.php 2021-11-14 15:51:15 UTC (rev 13150)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1190,61 +1190,105 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Get the first activity ID that matches a set of criteria.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.2.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 10.0.0 Parameters were made optional.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @todo Should parameters be optional?
- *
- * @param int $user_id User ID to filter by.
- * @param string $component Component to filter by.
- * @param string $type Activity type to filter by.
- * @param int $item_id Associated item to filter by.
- * @param int $secondary_item_id Secondary associated item to filter by.
- * @param string $action Action to filter by.
- * @param string $content Content to filter by.
- * @param string $date_recorded Date to filter by.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args {
+ * An array of arguments. All items are optional.
+ * @type int $user_id User ID to filter by.
+ * @type string $component Component to filter by.
+ * @type string $type Activity type to filter by.
+ * @type int $item_id Associated item to filter by.
+ * @type int $secondary_item_id Secondary associated item to filter by.
+ * @type string $action Action to filter by.
+ * @type string $content Content to filter by.
+ * @type string $date_recorded Date to filter by.
+ * }
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return int|false Activity ID on success, false if none is found.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public static function get_id( $user_id, $component, $type, $item_id, $secondary_item_id, $action, $content, $date_recorded ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public static function get_id( $args = array() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $bp = buddypress();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $function_args = func_get_args();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Backward compatibility with old method of passing arguments.
+ if ( ! is_array( $args ) || count( $function_args ) > 1 ) {
+ _deprecated_argument(
+ __METHOD__,
+ '10.0.0',
+ sprintf(
+ /* translators: 1: the name of the method. 2: the name of the file. */
+ esc_html__( 'Arguments passed to %1$s should be in an associative array. See the inline documentation at %2$s for more details.', 'buddypress' ),
+ __METHOD__,
+ __FILE__
+ )
+ );
+
+ $old_args_keys = array(
+ 0 => 'user_id',
+ 1 => 'component',
+ 2 => 'type',
+ 3 => 'item_id',
+ 4 => 'secondary_item_id',
+ 5 => 'action',
+ 6 => 'content',
+ 7 => 'date_recorded',
+ );
+
+ $args = bp_core_parse_args_array( $old_args_keys, $function_args );
+ }
+
+ $r = bp_parse_args(
+ $args,
+ array(
+ 'user_id' => false,
+ 'component' => false,
+ 'type' => false,
+ 'item_id' => false,
+ 'secondary_item_id' => false,
+ 'action' => false,
+ 'content' => false,
+ 'date_recorded' => false,
+ )
+ );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $where_args = false;
</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 ( ! empty( $user_id ) ) {
- $where_args[] = $wpdb->prepare( "user_id = %d", $user_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $r['user_id'] ) ) {
+ $where_args[] = $wpdb->prepare( 'user_id = %d', $r['user_id'] );
</ins><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">- if ( ! empty( $component ) ) {
- $where_args[] = $wpdb->prepare( "component = %s", $component );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $r['component'] ) ) {
+ $where_args[] = $wpdb->prepare( 'component = %s', $r['component'] );
</ins><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">- if ( ! empty( $type ) ) {
- $where_args[] = $wpdb->prepare( "type = %s", $type );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $r['type'] ) ) {
+ $where_args[] = $wpdb->prepare( 'type = %s', $r['type'] );
</ins><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">- if ( ! empty( $item_id ) ) {
- $where_args[] = $wpdb->prepare( "item_id = %d", $item_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $r['item_id'] ) ) {
+ $where_args[] = $wpdb->prepare( 'item_id = %d', $r['item_id'] );
</ins><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">- if ( ! empty( $secondary_item_id ) ) {
- $where_args[] = $wpdb->prepare( "secondary_item_id = %d", $secondary_item_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $r['secondary_item_id'] ) ) {
+ $where_args[] = $wpdb->prepare( 'secondary_item_id = %d', $r['secondary_item_id'] );
</ins><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">- if ( ! empty( $action ) ) {
- $where_args[] = $wpdb->prepare( "action = %s", $action );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $r['action'] ) ) {
+ $where_args[] = $wpdb->prepare( 'action = %s', $r['action'] );
</ins><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">- if ( ! empty( $content ) ) {
- $where_args[] = $wpdb->prepare( "content = %s", $content );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $r['content'] ) ) {
+ $where_args[] = $wpdb->prepare( 'content = %s', $r['content'] );
</ins><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">- if ( ! empty( $date_recorded ) ) {
- $where_args[] = $wpdb->prepare( "date_recorded = %s", $date_recorded );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $r['date_recorded'] ) ) {
+ $where_args[] = $wpdb->prepare( 'date_recorded = %s', $r['date_recorded'] );
</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"> if ( ! empty( $where_args ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $bp = buddypress();
</ins><span class="cx" style="display: block; padding: 0 10px"> $where_sql = 'WHERE ' . join( ' AND ', $where_args );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $result = $wpdb->get_var( "SELECT id FROM {$bp->activity->table_name} {$where_sql}" );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $result = $wpdb->get_var( "SELECT id FROM {$bp->activity->table_name} {$where_sql}" );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return is_numeric( $result ) ? (int) $result : false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestcasesactivityclassBP_Activity_Activityphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/activity/class.BP_Activity_Activity.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/activity/class.BP_Activity_Activity.php 2021-11-14 15:16:38 UTC (rev 13149)
+++ trunk/tests/phpunit/testcases/activity/class.BP_Activity_Activity.php 2021-11-14 15:51:15 UTC (rev 13150)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -464,13 +464,34 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'item_id' => 1888,
</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">- $activity = BP_Activity_Activity::get_id( false, false, false, 523, false, false, false, false );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $args = array(
+ 'item_id' => 523,
+ );
+
+ $activity = BP_Activity_Activity::get_id( $args );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $a1, $activity );
</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><span class="cx" style="display: block; padding: 0 10px"> * @group get_id
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @group BP8596
+ * @expectedDeprecated BP_Activity_Activity::get_id
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_get_id_with_deprecated_args() {
+ $a1 = self::factory()->activity->create( array(
+ 'item_id' => 573,
+ ) );
+ $a2 = self::factory()->activity->create( array(
+ 'item_id' => 1098,
+ ) );
+
+ $activity = BP_Activity_Activity::get_id( false, false, false, 1098, false, false, false, false );
+ $this->assertEquals( $a2, $activity );
+ }
+
+ /**
+ * @group get_id
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_get_id_with_secondary_item_id() {
</span><span class="cx" style="display: block; padding: 0 10px"> $a1 = self::factory()->activity->create( array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'secondary_item_id' => 523,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -479,7 +500,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'secondary_content' => 1888,
</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">- $activity = BP_Activity_Activity::get_id( false, false, false, false, 523, false, false, false );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $args = array(
+ 'secondary_item_id' => 523,
+ );
+
+ $activity = BP_Activity_Activity::get_id( $args );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $a1, $activity );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>