support-2.0.x-dev/modules/support_ticket/src/Plugin/views/field/SupportTicket.php

<?php

namespace Drupal\support_ticket\Plugin\views\field;

use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Url;
use Drupal\views\ResultRow;
use Drupal\views\ViewExecutable;
use Drupal\views\Plugin\views\display\DisplayPluginBase;
use Drupal\views\Plugin\views\field\FieldPluginBase;

/**
 * Field handler provides renderer that allows linking to a support ticket.
 *
 * Definition terms:
 * - link_to_support_ticket default: Should this field have the checkbox
 *   "link to support ticket" enabled by default.
 *
 * @ingroup views_field_handlers
 *
 * @ViewsField("support_ticket")
 */
class SupportTicket extends FieldPluginBase {

  /**
   * {@inheritdoc}
   */
  public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
    parent::init($view, $display, $options);

    // Don't add the additional fields to groupby.
    if (!empty($this->options['link_to_support_ticket'])) {
      $this->additional_fields['stid'] = [
        'table' => 'support_ticket_field_data',
        'field' => 'stid',
      ];
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $default = FALSE;
    if (isset($this->definition['link_to_support_ticket default'])) {
      $default = $this->definition['link_to_support_ticket default'];
    }
    $options['link_to_support_ticket'] = ['default' => $default];
    return $options;
  }

  /**
   * Provide link to support ticket option.
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    $form['link_to_support_ticket'] = [
      '#title' => $this->t('Link this field to the original ticket'),
      '#description' => $this->t("Enable to override this field's links."),
      '#type' => 'checkbox',
      '#default_value' => !empty($this->options['link_to_support_ticket']),
    ];

    parent::buildOptionsForm($form, $form_state);
  }

  /**
   * Prepares link to the support ticket.
   *
   * @param string $data
   *   The XSS safe string for the link text.
   * @param \Drupal\views\ResultRow $values
   *   The values retrieved from a single row of a view's query result.
   *
   * @return string
   *   Returns a string for the link text.
   */
  protected function renderLink($data, ResultRow $values) {
    if (!empty($this->options['link_to_support_ticket']) && !empty($this->additional_fields['stid'])) {
      if ($data !== NULL && $data !== '') {
        $this->options['alter']['make_link'] = TRUE;
        $this->options['alter']['url'] = Url::fromRoute('entity.support_ticket.canonical', ['support_ticket' => $this->getValue($values, 'stid')]);
        if (isset($this->aliases['langcode'])) {
          $languages = \Drupal::languageManager()->getLanguages();
          $langcode = $this->getValue($values, 'langcode');
          if (isset($languages[$langcode])) {
            $this->options['alter']['language'] = $languages[$langcode];
          }
          else {
            unset($this->options['alter']['language']);
          }
        }
      }
      else {
        $this->options['alter']['make_link'] = FALSE;
      }
    }
    return $data;
  }

  /**
   * {@inheritdoc}
   */
  public function render(ResultRow $values) {
    $value = $this->getValue($values);
    return $this->renderLink($this->sanitizeValue($value), $values);
  }

}