class SortPluginBase

Same name in other branches
  1. 8.9.x core/modules/views/src/Plugin/views/sort/SortPluginBase.php \Drupal\views\Plugin\views\sort\SortPluginBase
  2. 10 core/modules/views/src/Plugin/views/sort/SortPluginBase.php \Drupal\views\Plugin\views\sort\SortPluginBase
  3. 11.x core/modules/views/src/Plugin/views/sort/SortPluginBase.php \Drupal\views\Plugin\views\sort\SortPluginBase

Base sort handler that has no options and performs a simple sort.

Hierarchy

Expanded class hierarchy of SortPluginBase

Related topics

4 files declare their use of SortPluginBase
ModerationStateSort.php in core/modules/content_moderation/src/Plugin/views/sort/ModerationStateSort.php
Score.php in core/modules/search/src/Plugin/views/sort/Score.php
StatisticsLastCommentName.php in core/modules/comment/src/Plugin/views/sort/StatisticsLastCommentName.php
Thread.php in core/modules/comment/src/Plugin/views/sort/Thread.php

File

core/modules/views/src/Plugin/views/sort/SortPluginBase.php, line 26

Namespace

Drupal\views\Plugin\views\sort
View source
abstract class SortPluginBase extends HandlerBase implements CacheableDependencyInterface {
    
    /**
     * Determine if a sort can be exposed.
     */
    public function canExpose() {
        return TRUE;
    }
    
    /**
     * Called to add the sort to a query.
     */
    public function query() {
        $this->ensureMyTable();
        // Add the field.
        $this->query
            ->addOrderBy($this->tableAlias, $this->realField, $this->options['order']);
    }
    protected function defineOptions() {
        $options = parent::defineOptions();
        $options['order'] = [
            'default' => 'ASC',
        ];
        $options['exposed'] = [
            'default' => FALSE,
        ];
        $options['expose'] = [
            'contains' => [
                'label' => [
                    'default' => '',
                ],
                'field_identifier' => [
                    'default' => '',
                ],
            ],
        ];
        return $options;
    }
    
    /**
     * Display whether or not the sort order is ascending or descending.
     */
    public function adminSummary() {
        if (!empty($this->options['exposed'])) {
            return $this->t('Exposed');
        }
        switch ($this->options['order']) {
            case 'ASC':
            case 'asc':
            default:
                return $this->t('asc');
            case 'DESC':
            case 'desc':
                return $this->t('desc');
        }
    }
    
    /**
     * Basic options for all sort criteria.
     */
    public function buildOptionsForm(&$form, FormStateInterface $form_state) {
        parent::buildOptionsForm($form, $form_state);
        if ($this->canExpose()) {
            $this->showExposeButton($form, $form_state);
        }
        $form['op_val_start'] = [
            '#value' => '<div class="clearfix">',
        ];
        $this->showSortForm($form, $form_state);
        $form['op_val_end'] = [
            '#value' => '</div>',
        ];
        if ($this->canExpose()) {
            $this->showExposeForm($form, $form_state);
        }
    }
    
    /**
     * Shortcut to display the expose/hide button.
     */
    public function showExposeButton(&$form, FormStateInterface $form_state) {
        $form['expose_button'] = [
            '#prefix' => '<div class="views-expose clearfix">',
            '#suffix' => '</div>',
            // Should always come first
'#weight' => -1000,
        ];
        // Add a checkbox for JS users, which will have behavior attached to it
        // so it can replace the button.
        $form['expose_button']['checkbox'] = [
            '#theme_wrappers' => [
                'container',
            ],
            '#attributes' => [
                'class' => [
                    'js-only',
                ],
            ],
        ];
        $form['expose_button']['checkbox']['checkbox'] = [
            '#title' => $this->t('Expose this sort to visitors, to allow them to change it'),
            '#type' => 'checkbox',
        ];
        // Then add the button itself.
        if (empty($this->options['exposed'])) {
            $form['expose_button']['markup'] = [
                '#markup' => '<div class="description exposed-description" style="float: left; margin-right:10px">' . $this->t('This sort is not exposed. Expose it to allow the users to change it.') . '</div>',
            ];
            $form['expose_button']['button'] = [
                '#limit_validation_errors' => [],
                '#type' => 'submit',
                '#value' => $this->t('Expose sort'),
                '#submit' => [
                    [
                        $this,
                        'displayExposedForm',
                    ],
                ],
            ];
            $form['expose_button']['checkbox']['checkbox']['#default_value'] = 0;
        }
        else {
            $form['expose_button']['markup'] = [
                '#markup' => '<div class="description exposed-description">' . $this->t('This sort is exposed. If you hide it, users will not be able to change it.') . '</div>',
            ];
            $form['expose_button']['button'] = [
                '#limit_validation_errors' => [],
                '#type' => 'submit',
                '#value' => $this->t('Hide sort'),
                '#submit' => [
                    [
                        $this,
                        'displayExposedForm',
                    ],
                ],
            ];
            $form['expose_button']['checkbox']['checkbox']['#default_value'] = 1;
        }
    }
    
    /**
     * Simple validate handler.
     */
    public function validateOptionsForm(&$form, FormStateInterface $form_state) {
        $this->sortValidate($form, $form_state);
        if (!empty($this->options['exposed'])) {
            $this->validateExposeForm($form, $form_state);
        }
    }
    
    /**
     * Simple submit handler.
     */
    public function submitOptionsForm(&$form, FormStateInterface $form_state) {
        // Do not store this values.
        $form_state->unsetValue('expose_button');
        $this->sortSubmit($form, $form_state);
        if (!empty($this->options['exposed'])) {
            $this->submitExposeForm($form, $form_state);
        }
    }
    
    /**
     * Shortcut to display the value form.
     */
    protected function showSortForm(&$form, FormStateInterface $form_state) {
        $options = $this->sortOptions();
        if (!empty($options)) {
            $form['order'] = [
                '#title' => $this->t('Order', [], [
                    'context' => 'Sort order',
                ]),
                '#type' => 'radios',
                '#options' => $options,
                '#default_value' => $this->options['order'],
            ];
        }
    }
    protected function sortValidate(&$form, FormStateInterface $form_state) {
    }
    public function sortSubmit(&$form, FormStateInterface $form_state) {
    }
    
    /**
     * Provide a list of options for the default sort form.
     *
     * Should be overridden by classes that don't override sort_form
     */
    protected function sortOptions() {
        return [
            'ASC' => $this->t('Sort ascending'),
            'DESC' => $this->t('Sort descending'),
        ];
    }
    public function buildExposeForm(&$form, FormStateInterface $form_state) {
        // #flatten will move everything from $form['expose'][$key] to $form[$key]
        // prior to rendering. That's why the preRender for it needs to run first,
        // so that when the next preRender (the one for fieldsets) runs, it gets
        // the flattened data.
        array_unshift($form['#pre_render'], [
            static::class,
            'preRenderFlattenData',
        ]);
        $form['expose']['#flatten'] = TRUE;
        $form['expose']['label'] = [
            '#type' => 'textfield',
            '#default_value' => $this->options['expose']['label'],
            '#title' => $this->t('Label'),
            '#required' => TRUE,
            '#size' => 40,
            '#weight' => -1,
        ];
        $form['expose']['field_identifier'] = [
            '#type' => 'textfield',
            '#default_value' => $this->options['expose']['field_identifier'],
            '#title' => $this->t('Sort field identifier'),
            '#required' => TRUE,
            '#size' => 40,
            '#description' => $this->t("This will appear in the URL after the ?, as value of 'sort_by' parameter, to identify this sort field. Cannot be blank. Only letters, digits and the dot ('.'), hyphen ('-'), underscore ('_'), and tilde ('~') characters are allowed."),
        ];
    }
    
    /**
     * Validate the options form.
     */
    public function validateExposeForm($form, FormStateInterface $form_state) {
        $field_identifier = $form_state->getValue([
            'options',
            'expose',
            'field_identifier',
        ]);
        if (!preg_match('/^[a-zA-z][a-zA-Z0-9_~.\\-]*$/', $field_identifier)) {
            $form_state->setErrorByName('expose][field_identifier', $this->t('This identifier has illegal characters.'));
            return;
        }
        // Validate that the sort field identifier is unique within the sort
        // handlers. Note that the sort field identifier is different that other
        // identifiers because it is used as a query string value of the 'sort_by'
        // parameter, while the others are used as query string parameter keys.
        // Therefore we can have a sort field identifier be the same as an exposed
        // filter identifier. This prevents us from using
        // DisplayPluginInterface::isIdentifierUnique() to test for uniqueness.
        // @see \Drupal\views\Plugin\views\display\DisplayPluginInterface::isIdentifierUnique()
        foreach ($this->view->display_handler
            ->getHandlers('sort') as $key => $handler) {
            if ($handler->canExpose() && $handler->isExposed()) {
                if ($form_state->get('id') !== $key && isset($handler->options['expose']['field_identifier']) && $field_identifier === $handler->options['expose']['field_identifier']) {
                    $form_state->setErrorByName('expose][field_identifier', $this->t('This identifier is already used by %label sort handler.', [
                        '%label' => $handler->adminLabel(TRUE),
                    ]));
                    return;
                }
            }
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public static function trustedCallbacks() {
        $callbacks = parent::trustedCallbacks();
        $callbacks[] = 'preRenderFlattenData';
        return $callbacks;
    }
    
    /**
     * Provide default options for exposed sorts.
     */
    public function defaultExposeOptions() {
        $this->options['expose'] = [
            'label' => $this->definition['title'],
            'field_identifier' => $this->options['id'],
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheMaxAge() {
        // The result of a sort does not depend on outside information, so by
        // default it is cacheable.
        return Cache::PERMANENT;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheContexts() {
        $cache_contexts = [];
        // Exposed sorts use GET parameters, so it depends on the current URL.
        if ($this->isExposed()) {
            $cache_contexts[] = 'url.query_args:sort_by';
        }
        return $cache_contexts;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheTags() {
        return [];
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
HandlerBase::$field public property With field you can override the realField if the real field is not set.
HandlerBase::$moduleHandler protected property The module handler. 3
HandlerBase::$query public property Where the $query object will reside. 7
HandlerBase::$realField public property The real field.
HandlerBase::$relationship public property The relationship used for this field.
HandlerBase::$table public property The table this handler is attached to.
HandlerBase::$tableAlias public property The alias of the table of this handler which is used in the query.
HandlerBase::$viewsData protected property The views data service.
HandlerBase::acceptExposedInput public function Take input from exposed handlers and assign to this handler, if necessary. 1
HandlerBase::access public function Check whether given user has access to this handler. Overrides ViewsHandlerInterface::access 4
HandlerBase::adminLabel public function Return a string representing this handler&#039;s name in the UI. Overrides ViewsHandlerInterface::adminLabel 4
HandlerBase::breakString public static function Breaks x,y,z and x+y+z into an array. Overrides ViewsHandlerInterface::breakString
HandlerBase::broken public function Determines if the handler is considered &#039;broken&#039;. Overrides ViewsHandlerInterface::broken
HandlerBase::buildExposedForm public function Render our chunk of the exposed handler form when selecting. 1
HandlerBase::buildExtraOptionsForm public function Provide a form for setting options. 1
HandlerBase::buildGroupByForm public function Provide a form for aggregation settings. 1
HandlerBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginBase::calculateDependencies 10
HandlerBase::caseTransform protected function Transform a string by a certain method.
HandlerBase::defineExtraOptions public function Provide defaults for the handler.
HandlerBase::displayExposedForm public function Displays the Expose form.
HandlerBase::ensureMyTable public function Ensures that the main table for this handler is in the query. Overrides ViewsHandlerInterface::ensureMyTable 2
HandlerBase::exposedInfo public function Get information about the exposed form for the form renderer. 1
HandlerBase::getDateField public function Creates cross-database SQL dates. 2
HandlerBase::getDateFormat public function Creates cross-database SQL date formatting. 2
HandlerBase::getEntityType public function Determines the entity type used by this handler. Overrides ViewsHandlerInterface::getEntityType
HandlerBase::getField public function Shortcut to get a handler&#039;s raw field value. Overrides ViewsHandlerInterface::getField
HandlerBase::getJoin public function Get the join object that should be used for this handler. Overrides ViewsHandlerInterface::getJoin
HandlerBase::getModuleHandler protected function Gets the module handler.
HandlerBase::getTableJoin public static function Fetches a handler to join one table to a primary table from the data cache. Overrides ViewsHandlerInterface::getTableJoin
HandlerBase::getViewsData protected function Gets views data service.
HandlerBase::hasExtraOptions public function Determines if the handler has extra options. 1
HandlerBase::init public function Initialize the plugin. Overrides PluginBase::init 6
HandlerBase::isAGroup public function Returns TRUE if the exposed filter works like a grouped filter. 1
HandlerBase::isExposed public function Determine if this item is &#039;exposed&#039;.
HandlerBase::multipleExposedInput public function Define if the exposed input has to be submitted multiple times. 1
HandlerBase::placeholder protected function Provides a unique placeholders for handlers.
HandlerBase::postExecute public function Run after the view is executed, before the result is cached. Overrides ViewsHandlerInterface::postExecute
HandlerBase::preQuery public function Run before the view is built. Overrides ViewsHandlerInterface::preQuery 2
HandlerBase::sanitizeValue public function Sanitize the value for output. Overrides ViewsHandlerInterface::sanitizeValue
HandlerBase::setModuleHandler public function Sets the module handler.
HandlerBase::setRelationship public function Sets up any needed relationship. Overrides ViewsHandlerInterface::setRelationship
HandlerBase::setViewsData public function
HandlerBase::showExposeForm public function Shortcut to display the exposed options form. Overrides ViewsHandlerInterface::showExposeForm
HandlerBase::storeExposedInput public function If set to remember exposed input in the session, store it there. 1
HandlerBase::submitExposed public function Submit the exposed handler form.
HandlerBase::submitExposeForm public function Perform any necessary changes to the form exposes prior to storage.
HandlerBase::submitExtraOptionsForm public function Perform any necessary changes to the form values prior to storage.
HandlerBase::submitFormCalculateOptions public function Calculates options stored on the handler. 1
HandlerBase::submitGroupByForm public function Perform any necessary changes to the form values prior to storage. 1
HandlerBase::submitTemporaryForm public function Submits a temporary form.
HandlerBase::usesGroupBy public function Provides the handler some groupby. 13
HandlerBase::validate public function Validate that the plugin is correct and can be saved. Overrides PluginBase::validate 2
HandlerBase::validateExposed public function Validate the exposed handler form. 4
HandlerBase::validateExtraOptionsForm public function Validate the options form.
HandlerBase::__construct public function Constructs a Handler object. Overrides PluginBase::__construct 45
PluginBase::$definition public property Plugins&#039; definition.
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$renderer protected property Stores the render API renderer. 3
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
PluginBase::$view public property The top object of a view. 1
PluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 63
PluginBase::destroy public function Clears a plugin. Overrides ViewsPluginInterface::destroy 2
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
PluginBase::getProvider public function Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer protected function Returns the render API renderer. 1
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY constant Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED constant Include negotiated languages when listing languages.
PluginBase::listLanguages protected function Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle public function Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup public static function Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData public static function Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::queryLanguageSubstitutions public static function Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
PluginBase::summaryTitle public function Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions 1
PluginBase::unpackOptions public function Unpacks options over our existing defaults. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions 8
PluginBase::viewsTokenReplace protected function Replaces Views&#039; tokens in a given string. 1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
SortPluginBase::adminSummary public function Display whether or not the sort order is ascending or descending. Overrides HandlerBase::adminSummary
SortPluginBase::buildExposeForm public function Form for exposed handler options. Overrides HandlerBase::buildExposeForm
SortPluginBase::buildOptionsForm public function Basic options for all sort criteria. Overrides HandlerBase::buildOptionsForm 2
SortPluginBase::canExpose public function Determine if a sort can be exposed. Overrides HandlerBase::canExpose
SortPluginBase::defaultExposeOptions public function Provide default options for exposed sorts. Overrides HandlerBase::defaultExposeOptions
SortPluginBase::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides HandlerBase::defineOptions 1
SortPluginBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
SortPluginBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
SortPluginBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
SortPluginBase::query public function Called to add the sort to a query. Overrides HandlerBase::query 6
SortPluginBase::showExposeButton public function Shortcut to display the expose/hide button. Overrides HandlerBase::showExposeButton
SortPluginBase::showSortForm protected function Shortcut to display the value form.
SortPluginBase::sortOptions protected function Provide a list of options for the default sort form.
SortPluginBase::sortSubmit public function
SortPluginBase::sortValidate protected function
SortPluginBase::submitOptionsForm public function Simple submit handler. Overrides PluginBase::submitOptionsForm
SortPluginBase::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides PluginBase::trustedCallbacks
SortPluginBase::validateExposeForm public function Validate the options form. Overrides HandlerBase::validateExposeForm
SortPluginBase::validateOptionsForm public function Simple validate handler. Overrides PluginBase::validateOptionsForm
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.

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