class WebformImageSelectElementImages in Webform 6.x

Same name and namespace in other branches

8.5 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

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 22

Namespace

Drupal\webform_image_select\Element

View 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'])) {
      WebformFormHelper::processStates($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::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FormElement::processAutocomplete	public static	function	Adds autocomplete functionality to elements.
FormElement::processPattern	public static	function	#process callback for #pattern form element property.
FormElement::validatePattern	public static	function	#element_validate callback for #pattern form element property.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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	2
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	98
RenderElement::preRenderAjaxForm	public static	function	Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup	public static	function	Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm	public static	function	Form element processing handler for the #ajax form property.	1
RenderElement::processGroup	public static	function	Arranges elements into groups.
RenderElement::setAttributes	public static	function	Sets a form element's class attribute. Overrides ElementInterface::setAttributes
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.
WebformImageSelectElementImages::CUSTOM_OPTION		constant
WebformImageSelectElementImages::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
WebformImageSelectElementImages::processWebformImageSelectElementImages	public static	function	Processes a webform element image select images element.
WebformImageSelectElementImages::validateWebformImageSelectElementImages	public static	function	Validates a webform element image select images element.
WebformImageSelectElementImages::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback

You are here