BlockDeleteForm.php

Same filename in other branches
  1. 9 core/modules/block/src/Form/BlockDeleteForm.php
  2. 8.9.x core/modules/block/src/Form/BlockDeleteForm.php
  3. 11.x core/modules/block/src/Form/BlockDeleteForm.php

Namespace

Drupal\block\Form

File

core/modules/block/src/Form/BlockDeleteForm.php

View source
<?php

namespace Drupal\block\Form;

use Drupal\Core\Entity\EntityDeleteForm;
use Drupal\Core\Url;

/**
 * Provides a deletion confirmation form for the block instance deletion form.
 *
 * @internal
 */
class BlockDeleteForm extends EntityDeleteForm {
    
    /**
     * {@inheritdoc}
     */
    public function getCancelUrl() {
        return new Url('block.admin_display');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getConfirmText() {
        return $this->t('Remove');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getQuestion() {
        $entity = $this->getEntity();
        $regions = $this->systemRegionList($entity->getTheme(), REGIONS_VISIBLE);
        return $this->t('Are you sure you want to remove the @entity-type %label from the %region region?', [
            '@entity-type' => $entity->getEntityType()
                ->getSingularLabel(),
            '%label' => $entity->label(),
            '%region' => $regions[$entity->getRegion()],
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDescription() {
        return $this->t('This will remove the block placement. You will need to <a href=":url">place it again</a> in order to undo this action.', [
            ':url' => Url::fromRoute('block.admin_display_theme', [
                'theme' => $this->getEntity()
                    ->getTheme(),
            ])
                ->toString(),
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getDeletionMessage() {
        $entity = $this->getEntity();
        $regions = $this->systemRegionList($entity->getTheme(), REGIONS_VISIBLE);
        return $this->t('The @entity-type %label has been removed from the %region region.', [
            '@entity-type' => $entity->getEntityType()
                ->getSingularLabel(),
            '%label' => $entity->label(),
            '%region' => $regions[$entity->getRegion()],
        ]);
    }
    
    /**
     * Wraps system_region_list().
     */
    protected function systemRegionList($theme, $show = REGIONS_ALL) {
        return system_region_list($theme, $show);
    }

}

Classes

Title Deprecated Summary
BlockDeleteForm Provides a deletion confirmation form for the block instance deletion form.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.