You are here

Home » API reference » Payment 8.2 » SelectPaymentMethodConfiguration.php

class SelectPaymentMethodConfiguration in Payment 8.2

Handles the "select a payment method configuration to add" route.

Hierarchy

Expanded class hierarchy of SelectPaymentMethodConfiguration

1 file declares its use of SelectPaymentMethodConfiguration
SelectPaymentMethodConfigurationTest.php in tests/src/Unit/Controller/SelectPaymentMethodConfigurationTest.php

File

src/Controller/SelectPaymentMethodConfiguration.php, line 16

Namespace

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

  /**
   * The payment method configuration access control handler.
   *
   * @var \Drupal\Core\Entity\EntityAccessControlHandlerInterface
   */
  protected $paymentMethodConfigurationAccessControlHandler;

  /**
   * The payment method configuration plugin manager.
   *
   * @var \Drupal\payment\Plugin\Payment\MethodConfiguration\PaymentMethodConfigurationManagerInterface
   */
  protected $paymentMethodConfigurationManager;

  /**
   * Constructs a new instance.
   *
   * @param \Drupal\Core\Entity\EntityAccessControlHandlerInterface $payment_method_configuration_access_control_handler
   * @param \Drupal\payment\Plugin\Payment\MethodConfiguration\PaymentMethodConfigurationManagerInterface $payment_method_configuration_manager
   * @param \Drupal\Core\Session\AccountInterface $current_user
   */
  public function __construct(EntityAccessControlHandlerInterface $payment_method_configuration_access_control_handler, PaymentMethodConfigurationManagerInterface $payment_method_configuration_manager, AccountInterface $current_user) {
    $this->currentUser = $current_user;
    $this->paymentMethodConfigurationAccessControlHandler = $payment_method_configuration_access_control_handler;
    $this->paymentMethodConfigurationManager = $payment_method_configuration_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {

    /** @var \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager */
    $entity_type_manager = $container
      ->get('entity_type.manager');
    return new static($entity_type_manager
      ->getAccessControlHandler('payment_method_configuration'), $container
      ->get('plugin.manager.payment.method_configuration'), $container
      ->get('current_user'));
  }

  /**
   * Displays a list of available payment method plugins.
   *
   * @return string
   */
  public function execute() {
    $definitions = $this->paymentMethodConfigurationManager
      ->getDefinitions();
    unset($definitions['payment_unavailable']);
    $items = [];
    foreach ($definitions as $plugin_id => $definition) {
      $access = $this->paymentMethodConfigurationAccessControlHandler
        ->createAccess($plugin_id);
      if ($access) {
        $items[] = [
          'title' => $definition['label'],
          'description' => $definition['description'],
          'localized_options' => [],
          'url' => new Url('payment.payment_method_configuration.add', [
            'plugin_id' => $plugin_id,
          ]),
        ];
      }
    }
    return [
      '#theme' => 'admin_block_content',
      '#content' => $items,
    ];
  }

  /**
   * Checks access to self::select().
   *
   * @return \Drupal\Core\Access\AccessResultInterface
   *   The access result.
   */
  public function access() {
    $definitions = $this->paymentMethodConfigurationManager
      ->getDefinitions();
    unset($definitions['payment_unavailable']);
    $access_result = AccessResult::forbidden();
    foreach (array_keys($definitions) as $plugin_id) {
      $access_result = $this->paymentMethodConfigurationAccessControlHandler
        ->createAccess($plugin_id, $this->currentUser, [], TRUE);
      if ($access_result
        ->isAllowed()) {
        return $access_result;
      }
    }
    return $access_result;
  }

}

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.
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.
SelectPaymentMethodConfiguration::$paymentMethodConfigurationAccessControlHandler protected property The payment method configuration access control handler.
SelectPaymentMethodConfiguration::$paymentMethodConfigurationManager protected property The payment method configuration plugin manager.
SelectPaymentMethodConfiguration::access public function Checks access to self::select().
SelectPaymentMethodConfiguration::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
SelectPaymentMethodConfiguration::execute public function Displays a list of available payment method plugins.
SelectPaymentMethodConfiguration::__construct public function Constructs a new instance.
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.