class Nif in Field NIF 8

Same name in this branch

8 src/Element/Nif.php \Drupal\field_nif\Element\Nif
8 src/Plugin/WebformElement/Nif.php \Drupal\field_nif\Plugin\WebformElement\Nif

Provides a NIF/NIE/CIF render element.

Properties:

#supported_types: (optional) An array with the supported document types, available:
- nif: Spanish with a national identity document assigned by the Ministry of the Interior.
- nie: Foreigners resident in Spain and identified by the Police with an identification number.
- cif: For legal persons or entities in general, tax identification code.

Usage example:

$form['nif'] = array(
  '#type' => 'nif',
  '#default_value' => $this
    ->getNif(),
  '#supported_types' => [
    'nif',
    'nie',
    'cif',
  ],
);

Plugin annotation

@FormElement("nif");

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\Core\Render\Element\Textfield
    class \Drupal\field_nif\Element\Nif

Expanded class hierarchy of Nif

File

src/Element/Nif.php, line 39

Namespace

Drupal\field_nif\Element

View source

class Nif extends Textfield {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#input' => TRUE,
      '#default_value' => NULL,
      '#size' => 12,
      '#maxlength' => 10,
      '#supported_types' => [
        'nif',
        'nie',
        'cif',
      ],
      '#process' => [
        [
          $class,
          'processAutocomplete',
        ],
        [
          $class,
          'processAjaxForm',
        ],
        [
          $class,
          'processGroup',
        ],
      ],
      '#element_validate' => [
        [
          $class,
          'validateNif',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderTextfield',
        ],
      ],
      '#theme' => 'input__textfield',
      '#theme_wrappers' => [
        'form_element',
      ],
    ];
  }

  /**
   * Form element validation handler for NIF/NIE/CIF elements.
   *
   * @param array $element
   *   The form element to validate.
   * @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 validateNif(&$element, FormStateInterface $form_state, &$complete_form) {
    $value = trim($element['#value']);
    $supported_types = array_filter($element['#supported_types']);
    $form_state
      ->setValueForElement($element, $value);
    if ($value !== '' && !NifUtils::validateNifCifNie($value, $element['#supported_types'])) {
      $form_state
        ->setError($element, t('@value is not a valid @document_type document number.', [
        '@value' => $value,
        '@document_type' => mb_strtoupper(implode('/', $supported_types)),
      ]));
    }
  }

  /**
   * Prepares a #type 'nif' render element for input.html.twig.
   *
   * @param array $element
   *   An associative array containing the properties of the element.
   *
   * @return array
   *   The $element with prepared variables ready for input.html.twig.
   */
  public static function preRenderNif($element) {
    $element['#attributes']['type'] = 'nif';
    Element::setAttributes($element, [
      'id',
      'name',
      'value',
      'size',
      'maxlength',
      'placeholder',
      'supported_types',
    ]);
    static::setAttributes($element, [
      'form-nif',
    ]);
    return $element;
  }

}

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.
Nif::getInfo	public	function	Returns the element properties for this element. Overrides Textfield::getInfo
Nif::preRenderNif	public static	function	Prepares a #type 'nif' render element for input.html.twig.
Nif::validateNif	public static	function	Form element validation handler for NIF/NIE/CIF elements.
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.
Textfield::preRenderTextfield	public static	function	Prepares a #type 'textfield' render element for input.html.twig.
Textfield::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback	3

You are here

class Nif in Field NIF 8

Plugin annotation

Hierarchy

See also

File

Namespace

Members

API Navigation