Changeset 10355 for trunk/src/bp-core/classes/class-bp-button.php

Timestamp:

11/15/2015 07:13:42 PM (11 years ago)

Author:

tw2113

Message:

More documentation cleanup for part of BP-Core component.

See #6398.

File:

• trunk/src/bp-core/classes/class-bp-button.php (modified) (7 diffs)

trunk/src/bp-core/classes/class-bp-button.php

@@ -144 +144 @@
     public $link_text = '';
 
-    /** HTML result ***********************************************************/
-
+    /** HTML result
+     *
+     * @var string
+     */
     public $contents = '';
 
@@ -161 +163 @@
         $r = wp_parse_args( $args, get_class_vars( __CLASS__ ) );
 
-        // Required button properties
+        // Required button properties.
         $this->id                = $r['id'];
         $this->component         = $r['component'];
@@ -172 +174 @@
             return false;
 
-        // No button if component is not active
+        // No button if component is not active.
         if ( ! bp_is_active( $this->component ) )
             return false;
 
-        // No button for guests if must be logged in
+        // No button for guests if must be logged in.
         if ( true == $this->must_be_logged_in && ! is_user_logged_in() )
             return false;
 
-        // block_self
+        // The block_self property.
         if ( true == $this->block_self ) {
             // No button if you are the current user in a members loop
             // This condition takes precedence, because members loops
-            // can be found on user profiles
+            // can be found on user profiles.
             if ( bp_get_member_user_id() ) {
                 if ( is_user_logged_in() && bp_loggedin_user_id() == bp_get_member_user_id() ) {
@@ -191 +193 @@
 
             // No button if viewing your own profile (and not in
-            // a members loop)
+            // a members loop).
             } elseif ( bp_is_my_profile() ) {
                 return false;
@@ -197 +199 @@
         }
 
-        // Wrapper properties
+        // Wrapper properties.
         if ( false !== $this->wrapper ) {
 
-            // Wrapper ID
+            // Wrapper ID.
             if ( !empty( $r['wrapper_id'] ) ) {
                 $this->wrapper_id    = ' id="' . $r['wrapper_id'] . '"';
             }
 
-            // Wrapper class
+            // Wrapper class.
             if ( !empty( $r['wrapper_class'] ) ) {
                 $this->wrapper_class = ' class="generic-button ' . $r['wrapper_class'] . '"';
@@ -212 +214 @@
             }
 
-            // Set before and after
+            // Set before and after.
             $before = '<' . $r['wrapper'] . $this->wrapper_class . $this->wrapper_id . '>';
             $after  = '</' . $r['wrapper'] . '>';
 
-        // No wrapper
+        // No wrapper.
         } else {
             $before = $after = '';
         }
 
-        // Link properties
+        // Link properties.
         if ( !empty( $r['link_id']    ) ) $this->link_id    = ' id="' .    $r['link_id']    . '"';
         if ( !empty( $r['link_href']  ) ) $this->link_href  = ' href="' .  $r['link_href']  . '"';
@@ -229 +231 @@
         if ( !empty( $r['link_text']  ) ) $this->link_text  =              $r['link_text'];
 
-        // Build the button
+        // Build the button.
         $this->contents = $before . '<a'. $this->link_href . $this->link_title . $this->link_id . $this->link_rel . $this->link_class . '>' . $this->link_text . '</a>' . $after;