You are here

Home » API reference » Creditfield Form Element 8 » CardNumber.php

class CardNumber in Creditfield Form Element 8

Provides a one-line credit card number field form element.

Plugin annotation

@FormElement("creditfield_cardnumber");

Hierarchy

Expanded class hierarchy of CardNumber

1 file declares its use of CardNumber
CardNumberTest.php in tests/src/Unit/Element/CardNumberTest.php

File

src/Element/CardNumber.php, line 14

Namespace

Drupal\creditfield\Element
View source 
class CardNumber extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#input' => TRUE,
      '#size' => 60,
      '#maxlength' => 16,
      '#autocomplete_route_name' => FALSE,
      '#element_validate' => [
        [
          $class,
          'validateCardNumber',
        ],
      ],
      '#process' => [
        [
          $class,
          'processCardNumber',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderCardNumber',
        ],
      ],
      '#theme' => 'input__textfield',
      '#theme_wrappers' => [
        'form_element',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function processCardNumber(&$element, FormStateInterface $form_state, &$complete_form) {
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public static function validateCardNumber(&$element, FormStateInterface $form_state, &$complete_form) {
    if (!static::numberIsValid($element['#value'])) {
      $form_state
        ->setError($element, t('Your card appears to be invalid. Please check the numbers and try again.'));
      return;
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
    if ($input !== FALSE && $input !== NULL) {

      // Equate $input to the form value to ensure it's marked for
      // validation.
      return str_replace([
        "\r",
        "\n",
      ], '', $input);
    }
  }

  /**
   * Prepares a #type 'creditfield_cardnumber' 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 preRenderCardNumber($element) {
    $element['#attributes']['type'] = 'text';
    Element::setAttributes($element, [
      'id',
      'name',
      'value',
      'size',
      'maxlength',
      'placeholder',
    ]);
    static::setAttributes($element, [
      'form-text',
    ]);
    return $element;
  }

  /**
   * Validate callback for credit card number form fields.
   * Luhn algorithm number checker - (c) 2005-2008 shaman - www.planzero.org
   * @param $value
   * @return bool
   */
  public static function numberIsValid($value) {

    // short circuit here if value is not an integer
    if (!preg_match('/^\\d+$/', $value)) {
      return FALSE;
    }

    // Set the string length and parity
    $cardnumber_length = mb_strlen($value);
    if ($cardnumber_length < 14 || $cardnumber_length > 16) {
      return FALSE;
    }
    $parity = $cardnumber_length % 2;

    // Loop through each digit and do the maths
    $total = 0;
    for ($i = 0; $i < $cardnumber_length; $i++) {
      $digit = $value[$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;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CardNumber::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
CardNumber::numberIsValid public static function Validate callback for credit card number form fields. Luhn algorithm number checker - (c) 2005-2008 shaman - www.planzero.org
CardNumber::preRenderCardNumber public static function Prepares a #type 'creditfield_cardnumber' render element for input.html.twig.
CardNumber::processCardNumber public static function
CardNumber::validateCardNumber public static function
CardNumber::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback
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.
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.