You are here

Home » API reference » Image Optimize (or ImageAPI Optimize) 4.x » ImageAPIOptimizePipelineDeleteForm.php

class ImageAPIOptimizePipelineDeleteForm in Image Optimize (or ImageAPI Optimize) 4.x

Same name and namespace in other branches
  1. 8.3 src/Form/ImageAPIOptimizePipelineDeleteForm.php \Drupal\imageapi_optimize\Form\ImageAPIOptimizePipelineDeleteForm
  2. 8.2 src/Form/ImageAPIOptimizePipelineDeleteForm.php \Drupal\imageapi_optimize\Form\ImageAPIOptimizePipelineDeleteForm

Creates a form to delete an image optimize pipeline.

Hierarchy

Expanded class hierarchy of ImageAPIOptimizePipelineDeleteForm

File

src/Form/ImageAPIOptimizePipelineDeleteForm.php, line 11

Namespace

Drupal\imageapi_optimize\Form
View source 
class ImageAPIOptimizePipelineDeleteForm extends EntityDeleteForm {

  /**
   * Replacement options.
   *
   * @var array
   */
  protected $replacementOptions;

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->t('Optionally select a pipeline before deleting %pipeline', [
      '%pipeline' => $this->entity
        ->label(),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    if (count($this
      ->getReplacementOptions()) > 1) {
      return $this
        ->t('If this pipeline is in use on the site, you may select another pipeline to replace it. If no replacement pipeline is selected, the dependent configurations might need manual reconfiguration.');
    }
    return $this
      ->t('The dependent configurations might need manual reconfiguration.');
  }

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    $replacement_pipelines = $this
      ->getReplacementOptions();

    // If there are non-empty options in the list, allow the user to optionally
    // pick up a replacement.
    if (count($replacement_pipelines) > 1) {
      $form['replacement'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Replacement pipeline'),
        '#options' => $replacement_pipelines,
        '#empty_option' => $this
          ->t('- No replacement -'),
        '#weight' => -5,
      ];
    }
    return parent::form($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Save a selected replacement in the image optimize pipeline storage. It will be used
    // later, in the same request, when resolving dependencies.
    if ($replacement = $form_state
      ->getValue('replacement')) {

      /** @var \Drupal\imageapi_optimize\ImageAPIOptimizePipelineStorageInterface $storage */
      $storage = $this->entityTypeManager
        ->getStorage($this->entity
        ->getEntityTypeId());
      $storage
        ->setReplacementId($this->entity
        ->id(), $replacement);
    }
    parent::submitForm($form, $form_state);
  }

  /**
   * Returns a list of image optimize pipeline replacement options.
   *
   * @return array
   *   An option list suitable for the form select '#options'.
   */
  protected function getReplacementOptions() {
    if (!isset($this->replacementOptions)) {
      $this->replacementOptions = array_diff_key(imageapi_optimize_pipeline_options(), [
        $this
          ->getEntity()
          ->id() => '',
      ]);
    }
    return $this->replacementOptions;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigDependencyDeleteFormTrait::addDependencyListsToForm protected function Adds form elements to list affected configuration entities.
ConfigDependencyDeleteFormTrait::t abstract protected function Translates a string to the current language or to a given language.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
EntityConfirmFormBase::actions protected function Returns an array of supported actions for the current entity form. Overrides EntityForm::actions 1
EntityConfirmFormBase::delete public function The delete() method is not used in EntityConfirmFormBase. This overrides the default implementation that redirects to the delete-form confirmation form.
EntityConfirmFormBase::getBaseFormId public function Returns a string identifying the base form. Overrides EntityForm::getBaseFormId
EntityConfirmFormBase::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText
EntityConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
EntityConfirmFormBase::save public function The save() method is not used in EntityConfirmFormBase. This overrides the default implementation that saves the entity. Overrides EntityForm::save
EntityDeleteForm::buildForm public function Form constructor. Overrides EntityConfirmFormBase::buildForm 6
EntityDeleteForm::getConfigManager protected function Gets the configuration manager.
EntityDeleteForm::getConfigNamesToDelete protected function Returns config names to delete for the deletion confirmation form. 1
EntityDeleteFormTrait::getCancelUrl public function 3
EntityDeleteFormTrait::getConfirmText public function 1
EntityDeleteFormTrait::getDeletionMessage protected function Gets the message to display to the user after deleting the entity. 3
EntityDeleteFormTrait::getEntity abstract public function Gets the entity of this form.
EntityDeleteFormTrait::getRedirectUrl protected function Returns the URL where the user should be redirected after deletion. 5
EntityDeleteFormTrait::logDeletionMessage protected function Logs a message about the deleted entity. 2
EntityDeleteFormTrait::logger abstract protected function Gets the logger for a specific channel.
EntityForm::$entity protected property The entity being used by this form. 11
EntityForm::$entityTypeManager protected property The entity type manager. 3
EntityForm::$moduleHandler protected property The module handler service.
EntityForm::$operation protected property The name of the current operation.
EntityForm::actionsElement protected function Returns the action form element for the current entity form.
EntityForm::afterBuild public function Form element #after_build callback: Updates the entity with submitted data.
EntityForm::buildEntity public function Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity 3
EntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties. 9
EntityForm::getEntityFromRouteMatch public function Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface::getEntityFromRouteMatch 3
EntityForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 12
EntityForm::getOperation public function Gets the operation identifying the form. Overrides EntityFormInterface::getOperation
EntityForm::init protected function Initialize the form state and the entity before the first form build. 3
EntityForm::prepareEntity protected function Prepares the entity object before the form is built first. 3
EntityForm::prepareInvokeAll protected function Invokes the specified prepare hook variant.
EntityForm::processForm public function Process callback: assigns weights and hides extra fields.
EntityForm::setEntity public function Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityTypeManager public function Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler public function Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation public function Sets the operation for this form. Overrides EntityFormInterface::setOperation
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 105
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::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 72
ImageAPIOptimizePipelineDeleteForm::$replacementOptions protected property Replacement options.
ImageAPIOptimizePipelineDeleteForm::form public function Gets the actual form array to be built. Overrides EntityForm::form
ImageAPIOptimizePipelineDeleteForm::getDescription public function Returns additional text to display as a description. Overrides EntityConfirmFormBase::getDescription
ImageAPIOptimizePipelineDeleteForm::getQuestion public function Overrides EntityDeleteFormTrait::getQuestion
ImageAPIOptimizePipelineDeleteForm::getReplacementOptions protected function Returns a list of image optimize pipeline replacement options.
ImageAPIOptimizePipelineDeleteForm::submitForm public function Overrides EntityDeleteFormTrait::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. 27
MessengerTrait::messenger public function Gets the messenger. 27
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. 4
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