Changeset 3260 for branches/1.2/bp-core/bp-core-classes.php

Timestamp:

09/13/2010 01:08:31 AM (15 years ago)

Author:

johnjamesjacoby

Message:

Committing patch from #2566 for easier review and testing. Adds BP_Button class and associated template tags. Also includes code formatting fixes, phpdoc, widget fixes when friends component is disabled, and possibly the kitchen sink.

File:

• branches/1.2/bp-core/bp-core-classes.php (modified) (1 diff)

branches/1.2/bp-core/bp-core-classes.php

@@ -496 +496 @@
 }
 
+/**
+ * BP_Button
+ *
+ * API to create BuddyPress buttons
+ *
+ * @package BuddyPress Core
+ * @since 1.2.6
+ */
+class BP_Button {
+
+    // Button properties
+    var $id;
+    var $component;
+    var $must_be_logged_in;
+    var $block_self;
+
+    // Wrapper div
+    var $wrapper_class;
+    var $wrapper_id;
+
+    // Button
+    var $link_href;
+    var $link_class;
+    var $link_id;
+    var $link_rel;
+    var $link_title;
+    var $link_text;
+
+    // HTML result
+    var $contents;
+
+    /**
+     * bp_button()
+     *
+     * Builds the button based on passed parameters:
+     *
+     * component: Which component this button is for
+     * must_be_logged_in: Button only appears for logged in users
+     * block_self: Button will not appear when viewing your own profile.
+     * wrapper_id: The DOM ID of the button wrapper
+     * wrapper_class: The DOM class of the button wrapper
+     * link_href: The destination link of the button
+     * link_title: Title of the button
+     * link_id: The DOM ID of the button
+     * link_class: The DOM class of the button
+     * link_rel: The DOM rel of the button
+     * link_text: The contents of the button
+     *
+     * @param array $args
+     * @return bool False if not allowed
+     */
+    function bp_button( $args = '' ) {
+
+        $defaults = array(
+            'id'                => '',
+            'component'         => 'core',
+            'must_be_logged_in' => true,
+            'block_self'        => true,
+
+            'wrapper_id'        => '',
+            'wrapper_class'     => '',
+
+            'link_href'         => '',
+            'link_title'        => '',
+            'link_id'           => '',
+            'link_class'        => '',
+            'link_rel'          => '',
+            'link_text'         => '',
+        );
+
+        $r = wp_parse_args( $args, $defaults );
+        extract( $r, EXTR_SKIP );
+
+        // Required button properties
+        $this->id                = $id;
+        $this->component         = $component;
+        $this->must_be_logged_in = (bool)$must_be_logged_in;
+        $this->block_self        = (bool)$block_self;
+
+        // $id and $component are required
+        if ( empty( $id ) || empty( $component ) )
+            return false;
+
+        // No button if component is not active
+        if ( !bp_is_active( $this->component ) )
+            return false;
+
+        // No button for guests if must be logged in
+        if ( true == $this->must_be_logged_in && !is_user_logged_in )
+            return false;
+
+        // No button if viewing your own profile
+        if ( true == $this->block_self && bp_is_my_profile() )
+            return false;
+
+        // Wrapper properties
+        if ( !empty( $wrapper_id ) )
+            $this->wrapper_id    = ' id="' . $wrapper_id . '"';
+
+        if ( !empty( $wrapper_class ) )
+            $this->wrapper_class = ' class="generic-button ' . $wrapper_class . '"';
+        else
+            $this->wrapper_class = ' class="generic-button"';
+
+        // Link properties
+        if ( !empty( $link_id ) )
+            $this->link_id       = ' id="' . $link_id . '"';
+
+        if ( !empty( $link_href ) )
+            $this->link_href     = ' href="' . $link_href . '"';
+
+        if ( !empty( $link_title ) )
+            $this->link_title    = ' title="' . $link_title . '"';
+
+        if ( !empty( $link_rel ) )
+            $this->link_rel      = ' rel="' . $link_rel . '"';
+
+        if ( !empty( $link_class ) )
+            $this->link_class    = ' class="' . $link_class . '"';
+
+        if ( !empty( $link_text ) )
+            $this->link_text     = $link_text;
+
+        // Build the button
+        $this->contents  = '<div' . $this->wrapper_class . $this->wrapper_id . '>';
+        $this->contents .= '<a'. $this->link_href . $this->link_title . $this->link_id . $this->link_rel . $this->link_class . '>' . $this->link_text . '</a>';
+        $this->contents .= '</div>';
+
+        // Allow button to be manipulated externally
+        $this->contents = apply_filters( 'bp_button_' . $component . '_' . $id, $this->contents, $this );
+    }
+
+    /**
+     * contents()
+     *
+     * Return contents of button
+     *
+     * @return string
+     */
+    function contents() {
+        return $this->contents;
+    }
+
+    /**
+     * display()
+     *
+     * Output contents of button
+     */
+    function display() {
+        if ( !empty( $this->contents ) )
+            echo $this->contents;
+    }
+}
 
 ?>