Changeset 46209

Timestamp:

09/20/2019 08:29:30 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Privacy: Display group items count in the personal data export file if there's more than one item in the group.

Props birgire, garrett-eclipse, pputzer.
Fixes #46895.

Location:

trunk

Files:

• src/wp-admin/includes/privacy-tools.php (modified) (1 diff)
• tests/phpunit/tests/privacy/wpPrivacyGeneratePersonalDataExportGroupHtml.php (modified) (3 diffs)

trunk/src/wp-admin/includes/privacy-tools.php

@@ -235 +235 @@
  */
 function wp_privacy_generate_personal_data_export_group_html( $group_data ) {
-    $group_html = '<h2>' . esc_html( $group_data['group_label'] ) . '</h2>';
+    $group_html  = '<h2>';
+    $group_html .= esc_html( $group_data['group_label'] );
+
+    $items_count = count( (array) $group_data['items'] );
+    if ( $items_count > 1 ) {
+        $group_html .= sprintf( ' <span class="count">(%d)</span>', $items_count );
+    }
+
+    $group_html .= '</h2>';
 
     if ( ! empty( $group_data['group_description'] ) ) {

trunk/tests/phpunit/tests/privacy/wpPrivacyGeneratePersonalDataExportGroupHtml.php

@@ -51 +51 @@
      *
      * @ticket 44044
+     * @ticket 46895 Updated to remove </h2> from test to avoid Count introducing failure.
      */
     public function test_group_html_generation_multiple_data_items() {
@@ -81 +82 @@
         $actual = wp_privacy_generate_personal_data_export_group_html( $data );
 
-        $this->assertContains( '<h2>Test Data Group</h2>', $actual );
+        $this->assertContains( '<h2>Test Data Group', $actual );
         $this->assertContains( '<td>Field 1 Value', $actual );
         $this->assertContains( '<td>Another Field 1 Value', $actual );
@@ -198 +199 @@
         $this->assertContains( '<th>Images are not allowed</th><td></td>', $actual );
     }
+
+    /**
+     * Test group count is displayed for multiple items.
+     *
+     * @ticket 46895
+     */
+    public function test_group_html_generation_should_display_group_count_when_multiple_items() {
+        $data = array(
+            'group_label' => 'Test Data Group',
+            'items'       => array(
+                array(
+                    array(
+                        'name'  => 'Field 1 Name',
+                        'value' => 'Field 1 Value',
+                    ),
+                ),
+                array(
+                    array(
+                        'name'  => 'Field 2 Name',
+                        'value' => 'Field 2 Value',
+                    ),
+                ),
+            ),
+        );
+
+        $actual = wp_privacy_generate_personal_data_export_group_html( $data );
+
+        $this->assertContains( '<h2>Test Data Group', $actual );
+        $this->assertContains( '<span class="count">(2)</span></h2>', $actual );
+        $this->assertSame( 2, substr_count( $actual, '<table>' ) );
+    }
+
+    /**
+     * Test group count is not displayed for a single item.
+     *
+     * @ticket 46895
+     */
+    public function test_group_html_generation_should_not_display_group_count_when_single_item() {
+        $data = array(
+            'group_label' => 'Test Data Group',
+            'items'       => array(
+                array(
+                    array(
+                        'name'  => 'Field 1 Name',
+                        'value' => 'Field 1 Value',
+                    ),
+                ),
+            ),
+        );
+
+        $actual = wp_privacy_generate_personal_data_export_group_html( $data );
+
+        $this->assertContains( '<h2>Test Data Group</h2>', $actual );
+        $this->assertNotContains( '<span class="count">', $actual );
+        $this->assertSame( 1, substr_count( $actual, '<table>' ) );
+    }
 }