class ListPaymentMethods in Payment 8.2

Handles the "list all payment methods" route.

Hierarchy

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

Expanded class hierarchy of ListPaymentMethods

1 file declares its use of ListPaymentMethods

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

File

src/Controller/ListPaymentMethods.php, line 13

Namespace

Drupal\payment\Controller

View source

class ListPaymentMethods extends ControllerBase {

  /**
   * The payment method plugin manager used for testing.
   *
   * @var \Drupal\payment\Plugin\Payment\Method\PaymentMethodManagerInterface
   */
  protected $paymentMethodManager;

  /**
   * Constructs a new instance.
   *
   * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
   * @param \Drupal\payment\Plugin\Payment\Method\PaymentMethodManagerInterface $payment_method_manager
   */
  public function __construct(TranslationInterface $string_translation, PaymentMethodManagerInterface $payment_method_manager) {
    $this->paymentMethodManager = $payment_method_manager;
    $this->stringTranslation = $string_translation;
  }

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

  /**
   * Lists all available payment method plugins.
   *
   * @return array
   *   A renderable array.
   */
  public function execute() {
    $rows = [];
    foreach ($this->paymentMethodManager
      ->getDefinitions() as $plugin_id => $definition) {
      $operations_provider = $this->paymentMethodManager
        ->getOperationsProvider($plugin_id);
      $row = [
        'label' => [
          '#markup' => $definition['label'],
        ],
        'status' => [
          '#markup' => $definition['active'] ? $this
            ->t('Enabled') : $this
            ->t('Disabled'),
        ],
        'operations' => [
          '#type' => 'operations',
          '#links' => $operations_provider ? $operations_provider
            ->getOperations($plugin_id) : [],
        ],
      ];
      if (!$definition['active']) {
        $row['#attributes']['class'] = [
          'payment-method-disabled',
        ];
      }
      $rows[$plugin_id] = $row;
    }
    return [
      '#attached' => [
        'library' => [
          'payment/payment_method.list',
        ],
      ],
      '#attributes' => [
        'class' => [
          'payment-method-list',
        ],
      ],
      '#header' => [
        $this
          ->t('Name'),
        $this
          ->t('Status'),
        $this
          ->t('Operations'),
      ],
      '#type' => 'table',
    ] + $rows;
  }

}

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.
ListPaymentMethods::$paymentMethodManager	protected	property	The payment method plugin manager used for testing.
ListPaymentMethods::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
ListPaymentMethods::execute	public	function	Lists all available payment method plugins.
ListPaymentMethods::__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 ListPaymentMethods in Payment 8.2

Hierarchy

File

Namespace

Members

API Navigation