You are here

class Unavailable in Payment 8.2

Same name in this branch
  1. 8.2 src/Plugin/Payment/Method/Unavailable.php \Drupal\payment\Plugin\Payment\Method\Unavailable
  2. 8.2 src/Plugin/Payment/Type/Unavailable.php \Drupal\payment\Plugin\Payment\Type\Unavailable

An unavailable payment type.

Plugin annotation


@PaymentType(
  id = "payment_unavailable",
  label = @Translation("Unavailable")
)

Hierarchy

Expanded class hierarchy of Unavailable

1 file declares its use of Unavailable
UnavailableTest.php in tests/src/Unit/Plugin/Payment/Type/UnavailableTest.php
5 string references to 'Unavailable'
PaymentForm::getPaymentDescription in modules/payment_form/src/Plugin/Payment/Type/PaymentForm.php
Returns the description of the payment this plugin is of.
PaymentListBuilder::buildRow in src/Entity/Payment/PaymentListBuilder.php
{@inheritdnoc}
PaymentReference::getPaymentDescription in modules/payment_reference/src/Plugin/Payment/Type/PaymentReference.php
Returns the description of the payment this plugin is of.
PaymentUnitTest::testLabel in tests/src/Kernel/PaymentUnitTest.php
Tests label().
Unavailable::getPaymentDescription in src/Plugin/Payment/Type/Unavailable.php
Returns the description of the payment this plugin is of.

File

src/Plugin/Payment/Type/Unavailable.php, line 25

Namespace

Drupal\payment\Plugin\Payment\Type
View source
class Unavailable extends PaymentTypeBase {

  /**
   * Constructs a new instance.
   *
   * @param mixed[] $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed[] $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\payment\EventDispatcherInterface $event_dispatcher
   *   The event dispatcher.
   * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
   *   The string translator.
   */
  public function __construct(array $configuration, $plugin_id, array $plugin_definition, EventDispatcherInterface $event_dispatcher, TranslationInterface $string_translation) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $event_dispatcher);
    $this->stringTranslation = $string_translation;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('payment.event_dispatcher'), $container
      ->get('string_translation'));
  }

  /**
   * {@inheritdoc}
   */
  public function resumeContextAccess(AccountInterface $account) {
    return AccessResult::forbidden();
  }

  /**
   * {@inheritdoc}
   */
  protected function doGetResumeContextResponse() {
    throw new NotFoundHttpException();
  }

  /**
   * {@inheritdoc}
   */
  public function getPaymentDescription() {
    return new TranslatableMarkup('Unavailable');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PaymentAwareTrait::$payment protected property The payment.
PaymentAwareTrait::getPayment public function
PaymentAwareTrait::setPayment public function
PaymentTypeBase::$eventDispatcher protected property The event dispatcher.
PaymentTypeBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
PaymentTypeBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 2
PaymentTypeBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
PaymentTypeBase::getResumeContextResponse function Resumes the payer's original workflow. Overrides PaymentTypeInterface::getResumeContextResponse
PaymentTypeBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
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.
Unavailable::create public static function Creates an instance of the plugin. Overrides PaymentTypeBase::create
Unavailable::doGetResumeContextResponse protected function Performs the actual context resumption. Overrides PaymentTypeBase::doGetResumeContextResponse
Unavailable::getPaymentDescription public function Returns the description of the payment this plugin is of. Overrides PaymentTypeInterface::getPaymentDescription
Unavailable::resumeContextAccess public function Checks if the payment type context can be resumed. Overrides PaymentTypeInterface::resumeContextAccess
Unavailable::__construct public function Constructs a new instance. Overrides PaymentTypeBase::__construct