class Incoming in SMS Framework 8

Defines a gateway supporting incoming route.

Plugin annotation

@SmsGateway(
  id = "incoming",
  label = @Translation("Incoming"),
  incoming = TRUE,
  incoming_route = TRUE,
)

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\Incoming

2 string references to 'Incoming'

SmsFrameworkViewsTest::testSms in tests/src/Kernel/SmsFrameworkViewsTest.php

Tests view of SMS entities with join to recipient table.

SmsMessageDirection::render in src/Plugin/views/field/SmsMessageDirection.php

Renders the field.

File

tests/modules/sms_test_gateway/src/Plugin/SmsGateway/Incoming.php, line 27

Namespace

Drupal\sms_test_gateway\Plugin\SmsGateway

class Incoming extends SmsGatewayPluginBase {

  /**
   * {@inheritdoc}
   */
  public function send(SmsMessageInterface $sms) {
  }

  /**
   * Process an incoming message POST request.
   *
   * This callback expects a 'messages' POST value containing JSON.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   * @param \Drupal\sms\Entity\SmsGatewayInterface $sms_gateway
   *   The gateway instance.
   *
   * @return \Drupal\sms\SmsProcessingResponse
   *   A SMS processing response task.
   */
  public function processIncoming(Request $request, SmsGatewayInterface $sms_gateway) {
    $json = Json::decode($request
      ->getContent());
    $raw_messages = $json['messages'];

    // JSON property to SmsMessage method setters mapping.
    $sms_properties = [
      'sender_number' => 'setSenderNumber',
      'message' => 'setMessage',
      'recipients' => 'addRecipients',
    ];
    $messages = [];
    foreach ($raw_messages as $raw_message) {
      $result = new SmsMessageResult();
      foreach ($raw_message['recipients'] as $recipient) {
        $report = (new SmsDeliveryReport())
          ->setRecipient($recipient);
        $result
          ->addReport($report);
      }
      $message = (new SmsMessage())
        ->setDirection(Direction::INCOMING)
        ->setGateway($sms_gateway)
        ->setResult($result);
      foreach ($sms_properties as $property => $method) {
        if (array_key_exists($property, $raw_message)) {
          $value = $raw_message[$property];
          call_user_func_array([
            $message,
            $method,
          ], [
            $value,
          ]);
        }
      }
      $messages[] = $message;
    }
    $response = new Response('', 204);
    $task = (new SmsProcessingResponse())
      ->setResponse($response)
      ->setMessages($messages);
    return $task;
  }

}

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
Incoming::processIncoming	public	function	Process an incoming message POST request.
Incoming::send	public	function	Sends an SMS. Overrides SmsGatewayPluginInterface::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::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm	1
SmsGatewayPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
SmsGatewayPluginBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurablePluginInterface::defaultConfiguration	1
SmsGatewayPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurablePluginInterface::getConfiguration
SmsGatewayPluginBase::getCreditsBalance	public	function	Returns the credit balance available on this gateway. Overrides SmsGatewayPluginInterface::getCreditsBalance	1
SmsGatewayPluginBase::getDeliveryReports	public	function	Gets delivery reports from the gateway. Overrides SmsGatewayPluginInterface::getDeliveryReports	1
SmsGatewayPluginBase::parseDeliveryReports	public	function	Parses incoming delivery reports and returns the created delivery reports. Overrides SmsGatewayPluginInterface::parseDeliveryReports	1
SmsGatewayPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface::setConfiguration
SmsGatewayPluginBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm	1
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.