class ImageEffectsPxPerc in Image Effects 8

Implements a form element for a quantity either in pixels or percentage.

Plugin annotation

@FormElement("image_effects_px_perc");

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\ImageEffectsPxPerc

7 #type uses of ImageEffectsPxPerc

ImagemagickArgumentsImageEffect::buildConfigurationForm in src/Plugin/ImageEffect/ImagemagickArgumentsImageEffect.php

Form constructor.

MaskImageEffect::buildConfigurationForm in src/Plugin/ImageEffect/MaskImageEffect.php

Form constructor.

ResizePercentageImageEffect::buildConfigurationForm in src/Plugin/ImageEffect/ResizePercentageImageEffect.php

Form constructor.

ScaleAndSmartCropImageEffect::buildConfigurationForm in src/Plugin/ImageEffect/ScaleAndSmartCropImageEffect.php

Form constructor.

SetCanvasImageEffect::buildConfigurationForm in src/Plugin/ImageEffect/SetCanvasImageEffect.php

Form constructor.

... See full list

File

src/Element/ImageEffectsPxPerc.php, line 13

Namespace

Drupal\image_effects\Element

class ImageEffectsPxPerc extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#input' => TRUE,
      '#process' => [
        [
          $class,
          'processImageEffectsPxPerc',
        ],
      ],
      '#element_validate' => [
        [
          $class,
          'validateImageEffectsPxPerc',
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
    if ($input !== FALSE && $input !== NULL) {
      if (empty($input['c0']['c1']['value'])) {
        return '';
      }
      if ($input['c0']['c1']['uom'] === 'perc') {
        return $input['c0']['c1']['value'] . '%';
      }
      else {
        return $input['c0']['c1']['value'];
      }
    }
    return '';
  }

  /**
   * Processes a 'image_effects_px_perc' form element.
   *
   * @param array $element
   *   The form element to process.
   * @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 processImageEffectsPxPerc(array &$element, FormStateInterface $form_state, array &$complete_form) {

    // Make sure element properties are set.
    $element += [
      '#title' => NULL,
      '#description' => NULL,
      '#states' => NULL,
      '#size' => 4,
      '#maxlength' => 4,
    ];

    // Determine UoM and value.
    if (strpos($element['#default_value'], '%') !== FALSE) {
      $uom = 'perc';
      $val = str_replace('%', '', $element['#default_value']);
    }
    else {
      $uom = 'px';
      $val = $element['#default_value'];
    }

    // Form elements.
    $element['c0'] = [
      '#type' => 'fieldset',
      '#title' => $element['#title'],
      '#attributes' => [
        'class' => [
          'fieldgroup',
          'form-composite',
        ],
      ],
      '#description' => $element['#description'],
    ];
    $element['c0']['c1'] = [
      '#type' => 'fieldset',
      '#attributes' => [
        'class' => [
          'container-inline',
          'fieldgroup',
          'form-composite',
        ],
      ],
    ];
    $element['c0']['c1']['value'] = [
      '#type' => 'number',
      '#default_value' => $val,
      '#size' => $element['#size'],
      '#maxlength' => $element['#maxlength'],
    ];
    $element['c0']['c1']['uom'] = [
      '#type' => 'radios',
      '#default_value' => $uom,
      '#options' => [
        'px' => t('px'),
        'perc' => t('%'),
      ],
    ];
    return $element;
  }

  /**
   * Form element validation handler.
   */
  public static function validateImageEffectsPxPerc(&$element, FormStateInterface $form_state, &$complete_form) {
    $form_state
      ->setValueForElement($element, $element['#value']);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
ImageEffectsPxPerc::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
ImageEffectsPxPerc::processImageEffectsPxPerc	public static	function	Processes a 'image_effects_px_perc' form element.
ImageEffectsPxPerc::validateImageEffectsPxPerc	public static	function	Form element validation handler.
ImageEffectsPxPerc::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback
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.