class PaymentForm in Payment 8.2

The payment form field payment type.

Plugin annotation

@PaymentType(
  configuration_form = "\Drupal\payment_form\Plugin\Payment\Type\PaymentFormConfigurationForm",
  id = "payment_form",
  label = @Translation("Payment form field")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\payment\Plugin\Payment\Type\PaymentTypeBase implements ConfigurableInterface, DependentPluginInterface, ContainerFactoryPluginInterface, PaymentTypeInterface uses PaymentAwareTrait
      • class \Drupal\payment_form\Plugin\Payment\Type\PaymentForm implements ContainerFactoryPluginInterface

3 files declare their use of PaymentForm

PaymentFormTest.php in modules/payment_form/tests/src/Unit/Plugin/Payment/Type/PaymentFormTest.php

PaymentFormTest.php in modules/payment_form/tests/src/Unit/Plugin/Field/FieldFormatter/PaymentFormTest.php

PaymentFormWebTest.php in modules/payment_form/tests/src/Functional/Plugin/Field/FieldFormatter/PaymentFormWebTest.php

File

modules/payment_form/src/Plugin/Payment/Type/PaymentForm.php, line 30

Namespace

Drupal\payment_form\Plugin\Payment\Type

class PaymentForm extends PaymentTypeBase implements ContainerFactoryPluginInterface {

  /**
   * The entity field manager.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $entityFieldManager;

  /**
   * 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\Entity\EntityFieldManagerInterface $entity_field_manager
   *   The entity field manager.
   * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
   *   The string translator.
   */
  public function __construct(array $configuration, $plugin_id, array $plugin_definition, EventDispatcherInterface $event_dispatcher, EntityFieldManagerInterface $entity_field_manager, TranslationInterface $string_translation) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $event_dispatcher);
    $this->entityFieldManager = $entity_field_manager;
    $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('entity_field.manager'), $container
      ->get('string_translation'));
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'bundle' => NULL,
      'destination_url' => NULL,
      'entity_type_id' => NULL,
      'field_name' => NULL,
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  protected function doGetResumeContextResponse() {
    return new Response(Url::fromUri($this
      ->getDestinationUrl()));
  }

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

  /**
   * {@inheritdoc}
   */
  public function getPaymentDescription() {
    $field_definitions = $this->entityFieldManager
      ->getFieldDefinitions($this
      ->getEntityTypeId(), $this
      ->getBundle());
    return isset($field_definitions[$this
      ->getFieldName()]) ? $field_definitions[$this
      ->getFieldName()]
      ->getLabel() : new TranslatableMarkup('Unavailable');
  }

  /**
   * Sets the ID of the entity type the payment was made for.
   *
   * @param string $entity_type_id
   *
   * @return $this
   */
  public function setEntityTypeId($entity_type_id) {
    $this->configuration['entity_type_id'] = $entity_type_id;
    return $this;
  }

  /**
   * Gets the ID of the entity type the payment was made for.
   *
   * @return string
   */
  public function getEntityTypeId() {
    return $this->configuration['entity_type_id'];
  }

  /**
   * Sets the bundle of the entity the payment was made for.
   *
   * @param string $bundle
   *
   * @return $this
   */
  public function setBundle($bundle) {
    $this->configuration['bundle'] = $bundle;
    return $this;
  }

  /**
   * Gets the bundle of the entity the payment was made for.
   *
   * @return string
   */
  public function getBundle() {
    return $this->configuration['bundle'];
  }

  /**
   * Sets the name of the field the payment was made for.
   *
   * @param string $field_name
   *
   * @return $this
   */
  public function setFieldName($field_name) {
    $this->configuration['field_name'] = $field_name;
    return $this;
  }

  /**
   * Gets the name of the field the payment was made for.
   *
   * @return string
   */
  public function getFieldName() {
    return $this->configuration['field_name'];
  }

  /**
   * Sets the URL the user should be redirected to upon resuming the context.
   *
   * @param string $url
   *   The destination URL.
   *
   * @return $this
   */
  public function setDestinationUrl($url) {
    $this->configuration['destination_url'] = $url;
    return $this;
  }

  /**
   * Gets the URL the user should be redirected to upon resuming the context.
   *
   * @return string
   *   The destination URL.
   */
  public function getDestinationUrl() {
    return $this->configuration['destination_url'];
  }

}

Members

Name	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
PaymentForm::$entityFieldManager	protected	property	The entity field manager.
PaymentForm::create	public static	function	Creates an instance of the plugin. Overrides PaymentTypeBase::create
PaymentForm::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides PaymentTypeBase::defaultConfiguration
PaymentForm::doGetResumeContextResponse	protected	function	Performs the actual context resumption. Overrides PaymentTypeBase::doGetResumeContextResponse
PaymentForm::getBundle	public	function	Gets the bundle of the entity the payment was made for.
PaymentForm::getDestinationUrl	public	function	Gets the URL the user should be redirected to upon resuming the context.
PaymentForm::getEntityTypeId	public	function	Gets the ID of the entity type the payment was made for.
PaymentForm::getFieldName	public	function	Gets the name of the field the payment was made for.
PaymentForm::getPaymentDescription	public	function	Returns the description of the payment this plugin is of. Overrides PaymentTypeInterface::getPaymentDescription
PaymentForm::resumeContextAccess	public	function	Checks if the payment type context can be resumed. Overrides PaymentTypeInterface::resumeContextAccess
PaymentForm::setBundle	public	function	Sets the bundle of the entity the payment was made for.
PaymentForm::setDestinationUrl	public	function	Sets the URL the user should be redirected to upon resuming the context.
PaymentForm::setEntityTypeId	public	function	Sets the ID of the entity type the payment was made for.
PaymentForm::setFieldName	public	function	Sets the name of the field the payment was made for.
PaymentForm::__construct	public	function	Constructs a new instance. Overrides PaymentTypeBase::__construct
PaymentTypeBase::$eventDispatcher	protected	property	The event dispatcher.
PaymentTypeBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
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.