class WebformImageSelectElementImages in Webform 8.5
Same name and namespace in other branches
- 6.x modules/webform_image_select/src/Element/WebformImageSelectElementImages.php \Drupal\webform_image_select\Element\WebformImageSelectElementImages
Provides a form element for managing webform element options.
This element is used by select, radios, checkboxes, likert, and mapping elements.
Plugin annotation
@FormElement("webform_image_select_element_images");
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\webform_image_select\Element\WebformImageSelectElementImages
- 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 WebformImageSelectElementImages
1 #type use of WebformImageSelectElementImages
- WebformImageSelect::form in modules/
webform_image_select/ src/ Plugin/ WebformElement/ WebformImageSelect.php - Gets the actual configuration webform array to be built.
File
- modules/
webform_image_select/ src/ Element/ WebformImageSelectElementImages.php, line 21
Namespace
Drupal\webform_image_select\ElementView source
class WebformImageSelectElementImages extends FormElement {
const CUSTOM_OPTION = '';
/**
* {@inheritdoc}
*/
public function getInfo() {
$class = get_class($this);
return [
'#input' => TRUE,
'#process' => [
[
$class,
'processWebformImageSelectElementImages',
],
[
$class,
'processAjaxForm',
],
],
'#theme_wrappers' => [
'form_element',
],
];
}
/**
* {@inheritdoc}
*/
public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
if ($input === FALSE) {
if (isset($element['#default_value'])) {
if (is_string($element['#default_value'])) {
return WebformOptionsEntity::load($element['#default_value']) ? $element['#default_value'] : [];
}
else {
return $element['#default_value'];
}
}
else {
return [];
}
}
elseif (!empty($input['images'])) {
return $input['images'];
}
elseif (isset($input['custom']['images'])) {
return $input['custom']['images'];
}
else {
return [];
}
}
/**
* Processes a webform element image select images element.
*/
public static function processWebformImageSelectElementImages(&$element, FormStateInterface $form_state, &$complete_form) {
$element['#tree'] = TRUE;
/** @var \Drupal\webform_image_select\WebformImageSelectImagesStorageInterface $webform_images_storage */
$webform_images_storage = \Drupal::entityTypeManager()
->getStorage('webform_image_select_images');
$webform_images = $webform_images_storage
->getImages();
$t_args = [
':href' => Url::fromRoute('entity.webform_image_select_images.collection')
->toString(),
];
$class_name = 'js-' . $element['#id'] . '-webform-image-select-images';
// Select images.
$element['images'] = [
'#type' => 'select',
'#description' => t('Please select <a href=":href">predefined images</a> or enter custom image.', $t_args),
'#options' => [
static::CUSTOM_OPTION => t('Custom images…'),
] + $webform_images,
'#attributes' => [
'class' => [
$class_name,
],
],
'#error_no_message' => TRUE,
'#access' => count($webform_images) ? TRUE : FALSE,
'#default_value' => isset($element['#default_value']) && !is_array($element['#default_value']) ? $element['#default_value'] : '',
];
// Custom images.
$element['custom'] = [
'#type' => 'webform_image_select_images',
'#title' => $element['#title'],
'#title_display' => 'invisible',
'#states' => [
'visible' => [
"select.{$class_name}" => [
'value' => '',
],
],
],
'#error_no_message' => TRUE,
'#default_value' => isset($element['#default_value']) && !is_string($element['#default_value']) ? $element['#default_value'] : [],
];
$element['#element_validate'] = [
[
get_called_class(),
'validateWebformImageSelectElementImages',
],
];
if (!empty($element['#states'])) {
webform_process_states($element, '#wrapper_attributes');
}
return $element;
}
/**
* Validates a webform element image select images element.
*/
public static function validateWebformImageSelectElementImages(&$element, FormStateInterface $form_state, &$complete_form) {
$options_value = NestedArray::getValue($form_state
->getValues(), $element['images']['#parents']);
$custom_value = NestedArray::getValue($form_state
->getValues(), $element['custom']['#parents']);
$value = $options_value;
if ($options_value === static::CUSTOM_OPTION) {
$value = $custom_value;
}
if (Element::isVisibleElement($element) && $element['#required'] && empty($value)) {
WebformElementHelper::setRequiredError($element, $form_state);
}
$form_state
->setValueForElement($element['images'], NULL);
$form_state
->setValueForElement($element['custom'], NULL);
$form_state
->setValueForElement($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. | |
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. | |
WebformImageSelectElementImages:: |
constant | |||
WebformImageSelectElementImages:: |
public | function |
Returns the element properties for this element. Overrides ElementInterface:: |
|
WebformImageSelectElementImages:: |
public static | function | Processes a webform element image select images element. | |
WebformImageSelectElementImages:: |
public static | function | Validates a webform element image select images element. | |
WebformImageSelectElementImages:: |
public static | function |
Determines how user input is mapped to an element's #value property. Overrides FormElement:: |