You are here

Home » API reference » Brazilian IDs 8 » CpfCnpjBase.php

class CpfCnpjBase in Brazilian IDs 8

Base class for CPF and CNPJ elements.

Hierarchy

Expanded class hierarchy of CpfCnpjBase

File

src/Element/CpfCnpjBase.php, line 14

Namespace

Drupal\brazilian_ids\Element
View source 
class CpfCnpjBase extends Textfield implements ContainerFactoryPluginInterface {

  /**
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  private $moduleHandler;

  /**
   * Constructs a Drupal\brazilian_ids\Element\CnpjElement object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   Module handler to check if other modules are enabled.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ModuleHandlerInterface $module_handler) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->moduleHandler = $module_handler;
  }

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $info = parent::getInfo();

    // Changes default input size.
    $info['#size'] = 20;

    // Adds validation callback.
    $info['#element_validate'] = [
      [
        get_class($this),
        'validateElement',
      ],
    ];

    // Adds mask properties to take effect when the Mask Field module (mask)
    // is enabled.
    $mask = $this
      ->getMaskDefaults();
    if ($mask && $this->moduleHandler
      ->moduleExists('mask')) {
      $helper = new \Drupal\mask\Helper\ElementHelper();
      $helper
        ->elementInfoAlter($info, $mask);
    }
    return $info;
  }

  /**
   * Returns mask settings for this element type.
   */
  protected function getMaskDefaults() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('module_handler'));
  }

  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
    $value = parent::valueCallback($element, $input, $form_state);
    return \Drupal::service('brazilian_ids')
      ->clean($value);
  }

  /**
   * Validates the CNPJ value.
   */
  public static function validateElement(&$element, FormStateInterface $form_state, &$complete_form) {
    $value = $element['#value'];
    $error = [];
    if ($value !== '' && !static::validateValue($value, $error)) {
      $form_state
        ->setError($element, $error['message']);
    }
  }

  /**
   * Validates the submitted value.
   *
   * @param string $value
   *   The value of the CPF or CNPJ number to be validated.
   *
   * @param array $error
   *   If provided, it is filled with the error message at $error['message'] if any.
   *
   * @see \Drupal\brazilian_ids\BrazilianIdsService::validateCpfCnpj()
   */
  protected static function validateValue($value, array &$error = []) {
    return \Drupal::service('brazilian_ids')
      ->validateCpfCnpj($value, $error);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CpfCnpjBase::$moduleHandler private property
CpfCnpjBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
CpfCnpjBase::getInfo public function Returns the element properties for this element. Overrides Textfield::getInfo 3
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
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.