class SmsGateway in SMS Framework 8
Same name in this branch
- 8 src/Annotation/SmsGateway.php \Drupal\sms\Annotation\SmsGateway
- 8 src/Entity/SmsGateway.php \Drupal\sms\Entity\SmsGateway
Same name and namespace in other branches
- 2.x src/Entity/SmsGateway.php \Drupal\sms\Entity\SmsGateway
- 2.1.x src/Entity/SmsGateway.php \Drupal\sms\Entity\SmsGateway
Defines storage for an SMS Gateway instance.
Plugin annotation
@ConfigEntityType(
id = "sms_gateway",
label = @Translation("SMS Gateway"),
label_collection = @Translation("SMS Gateways"),
label_singular = @Translation("SMS gateway"),
label_plural = @Translation("SMS gateways"),
label_count = @PluralTranslation(
singular = "@count SMS gateway",
plural = "@count SMS gateways",
),
config_prefix = "gateway",
admin_permission = "administer smsframework",
entity_keys = {
"id" = "id",
"label" = "label",
},
handlers = {
"list_builder" = "\Drupal\sms\Lists\SmsGatewayListBuilder",
"form" = {
"add" = "Drupal\sms\Form\SmsGatewayForm",
"default" = "Drupal\sms\Form\SmsGatewayForm",
"edit" = "Drupal\sms\Form\SmsGatewayForm",
"delete" = "Drupal\sms\Form\SmsGatewayDeleteForm",
}
},
links = {
"canonical" = "/admin/config/smsframework/gateways/{sms_gateway}",
"edit-form" = "/admin/config/smsframework/gateways/{sms_gateway}",
"delete-form" = "/admin/config/smsframework/gateways/{sms_gateway}/delete",
},
)
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
- class \Drupal\sms\Entity\SmsGateway implements EntityWithPluginCollectionInterface, SmsGatewayInterface
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
Expanded class hierarchy of SmsGateway
12 files declare their use of SmsGateway
- RouteSubscriber.php in src/
Routing/ RouteSubscriber.php - SmsDevelMessageForm.php in modules/
sms_devel/ src/ Form/ SmsDevelMessageForm.php - SmsFrameworkGatewayAdminTest.php in tests/
src/ Functional/ SmsFrameworkGatewayAdminTest.php - SmsFrameworkGatewayEntityTest.php in tests/
src/ Kernel/ SmsFrameworkGatewayEntityTest.php - SmsFrameworkProviderTest.php in tests/
src/ Kernel/ SmsFrameworkProviderTest.php
File
- src/
Entity/ SmsGateway.php, line 48
Namespace
Drupal\sms\EntityView source
class SmsGateway extends ConfigEntityBase implements SmsGatewayInterface, EntityWithPluginCollectionInterface {
/**
* The ID of the SMS Gateway.
*
* @var string
*/
protected $id;
/**
* The label of the SMS Gateway.
*
* @var string
*/
protected $label;
/**
* The plugin instance settings.
*
* @var array
*
* Access settings using:
* @code
* $gateway->getPlugin()->getConfiguration();
* @endcode
*/
protected $settings = [];
/**
* An SmsGateway plugin ID.
*
* @var string
*/
protected $plugin;
/**
* The plugin collection that holds the plugin for this entity.
*
* @var \Drupal\sms\Plugin\SmsGatewayPluginCollection
*/
protected $pluginCollection;
/**
* Whether messages sent to this gateway should be sent immediately.
*
* @var bool
*/
protected $skip_queue;
/**
* The internal path where incoming messages are received.
*
* @var string
*/
protected $incoming_push_path;
/**
* The internal path where pushed delivery reports can be received.
*
* @var string
*/
protected $reports_push_path;
/**
* How many seconds to hold messages after they are received.
*
* @var int
*/
protected $retention_duration_incoming;
/**
* How many seconds to hold messages after they are sent.
*
* @var int
*/
protected $retention_duration_outgoing;
/**
* {@inheritdoc}
*/
public static function preCreate(EntityStorageInterface $storage, array &$values) {
parent::preCreate($storage, $values);
if (!isset($values['incoming_push_path'])) {
$key = Crypt::randomBytesBase64(16);
$values['incoming_push_path'] = '/sms/incoming/receive/' . $key;
}
if (!isset($values['reports_push_path'])) {
$key = Crypt::randomBytesBase64(16);
$values['reports_push_path'] = '/sms/delivery-report/receive/' . $key;
}
}
/**
* {@inheritdoc}
*/
public function postSave(EntityStorageInterface $storage, $update = TRUE) {
parent::postSave($storage, $update);
/** @var static $original */
$original =& $this->original;
$original_path = isset($original) ? $original
->getPushReportPath() : '';
if ($original_path != $this
->getPushReportPath()) {
\Drupal::service('router.builder')
->setRebuildNeeded();
}
}
/**
* Encapsulates the creation of the action's LazyPluginCollection.
*
* @return \Drupal\Component\Plugin\LazyPluginCollection
* The action's plugin collection.
*/
protected function getPluginCollection() {
if (!$this->pluginCollection) {
$this->pluginCollection = new SmsGatewayPluginCollection(\Drupal::service('plugin.manager.sms_gateway'), $this->plugin, $this->settings);
}
return $this->pluginCollection;
}
/**
* {@inheritdoc}
*/
public function getPluginCollections() {
return [
'settings' => $this
->getPluginCollection(),
];
}
/**
* {@inheritdoc}
*/
public function getPlugin() {
return $this
->getPluginCollection()
->get($this->plugin);
}
/**
* {@inheritdoc}
*/
public function getPluginId() {
return $this->plugin;
}
/**
* {@inheritdoc}
*/
public function getSkipQueue() {
return !empty($this->skip_queue);
}
/**
* {@inheritdoc}
*/
public function setSkipQueue($skip_queue) {
$this->skip_queue = (bool) $skip_queue;
return $this;
}
/**
* {@inheritdoc}
*/
public function getPushIncomingPath() {
return $this->incoming_push_path;
}
/**
* {@inheritdoc}
*/
public function setPushIncomingPath($path) {
$this->incoming_push_path = $path;
return $this;
}
/**
* {@inheritdoc}
*/
public function getPushReportUrl() {
return Url::fromRoute('sms.delivery_report.receive.' . $this
->id());
}
/**
* {@inheritdoc}
*/
public function getPushReportPath() {
return $this->reports_push_path;
}
/**
* {@inheritdoc}
*/
public function setPushReportPath($path) {
$this->reports_push_path = $path;
return $this;
}
/**
* {@inheritdoc}
*/
public function getRetentionDuration($direction) {
switch ($direction) {
case Direction::INCOMING:
return (int) $this->retention_duration_incoming;
case Direction::OUTGOING:
return (int) $this->retention_duration_outgoing;
default:
throw new \InvalidArgumentException(sprintf('%s is not a valid direction.', $direction));
}
}
/**
* {@inheritdoc}
*/
public function setRetentionDuration($direction, $retention_duration) {
switch ($direction) {
case Direction::INCOMING:
$this->retention_duration_incoming = $retention_duration;
break;
case Direction::OUTGOING:
$this->retention_duration_outgoing = $retention_duration;
break;
}
return $this;
}
/**
* {@inheritdoc}
*/
public function getMaxRecipientsOutgoing() {
$definition = $this
->getPlugin()
->getPluginDefinition();
return isset($definition['outgoing_message_max_recipients']) ? (int) $definition['outgoing_message_max_recipients'] : 1;
}
/**
* {@inheritdoc}
*/
public function supportsIncoming() {
$definition = $this
->getPlugin()
->getPluginDefinition();
return isset($definition['incoming']) ? (bool) $definition['incoming'] : FALSE;
}
/**
* {@inheritdoc}
*/
public function autoCreateIncomingRoute() {
$definition = $this
->getPlugin()
->getPluginDefinition();
return isset($definition['incoming_route']) ? (bool) $definition['incoming_route'] : FALSE;
}
/**
* {@inheritdoc}
*/
public function isScheduleAware() {
$definition = $this
->getPlugin()
->getPluginDefinition();
return !empty($definition['schedule_aware']);
}
/**
* {@inheritdoc}
*/
public function supportsReportsPull() {
$definition = $this
->getPlugin()
->getPluginDefinition();
return isset($definition['reports_pull']) ? (bool) $definition['reports_pull'] : FALSE;
}
/**
* {@inheritdoc}
*/
public function supportsReportsPush() {
$definition = $this
->getPlugin()
->getPluginDefinition();
return isset($definition['reports_push']) ? (bool) $definition['reports_push'] : FALSE;
}
/**
* {@inheritdoc}
*/
public function supportsCreditBalanceQuery() {
$definition = $this
->getPlugin()
->getPluginDefinition();
return isset($definition['credit_balance_available']) ? (bool) $definition['credit_balance_available'] : FALSE;
}
}
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. | |
ConfigEntityBase:: |
private | property | Whether the config is being deleted by the uninstall process. | |
ConfigEntityBase:: |
protected | property | The language code of the entity's default language. | |
ConfigEntityBase:: |
protected | property | The original ID of the configuration entity. | |
ConfigEntityBase:: |
protected | property | The enabled/disabled status of the configuration entity. | 4 |
ConfigEntityBase:: |
protected | property | Third party entity settings. | |
ConfigEntityBase:: |
protected | property | Trust supplied data and not use configuration schema on save. | |
ConfigEntityBase:: |
protected | property | The UUID for this entity. | |
ConfigEntityBase:: |
protected | property | Information maintained by Drupal core about configuration. | |
ConfigEntityBase:: |
protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | |
ConfigEntityBase:: |
public | function |
Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface:: |
13 |
ConfigEntityBase:: |
public | function |
Creates a duplicate of the entity. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Disables the configuration entity. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Enables the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the cache tags that should be used to invalidate caches. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Gets the configuration dependency name. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected static | function | Gets the configuration manager. | |
ConfigEntityBase:: |
public | function |
Gets the configuration target identifier for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the configuration dependencies. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
protected | function | Gets the typed config manager. | |
ConfigEntityBase:: |
public | function |
Gets whether on not the data is trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
protected static | function |
Override to never invalidate the individual entities' cache tags; the
config system already invalidates them. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected | function |
Override to never invalidate the entity's cache tag; the config system
already invalidates it. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Checks whether this entity is installable. Overrides ConfigEntityInterface:: |
2 |
ConfigEntityBase:: |
public | function |
Overrides Entity::isNew(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface:: |
7 |
ConfigEntityBase:: |
public static | function |
Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase:: |
8 |
ConfigEntityBase:: |
public | function |
Acts on an entity before the presave hook is invoked. Overrides EntityBase:: |
13 |
ConfigEntityBase:: |
public | function |
Saves an entity permanently. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Sets the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets the status of the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function | ||
ConfigEntityBase:: |
public static | function | Helper callback for uasort() to sort configuration entities by weight and label. | 6 |
ConfigEntityBase:: |
public | function |
Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface:: |
4 |
ConfigEntityBase:: |
public | function |
Gets an array of all property values. Overrides EntityBase:: |
2 |
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets that the data should be trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the public URL for this entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Constructs an Entity object. Overrides EntityBase:: |
10 |
ConfigEntityBase:: |
public | function |
Overrides EntityBase:: |
4 |
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 | |
DependencyTrait:: |
protected | property | The object's dependencies. | |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. Aliased as: addDependencyTrait | |
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 | function |
Checks data value access. Overrides AccessibleInterface:: |
1 |
EntityBase:: |
public | function |
Gets the bundle of the entity. Overrides EntityInterface:: |
1 |
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 |
Gets the key that is used to store configuration dependencies. Overrides EntityInterface:: |
|
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 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:: |
public | function |
Gets the identifier. Overrides EntityInterface:: |
11 |
EntityBase:: |
public | function |
Gets the label of the entity. Overrides EntityInterface:: |
6 |
EntityBase:: |
public | function |
Gets the language of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the language manager. | |
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 | function |
Acts on a created entity before hooks are invoked. Overrides EntityInterface:: |
4 |
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 | function |
Gets a list of entities referenced by this entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Generates the HTML for a link to this entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets a list of URI relationships supported by this entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets an array of placeholders for this entity. | 2 |
EntityBase:: |
public | function |
Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the UUID generator. | |
PluginDependencyTrait:: |
protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 |
PluginDependencyTrait:: |
protected | function | Calculates and returns dependencies of a specific plugin instance. | |
PluginDependencyTrait:: |
protected | function | Wraps the module handler. | 1 |
PluginDependencyTrait:: |
protected | function | Wraps the theme handler. | 1 |
RefinableCacheableDependencyTrait:: |
public | function | 1 | |
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
SmsGateway:: |
protected | property | The ID of the SMS Gateway. | |
SmsGateway:: |
protected | property | The internal path where incoming messages are received. | |
SmsGateway:: |
protected | property | The label of the SMS Gateway. | |
SmsGateway:: |
protected | property | An SmsGateway plugin ID. | |
SmsGateway:: |
protected | property | The plugin collection that holds the plugin for this entity. | |
SmsGateway:: |
protected | property | The internal path where pushed delivery reports can be received. | |
SmsGateway:: |
protected | property | How many seconds to hold messages after they are received. | |
SmsGateway:: |
protected | property | How many seconds to hold messages after they are sent. | |
SmsGateway:: |
protected | property | The plugin instance settings. | |
SmsGateway:: |
protected | property | Whether messages sent to this gateway should be sent immediately. | |
SmsGateway:: |
public | function |
Whether to automatically create a route for receiving incoming messages. Overrides SmsGatewayInterface:: |
|
SmsGateway:: |
public | function |
Get maximum number of recipients per outgoing message. Overrides SmsGatewayInterface:: |
|
SmsGateway:: |
public | function |
Returns the plugin instance. Overrides SmsGatewayInterface:: |
|
SmsGateway:: |
protected | function | Encapsulates the creation of the action's LazyPluginCollection. | |
SmsGateway:: |
public | function |
Gets the plugin collections used by this object. Overrides ObjectWithPluginCollectionInterface:: |
|
SmsGateway:: |
public | function |
Returns the plugin ID. Overrides SmsGatewayInterface:: |
|
SmsGateway:: |
public | function |
Get the internal path where incoming messages are received. Overrides SmsGatewayInterface:: |
|
SmsGateway:: |
public | function |
Get the internal path where pushed delivery reports can be received. Overrides SmsGatewayInterface:: |
|
SmsGateway:: |
public | function |
Get the url where pushed delivery reports can be received. Overrides SmsGatewayInterface:: |
|
SmsGateway:: |
public | function |
Get how many seconds to hold messages. Overrides SmsGatewayInterface:: |
|
SmsGateway:: |
public | function |
Get whether messages sent to this gateway should be sent immediately. Overrides SmsGatewayInterface:: |
|
SmsGateway:: |
public | function |
Get whether this gateway is schedule aware. Overrides SmsGatewayInterface:: |
|
SmsGateway:: |
public | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase:: |
|
SmsGateway:: |
public static | function |
Changes the values of an entity before it is created. Overrides EntityBase:: |
|
SmsGateway:: |
public | function |
Set the internal path where incoming messages are received. Overrides SmsGatewayInterface:: |
|
SmsGateway:: |
public | function |
Set the internal path where pushed delivery reports can be received. Overrides SmsGatewayInterface:: |
|
SmsGateway:: |
public | function |
Set how many seconds to hold messages.. Overrides SmsGatewayInterface:: |
|
SmsGateway:: |
public | function |
Set whether messages sent to this gateway should be sent immediately. Overrides SmsGatewayInterface:: |
|
SmsGateway:: |
public | function |
Get whether this gateway supports credit balance queries. Overrides SmsGatewayInterface:: |
|
SmsGateway:: |
public | function |
Whether the gateway supports receiving messages. Overrides SmsGatewayInterface:: |
|
SmsGateway:: |
public | function |
Gets whether this gateway can pull reports. Overrides SmsGatewayInterface:: |
|
SmsGateway:: |
public | function |
Gets whether this gateway can handle reports pushed to the site. Overrides SmsGatewayInterface:: |
|
SynchronizableEntityTrait:: |
protected | property | Whether this entity is being created, updated or deleted through a synchronization process. | |
SynchronizableEntityTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
public | function |