Going all in on the meaning of status messages for result.

Renaming result::*status* to result::*error*

Per https://www.drupal.org/node/2789237 #24

If a result is given, and the result has > 0 reports, and no error status, then success. See devel form

Author: dpi

modules/sms_devel/src/Form/SmsDevelMessageForm.php

@@ -11,6 +11,7 @@
 use Drupal\sms\Entity\SmsMessage;
 use Drupal\sms\Direction;
 use Drupal\sms\Exception\SmsException;
+use Drupal\sms\Message\SmsMessageResultInterface;
 
 /**
  * Simulate a message being sent or received.
@@ -73,6 +74,7 @@ public function buildForm(array $form, FormStateInterface $form_state) {
       '#required' => TRUE,
     ];
 
+    $gateways = [];
     foreach (SmsGateway::loadMultiple() as $sms_gateway) {
       $gateways[$sms_gateway->id()] = $sms_gateway->label();
     }
@@ -165,8 +167,11 @@ function submitReceive(array &$form, FormStateInterface $form_state) {
     $this->message->setDirection(Direction::INCOMING);
 
     if ($form_state->getValue('skip_queue')) {
-      $this->smsProvider->incoming($this->message);
-      drupal_set_message($this->t('Message received.'));
+      $messages = $this->smsProvider->incoming($this->message);
+      foreach ($messages as $message) {
+        $result = $message->getResult();
+        $this->resultMessage($result);
+      }
     }
     else {
       $this->smsProvider->queue($this->message);
@@ -188,8 +193,11 @@ function submitSend(array &$form, FormStateInterface $form_state) {
 
     try {
       if ($form_state->getValue('skip_queue')) {
-        $this->smsProvider->send($this->message);
-        drupal_set_message($this->t('Message sent.'));
+        $messages = $this->smsProvider->send($this->message);
+        foreach ($messages as $message) {
+          $result = $message->getResult();
+          $this->resultMessage($result);
+        }
       }
       else {
         $this->smsProvider->queue($this->message);
@@ -208,4 +216,28 @@ function submitSend(array &$form, FormStateInterface $form_state) {
    */
   function submitForm(array &$form, FormStateInterface $form_state) {}
 
+  /**
+   * Output a status message for a result object.
+   *
+   * @param \Drupal\sms\Message\SmsMessageResultInterface $result
+   *   An SMS result object
+   */
+  protected function resultMessage(SmsMessageResultInterface $result) {
+    if ($status_code = $result->getError()) {
+      $status_message = $result->getErrorMessage();
+      drupal_set_message($this->t('A problem occurred while attempting to process message: (code: @code) @message', [
+        '@code' => $status_code,
+        '@message' => $status_message,
+      ]), 'error');
+    }
+    else if ($report_count = count($result->getReports())) {
+      drupal_set_message($this->t('Message was processed, @count delivery reports were generated.', [
+        '@count' => $report_count,
+      ]));
+    }
+    else {
+      drupal_set_message($this->t('An unknown error occurred while attempting to process message. No result or reports were generated by the gateway.'), 'error');
+    }
+  }
+
 }

src/Message/SmsMessageResult.php

@@ -15,18 +15,18 @@
 class SmsMessageResult implements SmsMessageResultInterface {
 
   /**
-   * The status of the message, or NULL if unknown.
+   * The error of the message, or NULL if unknown.
    *
    * @var string|NULL
    */
-  protected $status = NULL;
+  protected $error = NULL;
 
   /**
-   * The status message as provided by the gateway API.
+   * The error message as provided by the gateway API.
    *
    * @var string
    */
-  protected $statusMessage = '';
+  protected $errorMessage = '';
 
   /**
    * The message delivery reports.
@@ -56,30 +56,30 @@ class SmsMessageResult implements SmsMessageResultInterface {
   /**
    * {@inheritdoc}
    */
-  public function getStatus() {
-    return $this->status;
+  public function getError() {
+    return $this->error;
   }
 
   /**
    * {@inheritdoc}
    */
-  public function setStatus($status) {
-    $this->status = $status;
+  public function setError($error) {
+    $this->error = $error;
     return $this;
   }
 
   /**
    * {@inheritdoc}
    */
-  public function getStatusMessage() {
-    return $this->statusMessage;
+  public function getErrorMessage() {
+    return $this->errorMessage;
   }
 
   /**
    * {@inheritdoc}
    */
-  public function setStatusMessage($message) {
-    $this->statusMessage = $message;
+  public function setErrorMessage($message) {
+    $this->errorMessage = $message;
     return $this;
   }
 

src/Message/SmsMessageResultInterface.php

@@ -13,47 +13,47 @@
 interface SmsMessageResultInterface {
 
   /**
-   * Gets the status of the message.
+   * Gets the error of the message.
    *
    * @return string|NULL
-   *   A status code from \Drupal\sms\Message\SmsMessageResultStatus, or NULL if
-   *   unknown.
+   *   A error code from \Drupal\sms\Message\SmsMessageResultError, or NULL if
+   *   there was no error.
    */
-  public function getStatus();
+  public function getError();
 
   /**
-   * Sets the status of the message.
+   * Sets the error of the message.
    *
-   * Usually a setting a status on a result indicates something went wrong with
+   * Usually a setting an error on a result indicates something went wrong with
    * the entire transaction.
    *
-   * @param string $status|NULL
-   *   A status code from \Drupal\sms\Message\SmsMessageResultStatus, or NULL if
+   * @param string $error|NULL
+   *   A error code from \Drupal\sms\Message\SmsMessageResultError, or NULL if
    *   unknown.
    *
    * @return $this
    *   Returns this result object for chaining.
    */
-  public function setStatus($status);
+  public function setError($error);
 
   /**
-   * Gets the status message.
+   * Gets the error message.
    *
    * @return string
-   *   The status message as provided by the gateway API.
+   *   The error message as provided by the gateway API.
    */
-  public function getStatusMessage();
+  public function getErrorMessage();
 
   /**
-   * Sets the status message.
+   * Sets the error message.
    *
    * @param string $message
-   *   The status message as provided by the gateway API.
+   *   The error message as provided by the gateway API.
    *
    * @return $this
    *   Returns this report object for chaining.
    */
-  public function setStatusMessage($message);
+  public function setErrorMessage($message);
 
   /**
    * Gets the delivery report for a particular recipient.

src/Tests/SmsFrameworkMessageTestTrait.php

@@ -185,16 +185,16 @@ public function testOptionsRemove() {
    * @covers ::setResult
    */
   public function testResults() {
-    $status_message = $this->getRandomGenerator()->string();
+    $error_message = $this->getRandomGenerator()->string();
     $result = (new SmsMessageResult())
-      ->setStatusMessage($status_message);
+      ->setErrorMessage($error_message);
 
     $sms_message = $this->createSmsMessage();
     $sms_message->setResult($result);
 
     $result_actual = $sms_message->getResult();
     $this->assertSame($result, $result_actual);
-    $this->assertSame($status_message, $result_actual->getStatusMessage());
+    $this->assertSame($error_message, $result_actual->getErrorMessage());
   }
 
   /**

tests/src/Unit/Message/SmsFrameworkResultUnitTest.php

@@ -17,37 +17,37 @@
 class SmsFrameworkResultUnitTest extends UnitTestCase {
 
   /**
-   * Tests status.
+   * Tests error.
    *
-   * @covers ::getStatus
-   * @covers ::setStatus
+   * @covers ::getError
+   * @covers ::setError
    */
-  public function testStatus() {
+  public function testError() {
     $result = $this->createResult();
-    $this->assertNull($result->getStatus(), 'Default value is NULL');
+    $this->assertNull($result->getError(), 'Default value is NULL');
 
-    $status = $this->getRandomGenerator()->string();
-    $return = $result->setStatus($status);
+    $error = $this->getRandomGenerator()->string();
+    $return = $result->setError($error);
 
     $this->assertTrue($return instanceof SmsMessageResultInterface);
-    $this->assertEquals($status, $result->getStatus());
+    $this->assertEquals($error, $result->getError());
   }
 
   /**
-   * Tests status message.
+   * Tests error message.
    *
-   * @covers ::getStatusMessage
-   * @covers ::setStatusMessage
+   * @covers ::getErrorMessage
+   * @covers ::setErrorMessage
    */
-  public function testStatusMessage() {
+  public function testErrorMessage() {
     $result = $this->createResult();
-    $this->assertEquals('', $result->getStatusMessage(), 'Default value is empty string');
+    $this->assertEquals('', $result->getErrorMessage(), 'Default value is empty string');
 
-    $status_message = $this->getRandomGenerator()->string();
-    $return = $result->setStatusMessage($status_message);
+    $error_message = $this->getRandomGenerator()->string();
+    $return = $result->setErrorMessage($error_message);
 
     $this->assertTrue($return instanceof SmsMessageResultInterface);
-    $this->assertEquals($status_message, $result->getStatusMessage());
+    $this->assertEquals($error_message, $result->getErrorMessage());
   }
 
   /**

tests/src/Unit/Message/SmsMessageTest.php

@@ -25,7 +25,7 @@ class SmsMessageTest extends UnitTestCase {
   /**
    * Create a SMS message object for testing.
    *
-   * @return \Drupal\Tests\sms\Unit\Message\TestSmsMessage
+   * @return \Drupal\sms\Message\SmsMessageInterface
    */
   protected function createSmsMessage() {
     return new TestSmsMessage();