Changeset 11114 for trunk/tests/phpunit/testcases/core/class-bp-button.php

Timestamp:

09/19/2016 02:40:27 AM (9 years ago)

Author:

r-a-y

Message:

Core: Refactor BP_Button class to use an easier syntax.

Previously, to use the BP_Button class, a dev would have to define
several parameters in order to render the HTML element for a button:

array(

'wrapper' => 'div',
'wrapper_id' => 'my-wrapper',
'wrapper_class' => 'my-wrapper-class',
'link_href' => 'hxxp://example.com',
'link_class' => 'my-link-class',
'link_id' => 'my-link-id',
'link_rel' => 'nofollow',
'link_title' => 'my-link-title'

)

This commit simplifies the syntax to:

array(

'parent_element' => 'div',
'parent_attr' => array(

'id' => 'my-wrapper',
'class' => 'my-wrapper-class'

),
'button_attr' => array(

'href' => 'hxxp://example.com',
'class' => 'my-link-class',
'id' => 'my-link-id',
'rel' => 'nofollow',
'title' => 'my-link-title'

)

)

The 'parent_attr' and 'button_attr' parameters can use any arbitrary
HTML attribute set as the array key.

This commit also means we are deprecating the older parameters listed in
the first example. However, we still support these parameters via backward
compatibility.

Fixes #7226.

File:

• trunk/tests/phpunit/testcases/core/class-bp-button.php (modified) (1 diff)

trunk/tests/phpunit/testcases/core/class-bp-button.php

@@ -163 +163 @@
         $GLOBALS['members_template'] = null;
     }
+
+    /**
+     * @ticket BP7226
+     */
+    public function test_bp_button_new_args() {
+        $b = new BP_Button( array(
+            'id' => 'foo',
+            'component' => 'members',
+            'block_self' => false,
+            'must_be_logged_in' => false,
+            'parent_element' => 'section',
+            'parent_attr' => array(
+                'class' => 'section-class',
+                'id' => 'section-id',
+                'data-parent' => 'foo',
+            ),
+            'button_element' => 'button',
+            'button_attr' => array(
+                'autofocus' => 'autofocus',
+                'type' => 'submit',
+                'name' => 'my-button'
+            )
+        ) );
+
+        $this->assertNotFalse( strpos( $b->contents, '<section ' ) );
+        $this->assertNotFalse( strpos( $b->contents, 'class="section-class ' ) );
+        $this->assertNotFalse( strpos( $b->contents, 'id="section-id"' ) );
+        $this->assertNotFalse( strpos( $b->contents, 'data-parent="foo"' ) );
+        $this->assertNotFalse( strpos( $b->contents, '<button ' ) );
+        $this->assertNotFalse( strpos( $b->contents, 'autofocus="autofocus"' ) );
+        $this->assertNotFalse( strpos( $b->contents, 'type="submit"' ) );
+        $this->assertNotFalse( strpos( $b->contents, 'name="my-button"' ) );
+    }
+
+    /**
+     * @ticket BP7226
+     */
+    public function test_bp_button_deprecated_args_should_still_render() {
+        $b = new BP_Button( array(
+            'id' => 'foo',
+            'component' => 'members',
+            'block_self' => false,
+            'must_be_logged_in' => false,
+            'wrapper' => 'section',
+            'wrapper_class' => 'section-class',
+            'wrapper_id' => 'section-id',
+            'link_href' => 'http://example.com',
+            'link_class' => 'link-class',
+            'link_id' => 'link-id',
+            'link_rel' => 'nofollow',
+            'link_title' => 'link-title'
+        ) );
+
+        $this->assertNotFalse( strpos( $b->contents, '<section ' ) );
+        $this->assertNotFalse( strpos( $b->contents, 'class="section-class ' ) );
+        $this->assertNotFalse( strpos( $b->contents, 'id="section-id"' ) );
+        $this->assertNotFalse( strpos( $b->contents, 'href="http://example.com"' ) );
+        $this->assertNotFalse( strpos( $b->contents, 'class="link-class"' ) );
+        $this->assertNotFalse( strpos( $b->contents, 'id="link-id"' ) );
+        $this->assertNotFalse( strpos( $b->contents, 'rel="nofollow"' ) );
+        $this->assertNotFalse( strpos( $b->contents, 'title="link-title"' ) );
+    }
+
+    /**
+     * @ticket BP7226
+     */
+    public function test_bp_button_new_element_attrs_have_precedence_over_deprecated_element_attrs() {
+        $b = new BP_Button( array(
+            'id' => 'foo',
+            'component' => 'members',
+            'block_self' => false,
+            'must_be_logged_in' => false,
+            'button_element' => 'button',
+            'button_attr' => array(
+                'class' => 'new-class',
+            ),
+            'link_class' => 'old-class'
+        ) );
+
+        $this->assertNotFalse( strpos( $b->contents, '<button class="new-class"' ) );
+    }
+
+    /**
+     * @ticket BP7226
+     */
+    public function test_bp_button_new_element_attrs_should_not_render_for_empty_attrs() {
+        $b = new BP_Button( array(
+            'id' => 'foo',
+            'component' => 'members',
+            'block_self' => false,
+            'must_be_logged_in' => false,
+            'button_element' => 'button',
+            'button_attr' => array(
+                'class' => '',
+            ),
+        ) );
+
+        $this->assertFalse( strpos( $b->contents, '<button class=""' ) );
+    }
 }