class ConfigurePaymentType in Payment 8.2
Handles the "configure payment type" route.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\payment\Controller\ConfigurePaymentType
Expanded class hierarchy of ConfigurePaymentType
1 file declares its use of ConfigurePaymentType
- ConfigurePaymentTypeTest.php in tests/
src/ Unit/ Controller/ ConfigurePaymentTypeTest.php
File
- src/
Controller/ ConfigurePaymentType.php, line 15
Namespace
Drupal\payment\ControllerView source
class ConfigurePaymentType extends ControllerBase {
/**
* The payment type plugin manager.
*
* @var \Drupal\payment\Plugin\Payment\Type\PaymentTypeManagerInterface
*/
protected $paymentTypeManager;
/**
* Constructs a new instance.
*
* @param \Drupal\Core\Form\FormBuilderInterface $form_builder
* The form builder.
* @param \Drupal\payment\Plugin\Payment\Type\PaymentTypeManagerInterface $payment_type_manager
* The payment type plugin manager.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
*/
public function __construct(FormBuilderInterface $form_builder, PaymentTypeManagerInterface $payment_type_manager, TranslationInterface $string_translation) {
$this->formBuilder = $form_builder;
$this->paymentTypeManager = $payment_type_manager;
$this->stringTranslation = $string_translation;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('form_builder'), $container
->get('plugin.manager.payment.type'), $container
->get('string_translation'));
}
/**
* Builds the payment type's configuration form.
*
* @param string $bundle
* The payment bundle, also known as the payment type's plugin ID.
*
* @return array
* A renderable array
*
* @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
*/
public function execute($bundle) {
$definition = $this->paymentTypeManager
->getDefinition($bundle, FALSE);
if (is_null($definition)) {
throw new NotFoundHttpException();
}
elseif (isset($definition['configuration_form'])) {
return $this->formBuilder
->getForm($definition['configuration_form']);
}
else {
return [
'#markup' => $this
->t('This payment type has no configuration.'),
];
}
}
/**
* Gets the title of the payment type configuration page.
*
* @param string $bundle
* The payment type's plugin ID.
*
* @return string
*/
public function title($bundle) {
$definition = $this->paymentTypeManager
->getDefinition($bundle);
return $definition['label'];
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfigurePaymentType:: |
protected | property | The payment type plugin manager. | |
ConfigurePaymentType:: |
public static | function |
Instantiates a new instance of this class. Overrides ControllerBase:: |
|
ConfigurePaymentType:: |
public | function | Builds the payment type's configuration form. | |
ConfigurePaymentType:: |
public | function | Gets the title of the payment type configuration page. | |
ConfigurePaymentType:: |
public | function | Constructs a new instance. | |
ControllerBase:: |
protected | property | The configuration factory. | |
ControllerBase:: |
protected | property | The current user service. | 1 |
ControllerBase:: |
protected | property | The entity form builder. | |
ControllerBase:: |
protected | property | The entity manager. | |
ControllerBase:: |
protected | property | The entity type manager. | |
ControllerBase:: |
protected | property | The form builder. | 2 |
ControllerBase:: |
protected | property | The key-value storage. | 1 |
ControllerBase:: |
protected | property | The language manager. | 1 |
ControllerBase:: |
protected | property | The module handler. | 2 |
ControllerBase:: |
protected | property | The state service. | |
ControllerBase:: |
protected | function | Returns the requested cache bin. | |
ControllerBase:: |
protected | function | Retrieves a configuration object. | |
ControllerBase:: |
private | function | Returns the service container. | |
ControllerBase:: |
protected | function | Returns the current user. | 1 |
ControllerBase:: |
protected | function | Retrieves the entity form builder. | |
ControllerBase:: |
protected | function | Retrieves the entity manager service. | |
ControllerBase:: |
protected | function | Retrieves the entity type manager. | |
ControllerBase:: |
protected | function | Returns the form builder service. | 2 |
ControllerBase:: |
protected | function | Returns a key/value storage collection. | 1 |
ControllerBase:: |
protected | function | Returns the language manager service. | 1 |
ControllerBase:: |
protected | function | Returns the module handler. | 2 |
ControllerBase:: |
protected | function |
Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait:: |
|
ControllerBase:: |
protected | function | Returns the state storage service. | |
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |