#561104 by Crell: Added support for random ordering in dynamic select queries.

1 files changed, 33 insertions, 0 deletions

diff --git a/includes/database/select.inc b/includes/database/select.inc
index a4c4ed3e4..55eecf586 100644
--- a/includes/database/select.inc
+++ b/includes/database/select.inc
@@ -348,6 +348,28 @@ interface SelectQueryInterface extends QueryConditionInterface, QueryAlterableIn
   public function orderBy($field, $direction = 'ASC');
 
   /**
+   * Orders the result set by a random value.
+   *
+   * This may be stacked with other orderBy() calls. If so, the query will order
+   * by each specified field, including this one, in the order called. Although
+   * this method may be called multiple times on the same query, doing so
+   * is not particularly useful.
+   *
+   * Note: The method used by most drivers may not scale to very large result
+   * sets. If you need to work with extremely large data sets, you may create
+   * your own database driver by subclassing off of an existing driver and
+   * implementing your own randomization mechanism. See
+   *
+   * http://jan.kneschke.de/projects/mysql/order-by-rand/
+   *
+   * for an example of such an alternate sorting mechanism.
+   *
+   * @return
+   *   The called object
+   */
+  public function orderRandom();
+
+  /**
    * Restricts a query to a given range in the result set.
    *
    * If this method is called with no parameters, will remove any range
@@ -643,6 +665,11 @@ class SelectQueryExtender implements SelectQueryInterface {
     return $this;
   }
 
+  public function orderRandom() {
+    $this->query->orderRandom();
+    return $this;
+  }
+
   public function range($start = NULL, $length = NULL) {
     $this->query->range($start, $length);
     return $this;
@@ -1182,6 +1209,12 @@ class SelectQuery extends Query implements SelectQueryInterface {
     return $this;
   }
 
+  public function orderRandom() {
+    $alias = $this->addExpression('RAND()', 'random_field');
+    $this->orderBy($alias);
+    return $this;
+  }
+
   public function range($start = NULL, $length = NULL) {
     $this->range = func_num_args() ? array('start' => $start, 'length' => $length) : array();
     return $this;