class ImageEffectDeleteForm

Same name in other branches
  1. 9 core/modules/image/src/Form/ImageEffectDeleteForm.php \Drupal\image\Form\ImageEffectDeleteForm
  2. 8.9.x core/modules/image/src/Form/ImageEffectDeleteForm.php \Drupal\image\Form\ImageEffectDeleteForm
  3. 10 core/modules/image/src/Form/ImageEffectDeleteForm.php \Drupal\image\Form\ImageEffectDeleteForm

Form for deleting an image effect.

@internal

Hierarchy

Expanded class hierarchy of ImageEffectDeleteForm

1 string reference to 'ImageEffectDeleteForm'
image.routing.yml in core/modules/image/image.routing.yml
core/modules/image/image.routing.yml

File

core/modules/image/src/Form/ImageEffectDeleteForm.php, line 14

Namespace

Drupal\image\Form
View source
class ImageEffectDeleteForm extends ConfirmFormBase {
    
    /**
     * The image style containing the image effect to be deleted.
     *
     * @var \Drupal\image\ImageStyleInterface
     */
    protected $imageStyle;
    
    /**
     * The image effect to be deleted.
     *
     * @var \Drupal\image\ImageEffectInterface
     */
    protected $imageEffect;
    
    /**
     * {@inheritdoc}
     */
    public function getQuestion() {
        return $this->t('Are you sure you want to delete the @effect effect from the %style style?', [
            '%style' => $this->imageStyle
                ->label(),
            '@effect' => $this->imageEffect
                ->label(),
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getConfirmText() {
        return $this->t('Delete');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCancelUrl() {
        return $this->imageStyle
            ->toUrl('edit-form');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'image_effect_delete_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state, ?ImageStyleInterface $image_style = NULL, $image_effect = NULL) {
        $this->imageStyle = $image_style;
        $this->imageEffect = $this->imageStyle
            ->getEffect($image_effect);
        return parent::buildForm($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $this->imageStyle
            ->deleteImageEffect($this->imageEffect);
        $this->messenger()
            ->addStatus($this->t('The image effect %name has been deleted.', [
            '%name' => $this->imageEffect
                ->label(),
        ]));
        $form_state->setRedirectUrl($this->imageStyle
            ->toUrl('edit-form'));
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title 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 17
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 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 2
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. 2
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 109
FormBase::currentUser protected function Gets the current user. 2
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 58
ImageEffectDeleteForm::$imageEffect protected property The image effect to be deleted.
ImageEffectDeleteForm::$imageStyle protected property The image style containing the image effect to be deleted.
ImageEffectDeleteForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
ImageEffectDeleteForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
ImageEffectDeleteForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
ImageEffectDeleteForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ImageEffectDeleteForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
ImageEffectDeleteForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
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. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
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. 3
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.

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