class PanelsDeleteBlockForm in Panels 8.4

Same name and namespace in other branches

8.3 src/Form/PanelsDeleteBlockForm.php \Drupal\panels\Form\PanelsDeleteBlockForm

Provides a form for deleting an access condition.

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\panels\Form\PanelsDeleteBlockForm uses CachedValuesGetterTrait

Expanded class hierarchy of PanelsDeleteBlockForm

1 string reference to 'PanelsDeleteBlockForm'

panels.routing.yml in ./panels.routing.yml: panels.routing.yml

File

src/Form/PanelsDeleteBlockForm.php, line 14

Namespace

Drupal\panels\Form

View source

class PanelsDeleteBlockForm extends ConfirmFormBase {
  use CachedValuesGetterTrait;

  /**
   * The tempstore factory.
   *
   * @var \Drupal\Core\TempStore\SharedTempStoreFactory $tempstore
   */
  protected $tempstore;

  /**
   * The tempstore id.
   *
   * @var string
   */
  protected $tempstore_id;

  /**
   * @var \Drupal\ctools\Plugin\BlockVariantInterface
   */
  protected $plugin;

  /**
   * The plugin being configured.
   *
   * @var \Drupal\Core\Block\BlockPluginInterface
   */
  protected $block;

  /**
   * PanelsDeleteBlockForm constructor.
   *
   * @param \Drupal\Core\TempStore\SharedTempStoreFactory $tempstore
   *   The tempstore factory.
   */
  public function __construct(SharedTempStoreFactory $tempstore) {
    $this->tempstore = $tempstore;
  }

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

  /**
   * Get the tempstore id.
   *
   * @return string
   */
  protected function getTempstoreId() {
    return $this->tempstore_id;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return $this
      ->getRequest()->attributes
      ->get('destination');
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $tempstore_id = NULL, $machine_name = NULL, $block_id = NULL) {
    $this->tempstore_id = $tempstore_id;
    $cached_values = $this
      ->getCachedValues($this->tempstore, $tempstore_id, $machine_name);
    $this->plugin = $cached_values['plugin'];
    $this->block = $this->plugin
      ->getBlock($block_id);
    $form['block_display'] = [
      '#type' => 'value',
      '#value' => $machine_name,
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->plugin
      ->removeBlock($this->block
      ->getConfiguration()['uuid']);
    $cached_values = $this
      ->getCachedValues($this->tempstore, $this
      ->getTempstoreId(), $form_state
      ->getValue('block_display'));
    $cached_values['plugin'] = $this->plugin;

    // PageManager specific handling.
    if (isset($cached_values['page_variant'])) {
      $cached_values['page_variant']
        ->getVariantPlugin()
        ->setConfiguration($cached_values['plugin']
        ->getConfiguration());
    }
    $this->tempstore
      ->get($this
      ->getTempstoreId())
      ->set($cached_values['id'], $cached_values);
    $this
      ->messenger()
      ->addMessage($this
      ->t('The block %label has been removed.', [
      '%label' => $this->block
        ->label(),
    ]));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CachedValuesGetterTrait::getCachedValues	protected	function	Gets cached values for non-wizard classes that interact with a wizard.
ConfirmFormBase::getCancelText	public	function	Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText	1
ConfirmFormBase::getDescription	public	function	Returns additional text to display as a description. Overrides ConfirmFormInterface::getDescription	11
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.
PanelsDeleteBlockForm::$block	protected	property	The plugin being configured.
PanelsDeleteBlockForm::$plugin	protected	property
PanelsDeleteBlockForm::$tempstore	protected	property	The tempstore factory.
PanelsDeleteBlockForm::$tempstore_id	protected	property	The tempstore id.
PanelsDeleteBlockForm::buildForm	public	function	Form constructor. Overrides ConfirmFormBase::buildForm
PanelsDeleteBlockForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
PanelsDeleteBlockForm::getCancelUrl	public	function	Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
PanelsDeleteBlockForm::getConfirmText	public	function	Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
PanelsDeleteBlockForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
PanelsDeleteBlockForm::getQuestion	public	function	Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
PanelsDeleteBlockForm::getTempstoreId	protected	function	Get the tempstore id.
PanelsDeleteBlockForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
PanelsDeleteBlockForm::__construct	public	function	PanelsDeleteBlockForm constructor.
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 PanelsDeleteBlockForm in Panels 8.4

Hierarchy

File

Namespace

Members

API Navigation