class Store in Commerce Core 8.2
Same name in this branch
- 8.2 modules/store/src/Entity/Store.php \Drupal\commerce_store\Entity\Store
- 8.2 modules/store/src/Plugin/views/field/Store.php \Drupal\commerce_store\Plugin\views\field\Store
Defines the store entity class.
Plugin annotation
@ContentEntityType(
id = "commerce_store",
label = @Translation("Store", context = "Commerce"),
label_collection = @Translation("Stores", context = "Commerce"),
label_singular = @Translation("store", context = "Commerce"),
label_plural = @Translation("stores", context = "Commerce"),
label_count = @PluralTranslation(
singular = "@count store",
plural = "@count stores",
context = "Commerce",
),
bundle_label = @Translation("Store type", context = "Commerce"),
handlers = {
"event" = "Drupal\commerce_store\Event\StoreEvent",
"storage" = "Drupal\commerce_store\StoreStorage",
"access" = "Drupal\entity\EntityAccessControlHandler",
"query_access" = "Drupal\entity\QueryAccess\QueryAccessHandler",
"permission_provider" = "Drupal\entity\EntityPermissionProvider",
"view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
"list_builder" = "Drupal\commerce_store\StoreListBuilder",
"views_data" = "Drupal\commerce\CommerceEntityViewsData",
"form" = {
"default" = "Drupal\commerce_store\Form\StoreForm",
"add" = "Drupal\commerce_store\Form\StoreForm",
"edit" = "Drupal\commerce_store\Form\StoreForm",
"duplicate" = "Drupal\commerce_store\Form\StoreForm",
"delete" = "Drupal\Core\Entity\ContentEntityDeleteForm"
},
"local_task_provider" = {
"default" = "Drupal\entity\Menu\DefaultEntityLocalTaskProvider",
},
"route_provider" = {
"default" = "Drupal\entity\Routing\AdminHtmlRouteProvider",
"delete-multiple" = "Drupal\entity\Routing\DeleteMultipleRouteProvider",
},
"translation" = "Drupal\content_translation\ContentTranslationHandler"
},
base_table = "commerce_store",
data_table = "commerce_store_field_data",
admin_permission = "administer commerce_store",
permission_granularity = "bundle",
translatable = TRUE,
entity_keys = {
"id" = "store_id",
"uuid" = "uuid",
"bundle" = "type",
"label" = "name",
"langcode" = "langcode",
"owner" = "uid",
"uid" = "uid",
},
links = {
"canonical" = "/store/{commerce_store}",
"add-page" = "/store/add",
"add-form" = "/store/add/{commerce_store_type}",
"edit-form" = "/store/{commerce_store}/edit",
"duplicate-form" = "/store/{commerce_store}/duplicate",
"delete-form" = "/store/{commerce_store}/delete",
"delete-multiple-form" = "/admin/commerce/config/stores/delete",
"collection" = "/admin/commerce/config/stores",
},
bundle_entity_type = "commerce_store_type",
field_ui_base_route = "entity.commerce_store_type.edit_form",
)
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\commerce_store\Entity\Store implements StoreInterface uses EntityOwnerTrait
- class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, ContentEntityInterface, TranslationStatusInterface uses EntityChangesDetectionTrait, SynchronizableEntityTrait
Expanded class hierarchy of Store
8 files declare their use of Store
- CanadianSalesTaxTest.php in modules/
tax/ tests/ src/ Kernel/ Plugin/ Commerce/ TaxType/ CanadianSalesTaxTest.php - commerce_store.install in modules/
store/ commerce_store.install - Contains install and update functions for commerce_store module.
- CustomTest.php in modules/
tax/ tests/ src/ Kernel/ Plugin/ Commerce/ TaxType/ CustomTest.php - EuropeanUnionVatTest.php in modules/
tax/ tests/ src/ Kernel/ Plugin/ Commerce/ TaxType/ EuropeanUnionVatTest.php - StoreCreationTrait.php in modules/
store/ src/ StoreCreationTrait.php
8 string references to 'Store'
- commerce.links.menu.yml in ./
commerce.links.menu.yml - commerce.links.menu.yml
- commerce.routing.yml in ./
commerce.routing.yml - commerce.routing.yml
- commerce_order.schema.yml in modules/
order/ config/ schema/ commerce_order.schema.yml - modules/order/config/schema/commerce_order.schema.yml
- OrderAddForm::buildForm in modules/
order/ src/ Form/ OrderAddForm.php - Form constructor.
- OrderForm::form in modules/
order/ src/ Form/ OrderForm.php - Gets the actual form array to be built.
File
- modules/
store/ src/ Entity/ Store.php, line 83
Namespace
Drupal\commerce_store\EntityView source
class Store extends ContentEntityBase implements StoreInterface {
use EntityOwnerTrait;
/**
* {@inheritdoc}
*/
public function getName() {
return $this
->get('name')->value;
}
/**
* {@inheritdoc}
*/
public function setName($name) {
$this
->set('name', $name);
return $this;
}
/**
* {@inheritdoc}
*/
public function getEmail() {
return $this
->get('mail')->value;
}
/**
* {@inheritdoc}
*/
public function setEmail($mail) {
$this
->set('mail', $mail);
return $this;
}
/**
* {@inheritdoc}
*/
public function getDefaultCurrency() {
return $this
->get('default_currency')->entity;
}
/**
* {@inheritdoc}
*/
public function setDefaultCurrency(CurrencyInterface $currency) {
$this
->set('default_currency', $currency
->getCurrencyCode());
return $this;
}
/**
* {@inheritdoc}
*/
public function getDefaultCurrencyCode() {
return $this
->get('default_currency')->target_id;
}
/**
* {@inheritdoc}
*/
public function setDefaultCurrencyCode($currency_code) {
$this
->set('default_currency', $currency_code);
return $this;
}
/**
* {@inheritdoc}
*/
public function getTimezone() {
return $this
->get('timezone')->value;
}
/**
* {@inheritdoc}
*/
public function setTimezone($timezone) {
$this
->set('timezone', $timezone);
return $this;
}
/**
* {@inheritdoc}
*/
public function getAddress() {
return $this
->get('address')
->first();
}
/**
* {@inheritdoc}
*/
public function setAddress(AddressInterface $address) {
// $this->set('address', $address) results in the address being appended
// to the item list, instead of replacing the existing first item.
$this->address = $address;
return $this;
}
/**
* {@inheritdoc}
*/
public function getBillingCountries() {
$countries = [];
foreach ($this
->get('billing_countries') as $countryItem) {
$countries[] = $countryItem->value;
}
return $countries;
}
/**
* {@inheritdoc}
*/
public function setBillingCountries(array $countries) {
$this
->set('billing_countries', $countries);
return $this;
}
/**
* {@inheritdoc}
*/
public function isDefault() {
return (bool) $this
->get('is_default')->value;
}
/**
* {@inheritdoc}
*/
public function setDefault($is_default) {
$this
->set('is_default', (bool) $is_default);
return $this;
}
/**
* {@inheritdoc}
*/
public function preSave(EntityStorageInterface $storage) {
parent::preSave($storage);
foreach (array_keys($this
->getTranslationLanguages()) as $langcode) {
$translation = $this
->getTranslation($langcode);
// Explicitly set the owner ID to 0 if the translation owner is anonymous
// (This will ensure we don't store a broken reference in case the user
// no longer exists).
if ($translation
->getOwner()
->isAnonymous()) {
$translation
->setOwnerId(0);
}
}
}
/**
* {@inheritdoc}
*/
public function postSave(EntityStorageInterface $storage, $update = TRUE) {
/** @var \Drupal\commerce_store\StoreStorage $storage */
parent::postSave($storage, $update);
$default = $this
->isDefault();
$original_default = $this->original ? $this->original
->isDefault() : FALSE;
if ($default && !$original_default) {
// The store was set as default, remove the flag from other stores.
$store_ids = $storage
->getQuery()
->condition('store_id', $this
->id(), '<>')
->condition('is_default', TRUE)
->accessCheck(FALSE)
->execute();
foreach ($store_ids as $store_id) {
/** @var \Drupal\commerce_store\Entity\StoreInterface $store */
$store = $storage
->load($store_id);
$store
->setDefault(FALSE);
$store
->save();
}
}
}
/**
* {@inheritdoc}
*/
public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
$fields = parent::baseFieldDefinitions($entity_type);
$fields += static::ownerBaseFieldDefinitions($entity_type);
$fields['type'] = BaseFieldDefinition::create('entity_reference')
->setLabel(t('Type'))
->setDescription(t('The store type.'))
->setSetting('target_type', 'commerce_store_type')
->setReadOnly(TRUE);
$fields['uid']
->setLabel(t('Owner'))
->setDescription(t('The store owner.'))
->setDisplayConfigurable('view', TRUE)
->setDisplayConfigurable('form', TRUE);
$fields['name'] = BaseFieldDefinition::create('string')
->setLabel(t('Name'))
->setDescription(t('The store name.'))
->setRequired(TRUE)
->setTranslatable(TRUE)
->setSettings([
'default_value' => '',
'max_length' => 255,
])
->setDisplayOptions('form', [
'type' => 'string_textfield',
'weight' => 0,
])
->setDisplayConfigurable('view', TRUE)
->setDisplayConfigurable('form', TRUE);
$fields['mail'] = BaseFieldDefinition::create('email')
->setLabel(t('Email'))
->setDescription(t('Store email notifications are sent from this address.'))
->setRequired(TRUE)
->setDisplayOptions('form', [
'type' => 'email_default',
'weight' => 1,
])
->setSetting('display_description', TRUE)
->setDisplayConfigurable('view', TRUE)
->setDisplayConfigurable('form', TRUE);
$fields['default_currency'] = BaseFieldDefinition::create('entity_reference')
->setLabel(t('Default currency'))
->setDescription(t('The default currency of the store.'))
->setCardinality(1)
->setRequired(TRUE)
->setSetting('target_type', 'commerce_currency')
->setSetting('handler', 'default')
->setTranslatable(TRUE)
->setDisplayOptions('form', [
'type' => 'options_select',
'weight' => 2,
])
->setDisplayConfigurable('view', TRUE)
->setDisplayConfigurable('form', TRUE);
$fields['timezone'] = BaseFieldDefinition::create('list_string')
->setLabel(t('Timezone'))
->setDescription(t('Used when determining promotion and tax availability.'))
->setCardinality(1)
->setRequired(TRUE)
->setDefaultValueCallback('Drupal\\commerce_store\\Entity\\Store::getSiteTimezone')
->setSetting('allowed_values_function', [
'\\Drupal\\commerce_store\\Entity\\Store',
'getTimezones',
])
->setDisplayOptions('form', [
'type' => 'options_select',
'weight' => 3,
])
->setSetting('display_description', TRUE)
->setDisplayConfigurable('view', TRUE)
->setDisplayConfigurable('form', TRUE);
$fields['address'] = BaseFieldDefinition::create('address')
->setLabel(t('Address'))
->setDescription(t('The store address.'))
->setCardinality(1)
->setRequired(TRUE)
->setSetting('field_overrides', [
AddressField::GIVEN_NAME => [
'override' => FieldOverride::HIDDEN,
],
AddressField::ADDITIONAL_NAME => [
'override' => FieldOverride::HIDDEN,
],
AddressField::FAMILY_NAME => [
'override' => FieldOverride::HIDDEN,
],
AddressField::ORGANIZATION => [
'override' => FieldOverride::HIDDEN,
],
])
->setDisplayOptions('form', [
'type' => 'address_default',
'weight' => 4,
])
->setDisplayConfigurable('view', TRUE)
->setDisplayConfigurable('form', TRUE);
$fields['billing_countries'] = BaseFieldDefinition::create('list_string')
->setLabel(t('Supported billing countries'))
->setCardinality(BaseFieldDefinition::CARDINALITY_UNLIMITED)
->setSetting('allowed_values_function', [
'\\Drupal\\commerce_store\\Entity\\Store',
'getAvailableCountries',
])
->setDisplayOptions('form', [
'type' => 'options_select',
'weight' => 5,
])
->setDisplayConfigurable('view', TRUE)
->setDisplayConfigurable('form', TRUE);
$fields['path'] = BaseFieldDefinition::create('path')
->setLabel(t('URL alias'))
->setDescription(t('The store URL alias.'))
->setTranslatable(TRUE)
->setDisplayOptions('form', [
'type' => 'path',
'weight' => 30,
])
->setDisplayConfigurable('form', TRUE)
->setCustomStorage(TRUE);
// 'default' is a reserved SQL word, hence the 'is_' prefix.
$fields['is_default'] = BaseFieldDefinition::create('boolean')
->setLabel(t('Default'))
->setDescription(t('Whether this is the default store.'))
->setDefaultValue(FALSE)
->setDisplayOptions('form', [
'type' => 'boolean_checkbox',
'settings' => [
'display_label' => TRUE,
],
'weight' => 90,
])
->setDisplayConfigurable('view', TRUE)
->setDisplayConfigurable('form', TRUE);
return $fields;
}
/**
* Default value callback for the 'timezone' base field definition.
*
* @see ::baseFieldDefinitions()
*
* @return array
* An array of default values.
*/
public static function getSiteTimezone() {
$site_timezone = \Drupal::config('system.date')
->get('timezone.default');
if (empty($site_timezone)) {
$site_timezone = @date_default_timezone_get();
}
return [
$site_timezone,
];
}
/**
* Gets the allowed values for the 'timezone' base field.
*
* @return array
* The allowed values.
*/
public static function getTimezones() {
return system_time_zones(NULL, TRUE);
}
/**
* Gets the allowed values for the 'billing_countries' base field.
*
* @return array
* The allowed values.
*/
public static function getAvailableCountries() {
return \Drupal::service('address.country_repository')
->getList();
}
}
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:: |
protected | function | Gets a translated field. | |
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 label of the entity. Overrides EntityBase:: |
2 |
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 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 |
Constructs an Entity object. Overrides EntityBase:: |
|
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. | |
EntityChangesDetectionTrait:: |
protected | function | Returns an array of field names to skip when checking for changes. Aliased as: traitGetFieldsToSkipFromTranslationChangesCheck | |
EntityOwnerTrait:: |
public static | function | Default value callback for 'owner' base field. | 1 |
EntityOwnerTrait:: |
public | function |
Overrides EntityOwnerTrait:: |
|
EntityOwnerTrait:: |
public | function | ||
EntityOwnerTrait:: |
public static | function | Returns an array of base field definitions for entity owners. | |
EntityOwnerTrait:: |
public | function | ||
EntityOwnerTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | 1 | |
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
Store:: |
public static | function |
Provides base field definitions for an entity type. Overrides ContentEntityBase:: |
|
Store:: |
public | function |
Gets the store address. Overrides StoreInterface:: |
|
Store:: |
public static | function | Gets the allowed values for the 'billing_countries' base field. | |
Store:: |
public | function |
Gets the store billing countries. Overrides StoreInterface:: |
|
Store:: |
public | function |
Gets the default store currency. Overrides StoreInterface:: |
|
Store:: |
public | function |
Gets the default store currency code. Overrides StoreInterface:: |
|
Store:: |
public | function |
Gets the store email. Overrides StoreInterface:: |
|
Store:: |
public | function |
Gets the store name. Overrides StoreInterface:: |
|
Store:: |
public static | function | Default value callback for the 'timezone' base field definition. | |
Store:: |
public | function |
Gets the store timezone. Overrides StoreInterface:: |
|
Store:: |
public static | function | Gets the allowed values for the 'timezone' base field. | |
Store:: |
public | function |
Gets whether this is the default store. Overrides StoreInterface:: |
|
Store:: |
public | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides ContentEntityBase:: |
|
Store:: |
public | function |
Acts on an entity before the presave hook is invoked. Overrides ContentEntityBase:: |
|
Store:: |
public | function |
Sets the store address. Overrides StoreInterface:: |
|
Store:: |
public | function |
Sets the store billing countries. Overrides StoreInterface:: |
|
Store:: |
public | function |
Sets whether this is the default store. Overrides StoreInterface:: |
|
Store:: |
public | function |
Sets the default store currency. Overrides StoreInterface:: |
|
Store:: |
public | function |
Sets the default store currency code. Overrides StoreInterface:: |
|
Store:: |
public | function |
Sets the store email. Overrides StoreInterface:: |
|
Store:: |
public | function |
Sets the store name. Overrides StoreInterface:: |
|
Store:: |
public | function |
Sets the store timezone. Overrides StoreInterface:: |
|
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. |