Changeset 8758

Timestamp:

08/05/2014 04:10:55 PM (12 years ago)

Author:

johnjamesjacoby

Message:

Clean up BP_Blogs_Template() methods:

• Add inline doc
• Use public modifiers
• Normalize comparisons
• Add default variable values
• Add brackets and bring code formatting up to date
• Use empty() checks where appropriate

File:

• trunk/src/bp-blogs/bp-blogs-template.php (modified) (17 diffs)

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

@@ -91 +91 @@
      * @var int
      */
-    var $current_blog = -1;
+    public $current_blog = -1;
 
     /**
@@ -99 +99 @@
      * @var int
      */
-    var $blog_count;
+    public $blog_count = 0;
 
     /**
@@ -107 +107 @@
      * @var array
      */
-    var $blogs;
+    public $blogs = array();
 
     /**
@@ -115 +115 @@
      * @var object
      */
-    var $blog;
+    public $blog;
 
     /**
@@ -123 +123 @@
      * @var bool
      */
-    var $in_the_loop;
+    public $in_the_loop = false;
 
     /**
@@ -131 +131 @@
      * @var public
      */
-    var $pag_page;
+    public $pag_page = 1;
 
     /**
@@ -139 +139 @@
      * @var public
      */
-    var $pag_num;
+    public $pag_num = 20;
 
     /**
@@ -147 +147 @@
      * @var string
      */
-    var $pag_links;
+    public $pag_links = '';
 
     /**
@@ -155 +155 @@
      * @var int
      */
-    var $total_blog_count;
+    public $total_blog_count = 0;
 
     /**
@@ -174 +174 @@
      * @param array $include_blog_ids Array of blog IDs to include.
      */
-    function __construct( $type, $page, $per_page, $max, $user_id, $search_terms, $page_arg = 'bpage', $update_meta_cache = true, $include_blog_ids = false ) {
-
-        $this->pag_page = isset( $_REQUEST[$page_arg] ) ? intval( $_REQUEST[$page_arg] ) : $page;
-        $this->pag_num = isset( $_REQUEST['num'] ) ? intval( $_REQUEST['num'] ) : $per_page;
-
-        if ( isset( $_REQUEST['letter'] ) && '' != $_REQUEST['letter'] ) {
+    public function __construct( $type, $page, $per_page, $max, $user_id, $search_terms, $page_arg = 'bpage', $update_meta_cache = true, $include_blog_ids = false ) {
+
+        $this->pag_page = isset( $_REQUEST[ $page_arg ] ) ? intval( $_REQUEST[ $page_arg ] ) : $page;
+        $this->pag_num  = isset( $_REQUEST['num']       ) ? intval( $_REQUEST['num']       ) : $per_page;
+
+        // Backwards compatibility support for blogs by first letter
+        if ( ! empty( $_REQUEST['letter'] ) ) {
             $this->blogs = BP_Blogs_Blog::get_by_letter( $_REQUEST['letter'], $this->pag_num, $this->pag_page );
+
+        // Typical blogs query
         } else {
             $this->blogs = bp_blogs_get_blogs( array(
@@ -193 +196 @@
         }
 
-        if ( !$max || $max >= (int) $this->blogs['total'] )
+        // Set the total blog count
+        if ( empty( $max ) || ( $max >= (int) $this->blogs['total'] ) ) {
             $this->total_blog_count = (int) $this->blogs['total'];
-        else
+        } else {
             $this->total_blog_count = (int) $max;
-
+        }
+
+        // Set the blogs array (to loop through later
         $this->blogs = $this->blogs['blogs'];
 
-        if ( $max ) {
-            if ( $max >= count($this->blogs) ) {
-                $this->blog_count = count( $this->blogs );
-            } else {
-                $this->blog_count = (int) $max;
-            }
+        // Get the current blog count to compare maximum against
+        $blog_count = count( $this->blogs );
+
+        // Set the current blog count
+        if ( empty( $max ) || ( $max >= (int) $blog_count ) ) {
+            $this->blog_count = (int) $blog_count;
         } else {
-            $this->blog_count = count( $this->blogs );
-        }
-
-        if ( (int) $this->total_blog_count && (int) $this->pag_num ) {
+            $this->blog_count = (int) $max;
+        }
+
+        // Build pagination links based on total blogs and current page number
+        if ( ! empty( $this->total_blog_count ) && ! empty( $this->pag_num ) ) {
             $this->pag_links = paginate_links( array(
                 'base'      => add_query_arg( $page_arg, '%#%' ),
@@ -217 +224 @@
                 'current'   => (int) $this->pag_page,
                 'prev_text' => _x( '←', 'Blog pagination previous text', 'buddypress' ),
-                'next_text' => _x( '→', 'Blog pagination next text', 'buddypress' ),
+                'next_text' => _x( '→', 'Blog pagination next text',     'buddypress' ),
                 'mid_size'  => 1
             ) );
@@ -230 +237 @@
      * @return bool True if there are items in the loop, otherwise false.
      */
-    function has_blogs() {
-        if ( $this->blog_count )
-            return true;
-
-        return false;
+    public function has_blogs() {
+        return (bool) ! empty( $this->blog_count );
     }
 
@@ -242 +246 @@
      * @return object The next blog to iterate over.
      */
-    function next_blog() {
+    public function next_blog() {
         $this->current_blog++;
-        $this->blog = $this->blogs[$this->current_blog];
+        $this->blog = $this->blogs[ $this->current_blog ];
 
         return $this->blog;
@@ -252 +256 @@
      * Rewind the blogs and reset blog index.
      */
-    function rewind_blogs() {
+    public function rewind_blogs() {
         $this->current_blog = -1;
         if ( $this->blog_count > 0 ) {
@@ -270 +274 @@
      * @return bool True if there are more blogs to show, otherwise false.
      */
-    function blogs() {
-        if ( $this->current_blog + 1 < $this->blog_count ) {
+    public function blogs() {
+        if ( ( $this->current_blog + 1 ) < $this->blog_count ) {
             return true;
-        } elseif ( $this->current_blog + 1 == $this->blog_count ) {
-            do_action('blog_loop_end');
+        } elseif ( ( $this->current_blog + 1 ) === $this->blog_count ) {
+            do_action( 'blog_loop_end' );
             // Do some cleaning up after the loop
             $this->rewind_blogs();
@@ -292 +296 @@
      * @see bp_the_blog()
      */
-    function the_blog() {
+    public function the_blog() {
 
         $this->in_the_loop = true;
         $this->blog        = $this->next_blog();
 
-        if ( 0 == $this->current_blog ) // loop has just started
-            do_action('blog_loop_start');
+        // loop has just started
+        if ( 0 === $this->current_blog ) {
+            do_action( 'blog_loop_start' );
+        }
     }
 }