<!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][7529] trunk: Introduce `bp_core_mark_all_notifications_by_type()` and replace `bp_core_delete_all_notifications_by_type()` usages.</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">
<dt>Revision</dt> <dd><a href="http://buddypress.trac.wordpress.org/changeset/7529">7529</a></dd>
<dt>Author</dt> <dd>johnjamesjacoby</dd>
<dt>Date</dt> <dd>2013-11-08 05:09:31 +0000 (Fri, 08 Nov 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Introduce `bp_core_mark_all_notifications_by_type()` and replace `bp_core_delete_all_notifications_by_type()` usages. Ensures notifications are toggled as acknowledged rather than deleted. See <a href="http://buddypress.trac.wordpress.org/ticket/5148">#5148</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpactivitybpactivityscreensphp">trunk/bp-activity/bp-activity-screens.php</a></li>
<li><a href="#trunkbpfriendsbpfriendscachephp">trunk/bp-friends/bp-friends-cache.php</a></li>
<li><a href="#trunkbpfriendsbpfriendsscreensphp">trunk/bp-friends/bp-friends-screens.php</a></li>
<li><a href="#trunkbpgroupsbpgroupsscreensphp">trunk/bp-groups/bp-groups-screens.php</a></li>
<li><a href="#trunkbpmembersbpmembersnotificationsphp">trunk/bp-members/bp-members-notifications.php</a></li>
<li><a href="#trunkbpnotificationsbpnotificationsfunctionsphp">trunk/bp-notifications/bp-notifications-functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpactivitybpactivityscreensphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-activity/bp-activity-screens.php (7528 => 7529)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-activity/bp-activity-screens.php 2013-11-08 04:52:07 UTC (rev 7528)
+++ trunk/bp-activity/bp-activity-screens.php 2013-11-08 05:09:31 UTC (rev 7529)
</span><span class="lines">@@ -133,13 +133,10 @@
</span><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.5)
</span><span class="cx"> *
</span><del>- * @global object $bp BuddyPress global settings
- * @uses bp_core_delete_notifications_by_type()
</del><ins>+ * @uses bp_core_mark_all_notifications_by_type()
</ins><span class="cx"> */
</span><span class="cx"> function bp_activity_remove_screen_notifications() {
</span><del>- global $bp;
-
- bp_core_delete_notifications_by_type( bp_loggedin_user_id(), $bp->activity->id, 'new_at_mention' );
</del><ins>+ bp_core_mark_all_notifications_by_type( bp_loggedin_user_id(), buddypress()->activity->id, 'new_at_mention' );
</ins><span class="cx"> }
</span><span class="cx"> add_action( 'bp_activity_screen_my_activity', 'bp_activity_remove_screen_notifications' );
</span><span class="cx"> add_action( 'bp_activity_screen_single_activity_permalink', 'bp_activity_remove_screen_notifications' );
</span></span></pre></div>
<a id="trunkbpfriendsbpfriendscachephp"></a>
<div class="modfile"><h4>Modified: trunk/bp-friends/bp-friends-cache.php (7528 => 7529)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-friends/bp-friends-cache.php 2013-11-08 04:52:07 UTC (rev 7528)
+++ trunk/bp-friends/bp-friends-cache.php 2013-11-08 05:09:31 UTC (rev 7529)
</span><span class="lines">@@ -23,10 +23,9 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> function friends_clear_friend_notifications() {
</span><del>- global $bp;
-
- if ( isset( $_GET['new'] ) )
- bp_core_delete_notifications_by_type( bp_loggedin_user_id(), $bp->friends->id, 'friendship_accepted' );
</del><ins>+ if ( isset( $_GET['new'] ) ) {
+ bp_core_mark_all_notifications_by_type( bp_loggedin_user_id(), buddypress()->friends->id, 'friendship_accepted' );
+ }
</ins><span class="cx"> }
</span><span class="cx"> add_action( 'bp_activity_screen_my_activity', 'friends_clear_friend_notifications' );
</span><span class="cx">
</span></span></pre></div>
<a id="trunkbpfriendsbpfriendsscreensphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-friends/bp-friends-screens.php (7528 => 7529)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-friends/bp-friends-screens.php 2013-11-08 04:52:07 UTC (rev 7528)
+++ trunk/bp-friends/bp-friends-screens.php 2013-11-08 05:09:31 UTC (rev 7529)
</span><span class="lines">@@ -15,10 +15,9 @@
</span><span class="cx"> if ( !defined( 'ABSPATH' ) ) exit;
</span><span class="cx">
</span><span class="cx"> function friends_screen_my_friends() {
</span><del>- global $bp;
</del><span class="cx">
</span><span class="cx"> // Delete any friendship acceptance notifications for the user when viewing a profile
</span><del>- bp_core_delete_notifications_by_type( bp_loggedin_user_id(), $bp->friends->id, 'friendship_accepted' );
</del><ins>+ bp_core_mark_all_notifications_by_type( bp_loggedin_user_id(), buddypress()->friends->id, 'friendship_accepted' );
</ins><span class="cx">
</span><span class="cx"> do_action( 'friends_screen_my_friends' );
</span><span class="cx">
</span><span class="lines">@@ -62,8 +61,9 @@
</span><span class="cx">
</span><span class="cx"> do_action( 'friends_screen_requests' );
</span><span class="cx">
</span><del>- if ( isset( $_GET['new'] ) )
- bp_core_delete_notifications_by_type( bp_loggedin_user_id(), 'friends', 'friendship_request' );
</del><ins>+ if ( isset( $_GET['new'] ) ) {
+ bp_core_mark_all_notifications_by_type( bp_loggedin_user_id(), buddypress()->friends->id, 'friendship_request' );
+ }
</ins><span class="cx">
</span><span class="cx"> bp_core_load_template( apply_filters( 'friends_template_requests', 'members/single/home' ) );
</span><span class="cx"> }
</span></span></pre></div>
<a id="trunkbpgroupsbpgroupsscreensphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-groups/bp-groups-screens.php (7528 => 7529)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-groups/bp-groups-screens.php 2013-11-08 04:52:07 UTC (rev 7528)
+++ trunk/bp-groups/bp-groups-screens.php 2013-11-08 05:09:31 UTC (rev 7529)
</span><span class="lines">@@ -31,10 +31,10 @@
</span><span class="cx">
</span><span class="cx"> // Delete group request notifications for the user
</span><span class="cx"> if ( isset( $_GET['n'] ) ) {
</span><del>- bp_core_delete_notifications_by_type( bp_loggedin_user_id(), $bp->groups->id, 'membership_request_accepted' );
- bp_core_delete_notifications_by_type( bp_loggedin_user_id(), $bp->groups->id, 'membership_request_rejected' );
- bp_core_delete_notifications_by_type( bp_loggedin_user_id(), $bp->groups->id, 'member_promoted_to_mod' );
- bp_core_delete_notifications_by_type( bp_loggedin_user_id(), $bp->groups->id, 'member_promoted_to_admin' );
</del><ins>+ bp_core_mark_all_notifications_by_type( bp_loggedin_user_id(), $bp->groups->id, 'membership_request_accepted' );
+ bp_core_mark_all_notifications_by_type( bp_loggedin_user_id(), $bp->groups->id, 'membership_request_rejected' );
+ bp_core_mark_all_notifications_by_type( bp_loggedin_user_id(), $bp->groups->id, 'member_promoted_to_mod' );
+ bp_core_mark_all_notifications_by_type( bp_loggedin_user_id(), $bp->groups->id, 'member_promoted_to_admin' );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> do_action( 'groups_screen_my_groups' );
</span><span class="lines">@@ -94,7 +94,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> // Remove notifications
</span><del>- bp_core_delete_notifications_by_type( bp_loggedin_user_id(), 'groups', 'group_invite' );
</del><ins>+ bp_core_mark_all_notifications_by_type( bp_loggedin_user_id(), buddypress()->groups->id, 'group_invite' );
</ins><span class="cx">
</span><span class="cx"> do_action( 'groups_screen_group_invites', $group_id );
</span><span class="cx">
</span><span class="lines">@@ -109,10 +109,10 @@
</span><span class="cx"> $bp = buddypress();
</span><span class="cx">
</span><span class="cx"> if ( isset( $_GET['n'] ) ) {
</span><del>- bp_core_delete_notifications_by_type( bp_loggedin_user_id(), $bp->groups->id, 'membership_request_accepted' );
- bp_core_delete_notifications_by_type( bp_loggedin_user_id(), $bp->groups->id, 'membership_request_rejected' );
- bp_core_delete_notifications_by_type( bp_loggedin_user_id(), $bp->groups->id, 'member_promoted_to_mod' );
- bp_core_delete_notifications_by_type( bp_loggedin_user_id(), $bp->groups->id, 'member_promoted_to_admin' );
</del><ins>+ bp_core_mark_all_notifications_by_type( bp_loggedin_user_id(), $bp->groups->id, 'membership_request_accepted' );
+ bp_core_mark_all_notifications_by_type( bp_loggedin_user_id(), $bp->groups->id, 'membership_request_rejected' );
+ bp_core_mark_all_notifications_by_type( bp_loggedin_user_id(), $bp->groups->id, 'member_promoted_to_mod' );
+ bp_core_mark_all_notifications_by_type( bp_loggedin_user_id(), $bp->groups->id, 'member_promoted_to_admin' );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> do_action( 'groups_screen_group_home' );
</span><span class="lines">@@ -813,7 +813,7 @@
</span><span class="cx"> return false;
</span><span class="cx">
</span><span class="cx"> // Remove any screen notifications
</span><del>- bp_core_delete_notifications_by_type( bp_loggedin_user_id(), $bp->groups->id, 'new_membership_request' );
</del><ins>+ bp_core_mark_all_notifications_by_type( bp_loggedin_user_id(), $bp->groups->id, 'new_membership_request' );
</ins><span class="cx">
</span><span class="cx"> $request_action = (string)bp_action_variable( 1 );
</span><span class="cx"> $membership_id = (int)bp_action_variable( 2 );
</span></span></pre></div>
<a id="trunkbpmembersbpmembersnotificationsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-members/bp-members-notifications.php (7528 => 7529)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-members/bp-members-notifications.php 2013-11-08 04:52:07 UTC (rev 7528)
+++ trunk/bp-members/bp-members-notifications.php 2013-11-08 05:09:31 UTC (rev 7529)
</span><span class="lines">@@ -146,8 +146,6 @@
</span><span class="cx"> /**
</span><span class="cx"> * Delete all notifications for by type
</span><span class="cx"> *
</span><del>- * Used when clearing out notifications for an entire component
- *
</del><span class="cx"> * @since BuddyPress (1.0)
</span><span class="cx"> * @param int $user_id
</span><span class="cx"> * @param string $component_name
</span><span class="lines">@@ -165,6 +163,27 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Mark all notifications read/unread for by type
+ *
+ * Used when clearing out notifications for an entire component
+ *
+ * @since BuddyPress (1.9)
+ * @param int $user_id
+ * @param string $component_name
+ * @param string $component_action
+ * @return boolean True on success, false on fail
+ */
+function bp_core_mark_all_notifications_by_type( $item_id, $component_name, $component_action = false, $secondary_item_id = false, $is_new = false ) {
+
+ // Bail if notifications is not active
+ if ( ! bp_is_active( 'notifications' ) ) {
+ return false;
+ }
+
+ bp_notifications_mark_all_notifications_by_type( $item_id, $component_name, $component_action, $secondary_item_id, $is_new );
+}
+
+/**
</ins><span class="cx"> * Delete all notifications for a user
</span><span class="cx"> *
</span><span class="cx"> * Used when clearing out all notifications for a user, whene deleted or spammed
</span></span></pre></div>
<a id="trunkbpnotificationsbpnotificationsfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-notifications/bp-notifications-functions.php (7528 => 7529)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-notifications/bp-notifications-functions.php 2013-11-08 04:52:07 UTC (rev 7528)
+++ trunk/bp-notifications/bp-notifications-functions.php 2013-11-08 05:09:31 UTC (rev 7529)
</span><span class="lines">@@ -299,12 +299,12 @@
</span><span class="cx"> * @since BuddyPress (1.9.0)
</span><span class="cx"> *
</span><span class="cx"> * @param int $user_id ID of the user whose notifications are being deleted.
</span><del>- * @param int $is_new 0 for read, 1 for unread
</del><span class="cx"> * @param string $component_name Name of the associated component.
</span><span class="cx"> * @param string $component_action Name of the associated action.
</span><ins>+ * @param int $is_new 0 for read, 1 for unread
</ins><span class="cx"> * @return bool True on success, false on failure.
</span><span class="cx"> */
</span><del>-function bp_notifications_mark_notifications_by_type( $user_id, $is_new, $component_name, $component_action ) {
</del><ins>+function bp_notifications_mark_notifications_by_type( $user_id, $component_name, $component_action, $is_new = false ) {
</ins><span class="cx"> return BP_Notifications_Notification::delete( array(
</span><span class="cx"> 'user_id' => $user_id,
</span><span class="cx"> 'component_name' => $component_name,
</span><span class="lines">@@ -323,13 +323,13 @@
</span><span class="cx"> *
</span><span class="cx"> * @param int $user_id ID of the user whose notifications are being deleted.
</span><span class="cx"> * @param int $item_id ID of the associated item.
</span><del>- * @param int $is_new 0 for read, 1 for unread
</del><span class="cx"> * @param string $component_name Name of the associated component.
</span><span class="cx"> * @param string $component_action Name of the associated action.
</span><span class="cx"> * @param int $secondary_item_id ID of the secondary associated item.
</span><ins>+ * @param int $is_new 0 for read, 1 for unread
</ins><span class="cx"> * @return bool True on success, false on failure.
</span><span class="cx"> */
</span><del>-function bp_notifications_mark_notifications_by_item_id( $user_id, $item_id, $is_new, $component_name, $component_action, $secondary_item_id = false ) {
</del><ins>+function bp_notifications_mark_notifications_by_item_id( $user_id, $item_id, $component_name, $component_action, $secondary_item_id = false, $is_new = false ) {
</ins><span class="cx"> return BP_Notifications_Notification::delete( array(
</span><span class="cx"> 'user_id' => $user_id,
</span><span class="cx"> 'item_id' => $item_id,
</span><span class="lines">@@ -352,9 +352,10 @@
</span><span class="cx"> * @param string $component_name Name of the associated component.
</span><span class="cx"> * @param string $component_action Optional. Name of the associated action.
</span><span class="cx"> * @param int $secondary_item_id Optional. ID of the secondary associated item.
</span><ins>+ * @param int $is_new 0 for read, 1 for unread
</ins><span class="cx"> * @return bool True on success, false on failure.
</span><span class="cx"> */
</span><del>-function bp_notifications_mark_all_notifications_by_type( $item_id, $is_new, $component_name, $component_action = false, $secondary_item_id = false ) {
</del><ins>+function bp_notifications_mark_all_notifications_by_type( $item_id, $component_name, $component_action = false, $secondary_item_id = false, $is_new = false ) {
</ins><span class="cx"> return BP_Notifications_Notification::delete( array(
</span><span class="cx"> 'item_id' => $item_id,
</span><span class="cx"> 'secondary_item_id' => $secondary_item_id,
</span><span class="lines">@@ -379,9 +380,10 @@
</span><span class="cx"> * @param int $is_new 0 for read, 1 for unread
</span><span class="cx"> * @param string $component_name Name of the associated component.
</span><span class="cx"> * @param string $component_action Name of the associated action.
</span><ins>+ * @param int $is_new 0 for read, 1 for unread
</ins><span class="cx"> * @return bool True on success, false on failure.
</span><span class="cx"> */
</span><del>-function bp_notifications_mark_notifications_from_user( $user_id, $is_new, $component_name, $component_action ) {
</del><ins>+function bp_notifications_mark_notifications_from_user( $user_id, $component_name, $component_action, $is_new = false ) {
</ins><span class="cx"> return BP_Notifications_Notification::delete( array(
</span><span class="cx"> 'item_id' => $user_id,
</span><span class="cx"> 'component_name' => $component_name,
</span></span></pre>
</div>
</div>
</body>
</html>