Ticket #7226: 7226-06.patch

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

@@ -33 +33 @@
  *                                          Default: ''.
  *     @type string      $wrapper_class     Optional. DOM class of the button wrapper
  *                                          element. Default: ''.
+ *     @type string      $li_class          Optional: Available if $wrapper set to ul & li elements created
+ *                                          Default: ''.
+ *     @type string      $element           Optional. The type of element to use e.g 'anchor', 'button', 'input'
+ *                                          Default: 'anchor'.
+ *     @type string      $element_type      Optional. Set the button type i.e like input types
+ *                                          Defaults to 'button' [type="button"] can be 'submit' [type="submit"]
+ *     @type string      $name              Button/input 'name' value - if type == 'submit' || 'reset.
+ *     @type string      $value             Button/input 'value' value - if type == 'submit' || 'reset'.
  *     @type string      $link_href         Optional. Destination link of the button.
  *                                          Default: ''.
+ *     @type string      $data_attr         Optional. Allow data attributtes to be set. e.g 'data-bp-buttons=""'
+ *                                          Takes an array of key/value pairs to allow for multiple attrs.
+ *                                          Default: ''.
  *     @type string      $link_class        Optional. DOM class of the button. Default: ''.
  *     @type string      $link_id           Optional. DOM ID of the button. Default: ''.
  *     @type string      $link_rel          Optional. DOM 'rel' attribute of the button.
@@ -82 +93 @@
         /**
          * The type of DOM element to use for a wrapper.
          *
-         * @var string|bool 'div', 'span', 'p', 'li', or false for no wrapper.
+         * @var string|bool 'div', 'li',  'p', 'span' or false for no wrapper.
          */
         public $wrapper = 'div';
 
@@ -100 +111 @@
          */
         public $wrapper_id = '';
 
+        /**
+         * The DOM class of li child elements the wrapper as a ul.
+         *
+         * @var string
+         */
+
+        public $li_class = '';
+
         /** Button ****************************************************************/
 
         /**
+        * The node element type type i.e. a true '<button>', '<a>' or '<input />':
+        * 'button', 'anchor', 'input'
+        *
+        * @var string
+        */
+        public $element = 'anchor';
+
+        /**
+        * The button/input elements type i.e. 'submit', 'button', 'reset'.
+        *
+        *
+        * @var string
+        */
+        public $element_type = 'button';
+
+        /**
+        * The button/input elements name attr i.e. 'name=""'.
+        *
+        *
+        * @var string
+        */
+        public $name = '';
+
+        /**
+        * The button/input elements value attr i.e. 'value=""'.
+        *
+        *
+        * @var string
+        */
+        public $value = '';
+
+
+        /**
          * The destination link of the button.
          *
          * @var string
@@ -138 +190 @@
         public $link_title = '';
 
         /**
+         * Data attributes.
+                * Takes an array of key/value pairs to loop over.
+         *
+         * @var array
+         */
+        public $data_attr = '';
+
+        /**
          * The contents of the button link.
          *
          * @var string
@@ -164 +224 @@
                 $r = wp_parse_args( $args, get_class_vars( __CLASS__ ) );
 
                 // Required button properties.
-                $this->id                = $r['id'];
+                $this->id                = esc_attr( $r['id'] );
                 $this->component         = $r['component'];
                 $this->must_be_logged_in = (bool) $r['must_be_logged_in'];
                 $this->block_self        = (bool) $r['block_self'];
-                $this->wrapper           = $r['wrapper'];
+                $this->wrapper           = esc_attr( $r['wrapper'] ) ;
 
                 // $id and $component are required
                 if ( empty( $r['id'] ) || empty( $r['component'] ) )
@@ -202 +262 @@
                 // Wrapper properties.
                 if ( false !== $this->wrapper ) {
 
+                /**
+                        * Currently BP does not provide for a wrapping group element, templates
+                        * would need to provide the  parent wrapper in the template if li
+                        * specified as wrapper.
+                        */
+
+                /**
+                        * If 'li' is set for $wrapper we'll create
+                        * & add class tokens if args not empty.
+                        */
+                        if( 'li' == $this->wrapper ) {
+                                if( !empty( $r['li_class'] ) ) $this->li_class = ' class="' . esc_attr( $r['li_class'] ) . '"';
+                        }
+
                         // Wrapper ID.
                         if ( !empty( $r['wrapper_id'] ) ) {
-                                $this->wrapper_id    = ' id="' . $r['wrapper_id'] . '"';
+                                $this->wrapper_id  = ' id="' . esc_attr( $r['wrapper_id'] ) . '"';
                         }
 
                         // Wrapper class.
-                        if ( !empty( $r['wrapper_class'] ) ) {
-                                $this->wrapper_class = ' class="generic-button ' . $r['wrapper_class'] . '"';
+                        if ( !empty( $r['wrapper_class'] ) && 'li' !== $this->wrapper ) {
+                                $this->wrapper_class = ' class="generic-button ' . esc_attr( $r['wrapper_class'] ) . '"';
+                        } elseif( 'li' == $this->wrapper ) {
+                                                if( !empty( $r['li_class'] ) ) $this->wrapper_class = ' class="generic-button ' . esc_attr( $r['li_class'] ) . '"';
                         } else {
                                 $this->wrapper_class = ' class="generic-button"';
                         }
 
                         // Set before and after.
-                        $before = '<' . $r['wrapper'] . $this->wrapper_class . $this->wrapper_id . '>';
-                        $after  = '</' . $r['wrapper'] . '>';
+                        // Include 'li' elements if wrapper = 'ul'
+                        $before = '<'  . $this->wrapper . $this->wrapper_class . $this->wrapper_id . '>';
+                        $after  = '</' . $this->wrapper . '>';
 
                 // No wrapper.
                 } else {
@@ -223 +300 @@
                         $before = $after = '';
                 }
 
-                // 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']  . '"';
-                if ( !empty( $r['link_title'] ) ) $this->link_title = ' title="' . $r['link_title'] . '"';
-                if ( !empty( $r['link_rel']   ) ) $this->link_rel   = ' rel="' .   $r['link_rel']   . '"';
-                if ( !empty( $r['link_class'] ) ) $this->link_class = ' class="' . $r['link_class'] . '"';
-                if ( !empty( $r['link_text']  ) ) $this->link_text  =              $r['link_text'];
+                // Link/Button/input  attributes.
+                //if ( !empty( $r['element']    ) ) $this->element    =
+                if ( 'button' == $r['element'] || 'input' == $r['element'] ) {
+                        if ( !empty( $r['element_type'] ) ) $this->element_type = ' type="' . esc_attr( $r['element_type'] ) . '"';
+                        if( 'submit' == $r['element_type'] || 'reset' == $r['element_type'] ) {
+                                if ( !empty( $r['name']  ) ) $this->name  = ' name="'  . esc_attr( $r['name'] )  . '"';
+                                if ( !empty( $r['value'] ) ) $this->value = ' value="' . esc_attr( $r['value'] ) . '"';
+                        }
+                }
 
+                if ( !empty( $r['link_id']    ) ) $this->link_id    = ' id="'    .   esc_attr( $r['link_id'] )   . '"';
+                // No href if we're a button please!
+                if ( !empty( $r['link_href']  ) ) $this->link_href  = ' href="'  .   esc_url(  $r['link_href'] )  . '"';
+                if ( !empty( $r['link_title'] ) ) $this->link_title = ' title="' .   esc_attr( $r['link_title'] ) . '"';
+                if ( !empty( $r['link_rel']   ) ) $this->link_rel   = ' rel="'   .   esc_attr( $r['link_rel'] )   . '"';
+                if ( !empty( $r['link_class'] ) ) $this->link_class = ' class="' .   esc_attr( $r['link_class'] ) . '"';
+                if ( !empty( $r['link_text']  ) && 'input' !== $r['element'] ) $this->link_text  = esc_html( $r['link_text'] );
+
+                /**
+                * Build data attr to display
+                * loop over $r['data_attr'] & build as many data-foo="bar" instances as array pairs found
+                */
+
+                if ( !empty( $r['data_attr'] ) ) {
+
+                        $data_attr = $r['data_attr'];
+                        foreach ($data_attr as $key => $value) {
+                        $this->data_attr .= 'data-' . sanitize_key( $key ) . '="' . esc_attr( $value ) . '"';
+                        }
+
+                } else {
+                        $this->data_attr = '';
+                }
+
+                // The wrapper element
+
+                // The element tag: e.g '<a', '<button'
+
+                if ( 'button' == $r['element'] || 'input' == $r['element'] ) {
+
+                        // If the element type is submit we'll build the button/input form controls attr here
+                        if( 'submit' == $r['element_type'] ) {
+                                $element_controls = $this->name . $this->value ;
+                        } else {
+                                $element_controls = '';
+                        }
+
+                        if ( 'button' == $r['element'] ){
+                                        $before_element = '<button ' . $this->element_type . $element_controls;
+                                        $after_element  = '</button>';
+                        } elseif( 'input' == $r['element'] ) {
+                                        $before_element = '<input ' . $this->element_type . $element_controls;
+                                        $after_element  = '';
+                        }
+
+
+                } else {
+                        $before_element = '<a ' . $this->link_href;
+                        $after_element  = '</a>';
+                }
+
                 // 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;
+                // attr here can be applicable/common to anchors or button elements
+                $this->contents = $before . $before_element . $this->link_title . $this->link_id . $this->link_rel . $this->data_attr . $this->link_class . '>' . $this->link_text . $after_element . $after;
 
                 /**
                  * Filters the button based on class parameters.
@@ -246 +377 @@
                  * @param BP_Button $this     Current BP_Button instance.
                  * @param string    $before   HTML appended before the actual button.
                  * @param string    $after    HTML appended after the actual button.
+                 * @param string    $before_element  Actual items opening element.
+                 * @param string    $after_element   Actual items closing element  .
                  */
-                $this->contents = apply_filters( 'bp_button_' . $this->component . '_' . $this->id, $this->contents, $this, $before, $after );
+                $this->contents = apply_filters( 'bp_button_' . $this->component . '_' . $this->id, $this->contents, $this, $before, $after, $before_element, $after_element );
         }
 
         /**