class MetatagViewsRevertForm in Metatag 8

Defines a form for reverting views metatags.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
  - class \Drupal\metatag_views\Form\MetatagViewsRevertForm

Expanded class hierarchy of MetatagViewsRevertForm

File

metatag_views/src/Form/MetatagViewsRevertForm.php, line 14

Namespace

Drupal\metatag_views\Form

View source

class MetatagViewsRevertForm extends ConfirmFormBase {

  /**
   * Entity manager for views entities.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $viewsManager;

  /**
   * The view entity to revert meta tags on.
   *
   * @var \Drupal\views\ViewEntityInterface
   */
  protected $view;

  /**
   * The view's display id.
   *
   * @var string
   */
  protected $displayId;

  /**
   * {@inheritdoc}
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager) {
    $this->viewsManager = $entity_type_manager
      ->getStorage('view');
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->t('Do you want to revert meta tags for @view_name : @display_name?', [
      '@view_name' => $this->view
        ->label(),
      '@display_name' => $this->view
        ->getDisplay($this->displayId)['display_title'],
    ]);
  }

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

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this
      ->t('You are about to revert the custom meta tags for the %display_name display on the %view_name view. This action cannot be undone.', [
      '%view_name' => $this->view
        ->label(),
      '%display_name' => $this->view
        ->getDisplay($this->displayId)['display_title'],
    ]);
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $view_id = NULL, $display_id = NUL) {
    $this->view = $this->viewsManager
      ->load($view_id);
    $this->displayId = $display_id;
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Removed meta tags from the view.
    $config_name = $this->view
      ->getConfigDependencyName();
    $config_path = 'display.' . $this->displayId . '.display_options.display_extenders.metatag_display_extender.metatags';
    $this
      ->configFactory()
      ->getEditable($config_name)
      ->clear($config_path)
      ->save();

    // Redirect back to the views list.
    $form_state
      ->setRedirect('metatag_views.metatags.list');
    $this
      ->messenger()
      ->addMessage($this
      ->t('Reverted meta tags for @view_name : @display_name', [
      '@view_name' => $this->view
        ->label(),
      '@display_name' => $this->view
        ->getDisplay($this->displayId)['display_title'],
    ]));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
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.
MetatagViewsRevertForm::$displayId	protected	property	The view's display id.
MetatagViewsRevertForm::$view	protected	property	The view entity to revert meta tags on.
MetatagViewsRevertForm::$viewsManager	protected	property	Entity manager for views entities.
MetatagViewsRevertForm::buildForm	public	function	Form constructor. Overrides ConfirmFormBase::buildForm
MetatagViewsRevertForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
MetatagViewsRevertForm::getCancelText	public	function	Returns a caption for the link which cancels the action. Overrides ConfirmFormBase::getCancelText
MetatagViewsRevertForm::getCancelUrl	public	function	Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
MetatagViewsRevertForm::getConfirmText	public	function	Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
MetatagViewsRevertForm::getDescription	public	function	Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
MetatagViewsRevertForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
MetatagViewsRevertForm::getQuestion	public	function	Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
MetatagViewsRevertForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
MetatagViewsRevertForm::__construct	public	function
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.

You are here

class MetatagViewsRevertForm in Metatag 8

Hierarchy

File

Namespace

Members

API Navigation