You are here

Home » API reference » XML sitemap 2.x » XmlSitemapCustomDeleteForm.php

class XmlSitemapCustomDeleteForm in XML sitemap 2.x

Same name and namespace in other branches
  1. 8 xmlsitemap_custom/src/Form/XmlSitemapCustomDeleteForm.php \Drupal\xmlsitemap_custom\Form\XmlSitemapCustomDeleteForm

Provides a form for deleting a custom link.

Hierarchy

Expanded class hierarchy of XmlSitemapCustomDeleteForm

1 string reference to 'XmlSitemapCustomDeleteForm'
xmlsitemap_custom.routing.yml in xmlsitemap_custom/xmlsitemap_custom.routing.yml
xmlsitemap_custom/xmlsitemap_custom.routing.yml

File

xmlsitemap_custom/src/Form/XmlSitemapCustomDeleteForm.php, line 15

Namespace

Drupal\xmlsitemap_custom\Form
View source 
class XmlSitemapCustomDeleteForm extends ConfirmFormBase {

  /**
   * The xmlsitemap link storage handler.
   *
   * @var \Drupal\xmlsitemap\XmlSitemapLinkStorageInterface
   */
  protected $linkStorage;

  /**
   * The path of the custom link.
   *
   * @var string
   *
   * @codingStandardsIgnoreStart
   */
  protected $custom_link;

  /**
   * Constructs a new XmlSitemapCustomEditForm object.
   *
   * @param \Drupal\xmlsitemap\XmlSitemapLinkStorageInterface $link_storage
   *   The xmlsitemap link storage service.
   *
   * @codingStandardsIgnoreEnd
   */
  public function __construct(XmlSitemapLinkStorageInterface $link_storage) {
    $this->linkStorage = $link_storage;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('xmlsitemap.link_storage'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $link = '') {
    if (!($custom_link = $this->linkStorage
      ->load('custom', $link))) {
      throw new NotFoundHttpException();
    }
    else {
      $this->custom_link = $custom_link;
    }
    return parent::buildForm($form, $form_state);
  }

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

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return new Url('xmlsitemap_custom.list');
  }

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->t('Are you sure you want to delete %link?', [
      '%link' => $this->custom_link['loc'],
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->linkStorage
      ->delete('custom', $this->custom_link['id']);
    $this
      ->logger('xmlsitemap')
      ->debug('The custom link for %loc has been deleted.', [
      '%loc' => $this->custom_link['loc'],
    ]);
    $this
      ->messenger()
      ->addStatus($this
      ->t('The custom link for %loc has been deleted.', [
      '%loc' => $this->custom_link['loc'],
    ]));
    $form_state
      ->setRedirectUrl($this
      ->getCancelUrl());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfirmFormBase::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText 2
ConfirmFormBase::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormInterface::getDescription 14
ConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 3
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. 3
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.
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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 72
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. 27
MessengerTrait::messenger public function Gets the messenger. 27
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. 4
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.
XmlSitemapCustomDeleteForm::$custom_link protected property The path of the custom link.
XmlSitemapCustomDeleteForm::$linkStorage protected property The xmlsitemap link storage handler.
XmlSitemapCustomDeleteForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
XmlSitemapCustomDeleteForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
XmlSitemapCustomDeleteForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
XmlSitemapCustomDeleteForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
XmlSitemapCustomDeleteForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
XmlSitemapCustomDeleteForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
XmlSitemapCustomDeleteForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
XmlSitemapCustomDeleteForm::__construct public function Constructs a new XmlSitemapCustomEditForm object.