<!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][7969] trunk/bp-messages/bp-messages-classes.php: Add phpDoc for BP_Messages_Notice class.</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/7969">7969</a></dd>
<dt>Author</dt> <dd>r-a-y</dd>
<dt>Date</dt> <dd>2014-02-22 22:49:31 +0000 (Sat, 22 Feb 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add phpDoc for BP_Messages_Notice class.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpmessagesbpmessagesclassesphp">trunk/bp-messages/bp-messages-classes.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpmessagesbpmessagesclassesphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-messages/bp-messages-classes.php (7968 => 7969)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-messages/bp-messages-classes.php 2014-02-22 21:40:39 UTC (rev 7968)
+++ trunk/bp-messages/bp-messages-classes.php 2014-02-22 22:49:31 UTC (rev 7969)
</span><span class="lines">@@ -429,20 +429,68 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+/**
+ * BuddyPress Notices class.
+ *
+ * Use this class to create, activate, deactivate or delete notices.
+ *
+ * @since BuddyPress (1.0.0)
+ */
</ins><span class="cx"> class BP_Messages_Notice {
</span><ins>+ /**
+ * The notice ID.
+ *
+ * @var int
+ */
</ins><span class="cx"> public $id = null;
</span><ins>+
+ /**
+ * The subject line for the notice.
+ *
+ * @var string
+ */
</ins><span class="cx"> public $subject;
</span><ins>+
+ /**
+ * The content of the notice.
+ *
+ * @var string
+ */
</ins><span class="cx"> public $message;
</span><ins>+
+ /**
+ * The date the notice was created.
+ *
+ * @var string
+ */
</ins><span class="cx"> public $date_sent;
</span><ins>+
+ /**
+ * Whether the notice is active or not.
+ *
+ * @var int
+ */
</ins><span class="cx"> public $is_active;
</span><span class="cx">
</span><ins>+ /**
+ * Constructor.
+ *
+ * @since BuddyPress (1.0.0)
+ */
</ins><span class="cx"> public function __construct( $id = null ) {
</span><span class="cx"> if ( $id ) {
</span><span class="cx"> $this->id = $id;
</span><del>- $this->populate($id);
</del><ins>+ $this->populate();
</ins><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Populate method.
+ *
+ * Runs during constructor.
+ *
+ * @since BuddyPress (1.0.0)
+ */
</ins><span class="cx"> public function populate() {
</span><span class="cx"> global $wpdb, $bp;
</span><span class="cx">
</span><span class="lines">@@ -456,6 +504,13 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Saves a notice.
+ *
+ * @since BuddyPress (1.0.0)
+ *
+ * @return bool
+ */
</ins><span class="cx"> public function save() {
</span><span class="cx"> global $wpdb, $bp;
</span><span class="cx">
</span><span class="lines">@@ -464,16 +519,19 @@
</span><span class="cx">
</span><span class="cx"> do_action_ref_array( 'messages_notice_before_save', array( &$this ) );
</span><span class="cx">
</span><del>- if ( empty( $this->id ) )
</del><ins>+ if ( empty( $this->id ) ) {
</ins><span class="cx"> $sql = $wpdb->prepare( "INSERT INTO {$bp->messages->table_name_notices} (subject, message, date_sent, is_active) VALUES (%s, %s, %s, %d)", $this->subject, $this->message, $this->date_sent, $this->is_active );
</span><del>- else
</del><ins>+ } else {
</ins><span class="cx"> $sql = $wpdb->prepare( "UPDATE {$bp->messages->table_name_notices} SET subject = %s, message = %s, is_active = %d WHERE id = %d", $this->subject, $this->message, $this->is_active, $this->id );
</span><ins>+ }
</ins><span class="cx">
</span><del>- if ( !$wpdb->query( $sql ) )
</del><ins>+ if ( ! $wpdb->query( $sql ) ) {
</ins><span class="cx"> return false;
</span><ins>+ }
</ins><span class="cx">
</span><del>- if ( !$id = $this->id )
</del><ins>+ if ( ! $id = $this->id ) {
</ins><span class="cx"> $id = $wpdb->insert_id;
</span><ins>+ }
</ins><span class="cx">
</span><span class="cx"> // Now deactivate all notices apart from the new one.
</span><span class="cx"> $wpdb->query( $wpdb->prepare( "UPDATE {$bp->messages->table_name_notices} SET is_active = 0 WHERE id != %d", $id ) );
</span><span class="lines">@@ -485,23 +543,45 @@
</span><span class="cx"> return true;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Activates a notice.
+ *
+ * @since BuddyPress (1.0.0)
+ *
+ * @return bool
+ */
</ins><span class="cx"> public function activate() {
</span><span class="cx"> $this->is_active = 1;
</span><span class="cx"> return (bool) $this->save();
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Deactivates a notice.
+ *
+ * @since BuddyPress (1.0.0)
+ *
+ * @return bool
+ */
</ins><span class="cx"> public function deactivate() {
</span><span class="cx"> $this->is_active = 0;
</span><span class="cx"> return (bool) $this->save();
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Deletes a notice.
+ *
+ * @since BuddyPress (1.0.0)
+ *
+ * @return bool
+ */
</ins><span class="cx"> public function delete() {
</span><span class="cx"> global $wpdb, $bp;
</span><span class="cx">
</span><span class="cx"> $sql = $wpdb->prepare( "DELETE FROM {$bp->messages->table_name_notices} WHERE id = %d", $this->id );
</span><span class="cx">
</span><del>- if ( !$wpdb->query( $sql ) )
</del><ins>+ if ( ! $wpdb->query( $sql ) ) {
</ins><span class="cx"> return false;
</span><ins>+ }
</ins><span class="cx">
</span><span class="cx"> return true;
</span><span class="cx"> }
</span><span class="lines">@@ -509,12 +589,18 @@
</span><span class="cx"> /** Static Methods ********************************************************/
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Pulls up a list of notices
</del><ins>+ * Pulls up a list of notices.
</ins><span class="cx"> *
</span><span class="cx"> * To get all notices, pass a value of -1 to pag_num
</span><span class="cx"> *
</span><del>- * @param array $args See $defaults for explanation of accepted arguments
- * @return array $notices
</del><ins>+ * @since BuddyPress (1.0.0)
+ *
+ * @param array $data {
+ * Array of parameters.
+ * @type int $pag_num Number of notices per page. Defaults to 20.
+ * @type int $pag_page The page number. Defaults to 1.
+ * }
+ * @return array
</ins><span class="cx"> */
</span><span class="cx"> public static function get_notices( $args = array() ) {
</span><span class="cx"> global $wpdb, $bp;
</span><span class="lines">@@ -534,6 +620,13 @@
</span><span class="cx"> return $notices;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Returns the total number of recorded notices.
+ *
+ * @since BuddyPress (1.0.0)
+ *
+ * @return int
+ */
</ins><span class="cx"> public static function get_total_notice_count() {
</span><span class="cx"> global $wpdb, $bp;
</span><span class="cx">
</span><span class="lines">@@ -542,6 +635,13 @@
</span><span class="cx"> return $notice_count;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Returns the active notice that should be displayed on the frontend.
+ *
+ * @since BuddyPress (1.0.0)
+ *
+ * @return object The BP_Messages_Notice object
+ */
</ins><span class="cx"> public static function get_active() {
</span><span class="cx"> global $wpdb, $bp;
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>