class PaymentLineItemsDisplay in Payment 8.2

Provides an element to display payment line items.

Plugin annotation

@RenderElement("payment_line_items_display");

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\payment\Element\PaymentLineItemsDisplay implements ContainerFactoryPluginInterface uses FormElementCallbackTrait

Expanded class hierarchy of PaymentLineItemsDisplay

1 file declares its use of PaymentLineItemsDisplay

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

3 #type uses of PaymentLineItemsDisplay

PaymentForm::form in modules/payment_form/src/Entity/Payment/PaymentForm.php: Gets the actual form array to be built.
PaymentLineItemOverview::viewElements in src/Plugin/Field/FieldFormatter/PaymentLineItemOverview.php: Builds a renderable array for a field value.
PaymentReferenceBase::buildPaymentForm in src/Element/PaymentReferenceBase.php: Builds the payment form.

File

src/Element/PaymentLineItemsDisplay.php, line 18

Namespace

Drupal\payment\Element

View source

class PaymentLineItemsDisplay extends FormElement implements ContainerFactoryPluginInterface {
  use FormElementCallbackTrait;

  /**
   * The currency storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $currencyStorage;

  /**
   * Constructs a new instance.
   *
   * @param mixed[] $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
   * @param \Drupal\Core\Entity\EntityStorageInterface $currency_storage
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, TranslationInterface $string_translation, EntityStorageInterface $currency_storage) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->currencyStorage = $currency_storage;
    $this->stringTranslation = $string_translation;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {

    /** @var \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager */
    $entity_type_manager = $container
      ->get('entity_type.manager');
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('string_translation'), $entity_type_manager
      ->getStorage('currency'));
  }

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $plugin_id = $this
      ->getPluginId();
    return array(
      // A \Drupal\payment\LineItemCollectionInterface instance (required).
      '#payment_line_items' => NULL,
      '#pre_render' => [
        [
          get_class($this),
          'instantiate#preRender#' . $plugin_id,
        ],
      ],
    );
  }

  /**
   * Implements form #pre_render callback.
   *
   * @throws \InvalidArgumentException
   */
  public function preRender(array $element) {
    if (!isset($element['#payment_line_items']) || !$element['#payment_line_items'] instanceof LineItemCollectionInterface) {
      throw new \InvalidArgumentException(sprintf('#payment_line_items must be an instance of %s.', LineItemCollectionInterface::class));
    }
    $element['table'] = array(
      '#empty' => $this
        ->t('There are no line items.'),
      '#header' => array(
        $this
          ->t('Description'),
        $this
          ->t('Quantity'),
        $this
          ->t('Amount'),
        $this
          ->t('Total'),
      ),
      '#type' => 'table',
    );

    /** @var \Drupal\payment\LineItemCollectionInterface $payment_line_items */
    $payment_line_items = $element['#payment_line_items'];
    foreach ($payment_line_items
      ->getLineItems() as $delta => $payment_line_item) {

      /** @var \Drupal\currency\Entity\CurrencyInterface $currency */
      $currency = $this->currencyStorage
        ->load($payment_line_item
        ->getCurrencyCode());
      $element['table']['line_item_' . $payment_line_item
        ->getName()] = array(
        '#attributes' => array(
          'class' => array(
            'payment-line-item',
            'payment-line-item-name-' . $payment_line_item
              ->getName(),
            'payment-line-item-plugin-' . $payment_line_item
              ->getPluginId(),
          ),
        ),
        'description' => array(
          '#attributes' => array(
            'class' => array(
              'payment-line-item-description',
            ),
          ),
          '#markup' => $payment_line_item
            ->getDescription(),
        ),
        'quantity' => array(
          '#attributes' => array(
            'class' => array(
              'payment-line-item-quantity',
            ),
          ),
          '#markup' => $payment_line_item
            ->getQuantity(),
        ),
        'amount' => array(
          '#attributes' => array(
            'class' => array(
              'payment-line-item-amount',
            ),
          ),
          '#markup' => $currency
            ->formatAmount($payment_line_item
            ->getAmount()),
        ),
        'total' => array(
          '#attributes' => array(
            'class' => array(
              'payment-line-item-amount-total',
            ),
          ),
          '#markup' => $currency
            ->formatAmount($payment_line_item
            ->getTotalAmount()),
        ),
      );
    }

    /** @var \Drupal\currency\Entity\CurrencyInterface $payment_line_items_currency */
    $payment_line_items_currency = $this->currencyStorage
      ->load($payment_line_items
      ->getCurrencyCode());
    $element['table']['payment_total'] = array(
      '#attributes' => array(
        'class' => array(
          'payment-amount',
        ),
      ),
      'label' => array(
        '#attributes' => array(
          'class' => array(
            'payment-amount-label',
          ),
          'colspan' => 3,
        ),
        '#markup' => $this
          ->t('Total amount'),
      ),
      'total' => array(
        '#attributes' => array(
          'class' => array(
            'payment-amount-total',
          ),
        ),
        '#markup' => $payment_line_items_currency
          ->formatAmount($payment_line_items
          ->getAmount()),
      ),
    );
    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
FormElementCallbackTrait::__callStatic	public static	function	Instantiates this class as a plugin and calls a method on it.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PaymentLineItemsDisplay::$currencyStorage	protected	property	The currency storage.
PaymentLineItemsDisplay::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
PaymentLineItemsDisplay::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
PaymentLineItemsDisplay::preRender	public	function	Implements form #pre_render callback.
PaymentLineItemsDisplay::__construct	public	function	Constructs a new instance. Overrides PluginBase::__construct
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.
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 PaymentLineItemsDisplay in Payment 8.2

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation