View source
<?php
namespace Drupal\views\Plugin\views\sort;
use Drupal\Core\Cache\Cache;
use Drupal\Core\Cache\CacheableDependencyInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\views\Plugin\views\HandlerBase;
abstract class SortPluginBase extends HandlerBase implements CacheableDependencyInterface {
public function canExpose() {
return TRUE;
}
public function query() {
$this
->ensureMyTable();
$this->query
->addOrderBy($this->tableAlias, $this->realField, $this->options['order']);
}
protected function defineOptions() {
$options = parent::defineOptions();
$options['order'] = array(
'default' => 'ASC',
);
$options['exposed'] = array(
'default' => FALSE,
);
$options['expose'] = array(
'contains' => array(
'label' => array(
'default' => '',
),
),
);
return $options;
}
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');
break;
case 'DESC':
case 'desc':
return $this
->t('desc');
break;
}
}
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
parent::buildOptionsForm($form, $form_state);
if ($this
->canExpose()) {
$this
->showExposeButton($form, $form_state);
}
$form['op_val_start'] = array(
'#value' => '<div class="clearfix">',
);
$this
->showSortForm($form, $form_state);
$form['op_val_end'] = array(
'#value' => '</div>',
);
if ($this
->canExpose()) {
$this
->showExposeForm($form, $form_state);
}
}
public function showExposeButton(&$form, FormStateInterface $form_state) {
$form['expose_button'] = array(
'#prefix' => '<div class="views-expose clearfix">',
'#suffix' => '</div>',
'#weight' => -1000,
);
$form['expose_button']['checkbox'] = array(
'#theme_wrappers' => array(
'container',
),
'#attributes' => array(
'class' => array(
'js-only',
),
),
);
$form['expose_button']['checkbox']['checkbox'] = array(
'#title' => $this
->t('Expose this sort to visitors, to allow them to change it'),
'#type' => 'checkbox',
);
if (empty($this->options['exposed'])) {
$form['expose_button']['markup'] = array(
'#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'] = array(
'#limit_validation_errors' => array(),
'#type' => 'submit',
'#value' => $this
->t('Expose sort'),
'#submit' => array(
array(
$this,
'displayExposedForm',
),
),
'#attributes' => array(
'class' => array(
'use-ajax-submit',
),
),
);
$form['expose_button']['checkbox']['checkbox']['#default_value'] = 0;
}
else {
$form['expose_button']['markup'] = array(
'#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'] = array(
'#limit_validation_errors' => array(),
'#type' => 'submit',
'#value' => $this
->t('Hide sort'),
'#submit' => array(
array(
$this,
'displayExposedForm',
),
),
'#attributes' => array(
'class' => array(
'use-ajax-submit',
),
),
);
$form['expose_button']['checkbox']['checkbox']['#default_value'] = 1;
}
}
public function validateOptionsForm(&$form, FormStateInterface $form_state) {
$this
->sortValidate($form, $form_state);
if (!empty($this->options['exposed'])) {
$this
->validateExposeForm($form, $form_state);
}
}
public function submitOptionsForm(&$form, FormStateInterface $form_state) {
$form_state
->unsetValue('expose_button');
$this
->sortSubmit($form, $form_state);
if (!empty($this->options['exposed'])) {
$this
->submitExposeForm($form, $form_state);
}
}
protected function showSortForm(&$form, FormStateInterface $form_state) {
$options = $this
->sortOptions();
if (!empty($options)) {
$form['order'] = array(
'#title' => $this
->t('Order'),
'#type' => 'radios',
'#options' => $options,
'#default_value' => $this->options['order'],
);
}
}
protected function sortValidate(&$form, FormStateInterface $form_state) {
}
public function sortSubmit(&$form, FormStateInterface $form_state) {
}
protected function sortOptions() {
return array(
'ASC' => $this
->t('Sort ascending'),
'DESC' => $this
->t('Sort descending'),
);
}
public function buildExposeForm(&$form, FormStateInterface $form_state) {
array_unshift($form['#pre_render'], array(
get_class($this),
'preRenderFlattenData',
));
$form['expose']['#flatten'] = TRUE;
$form['expose']['label'] = array(
'#type' => 'textfield',
'#default_value' => $this->options['expose']['label'],
'#title' => $this
->t('Label'),
'#required' => TRUE,
'#size' => 40,
'#weight' => -1,
);
}
public function defaultExposeOptions() {
$this->options['expose'] = array(
'label' => $this->definition['title'],
);
}
public function getCacheMaxAge() {
return Cache::PERMANENT;
}
public function getCacheContexts() {
$cache_contexts = [];
if ($this
->isExposed()) {
$cache_contexts[] = 'url.query_args:sort_by';
}
return $cache_contexts;
}
public function getCacheTags() {
return [];
}
}