SortAllowedValues.php in Views List Sort 8

Namespace

Drupal\views_list_sort\Plugin\views\sort

File

src/Plugin/views/sort/SortAllowedValues.php

<?php

namespace Drupal\views_list_sort\Plugin\views\sort;

use Drupal\Core\Database\Database;
use Drupal\Core\Form\FormStateInterface;
use Drupal\views\FieldAPIHandlerTrait;
use Drupal\views\Plugin\views\sort\SortPluginBase;

/**
 * Sort handler for fields with allowed_values.
 *
 * @ingroup views_sort_handlers
 *
 * @ViewsSort("sort_allowed_values")
 */
class SortAllowedValues extends SortPluginBase {
  use FieldAPIHandlerTrait;

  /**
   * Options definition.
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['allowed_values'] = [
      'default' => 0,
    ];
    $options['null_heavy'] = [
      'default' => 0,
    ];
    return $options;
  }

  /**
   * Options form.
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['allowed_values'] = [
      '#type' => 'radios',
      '#title' => t('Sort by allowed values'),
      '#options' => [
        t('No'),
        t('Yes'),
      ],
      '#default_value' => $this->options['allowed_values'],
    ];
    $form['null_heavy'] = [
      '#type' => 'radios',
      '#title' => t('Treat null values as heavier than the allowed values'),
      '#options' => [
        t('No'),
        t('Yes'),
      ],
      '#default_value' => $this->options['null_heavy'],
    ];
  }

  /**
   * Called to add the sort to a query.
   *
   * Sort by index of allowed values using sql FIELD function.
   *
   * @see http://dev.mysql.com/doc/refman/5.5/en/string-functions.html#function_field
   */
  public function query() {
    $this
      ->ensureMyTable();

    // Skip if disabled.
    if (!$this->options['allowed_values']) {
      return;
    }
    $field_storage = $this
      ->getFieldStorageDefinition();
    $allowed_values = array_keys(options_allowed_values($field_storage));
    $connection = Database::getConnection();
    $formula = '';

    // Reverse the values returned by the FIELD function and the allowed values
    // so '0' is heavier than the rest.
    if ($this->options['null_heavy']) {
      $allowed_values = array_reverse($allowed_values);
      $formula .= '-1 * ';
    }
    $formula .= 'FIELD(' . $this->tableAlias . '.' . $this->field . ', ' . implode(', ', array_map([
      $connection,
      'quote',
    ], $allowed_values)) . ')';
    $this->query
      ->addOrderBy(NULL, $formula, $this->options['order'], $this->tableAlias . '_' . $this->field . '_allowed_values');
  }

}

Classes

Name	Description
SortAllowedValues	Sort handler for fields with allowed_values.