class ImageEffectsColor in Image Effects 8.3
Same name and namespace in other branches
- 8 src/Element/ImageEffectsColor.php \Drupal\image_effects\Element\ImageEffectsColor
- 8.2 src/Element/ImageEffectsColor.php \Drupal\image_effects\Element\ImageEffectsColor
Implements a form element to enable capturing color information.
Enable capturing color information. Plugins allow to define alternative color selectors.
Plugin annotation
@FormElement("image_effects_color");
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
- class \Drupal\image_effects\Element\ImageEffectsColor
- class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of ImageEffectsColor
4 #type uses of ImageEffectsColor
- ColorShiftImageEffect::buildConfigurationForm in src/
Plugin/ ImageEffect/ ColorShiftImageEffect.php - Form constructor.
- SetCanvasImageEffect::buildConfigurationForm in src/
Plugin/ ImageEffect/ SetCanvasImageEffect.php - Form constructor.
- SetTransparentColorImageEffect::buildConfigurationForm in src/
Plugin/ ImageEffect/ SetTransparentColorImageEffect.php - Form constructor.
- TextOverlayImageEffect::buildConfigurationForm in src/
Plugin/ ImageEffect/ TextOverlayImageEffect.php - Form constructor.
File
- src/
Element/ ImageEffectsColor.php, line 17
Namespace
Drupal\image_effects\ElementView source
class ImageEffectsColor extends FormElement {
/**
* {@inheritdoc}
*/
public function getInfo() {
$class = get_class($this);
return [
'#input' => TRUE,
'#process' => [
[
$class,
'processImageEffectsColor',
],
],
'#element_validate' => [
[
$class,
'validateImageEffectsColor',
],
],
];
}
/**
* {@inheritdoc}
*/
public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
if ($input !== FALSE && $input !== NULL) {
// Make sure element properties are set.
$element['#allow_null'] = isset($element['#allow_null']) ? $element['#allow_null'] : FALSE;
$element['#allow_opacity'] = isset($element['#allow_opacity']) ? $element['#allow_opacity'] : FALSE;
// Normalize returned element values to a RGBA hex value.
$val = '';
if ($element['#allow_null'] && !empty($input['container']['transparent'])) {
return '';
}
elseif ($element['#allow_null'] || $element['#allow_opacity']) {
$val = mb_strtoupper($input['container']['hex']);
}
else {
$val = mb_strtoupper($input['hex']);
}
if ($val[0] != '#') {
$val = '#' . $val;
}
if ($element['#allow_opacity']) {
$val .= ColorUtility::opacityToAlpha($input['container']['opacity']);
}
return $val;
}
return '';
}
/**
* Processes a 'image_effects_color' form element.
*
* @param array $element
* The form element to process. Properties used:
* '#allow_null' - if set to TRUE, a checkbox is displayed to set the
* color as a full transparency, In this case, color hex and opacity are
* hidden, and the value returned is NULL.
* '#allow_opacity' - if set to TRUE, a textfield is displayed to capture
* the 'opacity' value, as a percentage.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
* @param array $complete_form
* The complete form structure.
*
* @return array
* The processed element.
*/
public static function processImageEffectsColor(array &$element, FormStateInterface $form_state, array &$complete_form) {
// Make sure element properties are set.
$element += [
'#allow_null' => FALSE,
'#allow_opacity' => FALSE,
'#description' => NULL,
'#states' => NULL,
'#title' => t('Color'),
'#checkbox_title' => t('Transparent'),
];
// In case default value is transparent, set hex and opacity to default
// values (white, fully opaque) so that if transparency is unchecked,
// we have a starting value.
$transparent = empty($element['#default_value']) ? TRUE : FALSE;
$hex = $transparent ? '#FFFFFF' : mb_substr($element['#default_value'], 0, 7);
$opacity = $transparent ? 100 : ColorUtility::rgbaToOpacity($element['#default_value']);
$colorPlugin = \Drupal::service('plugin.manager.image_effects.color_selector')
->getPlugin();
if ($element['#allow_null'] || $element['#allow_opacity']) {
// More sub-fields are needed to define the color, wrap them in a
// container fieldset.
$element['container'] = [
'#type' => 'fieldset',
'#description' => $element['#description'],
'#title' => $element['#title'],
'#states' => $element['#states'],
];
// Checkbox for transparency.
if ($element['#allow_null']) {
$element['container']['transparent'] = [
'#type' => 'checkbox',
'#title' => $element['#checkbox_title'],
'#default_value' => $transparent,
];
}
// Color field.
$element['container']['hex'] = $colorPlugin
->selectionElement([
'#default_value' => $hex,
]);
// States management for color field.
$element['container']['hex']['#states'] = [
'visible' => [
':input[name="' . $element['#name'] . '[container][transparent]"]' => [
'checked' => FALSE,
],
],
];
// Textfield for opacity.
if ($element['#allow_opacity']) {
$element['container']['opacity'] = [
'#type' => 'number',
'#title' => t('Opacity'),
'#default_value' => $opacity,
'#maxlength' => 3,
'#size' => 2,
'#field_suffix' => '%',
'#min' => 0,
'#max' => 100,
'#states' => [
'visible' => [
':input[name="' . $element['#name'] . '[container][transparent]"]' => [
'checked' => FALSE,
],
],
],
];
}
}
else {
// No transparency or opacity, straight color field.
$options = $element;
$options['#default_value'] = $hex;
$element['hex'] = $colorPlugin
->selectionElement($options);
}
unset($element['#description'], $element['#title']);
return $element;
}
/**
* Form element validation handler.
*/
public static function validateImageEffectsColor(&$element, FormStateInterface $form_state, &$complete_form) {
$form_state
->setValueForElement($element, $element['#value']);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormElement:: |
public static | function | Adds autocomplete functionality to elements. | |
FormElement:: |
public static | function | #process callback for #pattern form element property. | |
FormElement:: |
public static | function | #element_validate callback for #pattern form element property. | |
ImageEffectsColor:: |
public | function |
Returns the element properties for this element. Overrides ElementInterface:: |
|
ImageEffectsColor:: |
public static | function | Processes a 'image_effects_color' form element. | |
ImageEffectsColor:: |
public static | function | Form element validation handler. | |
ImageEffectsColor:: |
public static | function |
Determines how user input is mapped to an element's #value property. Overrides FormElement:: |
|
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 92 |
RenderElement:: |
public static | function | Adds Ajax information about an element to communicate with JavaScript. | |
RenderElement:: |
public static | function | Adds members of this group as actual elements for rendering. | |
RenderElement:: |
public static | function | Form element processing handler for the #ajax form property. | 1 |
RenderElement:: |
public static | function | Arranges elements into groups. | |
RenderElement:: |
public static | function |
Sets a form element's class attribute. Overrides ElementInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |