class AjaxTestImageEffect

Provides a test effect using Ajax in the configuration form.

Attributes

#[ImageEffect(id: "image_module_test_ajax", label: new TranslatableMarkup("Ajax test"))]

Hierarchy

  • class \Drupal\image_module_test\Plugin\ImageEffect\AjaxTestImageEffect extends \Drupal\image\ConfigurableImageEffectBase

Expanded class hierarchy of AjaxTestImageEffect

File

core/modules/image/tests/modules/image_module_test/src/Plugin/ImageEffect/AjaxTestImageEffect.php, line 18

Namespace

Drupal\image_module_test\Plugin\ImageEffect
View source
class AjaxTestImageEffect extends ConfigurableImageEffectBase {
  
  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'test_parameter' => 0,
    ];
  }
  
  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['test_parameter'] = [
      '#type' => 'number',
      '#title' => $this->t('Test parameter'),
      '#default_value' => $this->configuration['test_parameter'],
      '#min' => 0,
    ];
    $form['ajax_refresh'] = [
      '#type' => 'button',
      '#value' => $this->t('Ajax refresh'),
      '#ajax' => [
        'callback' => [
          $this,
          'ajaxCallback',
        ],
      ],
    ];
    $form['ajax_value'] = [
      '#id' => 'ajax-value',
      '#type' => 'item',
      '#title' => $this->t('Ajax value'),
      '#markup' => 'bar',
    ];
    return $form;
  }
  
  /**
   * AJAX callback.
   */
  public function ajaxCallback($form, FormStateInterface $form_state) {
    $item = [
      '#type' => 'item',
      '#title' => $this->t('Ajax value'),
      '#markup' => microtime(),
    ];
    $response = new AjaxResponse();
    $response->addCommand(new HtmlCommand('#ajax-value', $item));
    return $response;
  }
  
  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this->configuration['test_parameter'] = $form_state->getValue('test_parameter');
  }
  
  /**
   * {@inheritdoc}
   */
  public function applyEffect(ImageInterface $image) {
    return TRUE;
  }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AjaxTestImageEffect::ajaxCallback public function AJAX callback.
AjaxTestImageEffect::applyEffect public function Overrides ImageEffectInterface::applyEffect
AjaxTestImageEffect::buildConfigurationForm public function Overrides PluginFormInterface::buildConfigurationForm
AjaxTestImageEffect::defaultConfiguration public function Overrides ConfigurableTrait::defaultConfiguration
AjaxTestImageEffect::submitConfigurationForm public function Overrides ConfigurableImageEffectBase::submitConfigurationForm
ConfigurableImageEffectBase::validateConfigurationForm public function Overrides PluginFormInterface::validateConfigurationForm 2
ConfigurableTrait::$configuration protected property Configuration information passed into the plugin.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
ImageEffectBase::$logger protected property A logger instance.
ImageEffectBase::$uuid protected property The image effect ID.
ImageEffectBase::$weight protected property The weight of the image effect.
ImageEffectBase::calculateDependencies public function Overrides DependentPluginInterface::calculateDependencies
ImageEffectBase::create public static function Overrides ContainerFactoryPluginInterface::create 1
ImageEffectBase::getConfiguration public function Overrides ConfigurableTrait::getConfiguration
ImageEffectBase::getDerivativeExtension public function Overrides ImageEffectInterface::getDerivativeExtension 1
ImageEffectBase::getSummary public function Overrides ImageEffectInterface::getSummary 3
ImageEffectBase::getUuid public function Overrides ImageEffectInterface::getUuid
ImageEffectBase::getWeight public function Overrides ImageEffectInterface::getWeight
ImageEffectBase::label public function Overrides ImageEffectInterface::label
ImageEffectBase::setConfiguration public function Overrides ConfigurableTrait::setConfiguration
ImageEffectBase::setWeight public function Overrides ImageEffectInterface::setWeight
ImageEffectBase::transformDimensions public function Overrides ImageEffectInterface::transformDimensions 4
ImageEffectBase::__construct public function Overrides ConfigurablePluginBase::__construct
MessengerTrait::$messenger protected property The messenger. 25
MessengerTrait::messenger public function Gets the messenger. 25
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin ID.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Gets the plugin ID of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable Deprecated public function Determines if the plugin is configurable.
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. 1

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