class CpfCnpjElement in Brazilian IDs 8

Plugin annotation

@FormElement("brazilian_ids_cpf_cnpj");

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\brazilian_ids\Element\CpfCnpjBase implements ContainerFactoryPluginInterface
            • class \Drupal\brazilian_ids\Element\CpfCnpjElement

1 #type use of CpfCnpjElement

CpfCnpjWidget::formElement in src/Plugin/Field/FieldWidget/CpfCnpjWidget.php

Returns the form for a single field widget.

File

src/Element/CpfCnpjElement.php, line 10

Namespace

Drupal\brazilian_ids\Element

class CpfCnpjElement extends CpfCnpjBase {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $info = parent::getInfo();
    $info['#maxlength'] = 18;

    // Mask settings are added during element processing to avoid accidental
    // overrides.
    $info['#process'][] = [
      __CLASS__,
      'processMask',
    ];
    return $info;
  }

  /**
   * Processes Form API elements to add mask.
   *
   * @param array $element
   *   The element being processed.
   *
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state of the form the element belongs to.
   *
   * @param array $complete_form
   *   The form the element belongs to.
   *
   * @return array
   *   The processed element.
   */
  public static function processMask(array &$element, FormStateInterface $form_state, array &$complete_form) {
    if (\Drupal::moduleHandler()
      ->moduleExists('mask')) {

      // The mask is set up by JavaScript.
      $element['#attributes']['class'][] = 'brazilian-ids-cpf-cnpj-mask';
      $element['#attached']['library'][] = 'brazilian_ids/brazilian_ids_mask';
    }
    return $element;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CpfCnpjBase::$moduleHandler	private	property
CpfCnpjBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
CpfCnpjBase::getMaskDefaults	protected	function	Returns mask settings for this element type.	2
CpfCnpjBase::validateElement	public static	function	Validates the CNPJ value.
CpfCnpjBase::validateValue	protected static	function	Validates the submitted value.	2
CpfCnpjBase::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides Textfield::valueCallback
CpfCnpjBase::__construct	public	function	Constructs a Drupal\brazilian_ids\Element\CnpjElement object. Overrides PluginBase::__construct
CpfCnpjElement::getInfo	public	function	Returns the element properties for this element. Overrides CpfCnpjBase::getInfo
CpfCnpjElement::processMask	public static	function	Processes Form API elements to add mask.
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.
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.