class Payment in Payment 8.2
Same name in this branch
- 8.2 src/Payment.php \Drupal\payment\Payment
- 8.2 src/Entity/Payment.php \Drupal\payment\Entity\Payment
Defines a payment entity.
Plugin annotation
@ContentEntityType(
base_table = "payment",
bundle_label = @Translation("Payment type"),
handlers = {
"access" = "Drupal\payment\Entity\Payment\PaymentAccessControlHandler",
"form" = {
"delete" = "Drupal\payment\Entity\Payment\PaymentDeleteForm",
"update_status" = "Drupal\payment\Entity\Payment\PaymentStatusForm",
"capture" = "Drupal\payment\Entity\Payment\PaymentCaptureForm",
"refund" = "Drupal\payment\Entity\Payment\PaymentRefundForm"
},
"list_builder" = "Drupal\payment\Entity\Payment\PaymentListBuilder",
"view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
"views_data" = "Drupal\payment\Entity\Payment\PaymentViewsData",
"storage" = "Drupal\payment\Entity\Payment\PaymentStorage",
"storage_schema" = "Drupal\payment\Entity\Payment\PaymentStorageSchema",
},
entity_keys = {
"bundle" = "bundle",
"id" = "id",
"uuid" = "uuid",
},
field_ui_base_route = "payment.payment_type",
id = "payment",
label = @Translation("Payment"),
links = {
"canonical" = "/payment/{payment}",
"collection" = "/admin/content/payment",
"complete" = "/payment/{payment}/complete",
"delete-form" = "/payment/{payment}/delete",
"update-status-form" = "/payment/{payment}/update-status",
"capture-form" = "/payment/{payment}/capture",
"refund-form" = "/payment/{payment}/refund"
}
)
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, ContentEntityInterface, TranslationStatusInterface uses EntityChangesDetectionTrait, SynchronizableEntityTrait
- class \Drupal\payment\Entity\Payment implements PaymentInterface uses EntityChangedTrait
- class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, ContentEntityInterface, TranslationStatusInterface uses EntityChangesDetectionTrait, SynchronizableEntityTrait
Expanded class hierarchy of Payment
3 files declare their use of Payment
- PaymentReferenceBase.php in src/
Element/ PaymentReferenceBase.php - PaymentReferenceElement.php in modules/
payment_reference_test/ src/ PaymentReferenceElement.php - PaymentReferenceWebTest.php in modules/
payment_reference/ tests/ src/ Functional/ Element/ PaymentReferenceWebTest.php
8 string references to 'Payment'
- payment.info.yml in ./
payment.info.yml - payment.info.yml
- payment.links.menu.yml in ./
payment.links.menu.yml - payment.links.menu.yml
- payment.routing.yml in ./
payment.routing.yml - payment.routing.yml
- PaymentAdministrationCategoryWebTest::testOverview in tests/
src/ Functional/ PaymentAdministrationCategoryWebTest.php - Tests administrative overview.
- payment_form.info.yml in modules/
payment_form/ payment_form.info.yml - modules/payment_form/payment_form.info.yml
File
- src/
Entity/ Payment.php, line 56
Namespace
Drupal\payment\EntityView source
class Payment extends ContentEntityBase implements PaymentInterface {
use EntityChangedTrait;
/**
* {@inheritdoc}
*/
public function __construct(array $values, $entity_type, $bundle = FALSE, $translations = array()) {
// Unserialize the values for fields that are stored in the base table,
// because the entity storage does not do that.
// @todo Remove this when
// https://www.drupal.org/project/drupal/issues/2788637 is fixed.
$property_names = [
'payment_method',
'payment_type',
];
foreach ($property_names as $property_name) {
if (isset($values[$property_name])) {
foreach ($values[$property_name] as &$item_values) {
if (is_string($item_values['plugin_configuration'])) {
$item_values['plugin_configuration'] = unserialize($item_values['plugin_configuration']);
}
}
}
}
parent::__construct($values, $entity_type, $bundle, $translations);
}
/**
* {@inheritdoc}
*/
public function getCreatedTime() {
return $this
->get('created')->value;
}
/**
* {@inheritdoc}
*/
public function getChangedTimeAcrossTranslations() {
// Payments are not translatable, so there are no per-translation changed
// times.
return $this
->getChangedTime();
}
/**
* {@inheritdoc}
*/
public function label() {
return (string) $this
->getPaymentType()
->getPaymentDescription();
}
/**
* {@inheritdoc}
*/
public function getPaymentType() {
/** @var \Drupal\plugin\Plugin\Field\FieldType\PluginCollectionItemInterface $field_item */
$field_item = $this
->get('payment_type')
->first();
return $field_item ? $field_item
->getContainedPluginInstance() : NULL;
}
/**
* {@inheritdoc}
*/
public function getCurrency() {
return $this
->get('currency')->entity;
}
/**
* {@inheritdoc}
*/
public function setCurrencyCode($currency_code) {
$this
->set('currency', $currency_code);
return $this;
}
/**
* {@inheritdoc}
*/
public function getCurrencyCode() {
return $this
->get('currency')->target_id;
}
/**
* {@inheritdoc}
*/
public function setLineItems(array $line_items) {
foreach ($line_items as $line_item) {
$this
->setLineItem($line_item);
}
return $this;
}
/**
* {@inheritdoc}
*/
public function setLineItem(PaymentLineItemInterface $line_item) {
$line_item
->setPayment($this);
$this
->unsetLineItem($line_item
->getName());
$this
->get('line_items')
->appendItem($line_item);
return $this;
}
/**
* {@inheritdoc}
*/
public function unsetLineItem($name) {
foreach ($this
->get('line_items') as $delta => $line_item_item) {
if ($line_item_item
->getContainedPluginInstance()
->getName() == $name) {
$this
->get('line_items')
->removeItem($delta);
}
}
return $this;
}
/**
* {@inheritdoc}
*/
public function getLineItems() {
$line_items = [];
/** @var \Drupal\plugin\Plugin\Field\FieldType\PluginCollectionItemInterface $field_item */
foreach ($this
->get('line_items') as $field_item) {
/** @var \Drupal\payment\Plugin\Payment\LineItem\PaymentLineItemInterface $line_item */
$line_item = $field_item
->getContainedPluginInstance();
if ($line_item) {
$line_items[$line_item
->getName()] = $line_item;
}
}
return $line_items;
}
/**
* {@inheritdoc}
*/
public function getLineItem($name) {
$line_items = $this
->getLineItems();
foreach ($line_items as $delta => $line_item) {
if ($line_item
->getName() == $name) {
return $line_item;
}
}
return NULL;
}
/**
* {@inheritdoc}
*/
public function getLineItemsByType($plugin_id) {
$line_items = [];
foreach ($this
->getLineItems() as $name => $line_item) {
if ($line_item
->getPluginId() == $plugin_id) {
$line_items[$name] = $line_item;
}
}
return $line_items;
}
/**
* {@inheritdoc}
*/
public function setPaymentStatuses(array $payment_statuses) {
$payment_status_list = $this
->get('payment_statuses');
// Remove all existing field items.
foreach ($payment_status_list as $index => $payment_status) {
$payment_status_list
->removeItem($index);
}
// Set each individual new status.
/** @var \Drupal\payment\Plugin\Payment\Status\PaymentStatusInterface[] $payment_statuses */
foreach ($payment_statuses as $payment_status) {
$payment_status
->setPayment($this);
$payment_status_list
->appendItem($payment_status);
}
return $this;
}
/**
* {@inheritdoc}
*/
public function setPaymentStatus(PluginPaymentStatusInterface $payment_status) {
$previous_status = $this
->getPaymentStatus();
$payment_status
->setPayment($this);
// Prevent duplicate statuses.
if (!$this
->getPaymentStatus() || $this
->getPaymentStatus()
->getPluginId() != $payment_status
->getPluginId()) {
$this
->get('payment_statuses')
->appendItem($payment_status);
}
/** @var \Drupal\payment\EventDispatcherInterface $event_dispatcher */
$event_dispatcher = \Drupal::service('payment.event_dispatcher');
$event_dispatcher
->setPaymentStatus($this, $previous_status);
return $this;
}
/**
* {@inheritdoc}
*/
public function getPaymentStatuses() {
$payment_statuses = [];
/** @var \Drupal\plugin\Plugin\Field\FieldType\PluginCollectionItemInterface $field_item */
foreach ($this
->get('payment_statuses') as $field_item) {
$payment_statuses[] = $field_item
->getContainedPluginInstance();
}
return array_filter($payment_statuses);
}
/**
* {@inheritdoc}
*/
public function getPaymentStatus() {
$deltas = [];
/** @var \Drupal\plugin\Plugin\Field\FieldType\PluginCollectionItemInterface $field_item */
foreach ($this
->get('payment_statuses') as $delta => $field_item) {
$deltas[] = $delta;
}
if ($deltas) {
return $this
->get('payment_statuses')[max($deltas)]
->getContainedPluginInstance();
}
}
/**
* {@inheritdoc}
*/
public function setPaymentMethod(PluginPaymentMethodInterface $payment_method) {
// The payment method might have been unserialized with an old payment
// object, trying to save that as new will result in exceptions. Set the
// current object again.
$payment_method
->setPayment($this);
/** @var \Drupal\plugin\Plugin\Field\FieldType\PluginCollectionItemInterface $field_item */
$this
->get('payment_method')
->applyDefaultValue();
$this
->get('payment_method')
->appendItem($payment_method);
return $this;
}
/**
* {@inheritdoc}
*/
public function getPaymentMethod() {
/** @var \Drupal\plugin\Plugin\Field\FieldType\PluginCollectionItemInterface $field_item */
$field_item = $this
->get('payment_method')
->first();
return $field_item ? $field_item
->getContainedPluginInstance() : NULL;
}
/**
* {@inheritdoc}
*/
public function setOwnerId($id) {
$this->owner[0]
->setValue($id);
return $this;
}
/**
* {@inheritdoc}
*/
public function setOwner(UserInterface $user) {
$this->owner[0]
->setValue($user
->id());
return $this;
}
/**
* {@inheritdoc}
*/
public function getOwnerId() {
return $this->owner[0]
->get('target_id')
->getValue();
}
/**
* {@inheritdoc}
*/
public function getOwner() {
return $this->owner[0]
->get('entity')
->getValue();
}
/**
* {@inheritdoc}
*/
public function getAmount() {
$total = 0;
foreach ($this
->getLineItems() as $line_item) {
$total = bcadd($total, $line_item
->getTotalAmount(), 6);
}
return $total;
}
/**
* {@inheritdoc}
*/
public function execute() {
if ($this
->getPaymentMethod()) {
return $this
->getPaymentMethod()
->executePayment();
}
}
/**
* {@inheritdoc}
*/
public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
$fields['bundle'] = BaseFieldDefinition::create('string')
->setLabel(t('Bundle'))
->setReadOnly(TRUE);
$fields['changed'] = BaseFieldDefinition::create('changed')
->setLabel(t('Changed'))
->setDescription(t('The time the payment was last edited.'))
->setDisplayOptions('view', array(
'type' => 'timestamp',
'weight' => 0,
))
->setDisplayConfigurable('view', TRUE);
$fields['created'] = BaseFieldDefinition::create('created')
->setLabel(t('Created'))
->setDescription(t('The time the payment was created.'))
->setDisplayOptions('view', array(
'type' => 'timestamp',
'weight' => 0,
))
->setDisplayConfigurable('view', TRUE);
$fields['currency'] = BaseFieldDefinition::create('entity_reference')
->setLabel(t('Currency'))
->setRequired(TRUE)
->setDefaultValue(0)
->setSetting('target_type', 'currency')
->setSetting('handler', 'default')
->setDisplayOptions('view', array(
'type' => 'entity_reference_label',
'weight' => 0,
))
->setDisplayConfigurable('view', TRUE);
$fields['id'] = BaseFieldDefinition::create('integer')
->setLabel(t('Payment ID'))
->setReadOnly(TRUE);
$fields['owner'] = BaseFieldDefinition::create('entity_reference')
->setLabel(t('Payer'))
->setDefaultValue(0)
->setSetting('target_type', 'user')
->setSetting('handler', 'default')
->setDefaultValueCallback(Payment::class . '::getCurrentUserId')
->setTranslatable(TRUE)
->setDisplayOptions('view', array(
'type' => 'author',
'weight' => 0,
))
->setDisplayConfigurable('view', TRUE);
$fields['line_items'] = BaseFieldDefinition::create('plugin:payment_line_item')
->setLabel(t('Line items'))
->setCardinality(BaseFieldDefinition::CARDINALITY_UNLIMITED)
->setDisplayOptions('view', array(
'type' => 'payment_line_item_overview',
'weight' => 0,
))
->setDisplayConfigurable('view', TRUE);
$fields['payment_method'] = BaseFieldDefinition::create('plugin:payment_method')
->setLabel(t('Payment method'))
->setDisplayOptions('view', array(
'type' => 'plugin_label',
'weight' => 0,
))
->setDisplayConfigurable('view', TRUE);
$fields['payment_statuses'] = BaseFieldDefinition::create('plugin:payment_status')
->setLabel(t('Payment statuses'))
->setCardinality(BaseFieldDefinition::CARDINALITY_UNLIMITED)
->setDisplayOptions('view', array(
'type' => 'payment_status_overview',
'weight' => 0,
))
->setDisplayConfigurable('view', TRUE);
$fields['payment_type'] = BaseFieldDefinition::create('plugin:payment_type')
->setLabel(t('Payment type'))
->setDisplayOptions('view', array(
'type' => 'plugin_label',
'weight' => 0,
))
->setDisplayConfigurable('view', TRUE);
$fields['uuid'] = BaseFieldDefinition::create('uuid')
->setLabel(t('Universally Unique ID'))
->setReadOnly(TRUE);
return $fields;
}
/**
* {@inheritdoc}
*/
protected function getTranslatedField($name, $langcode) {
$field_item_list = parent::getTranslatedField($name, $langcode);
$plugin_bag_field_names = [
'line_items',
'payment_method',
'payment_statuses',
'payment_type',
];
if (in_array($name, $plugin_bag_field_names)) {
foreach ($field_item_list as $field_item) {
$plugin_instance = $field_item
->get('plugin_instance')
->getValue();
if ($plugin_instance instanceof PaymentAwareInterface) {
$plugin_instance
->setPayment($this);
}
}
}
return $field_item_list;
}
/**
* Default value callback for 'owner' base field definition.
*
* @see ::baseFieldDefinitions()
*
* @return array
* An array of default values.
*/
public static function getCurrentUserId(EntityInterface $entity, FieldDefinitionInterface $field_definition) {
return array(
\Drupal::currentUser()
->id(),
);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CacheableDependencyTrait:: |
protected | property | Cache contexts. | |
CacheableDependencyTrait:: |
protected | property | Cache max-age. | |
CacheableDependencyTrait:: |
protected | property | Cache tags. | |
CacheableDependencyTrait:: |
protected | function | Sets cacheability; useful for value object constructors. | |
ContentEntityBase:: |
protected | property | Language code identifying the entity active language. | |
ContentEntityBase:: |
protected | property | Local cache for the default language code. | |
ContentEntityBase:: |
protected | property | The default langcode entity key. | |
ContentEntityBase:: |
protected | property | Whether the revision translation affected flag has been enforced. | |
ContentEntityBase:: |
protected | property | Holds untranslatable entity keys such as the ID, bundle, and revision ID. | |
ContentEntityBase:: |
protected | property | Local cache for field definitions. | |
ContentEntityBase:: |
protected | property | The array of fields, each being an instance of FieldItemListInterface. | |
ContentEntityBase:: |
protected static | property | Local cache for fields to skip from the checking for translation changes. | |
ContentEntityBase:: |
protected | property | Indicates whether this is the default revision. | |
ContentEntityBase:: |
protected | property | The language entity key. | |
ContentEntityBase:: |
protected | property | Local cache for the available language objects. | |
ContentEntityBase:: |
protected | property | The loaded revision ID before the new revision was set. | |
ContentEntityBase:: |
protected | property | Boolean indicating whether a new revision should be created on save. | |
ContentEntityBase:: |
protected | property | The revision translation affected entity key. | |
ContentEntityBase:: |
protected | property | Holds translatable entity keys such as the label. | |
ContentEntityBase:: |
protected | property | A flag indicating whether a translation object is being initialized. | |
ContentEntityBase:: |
protected | property | An array of entity translation metadata. | |
ContentEntityBase:: |
protected | property | Whether entity validation was performed. | |
ContentEntityBase:: |
protected | property | Whether entity validation is required before saving the entity. | |
ContentEntityBase:: |
protected | property | The plain data values of the contained fields. | |
ContentEntityBase:: |
public | function |
Checks data value access. Overrides EntityBase:: |
1 |
ContentEntityBase:: |
public | function |
Adds a new translation to the translatable object. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Gets the bundle of the entity. Overrides EntityBase:: |
|
ContentEntityBase:: |
public static | function |
Provides field definitions for a specific bundle. Overrides FieldableEntityInterface:: |
4 |
ContentEntityBase:: |
protected | function | Clear entity translation object cache to remove stale references. | |
ContentEntityBase:: |
public | function |
Creates a duplicate of the entity. Overrides EntityBase:: |
1 |
ContentEntityBase:: |
public | function |
Gets a field item list. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
protected | function | Gets the value of the given entity key, if defined. | 1 |
ContentEntityBase:: |
public | function |
Gets the definition of a contained field. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Gets an array of field definitions of all contained fields. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Gets an array of all field item lists. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
protected | function | Returns an array of field names to skip in ::hasTranslationChanges. | 1 |
ContentEntityBase:: |
public | function | ||
ContentEntityBase:: |
protected | function | ||
ContentEntityBase:: |
public | function |
Gets the loaded Revision ID of the entity. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Gets the revision identifier of the entity. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Gets an array of field item lists for translatable fields. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Gets a translation of the data. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Returns the languages the data is translated to. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Returns the translation status. Overrides TranslationStatusInterface:: |
|
ContentEntityBase:: |
public | function |
Returns the translatable object referring to the original language. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Determines whether the entity has a field with the given name. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Checks there is a translation for the given language code. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Determines if the current translation of the entity has unsaved changes. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Gets the identifier. Overrides EntityBase:: |
|
ContentEntityBase:: |
protected | function | Instantiates a translation object for an existing translation. | |
ContentEntityBase:: |
public | function |
Checks if this entity is the default revision. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether the translation is the default one. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks if untranslatable fields should affect only the default translation. Overrides TranslatableRevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks if this entity is the latest revision. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether this is the latest revision affecting this translation. Overrides TranslatableRevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Determines whether a new revision should be created on save. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether the translation is new. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether the current translation is affected by the current revision. Overrides TranslatableRevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks if the revision translation affected flag value has been enforced. Overrides TranslatableRevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Returns the translation support status. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether entity validation is required before saving the entity. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Gets the language of the entity. Overrides EntityBase:: |
|
ContentEntityBase:: |
public | function |
Reacts to changes to a field. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Acts on a created entity before hooks are invoked. Overrides EntityBase:: |
|
ContentEntityBase:: |
public | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase:: |
5 |
ContentEntityBase:: |
public | function |
Acts on an entity before the presave hook is invoked. Overrides EntityBase:: |
5 |
ContentEntityBase:: |
public | function |
Acts on a revision before it gets saved. Overrides RevisionableInterface:: |
2 |
ContentEntityBase:: |
public | function |
Gets a list of entities referenced by this entity. Overrides EntityBase:: |
1 |
ContentEntityBase:: |
public | function |
Removes the translation identified by the given language code. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Sets a field value. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
protected | function | Populates the local cache for the default language code. | |
ContentEntityBase:: |
public | function |
Enforces an entity to be saved as a new revision. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Marks the current revision translation as affected. Overrides TranslatableRevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Enforces the revision translation affected flag value. Overrides TranslatableRevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Sets whether entity validation is required before saving the entity. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Gets an array of all property values. Overrides EntityBase:: |
|
ContentEntityBase:: |
protected | function | Updates language for already instantiated fields. | |
ContentEntityBase:: |
public | function |
Updates the loaded Revision ID with the revision ID. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function | Updates the original values with the interim changes. | |
ContentEntityBase:: |
public | function |
Gets the entity UUID (Universally Unique Identifier). Overrides EntityBase:: |
|
ContentEntityBase:: |
public | function |
Validates the currently set values. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether the entity object was a default revision when it was saved. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function | Magic method: Implements a deep clone. | |
ContentEntityBase:: |
public | function | Implements the magic method for getting object properties. | |
ContentEntityBase:: |
public | function | Implements the magic method for isset(). | |
ContentEntityBase:: |
public | function | Implements the magic method for setting object properties. | |
ContentEntityBase:: |
public | function |
Overrides EntityBase:: |
|
ContentEntityBase:: |
public | function | Implements the magic method for unset(). | |
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 | Aliased as: traitSleep | 1 |
DependencySerializationTrait:: |
public | function | 2 | |
EntityBase:: |
protected | property | Boolean indicating whether the entity should be forced to be new. | |
EntityBase:: |
protected | property | The entity type. | |
EntityBase:: |
protected | property | A typed data object wrapping this entity. | |
EntityBase:: |
public static | function |
Constructs a new entity object, without permanently saving it. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Deletes an entity permanently. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Enforces an entity to be new. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets the entity manager. | |
EntityBase:: |
protected | function | Gets the entity type bundle info service. | |
EntityBase:: |
protected | function | Gets the entity type manager. | |
EntityBase:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
Returns the cache tags that should be used to invalidate caches. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Gets the key that is used to store configuration dependencies. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the configuration dependency name. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Gets the configuration target identifier for the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Gets the entity type definition. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the ID of the type of the entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | The list cache tags to invalidate for this entity. | |
EntityBase:: |
public | function |
Gets the original ID. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Gets a typed data object for this entity object. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Indicates if a link template exists for a given key. Overrides EntityInterface:: |
|
EntityBase:: |
protected static | function | Invalidates an entity's cache tags upon delete. | 1 |
EntityBase:: |
protected | function | Invalidates an entity's cache tags upon save. | 1 |
EntityBase:: |
public | function |
Determines whether the entity is new. Overrides EntityInterface:: |
2 |
EntityBase:: |
protected | function | Gets the language manager. | |
EntityBase:: |
public | function |
Deprecated way of generating a link to the entity. See toLink(). Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets an array link templates. | 1 |
EntityBase:: |
public static | function |
Loads an entity. Overrides EntityInterface:: |
|
EntityBase:: |
public static | function |
Loads one or more entities. Overrides EntityInterface:: |
|
EntityBase:: |
public static | function |
Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface:: |
16 |
EntityBase:: |
public static | function |
Acts on loaded entities. Overrides EntityInterface:: |
2 |
EntityBase:: |
public static | function |
Changes the values of an entity before it is created. Overrides EntityInterface:: |
5 |
EntityBase:: |
public static | function |
Acts on entities before they are deleted and before hooks are invoked. Overrides EntityInterface:: |
4 |
EntityBase:: |
public | function |
Saves an entity permanently. Overrides EntityInterface:: |
3 |
EntityBase:: |
public | function |
Sets the original ID. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Generates the HTML for a link to this entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Gets a list of URI relationships supported by this entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the public URL for this entity. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets an array of placeholders for this entity. | 2 |
EntityBase:: |
protected | function | Gets the UUID generator. | |
EntityChangedTrait:: |
public | function | Gets the timestamp of the last entity change for the current translation. | |
EntityChangedTrait:: |
public | function | Sets the timestamp of the last entity change for the current translation. | |
EntityChangesDetectionTrait:: |
protected | function | Returns an array of field names to skip when checking for changes. Aliased as: traitGetFieldsToSkipFromTranslationChangesCheck | |
Payment:: |
public static | function |
Provides base field definitions for an entity type. Overrides ContentEntityBase:: |
|
Payment:: |
public | function |
Executes the payment. Overrides PaymentInterface:: |
|
Payment:: |
public | function |
Gets the line items' total amount. Overrides LineItemCollectionInterface:: |
|
Payment:: |
public | function |
Returns the timestamp of the last entity change across all translations. Overrides EntityChangedTrait:: |
|
Payment:: |
public | function |
Returns the timestamp of the entity creation. Overrides PaymentInterface:: |
|
Payment:: |
public | function |
Gets the line items' currency. Overrides PaymentInterface:: |
|
Payment:: |
public | function |
Gets the line items' ISO 4217 currency code. Overrides LineItemCollectionInterface:: |
|
Payment:: |
public static | function | Default value callback for 'owner' base field definition. | |
Payment:: |
public | function |
Gets a line item. Overrides LineItemCollectionInterface:: |
|
Payment:: |
public | function |
Gets all line items. Overrides LineItemCollectionInterface:: |
|
Payment:: |
public | function |
Gets line items by plugin type. Overrides LineItemCollectionInterface:: |
|
Payment:: |
public | function |
Returns the entity owner's user entity. Overrides EntityOwnerInterface:: |
|
Payment:: |
public | function |
Returns the entity owner's user ID. Overrides EntityOwnerInterface:: |
|
Payment:: |
public | function |
Gets the payment method plugin. Overrides PaymentInterface:: |
|
Payment:: |
public | function |
Gets the current payment status. Overrides PaymentInterface:: |
|
Payment:: |
public | function |
Gets all payment statuses. Overrides PaymentInterface:: |
|
Payment:: |
public | function |
Gets the payment's type plugin. Overrides PaymentInterface:: |
|
Payment:: |
protected | function |
Gets a translated field. Overrides ContentEntityBase:: |
|
Payment:: |
public | function |
Gets the label of the entity. Overrides ContentEntityBase:: |
|
Payment:: |
public | function |
Sets the line items' ISO 4217 currency code. Overrides LineItemCollectionInterface:: |
|
Payment:: |
public | function |
Sets a line item. Overrides LineItemCollectionInterface:: |
|
Payment:: |
public | function |
Sets line items. Overrides LineItemCollectionInterface:: |
|
Payment:: |
public | function |
Sets the entity owner's user entity. Overrides EntityOwnerInterface:: |
|
Payment:: |
public | function |
Sets the entity owner's user ID. Overrides EntityOwnerInterface:: |
|
Payment:: |
public | function |
Gets the payment method plugin. Overrides PaymentInterface:: |
|
Payment:: |
public | function |
Sets a status. Overrides PaymentInterface:: |
|
Payment:: |
public | function |
Sets/replaces all statuses without notifications. Overrides PaymentInterface:: |
|
Payment:: |
public | function |
Unsets a line item. Overrides LineItemCollectionInterface:: |
|
Payment:: |
public | function |
Constructs an Entity object. Overrides ContentEntityBase:: |
|
RefinableCacheableDependencyTrait:: |
public | function | 1 | |
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
protected | property | Whether this entity is being created, updated or deleted through a synchronization process. | |
SynchronizableEntityTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
public | function | ||
TranslationStatusInterface:: |
constant | Status code identifying a newly created translation. | ||
TranslationStatusInterface:: |
constant | Status code identifying an existing translation. | ||
TranslationStatusInterface:: |
constant | Status code identifying a removed translation. |