class TableSort

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Utility/TableSort.php \Drupal\Core\Utility\TableSort
  2. 8.9.x core/lib/Drupal/Core/Utility/TableSort.php \Drupal\Core\Utility\TableSort
  3. 10 core/lib/Drupal/Core/Utility/TableSort.php \Drupal\Core\Utility\TableSort
  4. 11.x core/lib/Drupal/Core/Utility/TableSort.php \Drupal\Core\Utility\TableSort

Query extender class for tablesort queries.

Hierarchy

Expanded class hierarchy of TableSort

18 string references to 'TableSort'
comment_admin_overview in modules/comment/comment.admin.inc
Form builder for the comment overview administration form.
database_test_theme_tablesort in modules/simpletest/tests/database_test.module
Output a form without setting a header sort.
dblog_overview in modules/dblog/dblog.admin.inc
Page callback: Displays a listing of database log messages.
dblog_top in modules/dblog/dblog.admin.inc
Page callback: Shows the most frequent log messages of a given event type.
forum_get_topics in modules/forum/forum.module
Gets all the topics in a forum.

... See full list

File

includes/tablesort.inc, line 15

View source
class TableSort extends SelectQueryExtender {
  
  /**
   * The array of fields that can be sorted by.
   *
   * @var array
   */
  protected $header = array();
  public function __construct(SelectQueryInterface $query, DatabaseConnection $connection) {
    parent::__construct($query, $connection);
    // Add convenience tag to mark that this is an extended query. We have to
    // do this in the constructor to ensure that it is set before preExecute()
    // gets called.
    $this->addTag('tablesort');
  }
  
  /**
   * Order the query based on a header array.
   *
   * @see theme_table()
   * @param $header
   *   Table header array.
   * @return SelectQueryInterface
   *   The called object.
   */
  public function orderByHeader(array $header) {
    $this->header = $header;
    $ts = $this->init();
    if (!empty($ts['sql'])) {
      // Based on code from db_escape_table(), but this can also contain a dot.
      $field = preg_replace('/[^A-Za-z0-9_.]+/', '', $ts['sql']);
      // orderBy() will ensure that only ASC/DESC values are accepted, so we
      // don't need to sanitize that here.
      $this->orderBy($field, $ts['sort']);
    }
    return $this;
  }
  
  /**
   * Initializes the table sort context.
   */
  protected function init() {
    $ts = $this->order();
    $ts['sort'] = $this->getSort();
    $ts['query'] = $this->getQueryParameters();
    return $ts;
  }
  
  /**
   * Determine the current sort direction.
   *
   * @param $headers
   *   An array of column headers in the format described in theme_table().
   * @return
   *   The current sort direction ("asc" or "desc").
   */
  protected function getSort() {
    return tablesort_get_sort($this->header);
  }
  
  /**
   * Compose a URL query parameter array to append to table sorting requests.
   *
   * @return
   *   A URL query parameter array that consists of all components of the current
   *   page request except for those pertaining to table sorting.
   *
   * @see tablesort_get_query_parameters()
   */
  protected function getQueryParameters() {
    return tablesort_get_query_parameters();
  }
  
  /**
   * Determine the current sort criterion.
   *
   * @param $headers
   *   An array of column headers in the format described in theme_table().
   * @return
   *   An associative array describing the criterion, containing the keys:
   *   - "name": The localized title of the table column.
   *   - "sql": The name of the database field to sort on.
   */
  protected function order() {
    return tablesort_get_order($this->header);
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
SelectQueryExtender::$connection protected property The connection object on which to run this query.
SelectQueryExtender::$placeholder protected property The placeholder counter.
SelectQueryExtender::$query protected property The SelectQuery object we are extending/decorating.
SelectQueryExtender::$uniqueIdentifier protected property A unique identifier for this query object.
SelectQueryExtender::addExpression public function Overrides SelectQueryInterface::addExpression
SelectQueryExtender::addField public function Overrides SelectQueryInterface::addField
SelectQueryExtender::addJoin public function Overrides SelectQueryInterface::addJoin
SelectQueryExtender::addMetaData public function Overrides QueryAlterableInterface::addMetaData
SelectQueryExtender::addTag public function Overrides QueryAlterableInterface::addTag
SelectQueryExtender::arguments public function Overrides QueryConditionInterface::arguments
SelectQueryExtender::compile public function Overrides QueryConditionInterface::compile
SelectQueryExtender::compiled public function Overrides QueryConditionInterface::compiled
SelectQueryExtender::condition public function Overrides QueryConditionInterface::condition
SelectQueryExtender::conditions public function Overrides QueryConditionInterface::conditions
SelectQueryExtender::countQuery public function Overrides SelectQueryInterface::countQuery 1
SelectQueryExtender::distinct public function Overrides SelectQueryInterface::distinct
SelectQueryExtender::execute public function 2
SelectQueryExtender::exists public function Overrides QueryConditionInterface::exists
SelectQueryExtender::extend public function Overrides QueryExtendableInterface::extend
SelectQueryExtender::fields public function Overrides SelectQueryInterface::fields
SelectQueryExtender::forUpdate public function Overrides SelectQueryInterface::forUpdate
SelectQueryExtender::getArguments public function Overrides SelectQueryInterface::getArguments
SelectQueryExtender::getExpressions public function Overrides SelectQueryInterface::getExpressions
SelectQueryExtender::getFields public function Overrides SelectQueryInterface::getFields
SelectQueryExtender::getGroupBy public function Overrides SelectQueryInterface::getGroupBy
SelectQueryExtender::getMetaData public function Overrides QueryAlterableInterface::getMetaData
SelectQueryExtender::getOrderBy public function Overrides SelectQueryInterface::getOrderBy
SelectQueryExtender::getTables public function Overrides SelectQueryInterface::getTables
SelectQueryExtender::getUnion public function Overrides SelectQueryInterface::getUnion
SelectQueryExtender::groupBy public function Overrides SelectQueryInterface::groupBy
SelectQueryExtender::hasAllTags public function Overrides QueryAlterableInterface::hasAllTags
SelectQueryExtender::hasAnyTag public function Overrides QueryAlterableInterface::hasAnyTag
SelectQueryExtender::hasTag public function Overrides QueryAlterableInterface::hasTag
SelectQueryExtender::having public function
SelectQueryExtender::havingArguments public function
SelectQueryExtender::havingCompile public function
SelectQueryExtender::havingCondition public function Overrides SelectQueryInterface::havingCondition
SelectQueryExtender::havingConditions public function
SelectQueryExtender::innerJoin public function Overrides SelectQueryInterface::innerJoin
SelectQueryExtender::isNotNull function Overrides QueryConditionInterface::isNotNull
SelectQueryExtender::isNull function Overrides QueryConditionInterface::isNull
SelectQueryExtender::isPrepared public function Overrides SelectQueryInterface::isPrepared
SelectQueryExtender::join public function Overrides SelectQueryInterface::join
SelectQueryExtender::leftJoin public function Overrides SelectQueryInterface::leftJoin
SelectQueryExtender::nextPlaceholder public function Implements QueryPlaceholderInterface::nextPlaceholder(). Overrides QueryPlaceholderInterface::nextPlaceholder
SelectQueryExtender::notExists public function Overrides QueryConditionInterface::notExists
SelectQueryExtender::orderBy public function Overrides SelectQueryInterface::orderBy
SelectQueryExtender::orderRandom public function Overrides SelectQueryInterface::orderRandom
SelectQueryExtender::preExecute public function Overrides SelectQueryInterface::preExecute
SelectQueryExtender::range public function Overrides SelectQueryInterface::range
SelectQueryExtender::rightJoin public function Overrides SelectQueryInterface::rightJoin
SelectQueryExtender::union public function Overrides SelectQueryInterface::union
SelectQueryExtender::uniqueIdentifier public function Implements QueryPlaceholderInterface::uniqueIdentifier(). Overrides QueryPlaceholderInterface::uniqueIdentifier
SelectQueryExtender::where public function Overrides QueryConditionInterface::where
SelectQueryExtender::__call public function Magic override for undefined methods.
SelectQueryExtender::__clone public function Overrides SelectQueryInterface::__clone
SelectQueryExtender::__toString public function
TableSort::$header protected property The array of fields that can be sorted by.
TableSort::getQueryParameters protected function Compose a URL query parameter array to append to table sorting requests.
TableSort::getSort protected function Determine the current sort direction.
TableSort::init protected function Initializes the table sort context.
TableSort::order protected function Determine the current sort criterion.
TableSort::orderByHeader public function Order the query based on a header array.
TableSort::__construct public function Overrides SelectQueryExtender::__construct

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.