class TableSortExampleController

Same name in other branches
  1. 4.0.x modules/tablesort_example/src/Controller/TableSortExampleController.php \Drupal\tablesort_example\Controller\TableSortExampleController

Controller routines for tablesort example routes.

Hierarchy

Expanded class hierarchy of TableSortExampleController

File

modules/tablesort_example/src/Controller/TableSortExampleController.php, line 12

Namespace

Drupal\tablesort_example\Controller
View source
class TableSortExampleController extends ControllerBase {
    
    /**
     * The Database Connection.
     *
     * @var \Drupal\Core\Database\Connection
     */
    protected $database;
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        $controller = new static($container->get('database'));
        $controller->setStringTranslation($container->get('string_translation'));
        return $controller;
    }
    
    /**
     * TableSortExampleController constructor.
     *
     * @param \Drupal\Core\Database\Connection $database
     *   The database connection.
     */
    public function __construct(Connection $database) {
        $this->database = $database;
    }
    
    /**
     * A simple controller method to explain what the tablesort example is about.
     */
    public function description() {
        // We are going to output the results in a table with a nice header.
        $header = [
            // The header gives the table the information it needs in order to make
            // the query calls for ordering. TableSort uses the field information
            // to know what database column to sort by.
[
                'data' => $this->t('Numbers'),
                'field' => 't.numbers',
            ],
            [
                'data' => $this->t('Letters'),
                'field' => 't.alpha',
            ],
            [
                'data' => $this->t('Mixture'),
                'field' => 't.random',
            ],
        ];
        // Using the TableSort Extender is what tells  the query object that we
        // are sorting.
        $query = $this->database
            ->select('tablesort_example', 't')
            ->extend('Drupal\\Core\\Database\\Query\\TableSortExtender');
        $query->fields('t');
        // Don't forget to tell the query object how to find the header information.
        $result = $query->orderByHeader($header)
            ->execute();
        $rows = [];
        foreach ($result as $row) {
            // Normally we would add some nice formatting to our rows
            // but for our purpose we are simply going to add our row
            // to the array.
            $rows[] = [
                'data' => (array) $row,
            ];
        }
        // Build the table for the nice output.
        $build = [
            '#markup' => '<p>' . t('The layout here is a themed as a table
           that is sortable by clicking the header name.') . '</p>',
        ];
        $build['tablesort_table'] = [
            '#theme' => 'table',
            '#header' => $header,
            '#rows' => $rows,
        ];
        return $build;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 3
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 1
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 1
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 3
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 1
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 1
ControllerBase::redirect protected function Returns a redirect response object for the specified route.
ControllerBase::state protected function Returns the state storage service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 17
MessengerTrait::messenger public function Gets the messenger. 17
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a &#039;destination&#039; URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
TableSortExampleController::$database protected property The Database Connection.
TableSortExampleController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
TableSortExampleController::description public function A simple controller method to explain what the tablesort example is about.
TableSortExampleController::__construct public function TableSortExampleController constructor.