Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
03/16/2012 02:42:59 AM (14 years ago)
Author:
johnjamesjacoby
Message:

Add 'BuddyPress' to phpdoc since's and deprecated's for 1.1, 1.2.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/bp-activity/bp-activity-template.php

    r5928 r5929  
    8888 * This is responsible for loading a group of activity items and displaying them
    8989 *
    90  * @since 1.0.0
     90 * @since BuddyPress (1.0)
    9191 */
    9292class BP_Activity_Template {
     
    227227 * Based on the $args passed, bp_has_activities() populates the $activities_template global.
    228228 *
    229  * @since 1.0.0
     229 * @since BuddyPress (1.0)
    230230 *
    231231 * @param array $args Arguments for limiting the contents of the activity loop. Can be passed as an associative array or as a URL argument string
     
    398398 * Determines if there are still activities left in the loop.
    399399 *
    400  * @since 1.0.0
     400 * @since BuddyPress (1.0)
    401401 *
    402402 * @global object $activities_template {@link BP_Activity_Template}
     
    413413 * Gets the current activity object in the loop
    414414 *
    415  * @since 1.0.0
     415 * @since BuddyPress (1.0)
    416416 *
    417417 * @global object $activities_template {@link BP_Activity_Template}
     
    428428 * Outputs the activity pagination count
    429429 *
    430  * @since 1.0.0
     430 * @since BuddyPress (1.0)
    431431 *
    432432 * @global object $activities_template {@link BP_Activity_Template}
     
    440440     * Returns the activity pagination count
    441441     *
    442      * @since 1.2.0
     442     * @since BuddyPress (1.2)
    443443     *
    444444     * @global object $activities_template {@link BP_Activity_Template}
     
    461461 * Outputs the activity pagination links
    462462 *
    463  * @since 1.0.0
     463 * @since BuddyPress (1.0)
    464464 *
    465465 * @uses bp_get_activity_pagination_links()
     
    472472     * Outputs the activity pagination links
    473473     *
    474      * @since 1.0.0
     474     * @since BuddyPress (1.0)
    475475     *
    476476     * @global object $activities_template {@link BP_Activity_Template}
     
    507507 * Outputs the activity count
    508508 *
    509  * @since 1.2.0
     509 * @since BuddyPress (1.2)
    510510 *
    511511 * @uses bp_get_activity_count()
     
    518518     * Returns the activity count
    519519     *
    520      * @since 1.2.0
     520     * @since BuddyPress (1.2)
    521521     *
    522522     * @global object $activities_template {@link BP_Activity_Template}
     
    534534 * Outputs the number of activities per page
    535535 *
    536  * @since 1.2.0
     536 * @since BuddyPress (1.2)
    537537 *
    538538 * @uses bp_get_activity_per_page()
     
    545545     * Returns the number of activities per page
    546546     *
    547      * @since 1.2.0
     547     * @since BuddyPress (1.2)
    548548     *
    549549     * @global object $activities_template {@link BP_Activity_Template}
     
    561561 * Outputs the activities title
    562562 *
    563  * @since 1.0.0
     563 * @since BuddyPress (1.0)
    564564 *
    565565 * @uses bp_get_activities_title()
     
    572572     * Returns the activities title
    573573     *
    574      * @since 1.0.0
     574     * @since BuddyPress (1.0)
    575575     *
    576576     * @global string $bp_activity_title
     
    588588 * {@internal Missing Description}
    589589 *
    590  * @since 1.0.0
     590 * @since BuddyPress (1.0)
    591591 *
    592592 * @uses bp_get_activities_no_activity()
     
    599599     * {@internal Missing Description}
    600600     *
    601      * @since 1.0.0
     601     * @since BuddyPress (1.0)
    602602     *
    603603     * @global string $bp_activity_no_activity
     
    615615 * Outputs the activity id
    616616 *
    617  * @since 1.2.0
     617 * @since BuddyPress (1.2)
    618618 *
    619619 * @uses bp_get_activity_id()
     
    626626     * Returns the activity id
    627627     *
    628      * @since 1.2.0
     628     * @since BuddyPress (1.2)
    629629     *
    630630     * @global object $activities_template {@link BP_Activity_Template}
     
    641641 * Outputs the activity item id
    642642 *
    643  * @since 1.2.0
     643 * @since BuddyPress (1.2)
    644644 *
    645645 * @uses bp_get_activity_item_id()
     
    652652     * Returns the activity item id
    653653     *
    654      * @since 1.2.0
     654     * @since BuddyPress (1.2)
    655655     *
    656656     * @global object $activities_template {@link BP_Activity_Template}
     
    667667 * Outputs the activity secondary item id
    668668 *
    669  * @since 1.2.0
     669 * @since BuddyPress (1.2)
    670670 *
    671671 * @uses bp_get_activity_secondary_item_id()
     
    678678     * Returns the activity secondary item id
    679679     *
    680      * @since 1.2.0
     680     * @since BuddyPress (1.2)
    681681     *
    682682     * @global object $activities_template {@link BP_Activity_Template}
     
    693693 * Outputs the date the activity was recorded
    694694 *
    695  * @since 1.2.0
     695 * @since BuddyPress (1.2)
    696696 *
    697697 * @uses bp_get_activity_date_recorded()
     
    704704     * Returns the date the activity was recorded
    705705     *
    706      * @since 1.2.0
     706     * @since BuddyPress (1.2)
    707707     *
    708708     * @global object $activities_template {@link BP_Activity_Template}
     
    719719 * Outputs the activity object name
    720720 *
    721  * @since 1.2.0
     721 * @since BuddyPress (1.2)
    722722 *
    723723 * @uses bp_get_activity_object_name()
     
    730730     * Returns the activity object name
    731731     *
    732      * @since 1.2.0
     732     * @since BuddyPress (1.2)
    733733     *
    734734     * @global object $activities_template {@link BP_Activity_Template}
     
    745745 * Outputs the activity type
    746746 *
    747  * @since 1.2.0
     747 * @since BuddyPress (1.2)
    748748 *
    749749 * @uses bp_get_activity_type()
     
    756756     * Returns the activity type
    757757     *
    758      * @since 1.2.0
     758     * @since BuddyPress (1.2)
    759759     *
    760760     * @global object $activities_template {@link BP_Activity_Template}
     
    773773     * Just a wrapper for bp_activity_type()
    774774     *
    775      * @since 1.2.0
    776      * @deprecated 1.5.0
     775     * @since BuddyPress (1.2)
     776     * @deprecated BuddyPress (1.5)
    777777     *
    778778     * @todo Properly deprecate in favor of bp_activity_type() and
     
    788788     * Just a wrapper for bp_get_activity_type()
    789789     *
    790      * @since 1.2.0
    791      * @deprecated 1.5.0
     790     * @since BuddyPress (1.2)
     791     * @deprecated BuddyPress (1.5)
    792792     *
    793793     * @todo Properly deprecate in favor of bp_get_activity_type()
     
    802802 * Outputs the activity user id
    803803 *
    804  * @since 1.1.0
     804 * @since BuddyPress (1.1)
    805805 *
    806806 * @uses bp_get_activity_user_id()
     
    813813     * Returns the activity user id
    814814     *
    815      * @since 1.1.0
     815     * @since BuddyPress (1.1)
    816816     *
    817817     * @global object $activities_template {@link BP_Activity_Template}
     
    828828 * Outputs the activity user link
    829829 *
    830  * @since 1.2.0
     830 * @since BuddyPress (1.2)
    831831 *
    832832 * @uses bp_get_activity_user_link()
     
    839839     * Returns the activity user link
    840840     *
    841      * @since 1.2.0
     841     * @since BuddyPress (1.2)
    842842     *
    843843     * @global object $activities_template {@link BP_Activity_Template}
     
    861861 * Output the avatar of the user that performed the action
    862862 *
    863  * @since 1.1.0
     863 * @since BuddyPress (1.1)
    864864 *
    865865 * @param array $args
     
    873873     * Return the avatar of the user that performed the action
    874874     *
    875      * @since 1.1.0
     875     * @since BuddyPress (1.1)
    876876     *
    877877     * @param array $args optional
     
    949949 * Output the avatar of the object that action was performed on
    950950 *
    951  * @since 1.2.0
     951 * @since BuddyPress (1.2)
    952952 *
    953953 * @param array $args optional
     
    962962     * Return the avatar of the object that action was performed on
    963963     *
    964      * @since 1.2.0
     964     * @since BuddyPress (1.2)
    965965     *
    966966     * @param array $args optional
     
    10501050 * Output the activity action
    10511051 *
    1052  * @since 1.2.0
     1052 * @since BuddyPress (1.2)
    10531053 *
    10541054 * @uses bp_get_activity_action()
     
    10611061     * Return the activity action
    10621062     *
    1063      * @since 1.2.0
     1063     * @since BuddyPress (1.2)
    10641064     *
    10651065     * @global object $activities_template {@link BP_Activity_Template}
     
    10851085 * Output the activity content body
    10861086 *
    1087  * @since 1.2.0
     1087 * @since BuddyPress (1.2)
    10881088 *
    10891089 * @uses bp_get_activity_content_body()
     
    10961096     * Return the activity content body
    10971097     *
    1098      * @since 1.2.0
     1098     * @since BuddyPress (1.2)
    10991099     *
    11001100     * @global object $activities_template {@link BP_Activity_Template}
     
    11171117 * Does the activity have content?
    11181118 *
    1119  * @since 1.2.0
     1119 * @since BuddyPress (1.2)
    11201120 *
    11211121 * @global object $activities_template {@link BP_Activity_Template}
     
    11351135 * Output the activity content
    11361136 *
    1137  * @since 1.0.0
    1138  * @deprecated 1.5.0
     1137 * @since BuddyPress (1.0)
     1138 * @deprecated BuddyPress (1.5)
    11391139 *
    11401140 * @todo properly deprecate this function
     
    11491149     * Return the activity content
    11501150     *
    1151      * @since 1.0.0
    1152      * @deprecated 1.5.0
     1151     * @since BuddyPress (1.0)
     1152     * @deprecated BuddyPress (1.5)
    11531153     *
    11541154     * @todo properly deprecate this function
     
    11751175 * Insert activity meta
    11761176 *
    1177  * @since 1.2.0
     1177 * @since BuddyPress (1.2)
    11781178 *
    11791179 * @param string $content
     
    12111211 * Determine if the current user can delete an activity item
    12121212 *
    1213  * @since 1.2.0
     1213 * @since BuddyPress (1.2)
    12141214 *
    12151215 * @param object $activity Optional
     
    12461246 * Output the activity parent content
    12471247 *
    1248  * @since 1.2.0
     1248 * @since BuddyPress (1.2)
    12491249 *
    12501250 * @param array $args Optional
     
    12591259     * Return the activity content
    12601260     *
    1261      * @since 1.2.0
     1261     * @since BuddyPress (1.2)
    12621262     *
    12631263     * @param array $args Optional
     
    13041304 * Output whether or not the current activity is in a current user's favorites
    13051305 *
    1306  * @since 1.2.0
     1306 * @since BuddyPress (1.2)
    13071307 *
    13081308 * @uses bp_get_activity_is_favorite()
     
    13151315     * Return whether or not the current activity is in a current user's favorites
    13161316     *
    1317      * @since 1.2.0
     1317     * @since BuddyPress (1.2)
    13181318     *
    13191319     * @global object $activities_template {@link BP_Activity_Template}
     
    13311331 * Echoes the comment markup for an activity item
    13321332 *
    1333  * @since 1.2.0
     1333 * @since BuddyPress (1.2)
    13341334 *
    13351335 * @todo deprecate $args param
     
    13441344     * Gets the comment markup for an activity item
    13451345     *
    1346      * @since 1.2.0
     1346     * @since BuddyPress (1.2)
    13471347     *
    13481348     * @todo deprecate $args param
     
    13711371         * split between here and the comment.php template.
    13721372         *
    1373          * @since 1.2.0
     1373         * @since BuddyPress (1.2)
    13741374         *
    13751375         * @todo remove $counter global
     
    16511651 * Echoes the activity comment count
    16521652 *
    1653  * @since 1.2.0
     1653 * @since BuddyPress (1.2)
    16541654 *
    16551655 * @uses bp_activity_get_comment_count()
     
    16661666     * content of activity comments only.
    16671667     *
    1668      * @since 1.2.0
     1668     * @since BuddyPress (1.2)
    16691669     *
    16701670     * @todo deprecate $args
     
    16941694         * content of activity comments only.
    16951695         *
    1696          * @since 1.2.0
     1696         * @since BuddyPress (1.2)
    16971697         *
    16981698         * @todo investigate why bp_activity_recurse_comment_count() is used while being declared
     
    17211721 * Echoes the activity comment link
    17221722 *
    1723  * @since 1.2.0
     1723 * @since BuddyPress (1.2)
    17241724 *
    17251725 * @uses bp_get_activity_comment_link()
     
    17321732     * Gets the activity comment link
    17331733     *
    1734      * @since 1.2.0
     1734     * @since BuddyPress (1.2)
    17351735     *
    17361736     * @global object $activities_template {@link BP_Activity_Template}
     
    17471747 * Echoes the activity comment form no javascript display CSS
    17481748 *
    1749  * @since 1.2.0
     1749 * @since BuddyPress (1.2)
    17501750 *
    17511751 * @uses bp_get_activity_comment_form_nojs_display()
     
    17581758     * Gets the activity comment form no javascript display CSS
    17591759     *
    1760      * @since 1.2.0
     1760     * @since BuddyPress (1.2)
    17611761     *
    17621762     * @global object $activities_template {@link BP_Activity_Template}
     
    17751775 * Echoes the activity comment form action
    17761776 *
    1777  * @since 1.2.0
     1777 * @since BuddyPress (1.2)
    17781778 *
    17791779 * @uses bp_get_activity_comment_form_action()
     
    17861786     * Gets the activity comment form action
    17871787     *
    1788      * @since 1.2.0
     1788     * @since BuddyPress (1.2)
    17891789     *
    17901790     * @uses home_url()
     
    18011801 * Echoes the activity permalink id
    18021802 *
    1803  * @since 1.2.0
     1803 * @since BuddyPress (1.2)
    18041804 *
    18051805 * @uses bp_get_activity_permalink_id()
     
    18121812     * Gets the activity permalink id
    18131813     *
    1814      * @since 1.2.0
     1814     * @since BuddyPress (1.2)
    18151815     *
    18161816     * @uses apply_filters() To call the 'bp_get_activity_permalink_id' hook
     
    18251825 * Echoes the activity thread permalink
    18261826 *
    1827  * @since 1.2.0
     1827 * @since BuddyPress (1.2)
    18281828 *
    18291829 * @uses bp_get_activity_permalink_id()
     
    18361836     * Gets the activity thread permalink
    18371837     *
    1838      * @since 1.2.0
     1838     * @since BuddyPress (1.2)
    18391839     *
    18401840     * @uses bp_activity_get_permalink()
     
    18541854 * Echoes the activity favorite link
    18551855 *
    1856  * @since 1.2.0
     1856 * @since BuddyPress (1.2)
    18571857 *
    18581858 * @uses bp_get_activity_favorite_link()
     
    18651865     * Gets the activity favorite link
    18661866     *
    1867      * @since 1.2.0
     1867     * @since BuddyPress (1.2)
    18681868     *
    18691869     * @global object $activities_template {@link BP_Activity_Template}
     
    18831883 * Echoes the activity unfavorite link
    18841884 *
    1885  * @since 1.2.0
     1885 * @since BuddyPress (1.2)
    18861886 *
    18871887 * @uses bp_get_activity_unfavorite_link()
     
    18941894     * Gets the activity unfavorite link
    18951895     *
    1896      * @since 1.2.0
     1896     * @since BuddyPress (1.2)
    18971897     *
    18981898     * @global object $activities_template {@link BP_Activity_Template}
     
    19121912 * Echoes the activity CSS class
    19131913 *
    1914  * @since 1.0.0
     1914 * @since BuddyPress (1.0)
    19151915 *
    19161916 * @uses bp_get_activity_css_class()
     
    19231923     * Gets the activity CSS class
    19241924     *
    1925      * @since 1.0.0
     1925     * @since BuddyPress (1.0)
    19261926     *
    19271927     * @global object $activities_template {@link BP_Activity_Template}
     
    19581958 * Display the activity delete link.
    19591959 *
    1960  * @since 1.1.0
     1960 * @since BuddyPress (1.1)
    19611961 *
    19621962 * @uses bp_get_activity_delete_link()
     
    19691969     * Return the activity delete link.
    19701970     *
    1971      * @since 1.1.0
     1971     * @since BuddyPress (1.1)
    19721972     *
    19731973     * @global object $activities_template {@link BP_Activity_Template}
     
    20022002 * Display the activity latest update link.
    20032003 *
    2004  * @since 1.2.0
     2004 * @since BuddyPress (1.2)
    20052005 *
    20062006 * @param int $user_id Defaults to 0
     
    20152015     * Return the activity latest update link.
    20162016     *
    2017      * @since 1.2.0
     2017     * @since BuddyPress (1.2)
    20182018     *
    20192019     * @param int $user_id Defaults to 0
     
    20502050 * Display the activity filter links.
    20512051 *
    2052  * @since 1.1.0
     2052 * @since BuddyPress (1.1)
    20532053 *
    20542054 * @param array $args Defaults to false
     
    20632063     * Return the activity filter links.
    20642064     *
    2065      * @since 1.1.0
     2065     * @since BuddyPress (1.1)
    20662066     *
    20672067     * @param array $args Defaults to false
     
    21442144 * Determine if a comment can be made on an activity item
    21452145 *
    2146  * @since 1.2.0
     2146 * @since BuddyPress (1.2)
    21472147 *
    21482148 * @global object $activities_template {@link BP_Activity_Template}
     
    22032203 * Echoes the total favorite count for a specified user
    22042204 *
    2205  * @since 1.2.0
     2205 * @since BuddyPress (1.2)
    22062206 *
    22072207 * @param int $user_id Defaults to 0
     
    22162216     * Returns the total favorite count for a specified user
    22172217     *
    2218      * @since 1.2.0
     2218     * @since BuddyPress (1.2)
    22192219     *
    22202220     * @param int $user_id Defaults to 0
     
    22322232 * Echoes the total mention count for a specified user
    22332233 *
    2234  * @since 1.2.0
     2234 * @since BuddyPress (1.2)
    22352235 *
    22362236 * @param int $user_id Defaults to 0
     
    22452245     * Returns the total mention count for a specified user
    22462246     *
    2247      * @since 1.2.0
     2247     * @since BuddyPress (1.2)
    22482248     *
    22492249     * @param int $user_id Defaults to 0
     
    22592259 * Echoes the public message link for displayed user
    22602260 *
    2261  * @since 1.2.0
     2261 * @since BuddyPress (1.2)
    22622262 *
    22632263 * @uses bp_get_send_public_message_link()
     
    22702270     * Returns the public message link for displayed user
    22712271     *
    2272      * @since 1.2.0
     2272     * @since BuddyPress (1.2)
    22732273     *
    22742274     * @global object $bp BuddyPress global settings
     
    22952295 * Echoes the mentioned user display name
    22962296 *
    2297  * @since 1.2.0
     2297 * @since BuddyPress (1.2)
    22982298 *
    22992299 * @param int|string User id or username
     
    23082308     * Returns the mentioned user display name
    23092309     *
    2310      * @since 1.2.0
     2310     * @since BuddyPress (1.2)
    23112311     *
    23122312     * @param int|string User id or username
     
    23272327 * Output button for sending a public message
    23282328 *
    2329  * @since 1.2.0
     2329 * @since BuddyPress (1.2)
    23302330 *
    23312331 * @param array $args Optional
     
    23402340     * Return button for sending a public message
    23412341     *
    2342      * @since 1.2.0
     2342     * @since BuddyPress (1.2)
    23432343     *
    23442344     * @param array $args Optional
     
    23732373 * Outputs the activity post form action
    23742374 *
    2375  * @since 1.2.0
     2375 * @since BuddyPress (1.2)
    23762376 *
    23772377 * @uses bp_get_activity_post_form_action()
     
    23842384     * Returns the activity post form action
    23852385     *
    2386      * @since 1.2.0
     2386     * @since BuddyPress (1.2)
    23872387     *
    23882388     * @uses home_url()
     
    24012401 * Outputs the sitewide activity feed link
    24022402 *
    2403  * @since 1.0.0
     2403 * @since BuddyPress (1.0)
    24042404 *
    24052405 * @uses bp_get_sitewide_activity_feed_link()
     
    24122412     * Returns the sitewide activity feed link
    24132413     *
    2414      * @since 1.0.0
     2414     * @since BuddyPress (1.0)
    24152415     *
    24162416     * @uses home_url()
     
    24272427 * Outputs the member activity feed link
    24282428 *
    2429  * @since 1.2.0
     2429 * @since BuddyPress (1.2)
    24302430 *
    24312431 * @uses bp_get_member_activity_feed_link()
     
    24382438 * Outputs the member activity feed link
    24392439 *
    2440  * @since 1.0.0
    2441  * @deprecated 1.2.0
     2440 * @since BuddyPress (1.0)
     2441 * @deprecated BuddyPress (1.2)
    24422442 *
    24432443 * @todo properly deprecated in favor of bp_member_activity_feed_link()
     
    24502450     * Returns the member activity feed link
    24512451     *
    2452      * @since 1.2.0
     2452     * @since BuddyPress (1.2)
    24532453     *
    24542454     * @uses bp_is_profile_component()
     
    24842484     * Returns the member activity feed link
    24852485     *
    2486      * @since 1.0.0
    2487      * @deprecated 1.2.0
     2486     * @since BuddyPress (1.0)
     2487     * @deprecated BuddyPress (1.2)
    24882488     *
    24892489     * @todo properly deprecated in favor of bp_get_member_activity_feed_link()
     
    25012501 * Outputs the activity feed item guid
    25022502 *
    2503  * @since 1.0.0
     2503 * @since BuddyPress (1.0)
    25042504 *
    25052505 * @uses bp_activity_feed_item_guid()
     
    25122512     * Returns the activity feed item guid
    25132513     *
    2514      * @since 1.2.0
     2514     * @since BuddyPress (1.2)
    25152515     *
    25162516     * @global object $activities_template {@link BP_Activity_Template}
     
    25282528 * Outputs the activity feed item title
    25292529 *
    2530  * @since 1.0.0
     2530 * @since BuddyPress (1.0)
    25312531 *
    25322532 * @uses bp_get_activity_feed_item_title()
     
    25392539     * Returns the activity feed item title
    25402540     *
    2541      * @since 1.0.0
     2541     * @since BuddyPress (1.0)
    25422542     *
    25432543     * @global object $activities_template {@link BP_Activity_Template}
     
    25722572 * Outputs the activity feed item link
    25732573 *
    2574  * @since 1.0.0
     2574 * @since BuddyPress (1.0)
    25752575 *
    25762576 * @uses bp_get_activity_feed_item_link()
     
    25832583     * Returns the activity feed item link
    25842584     *
    2585      * @since 1.0.0
     2585     * @since BuddyPress (1.0)
    25862586     *
    25872587     * @global object $activities_template {@link BP_Activity_Template}
     
    25992599 * Outputs the activity feed item date
    26002600 *
    2601  * @since 1.0.0
     2601 * @since BuddyPress (1.0)
    26022602 *
    26032603 * @uses bp_get_activity_feed_item_date()
     
    26102610     * Returns the activity feed item date
    26112611     *
    2612      * @since 1.0.0
     2612     * @since BuddyPress (1.0)
    26132613     *
    26142614     * @global object $activities_template {@link BP_Activity_Template}
     
    26262626 * Outputs the activity feed item description
    26272627 *
    2628  * @since 1.0.0
     2628 * @since BuddyPress (1.0)
    26292629 *
    26302630 * @uses bp_get_activity_feed_item_description()
     
    26372637     * Returns the activity feed item description
    26382638     *
    2639      * @since 1.0.0
     2639     * @since BuddyPress (1.0)
    26402640     *
    26412641     * @global object $activities_template {@link BP_Activity_Template}
Note: See TracChangeset for help on using the changeset viewer.