class RgElement in Brazilian IDs 8

Plugin annotation

@FormElement("brazilian_ids_rg");

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\brazilian_ids\Element\RgElement

Expanded class hierarchy of RgElement

1 #type use of RgElement

RgDefaultWidget::formElement in src/Plugin/Field/FieldWidget/RgDefaultWidget.php: Returns the form for a single field widget.

File

src/Element/RgElement.php, line 11

Namespace

Drupal\brazilian_ids\Element

View source

class RgElement extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#title' => '',
      '#description' => '',
      '#required' => FALSE,
      '#default_value' => [
        'number' => NULL,
        'agency' => NULL,
        'state' => NULL,
      ],
      '#number_only' => FALSE,
      '#clean_number' => FALSE,
      '#state_options' => [
        'AC' => 'AC',
        'AL' => 'AL',
        'AM' => 'AM',
        'AP' => 'AP',
        'BA' => 'BA',
        'CE' => 'CE',
        'DF' => 'DF',
        'ES' => 'ES',
        'GO' => 'GO',
        'MA' => 'MA',
        'MG' => 'MG',
        'MS' => 'MS',
        'MT' => 'MT',
        'PA' => 'PA',
        'PB' => 'PB',
        'PE' => 'PE',
        'PI' => 'PI',
        'PR' => 'PR',
        'RJ' => 'RJ',
        'RN' => 'RN',
        'RO' => 'RO',
        'RR' => 'RR',
        'RS' => 'RS',
        'SC' => 'SC',
        'SE' => 'SE',
        'SP' => 'SP',
        'TO' => 'TO',
      ],
      '#process' => [
        [
          $class,
          'processElement',
        ],
      ],
      '#element_validate' => [
        [
          $class,
          'validateElement',
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
    $value = $input === FALSE ? $element['#default_value'] : $input['rg_fields'];
    if (isset($value['number'])) {
      $value['number'] = $element['#clean_number'] ? \Drupal::service('brazilian_ids')
        ->clean($value['number']) : str_replace(' ', '', $value['number']);
    }
    if (isset($value['agency'])) {
      $value['agency'] = trim($value['agency']);
    }
    return $value;
  }

  /**
   * Adds form elements to collect the RG field properties.
   */
  public static function processElement(array &$element, FormStateInterface $form_state, array &$complete_form) {
    $element['rg_fields'] = [
      '#type' => $element['#number_only'] ? 'container' : 'fieldset',
      '#title' => $element['#title'],
      '#description' => $element['#description'],
      '#tree' => TRUE,
    ];
    $element['rg_fields']['number'] = [
      '#type' => 'textfield',
      '#title' => $element['#number_only'] ? $element['#title'] : t('Number'),
      '#description' => $element['#number_only'] ? $element['#description'] : '',
      '#maxlength' => 20,
      '#size' => 20,
      '#required' => $element['#required'],
      '#default_value' => isset($element['#default_value']['number']) ? $element['#default_value']['number'] : '',
    ];
    if (empty($element['#number_only'])) {
      $element['rg_fields']['agency'] = [
        '#type' => 'textfield',
        '#title' => t('Issuing agency'),
        '#maxlength' => 60,
        '#size' => 20,
        '#required' => $element['#required'],
        '#default_value' => isset($element['#default_value']['agency']) ? $element['#default_value']['agency'] : '',
      ];
      $element['rg_fields']['state'] = [
        '#type' => 'select',
        '#title' => t('State'),
        '#options' => $element['#state_options'],
        '#empty_value' => '',
        '#required' => $element['#required'],
        '#default_value' => isset($element['#default_value']['state']) ? $element['#default_value']['state'] : '',
      ];
    }
    return $element;
  }

  /**
   * Validates the RG element.
   */
  public static function validateElement(&$element, FormStateInterface $form_state, &$complete_form) {
    $value = $element['#value'];

    // If any of the properties are provided, then all of them must be.
    $filled_properties = array_filter($value);
    $empty_properties = array_diff_key($value, $filled_properties);
    if ($filled_properties && $empty_properties) {
      foreach ($empty_properties as $property => $value) {
        $property_element =& $element['rg_fields'][$property];
        $form_state
          ->setError($property_element, t('The @field\'s %property must be provided.', [
          '@field' => $element['#title'],
          '%property' => $property_element['#title'],
        ]));
      }
    }
  }

}

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.
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
RgElement::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
RgElement::processElement	public static	function	Adds form elements to collect the RG field properties.
RgElement::validateElement	public static	function	Validates the RG element.
RgElement::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback
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.

You are here

class RgElement in Brazilian IDs 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation