class SmsMessageResult in SMS Framework 8
Same name in this branch
- 8 src/Message/SmsMessageResult.php \Drupal\sms\Message\SmsMessageResult
- 8 src/Entity/SmsMessageResult.php \Drupal\sms\Entity\SmsMessageResult
Same name and namespace in other branches
- 2.x src/Entity/SmsMessageResult.php \Drupal\sms\Entity\SmsMessageResult
- 2.1.x src/Entity/SmsMessageResult.php \Drupal\sms\Entity\SmsMessageResult
Defines the SMS message result entity.
The SMS message result entity is used to store SMS message results.
Plugin annotation
@ContentEntityType(
id = "sms_result",
label = @Translation("SMS Message Result"),
label_collection = @Translation("SMS Message Results"),
label_singular = @Translation("SMS message result"),
label_plural = @Translation("SMS message results"),
label_count = @PluralTranslation(
singular = "@count SMS message result",
plural = "@count SMS message results",
),
base_table = "sms_result",
entity_keys = {
"id" = "id",
"uuid" = "uuid",
},
)
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\sms\Entity\SmsMessageResult implements SmsMessageResultInterface
- class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, ContentEntityInterface, TranslationStatusInterface uses EntityChangesDetectionTrait, SynchronizableEntityTrait
Expanded class hierarchy of SmsMessageResult
3 files declare their use of SmsMessageResult
- SmsFrameworkMessageEntityTest.php in tests/
src/ Kernel/ SmsFrameworkMessageEntityTest.php - SmsFrameworkMessageResultEntityTest.php in tests/
src/ Kernel/ SmsFrameworkMessageResultEntityTest.php - SmsFrameworkUpdateTest.php in tests/
src/ Functional/ SmsFrameworkUpdateTest.php
File
- src/
Entity/ SmsMessageResult.php, line 36
Namespace
Drupal\sms\EntityView source
class SmsMessageResult extends ContentEntityBase implements SmsMessageResultInterface {
/**
* The static cache for delivery reports associated with this SMS result.
*
* @var \Drupal\sms\Entity\SmsDeliveryReportInterface[]
*/
protected $reports = [];
/**
* {@inheritdoc}
*/
public function getError() {
return $this
->get('error')->value;
}
/**
* {@inheritdoc}
*/
public function setError($error) {
$this
->set('error', $error);
return $this;
}
/**
* {@inheritdoc}
*/
public function getErrorMessage() {
return $this
->get('error_message')->value;
}
/**
* {@inheritdoc}
*/
public function setErrorMessage($message) {
$this
->set('error_message', $message);
return $this;
}
/**
* {@inheritdoc}
*/
public function getReport($recipient) {
foreach ($this
->getReports() as $report) {
if ($report
->getRecipient() === $recipient) {
return $report;
}
}
return NULL;
}
/**
* {@inheritdoc}
*/
public function getReports() {
if ($this->reports) {
return $this->reports;
}
if ($this
->getSmsMessage()) {
return $this
->getSmsMessage()
->getReports();
}
return [];
}
/**
* {@inheritdoc}
*/
public function setReports(array $reports) {
$this->reports = $reports;
return $this;
}
/**
* {@inheritdoc}
*/
public function addReport(PlainDeliveryReportInterface $report) {
$this->reports[] = $report;
return $this;
}
/**
* {@inheritdoc}
*/
public function getCreditsBalance() {
return $this
->get('credits_balance')->value;
}
/**
* {@inheritdoc}
*/
public function setCreditsBalance($balance) {
if (is_numeric($balance) || is_null($balance)) {
$this
->set('credits_balance', $balance);
}
else {
throw new SmsException(sprintf('Credit balance set is a %s', gettype($balance)));
}
return $this;
}
/**
* {@inheritdoc}
*/
public function getCreditsUsed() {
return $this
->get('credits_used')->value;
}
/**
* {@inheritdoc}
*/
public function setCreditsUsed($credits_used) {
if (is_numeric($credits_used) || is_null($credits_used)) {
$this
->set('credits_used', $credits_used);
}
else {
throw new SmsException(sprintf('Credit used is a %s', gettype($credits_used)));
}
return $this;
}
/**
* {@inheritdoc}
*/
public function getSmsMessage() {
return $this
->get('sms_message')->entity;
}
/**
* {@inheritdoc}
*/
public function setSmsMessage(SmsMessageInterface $sms_message) {
$this
->set('sms_message', $sms_message);
return $this;
}
/**
* {@inheritdoc}
*/
public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
$fields = parent::baseFieldDefinitions($entity_type);
$fields['error'] = BaseFieldDefinition::create('string')
->setLabel(t('Error'))
->setDescription(t('The normalized error code.'))
->setReadOnly(TRUE)
->setRequired(FALSE);
$fields['error_message'] = BaseFieldDefinition::create('string')
->setLabel(t('Error message'))
->setDescription(t('The description of the error from the gateway.'))
->setReadOnly(TRUE)
->setDefaultValue('')
->setRequired(FALSE);
$fields['credits_balance'] = BaseFieldDefinition::create('decimal')
->setLabel(t('Credits balance'))
->setDescription(t('The balance of credits after the message was sent.'))
->setReadOnly(TRUE)
->setRequired(TRUE);
$fields['credits_used'] = BaseFieldDefinition::create('decimal')
->setLabel(t('Credits used'))
->setDescription(t('The credits used for the message transaction.'))
->setReadOnly(TRUE)
->setRequired(TRUE);
$fields['sms_message'] = BaseFieldDefinition::create('entity_reference')
->setSetting('target_type', 'sms')
->setLabel(t('SMS Message'))
->setDescription(t('The parent SMS message.'))
->setReadOnly(TRUE)
->setRequired(TRUE);
return $fields;
}
/**
* {@inheritdoc}
*/
public function preSave(EntityStorageInterface $storage) {
// SMS message result cannot be saved without a parent SMS message.
if (!$this
->getSmsMessage()) {
throw new SmsStorageException('No parent SMS message specified for SMS message result');
}
parent::preSave($storage);
}
/**
* Converts a plain SMS message result into an SMS message result entity.
*
* @param \Drupal\sms\Message\SmsMessageResultInterface $sms_result
* A plain SMS message result.
*
* @return \Drupal\sms\Entity\SmsMessageResultInterface
* An SMS message result entity that can be saved.
*/
public static function convertFromMessageResult(StdMessageResultInterface $sms_result) {
if ($sms_result instanceof SmsMessageResultInterface) {
return $sms_result;
}
$new = SmsMessageResult::create();
$new
->setCreditsBalance($sms_result
->getCreditsBalance())
->setCreditsUsed($sms_result
->getCreditsUsed())
->setError($sms_result
->getError())
->setErrorMessage($sms_result
->getErrorMessage())
->setReports($sms_result
->getReports());
return $new;
}
}
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 saved entity before the insert or update 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 | ||
SmsMessageResult:: |
protected | property | The static cache for delivery reports associated with this SMS result. | |
SmsMessageResult:: |
public | function |
Adds a delivery report to the result. Overrides SmsMessageResultInterface:: |
|
SmsMessageResult:: |
public static | function |
Provides base field definitions for an entity type. Overrides ContentEntityBase:: |
|
SmsMessageResult:: |
public static | function | Converts a plain SMS message result into an SMS message result entity. | |
SmsMessageResult:: |
public | function |
Gets the credit balance after this transaction. Overrides SmsMessageResultInterface:: |
|
SmsMessageResult:: |
public | function |
Gets the credits consumed for this transaction. Overrides SmsMessageResultInterface:: |
|
SmsMessageResult:: |
public | function |
Gets the error of the message. Overrides SmsMessageResultInterface:: |
|
SmsMessageResult:: |
public | function |
Gets the error message. Overrides SmsMessageResultInterface:: |
|
SmsMessageResult:: |
public | function |
Gets the delivery report for a particular recipient. Overrides SmsMessageResultInterface:: |
|
SmsMessageResult:: |
public | function |
Gets the delivery reports for all recipients. Overrides SmsMessageResultInterface:: |
|
SmsMessageResult:: |
public | function |
Gets the parent SMS message entity. Overrides SmsMessageResultInterface:: |
|
SmsMessageResult:: |
public | function |
Acts on an entity before the presave hook is invoked. Overrides ContentEntityBase:: |
|
SmsMessageResult:: |
public | function |
Sets the credit balance after this transaction. Overrides SmsMessageResultInterface:: |
|
SmsMessageResult:: |
public | function |
Sets the credits consumed for this transaction. Overrides SmsMessageResultInterface:: |
|
SmsMessageResult:: |
public | function |
Sets the error of the message. Overrides SmsMessageResultInterface:: |
|
SmsMessageResult:: |
public | function |
Sets the error message. Overrides SmsMessageResultInterface:: |
|
SmsMessageResult:: |
public | function |
Sets the delivery reports for all recipients. Overrides SmsMessageResultInterface:: |
|
SmsMessageResult:: |
public | function |
Sets the parent SMS message entity. Overrides SmsMessageResultInterface:: |
|
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. |