class Cpf in CPF 8.2

Same name and namespace in other branches

8 src/Element/Cpf.php \Drupal\cpf\Element\Cpf

Provides a form input element for entering an CPF number.

Example usage:


$form['cpf'] = [
  '#type' => 'cpf',
  '#title' => $this->t('CPF number'),
];
@end


<h3>Plugin annotation</h3>
@code
@FormElement("cpf")

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\cpf\Element\Cpf

Expanded class hierarchy of Cpf

File

src/Element/Cpf.php, line 24

Namespace

Drupal\cpf\Element

View source

class Cpf extends FormElement {

  /**
   * Defines canonical mask format.
   */
  const CANONICAL_MASK = '000.000.000-00';

  /**
   * Defines a mask for numbers.
   */
  const DIGITS_MASK = '00000000000';

  /**
   * Defines the max length for a CPF number using a canonical mask.
   */
  const MAX_LENGTH_CANONICAL_MASK = 14;

  /**
   * Defines the max length for a CPF number.
   */
  const MAX_LENGTH_DIGITS_MASK = 9;

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#input' => TRUE,
      '#size' => 60,
      '#maxlength' => self::MAX_LENGTH_CANONICAL_MASK,
      '#autocomplete_route_name' => FALSE,
      '#description' => '',
      '#mask' => TRUE,
      '#process' => [
        [
          $class,
          'processAutocomplete',
        ],
        [
          $class,
          'processAjaxForm',
        ],
        [
          $class,
          'processPattern',
        ],
      ],
      '#element_validate' => [
        [
          $class,
          'validateCpf',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderCpf',
        ],
      ],
      '#theme' => 'input__cpf',
      '#theme_wrappers' => [
        'form_element',
      ],
    ];
  }

  /**
   * Form element validation handler for #type 'cpf'.
   *
   * Note that #maxlength and #required is validated by _form_validate()
   * already.
   */
  public static function validateCpf(&$element, FormStateInterface $form_state, &$complete_form) {
    $value = trim($element['#value']);
    $form_state
      ->setValueForElement($element, $value);
    if ($value !== '' && !\Drupal::service('cpf')
      ->isValid($value)) {
      $form_state
        ->setError($element, t('The CPF number %cpf is not valid.', [
        '%cpf' => $value,
      ]));
    }
  }

  /**
   * Prepares a #type 'cpf' render element for input.html.twig.
   *
   * @param array $element
   *   An associative array containing the properties of the element.
   *   Properties used: #title, #value, #description, #size, #maxlength,
   *   #placeholder, #required, #attributes.
   *
   * @return array
   *   The $element with prepared variables ready for input.html.twig.
   */
  public static function preRenderCpf(array $element) {
    $element['#attributes']['type'] = 'cpf';
    $element['#maxlength'] = $element['#mask'] ? self::MAX_LENGTH_CANONICAL_MASK : self::MAX_LENGTH_DIGITS_MASK;
    $data['cpf']['mask_plugin']['elements'][$element['#id']] = [
      'id' => $element['#id'],
      'mask' => $element['#mask'] ? self::CANONICAL_MASK : self::DIGITS_MASK,
    ];
    $element['#attached'] = [
      'library' => [
        'cpf/cpf',
      ],
      'drupalSettings' => $data,
    ];
    $attributes = [
      'id',
      'name',
      'value',
      'size',
      'maxlength',
      'placeholder',
    ];
    Element::setAttributes($element, $attributes);
    static::setAttributes($element, [
      'form-cpf',
    ]);
    return $element;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Cpf::CANONICAL_MASK		constant	Defines canonical mask format.
Cpf::DIGITS_MASK		constant	Defines a mask for numbers.
Cpf::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
Cpf::MAX_LENGTH_CANONICAL_MASK		constant	Defines the max length for a CPF number using a canonical mask.
Cpf::MAX_LENGTH_DIGITS_MASK		constant	Defines the max length for a CPF number.
Cpf::preRenderCpf	public static	function	Prepares a #type 'cpf' render element for input.html.twig.
Cpf::validateCpf	public static	function	Form element validation handler for #type 'cpf'.
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.
FormElement::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback	15
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
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 Cpf in CPF 8.2

Hierarchy

See also

File

Namespace

Members

API Navigation