Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
05/03/2015 06:51:25 PM (9 years ago)
Author:
tw2113
Message:

First pass at cleanup of Activity component documetnation.

See #6396.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-activity/classes/class-bp-activity-feed.php

    r9819 r9833  
    1818 * See {@link bp_activity_action_sitewide_feed()} as an example.
    1919 *
    20  * Accepted parameters:
    21  *   id               - internal id for the feed; should be alphanumeric only
    22  *                      (required)
    23  *   title            - RSS feed title
    24  *   link             - Relevant link for the RSS feed
    25  *   description      - RSS feed description
    26  *   ttl              - Time-to-live (see inline doc in constructor)
    27  *   update_period    - Part of the syndication module (see inline doc in
    28  *                      constructor for more info)
    29  *   update_frequency - Part of the syndication module (see inline doc in
    30  *                      constructor for more info)
    31  *   max              - Number of feed items to display
    32  *   activity_args    - Arguments passed to {@link bp_has_activities()}
    33  *
     20 * @param array $args {
     21 *   @type string $id               Required. Internal id for the feed; should be alphanumeric only.
     22 *   @type string $title            Optional. RSS feed title.
     23 *   @type string $link             Optional. Relevant link for the RSS feed.
     24 *   @type string $description      Optional. RSS feed description.
     25 *   @type string $ttl              Optional. Time-to-live. (see inline doc in constructor)
     26 *   @type string $update_period    Optional. Part of the syndication module.
     27 *                                            (see inline doc in constructor for more info)
     28 *   @type string $update_frequency Optional. Part of the syndication module.
     29 *                                            (see inline doc in constructor for more info)
     30 *   @type string $max              Optional. Number of feed items to display.
     31 *   @type array  $activity_args    Optional. Arguments passed to {@link bp_has_activities()}
     32 * }
    3433 * @since BuddyPress (1.8.0)
    3534 */
    3635class BP_Activity_Feed {
     36
    3737    /**
    3838     * Holds our custom class properties.
     
    5050     *
    5151     * @param string $key
     52     *
     53     * @return bool Whether or not data variable exists.
    5254     */
    5355    public function __isset( $key ) { return isset( $this->data[$key] ); }
     
    5759     *
    5860     * @param string $key
     61     *
     62     * @return mixed Data in variable if available or null.
    5963     */
    6064    public function __get( $key ) { return isset( $this->data[$key] ) ? $this->data[$key] : null; }
     
    124128         * @since BuddyPress (1.8.0)
    125129         *
    126          * @param BP_Activity_Feed Reference to current instance of activity feed.
     130         * @param BP_Activity_Feed $this Current instance of activity feed. Passed by reference.
    127131         */
    128132        do_action_ref_array( 'bp_activity_feed_prefetch', array( &$this ) );
     
    142146         * @since BuddyPress (1.8.0)
    143147         *
    144          * @param BP_Activity_Feed Reference to current instance of activity feed.
     148         * @param BP_Activity_Feed $this Current instance of activity feed. Passed by reference.
    145149         */
    146150        do_action_ref_array( 'bp_activity_feed_postfetch', array( &$this ) );
Note: See TracChangeset for help on using the changeset viewer.