class ListPaymentStatuses in Payment 8.2

Handles the "list payment methods" route.

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\payment\Controller\ListPaymentStatuses

Expanded class hierarchy of ListPaymentStatuses

1 file declares its use of ListPaymentStatuses

ListPaymentStatusesTest.php in tests/src/Unit/Controller/ListPaymentStatusesTest.php

File

src/Controller/ListPaymentStatuses.php, line 14

Namespace

Drupal\payment\Controller

View source

class ListPaymentStatuses extends ControllerBase {

  /**
   * The payment status plugin manager.
   *
   * @var \Drupal\payment\Plugin\Payment\Status\PaymentStatusManagerInterface
   */
  protected $paymentStatusManager;

  /**
   * The renderer.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * Constructs a new instance.
   *
   * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
   *   The string translator.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   * @param \Drupal\payment\Plugin\Payment\Status\PaymentStatusManagerInterface $payment_status_manager
   *   The payment status manager.
   */
  public function __construct(TranslationInterface $string_translation, RendererInterface $renderer, PaymentStatusManagerInterface $payment_status_manager) {
    $this->paymentStatusManager = $payment_status_manager;
    $this->renderer = $renderer;
    $this->stringTranslation = $string_translation;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('string_translation'), $container
      ->get('renderer'), $container
      ->get('plugin.manager.payment.status'));
  }

  /**
   * Lists all payment statuses.
   *
   * @return array
   *   A render array.
   */
  public function execute() {
    return [
      '#header' => [
        $this
          ->t('Title'),
        $this
          ->t('Description'),
        $this
          ->t('Operations'),
      ],
      '#type' => 'table',
    ] + $this
      ->buildListingLevel($this
      ->buildHierarchy(), 0);
  }

  /**
   * Helper function for self::listing() to build table rows.
   *
   * @param array[] $hierarchy
   *   Keys are plugin IDs, and values are arrays of the same structure as this
   *   parameter. The depth is unlimited.
   * @param integer $depth
   *   The depth of $hierarchy's top-level items as seen from the original
   *   hierarchy's root (this function is recursive), starting with 0.
   *
   * @return array
   *   A render array.
   */
  protected function buildListingLevel(array $hierarchy, $depth) {
    $rows = [];
    foreach ($hierarchy as $plugin_id => $children) {
      $definition = $this->paymentStatusManager
        ->getDefinition($plugin_id);
      $operations_provider = $this->paymentStatusManager
        ->getOperationsProvider($plugin_id);
      $indentation = [
        '#theme' => 'indentation',
        '#size' => $depth,
      ];
      $rows[$plugin_id] = [
        'label' => [
          '#markup' => $this->renderer
            ->render($indentation) . $definition['label'],
        ],
        'description' => [
          '#markup' => $definition['description'],
        ],
        'operations' => [
          '#type' => 'operations',
          '#links' => $operations_provider ? $operations_provider
            ->getOperations($plugin_id) : [],
        ],
      ];
      $rows = array_merge($rows, $this
        ->buildListingLevel($children, $depth + 1));
    }
    return $rows;
  }

  /**
   * Returns a hierarchical representation of payment statuses.
   *
   * @param string[]|null $limit_plugin_ids
   *   An array of plugin IDs to limit the statuses to, or NULL to allow all.
   *
   * @return array[]
   *   A possibly infinitely nested associative array. Keys are plugin IDs and
   *   values are arrays of similar structure as this method's return value.
   */
  protected function buildHierarchy(array $limit_plugin_ids = NULL) {
    static $hierarchy = NULL;
    if (is_null($hierarchy)) {
      $parents = [];
      $children = [];
      $definitions = $this->paymentStatusManager
        ->getDefinitions();
      if (is_array($limit_plugin_ids)) {
        $definitions = array_intersect_key($definitions, array_flip($limit_plugin_ids));
      }
      uasort($definitions, array(
        $this,
        'sort',
      ));
      foreach ($definitions as $plugin_id => $definition) {
        if (!empty($definition['parent_id'])) {
          $children[$definition['parent_id']][] = $plugin_id;
        }
        else {
          $parents[] = $plugin_id;
        }
      }
      $hierarchy = $this
        ->buildHierarchyLevel($parents, $children);
    }
    return $hierarchy;
  }

  /**
   * Helper function for self::hierarchy().
   *
   * @param string[] $parent_plugin_ids
   *   An array with IDs of plugins that are part of the same hierarchy level.
   * @param string[] $child_plugin_ids
   *   Keys are plugin IDs. Values are arrays with those plugin's child
   *   plugin IDs.
   *
   * @return array[]
   *   The return value is identical to that of self::hierarchy().
   */
  protected function buildHierarchyLevel(array $parent_plugin_ids, array $child_plugin_ids) {
    $hierarchy = [];
    foreach ($parent_plugin_ids as $plugin_id) {
      $hierarchy[$plugin_id] = isset($child_plugin_ids[$plugin_id]) ? $this
        ->buildHierarchyLevel($child_plugin_ids[$plugin_id], $child_plugin_ids) : [];
    }
    return $hierarchy;
  }

  /**
   * Implements uasort() callback to sort plugin definitions by label.
   */
  protected function sort(array $definition_a, array $definition_b) {
    return strcmp($definition_a['label'], $definition_b['label']);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$configFactory	protected	property	The configuration factory.
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityManager	protected	property	The entity manager.
ControllerBase::$entityTypeManager	protected	property	The entity type manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
ControllerBase::$stateService	protected	property	The state service.
ControllerBase::cache	protected	function	Returns the requested cache bin.
ControllerBase::config	protected	function	Retrieves a configuration object.
ControllerBase::container	private	function	Returns the service container.
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityManager Deprecated	protected	function	Retrieves the entity manager service.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
ControllerBase::keyValue	protected	function	Returns a key/value storage collection.	1
ControllerBase::languageManager	protected	function	Returns the language manager service.	1
ControllerBase::moduleHandler	protected	function	Returns the module handler.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state	protected	function	Returns the state storage service.
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
ListPaymentStatuses::$paymentStatusManager	protected	property	The payment status plugin manager.
ListPaymentStatuses::$renderer	protected	property	The renderer.
ListPaymentStatuses::buildHierarchy	protected	function	Returns a hierarchical representation of payment statuses.
ListPaymentStatuses::buildHierarchyLevel	protected	function	Helper function for self::hierarchy().
ListPaymentStatuses::buildListingLevel	protected	function	Helper function for self::listing() to build table rows.
ListPaymentStatuses::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
ListPaymentStatuses::execute	public	function	Lists all payment statuses.
ListPaymentStatuses::sort	protected	function	Implements uasort() callback to sort plugin definitions by label.
ListPaymentStatuses::__construct	public	function	Constructs a new instance.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.

You are here

class ListPaymentStatuses in Payment 8.2

Hierarchy

File

Namespace

Members

API Navigation