Skip to:
Content

BuddyPress.org

Changeset 8792


Ignore:
Timestamp:
08/11/2014 05:06:00 PM (12 years ago)
Author:
johnjamesjacoby
Message:

Code clean-up to classes in bp-messages-template.php.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-messages/bp-messages-template.php

    r8791 r8792  
    1515 */
    1616class BP_Messages_Box_Template {
     17
    1718    /**
    1819     * The loop iterator.
     
    2122     * @var int
    2223     */
    23     var $current_thread = -1;
     24    public $current_thread = -1;
    2425
    2526    /**
     
    2930     * @var int
    3031     */
    31     var $current_thread_count;
     32    public $current_thread_count = 0;
    3233
    3334    /**
     
    3738     * @var int
    3839     */
    39     var $total_thread_count;
     40    public $total_thread_count = 0;
    4041
    4142    /**
     
    4546     * @var array
    4647     */
    47     var $threads;
     48    public $threads = array();
    4849
    4950    /**
     
    5354     * @var object
    5455     */
    55     var $thread;
     56    public $thread = false;
    5657
    5758    /**
     
    6162     * @var bool
    6263     */
    63     var $in_the_loop;
     64    public $in_the_loop = false;
    6465
    6566    /**
     
    6970     * @var int
    7071     */
    71     var $user_id;
     72    public $user_id = 0;
    7273
    7374    /**
     
    7778     * @var string
    7879     */
    79     var $box;
     80    public $box = 'inbox';
    8081
    8182    /**
     
    8586     * @var int
    8687     */
    87     var $pag_page;
     88    public $pag_page = 1;
    8889
    8990    /**
     
    9394     * @var int
    9495     */
    95     var $pag_num;
     96    public $pag_num = 10;
    9697
    9798    /**
     
    101102     * @var string
    102103     */
    103     var $pag_links;
     104    public $pag_links = '';
    104105
    105106    /**
     
    109110     * @var string
    110111     */
    111     var $search_terms;
     112    public $search_terms = '';
    112113
    113114    /**
     
    126127     *        parameter. Default: 'mpage'.
    127128     */
    128     function __construct( $user_id, $box, $per_page, $max, $type, $search_terms, $page_arg = 'mpage' ) {
     129    public function __construct( $user_id, $box, $per_page, $max, $type, $search_terms, $page_arg = 'mpage' ) {
    129130        $this->pag_page = isset( $_GET[$page_arg] ) ? intval( $_GET[$page_arg] ) : 1;
    130131        $this->pag_num  = isset( $_GET['num'] )   ? intval( $_GET['num'] )   : $per_page;
     
    192193     * @return bool True if there are items in the loop, otherwise false.
    193194     */
    194     function has_threads() {
     195    public function has_threads() {
    195196        if ( $this->thread_count ) {
    196197            return true;
     
    205206     * @return object The next member to iterate over.
    206207     */
    207     function next_thread() {
     208    public function next_thread() {
    208209        $this->current_thread++;
    209210        $this->thread = $this->threads[$this->current_thread];
     
    215216     * Rewind the threads and reset thread index.
    216217     */
    217     function rewind_threads() {
     218    public function rewind_threads() {
    218219        $this->current_thread = -1;
    219220        if ( $this->thread_count > 0 ) {
     
    255256     * @see bp_message_thread()
    256257     */
    257     function the_message_thread() {
     258    public function the_message_thread() {
    258259
    259260        $this->in_the_loop = true;
     
    284285            }
    285286
    286             $this->thread->last_message_id      = $this->thread->messages[$last_message_index]->id;
    287             $this->thread->last_message_date    = $this->thread->messages[$last_message_index]->date_sent;
    288             $this->thread->last_sender_id       = $this->thread->messages[$last_message_index]->sender_id;
    289             $this->thread->last_message_subject = $this->thread->messages[$last_message_index]->subject;
    290             $this->thread->last_message_content = $this->thread->messages[$last_message_index]->message;
     287            $this->thread->last_message_id      = $this->thread->messages[ $last_message_index ]->id;
     288            $this->thread->last_message_date    = $this->thread->messages[ $last_message_index ]->date_sent;
     289            $this->thread->last_sender_id       = $this->thread->messages[ $last_message_index ]->sender_id;
     290            $this->thread->last_message_subject = $this->thread->messages[ $last_message_index ]->subject;
     291            $this->thread->last_message_content = $this->thread->messages[ $last_message_index ]->message;
    291292        }
    292293
    293294        // loop has just started
    294295        if ( 0 == $this->current_thread ) {
    295             do_action('messages_box_loop_start');
     296            do_action( 'messages_box_loop_start' );
    296297        }
    297298    }
     
    11951196 */
    11961197class BP_Messages_Thread_Template {
     1198
    11971199    /**
    11981200     * The loop iterator.
     
    12011203     * @var int
    12021204     */
    1203     var $current_message = -1;
     1205    public $current_message = -1;
    12041206
    12051207    /**
     
    12091211     * @var int
    12101212     */
    1211     var $message_count;
     1213    public $message_count = 0;
    12121214
    12131215    /**
     
    12171219     * @var object
    12181220     */
    1219     var $message;
     1221    public $message;
    12201222
    12211223    /**
     
    12251227     * @var BP_Messages_Thread
    12261228     */
    1227     var $thread;
     1229    public $thread;
    12281230
    12291231    /**
     
    12331235     * @var bool
    12341236     */
    1235     var $in_the_loop;
     1237    public $in_the_loop = false;
    12361238
    12371239    /**
     
    12411243     * @var int
    12421244     */
    1243     var $pag_page;
     1245    public $pag_page = 1;
    12441246
    12451247    /**
     
    12491251     * @var int
    12501252     */
    1251     var $pag_num;
     1253    public $pag_num = 10;
    12521254
    12531255    /**
     
    12571259     * @var string
    12581260     */
    1259     var $pag_links;
     1261    public $pag_links = '';
    12601262
    12611263    /**
     
    12651267     * @var int
    12661268     */
    1267     var $total_message_count;
     1269    public $total_message_count = 0;
    12681270
    12691271    /**
     
    12731275     * @param string $order 'ASC' or 'DESC'.
    12741276     */
    1275     function __construct( $thread_id, $order ) {
     1277    public function __construct( $thread_id, $order ) {
    12761278        $this->thread        = new BP_Messages_Thread( $thread_id, $order );
    12771279        $this->message_count = count( $this->thread->messages );
    12781280
    1279         $last_message_index = $this->message_count - 1;
    1280         $this->thread->last_message_id = $this->thread->messages[$last_message_index]->id;
    1281         $this->thread->last_message_date = $this->thread->messages[$last_message_index]->date_sent;
    1282         $this->thread->last_sender_id = $this->thread->messages[$last_message_index]->sender_id;
    1283         $this->thread->last_message_subject = $this->thread->messages[$last_message_index]->subject;
    1284         $this->thread->last_message_content = $this->thread->messages[$last_message_index]->message;
     1281        $last_message_index                 = $this->message_count - 1;
     1282        $this->thread->last_message_id      = $this->thread->messages[ $last_message_index ]->id;
     1283        $this->thread->last_message_date    = $this->thread->messages[ $last_message_index ]->date_sent;
     1284        $this->thread->last_sender_id       = $this->thread->messages[ $last_message_index ]->sender_id;
     1285        $this->thread->last_message_subject = $this->thread->messages[ $last_message_index ]->subject;
     1286        $this->thread->last_message_content = $this->thread->messages[ $last_message_index ]->message;
    12851287    }
    12861288
     
    12921294     * @return bool True if there are items in the loop, otherwise false.
    12931295     */
    1294     function has_messages() {
    1295         if ( $this->message_count ) {
     1296    public function has_messages() {
     1297        if ( ! empty( $this->message_count ) ) {
    12961298            return true;
    12971299        }
     
    13051307     * @return object The next member to iterate over.
    13061308     */
    1307     function next_message() {
     1309    public function next_message() {
    13081310        $this->current_message++;
    1309         $this->message = $this->thread->messages[$this->current_message];
     1311        $this->message = $this->thread->messages[ $this->current_message ];
    13101312
    13111313        return $this->message;
     
    13151317     * Rewind the messages and reset message index.
    13161318     */
    1317     function rewind_messages() {
     1319    public function rewind_messages() {
    13181320        $this->current_message = -1;
    13191321        if ( $this->message_count > 0 ) {
     
    13331335     * @return bool True if there are more messages to show, otherwise false.
    13341336     */
    1335     function messages() {
    1336         if ( $this->current_message + 1 < $this->message_count ) {
     1337    public function messages() {
     1338        if ( ( $this->current_message + 1 ) < $this->message_count ) {
    13371339            return true;
    1338         } elseif ( $this->current_message + 1 == $this->message_count ) {
    1339             do_action('thread_loop_end');
     1340        } elseif ( ( $this->current_message + 1 ) === $this->message_count ) {
     1341            do_action( 'thread_loop_end' );
    13401342            // Do some cleaning up after the loop
    13411343            $this->rewind_messages();
     
    13551357     * @see bp_thread_the_message()
    13561358     */
    1357     function the_message() {
     1359    public function the_message() {
    13581360        $this->in_the_loop = true;
    13591361        $this->message     = $this->next_message();
    13601362
    13611363        // loop has just started
    1362         if ( 0 == $this->current_message ) {
     1364        if ( 0 === $this->current_message ) {
    13631365            do_action( 'thread_loop_start' );
    13641366        }
Note: See TracChangeset for help on using the changeset viewer.