class TableSortExtender

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Database/Query/TableSortExtender.php \Drupal\Core\Database\Query\TableSortExtender
  2. 10 core/tests/fixtures/database_drivers/module/core_fake/src/Driver/Database/CoreFakeWithAllCustomClasses/TableSortExtender.php \Drupal\core_fake\Driver\Database\CoreFakeWithAllCustomClasses\TableSortExtender
  3. 10 core/lib/Drupal/Core/Database/Query/TableSortExtender.php \Drupal\Core\Database\Query\TableSortExtender
  4. 11.x core/tests/fixtures/database_drivers/module/core_fake/src/Driver/Database/CoreFakeWithAllCustomClasses/TableSortExtender.php \Drupal\core_fake\Driver\Database\CoreFakeWithAllCustomClasses\TableSortExtender
  5. 11.x core/lib/Drupal/Core/Database/Query/TableSortExtender.php \Drupal\Core\Database\Query\TableSortExtender

Query extender class for tablesort queries.

Hierarchy

Expanded class hierarchy of TableSortExtender

5 files declare their use of TableSortExtender
DatabaseTestController.php in core/modules/system/tests/modules/database_test/src/Controller/DatabaseTestController.php
DatabaseTestForm.php in core/modules/system/tests/modules/database_test/src/Form/DatabaseTestForm.php
DbLogController.php in core/modules/dblog/src/Controller/DbLogController.php
ForumManager.php in core/modules/forum/src/ForumManager.php
TableSortExtender.php in core/tests/fixtures/database_drivers/module/corefake/src/Driver/Database/corefakeWithAllCustomClasses/TableSortExtender.php
1 string reference to 'TableSortExtender'
ConnectionTest::providerGetDriverClass in core/tests/Drupal/Tests/Core/Database/ConnectionTest.php
Data provider for testGetDriverClass().

File

core/lib/Drupal/Core/Database/Query/TableSortExtender.php, line 11

Namespace

Drupal\Core\Database\Query
View source
class TableSortExtender extends SelectExtender {
    
    /**
     * {@inheritdoc}
     */
    public function __construct(SelectInterface $query, Connection $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.
     *
     * @param array $header
     *   Table header array.
     *
     * @return \Drupal\Core\Database\Query\SelectInterface
     *   The called object.
     *
     * @see table.html.twig
     */
    public function orderByHeader(array $header) {
        $context = TableSort::getContextFromRequest($header, \Drupal::request());
        if (!empty($context['sql'])) {
            // Based on code from \Drupal\Core\Database\Connection::escapeTable(),
            // but this can also contain a dot.
            $field = preg_replace('/[^A-Za-z0-9_.]+/', '', $context['sql']);
            // orderBy() will ensure that only ASC/DESC values are accepted, so we
            // don't need to sanitize that here.
            $this->orderBy($field, $context['sort']);
        }
        return $this;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
SelectExtender::$connection protected property The connection object on which to run this query.
SelectExtender::$placeholder protected property The placeholder counter.
SelectExtender::$query protected property The Select query object we are extending/decorating.
SelectExtender::$uniqueIdentifier protected property A unique identifier for this query object.
SelectExtender::addExpression public function Overrides SelectInterface::addExpression
SelectExtender::addField public function Overrides SelectInterface::addField
SelectExtender::addJoin public function Overrides SelectInterface::addJoin
SelectExtender::addMetaData public function Overrides AlterableInterface::addMetaData
SelectExtender::addTag public function Overrides AlterableInterface::addTag
SelectExtender::alwaysFalse public function Overrides ConditionInterface::alwaysFalse
SelectExtender::andConditionGroup public function Overrides ConditionInterface::andConditionGroup
SelectExtender::arguments public function Overrides ConditionInterface::arguments
SelectExtender::compile public function Overrides ConditionInterface::compile
SelectExtender::compiled public function Overrides ConditionInterface::compiled
SelectExtender::condition public function Overrides ConditionInterface::condition
SelectExtender::conditionGroupFactory public function Overrides ConditionInterface::conditionGroupFactory
SelectExtender::conditions public function Overrides ConditionInterface::conditions 1
SelectExtender::countQuery public function Overrides SelectInterface::countQuery 1
SelectExtender::distinct public function Overrides SelectInterface::distinct
SelectExtender::escapeField public function Overrides SelectInterface::escapeField
SelectExtender::escapeLike public function Overrides SelectInterface::escapeLike
SelectExtender::execute public function Overrides SelectInterface::execute 2
SelectExtender::exists public function Overrides ConditionInterface::exists
SelectExtender::extend public function Overrides ExtendableInterface::extend
SelectExtender::fields public function Overrides SelectInterface::fields
SelectExtender::forUpdate public function Overrides SelectInterface::forUpdate
SelectExtender::getArguments public function Overrides SelectInterface::getArguments
SelectExtender::getExpressions public function Overrides SelectInterface::getExpressions
SelectExtender::getFields public function Overrides SelectInterface::getFields
SelectExtender::getGroupBy public function Overrides SelectInterface::getGroupBy
SelectExtender::getMetaData public function Overrides AlterableInterface::getMetaData
SelectExtender::getOrderBy public function Overrides SelectInterface::getOrderBy
SelectExtender::getTables public function Overrides SelectInterface::getTables
SelectExtender::getUnion public function Overrides SelectInterface::getUnion
SelectExtender::groupBy public function Overrides SelectInterface::groupBy
SelectExtender::hasAllTags public function Overrides AlterableInterface::hasAllTags
SelectExtender::hasAnyTag public function Overrides AlterableInterface::hasAnyTag
SelectExtender::hasTag public function Overrides AlterableInterface::hasTag
SelectExtender::having public function Overrides SelectInterface::having
SelectExtender::havingArguments public function Overrides SelectInterface::havingArguments
SelectExtender::havingCompile public function Overrides SelectInterface::havingCompile
SelectExtender::havingCondition public function Overrides SelectInterface::havingCondition
SelectExtender::havingConditions public function Overrides SelectInterface::havingConditions
SelectExtender::havingExists public function Overrides SelectInterface::havingExists
SelectExtender::havingIsNotNull public function Overrides SelectInterface::havingIsNotNull
SelectExtender::havingIsNull public function Overrides SelectInterface::havingIsNull
SelectExtender::havingNotExists public function Overrides SelectInterface::havingNotExists
SelectExtender::innerJoin public function Overrides SelectInterface::innerJoin
SelectExtender::isNotNull public function Overrides ConditionInterface::isNotNull
SelectExtender::isNull public function Overrides ConditionInterface::isNull
SelectExtender::isPrepared public function Overrides SelectInterface::isPrepared
SelectExtender::join public function Overrides SelectInterface::join
SelectExtender::leftJoin public function Overrides SelectInterface::leftJoin
SelectExtender::nextPlaceholder public function Overrides PlaceholderInterface::nextPlaceholder
SelectExtender::notExists public function Overrides ConditionInterface::notExists
SelectExtender::orConditionGroup public function Overrides ConditionInterface::orConditionGroup
SelectExtender::orderBy public function Overrides SelectInterface::orderBy
SelectExtender::orderRandom public function Overrides SelectInterface::orderRandom
SelectExtender::preExecute public function Overrides SelectInterface::preExecute 1
SelectExtender::range public function Overrides SelectInterface::range
SelectExtender::union public function Overrides SelectInterface::union
SelectExtender::uniqueIdentifier public function Overrides PlaceholderInterface::uniqueIdentifier
SelectExtender::where public function Overrides ConditionInterface::where
SelectExtender::__call public function Magic override for undefined methods.
SelectExtender::__clone public function Overrides SelectInterface::__clone
SelectExtender::__toString public function Overrides SelectInterface::__toString
TableSortExtender::orderByHeader public function Order the query based on a header array.
TableSortExtender::__construct public function Overrides SelectExtender::__construct

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