class ImageEffectFormBase

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

Provides a base form for image effects.

Hierarchy

Expanded class hierarchy of ImageEffectFormBase

File

core/modules/image/src/Form/ImageEffectFormBase.php, line 16

Namespace

Drupal\image\Form
View source
abstract class ImageEffectFormBase extends FormBase {
    
    /**
     * The image style.
     *
     * @var \Drupal\image\ImageStyleInterface
     */
    protected $imageStyle;
    
    /**
     * The image effect.
     *
     * @var \Drupal\image\ImageEffectInterface|\Drupal\image\ConfigurableImageEffectInterface
     */
    protected $imageEffect;
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'image_effect_form';
    }
    
    /**
     * {@inheritdoc}
     *
     * @param array $form
     *   A nested array form elements comprising the form.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   The current state of the form.
     * @param \Drupal\image\ImageStyleInterface $image_style
     *   The image style.
     * @param string $image_effect
     *   The image effect ID.
     *
     * @return array
     *   The form structure.
     *
     * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
     */
    public function buildForm(array $form, FormStateInterface $form_state, ?ImageStyleInterface $image_style = NULL, $image_effect = NULL) {
        $this->imageStyle = $image_style;
        try {
            $this->imageEffect = $this->prepareImageEffect($image_effect);
        } catch (PluginNotFoundException $e) {
            throw new NotFoundHttpException("Invalid effect id: '{$image_effect}'.");
        }
        $request = $this->getRequest();
        if (!$this->imageEffect instanceof ConfigurableImageEffectInterface) {
            throw new NotFoundHttpException();
        }
        $form['#attached']['library'][] = 'image/admin';
        $form['uuid'] = [
            '#type' => 'value',
            '#value' => $this->imageEffect
                ->getUuid(),
        ];
        $form['id'] = [
            '#type' => 'value',
            '#value' => $this->imageEffect
                ->getPluginId(),
        ];
        $form['data'] = [];
        $subform_state = SubformState::createForSubform($form['data'], $form, $form_state);
        $form['data'] = $this->imageEffect
            ->buildConfigurationForm($form['data'], $subform_state);
        $form['data']['#tree'] = TRUE;
        // Check the URL for a weight, then the image effect, otherwise use default.
        $form['weight'] = [
            '#type' => 'hidden',
            '#value' => $request->query
                ->has('weight') ? (int) $request->query
                ->get('weight') : $this->imageEffect
                ->getWeight(),
        ];
        $form['actions'] = [
            '#type' => 'actions',
        ];
        $form['actions']['submit'] = [
            '#type' => 'submit',
            '#button_type' => 'primary',
        ];
        $form['actions']['cancel'] = [
            '#type' => 'link',
            '#title' => $this->t('Cancel'),
            '#url' => $this->imageStyle
                ->toUrl('edit-form'),
            '#attributes' => [
                'class' => [
                    'button',
                ],
            ],
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function validateForm(array &$form, FormStateInterface $form_state) {
        // The image effect configuration is stored in the 'data' key in the form,
        // pass that through for validation.
        $this->imageEffect
            ->validateConfigurationForm($form['data'], SubformState::createForSubform($form['data'], $form, $form_state));
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $form_state->cleanValues();
        // The image effect configuration is stored in the 'data' key in the form,
        // pass that through for submission.
        $this->imageEffect
            ->submitConfigurationForm($form['data'], SubformState::createForSubform($form['data'], $form, $form_state));
        $this->imageEffect
            ->setWeight($form_state->getValue('weight'));
        if ($uuid = $this->imageEffect
            ->getUuid()) {
            $this->imageStyle
                ->getEffect($uuid)
                ->setConfiguration($this->imageEffect
                ->getConfiguration());
        }
        else {
            $this->imageStyle
                ->addImageEffect($this->imageEffect
                ->getConfiguration());
        }
        $this->imageStyle
            ->save();
        $this->messenger()
            ->addStatus($this->t('The image effect was successfully applied.'));
        $form_state->setRedirectUrl($this->imageStyle
            ->toUrl('edit-form'));
    }
    
    /**
     * Converts an image effect ID into an object.
     *
     * @param string $image_effect
     *   The image effect ID.
     *
     * @return \Drupal\image\ImageEffectInterface
     *   The image effect object.
     */
    protected abstract function prepareImageEffect($image_effect);

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
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. 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::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 111
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.
ImageEffectFormBase::$imageEffect protected property The image effect.
ImageEffectFormBase::$imageStyle protected property The image style.
ImageEffectFormBase::buildForm public function Overrides FormInterface::buildForm 2
ImageEffectFormBase::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ImageEffectFormBase::prepareImageEffect abstract protected function Converts an image effect ID into an object. 2
ImageEffectFormBase::submitForm public function Form submission handler. Overrides FormInterface::submitForm
ImageEffectFormBase::validateForm public function Form validation handler. Overrides FormBase::validateForm
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.