class PaymentReference in Payment 8.2
Same name in this branch
- 8.2 modules/payment_reference/src/PaymentReference.php \Drupal\payment_reference\PaymentReference
- 8.2 modules/payment_reference/src/Element/PaymentReference.php \Drupal\payment_reference\Element\PaymentReference
- 8.2 modules/payment_reference/src/Plugin/Payment/Type/PaymentReference.php \Drupal\payment_reference\Plugin\Payment\Type\PaymentReference
- 8.2 modules/payment_reference/src/Plugin/Field/FieldWidget/PaymentReference.php \Drupal\payment_reference\Plugin\Field\FieldWidget\PaymentReference
- 8.2 modules/payment_reference/src/Plugin/Field/FieldType/PaymentReference.php \Drupal\payment_reference\Plugin\Field\FieldType\PaymentReference
The payment reference field payment type.
Plugin annotation
@PaymentType(
configuration_form = "\Drupal\payment_reference\Plugin\Payment\Type\PaymentReferenceConfigurationForm",
id = "payment_reference",
label = @Translation("Payment reference 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_reference\Plugin\Payment\Type\PaymentReference implements ContainerFactoryPluginInterface
- class \Drupal\payment\Plugin\Payment\Type\PaymentTypeBase implements ConfigurableInterface, DependentPluginInterface, ContainerFactoryPluginInterface, PaymentTypeInterface uses PaymentAwareTrait
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of PaymentReference
2 files declare their use of PaymentReference
- PaymentFactoryTest.php in modules/
payment_reference/ tests/ src/ Unit/ PaymentFactoryTest.php - PaymentReferenceTest.php in modules/
payment_reference/ tests/ src/ Unit/ Plugin/ Payment/ Type/ PaymentReferenceTest.php
File
- modules/
payment_reference/ src/ Plugin/ Payment/ Type/ PaymentReference.php, line 31
Namespace
Drupal\payment_reference\Plugin\Payment\TypeView source
class PaymentReference extends PaymentTypeBase implements ContainerFactoryPluginInterface {
/**
* The entity field manager.
*
* @var \Drupal\Core\Entity\EntityFieldManagerInterface
*/
protected $entityFieldManager;
/**
* The URL generator.
*
* @var \Drupal\Core\Routing\UrlGeneratorInterface
*/
protected $urlGenerator;
/**
* 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\Routing\UrlGeneratorInterface $url_generator
* The URL generator.
* @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, UrlGeneratorInterface $url_generator, EntityFieldManagerInterface $entity_field_manager, TranslationInterface $string_translation) {
$configuration += $this
->defaultConfiguration();
parent::__construct($configuration, $plugin_id, $plugin_definition, $event_dispatcher);
$this->urlGenerator = $url_generator;
$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('url_generator'), $container
->get('entity_field.manager'), $container
->get('string_translation'));
}
/**
* {@inheritdoc}
*/
public function defaultConfiguration() {
return array(
'bundle' => NULL,
'entity_type_id' => NULL,
'field_name' => NULL,
) + parent::defaultConfiguration();
}
/**
* {@inheritdoc}
*/
protected function doGetResumeContextResponse() {
return new Response(new Url('payment_reference.resume_context', array(
'payment' => $this
->getPayment()
->id(),
), array(
'absolute' => TRUE,
)));
}
/**
* {@inheritdoc}
*/
public function resumeContextAccess(AccountInterface $account) {
return AccessResult::allowedIf($this
->getPayment()
->getOwnerId() == $account
->id());
}
/**
* {@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'];
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PaymentAwareTrait:: |
protected | property | The payment. | |
PaymentAwareTrait:: |
public | function | ||
PaymentAwareTrait:: |
public | function | ||
PaymentReference:: |
protected | property | The entity field manager. | |
PaymentReference:: |
protected | property | The URL generator. | |
PaymentReference:: |
public static | function |
Creates an instance of the plugin. Overrides PaymentTypeBase:: |
|
PaymentReference:: |
public | function |
Gets default configuration for this plugin. Overrides PaymentTypeBase:: |
|
PaymentReference:: |
protected | function |
Performs the actual context resumption. Overrides PaymentTypeBase:: |
|
PaymentReference:: |
public | function | Gets the bundle of the entity the payment was made for. | |
PaymentReference:: |
public | function | Gets the ID of the entity type the payment was made for. | |
PaymentReference:: |
public | function | Gets the name of the field the payment was made for. | |
PaymentReference:: |
public | function |
Returns the description of the payment this plugin is of. Overrides PaymentTypeInterface:: |
|
PaymentReference:: |
public | function |
Checks if the payment type context can be resumed. Overrides PaymentTypeInterface:: |
|
PaymentReference:: |
public | function | Sets the bundle of the entity the payment was made for. | |
PaymentReference:: |
public | function | Sets the ID of the entity type the payment was made for. | |
PaymentReference:: |
public | function | Sets the name of the field the payment was made for. | |
PaymentReference:: |
public | function |
Constructs a new instance. Overrides PaymentTypeBase:: |
|
PaymentTypeBase:: |
protected | property | The event dispatcher. | |
PaymentTypeBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
|
PaymentTypeBase:: |
public | function |
Gets this plugin's configuration. Overrides ConfigurableInterface:: |
|
PaymentTypeBase:: |
function |
Resumes the payer's original workflow. Overrides PaymentTypeInterface:: |
||
PaymentTypeBase:: |
public | function |
Sets the configuration for this plugin instance. Overrides ConfigurableInterface:: |
|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
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. |