You are here

Home » API reference » SMS Framework 2.1.x » SmsGateway.php

class SmsGateway in SMS Framework 2.1.x

Same name in this branch
  1. 2.1.x src/Annotation/SmsGateway.php \Drupal\sms\Annotation\SmsGateway
  2. 2.1.x src/Entity/SmsGateway.php \Drupal\sms\Entity\SmsGateway
Same name and namespace in other branches
  1. 8 src/Entity/SmsGateway.php \Drupal\sms\Entity\SmsGateway
  2. 2.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",
  },
  config_export = {
    "id",
    "label",
    "plugin",
    "settings",
    "skip_queue",
    "incoming_push_path",
    "reports_push_path",
    "retention_duration_incoming",
    "retention_duration_outgoing",
  },
)

Hierarchy

Expanded class hierarchy of SmsGateway

9 files declare their use of SmsGateway
RouteSubscriber.php in src/Routing/RouteSubscriber.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
SmsFrameworkSmsSendTest.php in tests/src/Kernel/SmsFrameworkSmsSendTest.php

... See full list

File

src/Entity/SmsGateway.php, line 61

Namespace

Drupal\sms\Entity
View 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

Namesort descending Modifiers Type Description Overrides
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity. 4
ConfigEntityBase::$third_party_settings protected property Third party entity settings.
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies 14
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 8
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
ConfigEntityBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave 13
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 1
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 2
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 2
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 2
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::id public function Gets the identifier. Overrides EntityInterface::id 11
EntityBase::label public function Gets the label of the entity. Overrides EntityInterface::label 6
EntityBase::language public function Gets the language of the entity. Overrides EntityInterface::language 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 4
EntityBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 18
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
SmsGateway::$id protected property The ID of the SMS Gateway.
SmsGateway::$incoming_push_path protected property The internal path where incoming messages are received.
SmsGateway::$label protected property The label of the SMS Gateway.
SmsGateway::$plugin protected property An SmsGateway plugin ID.
SmsGateway::$pluginCollection protected property The plugin collection that holds the plugin for this entity.
SmsGateway::$reports_push_path protected property The internal path where pushed delivery reports can be received.
SmsGateway::$retention_duration_incoming protected property How many seconds to hold messages after they are received.
SmsGateway::$retention_duration_outgoing protected property How many seconds to hold messages after they are sent.
SmsGateway::$settings protected property The plugin instance settings.
SmsGateway::$skip_queue protected property Whether messages sent to this gateway should be sent immediately.
SmsGateway::autoCreateIncomingRoute public function Whether to automatically create a route for receiving incoming messages. Overrides SmsGatewayInterface::autoCreateIncomingRoute
SmsGateway::getMaxRecipientsOutgoing public function Get maximum number of recipients per outgoing message. Overrides SmsGatewayInterface::getMaxRecipientsOutgoing
SmsGateway::getPlugin public function Returns the plugin instance. Overrides SmsGatewayInterface::getPlugin
SmsGateway::getPluginCollection protected function Encapsulates the creation of the action's LazyPluginCollection.
SmsGateway::getPluginCollections public function Gets the plugin collections used by this object. Overrides ObjectWithPluginCollectionInterface::getPluginCollections
SmsGateway::getPluginId public function Returns the plugin ID. Overrides SmsGatewayInterface::getPluginId
SmsGateway::getPushIncomingPath public function Get the internal path where incoming messages are received. Overrides SmsGatewayInterface::getPushIncomingPath
SmsGateway::getPushReportPath public function Get the internal path where pushed delivery reports can be received. Overrides SmsGatewayInterface::getPushReportPath
SmsGateway::getPushReportUrl public function Get the url where pushed delivery reports can be received. Overrides SmsGatewayInterface::getPushReportUrl
SmsGateway::getRetentionDuration public function Get how many seconds to hold messages. Overrides SmsGatewayInterface::getRetentionDuration
SmsGateway::getSkipQueue public function Get whether messages sent to this gateway should be sent immediately. Overrides SmsGatewayInterface::getSkipQueue
SmsGateway::isScheduleAware public function Get whether this gateway is schedule aware. Overrides SmsGatewayInterface::isScheduleAware
SmsGateway::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase::postSave
SmsGateway::preCreate public static function Changes the values of an entity before it is created. Overrides EntityBase::preCreate
SmsGateway::setPushIncomingPath public function Set the internal path where incoming messages are received. Overrides SmsGatewayInterface::setPushIncomingPath
SmsGateway::setPushReportPath public function Set the internal path where pushed delivery reports can be received. Overrides SmsGatewayInterface::setPushReportPath
SmsGateway::setRetentionDuration public function Set how many seconds to hold messages.. Overrides SmsGatewayInterface::setRetentionDuration
SmsGateway::setSkipQueue public function Set whether messages sent to this gateway should be sent immediately. Overrides SmsGatewayInterface::setSkipQueue
SmsGateway::supportsCreditBalanceQuery public function Get whether this gateway supports credit balance queries. Overrides SmsGatewayInterface::supportsCreditBalanceQuery
SmsGateway::supportsIncoming public function Whether the gateway supports receiving messages. Overrides SmsGatewayInterface::supportsIncoming
SmsGateway::supportsReportsPull public function Gets whether this gateway can pull reports. Overrides SmsGatewayInterface::supportsReportsPull
SmsGateway::supportsReportsPush public function Gets whether this gateway can handle reports pushed to the site. Overrides SmsGatewayInterface::supportsReportsPush
SynchronizableEntityTrait::$isSyncing protected property Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function