class WebformImageResolution in Webform 8.5

Same name and namespace in other branches

6.x src/Element/WebformImageResolution.php \Drupal\webform\Element\WebformImageResolution

Provides a webform image resolution element .

Plugin annotation

@FormElement("webform_image_resolution");

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\Element\WebformImageResolution uses CompositeFormElementTrait

Expanded class hierarchy of WebformImageResolution

1 #type use of WebformImageResolution

WebformImageFile::form in src/Plugin/WebformElement/WebformImageFile.php: Gets the actual configuration webform array to be built.

File

src/Element/WebformImageResolution.php, line 14

Namespace

Drupal\webform\Element

View source

class WebformImageResolution extends FormElement {
  use CompositeFormElementTrait;

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#input' => TRUE,
      '#size' => 60,
      '#process' => [
        [
          $class,
          'processWebformImageResolution',
        ],
      ],
      '#theme_wrappers' => [
        'form_element',
      ],
      '#required' => FALSE,
      // Add '#markup' property to add an 'id' attribute to the form element.
      // @see template_preprocess_form_element()
      '#markup' => '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
    if ($input === FALSE) {
      if (!isset($element['#default_value'])) {
        $element['#default_value'] = '';
      }
      $max_resolution = explode('x', $element['#default_value']) + [
        '',
        '',
      ];
      return [
        'x' => $max_resolution[0],
        'y' => $max_resolution[1],
      ];
    }
    else {
      return $input;
    }
  }

  /**
   * Expand a image resolution field into width and height elements.
   *
   * @see \Drupal\image\Plugin\Field\FieldType\ImageItem::fieldSettingsForm
   */
  public static function processWebformImageResolution(&$element, FormStateInterface $form_state, &$complete_form) {
    $element['#tree'] = TRUE;
    $element['#type'] = 'item';
    $element += [
      '#description' => t('The maximum allowed image size expressed as WIDTH×HEIGHT (e.g. 640×480). Leave blank for no restriction. If a larger image is uploaded, it will be resized to reflect the given width and height. Resizing images on upload will cause the loss of <a href="http://wikipedia.org/wiki/Exchangeable_image_file_format">EXIF data</a> in the image.'),
      '#height_title' => t('Maximum height'),
      '#width_title' => t('Maximum width'),
    ];
    $element['container'] = [
      '#prefix' => '<div class="container-inline">',
      '#suffix' => '</div>',
    ];
    $element['container']['x'] = [
      '#type' => 'number',
      '#title' => $element['#width_title'],
      '#title_display' => 'invisible',
      '#value' => empty($element['#value']) ? NULL : $element['#value']['x'],
      '#min' => 1,
      '#field_suffix' => ' × ',
      '#parents' => array_merge($element['#parents'], [
        'x',
      ]),
    ];
    $element['container']['y'] = [
      '#type' => 'number',
      '#title' => $element['#height_title'],
      '#title_display' => 'invisible',
      '#value' => empty($element['#value']) ? NULL : $element['#value']['y'],
      '#min' => 1,
      '#field_suffix' => ' ' . t('pixels'),
      '#parents' => array_merge($element['#parents'], [
        'y',
      ]),
    ];

    // Add validate callback.
    $element += [
      '#element_validate' => [],
    ];
    array_unshift($element['#element_validate'], [
      get_called_class(),
      'validateWebformImageResolution',
    ]);
    return $element;
  }

  /**
   * Validates an image resolution element.
   *
   * @see \Drupal\image\Plugin\Field\FieldType\ImageItem::validateResolution
   */
  public static function validateWebformImageResolution(&$element, FormStateInterface $form_state, &$complete_form) {
    if (!empty($element['container']['x']['#value']) || !empty($element['container']['y']['#value'])) {
      foreach ([
        'x',
        'y',
      ] as $dimension) {
        if (!$element['container'][$dimension]['#value']) {

          // We expect the field name placeholder value to be wrapped in t()
          // here, so it won't be escaped again as it's already marked safe.
          $form_state
            ->setError($element['container'][$dimension], t('Both a height and width value must be specified in the @name field.', [
            '@name' => $element['#title'],
          ]));
          return;
        }
      }
      $form_state
        ->setValueForElement($element, $element['container']['x']['#value'] . 'x' . $element['container']['y']['#value']);
    }
    else {
      $form_state
        ->setValueForElement($element, '');
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CompositeFormElementTrait::preRenderCompositeFormElement	public static	function	Adds form element theming to an element if its title or description is set.
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
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.	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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
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.	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.
WebformImageResolution::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
WebformImageResolution::processWebformImageResolution	public static	function	Expand a image resolution field into width and height elements.
WebformImageResolution::validateWebformImageResolution	public static	function	Validates an image resolution element.
WebformImageResolution::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback

You are here

class WebformImageResolution in Webform 8.5

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation