You are here

Home » API reference » YAML Form 8 » YamlFormLikert.php

class YamlFormLikert in YAML Form 8

Same name in this branch
  1. 8 src/Element/YamlFormLikert.php \Drupal\yamlform\Element\YamlFormLikert
  2. 8 src/Plugin/YamlFormElement/YamlFormLikert.php \Drupal\yamlform\Plugin\YamlFormElement\YamlFormLikert

Provides a 'likert' element.

Plugin annotation


@YamlFormElement(
  id = "yamlform_likert",
  label = @Translation("Likert"),
  category = @Translation("Options elements"),
  multiline = TRUE,
  composite = TRUE,
)

Hierarchy

Expanded class hierarchy of YamlFormLikert

File

src/Plugin/YamlFormElement/YamlFormLikert.php, line 24

Namespace

Drupal\yamlform\Plugin\YamlFormElement
View source 
class YamlFormLikert extends YamlFormElementBase {

  /**
   * {@inheritdoc}
   */
  public function getDefaultProperties() {
    return [
      'title' => '',
      // General settings.
      'description' => '',
      'default_value' => [],
      // Form display.
      'title_display' => '',
      'description_display' => '',
      // Form validation.
      'required' => FALSE,
      // Submission display.
      'format' => $this
        ->getDefaultFormat(),
      // Likert settings.
      'questions' => [],
      'questions_randomize' => FALSE,
      'answers' => [],
      'na_answer' => FALSE,
      'na_answer_value' => '',
      'na_answer_text' => $this
        ->t('N/A'),
    ] + $this
      ->getDefaultBaseProperties();
  }

  /**
   * {@inheritdoc}
   */
  public function getTranslatableProperties() {
    return array_merge(parent::getTranslatableProperties(), [
      'questions',
      'answers',
      'na_answer_text',
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function initialize(array &$element) {
    parent::initialize($element);

    // Set element answers.
    if (isset($element['#answers'])) {
      $element['#answers'] = YamlFormOptions::getElementOptions($element, '#answers');
    }

    // Process answers and set N/A.
    YamlFormLikertElement::processYamlFormLikertAnswers($element);
  }

  /**
   * {@inheritdoc}
   */
  public function formatHtml(array &$element, $value, array $answers = []) {
    $format = $this
      ->getFormat($element);
    switch ($format) {
      case 'raw':
        $items = [];
        foreach ($element['#questions'] as $question_key => $question_label) {
          $answer_value = isset($value[$question_key]) ? $value[$question_key] : NULL;
          $items[$question_key] = [
            '#markup' => "<b>{$question_key}:</b> {$answer_value}",
          ];
        }
        return [
          '#theme' => 'item_list',
          '#items' => $items,
        ];
      case 'table':

        // NOTE: Including inline align attributes to help style the table for
        // HTML emails.
        $header = [];
        $header['likert_question'] = [
          'data' => '',
          'align' => 'left',
          'width' => '40%',
        ];
        foreach ($element['#answers'] as $answer_value => $answer_text) {
          $header[$answer_value] = [
            'data' => $answer_text,
            'align' => 'center',
          ];
        }

        // Calculate answers width.
        $width = number_format(60 / count($element['#answers']), 2, '.', '') . '%';
        $rows = [];
        foreach ($element['#questions'] as $question_key => $question_label) {
          $question_value = isset($value[$question_key]) ? $value[$question_key] : NULL;
          $row = [];
          $row['likert_question'] = [
            'data' => $question_label,
            'align' => 'left',
            'width' => '40%',
          ];
          foreach ($element['#answers'] as $answer_value => $answer_text) {
            $row[$answer_value] = [
              'data' => $question_value == $answer_value ? [
                '#markup' => '&#10007;',
              ] : '',
              'align' => 'center',
              'width' => $width,
            ];
          }
          $rows[$question_key] = $row;
        }
        return [
          '#type' => 'table',
          '#header' => $header,
          '#rows' => $rows,
          '#attributes' => [
            'class' => [
              'yamlform-likert-table',
            ],
          ],
          '#attached' => [
            'library' => [
              'yamlform/yamlform.element.likert',
            ],
          ],
        ];
      default:
      case 'value':
      case 'list':
        $items = [];
        foreach ($element['#questions'] as $question_key => $question_label) {
          $answer_value = isset($value[$question_key]) ? $value[$question_key] : NULL;
          $answer_text = $answer_value ? YamlFormOptionsHelper::getOptionText($answer_value, $element['#answers']) : $this
            ->t('[blank]');
          $items[$question_key] = [
            '#markup' => "<b>{$question_label}:</b> {$answer_text}",
          ];
        }
        return [
          '#theme' => 'item_list',
          '#items' => $items,
        ];
    }
  }

  /**
   * {@inheritdoc}
   */
  public function formatText(array &$element, $value, array $answers = []) {

    // Return empty value.
    if ($value === '' || $value === NULL || is_array($value) && empty($value)) {
      return '';
    }
    $format = $this
      ->getFormat($element);
    switch ($format) {
      case 'raw':
        $list = [];
        foreach ($element['#questions'] as $question_key => $question_label) {
          $answer_value = isset($value[$question_key]) ? $value[$question_key] : NULL;
          $list[] = "{$question_key}: {$answer_value}";
        }
        return implode("\n", $list);
      default:
      case 'value':
      case 'table':
      case 'list':
        $list = [];
        foreach ($element['#questions'] as $question_key => $question_label) {
          $answer_value = isset($value[$question_key]) ? $value[$question_key] : NULL;
          $answer_text = YamlFormOptionsHelper::getOptionText($answer_value, $element['#answers']);
          $list[] = "{$question_label}: {$answer_text}";
        }
        return implode("\n", $list);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getExportDefaultOptions() {
    return [
      'likert_answers_format' => 'label',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildExportOptionsForm(array &$form, FormStateInterface $form_state, array $export_options) {
    $form['likert'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Likert questions and answers'),
      '#open' => TRUE,
      '#weight' => -10,
    ];
    $form['likert']['likert_answers_format'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Answers format'),
      '#options' => [
        'label' => $this
          ->t('Answer labels, the human-readable value (label)'),
        'key' => $this
          ->t('Answer keys, the raw value stored in the database (key)'),
      ],
      '#default_value' => $export_options['likert_answers_format'],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildExportHeader(array $element, array $options) {
    $header = [];
    foreach ($element['#questions'] as $key => $label) {
      $header[] = $options['header_format'] == 'key' ? $key : $label;
    }
    return $this
      ->prefixExportHeader($header, $element, $options);
  }

  /**
   * {@inheritdoc}
   */
  public function buildExportRecord(array $element, $value, array $export_options) {
    $record = [];
    foreach ($element['#questions'] as $question_key => $question_label) {
      $answer_value = isset($value[$question_key]) ? $value[$question_key] : NULL;
      if ($export_options['likert_answers_format'] == 'key') {
        $record[] = $answer_value;
      }
      else {
        $record[] = YamlFormOptionsHelper::getOptionText($answer_value, $element['#answers']);
      }
    }
    return $record;
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultFormat() {
    return 'list';
  }

  /**
   * {@inheritdoc}
   */
  public function getFormats() {
    return parent::getFormats() + [
      'list' => $this
        ->t('List'),
      'table' => $this
        ->t('Table'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getTableColumn(array $element) {
    $key = $element['#yamlform_key'];
    $title = $element['#title'] ?: $key;
    $is_title_displayed = YamlFormElementHelper::isTitleDisplayed($element);

    // Get the main composite element, which can't be sorted.
    $columns = parent::getTableColumn($element);
    $columns['element__' . $key]['sort'] = FALSE;

    // Get individual questions.
    foreach ($element['#questions'] as $question_key => $question_label) {
      $columns['element__' . $key . '__' . $question_key] = [
        'title' => ($is_title_displayed ? $title . ': ' : '') . $question_label,
        'sort' => TRUE,
        'default' => FALSE,
        'key' => $key,
        'element' => $element,
        'delta' => $question_key,
        'question_key' => $question_key,
        'plugin' => $this,
      ];
    }
    return $columns;
  }

  /**
   * {@inheritdoc}
   */
  public function formatTableColumn(array $element, $value, array $options = []) {
    if (isset($options['question_key'])) {
      $question_key = $options['question_key'];
      $question_value = isset($value[$question_key]) ? $value[$question_key] : '';
      return YamlFormOptionsHelper::getOptionText($question_value, $element['#answers']);
    }
    else {
      return $this
        ->formatHtml($element, $value);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getTestValue(array $element, YamlFormInterface $yamlform) {
    $value = [];
    foreach ($element['#questions'] as $key => $question) {
      $keys = array_keys($element['#answers']);
      $value[$key] = $keys[array_rand($keys)];
    }
    return [
      $value,
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function getElementSelectorInputsOptions(array $element) {
    $selectors = $element['#questions'];
    foreach ($selectors as &$text) {
      $text .= ' [' . $this
        ->t('Radios') . ']';
    }
    return $selectors;
  }

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    $form = parent::form($form, $form_state);
    $form['likert'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Likert settings'),
    ];
    $form['likert']['questions'] = [
      '#type' => 'yamlform_options',
      '#title' => $this
        ->t('Questions'),
      '#label' => $this
        ->t('question'),
      '#labels' => $this
        ->t('questions'),
      '#required' => TRUE,
    ];
    $form['likert']['questions_randomize'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Randomize questions'),
      '#description' => $this
        ->t('Randomizes the order of the questions when they are displayed in the form.'),
      '#return_value' => TRUE,
    ];
    $form['likert']['answers'] = [
      '#type' => 'yamlform_element_options',
      '#title' => $this
        ->t('Answers'),
      '#likert' => TRUE,
      '#required' => TRUE,
    ];
    $form['likert']['na_answer'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Allow N/A answer'),
      '#description' => $this
        ->t('Allowing N/A is ideal for situations where you wish to make a likert element required, but still want to allow users to opt out of certain questions.'),
      '#return_value' => TRUE,
    ];
    $form['likert']['na_answer_value'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('N/A answer value'),
      '#description' => $this
        ->t('Value stored in the database. Leave blank to store an empty string in the database.'),
      '#states' => [
        'visible' => [
          ':input[name="properties[na_answer]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['likert']['na_answer_text'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('N/A answer text'),
      '#description' => $this
        ->t('Text display display on form.'),
      '#states' => [
        'visible' => [
          ':input[name="properties[na_answer]"]' => [
            'checked' => TRUE,
          ],
        ],
        'required' => [
          ':input[name="properties[na_answer]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    return $form;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
YamlFormElementBase::$configFactory protected property The configuration factory.
YamlFormElementBase::$currentUser protected property The current user.
YamlFormElementBase::$elementInfo protected property A element info manager.
YamlFormElementBase::$elementManager protected property The form element manager.
YamlFormElementBase::$entityTypeManager protected property The entity type manager.
YamlFormElementBase::$logger protected property A logger instance.
YamlFormElementBase::$tokenManager protected property The token manager.
YamlFormElementBase::build protected function Build an element as text or HTML. 2
YamlFormElementBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 1
YamlFormElementBase::buildHtml public function Build an element as HTML element. Overrides YamlFormElementInterface::buildHtml 1
YamlFormElementBase::buildText public function Build an element as text element. Overrides YamlFormElementInterface::buildText 1
YamlFormElementBase::checkAccessRules public function Check element access (rules). Overrides YamlFormElementInterface::checkAccessRules
YamlFormElementBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
YamlFormElementBase::displayDisabledWarning public function Display element disabled warning. Overrides YamlFormElementInterface::displayDisabledWarning 1
YamlFormElementBase::getAdminLabel public function Get an element's admin label (#admin_title, #title or #yamlform_key). Overrides YamlFormElementInterface::getAdminLabel
YamlFormElementBase::getConfigurationFormProperties public function Get an associative array of element properties from configuration form. Overrides YamlFormElementInterface::getConfigurationFormProperties 2
YamlFormElementBase::getConfigurationFormProperty protected function Get configuration property value. 1
YamlFormElementBase::getDefaultBaseProperties protected function Get default base properties used by all elements.
YamlFormElementBase::getElementSelectorOptions public function Get an element's selectors as options. Overrides YamlFormElementInterface::getElementSelectorOptions 11
YamlFormElementBase::getElementStateOptions public function Get an element's supported states as options. Overrides YamlFormElementInterface::getElementStateOptions
YamlFormElementBase::getFormat public function Get element's format name by looking for '#format' property, global settings, and finally default settings. Overrides YamlFormElementInterface::getFormat 1
YamlFormElementBase::getInfo public function Retrieves the default properties for the defined element type. Overrides YamlFormElementInterface::getInfo
YamlFormElementBase::getKey public function Get an element's key/name. Overrides YamlFormElementInterface::getKey
YamlFormElementBase::getLabel public function Get an element's label (#title or #yamlform_key). Overrides YamlFormElementInterface::getLabel
YamlFormElementBase::getPluginApiLink public function Get link to element's API documentation. Overrides YamlFormElementInterface::getPluginApiLink
YamlFormElementBase::getPluginApiUrl public function Get the URL for the element's API documentation. Overrides YamlFormElementInterface::getPluginApiUrl
YamlFormElementBase::getPluginLabel public function Gets the label of the plugin instance. Overrides YamlFormElementInterface::getPluginLabel
YamlFormElementBase::getRelatedTypes public function Get related element types. Overrides YamlFormElementInterface::getRelatedTypes 3
YamlFormElementBase::getTypeName public function Gets the type name (aka id) of the plugin instance with the 'yamlform_' prefix. Overrides YamlFormElementInterface::getTypeName
YamlFormElementBase::hasMultipleValues public function Checks if element value has multiple values. Overrides YamlFormElementInterface::hasMultipleValues 3
YamlFormElementBase::hasProperty public function Determine if an element supports a specified property. Overrides YamlFormElementInterface::hasProperty
YamlFormElementBase::hasWrapper public function Checks if the element has a wrapper. Overrides YamlFormElementInterface::hasWrapper
YamlFormElementBase::isComposite public function Checks if element is a composite element. Overrides YamlFormElementInterface::isComposite
YamlFormElementBase::isContainer public function Checks if element is a container that can contain elements. Overrides YamlFormElementInterface::isContainer 3
YamlFormElementBase::isDisabled public function Checks if element is disabled. Overrides YamlFormElementInterface::isDisabled
YamlFormElementBase::isEnabled public function Checks if element is enabled. Overrides YamlFormElementInterface::isEnabled 1
YamlFormElementBase::isHidden public function Checks if element is hidden. Overrides YamlFormElementInterface::isHidden
YamlFormElementBase::isInput public function Checks if the element carries a value. Overrides YamlFormElementInterface::isInput 5
YamlFormElementBase::isMultiline public function Checks if element value could contain multiple lines. Overrides YamlFormElementInterface::isMultiline 3
YamlFormElementBase::isRoot public function Checks if element is a root element. Overrides YamlFormElementInterface::isRoot 1
YamlFormElementBase::postCreate public function Acts on a form submission element after it is created. Overrides YamlFormElementInterface::postCreate 1
YamlFormElementBase::postDelete public function Delete any additional value associated with an element. Overrides YamlFormElementInterface::postDelete 2
YamlFormElementBase::postLoad public function Acts on loaded form submission. Overrides YamlFormElementInterface::postLoad 1
YamlFormElementBase::postSave public function Acts on a saved form submission element before the insert or update hook is invoked. Overrides YamlFormElementInterface::postSave 2
YamlFormElementBase::preCreate public function Changes the values of an entity before it is created. Overrides YamlFormElementInterface::preCreate 1
YamlFormElementBase::preDelete public function 1
YamlFormElementBase::prefixExportHeader protected function Prefix an element's export header.
YamlFormElementBase::prepare public function Prepare an element to be rendered within a form. Overrides YamlFormElementInterface::prepare 18
YamlFormElementBase::prepareWrapper protected function Set an elements Flexbox and #states wrapper. 1
YamlFormElementBase::preSave public function Acts on a form submission element before the presave hook is invoked. Overrides YamlFormElementInterface::preSave 2
YamlFormElementBase::setConfigurationFormDefaultValue protected function Set an element's configuration form element default value. 2
YamlFormElementBase::setConfigurationFormDefaultValueRecursive protected function Set configuration form default values recursively.
YamlFormElementBase::setDefaultValue public function Set an element's default value using saved data. Overrides YamlFormElementInterface::setDefaultValue 8
YamlFormElementBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
YamlFormElementBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 3
YamlFormElementBase::validateUnique public static function Form API callback. Validate #unique value.
YamlFormElementBase::__construct public function Constructs a Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
YamlFormLikert::buildExportHeader public function Build an element's export header. Overrides YamlFormElementBase::buildExportHeader
YamlFormLikert::buildExportOptionsForm public function Get an element's export options form. Overrides YamlFormElementBase::buildExportOptionsForm
YamlFormLikert::buildExportRecord public function Build an element's export row. Overrides YamlFormElementBase::buildExportRecord
YamlFormLikert::form public function Gets the actual configuration form array to be built. Overrides YamlFormElementBase::form
YamlFormLikert::formatHtml public function Format an element's value as HTML. Overrides YamlFormElementBase::formatHtml
YamlFormLikert::formatTableColumn public function Format an element's table column value. Overrides YamlFormElementBase::formatTableColumn
YamlFormLikert::formatText public function Format an element's value as plain text. Overrides YamlFormElementBase::formatText
YamlFormLikert::getDefaultFormat public function Get an element's default format name. Overrides YamlFormElementBase::getDefaultFormat
YamlFormLikert::getDefaultProperties public function Only a few elements don't inherit these default properties. Overrides YamlFormElementBase::getDefaultProperties
YamlFormLikert::getElementSelectorInputsOptions protected function Get an element's (sub)inputs selectors as options. Overrides YamlFormElementBase::getElementSelectorInputsOptions
YamlFormLikert::getExportDefaultOptions public function Get an element's default export options. Overrides YamlFormElementBase::getExportDefaultOptions
YamlFormLikert::getFormats public function Get an element's available formats. Overrides YamlFormElementBase::getFormats
YamlFormLikert::getTableColumn public function Get element's table column(s) settings. Overrides YamlFormElementBase::getTableColumn
YamlFormLikert::getTestValue public function Get test value for an element. Overrides YamlFormElementBase::getTestValue
YamlFormLikert::getTranslatableProperties public function Get translatable properties. Overrides YamlFormElementBase::getTranslatableProperties
YamlFormLikert::initialize public function Initialize an element to be displayed, rendered, or exported. Overrides YamlFormElementBase::initialize