class YamlFormCreditCardNumber in YAML Form 8

Same name in this branch

8 src/Element/YamlFormCreditCardNumber.php \Drupal\yamlform\Element\YamlFormCreditCardNumber
8 src/Plugin/YamlFormElement/YamlFormCreditCardNumber.php \Drupal\yamlform\Plugin\YamlFormElement\YamlFormCreditCardNumber

Provides a form element for entering a credit card number.

Plugin annotation

@FormElement("yamlform_creditcard_number");

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\yamlform\Element\YamlFormCreditCardNumber

Expanded class hierarchy of YamlFormCreditCardNumber

1 #type use of YamlFormCreditCardNumber

YamlFormCreditCard::getCompositeElements in src/Element/YamlFormCreditCard.php: Get a renderable array of form elements.

File

src/Element/YamlFormCreditCardNumber.php, line 14

Namespace

Drupal\yamlform\Element

View source

class YamlFormCreditCardNumber extends FormElement {

  /**
   * Defines the max length for an credit card number.
   */
  const CREDITCARD_MAX_LENGTH = 16;

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#input' => TRUE,
      '#size' => self::CREDITCARD_MAX_LENGTH,
      '#maxlength' => self::CREDITCARD_MAX_LENGTH,
      '#autocomplete_route_name' => FALSE,
      '#process' => [
        [
          $class,
          'processAutocomplete',
        ],
        [
          $class,
          'processAjaxForm',
        ],
        [
          $class,
          'processPattern',
        ],
      ],
      '#element_validate' => [
        [
          $class,
          'validateYamlFormCreditCardNumber',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderYamlFormCreditCardNumber',
        ],
      ],
      '#theme' => 'input__creditcard_number',
      '#theme_wrappers' => [
        'form_element',
      ],
    ];
  }

  /**
   * Form element validation handler for #type 'creditcard_number'.
   */
  public static function validateYamlFormCreditCardNumber(&$element, FormStateInterface $form_state, &$complete_form) {
    $value = trim($element['#value']);
    $form_state
      ->setValueForElement($element, $value);
    if ($value !== '' && !self::validCreditCardNumber($value)) {
      $form_state
        ->setError($element, t('The credit card number is not valid.'));
    }
  }

  /**
   * Validation rule for credit card number.
   *
   * Luhn algorithm number checker - (c) 2005-2008 shaman - www.planzero.org
   * This code has been released into the public domain, however please
   * give credit to the original author where possible.
   *
   * @param string $number
   *   A credit card number.
   *
   * @return bool
   *   TRUE is credit card number is valid.
   *
   * @see: http://stackoverflow.com/questions/174730/what-is-the-best-way-to-validate-a-credit-card-in-php
   */
  public static function validCreditCardNumber($number) {

    // If number is not 15 or 16 digits return FALSE.
    if (!preg_match('/^\\d{15,16}$/', $number)) {
      return FALSE;
    }

    // Set the string length and parity.
    $number_length = strlen($number);
    $parity = $number_length % 2;

    // Loop through each digit and do the maths.
    $total = 0;
    for ($i = 0; $i < $number_length; $i++) {
      $digit = $number[$i];

      // Multiply alternate digits by two.
      if ($i % 2 == $parity) {
        $digit *= 2;

        // If the sum is two digits, add them together (in effect).
        if ($digit > 9) {
          $digit -= 9;
        }
      }

      // Total up the digits.
      $total += $digit;
    }

    // If the total mod 10 equals 0, the number is valid.
    return $total % 10 == 0 ? TRUE : FALSE;
  }

  /**
   * Prepares a #type 'creditcard_number' render element for theme_element().
   *
   * @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 theme_element().
   */
  public static function preRenderYamlFormCreditCardNumber($element) {
    $element['#attributes']['type'] = 'text';
    Element::setAttributes($element, [
      'id',
      'name',
      'value',
      'size',
      'maxlength',
      'placeholder',
    ]);
    static::setAttributes($element, [
      'form-textfield',
      'form-creditcard-number',
    ]);
    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.
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.
YamlFormCreditCardNumber::CREDITCARD_MAX_LENGTH		constant	Defines the max length for an credit card number.
YamlFormCreditCardNumber::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
YamlFormCreditCardNumber::preRenderYamlFormCreditCardNumber	public static	function	Prepares a #type 'creditcard_number' render element for theme_element().
YamlFormCreditCardNumber::validateYamlFormCreditCardNumber	public static	function	Form element validation handler for #type 'creditcard_number'.
YamlFormCreditCardNumber::validCreditCardNumber	public static	function	Validation rule for credit card number.

You are here

class YamlFormCreditCardNumber in YAML Form 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation