Changeset 9191

Timestamp:

11/26/2014 06:21:42 PM (12 years ago)

Author:

boonebgorges

Message:

Introduce bp_sort_by_key().

A companion for bp_alpha_sort_by_key(), this function allows arrays of
objects or associative arrays to be sorted according to one of their keys/
properties - a kinda-sorta version of wp_list_pluck() for sorting. Supports
numeric as well as alphabetical sorts.

bp_alpha_sort_by_key() is converted to a wrapper of the new function.

Fixes #6047. See #5669.

Location:

trunk

Files:

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

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

@@ -94 +94 @@
 
 /**
- * Sort an array of objects or arrays by alphabetically sorting by a specific key/property.
- *
- * For instance, if you have an array of WordPress post objects, you can sort
- * them by post_name as follows:
- *     $sorted_posts = bp_alpha_sort_by_key( $posts, 'post_name' );
+ * Sort an array of objects or arrays by a specific key/property.
  *
  * The main purpose for this function is so that you can avoid having to create
  * your own awkward callback function for usort().
  *
- * @since BuddyPress (1.9.0)
- *
- * @param array $items The array 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.
- * @return array $items The sorted array.
- */
-function bp_alpha_sort_by_key( $items, $key ) {
+ * @since BuddyPress (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'.
+ * @return array      $items The sorted array.
+ */
+function bp_sort_by_key( $items, $key, $type = 'alpha' ) {
         usort( $items, create_function( '$a, $b', '
                 $values = array( 0 => false, 1 => false, );
@@ -123 +119 @@
 
                 if ( $values[0] && $values[1] ) {
-                        $cmp = strcmp( $values[0], $values[1] );
+                        if ( "num" === "' . $type . '" ) {
+                                $cmp = $values[0] - $values[1];
+                        } else {
+                                $cmp = strcmp( $values[0], $values[1] );
+                        }
+
                         if ( 0 > $cmp ) {
                                 $retval = -1;
@@ -138 +139 @@
 
         return $items;
+}
+
+/**
+ * Sort an array of objects or arrays by alphabetically sorting by a specific key/property.
+ *
+ * For instance, if you have an array of WordPress post objects, you can sort
+ * them by post_name as follows:
+ *     $sorted_posts = bp_alpha_sort_by_key( $posts, 'post_name' );
+ *
+ * @since BuddyPress (1.9.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.
+ * @return array      $items The sorted array.
+ */
+function bp_alpha_sort_by_key( $items, $key ) {
+        return bp_sort_by_key( $items, $key, 'alpha' );
 }
 

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

@@ -188 +188 @@
         }
 
+        /**
+         * @group bp_sort_by_key
+         */
+        public function test_bp_sort_by_key_arrays_num() {
+                $items = array(
+                        array(
+                                'foo' => 'bar',
+                                'value' => 5,
+                        ),
+                        array(
+                                'foo' => 'bar',
+                                'value' => 10,
+                        ),
+                        array(
+                                'foo' => 'bar',
+                                'value' => 1,
+                        ),
+                );
+
+                $expected = array(
+                        array(
+                                'foo' => 'bar',
+                                'value' => 1,
+                        ),
+                        array(
+                                'foo' => 'bar',
+                                'value' => 5,
+                        ),
+                        array(
+                                'foo' => 'bar',
+                                'value' => 10,
+                        ),
+                );
+
+                $this->assertEquals( $expected, bp_sort_by_key( $items, 'value', 'num' ) );
+        }
+
+        /**
+         * @group bp_sort_by_key
+         */
+        public function test_bp_sort_by_key_objects_num() {
+                $items = array(
+                        new stdClass,
+                        new stdClass,
+                        new stdClass,
+                );
+                $items[0]->foo = 'bar';
+                $items[0]->value = 5;
+                $items[1]->foo = 'bar';
+                $items[1]->value = 10;
+                $items[2]->foo = 'bar';
+                $items[2]->value = 1;
+
+                $expected = array(
+                        new stdClass,
+                        new stdClass,
+                        new stdClass,
+                );
+                $expected[0]->foo = 'bar';
+                $expected[0]->value = 1;
+                $expected[1]->foo = 'bar';
+                $expected[1]->value = 5;
+                $expected[2]->foo = 'bar';
+                $expected[2]->value = 10;
+
+                $this->assertEquals( $expected, bp_sort_by_key( $items, 'value', 'num' ) );
+        }
         /**
          * @group bp_alpha_sort_by_key