Merge pull request #8837 from MrPetovan/bug/8829-add-expected-sort-string-support

Add expected support for sort strings in select() parameters
This commit is contained in:
Tobias Diekershoff 2020-07-02 06:59:25 +02:00 committed by GitHub
commit ecb9eecdc8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 38 additions and 14 deletions

View file

@ -648,6 +648,20 @@ class DBA
/** /**
* Returns the SQL parameter string built from the provided parameter array * Returns the SQL parameter string built from the provided parameter array
* *
* Expected format for each key:
*
* group_by:
* - list of column names
*
* order:
* - numeric keyed column name => ASC
* - associative element with boolean value => DESC (true), ASC (false)
* - associative element with string value => 'ASC' or 'DESC' literally
*
* limit:
* - single numeric value => count
* - list with two numeric values => offset, count
*
* @param array $params * @param array $params
* @return string * @return string
*/ */
@ -665,7 +679,11 @@ class DBA
if ($order === 'RAND()') { if ($order === 'RAND()') {
$order_string .= "RAND(), "; $order_string .= "RAND(), ";
} elseif (!is_int($fields)) { } elseif (!is_int($fields)) {
$order_string .= self::quoteIdentifier($fields) . " " . ($order ? "DESC" : "ASC") . ", "; if ($order !== 'DESC' && $order !== 'ASC') {
$order = $order ? 'DESC' : 'ASC';
}
$order_string .= self::quoteIdentifier($fields) . " " . $order . ", ";
} else { } else {
$order_string .= self::quoteIdentifier($order) . ", "; $order_string .= self::quoteIdentifier($order) . ", ";
} }

View file

@ -1467,24 +1467,30 @@ class Database
/** /**
* Select rows from a table * Select rows from a table
* *
*
* Example:
* $table = 'item';
* or:
* $table = ['schema' => 'table'];
* @see DBA::buildTableString()
*
* $fields = ['id', 'uri', 'uid', 'network'];
*
* $condition = ['uid' => 1, 'network' => 'dspr', 'blocked' => true];
* or:
* $condition = ['`uid` = ? AND `network` IN (?, ?)', 1, 'dfrn', 'dspr'];
* @see DBA::buildCondition()
*
* $params = ['order' => ['id', 'received' => true, 'created' => 'ASC'), 'limit' => 10];
* @see DBA::buildParameter()
*
* $data = DBA::select($table, $fields, $condition, $params);
*
* @param string|array $table Table name or array [schema => table] * @param string|array $table Table name or array [schema => table]
* @param array $fields Array of selected fields, empty for all * @param array $fields Array of selected fields, empty for all
* @param array $condition Array of fields for condition * @param array $condition Array of fields for condition
* @param array $params Array of several parameters * @param array $params Array of several parameters
*
* @return boolean|object * @return boolean|object
*
* Example:
* $table = "item";
* $fields = array("id", "uri", "uid", "network");
*
* $condition = array("uid" => 1, "network" => 'dspr');
* or:
* $condition = array("`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr');
*
* $params = array("order" => array("id", "received" => true), "limit" => 10);
*
* $data = DBA::select($table, $fields, $condition, $params);
* @throws \Exception * @throws \Exception
*/ */
public function select($table, array $fields = [], array $condition = [], array $params = []) public function select($table, array $fields = [], array $condition = [], array $params = [])