View source
<?php
namespace Drupal\webform_ui\Form;
use Drupal\Component\Utility\Html;
use Drupal\Component\Utility\NestedArray;
use Drupal\Core\Entity\EntityFieldManagerInterface;
use Drupal\Core\Form\FormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Form\SubformState;
use Drupal\Core\Render\RendererInterface;
use Drupal\Core\Url;
use Drupal\webform\Element\WebformMessage;
use Drupal\webform\Plugin\WebformElement\WebformTable;
use Drupal\webform\Plugin\WebformElement\WebformTableRow;
use Drupal\webform\Plugin\WebformElementVariantInterface;
use Drupal\webform\Utility\WebformDialogHelper;
use Drupal\webform\Form\WebformDialogFormTrait;
use Drupal\webform\Plugin\WebformElementManagerInterface;
use Drupal\webform\Utility\WebformYaml;
use Drupal\webform\WebformEntityElementsValidatorInterface;
use Drupal\webform\WebformInterface;
use Drupal\webform\WebformTokenManagerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
abstract class WebformUiElementFormBase extends FormBase implements WebformUiElementFormInterface {
use WebformDialogFormTrait;
protected $renderer;
protected $entityFieldManager;
protected $elementManager;
protected $elementsValidator;
protected $tokenManager;
protected $webform;
protected $element = [];
protected $key;
protected $parentKey;
protected $originalType;
protected $operation;
protected $action;
public function getFormId() {
return 'webform_ui_element_form';
}
public function __construct(RendererInterface $renderer, EntityFieldManagerInterface $entity_field_manager, WebformElementManagerInterface $element_manager, WebformEntityElementsValidatorInterface $elements_validator, WebformTokenManagerInterface $token_manager) {
$this->renderer = $renderer;
$this->entityFieldManager = $entity_field_manager;
$this->elementManager = $element_manager;
$this->elementsValidator = $elements_validator;
$this->tokenManager = $token_manager;
}
public static function create(ContainerInterface $container) {
return new static($container
->get('renderer'), $container
->get('entity_field.manager'), $container
->get('plugin.manager.webform.element'), $container
->get('webform.elements_validator'), $container
->get('webform.token_manager'));
}
public function buildForm(array $form, FormStateInterface $form_state, WebformInterface $webform = NULL, $key = NULL, $parent_key = NULL, $type = NULL) {
if ($form_state
->get('default_value')) {
$this->element['#default_value'] = $form_state
->get('default_value');
}
$this->webform = $webform;
$this->key = $key;
$this->parentKey = $parent_key;
$element_plugin = $this
->getWebformElementPlugin();
$form['#parents'] = [];
$form['properties'] = [
'#parents' => [
'properties',
],
];
$subform_state = SubformState::createForSubform($form['properties'], $form, $form_state);
$form['properties'] = $element_plugin
->buildConfigurationForm($form['properties'], $subform_state);
if (isset($form['properties']['messages'])) {
$form['messages'] = $form['properties']['messages'];
$form['messages']['#weight'] = -100;
unset($form['properties']['messages']);
}
$form['parent_key'] = [
'#type' => 'value',
'#value' => $parent_key,
];
$form['properties']['element']['type'] = [
'#type' => 'item',
'#title' => $this
->t('Type'),
'label' => [
'#markup' => $element_plugin
->getPluginLabel(),
],
'#weight' => -100,
'#parents' => [
'type',
],
];
if ($key && $element_plugin
->getRelatedTypes($this->element)) {
$route_parameters = [
'webform' => $webform
->id(),
'key' => $key,
];
if ($this->originalType) {
$original_webform_element = $this->elementManager
->createInstance($this->originalType);
$route_parameters = [
'webform' => $webform
->id(),
'key' => $key,
];
$form['properties']['element']['type']['cancel'] = [
'#type' => 'link',
'#title' => $this
->t('Cancel'),
'#url' => new Url('entity.webform_ui.element.edit_form', $route_parameters),
'#attributes' => WebformDialogHelper::getOffCanvasDialogAttributes(WebformDialogHelper::DIALOG_NORMAL, [
'button',
'button--small',
]),
'#prefix' => ' ',
];
$form['properties']['element']['type']['#description'] = '(' . $this
->t('Changing from %type', [
'%type' => $original_webform_element
->getPluginLabel(),
]) . ')';
}
else {
$form['properties']['element']['type']['change_type'] = [
'#type' => 'link',
'#title' => $this
->t('Change'),
'#url' => new Url('entity.webform_ui.change_element', $route_parameters),
'#attributes' => WebformDialogHelper::getModalDialogAttributes(WebformDialogHelper::DIALOG_NORMAL, [
'button',
'button--small',
]),
'#prefix' => ' ',
];
}
}
if (!$key) {
$reserved_keys = [
'form_build_id',
'form_token',
'form_id',
'data',
'op',
'destination',
];
$reserved_keys = array_merge($reserved_keys, array_keys($this->entityFieldManager
->getBaseFieldDefinitions('webform_submission')));
$form['#attached']['drupalSettings']['webform_ui']['reserved_keys'] = $reserved_keys;
$form['properties']['element']['key_warning'] = [
'#type' => 'webform_message',
'#message_type' => 'warning',
'#message_message' => [
'#markup' => $this
->t("Please avoid using the reserved word '@key' as the element's key."),
'#prefix' => '<div id="webform-ui-reserved-key-warning">',
'#suffix' => '</div>',
],
'#weight' => -99,
'#attributes' => [
'style' => 'display:none',
],
];
}
$machine_name_pattern = $this
->config('webform.settings')
->get('element.machine_name_pattern') ?: 'a-z0-9_';
switch ($machine_name_pattern) {
case 'a-z0-9_':
$machine_name_requirements = $this
->t('lowercase letters, numbers, and underscores');
break;
case 'a-zA-Z0-9_':
$machine_name_requirements = $this
->t('letters, numbers, and underscores');
break;
case 'a-z0-9_-':
$machine_name_requirements = $this
->t('lowercase letters, numbers, and underscores');
break;
case 'a-zA-Z0-9_-':
$machine_name_requirements = $this
->t('letters, numbers, underscores, and dashes');
break;
}
$t_args = [
'@requirements' => $machine_name_requirements,
];
$form['properties']['element']['key'] = [
'#type' => 'machine_name',
'#title' => $this
->t('Key'),
'#description' => $this
->t('A unique element key. Can only contain @requirements.', $t_args),
'#machine_name' => [
'label' => '<br/>' . $this
->t('Key'),
'exists' => [
$this,
'exists',
],
'source' => [
'title',
],
'replace_pattern' => '[^' . $machine_name_pattern . ']+',
'error' => $this
->t('The element key name must contain only @requirements.', $t_args),
],
'#required' => TRUE,
'#parents' => [
'key',
],
'#disabled' => $key ? TRUE : FALSE,
'#default_value' => $key ?: $this
->getDefaultKey(),
'#weight' => -97,
];
if ($key) {
$form['properties']['element']['key']['#description'] = NULL;
}
if (isset($form['properties']['element']['title'])) {
$form['properties']['element']['key']['#machine_name']['source'] = [
'properties',
'element',
'title',
];
$form['properties']['element']['title']['#id'] = 'title';
}
if ($this
->isNew() && ($parent_prefix = $this
->getParentKeyPrefix($parent_key))) {
$form['properties']['element']['key']['#field_prefix'] = $parent_prefix . '_';
$form['properties']['element']['table_message'] = [
'#type' => 'webform_message',
'#message_message' => $this
->t("Element keys are automatically prefixed with parent row's key."),
'#message_type' => 'warning',
'#message_close' => TRUE,
'#message_storage' => WebformMessage::STORAGE_SESSION,
'#weight' => -98,
];
}
if (isset($form['properties']['flex']) && !$this
->isParentElementFlexbox($key, $parent_key)) {
$form['properties']['flex']['#access'] = FALSE;
}
$form['#attached']['library'][] = 'webform_ui/webform_ui';
$form['actions'] = [
'#type' => 'actions',
];
$form['actions']['submit'] = [
'#type' => 'submit',
'#value' => $this
->t('Save'),
'#button_type' => 'primary',
'#_validate_form' => TRUE,
];
if ($this->operation === 'create' && $this
->isAjax() && !$element_plugin instanceof WebformTable && !$element_plugin instanceof WebformTableRow) {
$form['actions']['save_add_element'] = [
'#type' => 'submit',
'#value' => $this
->t('Save + Add element'),
'#_validate_form' => TRUE,
];
}
$form['token_tree_link'] = $this->tokenManager
->buildTreeElement();
if ($form['token_tree_link']) {
$form['token_tree_link'] += [
'#weight' => 101,
];
}
$form = $this
->buildDefaultValueForm($form, $form_state);
return $this
->buildDialogForm($form, $form_state);
}
public function validateForm(array &$form, FormStateInterface $form_state) {
$button = $form_state
->getTriggeringElement();
if (empty($button['#_validate_form'])) {
return;
}
$subform_state = SubformState::createForSubform($form['properties'], $form, $form_state);
$element_plugin = $this
->getWebformElementPlugin();
$element_plugin
->validateConfigurationForm($form, $subform_state);
$element_errors = $subform_state
->getErrors();
foreach ($element_errors as $element_error) {
$form_state
->setErrorByName(NULL, $element_error);
}
if ($subform_state
->hasAnyErrors()) {
return;
}
$parent_key = $form_state
->getValue('parent_key');
$key = $form_state
->getValue('key');
if ($this
->isNew() && ($parent_prefix = $this
->getParentKeyPrefix($parent_key))) {
$key = $parent_prefix . '_' . $key;
$form_state
->setValue('key', $key);
}
$this->key = $key;
$webform = clone $this->webform;
$properties = $element_plugin
->getConfigurationFormProperties($form, $subform_state);
$webform
->setElementProperties($key, $properties, $parent_key);
if ($messages = $this->elementsValidator
->validate($webform)) {
$t_args = [
':href' => Url::fromRoute('entity.webform.source_form', [
'webform' => $webform
->id(),
])
->toString(),
];
$form_state
->setErrorByName('elements', $this
->t('There has been error validating the elements. You may need to edit the <a href=":href">YAML source</a> to resolve the issue.', $t_args));
foreach ($messages as $message) {
$this
->messenger()
->addError($message);
}
}
}
public function submitForm(array &$form, FormStateInterface $form_state) {
$op = $form_state
->getValue('op');
$parent_key = $form_state
->getValue('parent_key');
$key = $form_state
->getValue('key');
$element_plugin = $this
->getWebformElementPlugin();
$subform_state = SubformState::createForSubform($form['properties'], $form, $form_state);
$element_plugin
->submitConfigurationForm($form, $subform_state);
$properties = $element_plugin
->getConfigurationFormProperties($form, $subform_state);
$this->webform
->setElementProperties($key, $properties, $parent_key);
$this->webform
->save();
$properties = $form_state
->getValue('properties');
$t_args = [
'%title' => !empty($properties['title']) ? $properties['title'] : $key,
'@action' => $this->action,
];
$this
->messenger()
->addStatus($this
->t('%title has been @action.', $t_args));
$save_and_add_element = (string) $op === (string) $this
->t('Save + Add element') ? TRUE : FALSE;
$add_element = $element_plugin
->isContainer($this
->getElement()) ? $key : $parent_key;
$add_element = $add_element ? Html::getClass($add_element) : '_root_';
if ($this->requestStack
->getCurrentRequest()->query
->get('destination')) {
$redirect_destination = $this
->getRedirectDestination();
$destination = $redirect_destination
->get();
$destination .= (strpos($destination, '?') !== FALSE ? '&' : '?') . 'update=' . $key;
$destination .= $save_and_add_element ? '&add_element=' . $add_element : '';
$redirect_destination
->set($destination);
}
if ($this
->getWebformElementPlugin() instanceof WebformElementVariantInterface) {
$query = [
'reload' => 'true',
];
}
else {
$query = [
'update' => $key,
];
if ($save_and_add_element) {
$query['add_element'] = $add_element;
}
}
$form_state
->setRedirectUrl($this->webform
->toUrl('edit-form', [
'query' => $query,
]));
}
public function isNew() {
return $this instanceof WebformUiElementAddForm ? TRUE : FALSE;
}
public function getWebform() {
return $this->webform;
}
public function getElement() {
return $this->element;
}
public function getKey() {
return $this->key;
}
public function getParentKey() {
return $this->parentKey;
}
public function getWebformElementPlugin() {
return $this->elementManager
->getElementInstance($this->element, $this
->getWebform());
}
protected function isParentElementFlexbox($key = NULL, $parent_key = NULL) {
$elements = $this->webform
->getElementsInitializedAndFlattened();
if ($key && isset($elements[$key])) {
return $elements[$key]['#webform_parent_flexbox'];
}
if ($parent_key && isset($elements[$parent_key]) && isset($elements[$parent_key]['#type'])) {
return $elements[$parent_key]['#type'] === 'webform_flexbox' ? TRUE : FALSE;
}
return FALSE;
}
protected function isParentKeyPrefixEnabled($parent_key) {
while ($parent_key) {
$parent_element = $this
->getWebform()
->getElement($parent_key);
if ($parent_element['#type'] === 'webform_table') {
return !isset($parent_element['#prefix_children']) || $parent_element['#prefix_children'] === TRUE;
}
$parent_key = $parent_element['#webform_parent_key'];
}
return FALSE;
}
protected function getParentKeyPrefix($parent_key) {
if (!$this
->isParentKeyPrefixEnabled($parent_key)) {
return NULL;
}
while ($parent_key) {
$parent_element = $this
->getWebform()
->getElement($parent_key);
if (strpos($parent_key, '01') !== FALSE && $parent_element['#type'] === 'webform_table_row') {
return $parent_element['#webform_key'];
}
$parent_key = $parent_element['#webform_parent_key'];
}
return NULL;
}
public function exists($key) {
$elements = $this->webform
->getElementsInitializedAndFlattened();
return isset($elements[$key]) ? TRUE : FALSE;
}
public function getDefaultKey() {
$element_plugin = $this
->getWebformElementPlugin();
if (empty($element_plugin
->getDefaultKey())) {
return NULL;
}
$base_key = $element_plugin
->getDefaultKey();
$elements = $this
->getWebform()
->getElementsDecodedAndFlattened();
if (preg_match('/(^|_)(\\d+$)($|_)/', $base_key) && !isset($elements[$base_key])) {
return $base_key;
}
$increment = NULL;
foreach ($elements as $element_key => $element) {
if (strpos($element_key, $base_key) === 0) {
if (preg_match('/^' . $base_key . '_(\\d+)$/', $element_key, $match)) {
$element_increment = intval($match[1]);
if ($element_increment > $increment) {
$increment = $element_increment;
}
}
elseif ($increment === NULL) {
$increment = 0;
}
}
}
if ($increment === NULL) {
return $base_key;
}
else {
return $base_key . '_' . str_pad($increment + 1, 2, '0', STR_PAD_LEFT);
}
}
public function buildDefaultValueForm(array &$form, FormStateInterface $form_state) {
if (!isset($form['properties']['default']['default_value'])) {
return $form;
}
if ($element = $form_state
->get('default_value_element')) {
$element['#webform_key'] = $this
->getWebform()
->id();
$this->elementManager
->initializeElement($element);
$this->elementManager
->buildElement($element, $form, $form_state);
$form['default'] = [
'#type' => 'fieldset',
'#title' => $this
->t('Default value'),
];
$form['default']['default_value'] = $element;
$form['properties']['#type'] = 'container';
$form['properties']['#attributes']['style'] = 'display: none';
$form['#attributes']['novalidate'] = TRUE;
$form['actions']['submit'] = [
'#type' => 'submit',
'#value' => $this
->t('Update default value'),
'#attributes' => [
'data-hash' => 'webform-tab--advanced',
],
'#validate' => [
'::validateDefaultValue',
],
'#submit' => [
'::getDefaultValue',
],
'#button_type' => 'primary',
];
unset($form['actions']['save_add_element']);
if ($this
->isAjax()) {
$form['actions']['submit']['#ajax'] = [
'callback' => '::submitAjaxForm',
'event' => 'click',
];
}
}
else {
$form['properties']['default']['actions'] = [
'#type' => 'container',
];
$form['properties']['default']['actions']['set_default_value'] = [
'#type' => 'submit',
'#value' => $this
->t('Set default value'),
'#submit' => [
'::setDefaultValue',
],
'#attributes' => [
'formnovalidate' => 'formnovalidate',
],
'#_validate_form' => TRUE,
];
if ($this
->isAjax()) {
$form['properties']['default']['actions']['set_default_value']['#ajax'] = [
'callback' => '::submitAjaxForm',
'event' => 'click',
];
}
$form['#attached']['library'][] = 'webform/webform.form';
}
return $form;
}
public function getDefaultValue(array &$form, FormStateInterface $form_state) {
$default_value = $form_state
->getValue('default_value');
$form_state
->unsetValue('default_value');
$element_plugin = $this
->getWebformElementPlugin();
if (is_array($default_value)) {
if ($element_plugin
->isComposite()) {
$default_value = WebformYaml::encode($default_value);
}
else {
$default_value = implode(', ', $default_value);
}
}
$form_state
->setValueForElement($form['properties']['default']['default_value'], $default_value);
NestedArray::setValue($form_state
->getUserInput(), [
'properties',
'default_value',
], $default_value);
$form_state
->set('active_tab', 'advanced');
$form_state
->set('default_value_element', NULL);
$form_state
->setRebuild(TRUE);
}
public function setDefaultValue(array &$form, FormStateInterface $form_state) {
$element_plugin = $this
->getWebformElementPlugin();
$subform_state = SubformState::createForSubform($form['properties'], $form, $form_state);
$properties = $element_plugin
->getConfigurationFormProperties($form, $subform_state);
if (isset($properties['#default_value'])) {
if ($element_plugin
->hasMultipleValues($properties) && is_string($properties['#default_value'])) {
$properties['#default_value'] = preg_split('/\\s*,\\s*/', $properties['#default_value']);
}
}
$form_state
->set('default_value_element', $properties);
$form_state
->setRebuild(TRUE);
}
public function validateDefaultValue(array &$form, FormStateInterface $form_state) {
$form_state
->clearErrors();
}
}