class PaymentStatusesDisplay in Payment 8.2

Provides an element to display payment statuses.

Plugin annotation

@RenderElement("payment_statuses_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\PaymentStatusesDisplay implements ContainerFactoryPluginInterface uses FormElementCallbackTrait

Expanded class hierarchy of PaymentStatusesDisplay

1 file declares its use of PaymentStatusesDisplay

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

1 #type use of PaymentStatusesDisplay

PaymentStatusOverview::viewElements in src/Plugin/Field/FieldFormatter/PaymentStatusOverview.php: Builds a renderable array for a field value.

File

src/Element/PaymentStatusesDisplay.php, line 18

Namespace

Drupal\payment\Element

View source

class PaymentStatusesDisplay extends FormElement implements ContainerFactoryPluginInterface {
  use FormElementCallbackTrait;

  /**
   * The fate formatter.
   *
   * @var \Drupal\Core\Datetime\DateFormatter
   */
  protected $dateFormatter;

  /**
   * 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\Datetime\DateFormatter $date_formatter
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, TranslationInterface $string_translation, DateFormatter $date_formatter) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->dateFormatter = $date_formatter;
    $this->stringTranslation = $string_translation;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('string_translation'), $container
      ->get('date.formatter'));
  }

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $plugin_id = $this
      ->getPluginId();
    return array(
      // An array of
      // \Drupal\payment\Plugin\Payment\Status\PaymentStatusInterface instances.
      '#payment_statuses' => [],
      '#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_statuses']) || !is_array($element['#payment_statuses'])) {
      throw new \InvalidArgumentException('#payment_statuses must be an array of \\Drupal\\payment\\Plugin\\Payment\\Status\\PaymentStatusInterface instances.');
    }
    $element['table'] = array(
      '#empty' => $this
        ->t('There are no statuses.'),
      '#header' => array(
        $this
          ->t('Status'),
        $this
          ->t('Date'),
      ),
      '#type' => 'table',
    );

    /** @var \Drupal\payment\Plugin\Payment\Status\PaymentStatusInterface $status */
    foreach ($element['#payment_statuses'] as $delta => $payment_status) {
      if (!$payment_status instanceof PaymentStatusInterface) {
        $type = is_object($payment_status) ? get_class($payment_status) : gettype($payment_status);
        throw new \InvalidArgumentException(sprintf('#payment_statuses must be an array of \\Drupal\\payment\\Plugin\\Payment\\Status\\PaymentStatusInterface instances, but the array contained %s.', $type));
      }
      $definition = $payment_status
        ->getPluginDefinition();
      $element['table']['status_' . $delta] = array(
        '#attributes' => array(
          'class' => array(
            'payment-status-plugin-' . $payment_status
              ->getPluginId(),
          ),
        ),
        'label' => array(
          '#attributes' => array(
            'class' => array(
              'payment-status-label',
            ),
          ),
          '#markup' => $definition['label'],
        ),
        'created' => array(
          '#attributes' => array(
            'class' => array(
              'payment-line-item-quantity',
            ),
          ),
          '#markup' => $this->dateFormatter
            ->format($payment_status
            ->getCreated()),
        ),
      );
    }
    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.
PaymentStatusesDisplay::$dateFormatter	protected	property	The fate formatter.
PaymentStatusesDisplay::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
PaymentStatusesDisplay::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
PaymentStatusesDisplay::preRender	public	function	Implements form #pre_render callback.
PaymentStatusesDisplay::__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 PaymentStatusesDisplay in Payment 8.2

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation