class AjaxTestImageEffect
Same name and namespace in other branches
- 9 core/modules/image/tests/modules/image_module_test/src/Plugin/ImageEffect/AjaxTestImageEffect.php \Drupal\image_module_test\Plugin\ImageEffect\AjaxTestImageEffect
- 10 core/modules/image/tests/modules/image_module_test/src/Plugin/ImageEffect/AjaxTestImageEffect.php \Drupal\image_module_test\Plugin\ImageEffect\AjaxTestImageEffect
- 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
- class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\image\ImageEffectBase extends \Drupal\image\ImageEffectInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\image\ConfigurableImageEffectBase extends \Drupal\image\ConfigurableImageEffectInterface implements \Drupal\image\ImageEffectBase
- class \Drupal\image_module_test\Plugin\ImageEffect\AjaxTestImageEffect implements \Drupal\image\ConfigurableImageEffectBase
- class \Drupal\image\ConfigurableImageEffectBase extends \Drupal\image\ConfigurableImageEffectInterface implements \Drupal\image\ImageEffectBase
- class \Drupal\image\ImageEffectBase extends \Drupal\image\ImageEffectInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
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\ImageEffectView 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' => 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 | 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 | Form constructor. | Overrides PluginFormInterface::buildConfigurationForm | |
AjaxTestImageEffect::defaultConfiguration | public | function | Gets default configuration for this plugin. | Overrides ImageEffectBase::defaultConfiguration | |
AjaxTestImageEffect::submitConfigurationForm | public | function | Form submission handler. | Overrides ConfigurableImageEffectBase::submitConfigurationForm | |
ConfigurableImageEffectBase::validateConfigurationForm | public | function | Form validation handler. | Overrides PluginFormInterface::validateConfigurationForm | 2 |
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 | 1 | ||
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 | 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 | Constructs a \Drupal\Component\Plugin\PluginBase object. | Overrides PluginBase::__construct | |
MessengerTrait::$messenger | protected | property | The messenger. | 29 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 29 | |
MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | |
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 | 3 |
PluginBase::getPluginId | public | function | Gets the plugin_id of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | |
PluginBase::isConfigurable | public | function | Determines if the plugin is configurable. | ||
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 1 | |
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.