Same name and namespace in other branches
  1. 8.9.x core/modules/image/src/Form/ImageEffectAddForm.php \Drupal\image\Form\ImageEffectAddForm
  2. 9 core/modules/image/src/Form/ImageEffectAddForm.php \Drupal\image\Form\ImageEffectAddForm

Provides an add form for image effects.

@internal

Hierarchy

Expanded class hierarchy of ImageEffectAddForm

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

File

core/modules/image/src/Form/ImageEffectAddForm.php, line 15

Namespace

Drupal\image\Form
View source 
class ImageEffectAddForm extends ImageEffectFormBase {

  /**
   * The image effect manager.
   *
   * @var \Drupal\image\ImageEffectManager
   */
  protected $effectManager;

  /**
   * Constructs a new ImageEffectAddForm.
   *
   * @param \Drupal\image\ImageEffectManager $effect_manager
   *   The image effect manager.
   */
  public function __construct(ImageEffectManager $effect_manager) {
    $this->effectManager = $effect_manager;
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, ImageStyleInterface $image_style = NULL, $image_effect = NULL) {
    $form = parent::buildForm($form, $form_state, $image_style, $image_effect);
    $form['#title'] = $this
      ->t('Add %label effect to style %style', [
      '%label' => $this->imageEffect
        ->label(),
      '%style' => $image_style
        ->label(),
    ]);
    $form['actions']['submit']['#value'] = $this
      ->t('Add effect');
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  protected function prepareImageEffect($image_effect) {
    $image_effect = $this->effectManager
      ->createInstance($image_effect);

    // Set the initial weight so this effect comes last.
    $image_effect
      ->setWeight(count($this->imageStyle
      ->getEffects()));
    return $image_effect;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
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::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.
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.
ImageEffectAddForm::$effectManager protected property The image effect manager.
ImageEffectAddForm::buildForm public function Form constructor. Overrides ImageEffectFormBase::buildForm
ImageEffectAddForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
ImageEffectAddForm::prepareImageEffect protected function Converts an image effect ID into an object. Overrides ImageEffectFormBase::prepareImageEffect
ImageEffectAddForm::__construct public function Constructs a new ImageEffectAddForm.
ImageEffectFormBase::$imageEffect protected property The image effect.
ImageEffectFormBase::$imageStyle protected property The image style.
ImageEffectFormBase::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
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. 8
MessengerTrait::messenger public function Gets the messenger. 8
MessengerTrait::setMessenger public function Sets the messenger.
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. 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. 1
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.