Changeset 11082

Timestamp:

09/10/2016 05:14:34 PM (8 years ago)

Author:

dcavins

Message:

bp_sort_by_key(): Add $preserve_keys parameter.

Add a parameter to bp_sort_by_key() so that it calls either usort()
or uasort(), depending on the whether the array keys are important or
not.

Fixes #7238.

Location:

trunk

Files:

• src/bp-core/bp-core-functions.php (modified) (1 diff)
• tests/phpunit/testcases/core/functions.php (modified) (1 diff)

trunk/src/bp-core/bp-core-functions.php

@@ -109 +109 @@
  *
  * @since 2.2.0
- *
- * @param array      $items The items to be sorted. Its constituent items can be either associative arrays or objects.
- * @param string|int $key   The array index or property name to sort by.
- * @param string     $type  Sort type. 'alpha' for alphabetical, 'num' for numeric. Default: 'alpha'.
+ * @since 2.7.0 Added $preserve_keys parameter.
+ *
+ * @param array      $items         The items to be sorted. Its constituent items
+ *                                  can be either associative arrays or objects.
+ * @param string|int $key           The array index or property name to sort by.
+ * @param string     $type          Sort type. 'alpha' for alphabetical, 'num'
+ *                                  for numeric. Default: 'alpha'.
+ * @param bool       $preserve_keys Whether to keep the keys or not.
+ *
  * @return array $items The sorted array.
  */
-function bp_sort_by_key( $items, $key, $type = 'alpha' ) {
-    usort( $items, array( new BP_Core_Sort_By_Key_Callback( $key, $type ), 'sort_callback' ) );
+function bp_sort_by_key( $items, $key, $type = 'alpha', $preserve_keys = false ) {
+    if ( true === $preserve_keys ) {
+        uasort( $items, array( new BP_Core_Sort_By_Key_Callback( $key, $type ), 'sort_callback' ) );
+    } else {
+        usort( $items, array( new BP_Core_Sort_By_Key_Callback( $key, $type ), 'sort_callback' ) );
+    }
 
     return $items;

trunk/tests/phpunit/testcases/core/functions.php

@@ -427 +427 @@
 
         $this->assertEquals( $expected, bp_alpha_sort_by_key( $items, 'name' ) );
+    }
+
+    /**
+     * @group bp_sort_by_key
+     */
+    public function test_bp_sort_by_key_arrays_num_preserve_keys() {
+        $items = array(
+            'p' => array(
+                'foo' => 'bar',
+                'value' => 5,
+            ),
+            'q' => array(
+                'foo' => 'bar',
+                'value' => 10,
+            ),
+            'r' => array(
+                'foo' => 'bar',
+                'value' => 1,
+            ),
+        );
+
+        $expected = array(
+            'r' => array(
+                'foo' => 'bar',
+                'value' => 1,
+            ),
+            'p' => array(
+                'foo' => 'bar',
+                'value' => 5,
+            ),
+            'q' => array(
+                'foo' => 'bar',
+                'value' => 10,
+            ),
+        );
+
+        $this->assertEquals( $expected, bp_sort_by_key( $items, 'value', 'num', true ) );
+    }
+
+    /**
+     * @group bp_sort_by_key
+     */
+    public function test_bp_sort_by_key_num_should_respect_0_preserve_keys() {
+        $items = array(
+            's' => array(
+                'foo' => 'bar',
+                'value' => 2,
+            ),
+            't' => array(
+                'foo' => 'bar',
+                'value' => 0,
+            ),
+            'u' => array(
+                'foo' => 'bar',
+                'value' => 4,
+            ),
+        );
+
+        $expected = array(
+            't' => array(
+                'foo' => 'bar',
+                'value' => 0,
+            ),
+            's' => array(
+                'foo' => 'bar',
+                'value' => 2,
+            ),
+            'u' => array(
+                'foo' => 'bar',
+                'value' => 4,
+            ),
+        );
+
+        $this->assertEquals( $expected, bp_sort_by_key( $items, 'value', 'num', true ) );
     }