class CardExpiration in Creditfield Form Element 8

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

Plugin annotation

@FormElement("creditfield_expiration");

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\creditfield\Element\CardExpiration

Expanded class hierarchy of CardExpiration

1 file declares its use of CardExpiration

CardExpirationTest.php in tests/src/Unit/Element/CardExpirationTest.php

File

src/Element/CardExpiration.php, line 14

Namespace

Drupal\creditfield\Element

View source

class CardExpiration extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#input' => TRUE,
      '#element_validate' => [
        [
          $class,
          'validateCardExpiration',
        ],
      ],
      '#process' => [
        [
          $class,
          'processCardExpiration',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderCardExpiration',
        ],
      ],
      '#theme' => 'input__date',
      '#theme_wrappers' => [
        'form_element',
      ],
    ];
  }

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

  /**
   * {@inheritdoc}
   */
  public static function validateCardExpiration(&$element, FormStateInterface $form_state, &$complete_form) {
    if (!static::dateIsValid($element['#value'])) {
      $form_state
        ->setError($element, t('Please enter a valid expiration date.'));
    }
  }

  /**
   * Adds form-specific attributes to a 'creditfield_expiration' #type element.
   *
   * Supports HTML5 types of 'date', 'datetime', 'datetime-local', and 'time'.
   * Falls back to a plain textfield. Used as a sub-element by the datetime
   * element type.
   *
   * @param array $element
   *   An associative array containing the properties of the element.
   *   Properties used: #title, #value, #options, #description, #required,
   *   #attributes, #id, #name, #type, #min, #max, #step, #value, #size.
   *
   * Note: The input "name" attribute needs to be sanitized before output, which
   *       is currently done by initializing Drupal\Core\Template\Attribute with
   *       all the attributes.
   *
   * @return array
   *   The $element with prepared variables ready for #theme 'input__date'.
   */
  public static function preRenderCardExpiration($element) {
    $element['#attributes']['type'] = 'month';
    Element::setAttributes($element, [
      'id',
      'name',
      'type',
      'min',
      'max',
      'step',
      'value',
      'size',
    ]);
    static::setAttributes($element, [
      'form-' . $element['#attributes']['type'],
    ]);
    return $element;
  }

  /**
   * Simple date check to determine if the expiration date is in the future from right now.
   * @param $value
   * @return bool
   */
  public static function dateIsValid($value) {
    if (!mb_strlen($value)) {
      return FALSE;
    }
    $dateparts = explode('-', $value);
    $year = (int) $dateparts[0];
    $month = (int) $dateparts[1];
    if ($month > 12) {
      return FALSE;
    }
    if ($year < date('Y') || !is_integer($year)) {
      return FALSE;
    }
    if ($year == date('Y') && $month < date('m')) {
      return FALSE;
    }
    return TRUE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CardExpiration::dateIsValid	public static	function	Simple date check to determine if the expiration date is in the future from right now.
CardExpiration::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
CardExpiration::preRenderCardExpiration	public static	function	Adds form-specific attributes to a 'creditfield_expiration' #type element.
CardExpiration::processCardExpiration	public static	function
CardExpiration::validateCardExpiration	public static	function
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 CardExpiration in Creditfield Form Element 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation