Changeset 9515 for trunk/src/bp-activity/bp-activity-template.php

Timestamp:

02/18/2015 09:09:29 PM (10 years ago)

Author:

djpaul

Message:

Replace use of PHP4-era var class properties keywords with public.

Also adds some phpDoc.

Fixes #6185, props henry.wright

File:

• trunk/src/bp-activity/bp-activity-template.php (modified) (2 diffs)

trunk/src/bp-activity/bp-activity-template.php

@@ -115 +115 @@
  */
 class BP_Activity_Template {
-    var $current_activity = -1;
-    var $activity_count;
-    var $total_activity_count;
-    var $activities;
-    var $activity;
-
-    var $in_the_loop;
+    /**
+     * The loop iterator.
+     *
+     * @since BuddyPress (1.5.0)
+     * @access public
+     * @var int
+     */
+    public $current_activity = -1;
+    
+    /**
+     * The activity count.
+     *
+     * @since BuddyPress (1.5.0)
+     * @access public
+     * @var int
+     */
+    public $activity_count;
+    
+    /**
+     * The total activity count.
+     *
+     * @since BuddyPress (1.5.0)
+     * @access public
+     * @var int
+     */
+    public $total_activity_count;
+    
+    /**
+     * Array of activities located by the query.
+     *
+     * @since BuddyPress (1.5.0)
+     * @access public
+     * @var array
+     */
+    public $activities;
+    
+    /**
+     * The activity object currently being iterated on.
+     *
+     * @since BuddyPress (1.5.0)
+     * @access public
+     * @var object
+     */
+    public $activity;
+
+    /**
+     * A flag for whether the loop is currently being iterated.
+     *
+     * @since BuddyPress (1.5.0)
+     * @access public
+     * @var bool
+     */
+    public $in_the_loop;
 
     /**
@@ -129 +175 @@
      * @var string
      */
-    var $pag_arg;
-
-    var $pag_page;
-    var $pag_num;
-    var $pag_links;
-
-    var $full_name;
+    public $pag_arg;
+
+    /**
+     * The page number being requested.
+     *
+     * @since BuddyPress (1.5.0)
+     * @access public
+     * @var int
+     */
+    public $pag_page;
+    
+    /**
+     * The number of items being requested per page.
+     *
+     * @since BuddyPress (1.5.0)
+     * @access public
+     * @var int
+     */
+    public $pag_num;
+    
+    /**
+     * An HTML string containing pagination links.
+     *
+     * @since BuddyPress (1.5.0)
+     * @access public
+     * @var string
+     */
+    public $pag_links;
+
+    /**
+     * The displayed user's full name.
+     *
+     * @since BuddyPress (1.5.0)
+     * @access public
+     * @var string
+     */
+    public $full_name;
 
     /**