class Stripe in Stripe 8

Provides a form element that will be rendered by stripe elements.

Usage example:

*

Plugin annotation

@FormElement("stripe");

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\Core\Render\Element\Hidden
          • class \Drupal\stripe\Element\Stripe

See also

https://stripe.com/docs/elements

4 string references to 'Stripe'

stripe.info.yml in ./stripe.info.yml

stripe.info.yml

stripe.links.menu.yml in ./stripe.links.menu.yml

stripe.links.menu.yml

stripe_examples.info.yml in modules/stripe_examples/stripe_examples.info.yml

modules/stripe_examples/stripe_examples.info.yml

stripe_help in ./stripe.module

Implements hook_help().

1 #type use of Stripe

SimpleCheckoutForm::buildForm in modules/stripe_examples/src/Form/SimpleCheckoutForm.php

Form constructor.

File

src/Element/Stripe.php, line 22

Namespace

Drupal\stripe\Element

class Stripe extends Hidden {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $info = parent::getInfo();
    $class = get_class($this);
    $info['#process'][] = [
      $class,
      'processStripe',
    ];
    $info['#pre_render'][] = [
      $class,
      'preRenderStripe',
    ];
    $info['#theme_wrappers'] = [
      'stripe_element' => [],
      'form_element' => [],
    ];

    // The selectors are gonna be looked within the enclosing form only.
    $info['#stripe_selectors'] = [
      'name' => '',
      'first_name' => '',
      'last_name' => '',
      'address_line1' => '',
      'address_line2' => '',
      'address_city' => '',
      'address_state' => '',
      'address_zip' => '',
      'address_country' => '',
    ];
    return $info;
  }

  /**
   * Prepares a 'stripe' #type element for rendering.
   */
  public static function preRenderStripe($element) {
    Element::setAttributes($element, [
      'id',
    ]);
    $selectors = array_filter($element['#stripe_selectors']);
    if (!empty($selectors)) {
      $element['#attributes']['data-drupal-stripe-selectors'] = Json::encode($element['#stripe_selectors']);
    }
    return $element;
  }

  /**
   * Processes a stripe element.
   */
  public static function processStripe(&$element, FormStateInterface $form_state, &$complete_form) {
    $config = \Drupal::config('stripe.settings');
    $element['#attached']['library'][] = 'stripe/stripe.js';
    $apikey = $config
      ->get('apikey.' . $config
      ->get('environment') . '.public');
    $element['#attached']['drupalSettings']['stripe']['apiKey'] = $apikey;
    if (empty($apikey)) {
      $settings_uri = Url::fromRoute('stripe.settings')
        ->toString();
      \Drupal::messenger()
        ->addError(t('You must <a href="@settings_uri">configure</a> the <b>Publishable API Key</b> on <b>%environment</b> for the stripe elements to work.', [
        '%environment' => $config
          ->get('environment'),
        '@settings_uri' => $settings_uri,
      ]));
    }
    $settings = [];
    $element['#attached']['drupalSettings']['stripe']['elements'][$element['#id']] = $settings;
    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
Hidden::preRenderHidden	public static	function	Prepares a #type 'hidden' render element for input.html.twig.
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.
Stripe::getInfo	public	function	Returns the element properties for this element. Overrides Hidden::getInfo
Stripe::preRenderStripe	public static	function	Prepares a 'stripe' #type element for rendering.
Stripe::processStripe	public static	function	Processes a stripe element.