BP_Messages_Box_Template

Message Box Template Class
Description

Source

File: bp-messages/classes/class-bp-messages-box-template.php
class BP_Messages_Box_Template {
 
    /**
     * The loop iterator.
     *
     * @var int
     */
    public $current_thread = -1;
 
    /**
     * The number of threads returned by the paged query.
     *
     * @var int
     */
    public $current_thread_count = 0;
 
    /**
     * Total number of threads matching the query params.
     *
     * @var int
     */
    public $total_thread_count = 0;
 
    /**
     * Array of threads located by the query.
     *
     * @var array
     */
    public $threads = array();
 
    /**
     * The thread object currently being iterated on.
     *
     * @var object
     */
    public $thread = false;
 
    /**
     * A flag for whether the loop is currently being iterated.
     *
     * @var bool
     */
    public $in_the_loop = false;
 
    /**
     * User ID of the current inbox.
     *
     * @var int
     */
    public $user_id = 0;
 
    /**
     * The current "box" view ('notices', 'sentbox', 'inbox').
     *
     * @var string
     */
    public $box = 'inbox';
 
    /**
     * The page number being requested.
     *
     * @var int
     */
    public $pag_page = 1;
 
    /**
     * The number of items being requested per page.
     *
     * @var int
     */
    public $pag_num = 10;
 
    /**
     * An HTML string containing pagination links.
     *
     * @var string
     */
    public $pag_links = '';
 
    /**
     * Search terms for limiting the thread query.
     *
     * @var string
     */
    public $search_terms = '';
 
    /**
     * Constructor method.
     *
     * @param array $args {
     *     Array of arguments. See bp_has_message_threads() for full description.
     * }
     */
    public function __construct( $args = array() ) {
 
        // Backward compatibility with old method of passing arguments.
        if ( ! is_array( $args ) || func_num_args() > 1 ) {
            _deprecated_argument( __METHOD__, '2.2.0', sprintf( __( 'Arguments passed to %1$s should be in an associative array. See the inline documentation at %2$s for more details.', 'buddyboss' ), __METHOD__, __FILE__ ) );
 
            $old_args_keys = array(
                0 => 'user_id',
                1 => 'box',
                2 => 'per_page',
                3 => 'max',
                4 => 'type',
                5 => 'search_terms',
                6 => 'page_arg'
            );
 
            $args = bp_core_parse_args_array( $old_args_keys, func_get_args() );
        }
 
        $r = wp_parse_args( $args, array(
            'page'         => 1,
            'per_page'     => 10,
            'page_arg'     => 'mpage',
            'box'          => 'inbox',
            'type'         => 'all',
            'user_id'      => bp_loggedin_user_id(),
            'max'          => false,
            'search_terms' => '',
            'include'      => false,
            'meta_query'   => array(),
        ) );
 
        $this->pag_arg      = sanitize_key( $r['page_arg'] );
        $this->pag_page     = bp_sanitize_pagination_arg( $this->pag_arg, $r['page']     );
        $this->pag_num      = bp_sanitize_pagination_arg( 'num',          $r['per_page'] );
        $this->user_id      = $r['user_id'];
        $this->box          = $r['box'];
        $this->type         = $r['type'];
        $this->search_terms = $r['search_terms'];
        $this->include      = $r['include'];
 
        if ( 'notices' === $this->box ) {
            $this->threads = BP_Messages_Notice::get_notices( array(
                'pag_num'  => $this->pag_num,
                'pag_page' => $this->pag_page
            ) );
        } else {
            $threads = BP_Messages_Thread::get_current_threads_for_user( array(
                'user_id'      => $this->user_id,
                'box'          => $this->box,
                'type'         => $this->type,
                'limit'        => $this->pag_num,
                'page'         => $this->pag_page,
                'search_terms' => $this->search_terms,
                'include'      => $this->include,
                'meta_query'   => $r['meta_query'],
            ) );
 
            $this->threads            = $threads['threads'];
            $this->total_thread_count = $threads['total'];
        }
 
        if ( !$this->threads ) {
            $this->thread_count       = 0;
            $this->total_thread_count = 0;
        } else {
            $total_notice_count = BP_Messages_Notice::get_total_notice_count();
 
            if ( empty( $r['max'] ) || ( (int) $r['max'] >= (int) $total_notice_count ) ) {
                if ( 'notices' === $this->box ) {
                    $this->total_thread_count = (int) $total_notice_count;
                }
            } else {
                $this->total_thread_count = (int) $r['max'];
            }
 
            if ( ! empty( $r['max'] ) ) {
                if ( (int) $r['max'] >= count( $this->threads ) ) {
                    $this->thread_count = count( $this->threads );
                } else {
                    $this->thread_count = (int) $r['max'];
                }
            } else {
                $this->thread_count = count( $this->threads );
            }
        }
 
        if ( (int) $this->total_thread_count && (int) $this->pag_num ) {
            $pag_args = array(
                $r['page_arg'] => '%#%',
            );
 
            if ( defined( 'DOING_AJAX' ) && true === (bool) DOING_AJAX ) {
                $base = remove_query_arg( 's', wp_get_referer() );
            } else {
                $base = '';
            }
 
            $add_args = array();
 
            if ( ! empty( $this->search_terms ) ) {
                $add_args['s'] = $this->search_terms;
            }
 
            $this->pag_links = paginate_links( array(
                'base'      => add_query_arg( $pag_args, $base ),
                'format'    => '',
                'total'     => ceil( (int) $this->total_thread_count / (int) $this->pag_num ),
                'current'   => $this->pag_page,
                'prev_text' => __( '&larr;', 'buddyboss' ),
                'next_text' => __( '&rarr;', 'buddyboss' ),
                'mid_size'  => 1,
                'add_args'  => $add_args,
            ) );
        }
    }
 
    /**
     * Whether there are threads available in the loop.
     *
     * @see bp_has_message_threads()
     *
     * @return bool True if there are items in the loop, otherwise false.
     */
    public function has_threads() {
        if ( $this->thread_count ) {
            return true;
        }
 
        return false;
    }
 
    /**
     * Set up the next member and iterate index.
     *
     * @return object The next member to iterate over.
     */
    public function next_thread() {
        $this->current_thread++;
        $this->thread = $this->threads[$this->current_thread];
 
        return $this->thread;
    }
 
    /**
     * Rewind the threads and reset thread index.
     */
    public function rewind_threads() {
        $this->current_thread = -1;
        if ( $this->thread_count > 0 ) {
            $this->thread = $this->threads[0];
        }
    }
 
    /**
     * Whether there are threads left in the loop to iterate over.
     *
     * This method is used by {@link bp_message_threads()} as part of the
     * while loop that controls iteration inside the threads loop, eg:
     *     while ( bp_message_threads() ) { ...
     *
     * @see bp_message_threads()
     *
     * @return bool True if there are more threads to show, otherwise false.
     */
    function message_threads() {
        if ( $this->current_thread + 1 < $this->thread_count ) {
            return true;
        } elseif ( $this->current_thread + 1 == $this->thread_count ) {
 
            /**
             * Fires when at the end of threads to iterate over.
             *
             * @since BuddyPress 1.5.0
             */
            do_action( 'messages_box_loop_end' );
            // Do some cleaning up after the loop.
            $this->rewind_threads();
        }
 
        $this->in_the_loop = false;
        return false;
    }
 
    /**
     * Set up the current thread inside the loop.
     *
     * Used by {@link bp_message_thread()} to set up the current thread data
     * while looping, so that template tags used during that iteration make
     * reference to the current thread.
     *
     * @see bp_message_thread()
     */
    public function the_message_thread() {
 
        $this->in_the_loop = true;
        $this->thread      = $this->next_thread();
 
        if ( ! bp_is_current_action( 'notices' ) ) {
            $last_message_index     = 0;
            // $this->thread->messages = array_reverse( (array) $this->thread->messages );
 
            $this->thread->last_message_id      = $this->thread->messages[ $last_message_index ]->id;
            $this->thread->last_message_date    = $this->thread->messages[ $last_message_index ]->date_sent;
            $this->thread->last_sender_id       = $this->thread->messages[ $last_message_index ]->sender_id;
            $this->thread->last_message_subject = $this->thread->messages[ $last_message_index ]->subject;
            $this->thread->last_message_content = $this->thread->messages[ $last_message_index ]->message;
        }
 
        // Loop has just started.
        if ( 0 == $this->current_thread ) {
 
            /**
             * Fires if at the start of the message thread loop.
             *
             * @since BuddyPress 1.5.0
             */
            do_action( 'messages_box_loop_start' );
        }
    }
}
Expand full source code Collapse full source code
Methods

__construct — Constructor method.
has_threads — Whether there are threads available in the loop.
message_threads — Whether there are threads left in the loop to iterate over.
next_thread — Set up the next member and iterate index.
rewind_threads — Rewind the threads and reset thread index.
the_message_thread — Set up the current thread inside the loop.
Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.
Contents

Description

Source

Methods

Questions?
