ListFormatter.php in Text list formatter 8.2

Definition of Drupal\textformatter\Plugin\field\formatter\List;

Namespace

Drupal\textformatter\Plugin\field\formatter

File

lib/Drupal/textformatter/Plugin/field/formatter/ListFormatter.php

<?php

/**
 * @file
 * Definition of Drupal\textformatter\Plugin\field\formatter\List;
 */
namespace Drupal\textformatter\Plugin\field\formatter;

use Drupal\Core\Annotation\Plugin;
use Drupal\Core\Annotation\Translation;
use Drupal\Core\Entity\EntityInterface;
use Drupal\field\Plugin\Type\Formatter\FormatterBase;

/**
 * Plugin implementation of the 'text_default' formatter.
 *
 * @Plugin(
 *   id = "list_formatter",
 *   module = "textformatter",
 *   label = @Translation("List"),
 *   field_types = "",
 *   settings = {
 *     "type" = "ul",
 *     "class" = "textformatter-list",
 *     "comma_full_stop" = 0,
 *     "comma_and" = 0,
 *     "comma_tag" = "div",
 *     "term_plain" = 0,
 *     "comma_override" = 0,
 *     "separator_custom" = "",
 *     "separator_custom_tag" = "span",
 *     "separator_custom_class" = "textformatter-separator",
 *     "contrib" = ""
 *    }
 * )
 */
class ListFormatter extends FormatterBase {

  /**
   * Stores the textformatter info collected from hook_textformatter_field_info().
   *
   * @var array
   */
  protected static $textformatterInfo = array();

  /**
   * Implements Drupal\field\Plugin\Type\Formatter\FormatterInterface::settingsForm().
   */
  public function settingsForm(array $form, array &$form_state) {
    $field_name = $this->field['field_name'];
    $elements['type'] = array(
      '#title' => t("List type"),
      '#type' => 'select',
      '#options' => $this
        ->listTypes(),
      '#default_value' => $this
        ->getSetting('type'),
      '#required' => TRUE,
    );
    $elements['comma_and'] = array(
      '#type' => 'checkbox',
      '#title' => t("Include 'and' before the last item"),
      '#default_value' => $this
        ->getSetting('comma_and'),
      '#states' => array(
        'visible' => array(
          ':input[name="fields[' . $field_name . '][settings_edit_form][settings][type]"]' => array(
            'value' => 'comma',
          ),
          ':input[name="fields[' . $field_name . '][settings_edit_form][settings][comma_override]"]' => array(
            'checked' => FALSE,
          ),
        ),
      ),
    );
    $elements['comma_full_stop'] = array(
      '#type' => 'checkbox',
      '#title' => t("Append comma separated list with '.'"),
      '#default_value' => $this
        ->getSetting('comma_full_stop'),
      '#states' => array(
        'visible' => array(
          ':input[name="fields[' . $field_name . '][settings_edit_form][settings][type]"]' => array(
            'value' => 'comma',
          ),
          ':input[name="fields[' . $field_name . '][settings_edit_form][settings][comma_override]"]' => array(
            'checked' => FALSE,
          ),
        ),
      ),
    );

    //Override Comma with custom separator.
    $elements['comma_override'] = array(
      '#type' => 'checkbox',
      '#title' => t("Override comma separator"),
      '#description' => t("Override the default comma separator with a custom separator string."),
      '#default_value' => $this
        ->getSetting('comma_override'),
      '#states' => array(
        'visible' => array(
          ':input[name="fields[' . $field_name . '][settings_edit_form][settings][type]"]' => array(
            'value' => 'comma',
          ),
        ),
      ),
    );
    $elements['separator_custom'] = array(
      '#type' => 'textfield',
      '#title' => t("Custom separator"),
      '#description' => t("Override default comma separator with a custom separator string. You must add your own spaces in this string if you want them. @example", array(
        '@example' => "E.g. ' + ', or ' => '",
      )),
      '#size' => 40,
      '#default_value' => $this
        ->getSetting('separator_custom'),
      '#states' => array(
        'visible' => array(
          ':input[name="fields[' . $field_name . '][settings_edit_form][settings][comma_override]"]' => array(
            'checked' => TRUE,
          ),
        ),
      ),
    );
    $elements['separator_custom_tag'] = array(
      '#type' => 'select',
      '#title' => t("separator HTML wrapper"),
      '#description' => t("An HTML tag to wrap the separator in."),
      '#options' => $this
        ->wrapperOptions(),
      '#default_value' => $this
        ->getSetting('separator_custom_tag'),
      '#states' => array(
        'visible' => array(
          ':input[name="fields[' . $field_name . '][settings_edit_form][settings][comma_override]"]' => array(
            'checked' => TRUE,
          ),
        ),
      ),
    );
    $elements['separator_custom_class'] = array(
      '#title' => t("Separator classes"),
      '#type' => 'textfield',
      '#description' => t("A CSS class to use in the wrapper tag for the separator."),
      '#default_value' => $this
        ->getSetting('separator_custom_class'),
      '#element_validate' => array(
        '_textformatter_validate_class',
      ),
      '#states' => array(
        'visible' => array(
          ':input[name="fields[' . $field_name . '][settings_edit_form][settings][comma_override]"]' => array(
            'checked' => TRUE,
          ),
        ),
      ),
    );
    $elements['comma_tag'] = array(
      '#type' => 'select',
      '#title' => t("HTML wrapper"),
      '#description' => t("An HTML tag to wrap the list in. The CSS class below will be added to this tag."),
      '#options' => $this
        ->wrapperOptions(),
      '#default_value' => $this
        ->getSetting('comma_tag'),
      '#states' => array(
        'visible' => array(
          ':input[name="fields[' . $field_name . '][settings_edit_form][settings][type]"]' => array(
            'value' => 'comma',
          ),
        ),
      ),
    );
    $elements['class'] = array(
      '#title' => t("List classes"),
      '#type' => 'textfield',
      '#size' => 40,
      '#description' => t("A CSS class to use in the markup for the field list."),
      '#default_value' => $this
        ->getSetting('class'),
      '#element_validate' => array(
        '_textformatter_validate_class',
      ),
    );

    // Taxonomy term ref fields only.
    if ($this->field['type'] == 'taxonomy_term_reference') {
      $elements['term_plain'] = array(
        '#type' => 'checkbox',
        '#title' => t("Display taxonomy terms as plain text (Not term links)."),
        '#default_value' => $this
          ->getSetting('term_plain'),
      );
    }
    $context = array(
      'field' => $this->field,
      'instance' => $this->instance,
      'view_mode' => $this->viewMode,
    );
    drupal_alter('textformatter_field_formatter_settings_form', $form, $form_state, $context);
    return $elements;
  }

  /**
   * Implements Drupal\field\Plugin\Type\Formatter\FormatterInterface::settingsForm().
   */
  public function settingsSummary() {
    $summary = array();
    $types = $this
      ->listTypes();
    $summary[] = $types[$this
      ->getSetting('type')];
    if ($this
      ->getSetting('class')) {
      $summary[] = t("CSS Class") . ': <em>' . check_plain($this
        ->getSetting('class')) . '</em>';
    }
    if ($this
      ->getSetting('comma_override')) {
      $summary[] = '<em>*' . t("Comma separator overridden") . '*</em>';
    }
    return implode('<br>', $summary);
  }

  /**
   * Implements Drupal\field\Plugin\Type\Formatter\FormatterInterface::viewElements().
   */
  public function viewElements(EntityInterface $entity, $langcode, array $items) {
    $module = $this->field['module'];
    $field_type = $this->field['type'];
    $textformatter_info = $this
      ->fieldListInfo();
    $elements = $list_items = array();
    if (!empty($textformatter_info[$module]['callback']) && in_array($field_type, $textformatter_info[$module]['fields'])) {
      $function = $textformatter_info[$module]['callback'];
      if (function_exists($function)) {

        // Support existing function implementations.
        $display = array(
          'type' => $this
            ->getPluginId(),
          'settings' => $this
            ->getSettings(),
          'weight' => $this->weight,
          'label' => $this->label,
        );
        $list_items = $function($entity
          ->entityType(), $entity, $this->field, $this->instance, $langcode, $items, $display);
      }
      else {
        drupal_set_message(t('function @function does not exist.', array(
          '@function' => $function,
        )), 'error');
      }
    }
    else {
      foreach ($items as $delta => $item) {
        $list_items = $this
          ->defaultFieldList($entity, $langcode, $items);
      }
    }

    // If there are no list items, return and render nothing.
    if (empty($list_items)) {
      return;
    }
    $type = $this
      ->getSetting('type');

    // CSS classes are checked for validity on submission. drupal_attributes()
    // runs each attribute value through check_plain().
    $classes = explode(' ', $this
      ->getSetting('class'));
    switch ($type) {
      case 'ul':
      case 'ol':

        // Render as one element, item list.
        $elements[] = array(
          '#theme' => 'item_list',
          '#type' => $type,
          '#items' => $list_items,
          '#attributes' => array(
            'class' => $classes,
          ),
        );
        break;
      case 'comma':

        // Render as one element, comma separated list.
        $elements[] = array(
          '#theme' => 'textformatter_comma',
          '#items' => $list_items,
          '#formatter' => $this,
          '#attributes' => array(
            'class' => $classes,
          ),
        );
        break;
    }
    return $elements;
  }

  /**
   * Returns an array of info data, invoking hook_textformatter_field_info().
   *
   * @return array
   *   An array of info data.
   */
  protected static function fieldListInfo() {
    if (empty(self::$textformatterInfo)) {
      self::$textformatterInfo = module_invoke_all('textformatter_field_info');
      drupal_alter('textformatter_field_info', $info);
    }
    return self::$textformatterInfo;
  }

  /**
   * Returns an array of info to add to hook_field_formatter_info_alter().
   *
   * This iterates through each item returned from fieldListInfo.
   *
   * @return array
   *   An array of fields and settings from hook_textformatter_field_info data
   *   implementations. Containing an aggregated array from all items.
   */
  public static function prepareFieldListInfo() {
    $textformatter_info = self::fieldListInfo();
    $field_info = array(
      'fields' => array(),
      'settings' => array(),
    );

    // Create array of all field types and default settings.
    foreach ($textformatter_info as $module => $info) {
      $info += array(
        'fields' => array(),
        'settings' => array(),
      );
      $field_info['fields'] = array_merge($field_info['fields'], $info['fields']);
      $field_info['settings'] = array_merge($field_info['settings'], $info['settings']);
    }
    return $field_info;
  }

  /**
   * Default listing callback.
   */
  public function defaultFieldList(EntityInterface $entity, $langcode, array $items) {
    $list_items = array();

    // Use our helper function to get the value key dynamically.
    $value_key = _textformatter_get_field_value_key($this->field);
    foreach ($items as $delta => $item) {
      $list_items[$delta] = check_plain($item[$value_key]);
    }
    return $list_items;
  }

  /**
   * Returns a list of available list types.
   *
   * @return array
   *   An options list of types.
   */
  public function listTypes() {
    return array(
      'ul' => t("Unordered HTML list (ul)"),
      'ol' => t("Ordered HTML list (ol)"),
      'comma' => t("Comma separated list"),
    );
  }

  /**
   * Helper method return an array of html tags; formatted for a select list.
   *
   * @return array
   *   A keyed array of available html tags.
   */
  public function wrapperOptions() {
    return array(
      t('No HTML tag'),
      'div' => t('Div'),
      'span' => t('Span'),
      'p' => t('Paragraph'),
      'h1' => t('Header 1'),
      'h2' => t('Header 2'),
      'h3' => t('Header 3'),
      'h4' => t('Header 4'),
      'h5' => t('Header 5'),
      'h6' => t('Header 6'),
    );
  }

}

Classes

Name	Description
ListFormatter	Plugin implementation of the 'text_default' formatter.