You are here

Home » API reference » Avatar Kit 8 » AvatarsImageRadios.php

class AvatarsImageRadios in Avatar Kit 8

Provides a form element for a set of radio buttons with images.

Properties:

  • #thumbs: An associative array, where the keys are the returned values for each radio button, and the values are an array containing:

    • 'label': A label for the radio element.
    • 'uri': (optional) path to an image.

Usage example:


$thumbs['my_generator] = [
  'label' => t('My Generator'),
  'uri' => 'public://path/to.image',
];
$form['avatar_generators'] = [
  '#type' => 'avatars_image_radios',
  '#thumbs' => $thumbs,
  '#style_name' => $this->getSetting('preview_image_style'),
  '#default_value' => $default_value,
];

Plugin annotation

@FormElement("avatars_image_radios");

Hierarchy

Expanded class hierarchy of AvatarsImageRadios

1 #type use of AvatarsImageRadios
AvatarGeneratorPreviewWidget::formElement in src/Plugin/Field/FieldWidget/AvatarGeneratorPreviewWidget.php
Returns the form for a single field widget.

File

src/Element/AvatarsImageRadios.php, line 34

Namespace

Drupal\avatars\Element
View source 
class AvatarsImageRadios extends Radios {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#input' => TRUE,
      '#process' => [
        [
          $class,
          'processRadios',
        ],
      ],
      '#theme_wrappers' => [
        'radios',
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderCompositeFormElement',
        ],
      ],
      '#attached' => [
        'library' => [
          'avatars/avatars.avatars_image_radios',
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function processRadios(&$element, FormStateInterface $form_state, &$complete_form) {
    static::setAttributes($element, [
      'avatar_preview_radios',
    ]);
    $parent = $element;
    $parent['#options'] = [];
    foreach ($parent['#thumbs'] as $id => $thumb) {
      $parent['#options'][$id] = (string) $thumb['label'];
    }
    $parent = parent::processRadios($parent, $form_state, $complete_form);
    foreach (Element::children($parent) as $key) {
      $thumb = $element['#thumbs'][$key];
      $element[$key]['#theme'] = 'avatar_preview_radio';
      static::setAttributes($element[$key], [
        'avatar_preview_radio',
        'avatar_preview_radio__' . $key,
      ]);

      // Image.
      if (isset($thumb['uri'])) {
        if ($element['#style_name']) {
          $element[$key]['image']['#theme'] = 'image_style';
          $element[$key]['image']['#style_name'] = $element['#style_name'];
        }
        else {
          $element[$key]['image']['#theme'] = 'image';
        }
        $element[$key]['image']['#uri'] = $thumb['uri'];
      }

      // Radio.
      $element[$key]['radio'] =& $parent[$key];
      $element[$key]['radio']['#parents'][] = 'radio';
    }
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AvatarsImageRadios::getInfo public function Returns the element properties for this element. Overrides Radios::getInfo
AvatarsImageRadios::processRadios public static function Expands a radios element into individual radio elements. Overrides Radios::processRadios
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
Radios::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback
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.