Merge pull request #45 from stellarwp/feat/adding-the-order-by-param-in-get-all-by

Adding the order by param in the get_all_by method

Author: dpanta94

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file. This project adhere to the [Semantic Versioning](http://semver.org/) standard.
 
+## [3.1.1] 2025-10-01
+
+* Tweak - Fix the `get_all_by` method to accept an order by clause.
+
+[3.1.1]: https://github.com/stellarwp/schema/releases/tag/3.1.1
+
 ## [3.1.0] 2025-09-30
 
 * Feature - Introduce new column types: `Blob_Column`, `Binary_Column`, and `Boolean_Column`.

src/Schema/Tables/Contracts/Table.php

@@ -37,7 +37,7 @@
  * @method static int get_total_items( array $args = [] )
  * @method static bool update_many( array $entries )
  * @method static array paginate( array $args, int $per_page = 20, int $page = 1, array $columns = [ '*' ], string $join_table = '', string $join_condition = '', array $selectable_joined_columns = [], string $output = 'OBJECT' )
- * @method static mixed[] get_all_by( string $column, $value, string $operator = '=', int $limit = 50 )
+ * @method static mixed[] get_all_by( string $column, $value, string $operator = '=', int $limit = 50, string $order_by = '' )
  * @method static ?mixed get_first_by( string $column, $value )
  * @method static ?mixed get_by_id( $id )
  * @method static array operators()

src/Schema/Traits/Custom_Table_Query_Methods.php

@@ -671,24 +671,26 @@ protected static function get_join_parts( string $join_table, string $join_condi
 	 * Gets all models by a column.
 	 *
 	 * @since 3.0.0
+	 * @since 3.1.1 Added the $order_by parameter.
 	 *
 	 * @param string $column   The column to get the models by.
 	 * @param mixed  $value    The value to get the models by.
 	 * @param string $operator The operator to use.
 	 * @param int    $limit    The limit of models to return.
+	 * @param string $order_by The order by clause to use.
 	 *
 	 * @return mixed[] The models, or an empty array if no models are found.
 	 *
 	 * @throws InvalidArgumentException If the column does not exist.
 	 */
-	public static function get_all_by( string $column, $value, string $operator = '=', int $limit = 50 ): ?array{
+	public static function get_all_by( string $column, $value, string $operator = '=', int $limit = 50, string $order_by = '' ): ?array{
 		[ $value, $placeholder ] = self::prepare_value_for_query( $column, $value );
 
 		$operator = strtoupper( $operator );
 
 		$database = Config::get_db();
 		$results  = [];
-		foreach ( static::fetch_all_where( $database::prepare( "WHERE %i {$operator} {$placeholder}", ...array_filter( [ $column, $value ], static fn( $v ) => null !== $v ) ), $limit, ARRAY_A ) as $task_array ) {
+		foreach ( static::fetch_all_where( $database::prepare( "WHERE %i {$operator} {$placeholder}", ...array_filter( [ $column, $value ], static fn( $v ) => null !== $v ) ), $limit, ARRAY_A, $order_by ) as $task_array ) {
 			if ( empty( $task_array[ static::uid_column() ] ) ) {
 				continue;
 			}