class ResumeContext in Payment 8.2
Handles the "resume context" route.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\payment_reference\Controller\ResumeContext implements ContainerInjectionInterface
Expanded class hierarchy of ResumeContext
1 file declares its use of ResumeContext
- ResumeContextTest.php in modules/
payment_reference/ tests/ src/ Unit/ Controller/ ResumeContextTest.php
File
- modules/
payment_reference/ src/ Controller/ ResumeContext.php, line 16
Namespace
Drupal\payment_reference\ControllerView source
class ResumeContext extends ControllerBase implements ContainerInjectionInterface {
/**
* Constructs a new instance.
*
* @param \Drupal\Core\Session\AccountInterface $current_user
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
*/
public function __construct(AccountInterface $current_user, TranslationInterface $string_translation) {
$this->currentUser = $current_user;
$this->stringTranslation = $string_translation;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('current_user'), $container
->get('string_translation'));
}
/**
* Resumes the payment context.
*
* @param \Drupal\payment\Entity\PaymentInterface $payment
*
* @return array
* A renderable array.
*/
public function execute(PaymentInterface $payment) {
$message = $this
->t('You can now <span class="payment_reference-window-close">close this window</span>.');
if ($payment
->access('view')) {
$message = $this
->t('Your payment is %status.', [
'%status' => $payment
->getPaymentStatus()
->getPluginDefinition()['label'],
]) . ' ' . $message;
}
return [
'#attached' => [
'library' => [
'payment_reference/resume_context',
],
],
'#type' => 'markup',
'#markup' => $message,
];
}
/**
* Returns the label of a field instance.
*
* @param \Drupal\payment\Entity\PaymentInterface $payment
*
* @return string
*/
public function title(PaymentInterface $payment) {
return $payment
->label();
}
/**
* Checks if the user has access to resume a payment's context.
*
* @param \Drupal\payment\Entity\PaymentInterface $payment
*
* @return \Drupal\Core\Access\AccessResultInterface
*/
public function access(PaymentInterface $payment) {
return AccessResult::allowedIf($payment
->getPaymentType()
->resumeContextAccess($this->currentUser));
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
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. | |
ResumeContext:: |
public | function | Checks if the user has access to resume a payment's context. | |
ResumeContext:: |
public static | function |
Instantiates a new instance of this class. Overrides ControllerBase:: |
|
ResumeContext:: |
public | function | Resumes the payment context. | |
ResumeContext:: |
public | function | Returns the label of a field instance. | |
ResumeContext:: |
public | function | Constructs a new instance. | |
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. |