<!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][8481] trunk/src/bp-messages: Improve inline documentation in bp-messages.</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/8481">8481</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2014-06-07 23:47:51 +0000 (Sat, 07 Jun 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Improve inline documentation in bp-messages.
See <a href="http://buddypress.trac.wordpress.org/ticket/5022">#5022</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpmessagesbpmessagesfunctionsphp">trunk/src/bp-messages/bp-messages-functions.php</a></li>
<li><a href="#trunksrcbpmessagesbpmessagesloaderphp">trunk/src/bp-messages/bp-messages-loader.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpmessagesbpmessagesfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/src/bp-messages/bp-messages-functions.php (8480 => 8481)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/bp-messages/bp-messages-functions.php 2014-06-07 22:09:36 UTC (rev 8480)
+++ trunk/src/bp-messages/bp-messages-functions.php 2014-06-07 23:47:51 UTC (rev 8481)
</span><span class="lines">@@ -15,6 +15,27 @@
</span><span class="cx"> // Exit if accessed directly
</span><span class="cx"> if ( !defined( 'ABSPATH' ) ) exit;
</span><span class="cx">
</span><ins>+/**
+ * Create a new message.
+ *
+ * @param array $args {
+ * Array of arguments.
+ * @type int $sender_id Optional. ID of the user who is sending the
+ * message. Default: ID of the logged-in user.
+ * @type int $thread_id Optional. ID of the parent thread. Leave blank to
+ * create a new thread for the message.
+ * @type array $recipients IDs or usernames of message recipients. If this
+ * is an existing thread, it is unnecessary to pass a $recipients
+ * argument - existing thread recipients will be assumed.
+ * @type string $subject Optional. Subject line for the message. For
+ * existing threads, the existing subject will be used. For new
+ * threads, 'No Subject' will be used if no $subject is provided.
+ * @type string $content Content of the message. Cannot be empty.
+ * @type string $date_sent Date sent, in 'Y-m-d H:i:s' format. Default:
+ * current date/time.
+ * }
+ * @return int|bool ID of the message thread on success, false on failure.
+ */
</ins><span class="cx"> function messages_new_message( $args = '' ) {
</span><span class="cx">
</span><span class="cx"> $defaults = array (
</span><span class="lines">@@ -122,7 +143,13 @@
</span><span class="cx"> return false;
</span><span class="cx"> }
</span><span class="cx">
</span><del>-
</del><ins>+/**
+ * Send a notice.
+ *
+ * @param string $subject Subject of the notice.
+ * @param string $message Content of the notice.
+ * @return bool True on success, false on failure.
+ */
</ins><span class="cx"> function messages_send_notice( $subject, $message ) {
</span><span class="cx"> if ( !bp_current_user_can( 'bp_moderate' ) || empty( $subject ) || empty( $message ) ) {
</span><span class="cx"> return false;
</span><span class="lines">@@ -142,6 +169,12 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+/**
+ * Delete message thread(s).
+ *
+ * @param int|array Thread ID or array of thread IDs.
+ * @return bool True on success, false on failure.
+ */
</ins><span class="cx"> function messages_delete_thread( $thread_ids ) {
</span><span class="cx"> do_action( 'messages_before_delete_thread', $thread_ids );
</span><span class="cx">
</span><span class="lines">@@ -169,6 +202,14 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+/**
+ * Check whether a user has access to a thread.
+ *
+ * @param int $thread_id ID of the thread.
+ * @param int $user_id Optional. ID of the user. Default: ID of the logged-in
+ * user.
+ * @return int|null Message ID if the user has access, otherwise null.
+ */
</ins><span class="cx"> function messages_check_thread_access( $thread_id, $user_id = 0 ) {
</span><span class="cx"> if ( empty( $user_id ) )
</span><span class="cx"> $user_id = bp_loggedin_user_id();
</span><span class="lines">@@ -176,26 +217,63 @@
</span><span class="cx"> return BP_Messages_Thread::check_access( $thread_id, $user_id );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+/**
+ * Mark a thread as read.
+ *
+ * Wrapper for {@link BP_Messages_Thread::mark_as_read()}.
+ *
+ * @param int $thread_id ID of the thread.
+ */
</ins><span class="cx"> function messages_mark_thread_read( $thread_id ) {
</span><span class="cx"> return BP_Messages_Thread::mark_as_read( $thread_id );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+/**
+ * Mark a thread as unread.
+ *
+ * Wrapper for {@link BP_Messages_Thread::mark_as_unread()}.
+ *
+ * @param int $thread_id ID of the thread.
+ */
</ins><span class="cx"> function messages_mark_thread_unread( $thread_id ) {
</span><span class="cx"> return BP_Messages_Thread::mark_as_unread( $thread_id );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+/**
+ * Set messages-related cookies.
+ *
+ * Saves the 'bp_messages_send_to', 'bp_messages_subject', and
+ * 'bp_messages_content' cookies, which are used when setting up the default
+ * values on the messages page.
+ *
+ * @param string $recipients Comma-separated list of recipient usernames.
+ * @param string $subject Subject of the message.
+ * @param string $content Content of the message.
+ */
</ins><span class="cx"> function messages_add_callback_values( $recipients, $subject, $content ) {
</span><span class="cx"> @setcookie( 'bp_messages_send_to', $recipients, time() + 60 * 60 * 24, COOKIEPATH );
</span><span class="cx"> @setcookie( 'bp_messages_subject', $subject, time() + 60 * 60 * 24, COOKIEPATH );
</span><span class="cx"> @setcookie( 'bp_messages_content', $content, time() + 60 * 60 * 24, COOKIEPATH );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+/**
+ * Unset messages-related cookies.
+ *
+ * @see messages_add_callback_values()
+ */
</ins><span class="cx"> function messages_remove_callback_values() {
</span><span class="cx"> @setcookie( 'bp_messages_send_to', false, time() - 1000, COOKIEPATH );
</span><span class="cx"> @setcookie( 'bp_messages_subject', false, time() - 1000, COOKIEPATH );
</span><span class="cx"> @setcookie( 'bp_messages_content', false, time() - 1000, COOKIEPATH );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+/**
+ * Get the unread messages count for a user.
+ *
+ * @param int $user_id Optional. ID of the user. Default: ID of the
+ * logged-in user.
+ * @return int
+ */
</ins><span class="cx"> function messages_get_unread_count( $user_id = 0 ) {
</span><span class="cx"> if ( empty( $user_id ) )
</span><span class="cx"> $user_id = bp_loggedin_user_id();
</span><span class="lines">@@ -203,14 +281,34 @@
</span><span class="cx"> return BP_Messages_Thread::get_inbox_count( $user_id );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+/**
+ * Check whether a user is the sender of a message.
+ *
+ * @param int $user_id ID of the user.
+ * @param int $message_id ID of the message.
+ * @return int|null Returns the ID of the message if the user is the
+ * sender, otherwise null.
+ */
</ins><span class="cx"> function messages_is_user_sender( $user_id, $message_id ) {
</span><span class="cx"> return BP_Messages_Message::is_user_sender( $user_id, $message_id );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+/**
+ * Get the ID of the sender of a message.
+ *
+ * @param int $message_id ID of the message.
+ * @return int|null The ID of the sender if found, otherwise null.
+ */
</ins><span class="cx"> function messages_get_message_sender( $message_id ) {
</span><span class="cx"> return BP_Messages_Message::get_message_sender( $message_id );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+/**
+ * Check whether a message thread exists.
+ *
+ * @param int $thread_id ID of the thread.
+ * @return int|null The message thread ID on success, null on failure.
+ */
</ins><span class="cx"> function messages_is_valid_thread( $thread_id ) {
</span><span class="cx"> return BP_Messages_Thread::is_valid( $thread_id );
</span><span class="cx"> }
</span></span></pre></div>
<a id="trunksrcbpmessagesbpmessagesloaderphp"></a>
<div class="modfile"><h4>Modified: trunk/src/bp-messages/bp-messages-loader.php (8480 => 8481)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/bp-messages/bp-messages-loader.php 2014-06-07 22:09:36 UTC (rev 8480)
+++ trunk/src/bp-messages/bp-messages-loader.php 2014-06-07 23:47:51 UTC (rev 8481)
</span><span class="lines">@@ -12,6 +12,11 @@
</span><span class="cx"> // Exit if accessed directly
</span><span class="cx"> if ( !defined( 'ABSPATH' ) ) exit;
</span><span class="cx">
</span><ins>+/**
+ * Implementation of BP_Component for the Messages component.
+ *
+ * @since BuddyPress (1.5.0)
+ */
</ins><span class="cx"> class BP_Messages_Component extends BP_Component {
</span><span class="cx"> /**
</span><span class="cx"> * If this is true, the Message autocomplete will return friends only, unless
</span><span class="lines">@@ -23,9 +28,9 @@
</span><span class="cx"> public $autocomplete_all;
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Start the messages component creation process
</del><ins>+ * Start the messages 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">@@ -39,7 +44,11 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Include files
</del><ins>+ * Include files.
+ *
+ * @since BuddyPress (1.5.0)
+ *
+ * @param array $includes See {BP_Component::includes()} for details.
</ins><span class="cx"> */
</span><span class="cx"> public function includes( $includes = array() ) {
</span><span class="cx">
</span><span class="lines">@@ -61,12 +70,14 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Setup globals
</del><ins>+ * Set up globals for the Messages component.
</ins><span class="cx"> *
</span><span class="cx"> * The BP_MESSAGES_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)
+ *
+ * @param array $args Not used.
</ins><span class="cx"> */
</span><span class="cx"> public function setup_globals( $args = array() ) {
</span><span class="cx"> $bp = buddypress();
</span><span class="lines">@@ -98,7 +109,10 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Setup BuddyBar navigation
</del><ins>+ * Set up navigation for user pages.
+ *
+ * @param array $main_nav See {BP_Component::setup_nav()} for details.
+ * @param array $sub_nav See {BP_Component::setup_nav()} for details.
</ins><span class="cx"> */
</span><span class="cx"> public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
</span><span class="cx">
</span><span class="lines">@@ -181,7 +195,10 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Set up the Toolbar
</del><ins>+ * Set up the Toolbar.
+ *
+ * @param array $wp_admin_nav See {BP_Component::setup_admin_bar()}
+ * for details.
</ins><span class="cx"> */
</span><span class="cx"> public function setup_admin_bar( $wp_admin_nav = array() ) {
</span><span class="cx"> $bp = buddypress();
</span><span class="lines">@@ -250,7 +267,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Sets up the title for pages and <title>
</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">@@ -272,6 +289,9 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+/**
+ * Bootstrap the Messages component.
+ */
</ins><span class="cx"> function bp_setup_messages() {
</span><span class="cx"> buddypress()->messages = new BP_Messages_Component();
</span><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>