You are here

Home » API reference » Payment 8.2 » ListPaymentTypes.php

class ListPaymentTypes in Payment 8.2

Handles the "list payment types" route.

Hierarchy

Expanded class hierarchy of ListPaymentTypes

1 file declares its use of ListPaymentTypes
ListPaymentTypesTest.php in tests/src/Unit/Controller/ListPaymentTypesTest.php

File

src/Controller/ListPaymentTypes.php, line 16

Namespace

Drupal\payment\Controller
View source 
class ListPaymentTypes extends ControllerBase {

  /**
   * The payment type plugin manager.
   *
   * @var \Drupal\payment\Plugin\Payment\Type\PaymentTypeManagerInterface
   */
  protected $paymentTypeManager;

  /**
   * Constructs a new instance.
   *
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\payment\Plugin\Payment\Type\PaymentTypeManagerInterface $payment_type_manager
   *   The payment type plugin manager.
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   The current user.
   * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
   */
  public function __construct(ModuleHandlerInterface $module_handler, PaymentTypeManagerInterface $payment_type_manager, AccountInterface $current_user, TranslationInterface $string_translation) {
    $this->moduleHandler = $module_handler;
    $this->paymentTypeManager = $payment_type_manager;
    $this->stringTranslation = $string_translation;
    $this->currentUser = $current_user;
  }

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

  /**
   * Displays a list of available payment types.
   *
   * @return array
   *   A render array.
   */
  public function execute() {
    $table = [
      '#empty' => $this
        ->t('There are no available payment types.'),
      '#header' => [
        $this
          ->t('Type'),
        $this
          ->t('Description'),
        $this
          ->t('Operations'),
      ],
      '#type' => 'table',
    ];
    $definitions = $this->paymentTypeManager
      ->getDefinitions();
    unset($definitions['payment_unavailable']);
    foreach ($definitions as $plugin_id => $definition) {
      $operations_provider = $this->paymentTypeManager
        ->getOperationsProvider($plugin_id);
      $operations = $operations_provider ? $operations_provider
        ->getOperations($plugin_id) : [];

      // Add the payment type's global configuration operation.
      $operations['configure'] = [
        'url' => new Url('payment.payment_type', [
          'bundle' => $plugin_id,
        ]),
        'title' => $this
          ->t('Configure'),
      ];

      // Add Field UI operations.
      if ($this->moduleHandler
        ->moduleExists('field_ui')) {
        if ($this->currentUser
          ->hasPermission('administer payment fields')) {
          $operations['manage-fields'] = [
            'title' => $this
              ->t('Manage fields'),
            'url' => new Url('entity.payment.field_ui_fields', [
              'bundle' => $plugin_id,
            ]),
          ];
        }
        if ($this->currentUser
          ->hasPermission('administer payment form display')) {
          $operations['manage-form-display'] = [
            'title' => $this
              ->t('Manage form display'),
            'url' => new Url('entity.entity_form_display.payment.default', [
              'bundle' => $plugin_id,
            ]),
          ];
        }
        if ($this->currentUser
          ->hasPermission('administer payment display')) {
          $operations['manage-display'] = [
            'title' => $this
              ->t('Manage display'),
            'url' => new Url('entity.entity_view_display.payment.default', [
              'bundle' => $plugin_id,
            ]),
          ];
        }
      }
      $table[$plugin_id]['label'] = [
        '#markup' => $definition['label'],
      ];
      $table[$plugin_id]['description'] = [
        '#markup' => isset($definition['description']) ? $definition['description'] : NULL,
      ];
      $table[$plugin_id]['operations'] = [
        '#links' => $operations,
        '#type' => 'operations',
      ];
    }
    return $table;
  }

}

Members

Namesort descending 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.
ListPaymentTypes::$paymentTypeManager protected property The payment type plugin manager.
ListPaymentTypes::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
ListPaymentTypes::execute public function Displays a list of available payment types.
ListPaymentTypes::__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.