<!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][8319] trunk/bp-members: Improve inline documentation in Members component.</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/8319">8319</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2014-04-24 21:59:14 +0000 (Thu, 24 Apr 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Improve inline documentation in Members component. See <a href="http://buddypress.trac.wordpress.org/ticket/5022">#5022</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpmembersbpmembersloaderphp">trunk/bp-members/bp-members-loader.php</a></li>
<li><a href="#trunkbpmembersbpmembersnotificationsphp">trunk/bp-members/bp-members-notifications.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpmembersbpmembersloaderphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-members/bp-members-loader.php (8318 => 8319)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-members/bp-members-loader.php 2014-04-24 21:59:12 UTC (rev 8318)
+++ trunk/bp-members/bp-members-loader.php 2014-04-24 21:59:14 UTC (rev 8319)
</span><span class="lines">@@ -2,8 +2,6 @@
</span><span class="cx"> /**
</span><span class="cx"> * BuddyPress Member Loader
</span><span class="cx"> *
</span><del>- * A members component to help contain all of the user specific slugs
- *
</del><span class="cx"> * @package BuddyPress
</span><span class="cx"> * @subpackage Members
</span><span class="cx"> */
</span><span class="lines">@@ -14,9 +12,9 @@
</span><span class="cx"> class BP_Members_Component extends BP_Component {
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Start the members component creation process
</del><ins>+ * Start the members component creation process.
</ins><span class="cx"> *
</span><del>- * @since BuddyPress (1.5)
</del><ins>+ * @since BuddyPress (1.5.0)
</ins><span class="cx"> */
</span><span class="cx"> public function __construct() {
</span><span class="cx"> parent::start(
</span><span class="lines">@@ -30,9 +28,11 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Include files
</del><ins>+ * Include bp-members files.
</ins><span class="cx"> *
</span><del>- * @global BuddyPress $bp The one true BuddyPress instance
</del><ins>+ * @see BP_Component::includes() for description of parameters.
+ *
+ * @param array $includes See {@link BP_Component::includes()}.
</ins><span class="cx"> */
</span><span class="cx"> public function includes( $includes = array() ) {
</span><span class="cx"> $includes = array(
</span><span class="lines">@@ -55,12 +55,16 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Setup globals
</del><ins>+ * Set up bp-members global settings.
</ins><span class="cx"> *
</span><span class="cx"> * The BP_MEMBERS_SLUG constant is deprecated, and only used here for
</span><span class="cx"> * backwards compatibility.
</span><span class="cx"> *
</span><del>- * @since BuddyPress (1.5)
</del><ins>+ * @since BuddyPress (1.5.0)
+ *
+ * @see BP_Component::setup_globals() for description of parameters.
+ *
+ * @param array $args See {@link BP_Component::setup_globals()}.
</ins><span class="cx"> */
</span><span class="cx"> public function setup_globals( $args = array() ) {
</span><span class="cx"> $bp = buddypress();
</span><span class="lines">@@ -167,7 +171,16 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Setup BuddyBar navigation
</del><ins>+ * Set up component navigation.
+ *
+ * @since BuddyPress (1.5.0)
+ *
+ * @see BP_Component::setup_nav() for a description of arguments.
+ *
+ * @param array $main_nav Optional. See BP_Component::setup_nav() for
+ * description.
+ * @param array $sub_nav Optional. See BP_Component::setup_nav() for
+ * description.
</ins><span class="cx"> */
</span><span class="cx"> public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
</span><span class="cx"> $bp = buddypress();
</span><span class="lines">@@ -208,9 +221,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Sets up the title for pages and <title>
- *
- * @global BuddyPress $bp The one true BuddyPress instance
</del><ins>+ * Set up the title for pages and <title>.
</ins><span class="cx"> */
</span><span class="cx"> public function setup_title() {
</span><span class="cx"> $bp = buddypress();
</span><span class="lines">@@ -230,6 +241,9 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+/**
+ * Set up the bp-members component.
+ */
</ins><span class="cx"> function bp_setup_members() {
</span><span class="cx"> buddypress()->members = new BP_Members_Component();
</span><span class="cx"> }
</span></span></pre></div>
<a id="trunkbpmembersbpmembersnotificationsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-members/bp-members-notifications.php (8318 => 8319)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-members/bp-members-notifications.php 2014-04-24 21:59:12 UTC (rev 8318)
+++ trunk/bp-members/bp-members-notifications.php 2014-04-24 21:59:14 UTC (rev 8319)
</span><span class="lines">@@ -14,12 +14,12 @@
</span><span class="cx"> if ( !defined( 'ABSPATH' ) ) exit;
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Add a notification for a specific user, from a specific component
</del><ins>+ * Add a notification for a specific user, from a specific component.
</ins><span class="cx"> *
</span><span class="cx"> * @deprecated Deprecated since BuddyPress 1.9.0. Use
</span><del>- * bp_notifications_add_notification() instead.
</del><ins>+ * bp_notifications_add_notification() instead.
</ins><span class="cx"> *
</span><del>- * @since BuddyPress (1.0)
</del><ins>+ * @since BuddyPress (1.0.0)
</ins><span class="cx"> * @param string $item_id
</span><span class="cx"> * @param int $user_id
</span><span class="cx"> * @param string $component_name
</span><span class="lines">@@ -27,7 +27,7 @@
</span><span class="cx"> * @param string $secondary_item_id
</span><span class="cx"> * @param string $date_notified
</span><span class="cx"> * @param int $is_new
</span><del>- * @return boolean True on success, false on fail
</del><ins>+ * @return boolean True on success, false on failure.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_add_notification( $item_id, $user_id, $component_name, $component_action, $secondary_item_id = 0, $date_notified = false, $is_new = 1 ) {
</span><span class="cx">
</span><span class="lines">@@ -57,14 +57,14 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Delete a specific notification by its ID
</del><ins>+ * Delete a specific notification by its ID.
</ins><span class="cx"> *
</span><span class="cx"> * @deprecated Deprecated since BuddyPress 1.9.0. Use
</span><del>- * bp_notifications_delete_notification() instead.
</del><ins>+ * bp_notifications_delete_notification() instead.
</ins><span class="cx"> *
</span><del>- * @since BuddyPress (1.0)
- * @param int $id
- * @return boolean True on success, false on fail
</del><ins>+ * @since BuddyPress (1.0.0)
+ * @param int $id ID of notification.
+ * @return boolean True on success, false on failure.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_delete_notification( $id ) {
</span><span class="cx">
</span><span class="lines">@@ -80,13 +80,13 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Get a specific notification by its ID
</del><ins>+ * Get a specific notification by its ID.
</ins><span class="cx"> *
</span><span class="cx"> * @deprecated Deprecated since BuddyPress 1.9.0. Use
</span><del>- * bp_notifications_get_notification() instead.
</del><ins>+ * bp_notifications_get_notification() instead.
</ins><span class="cx"> *
</span><del>- * @since BuddyPress (1.0)
- * @param int $id
</del><ins>+ * @since BuddyPress (1.0.0)
+ * @param int $id ID of notification.
</ins><span class="cx"> * @return BP_Core_Notification
</span><span class="cx"> */
</span><span class="cx"> function bp_core_get_notification( $id ) {
</span><span class="lines">@@ -103,16 +103,15 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Get notifications for a specific user
</del><ins>+ * Get notifications for a specific user.
</ins><span class="cx"> *
</span><span class="cx"> * @deprecated Deprecated since BuddyPress 1.9.0. Use
</span><del>- * bp_notifications_get_notifications_for_user() instead.
</del><ins>+ * bp_notifications_get_notifications_for_user() instead.
</ins><span class="cx"> *
</span><del>- * @since BuddyPress (1.0)
- * @global BuddyPress $bp
- * @param int $user_id
</del><ins>+ * @since BuddyPress (1.0.0)
+ * @param int $user_id ID of user.
</ins><span class="cx"> * @param string $format
</span><del>- * @return boolean Object or array on success, false on fail
</del><ins>+ * @return boolean Object or array on success, false on failure.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_get_notifications_for_user( $user_id, $format = 'string' ) {
</span><span class="cx">
</span><span class="lines">@@ -132,19 +131,19 @@
</span><span class="cx"> /** Delete ********************************************************************/
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Delete notifications for a user by type
</del><ins>+ * Delete notifications for a user by type.
</ins><span class="cx"> *
</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><span class="cx"> * @deprecated Deprecated since BuddyPress 1.9.0. Use
</span><del>- * bp_notifications_delete_notifications_by_type() instead.
</del><ins>+ * bp_notifications_delete_notifications_by_type() instead.
</ins><span class="cx"> *
</span><del>- * @since BuddyPress (1.0)
</del><ins>+ * @since BuddyPress (1.0.0)
</ins><span class="cx"> * @param int $user_id
</span><span class="cx"> * @param string $component_name
</span><span class="cx"> * @param string $component_action
</span><del>- * @return boolean True on success, false on fail
</del><ins>+ * @return boolean True on success, false on failure.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_delete_notifications_by_type( $user_id, $component_name, $component_action ) {
</span><span class="cx">
</span><span class="lines">@@ -160,19 +159,19 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Delete notifications for an item ID
</del><ins>+ * Delete notifications for an item ID.
</ins><span class="cx"> *
</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><span class="cx"> * @deprecated Deprecated since BuddyPress 1.9.0. Use
</span><del>- * bp_notifications_delete_notifications_by_item_id() instead.
</del><ins>+ * bp_notifications_delete_notifications_by_item_id() instead.
</ins><span class="cx"> *
</span><del>- * @since BuddyPress (1.0)
</del><ins>+ * @since BuddyPress (1.0.0)
</ins><span class="cx"> * @param int $user_id
</span><span class="cx"> * @param string $component_name
</span><span class="cx"> * @param string $component_action
</span><del>- * @return boolean True on success, false on fail
</del><ins>+ * @return boolean True on success, false on failure.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_delete_notifications_by_item_id( $user_id, $item_id, $component_name, $component_action, $secondary_item_id = false ) {
</span><span class="cx">
</span><span class="lines">@@ -188,16 +187,16 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Delete all notifications for by type
</del><ins>+ * Delete all notifications for by type.
</ins><span class="cx"> *
</span><span class="cx"> * @deprecated Deprecated since BuddyPress 1.9.0. Use
</span><del>- * bp_notifications_delete_all_notifications_by_type() instead.
</del><ins>+ * bp_notifications_delete_all_notifications_by_type() instead.
</ins><span class="cx"> *
</span><del>- * @since BuddyPress (1.0)
</del><ins>+ * @since BuddyPress (1.0.0)
</ins><span class="cx"> * @param int $user_id
</span><span class="cx"> * @param string $component_name
</span><span class="cx"> * @param string $component_action
</span><del>- * @return boolean True on success, false on fail
</del><ins>+ * @return boolean True on success, false on failure.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_delete_all_notifications_by_type( $item_id, $component_name, $component_action = false, $secondary_item_id = false ) {
</span><span class="cx">
</span><span class="lines">@@ -213,18 +212,18 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Delete all notifications for a user
</del><ins>+ * Delete all notifications for a user.
</ins><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><span class="cx"> * @deprecated Deprecated since BuddyPress 1.9.0. Use
</span><del>- * bp_notifications_delete_notifications_from_user() instead.
</del><ins>+ * bp_notifications_delete_notifications_from_user() instead.
</ins><span class="cx"> *
</span><del>- * @since BuddyPress (1.0)
</del><ins>+ * @since BuddyPress (1.0.0)
</ins><span class="cx"> * @param int $user_id
</span><span class="cx"> * @param string $component_name
</span><span class="cx"> * @param string $component_action
</span><del>- * @return boolean True on success, false on fail
</del><ins>+ * @return boolean True on success, false on failure.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_delete_notifications_from_user( $user_id, $component_name, $component_action ) {
</span><span class="cx">
</span><span class="lines">@@ -242,17 +241,17 @@
</span><span class="cx"> /** Helpers *******************************************************************/
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Check if a user has access to a specific notification
</del><ins>+ * Check if a user has access to a specific notification.
</ins><span class="cx"> *
</span><del>- * Used before deleting a notification for a user
</del><ins>+ * Used before deleting a notification for a user.
</ins><span class="cx"> *
</span><span class="cx"> * @deprecated Deprecated since BuddyPress 1.9.0. Use
</span><del>- * bp_notifications_check_notification_access() instead.
</del><ins>+ * bp_notifications_check_notification_access() instead.
</ins><span class="cx"> *
</span><del>- * @since BuddyPress (1.0)
</del><ins>+ * @since BuddyPress (1.0.0)
</ins><span class="cx"> * @param int $user_id
</span><span class="cx"> * @param int $notification_id
</span><del>- * @return boolean True on success, false on fail
</del><ins>+ * @return boolean True on success, false on failure.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_check_notification_access( $user_id, $notification_id ) {
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>