You are here

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

class YamlFormUiElementDeleteForm in YAML Form 8

Form for deleting a form element.

Hierarchy

Expanded class hierarchy of YamlFormUiElementDeleteForm

1 string reference to 'YamlFormUiElementDeleteForm'
yamlform_ui.routing.yml in modules/yamlform_ui/yamlform_ui.routing.yml
modules/yamlform_ui/yamlform_ui.routing.yml

File

modules/yamlform_ui/src/Form/YamlFormUiElementDeleteForm.php, line 17

Namespace

Drupal\yamlform_ui\Form
View source 
class YamlFormUiElementDeleteForm extends ConfirmFormBase {

  /**
   * The renderer.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * Form element validator.
   *
   * @var \Drupal\yamlform\YamlFormEntityElementsValidator
   */
  protected $elementsValidator;

  /**
   * The form containing the form handler to be deleted.
   *
   * @var \Drupal\yamlform\YamlFormInterface
   */
  protected $yamlform;

  /**
   * A form element.
   *
   * @var \Drupal\yamlform\YamlFormElementInterface
   */
  protected $yamlformElement;

  /**
   * The form element key.
   *
   * @var string
   */
  protected $key;

  /**
   * The form element.
   *
   * @var array
   */
  protected $element;

  /**
   * Constructs a new YamlFormUiElementDeleteForm.
   *
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer.
   * @param \Drupal\yamlform\YamlFormEntityElementsValidator $elements_validator
   *   Form element validator.
   */
  public function __construct(RendererInterface $renderer, YamlFormEntityElementsValidator $elements_validator) {
    $this->renderer = $renderer;
    $this->elementsValidator = $elements_validator;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('renderer'), $container
      ->get('yamlform.elements_validator'));
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    $t_args = [
      '%element' => $this
        ->getElementTitle(),
      '%yamlform' => $this->yamlform
        ->label(),
    ];
    $build = [];
    if ($this->yamlformElement
      ->isContainer($this->element)) {
      $build['warning'] = [
        '#markup' => $this
          ->t('This will immediately delete the %element container and all nested elements within %element from the %yamlform form. This cannot be undone.', $t_args),
      ];
    }
    else {
      $build['warning'] = [
        '#markup' => $this
          ->t('This will immediately delete the %element element from the %yamlform form. This cannot be undone.', $t_args),
      ];
    }
    if ($this->element['#yamlform_children']) {
      $build['elements'] = $this
        ->getDeletedElementsItemList($this->element['#yamlform_children']);
      $build['elements']['#title'] = t('The below nested elements will be also deleted.');
    }
    return $this->renderer
      ->render($build);
  }

  /**
   * 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->yamlform
        ->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['#yamlform_children']) {
        $items[$key]['items'] = $this
          ->getDeletedElementsItemList($element['#yamlform_children']);
      }
    }
    return [
      '#theme' => 'item_list',
      '#items' => $items,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->t('Are you sure you want to delete the %title element from the %yamlform form?', [
      '%yamlform' => $this->yamlform
        ->label(),
      '%title' => $this
        ->getElementTitle(),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getConfirmText() {
    return $this
      ->t('Delete');
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return $this->yamlform
      ->toUrl('edit-form');
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'yamlform_ui_element_delete_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, YamlFormInterface $yamlform = NULL, $key = NULL) {
    $this->yamlform = $yamlform;
    $this->key = $key;
    $this->element = $yamlform
      ->getElement($key);
    if ($this->element === NULL) {
      throw new NotFoundHttpException();
    }

    /** @var \Drupal\yamlform\YamlFormElementManagerInterface $element_manager */
    $element_manager = \Drupal::service('plugin.manager.yamlform.element');
    $plugin_id = $element_manager
      ->getElementPluginId($this->element);
    $this->yamlformElement = $element_manager
      ->createInstance($plugin_id, $this->element);
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $this->yamlform
      ->deleteElement($this->key);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->yamlform
      ->save();
    drupal_set_message($this
      ->t('The form element %title has been deleted.', [
      '%title' => $this
        ->getElementTitle(),
    ]));
    $form_state
      ->setRedirectUrl($this->yamlform
      ->toUrl('edit-form'));
  }

  /**
   * Get the form element's title or key.
   *
   * @return string
   *   The form element's title or key,
   */
  protected function getElementTitle() {
    return !empty($this->element['#title']) ? $this->element['#title'] : $this->key;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfirmFormBase::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText 1
ConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.
YamlFormUiElementDeleteForm::$element protected property The form element.
YamlFormUiElementDeleteForm::$elementsValidator protected property Form element validator.
YamlFormUiElementDeleteForm::$key protected property The form element key.
YamlFormUiElementDeleteForm::$renderer protected property The renderer.
YamlFormUiElementDeleteForm::$yamlform protected property The form containing the form handler to be deleted.
YamlFormUiElementDeleteForm::$yamlformElement protected property A form element.
YamlFormUiElementDeleteForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
YamlFormUiElementDeleteForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
YamlFormUiElementDeleteForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
YamlFormUiElementDeleteForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
YamlFormUiElementDeleteForm::getDeletedElementsItemList protected function Get deleted elements as item list.
YamlFormUiElementDeleteForm::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
YamlFormUiElementDeleteForm::getElementTitle protected function Get the form element's title or key.
YamlFormUiElementDeleteForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
YamlFormUiElementDeleteForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
YamlFormUiElementDeleteForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
YamlFormUiElementDeleteForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
YamlFormUiElementDeleteForm::__construct public function Constructs a new YamlFormUiElementDeleteForm.