<!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][7627] trunk/bp-members/bp-members-notifications.php: Add deprecated notices to Core notifications functions.</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/7627">7627</a></dd>
<dt>Author</dt> <dd>johnjamesjacoby</dd>
<dt>Date</dt> <dd>2013-11-30 06:39:07 +0000 (Sat, 30 Nov 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add deprecated notices to Core notifications functions. Hat-tip boonebgorges, r-a-y. See <a href="http://buddypress.trac.wordpress.org/ticket/5266">#5266</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpmembersbpmembersnotificationsphp">trunk/bp-members/bp-members-notifications.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpmembersbpmembersnotificationsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-members/bp-members-notifications.php (7626 => 7627)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-members/bp-members-notifications.php 2013-11-30 06:35:17 UTC (rev 7626)
+++ trunk/bp-members/bp-members-notifications.php 2013-11-30 06:39:07 UTC (rev 7627)
</span><span class="lines">@@ -16,6 +16,9 @@
</span><span class="cx"> /**
</span><span class="cx"> * Add a notification for a specific user, from a specific component
</span><span class="cx"> *
</span><ins>+ * @deprecated Deprecated since BuddyPress 1.9.0. Use
+ * bp_notifications_add_notification() instead.
+ *
</ins><span class="cx"> * @since BuddyPress (1.0)
</span><span class="cx"> * @param string $item_id
</span><span class="cx"> * @param int $user_id
</span><span class="lines">@@ -33,6 +36,9 @@
</span><span class="cx"> return false;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ // Trigger the deprecated function notice
+ _deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_add_notification()' );
+
</ins><span class="cx"> // Notifications must always have a time
</span><span class="cx"> if ( false === $date_notified ) {
</span><span class="cx"> $date_notified = bp_core_current_time();
</span><span class="lines">@@ -53,6 +59,9 @@
</span><span class="cx"> /**
</span><span class="cx"> * Delete a specific notification by its ID
</span><span class="cx"> *
</span><ins>+ * @deprecated Deprecated since BuddyPress 1.9.0. Use
+ * bp_notifications_delete_notification() instead.
+ *
</ins><span class="cx"> * @since BuddyPress (1.0)
</span><span class="cx"> * @param int $id
</span><span class="cx"> * @return boolean True on success, false on fail
</span><span class="lines">@@ -64,12 +73,18 @@
</span><span class="cx"> return false;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ // Trigger the deprecated function notice
+ _deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_delete_notification()' );
+
</ins><span class="cx"> return BP_Notifications_Notification::delete_by_id( $id );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="cx"> * Get a specific notification by its ID
</span><span class="cx"> *
</span><ins>+ * @deprecated Deprecated since BuddyPress 1.9.0. Use
+ * bp_notifications_get_notification() instead.
+ *
</ins><span class="cx"> * @since BuddyPress (1.0)
</span><span class="cx"> * @param int $id
</span><span class="cx"> * @return BP_Core_Notification
</span><span class="lines">@@ -81,12 +96,18 @@
</span><span class="cx"> return false;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ // Trigger the deprecated function notice
+ _deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_get_notification()' );
+
</ins><span class="cx"> return bp_notifications_get_notification( $id );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="cx"> * Get notifications for a specific user
</span><span class="cx"> *
</span><ins>+ * @deprecated Deprecated since BuddyPress 1.9.0. Use
+ * bp_notifications_get_notifications_for_user() instead.
+ *
</ins><span class="cx"> * @since BuddyPress (1.0)
</span><span class="cx"> * @global BuddyPress $bp
</span><span class="cx"> * @param int $user_id
</span><span class="lines">@@ -100,6 +121,9 @@
</span><span class="cx"> return false;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ // Trigger the deprecated function notice
+ _deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_get_notifications_for_user()' );
+
</ins><span class="cx"> $renderable = bp_notifications_get_notifications_for_user( $user_id, $format );
</span><span class="cx">
</span><span class="cx"> return apply_filters( 'bp_core_get_notifications_for_user', $renderable, $user_id, $format );
</span><span class="lines">@@ -113,6 +137,9 @@
</span><span class="cx"> * Used when clearing out notifications for a specific component when the user
</span><span class="cx"> * has visited that component.
</span><span class="cx"> *
</span><ins>+ * @deprecated Deprecated since BuddyPress 1.9.0. Use
+ * bp_notifications_delete_notifications_by_type() instead.
+ *
</ins><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">@@ -126,6 +153,9 @@
</span><span class="cx"> return false;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ // Trigger the deprecated function notice
+ _deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_delete_notifications_by_type()' );
+
</ins><span class="cx"> return bp_notifications_delete_notifications_by_type( $user_id, $component_name, $component_action );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -135,6 +165,9 @@
</span><span class="cx"> * Used when clearing out notifications for a specific component when the user
</span><span class="cx"> * has visited that component.
</span><span class="cx"> *
</span><ins>+ * @deprecated Deprecated since BuddyPress 1.9.0. Use
+ * bp_notifications_delete_notifications_by_item_id() instead.
+ *
</ins><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">@@ -148,12 +181,18 @@
</span><span class="cx"> return false;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ // Trigger the deprecated function notice
+ _deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_delete_notifications_by_item_id()' );
+
</ins><span class="cx"> return bp_notifications_delete_notifications_by_item_id( $user_id, $item_id, $component_name, $component_action, $secondary_item_id );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="cx"> * Delete all notifications for by type
</span><span class="cx"> *
</span><ins>+ * @deprecated Deprecated since BuddyPress 1.9.0. Use
+ * bp_notifications_delete_all_notifications_by_type() instead.
+ *
</ins><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">@@ -167,6 +206,9 @@
</span><span class="cx"> return false;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ // Trigger the deprecated function notice
+ _deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_delete_all_notifications_by_type()' );
+
</ins><span class="cx"> bp_notifications_delete_all_notifications_by_type( $item_id, $component_name, $component_action, $secondary_item_id );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -175,6 +217,9 @@
</span><span class="cx"> *
</span><span class="cx"> * Used when clearing out all notifications for a user, whene deleted or spammed
</span><span class="cx"> *
</span><ins>+ * @deprecated Deprecated since BuddyPress 1.9.0. Use
+ * bp_notifications_delete_notifications_from_user() instead.
+ *
</ins><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">@@ -188,97 +233,12 @@
</span><span class="cx"> return false;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ // Trigger the deprecated function notice
+ _deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_delete_notifications_from_user()' );
+
</ins><span class="cx"> return bp_notifications_delete_notifications_from_user( $user_id, $component_name, $component_action );
</span><span class="cx"> }
</span><span class="cx">
</span><del>-/** Mark **********************************************************************/
-
-/**
- * Delete notifications for a user by type
- *
- * Used when clearing out notifications for a specific component when the user
- * has visited that component.
- *
- * @since BuddyPress (1.9.0)
- * @param int $user_id
- * @param string $component_name
- * @param string $component_action
- * @param int $is_new
- * @return boolean True on success, false on fail
- */
-function bp_core_mark_notifications_by_type( $user_id, $component_name, $component_action, $is_new = false ) {
-
- // Bail if notifications is not active
- if ( ! bp_is_active( 'notifications' ) ) {
- return false;
- }
-
- return bp_notifications_mark_notifications_by_type( $user_id, $component_name, $component_action, $is_new );
-}
-
-/**
- * Delete notifications for an item ID
- *
- * Used when clearing out notifications for a specific component when the user
- * has visited that component.
- *
- * @since BuddyPress (1.9.0)
- * @param int $user_id
- * @param string $component_name
- * @param string $component_action
- * @param int $is_new
- * @return boolean True on success, false on fail
- */
-function bp_core_mark_notifications_by_item_id( $user_id, $item_id, $component_name, $component_action, $secondary_item_id = false, $is_new = false ) {
-
- // Bail if notifications is not active
- if ( ! bp_is_active( 'notifications' ) ) {
- return false;
- }
-
- return bp_notifications_mark_notifications_by_item_id( $user_id, $item_id, $component_name, $component_action, $secondary_item_id, $is_new );
-}
-
-/**
- * Mark all notifications read/unread for by type
- *
- * Used when clearing out notifications for an entire component
- *
- * @since BuddyPress (1.9.0)
- * @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 );
-}
-
-/**
- * Mark all notifications read/unread from a user
- *
- * @since BuddyPress (1.9.0)
- * @param int $user_id
- * @param string $component_name
- * @param string $component_action
- * @return boolean True on success, false on fail
- */
-function bp_core_mark_notifications_from_user( $user_id, $component_name, $component_action, $is_new = false ) {
-
- // Bail if notifications is not active
- if ( ! bp_is_active( 'notifications' ) ) {
- return false;
- }
-
- return bp_notifications_mark_notifications_from_user( $user_id, $component_name, $component_action, $is_new );
-}
-
</del><span class="cx"> /** Helpers *******************************************************************/
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -286,6 +246,9 @@
</span><span class="cx"> *
</span><span class="cx"> * Used before deleting a notification for a user
</span><span class="cx"> *
</span><ins>+ * @deprecated Deprecated since BuddyPress 1.9.0. Use
+ * bp_notifications_check_notification_access() instead.
+ *
</ins><span class="cx"> * @since BuddyPress (1.0)
</span><span class="cx"> * @param int $user_id
</span><span class="cx"> * @param int $notification_id
</span><span class="lines">@@ -298,5 +261,8 @@
</span><span class="cx"> return false;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ // Trigger the deprecated function notice
+ _deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_check_notification_access()' );
+
</ins><span class="cx"> return bp_notifications_check_notification_access( $user_id, $notification_id );
</span><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>