class AjaxTestImageEffect

Same name in other branches
  1. 8.9.x core/modules/image/tests/modules/image_module_test/src/Plugin/ImageEffect/AjaxTestImageEffect.php \Drupal\image_module_test\Plugin\ImageEffect\AjaxTestImageEffect
  2. 10 core/modules/image/tests/modules/image_module_test/src/Plugin/ImageEffect/AjaxTestImageEffect.php \Drupal\image_module_test\Plugin\ImageEffect\AjaxTestImageEffect
  3. 11.x core/modules/image/tests/modules/image_module_test/src/Plugin/ImageEffect/AjaxTestImageEffect.php \Drupal\image_module_test\Plugin\ImageEffect\AjaxTestImageEffect

Provides a test effect using Ajax in the configuration form.

Plugin annotation


@ImageEffect(
  id = "image_module_test_ajax",
  label = @Translation("Ajax test")
)

Hierarchy

Expanded class hierarchy of AjaxTestImageEffect

File

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

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 Modifiers Object type Summary Overriden Title Overrides
AjaxTestImageEffect::ajaxCallback public function AJAX callback.
AjaxTestImageEffect::applyEffect public function Applies an image effect to the image object. Overrides ImageEffectInterface::applyEffect
AjaxTestImageEffect::buildConfigurationForm public function
AjaxTestImageEffect::defaultConfiguration public function Gets default configuration for this plugin. Overrides ImageEffectBase::defaultConfiguration
AjaxTestImageEffect::submitConfigurationForm public function Overrides ConfigurableImageEffectBase::submitConfigurationForm
ConfigurableImageEffectBase::validateConfigurationForm 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 Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ImageEffectBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ImageEffectBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ImageEffectBase::getDerivativeExtension public function Returns the extension of the derivative after applying this image effect. Overrides ImageEffectInterface::getDerivativeExtension 1
ImageEffectBase::getSummary public function Returns a render array summarizing the configuration of the image effect. Overrides ImageEffectInterface::getSummary 3
ImageEffectBase::getUuid public function Returns the unique ID representing the image effect. Overrides ImageEffectInterface::getUuid
ImageEffectBase::getWeight public function Returns the weight of the image effect. Overrides ImageEffectInterface::getWeight
ImageEffectBase::label public function Returns the image effect label. Overrides ImageEffectInterface::label
ImageEffectBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ImageEffectBase::setWeight public function Sets the weight for this image effect. Overrides ImageEffectInterface::setWeight
ImageEffectBase::transformDimensions public function Determines the dimensions of the styled image. Overrides ImageEffectInterface::transformDimensions 4
ImageEffectBase::__construct public function
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2

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