class Subscriber in Simplenews 8.2
Same name in this branch
- 8.2 src/Entity/Subscriber.php \Drupal\simplenews\Entity\Subscriber
- 8.2 src/Plugin/migrate/source/d7/Subscriber.php \Drupal\simplenews\Plugin\migrate\source\d7\Subscriber
Same name and namespace in other branches
- 8 src/Entity/Subscriber.php \Drupal\simplenews\Entity\Subscriber
- 3.x src/Entity/Subscriber.php \Drupal\simplenews\Entity\Subscriber
Defines the simplenews subscriber entity.
Plugin annotation
@ContentEntityType(
id = "simplenews_subscriber",
label = @Translation("Simplenews subscriber"),
handlers = {
"storage" = "Drupal\simplenews\Subscription\SubscriptionStorage",
"access" = "Drupal\simplenews\SubscriberAccessControlHandler",
"form" = {
"add" = "Drupal\simplenews\Form\SubscriberForm",
"default" = "Drupal\simplenews\Form\SubscriberForm",
"account" = "Drupal\simplenews\Form\SubscriptionsAccountForm",
"block" = "Drupal\simplenews\Form\SubscriptionsBlockForm",
"page" = "Drupal\simplenews\Form\SubscriptionsPageForm",
"delete" = "Drupal\simplenews\Form\SubscriberDeleteForm",
},
"view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
"list_builder" = "Drupal\Core\Entity\EntityListBuilder",
"views_data" = "Drupal\simplenews\SubscriberViewsData"
},
base_table = "simplenews_subscriber",
entity_keys = {
"id" = "id",
"label" = "mail"
},
field_ui_base_route = "simplenews.settings_subscriber",
admin_permission = "administer simplenews subscriptions",
links = {
"edit-form" = "/admin/people/simplenews/edit/{simplenews_subscriber}",
"delete-form" = "/admin/people/simplenews/delete/{simplenews_subscriber}",
},
token_type = "simplenews-subscriber"
)
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\simplenews\Entity\Subscriber implements SubscriberInterface
- class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, ContentEntityInterface, TranslationStatusInterface uses EntityChangesDetectionTrait, SynchronizableEntityTrait
Expanded class hierarchy of Subscriber
20 files declare their use of Subscriber
- ConfirmationController.php in src/
Controller/ ConfirmationController.php - Mailer.php in src/
Mail/ Mailer.php - simplenews.api.php in ./
simplenews.api.php - Hooks provided by the Simplenews module.
- simplenews.module in ./
simplenews.module - Simplenews node handling, sent email, newsletter block and general hooks.
- SimplenewsAdministrationTest.php in tests/
src/ Functional/ SimplenewsAdministrationTest.php
2 string references to 'Subscriber'
File
- src/
Entity/ Subscriber.php, line 50
Namespace
Drupal\simplenews\EntityView source
class Subscriber extends ContentEntityBase implements SubscriberInterface {
/**
* Whether currently copying field values to corresponding User.
*
* @var bool
*/
protected static $syncing;
/**
* {@inheritdoc}
*/
public function getMessage() {
return $this
->get('message')->value;
}
/**
* {@inheritdoc}
*/
public function setMessage($message) {
$this
->set('message', $message);
}
/**
* {@inheritdoc}
*/
public function getStatus() {
return $this
->get('status')->value == SubscriberInterface::ACTIVE;
}
/**
* {@inheritdoc}
*/
public function setStatus($status) {
$this
->set('status', $status ? SubscriberInterface::ACTIVE : SubscriberInterface::INACTIVE);
}
/**
* {@inheritdoc}
*/
public function getMail() {
return $this
->get('mail')->value;
}
/**
* {@inheritdoc}
*/
public function setMail($mail) {
$this
->set('mail', $mail);
}
/**
* {@inheritdoc}
*/
public function getUserId() {
return $this
->get('uid')->target_id;
}
/**
* {@inheritdoc}
*/
public function getUser() {
$uid = $this
->getUserId();
if ($uid && ($user = User::load($uid))) {
return $user;
}
elseif ($mail = $this
->getMail()) {
return user_load_by_mail($mail) ?: NULL;
}
else {
return NULL;
}
}
/**
* {@inheritdoc}
*/
public function getLangcode() {
return $this
->get('langcode')->value;
}
/**
* {@inheritdoc}
*/
public function setLangcode($langcode) {
$this
->set('langcode', $langcode);
}
/**
* {@inheritdoc}
*/
public function fillFromAccount(AccountInterface $account) {
if (static::$syncing) {
return $this;
}
static::$syncing = TRUE;
$this
->set('uid', $account
->id());
$this
->setMail($account
->getEmail());
$this
->setLangcode($account
->getPreferredLangcode());
$this
->setStatus($account
->isActive());
// Copy values for shared fields to existing subscriber.
foreach ($this
->getUserSharedFields($account) as $field_name) {
$this
->set($field_name, $account
->get($field_name)
->getValue());
}
static::$syncing = FALSE;
return $this;
}
/**
* {@inheritdoc}
*/
public function copyToAccount(AccountInterface $account) {
// Copy values for shared fields to existing user.
if (!static::$syncing && ($fields = $this
->getUserSharedFields($account))) {
static::$syncing = TRUE;
foreach ($fields as $field_name) {
$account
->set($field_name, $this
->get($field_name)
->getValue());
}
if (!$account
->isNew()) {
$account
->save();
}
static::$syncing = FALSE;
}
}
/**
* {@inheritdoc}
*/
public function getChanges() {
return unserialize($this
->get('changes')->value);
}
/**
* {@inheritdoc}
*/
public function setChanges($changes) {
$this
->set('changes', serialize($changes));
}
/**
* {@inheritdoc}
*/
public function isSubscribed($newsletter_id) {
foreach ($this->subscriptions as $item) {
if ($item->target_id == $newsletter_id) {
return $item->status == SIMPLENEWS_SUBSCRIPTION_STATUS_SUBSCRIBED;
}
}
return FALSE;
}
/**
* {@inheritdoc}
*/
public function isUnsubscribed($newsletter_id) {
foreach ($this->subscriptions as $item) {
if ($item->target_id == $newsletter_id) {
return $item->status == SIMPLENEWS_SUBSCRIPTION_STATUS_UNSUBSCRIBED;
}
}
return FALSE;
}
/**
* {@inheritdoc}
*/
public function getSubscription($newsletter_id) {
foreach ($this->subscriptions as $item) {
if ($item->target_id == $newsletter_id) {
return $item;
}
}
return FALSE;
}
/**
* {@inheritdoc}
*/
public function getSubscribedNewsletterIds() {
$ids = [];
foreach ($this->subscriptions as $item) {
if ($item->status == SIMPLENEWS_SUBSCRIPTION_STATUS_SUBSCRIBED) {
$ids[] = $item->target_id;
}
}
return $ids;
}
/**
* {@inheritdoc}
*/
public function subscribe($newsletter_id, $status = SIMPLENEWS_SUBSCRIPTION_STATUS_SUBSCRIBED, $source = 'unknown', $timestamp = REQUEST_TIME) {
if ($subscription = $this
->getSubscription($newsletter_id)) {
$subscription->status = $status;
}
else {
$data = [
'target_id' => $newsletter_id,
'status' => $status,
'source' => $source,
'timestamp' => $timestamp,
];
$this->subscriptions
->appendItem($data);
}
if ($status == SIMPLENEWS_SUBSCRIPTION_STATUS_SUBSCRIBED) {
\Drupal::moduleHandler()
->invokeAll('simplenews_subscribe', [
$this,
$newsletter_id,
]);
}
}
/**
* {@inheritdoc}
*/
public function unsubscribe($newsletter_id, $source = 'unknown', $timestamp = REQUEST_TIME) {
if ($subscription = $this
->getSubscription($newsletter_id)) {
$subscription->status = SIMPLENEWS_SUBSCRIPTION_STATUS_UNSUBSCRIBED;
}
else {
$data = [
'target_id' => $newsletter_id,
'status' => SIMPLENEWS_SUBSCRIPTION_STATUS_UNSUBSCRIBED,
'source' => $source,
'timestamp' => $timestamp,
];
$this->subscriptions
->appendItem($data);
}
// Clear eventually existing mail spool rows for this subscriber.
\Drupal::service('simplenews.spool_storage')
->deleteMails([
'snid' => $this
->id(),
'newsletter_id' => $newsletter_id,
]);
\Drupal::moduleHandler()
->invokeAll('simplenews_unsubscribe', [
$this,
$newsletter_id,
]);
}
/**
* {@inheritdoc}
*/
public function postSave(EntityStorageInterface $storage, $update = TRUE) {
parent::postSave($storage, $update);
// Copy values for shared fields to existing user.
if ($user = $this
->getUser()) {
$this
->copyToAccount($user);
}
}
/**
* {@inheritdoc}
*/
public function postCreate(EntityStorageInterface $storage) {
parent::postCreate($storage);
// Fill from a User account with matching uid or email.
if ($user = $this
->getUser()) {
$this
->fillFromAccount($user);
}
}
/**
* Identifies configurable fields shared with a user.
*
* @param \Drupal\user\UserInterface $user
* The user to match fields against.
*
* @return string[]
* An indexed array of the names of each field for which there is also a
* field on the given user with the same name and type.
*/
protected function getUserSharedFields(UserInterface $user) {
$field_names = [];
if (\Drupal::config('simplenews.settings')
->get('subscriber.sync_fields')) {
// Find any fields sharing name and type.
foreach ($this
->getFieldDefinitions() as $field_definition) {
/** @var \Drupal\Core\Field\FieldDefinitionInterface $field_definition */
$field_name = $field_definition
->getName();
$user_field = $user
->getFieldDefinition($field_name);
if ($field_definition
->getTargetBundle() && isset($user_field) && $user_field
->getType() == $field_definition
->getType()) {
$field_names[] = $field_name;
}
}
}
return $field_names;
}
/**
* {@inheritdoc}
*/
public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
$fields['id'] = BaseFieldDefinition::create('integer')
->setLabel(t('Subscriber ID'))
->setDescription(t('Primary key: Unique subscriber ID.'))
->setReadOnly(TRUE)
->setSetting('unsigned', TRUE);
$fields['uuid'] = BaseFieldDefinition::create('uuid')
->setLabel(t('UUID'))
->setDescription(t('The subscriber UUID.'))
->setReadOnly(TRUE);
$fields['status'] = BaseFieldDefinition::create('boolean')
->setLabel(t('Status'))
->setDescription(t('Boolean indicating the status of the subscriber.'))
->setDefaultValue(TRUE);
$fields['mail'] = BaseFieldDefinition::create('email')
->setLabel(t('Email'))
->setDescription(t("The subscriber's email address."))
->setSetting('default_value', '')
->setRequired(TRUE)
->setDisplayOptions('form', [
'type' => 'email_default',
'settings' => [],
])
->setDisplayConfigurable('form', TRUE);
$fields['uid'] = BaseFieldDefinition::create('entity_reference')
->setLabel(t('User'))
->setDescription(t('The corresponding user.'))
->setSetting('target_type', 'user')
->setSetting('handler', 'default');
$fields['langcode'] = BaseFieldDefinition::create('language')
->setLabel(t('Language'))
->setDescription(t("The subscriber's preferred language."));
$fields['changes'] = BaseFieldDefinition::create('string_long')
->setLabel(t('Changes'))
->setDescription(t('Contains the requested subscription changes.'));
$fields['created'] = BaseFieldDefinition::create('created')
->setLabel(t('Created'))
->setDescription(t('The time that the subscriber was created.'));
$fields['subscriptions'] = BaseFieldDefinition::create('simplenews_subscription')
->setCardinality(FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED)
->setLabel(t('Subscriptions'))
->setSetting('target_type', 'simplenews_newsletter')
->setDisplayOptions('form', [
'type' => 'simplenews_subscription_select',
'weight' => '0',
'settings' => [],
'third_party_settings' => [],
]);
return $fields;
}
/**
* {@inheritdoc}
*/
public static function loadByMail($mail, $create = FALSE, $default_langcode = NULL) {
$subscriber = FALSE;
if ($mail) {
$subscribers = \Drupal::entityTypeManager()
->getStorage('simplenews_subscriber')
->loadByProperties([
'mail' => $mail,
]);
$subscriber = reset($subscribers);
}
if ($create && !$subscriber) {
$subscriber = static::create([
'mail' => $mail,
]);
if ($default_langcode) {
$subscriber
->setLangcode($default_langcode);
}
}
return $subscriber;
}
/**
* {@inheritdoc}
*/
public static function loadByUid($uid, $create = FALSE) {
$subscriber = FALSE;
if ($uid) {
$subscribers = \Drupal::entityTypeManager()
->getStorage('simplenews_subscriber')
->loadByProperties([
'uid' => $uid,
]);
$subscriber = reset($subscribers);
}
if ($create && !$subscriber) {
$subscriber = static::create([
'uid' => $uid,
]);
}
return $subscriber;
}
}
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 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 |
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 | |
RefinableCacheableDependencyTrait:: |
public | function | 1 | |
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
Subscriber:: |
protected static | property | Whether currently copying field values to corresponding User. | |
Subscriber:: |
public static | function |
Provides base field definitions for an entity type. Overrides ContentEntityBase:: |
|
Subscriber:: |
public | function |
Copy values to a user account. Overrides SubscriberInterface:: |
|
Subscriber:: |
public | function |
Fill values from a user account. Overrides SubscriberInterface:: |
|
Subscriber:: |
public | function |
Returns the changes. Overrides SubscriberInterface:: |
|
Subscriber:: |
public | function |
Returns the lang code. Overrides SubscriberInterface:: |
|
Subscriber:: |
public | function |
Returns the subscribers email address. Overrides SubscriberInterface:: |
|
Subscriber:: |
public | function | ||
Subscriber:: |
public | function |
Returns if the subscriber is active or not. Overrides SubscriberInterface:: |
|
Subscriber:: |
public | function |
Get the ids of all subscribed newsletters. Overrides SubscriberInterface:: |
|
Subscriber:: |
public | function |
Returns the subscription to a given newsletter.. Overrides SubscriberInterface:: |
|
Subscriber:: |
public | function |
Returns corresponding User object, if any. Overrides SubscriberInterface:: |
|
Subscriber:: |
public | function |
Returns corresponding user ID. Overrides SubscriberInterface:: |
|
Subscriber:: |
protected | function | Identifies configurable fields shared with a user. | |
Subscriber:: |
public | function |
Check if the subscriber has an active subscription to a certain newsletter. Overrides SubscriberInterface:: |
|
Subscriber:: |
public | function |
Check if the subscriber has an inactive subscription to a given newsletter. Overrides SubscriberInterface:: |
|
Subscriber:: |
public static | function |
Load a simplenews newsletter subscriber object by mail. Overrides SubscriberInterface:: |
|
Subscriber:: |
public static | function |
Load a simplenews newsletter subscriber object by uid. Overrides SubscriberInterface:: |
|
Subscriber:: |
public | function |
Acts on a created entity before hooks are invoked. Overrides ContentEntityBase:: |
|
Subscriber:: |
public | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides ContentEntityBase:: |
|
Subscriber:: |
public | function |
Sets the changes. Overrides SubscriberInterface:: |
|
Subscriber:: |
public | function |
Sets the lang code. Overrides SubscriberInterface:: |
|
Subscriber:: |
public | function |
Sets the subscribers email address. Overrides SubscriberInterface:: |
|
Subscriber:: |
public | function | ||
Subscriber:: |
public | function |
Sets the status of the subscriber. Overrides SubscriberInterface:: |
|
Subscriber:: |
public | function |
Add a subscription to a certain newsletter to the subscriber. Overrides SubscriberInterface:: |
|
Subscriber:: |
public | function |
Delete a subscription to a certain newsletter of the subscriber. Overrides SubscriberInterface:: |
|
SubscriberInterface:: |
constant | Subscriber is active. | ||
SubscriberInterface:: |
constant | Subscriber is inactive. | ||
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. |