class MemoryOutgoingResult in SMS Framework 8

Defines a gateway with defective return values for its' send method.

Plugin annotation

@SmsGateway(
  id = "memory_outgoing_result",
  label = @Translation("Memory Outgoing Result"),
  outgoing_message_max_recipients = -1
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\sms\Plugin\SmsGatewayPluginBase implements SmsGatewayPluginInterface
      • class \Drupal\sms_test_gateway\Plugin\SmsGateway\Memory implements SmsIncomingEventProcessorInterface
        • class \Drupal\sms_test_gateway\Plugin\SmsGateway\MemoryOutgoingResult

File

tests/modules/sms_test_gateway/src/Plugin/SmsGateway/MemoryOutgoingResult.php, line 16

Namespace

Drupal\sms_test_gateway\Plugin\SmsGateway

class MemoryOutgoingResult extends Memory {

  /**
   * {@inheritdoc}
   */
  public function send(SmsMessageInterface $sms_message) {
    $result = parent::send($sms_message);
    if (\Drupal::state()
      ->get('sms_test_gateway.memory_outgoing_result.missing_result')) {
      return NULL;
    }
    $delete_reports = \Drupal::state()
      ->get('sms_test_gateway.memory_outgoing_result.delete_reports');
    if ($delete_reports > 0) {
      $reports = $result
        ->getReports();
      if (!count($reports)) {
        throw new \Exception('There are no reports to delete.');
      }

      // Slice off the first {$delete_reports}x reports.
      $reports = array_slice($reports, $delete_reports);
      $result
        ->setReports($reports);
      return $result;
    }
    return $result;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
Memory::buildConfigurationForm	public	function	Form constructor. Overrides SmsGatewayPluginBase::buildConfigurationForm
Memory::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides SmsGatewayPluginBase::defaultConfiguration	2
Memory::getCreditsBalance	public	function	Returns the credit balance available on this gateway. Overrides SmsGatewayPluginBase::getCreditsBalance
Memory::getDeliveryReports	public	function	Gets delivery reports from the gateway. Overrides SmsGatewayPluginBase::getDeliveryReports
Memory::incomingEvent	public	function	Process a SMS message from this gateway. Overrides SmsIncomingEventProcessorInterface::incomingEvent
Memory::parseDeliveryReports	public	function	Parses incoming delivery reports and returns the created delivery reports. Overrides SmsGatewayPluginBase::parseDeliveryReports
Memory::randomDeliveryReports	protected	function	Generates random delivery reports for each of the recipients of a message.
Memory::submitConfigurationForm	public	function	Form submission handler. Overrides SmsGatewayPluginBase::submitConfigurationForm
MemoryOutgoingResult::send	public	function	Sends an SMS. Overrides Memory::send
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
SmsGatewayPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
SmsGatewayPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurablePluginInterface::getConfiguration
SmsGatewayPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface::setConfiguration
SmsGatewayPluginBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
SmsGatewayPluginBase::__construct	public	function	Constructs a new SmsGateway plugin. Overrides PluginBase::__construct	1
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.