class WebformUiElementDeleteForm in Webform 6.x
Same name and namespace in other branches
- 8.5 modules/webform_ui/src/Form/WebformUiElementDeleteForm.php \Drupal\webform_ui\Form\WebformUiElementDeleteForm
Webform for deleting a webform element.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
- class \Drupal\webform\Form\WebformDeleteFormBase implements WebformDeleteFormInterface uses WebformDialogFormTrait
- class \Drupal\webform_ui\Form\WebformUiElementDeleteForm
- class \Drupal\webform\Form\WebformDeleteFormBase implements WebformDeleteFormInterface uses WebformDialogFormTrait
- class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
Expanded class hierarchy of WebformUiElementDeleteForm
1 string reference to 'WebformUiElementDeleteForm'
- webform_ui.routing.yml in modules/
webform_ui/ webform_ui.routing.yml - modules/webform_ui/webform_ui.routing.yml
File
- modules/
webform_ui/ src/ Form/ WebformUiElementDeleteForm.php, line 17
Namespace
Drupal\webform_ui\FormView source
class WebformUiElementDeleteForm extends WebformDeleteFormBase {
/**
* The renderer.
*
* @var \Drupal\Core\Render\RendererInterface
*/
protected $renderer;
/**
* The webform element manager.
*
* @var \Drupal\webform\Plugin\WebformElementManagerInterface
*/
protected $elementManager;
/**
* The webform element validator.
*
* @var \Drupal\webform\WebformEntityElementsValidatorInterface
*/
protected $elementsValidator;
/**
* The webform containing the webform handler to be deleted.
*
* @var \Drupal\webform\WebformInterface
*/
protected $webform;
/**
* A webform element.
*
* @var \Drupal\webform\Plugin\WebformElementInterface
*/
protected $webformElement;
/**
* The webform element key.
*
* @var string
*/
protected $key;
/**
* The webform element.
*
* @var array
*/
protected $element;
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
$instance = parent::create($container);
$instance->renderer = $container
->get('renderer');
$instance->elementManager = $container
->get('plugin.manager.webform.element');
$instance->elementsValidator = $container
->get('webform.elements_validator');
return $instance;
}
/****************************************************************************/
// Delete form.
/****************************************************************************/
/**
* {@inheritdoc}
*/
public function getQuestion() {
if ($this
->isDialog()) {
$t_args = [
'@title' => $this
->getElementTitle(),
];
return $this
->t("Delete the '@title' element?", $t_args);
}
else {
$t_args = [
'%webform' => $this->webform
->label(),
'%title' => $this
->getElementTitle(),
];
return $this
->t('Delete the %title element from the %webform webform?', $t_args);
}
}
/**
* {@inheritdoc}
*/
public function getWarning() {
$t_args = [
'%title' => $this
->getElementTitle(),
];
return [
'#type' => 'webform_message',
'#message_type' => 'warning',
'#message_message' => $this
->t('Are you sure you want to delete the %title element?', $t_args) . '<br/>' . '<strong>' . $this
->t('This action cannot be undone.') . '</strong>',
];
}
/**
* {@inheritdoc}
*/
public function getDescription() {
$element_plugin = $this
->getWebformElementPlugin();
$items = [];
$items[] = $this
->t('Remove this element');
$items[] = $this
->t('Delete any submission data associated with this element');
if ($element_plugin
->isContainer($this->element)) {
$items[] = $this
->t('Delete all child elements');
}
if ($element_plugin instanceof WebformElementVariantInterface) {
$items[] = $this
->t('Delete all related variants');
}
return [
'title' => [
'#markup' => $this
->t('This action will…'),
],
'list' => [
'#theme' => 'item_list',
'#items' => $items,
],
];
}
/**
* {@inheritdoc}
*/
public function getDetails() {
$elements = $this
->getDeletedElementsItemList($this->element['#webform_children']);
if ($elements) {
return [
'#type' => 'details',
'#title' => $this
->t('Nested elements being deleted'),
'elements' => $elements,
];
}
else {
return [];
}
}
/****************************************************************************/
// Form methods.
/****************************************************************************/
/**
* {@inheritdoc}
*/
public function getCancelUrl() {
return $this->webform
->toUrl('edit-form');
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'webform_ui_element_delete_form';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state, WebformInterface $webform = NULL, $key = NULL) {
$this->webform = $webform;
$this->key = $key;
$this->element = $webform
->getElement($key);
if ($this->element === NULL) {
throw new NotFoundHttpException();
}
$form = parent::buildForm($form, $form_state);
$form = $this
->buildDialogConfirmForm($form, $form_state);
return $form;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$this->webform
->deleteElement($this->key);
$this->webform
->save();
$this
->messenger()
->addStatus($this
->t('The webform element %title has been deleted.', [
'%title' => $this
->getElementTitle(),
]));
$query = [];
// Variants require the entire page to be reloaded so that Variants tab
// can be hidden.
if ($this
->getWebformElementPlugin() instanceof WebformElementVariantInterface) {
$query = [
'reload' => 'true',
];
}
$form_state
->setRedirectUrl($this->webform
->toUrl('edit-form', [
'query' => $query,
]));
}
/****************************************************************************/
// Helper methods.
/****************************************************************************/
/**
* Get deleted elements as item list.
*
* @param array $children
* An array child key.
*
* @return array
* A render array representing an item list of elements.
*/
protected function getDeletedElementsItemList(array $children) {
if (empty($children)) {
return [];
}
$items = [];
foreach ($children as $key) {
$element = $this->webform
->getElement($key);
if (isset($element['#title'])) {
$title = new FormattableMarkup('@title (@key)', [
'@title' => $element['#title'],
'@key' => $key,
]);
}
else {
$title = $key;
}
$items[$key]['title'] = [
'#markup' => $title,
];
if ($element['#webform_children']) {
$items[$key]['items'] = $this
->getDeletedElementsItemList($element['#webform_children']);
}
}
return [
'#theme' => 'item_list',
'#items' => $items,
];
}
/**
* Get the webform element's title or key.
*
* @return string
* The webform element's title or key,
*/
protected function getElementTitle() {
return WebformElementHelper::getAdminTitle($this->element);
}
/**
* Return the webform element plugin associated with this form.
*
* @return \Drupal\webform\Plugin\WebformElementInterface
* A webform element.
*/
protected function getWebformElementPlugin() {
return $this->elementManager
->getElementInstance($this->element);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfirmFormBase:: |
public | function |
Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface:: |
2 |
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 3 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 3 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function | Returns a redirect response object for the specified route. | |
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
72 |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
WebformAjaxFormTrait:: |
protected | function | Queue announcement with Ajax response. | |
WebformAjaxFormTrait:: |
protected | function | Add Ajax support to a form. | |
WebformAjaxFormTrait:: |
protected | function | Create an AjaxResponse or WebformAjaxResponse object. | |
WebformAjaxFormTrait:: |
protected | function | Get announcements. | |
WebformAjaxFormTrait:: |
protected | function | Get default ajax callback settings. | 1 |
WebformAjaxFormTrait:: |
protected | function | Get redirect URL from the form's state. | |
WebformAjaxFormTrait:: |
protected | function | Get the form's Ajax wrapper id. | 1 |
WebformAjaxFormTrait:: |
protected | function | Determine if Ajax callback is callable. | |
WebformAjaxFormTrait:: |
protected | function | Is the current request for an Ajax modal/dialog. | |
WebformAjaxFormTrait:: |
protected | function | Is the current request for an off canvas dialog. | |
WebformAjaxFormTrait:: |
protected | function | Handle missing Ajax callback. | |
WebformAjaxFormTrait:: |
protected | function | Replace form via an Ajax response. | 1 |
WebformAjaxFormTrait:: |
protected | function | Reset announcements. | |
WebformAjaxFormTrait:: |
protected | function | Set announcements. | |
WebformAjaxFormTrait:: |
public | function | Submit form #ajax callback. | 1 |
WebformAjaxFormTrait:: |
public | function | Validate form #ajax callback. | 1 |
WebformDeleteFormBase:: |
public | function |
Returns confirm input to display. Overrides WebformDeleteFormInterface:: |
3 |
WebformDeleteFormBase:: |
public | function |
Returns a caption for the button that confirms the action. Overrides ConfirmFormBase:: |
2 |
WebformDeleteFormBase:: |
public | function |
Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormBase:: |
|
WebformDialogFormTrait:: |
protected | function | Add modal dialog support to a confirm form. | |
WebformDialogFormTrait:: |
protected | function | Build webform dialog delete link. | |
WebformDialogFormTrait:: |
protected | function | Add modal dialog support to a form. | |
WebformDialogFormTrait:: |
public | function |
Cancel form #ajax callback. Overrides WebformAjaxFormTrait:: |
1 |
WebformDialogFormTrait:: |
public | function | Close dialog. | |
WebformDialogFormTrait:: |
protected | function |
Returns if webform is using Ajax. Overrides WebformAjaxFormTrait:: |
1 |
WebformDialogFormTrait:: |
public | function |
Empty submit callback used to only have the submit button to use an #ajax submit callback. Overrides WebformAjaxFormTrait:: |
|
WebformDialogFormTrait:: |
public | function | Validate callback to clear validation errors. | 2 |
WebformUiElementDeleteForm:: |
protected | property | The webform element. | |
WebformUiElementDeleteForm:: |
protected | property | The webform element manager. | |
WebformUiElementDeleteForm:: |
protected | property | The webform element validator. | |
WebformUiElementDeleteForm:: |
protected | property | The webform element key. | |
WebformUiElementDeleteForm:: |
protected | property | The renderer. | |
WebformUiElementDeleteForm:: |
protected | property | The webform containing the webform handler to be deleted. | |
WebformUiElementDeleteForm:: |
protected | property | A webform element. | |
WebformUiElementDeleteForm:: |
public | function |
Form constructor. Overrides WebformDeleteFormBase:: |
|
WebformUiElementDeleteForm:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
WebformUiElementDeleteForm:: |
public | function |
Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface:: |
|
WebformUiElementDeleteForm:: |
protected | function | Get deleted elements as item list. | |
WebformUiElementDeleteForm:: |
public | function |
Returns additional text to display as a description. Overrides WebformDeleteFormBase:: |
|
WebformUiElementDeleteForm:: |
public | function |
Returns details to display. Overrides WebformDeleteFormBase:: |
|
WebformUiElementDeleteForm:: |
protected | function | Get the webform element's title or key. | |
WebformUiElementDeleteForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
WebformUiElementDeleteForm:: |
public | function |
Returns the question to ask the user. Overrides ConfirmFormInterface:: |
|
WebformUiElementDeleteForm:: |
public | function |
Returns warning message to display. Overrides WebformDeleteFormBase:: |
|
WebformUiElementDeleteForm:: |
protected | function | Return the webform element plugin associated with this form. | |
WebformUiElementDeleteForm:: |
public | function |
Form submission handler. Overrides FormInterface:: |