View source
<?php
namespace Drupal\webform\Element;
use Drupal\Component\Render\FormattableMarkup;
use Drupal\Component\Utility\Html;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Render\Element\FormElement;
use Drupal\webform\Utility\WebformAccessibilityHelper;
use Drupal\webform\Utility\WebformElementHelper;
use Drupal\webform\Utility\WebformOptionsHelper;
class WebformLikert extends FormElement {
public function getInfo() {
$class = get_class($this);
return [
'#input' => TRUE,
'#process' => [
[
$class,
'processWebformLikert',
],
[
$class,
'processAjaxForm',
],
],
'#theme_wrappers' => [
'form_element',
],
'#required' => FALSE,
'#required_error' => '',
'#sticky' => TRUE,
'#questions' => [],
'#questions_description_display' => 'description',
'#answers' => [],
'#answers_description_display' => 'description',
'#na_answer' => FALSE,
'#na_answer_text' => '',
'#na_answer_value' => '',
];
}
public static function processWebformLikert(&$element, FormStateInterface $form_state, &$complete_form) {
static::processWebformLikertAnswers($element);
$element['#label_attributes']['webform-remove-for-attribute'] = TRUE;
$answers = [];
foreach ($element['#answers'] as $answer_key => $answer) {
$answer = (string) $answer;
if (!WebformOptionsHelper::hasOptionDescription($answer)) {
$answer_description_property_name = NULL;
$answer_title = $answer;
$answer_description = '';
}
else {
$answer_description_property_name = $element['#answers_description_display'] === 'help' ? 'help' : 'description';
list($answer_title, $answer_description) = WebformOptionsHelper::splitOption($answer);
}
$answers[$answer_key] = [
'description_property_name' => $answer_description_property_name,
'title' => $answer_title,
'description' => $answer_description,
];
}
$header = [
'likert_question' => [
'data' => [
'title' => WebformAccessibilityHelper::buildVisuallyHidden(t('Questions')),
],
],
];
foreach ($answers as $answer_key => $answer) {
$header[$answer_key] = [
'data' => [
'title' => [
'#markup' => $answer['title'],
],
],
];
switch ($answer['description_property_name']) {
case 'help':
$header[$answer_key]['data']['help'] = [
'#type' => 'webform_help',
'#help' => $answer['description'],
'#help_title' => $answer['title'],
];
break;
case 'description':
$header[$answer_key]['data']['description'] = [
'#type' => 'container',
'#markup' => $answer['description'],
'#attributes' => [
'class' => [
'description',
],
],
];
break;
}
}
if (!empty($element['#questions_randomize'])) {
$element['#questions'] = WebformElementHelper::randomize($element['#questions']);
}
$rows = [];
foreach ($element['#questions'] as $question_key => $question) {
$question = (string) $question;
if (!WebformOptionsHelper::hasOptionDescription($question)) {
$question_description_property_name = NULL;
$question_title = $question;
$question_description = '';
}
else {
$question_description_property_name = $element['#questions_description_display'] === 'help' ? '#help' : '#description';
list($question_title, $question_description) = WebformOptionsHelper::splitOption($question);
}
$value = isset($element['#value'][$question_key]) ? $element['#value'][$question_key] : NULL;
$question_id = 'edit-' . implode('-', array_merge($element['#parents'], [
'table',
$question_key,
'likert_question',
]));
$question_id = Html::getUniqueId($question_id);
$row = [];
$row['likert_question'] = [
'#type' => 'item',
'#title' => $question_title,
'#id' => $question_id,
'#value' => '<span></span>',
'#webform_element' => TRUE,
'#required' => $element['#required'],
'#label_attributes' => [
'webform-remove-for-attribute' => TRUE,
],
];
if ($question_description_property_name) {
$row['likert_question'][$question_description_property_name] = $question_description;
}
foreach ($answers as $answer_key => $answer) {
$answer_attributes = [
'aria-labelledby' => $question_id,
];
if ($element['#required']) {
$answer_attributes['required'] = 'required';
$answer_attributes['aria-required'] = 'true';
}
$row[$answer_key] = [
'#parents' => [
$element['#name'],
$question_key,
],
'#type' => 'radio',
'#return_value' => (string) $answer_key,
'#value' => $value === NULL ? FALSE : (string) $value,
'#attributes' => $answer_attributes,
];
$row[$answer_key]['#title_display'] = 'after';
switch ($answer['description_property_name']) {
case 'help':
$build = [
'title' => [
'#markup' => $answer['title'],
],
'help' => [
'#type' => 'webform_help',
'#help' => $answer['description'],
'#help_title' => $answer['title'],
'#prefix' => '<span class="webform-likert-help hidden">',
'#suffix' => '</span>',
],
'#prefix' => '<span class="webform-likert-label visually-hidden">',
'#suffix' => '</span>',
];
$row[$answer_key]['#title'] = \Drupal::service('renderer')
->render($build);
break;
case 'description':
$row[$answer_key] += [
'#title' => new FormattableMarkup('<span class="webform-likert-label visually-hidden">@title</span>', [
'@title' => $answer['title'],
]),
'#description' => new FormattableMarkup('<span class="webform-likert-description hidden">@description</span>', [
'@description' => $answer['description'],
]),
];
break;
default:
$row[$answer_key] += [
'#title' => new FormattableMarkup('<span class="webform-likert-label visually-hidden">@title</span>', [
'@title' => $answer['title'],
]),
];
}
}
$rows[$question_key] = $row;
}
$element['table'] = [
'#type' => 'table',
'#header' => $header,
'#sticky' => $element['#sticky'],
'#attributes' => [
'class' => [
'webform-likert-table',
],
'data-likert-answers-count' => count($element['#answers']),
],
'#prefix' => '<div class="webform-likert-table-wrapper">',
'#suffix' => '</div>',
] + $rows;
$properties = [
'#states',
'#sticky',
];
$element['table'] += array_intersect_key($element, array_combine($properties, $properties));
$element['#tree'] = TRUE;
$element['#after_build'][] = [
get_called_class(),
'afterBuild',
];
$element += [
'#element_validate' => [],
];
array_unshift($element['#element_validate'], [
get_called_class(),
'validateWebformLikert',
]);
$element['#attached']['library'][] = 'webform/webform.element.likert';
return $element;
}
public static function processWebformLikertAnswers(array &$element) {
if (empty($element['#na_answer']) || empty($element['#answers'])) {
return;
}
$na_value = !empty($element['#na_answer_value']) ? $element['#na_answer_value'] : (string) t('N/A');
$na_text = !empty($element['#na_answer_text']) ? $element['#na_answer_text'] : $na_value;
$element['#answers'] += [
$na_value => $na_text,
];
}
public static function afterBuild(array $element, FormStateInterface $form_state) {
if ($form_state
->isProcessingInput()) {
$form_state
->setValueForElement($element, $element['#value']);
}
return $element;
}
public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
$default_value = [];
foreach ($element['#questions'] as $question_key => $question_title) {
$default_value[$question_key] = NULL;
}
if ($input === FALSE) {
if (empty($element['#default_value'])) {
$element['#default_value'] = [];
}
return $element['#default_value'] + $default_value;
}
$value = $default_value;
foreach ($value as $allowed_key => $default) {
if (isset($input[$allowed_key]) && is_scalar($input[$allowed_key])) {
$value[$allowed_key] = (string) $input[$allowed_key];
}
}
return $value;
}
public static function validateWebformLikert(&$element, FormStateInterface $form_state, &$complete_form) {
if (!empty($element['#required'])) {
static::setRequiredError($element, $form_state);
}
}
public static function setRequiredError(array &$element, FormStateInterface $form_state) {
$value = $element['#value'];
foreach ($element['#questions'] as $question_key => $question_title) {
if (is_null($value[$question_key])) {
$question_element =& $element['table'][$question_key]['likert_question'];
$t_args = [
'@name' => $question_title,
];
if (!empty($element['#required_error'])) {
$form_state
->setError($question_element, new FormattableMarkup($element['#required_error'], $t_args));
}
else {
$form_state
->setError($question_element, t('@name field is required.', $t_args));
}
}
}
}
}