Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
09/25/2015 12:02:25 AM (8 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Messages component.

See #6576.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-messages/classes/class-bp-messages-thread.php

    r10038 r10139  
    11<?php
    22/**
    3  * BuddyPress Messages Classes
     3 * BuddyPress Messages Classes.
    44 *
    55 * @package BuddyPress
     
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
     
    1313 * BuddyPress Message Thread class.
    1414 *
    15  * @since BuddyPress (1.0.0)
     15 * @since 1.0.0
    1616 */
    1717class BP_Messages_Thread {
     
    2020     * The message thread ID.
    2121     *
    22      * @since BuddyPress (1.0.0)
     22     * @since 1.0.0
    2323     * @var int
    2424     */
     
    2828     * The current messages.
    2929     *
    30      * @since BuddyPress (1.0.0)
     30     * @since 1.0.0
    3131     * @var array
    3232     */
     
    3636     * The current recipients in the message thread.
    3737     *
    38      * @since BuddyPress (1.0.0)
     38     * @since 1.0.0
    3939     * @var array
    4040     */
     
    4444     * The user IDs of all messages in the message thread.
    4545     *
    46      * @since BuddyPress (1.2.0)
     46     * @since 1.2.0
    4747     * @var array
    4848     */
     
    5252     * The unread count for the logged-in user.
    5353     *
    54      * @since BuddyPress (1.2.0)
     54     * @since 1.2.0
    5555     * @var int
    5656     */
     
    6060     * The content of the last message in this thread.
    6161     *
    62      * @since BuddyPress (1.2.0)
     62     * @since 1.2.0
    6363     * @var string
    6464     */
     
    6868     * The date of the last message in this thread.
    6969     *
    70      * @since BuddyPress (1.2.0)
     70     * @since 1.2.0
    7171     * @var string
    7272     */
     
    7676     * The ID of the last message in this thread.
    7777     *
    78      * @since BuddyPress (1.2.0)
     78     * @since 1.2.0
    7979     * @var int
    8080     */
     
    8484     * The subject of the last message in this thread.
    8585     *
    86      * @since BuddyPress (1.2.0)
     86     * @since 1.2.0
    8787     * @var string
    8888     */
     
    9292     * The user ID of the author of the last message in this thread.
    9393     *
    94      * @since BuddyPress (1.2.0)
     94     * @since 1.2.0
    9595     * @var int
    9696     */
     
    100100     * Sort order of the messages in this thread (ASC or DESC).
    101101     *
    102      * @since BuddyPress (1.5.0)
     102     * @since 1.5.0
    103103     * @var string
    104104     */
     
    108108     * Constructor.
    109109     *
    110      * @since BuddyPress (1.0.0)
     110     * @since 1.0.0
    111111     *
    112112     * @see BP_Messages_Thread::populate() for full description of parameters.
     
    127127     * Used in constructor.
    128128     *
    129      * @since BuddyPress (1.0.0)
     129     * @since 1.0.0
    130130     *
    131131     * @param int    $thread_id The message thread ID.
     
    192192         * Fires after a BP_Messages_Thread object has been populated.
    193193         *
    194          * @since BuddyPress (2.2.0)
     194         * @since 2.2.0
    195195         *
    196196         * @param BP_Messages_Thread $this Message thread object.
     
    202202     * Mark a thread initialized in this class as read.
    203203     *
    204      * @since BuddyPress (1.0.0)
     204     * @since 1.0.0
    205205     *
    206206     * @see BP_Messages_Thread::mark_as_read()
     
    213213     * Mark a thread initialized in this class as unread.
    214214     *
    215      * @since BuddyPress (1.0.0)
     215     * @since 1.0.0
    216216     *
    217217     * @see BP_Messages_Thread::mark_as_unread()
     
    224224     * Returns recipients for a message thread.
    225225     *
    226      * @since BuddyPress (1.0.0)
    227      * @since BuddyPress (2.3.0) Added $thread_id as a parameter.
     226     * @since 1.0.0
     227     * @since 2.3.0 Added $thread_id as a parameter.
    228228     *
    229229     * @param int $thread_id The thread ID.
     
    258258         * Filters the recipients of a message thread.
    259259         *
    260          * @since BuddyPress (2.2.0)
     260         * @since 2.2.0
    261261         *
    262262         * @param array $recipients Array of recipient objects.
     
    271271     * Get all messages associated with a thread.
    272272     *
    273      * @since BuddyPress (2.3.0)
     273     * @since 2.3.0
    274274     *
    275275     * @param int $thread_id The message thread ID.
     
    298298     * Static method to get message recipients by thread ID.
    299299     *
    300      * @since BuddyPress (2.3.0)
     300     * @since 2.3.0
    301301     *
    302302     * @param  int $thread_id The thread ID.
     
    315315     * has marked the thread as deleted.
    316316     *
    317      * @since BuddyPress (1.0.0)
     317     * @since 1.0.0
    318318     *
    319319     * @param int $thread_id The message thread ID.
     
    329329         * Fires before a message thread is marked as deleted.
    330330         *
    331          * @since BuddyPress (2.2.0)
     331         * @since 2.2.0
    332332         *
    333333         * @param int $thread_id ID of the thread being deleted.
     
    355355             * Fires before an entire message thread is deleted.
    356356             *
    357              * @since BuddyPress (2.2.0)
     357             * @since 2.2.0
    358358             *
    359359             * @param int   $thread_id   ID of the thread being deleted.
     
    374374                 * Fires after a message is deleted. This hook is poorly named.
    375375                 *
    376                  * @since BuddyPress (1.0.0)
     376                 * @since 1.0.0
    377377                 *
    378378                 * @param int $message_id ID of the message.
     
    388388         * Fires after a message thread is either marked as deleted or deleted.
    389389         *
    390          * @since BuddyPress (2.2.0)
     390         * @since 2.2.0
    391391         *
    392392         * @param int   $thread_id   ID of the thread being deleted.
     
    401401     * Get current message threads for a user.
    402402     *
    403      * @since BuddyPress (1.0.0)
     403     * @since 1.0.0
    404404     *
    405405     * @param array $args {
     
    536536         * Filters the results of the query for a user's message threads.
    537537         *
    538          * @since BuddyPress (2.2.0)
     538         * @since 2.2.0
    539539         *
    540540         * @param array $value {
     
    555555     * and creating the necessary SQL clauses.
    556556     *
    557      * @since BuddyPress (2.2.0)
     557     * @since 2.2.0
    558558     *
    559559     * @param array $meta_query An array of meta_query filters. See the
     
    586586     * Mark a thread as read.
    587587     *
    588      * @since BuddyPress (1.0.0)
     588     * @since 1.0.0
    589589     *
    590590     * @param int $thread_id The message thread ID.
     
    604604     * Mark a thread as unread.
    605605     *
    606      * @since BuddyPress (1.0.0)
     606     * @since 1.0.0
    607607     *
    608608     * @param int $thread_id The message thread ID.
     
    622622     * Returns the total number of message threads for a user.
    623623     *
    624      * @since BuddyPress (1.0.0)
     624     * @since 1.0.0
    625625     *
    626626     * @param int    $user_id The user ID.
     
    653653     * Determine if the logged-in user is a sender of any message in a thread.
    654654     *
    655      * @since BuddyPress (1.0.0)
     655     * @since 1.0.0
    656656     *
    657657     * @param int $thread_id The message thread ID.
     
    676676     * Returns the userlink of the last sender in a message thread.
    677677     *
    678      * @since BuddyPress (1.0.0)
     678     * @since 1.0.0
    679679     *
    680680     * @param int $thread_id The message thread ID.
     
    697697     * Gets the unread message count for a user.
    698698     *
    699      * @since BuddyPress (1.0.0)
     699     * @since 1.0.0
    700700     *
    701701     * @param int $user_id The user ID.
     
    723723         * Filters a user's unread message count.
    724724         *
    725          * @since BuddyPress (2.2.0)
     725         * @since 2.2.0
    726726         *
    727727         * @param int $unread_count Unread message count.
     
    734734     * Checks whether a user is a part of a message thread discussion.
    735735     *
    736      * @since BuddyPress (1.0.0)
     736     * @since 1.0.0
    737737     *
    738738     * @param int $thread_id The message thread ID.
     
    759759     * Checks whether a message thread exists.
    760760     *
    761      * @since BuddyPress (1.0.0)
     761     * @since 1.0.0
    762762     *
    763763     * @param int $thread_id The message thread ID.
     
    789789     * "X Recipients" where "X" is the number of recipients in the message thread.
    790790     *
    791      * @since BuddyPress (1.0.0)
     791     * @since 1.0.0
    792792     *
    793793     * @param array $recipients Array containing the message recipients (array of objects).
     
    819819     * Upgrade method for the older BP message thread DB table.
    820820     *
    821      * @since BuddyPress (1.2.0)
     821     * @since 1.2.0
    822822     *
    823823     * @todo We should remove this.  No one is going to upgrade from v1.1, right?
Note: See TracChangeset for help on using the changeset viewer.