Fix: Options class now considers add()ed options for ordering, filtering and limiting.

Author: AllanJard

Database/Query.php

@@ -1313,8 +1313,6 @@ protected function _where($where, $value = null, $type = 'AND ', $op = '=', $bin
 	/**
 	 * Add parentheses to a where condition.
 	 *
-	 * @return void
-	 *
 	 * @internal
 	 */
 	protected function _where_group($inOut, $op)

Editor/Options.php

@@ -112,7 +112,10 @@ class Options extends Ext
 	 */
 
 	/**
-	 * Add extra options to the list, in addition to any obtained from the database.
+	 * Add extra options to the list, in addition to any obtained from the database. Note
+	 * that these go through the same filtering and ordering operation as database retrieved
+	 * values (they are merged together if both are used). Use a custom function if you want
+	 * complete control over the options and their order.
 	 *
 	 * @param string      $label The label to use for the option
 	 * @param string|null $value Value for the option. If not given, the label will be used
@@ -357,11 +360,6 @@ public function exec($db, $refresh, $search = null, $find = null)
 		$value = $this->_value;
 		$formatter = $this->_renderer;
 
-		// Create a list of the fields that we need to get from the db
-		$fields = [];
-		$fields[] = $value;
-		$fields = array_merge($fields, $label);
-
 		// We need a default formatter if one isn't provided
 		if (!$formatter) {
 			$formatter = static function ($row) use ($label) {
@@ -376,52 +374,20 @@ public function exec($db, $refresh, $search = null, $find = null)
 		}
 
 		// Get the data
-		$q = $db
-			->query('select')
-			->distinct(true)
-			->table($this->_table)
-			->left_join($this->_leftJoin)
-			->get($fields)
-			->where($this->_where);
+		$options = $this->execDb($db, $find);
 
-		if (is_array($find)) {
-			$q->where_in($value, $find);
+		// Manually added options
+		for ($i = 0; $i < count($this->_manualAdd); ++$i) {
+			$options[] = $this->_manualAdd[$i];
 		}
 
-		if (is_string($this->_order)) {
-			// For cases where we are ordering by a field which isn't included in the list
-			// of fields to display, we need to add the ordering field, due to the
-			// select distinct.
-			$orderFields = explode(',', $this->_order);
-
-			for ($i = 0, $ien = count($orderFields); $i < $ien; ++$i) {
-				$field = strtolower($orderFields[$i]);
-				$field = str_replace(' asc', '', $field);
-				$field = str_replace(' desc', '', $field);
-				$field = trim($field);
-
-				if (!in_array($field, $fields)) {
-					$q->get($field);
-				}
-			}
-
-			$q->order($this->_order);
-		} elseif ($this->_order === true) {
-			// Attempt to do a database order, needed for "limit()"ed results
-			$q->order($this->_label[0]);
-		}
-
-		$rows = $q
-			->exec()
-			->fetchAll();
-
 		// Create the output array
 		$out = [];
 		$max = $this->_limit;
 
-		for ($i = 0, $ien = count($rows); $i < $ien; ++$i) {
-			$rowLabel = $formatter($rows[$i]);
-			$rowValue = $rows[$i][$value];
+		for ($i = 0, $ien = count($options); $i < $ien; ++$i) {
+			$rowLabel = $formatter($options[$i]);
+			$rowValue = $options[$i][$value];
 
 			// Apply the search to the rendered label. Need to do it here rather than in SQL since
 			// the label is rendered in PHP.
@@ -436,7 +402,7 @@ public function exec($db, $refresh, $search = null, $find = null)
 					$inc = $this->_includes[$j];
 
 					if (isset($rows[$i][$inc])) {
-						$option[$inc] = $rows[$i][$inc];
+						$option[$inc] = $options[$i][$inc];
 					}
 				}
 
@@ -450,11 +416,6 @@ public function exec($db, $refresh, $search = null, $find = null)
 			}
 		}
 
-		// Stick on any extra manually added options
-		if (count($this->_manualAdd)) {
-			$out = array_merge($out, $this->_manualAdd);
-		}
-
 		// Local sorting
 		if ($this->_order === true) {
 			usort($out, static function ($a, $b) {
@@ -469,15 +430,62 @@ public function exec($db, $refresh, $search = null, $find = null)
 					$bLabel = '';
 				}
 
-				return is_numeric($aLabel) && is_numeric($bLabel) ?
-					($aLabel * 1) - ($bLabel * 1) :
-				strcmp($aLabel, $bLabel);
+				return is_numeric($aLabel) && is_numeric($bLabel)
+					? ($aLabel * 1) - ($bLabel * 1)
+					: strcmp($aLabel, $bLabel);
 			});
 		}
 
 		return $out;
 	}
 
+	public function execDb($db, $find)
+	{
+		// Create a list of the fields that we need to get from the db
+		$fields = [];
+		$fields[] = $this->_value;
+		$fields = array_merge($fields, $this->_label);
+
+		$q = $db
+			->query('select')
+			->distinct(true)
+			->table($this->_table)
+			->left_join($this->_leftJoin)
+			->get($fields)
+			->where($this->_where);
+
+		if (is_array($find)) {
+			$q->where_in($this->_value, $find);
+		}
+
+		if (is_string($this->_order)) {
+			// For cases where we are ordering by a field which isn't included in the list
+			// of fields to display, we need to add the ordering field, due to the
+			// select distinct.
+			$orderFields = explode(',', $this->_order);
+
+			for ($i = 0, $ien = count($orderFields); $i < $ien; ++$i) {
+				$field = strtolower($orderFields[$i]);
+				$field = str_replace(' asc', '', $field);
+				$field = str_replace(' desc', '', $field);
+				$field = trim($field);
+
+				if (!in_array($field, $fields)) {
+					$q->get($field);
+				}
+			}
+
+			$q->order($this->_order);
+		} elseif ($this->_order === true) {
+			// Attempt to do a database order, needed for "limit()"ed results
+			$q->order($this->_label[0]);
+		}
+
+		return $q
+			->exec()
+			->fetchAll();
+	}
+
 	/**
 	 * Get the objects for a set of values.
 	 *