CallbackFieldRow.php in Search Autocomplete 8

Namespace

Drupal\search_autocomplete\Plugin\views\row

File

src/Plugin/views/row/CallbackFieldRow.php

<?php

namespace Drupal\search_autocomplete\Plugin\views\row;

use Drupal\Core\Form\FormStateInterface;
use Drupal\views\Plugin\views\display\DisplayPluginBase;
use Drupal\views\Plugin\views\row\RowPluginBase;
use Drupal\views\ViewExecutable;

/**
 * Plugin which displays fields as raw data.
 *
 * @ingroup views_row_plugins
 *
 * @ViewsRow(
 *   id = "callback_fields",
 *   title = @Translation("Fields"),
 *   help = @Translation("Use fields as row data."),
 *   display_types = {"autocompletion_callback"}
 * )
 */
class CallbackFieldRow extends RowPluginBase {

  /**
   * Overrides \Drupal\views\Plugin\views\row\RowPluginBase::$usesFields.
   */
  protected $usesFields = TRUE;

  /**
   * Stores an array of prepared field aliases from options.
   *
   * @var array
   */
  protected $replacementAliases = [];

  /**
   * Stores an array of options to determine if the raw field output is used.
   *
   * @var array
   */
  protected $rawOutputOptions = [];
  protected $rowOptions = [];

  /**
   * Overrides \Drupal\views\Plugin\views\row\RowPluginBase::init().
   */
  public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
    parent::init($view, $display, $options);
    if (!empty($this->options['field_options'])) {
      $options = (array) $this->options['field_options'];

      // Prepare a trimmed version of replacement aliases.
      $aliases = static::extractFromOptionsArray('alias', $options);
      $this->replacementAliases = array_filter(array_map('trim', $aliases));

      // Prepare an array of raw output field options.
      $this->rawOutputOptions = static::extractFromOptionsArray('raw_output', $options);
    }
  }

  /**
   * Extracts a set of option values from a nested options array.
   *
   * @param string $key
   *   The key to extract from each array item.
   * @param array $options
   *   The options array to return values from.
   *
   * @return array
   *   A regular one dimensional array of values.
   */
  protected static function extractFromOptionsArray($key, $options) {
    return array_map(function ($item) use ($key) {
      return isset($item[$key]) ? $item[$key] : NULL;
    }, $options);
  }

  /**
   * Overrides \Drupal\views\Plugin\views\row\RowPluginBase::buildOptionsForm().
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['field_options'] = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Field'),
        $this
          ->t('Alias'),
      ],
      '#empty' => $this
        ->t('You have no fields. Add some to your view.'),
      '#tree' => TRUE,
    ];
    $options = $this->options['field_options'];
    if ($fields = $this->view->display_handler
      ->getOption('fields')) {
      foreach ($fields as $id => $field) {
        $form['field_options'][$id]['field'] = [
          '#markup' => $id,
        ];
        $form['field_options'][$id]['alias'] = [
          '#title' => $this
            ->t('Alias for @id', [
            '@id' => $id,
          ]),
          '#title_display' => 'invisible',
          '#type' => 'textfield',
          '#default_value' => isset($options[$id]['alias']) ? $options[$id]['alias'] : '',
          '#element_validate' => [
            [
              $this,
              'validateAliasName',
            ],
          ],
        ];
      }
    }
  }

  /**
   * Setter for rowOptions. This will contains the specific options for the
   * display.
   *
   * @param array $options
   *   The options grouping, link and value of the display.
   */
  public function setRowOptions($options) {
    $this->rowOptions = $options;
  }

  /**
   * Form element validation handler for CallbackFieldRow::buildOptionsForm().
   */
  public function validateAliasName($element, FormStateInterface $form_state) {
    if (preg_match('@[^A-Za-z0-9_-]+@', $element['#value'])) {
      $form_state
        ->setError($element, $this
        ->t('The machine-readable name must contain only letters, numbers, dashes and underscores.'));
    }
  }

  /**
   * Overrides
   * \Drupal\views\Plugin\views\row\RowPluginBase::validateOptionsForm().
   */
  public function validateOptionsForm(&$form, FormStateInterface $form_state) {

    // Collect an array of aliases to validate.
    $aliases = static::extractFromOptionsArray('alias', $form_state
      ->getValue([
      'row_options',
      'field_options',
    ]));

    // If array filter returns empty, no values have been entered. Unique keys
    // should only be validated if we have some.
    if (($filtered = array_filter($aliases)) && array_unique($filtered) !== $filtered) {
      $form_state
        ->setErrorByName('aliases', $this
        ->t('All field aliases must be unique'));
    }
  }

  /**
   * Overrides \Drupal\views\Plugin\views\row\RowPluginBase::render().
   */
  public function render($row) {
    $output = [];

    // Render all fields.
    foreach ($this->view->field as $id => $field) {

      // If this is not unknown and the raw output option has been set, just get
      // the raw value.
      if ($field->field_alias != 'unknown' && !empty($this->rawOutputOptions[$id])) {
        $value = $field
          ->sanitizeValue($field
          ->getValue($row), 'xss_admin');
      }
      else {
        if (!isset($this->view->row_index) || $this->view->row_index == NULL) {
          $this->view->row_index = $row->row_index;
        }
        $value = $field
          ->advancedRender($row);
      }

      // Add input link.
      if (isset($this->rowOptions['input_link']) && $this->rowOptions['input_link'] == $id) {
        $output['link'] = $value;
      }

      // Add value link.
      if (isset($this->rowOptions['input_label']) && $this->rowOptions['input_label'] == $id) {
        $output['value'] = $value;
      }

      // Add label if defined.
      if ($field->options['label']) {
        $value = $field->options['label'] . ': ' . $value;
      }

      // If field is not excluded: include in response.
      if (!$field->options['exclude']) {
        $output['fields'][$this
          ->getFieldKeyAlias($id)] = $value;
      }
    }
    return $output;
  }

  /**
   * Return an alias for a field ID, as set in the options form.
   *
   * @param string $id
   *   The field id to lookup an alias for.
   *
   * @return string
   *   The matches user entered alias, or the original ID if nothing is found.
   */
  public function getFieldKeyAlias($id) {
    if (isset($this->replacementAliases[$id])) {
      return $this->replacementAliases[$id];
    }
    return $id;
  }

  /**
   * Overrides \Drupal\views\Plugin\views\row\RowPluginBase::buildOptionsForm().
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    return $options;
  }

}

Classes

Name	Description
CallbackFieldRow	Plugin which displays fields as raw data.