Documenting that Swift_Message can be null

Author: jimmypuckett

src/MailTracking.php

@@ -55,7 +55,7 @@ public function setUpMailTracking()
     /**
      * Retrieve the appropriate swift message.
      *
-     * @param Swift_Message $message
+     * @param Swift_Message|null $message
      *
      * @return Swift_Message
      */
@@ -89,8 +89,8 @@ public function recordMail(Swift_Message $email)
     /**
      * Assert that the last email was bcc'ed to the given address.
      *
-     * @param string        $bcc
-     * @param Swift_Message $message
+     * @param string             $bcc
+     * @param Swift_Message|null $message
      *
      * @return PHPUnit_Framework_TestCase $this
      */
@@ -105,8 +105,8 @@ protected function seeEmailBcc($bcc, Swift_Message $message = null)
     /**
      * Assert that the last email was cc'ed to the given address.
      *
-     * @param string        $cc
-     * @param Swift_Message $message
+     * @param string             $cc
+     * @param Swift_Message|null $message
      *
      * @return PHPUnit_Framework_TestCase $this
      */
@@ -121,8 +121,8 @@ protected function seeEmailCc($cc, Swift_Message $message = null)
     /**
      * Assert that the last email's body contains the given text.
      *
-     * @param string        $excerpt
-     * @param Swift_Message $message
+     * @param string             $excerpt
+     * @param Swift_Message|null $message
      *
      * @return PHPUnit_Framework_TestCase $this
      */
@@ -137,8 +137,8 @@ protected function seeEmailContains($excerpt, Swift_Message $message = null)
     /**
      * Assert that the last email's body equals the given text.
      *
-     * @param string        $body
-     * @param Swift_Message $message
+     * @param string             $body
+     * @param Swift_Message|null $message
      *
      * @return PHPUnit_Framework_TestCase $this
      */
@@ -153,8 +153,8 @@ protected function seeEmailEquals($body, Swift_Message $message = null)
     /**
      * Assert that the last email was delivered by the given address.
      *
-     * @param string        $sender
-     * @param Swift_Message $message
+     * @param string             $sender
+     * @param Swift_Message|null $message
      *
      * @return PHPUnit_Framework_TestCase $this
      */
@@ -170,15 +170,15 @@ protected function seeEmailFrom($sender, Swift_Message $message = null)
     /**
      * Assert that the last email was set to reply to the given address.
      *
-     * @param string        $reply_to
-     * @param Swift_Message $message
+     * @param string             $reply_to
+     * @param Swift_Message|null $message
      *
      * @return PHPUnit_Framework_TestCase $this
      */
     protected function seeEmailReplyTo($reply_to, Swift_Message $message = null)
     {
         $this->assertArrayHasKey($reply_to, (array)$this->getEmail($message)
-                                                  ->getReplyTo(), "No email was set to reply to $reply_to.");
+                                                        ->getReplyTo(), "No email was set to reply to $reply_to.");
 
         return $this;
     }
@@ -202,8 +202,8 @@ protected function seeEmailsSent($count)
     /**
      * Assert that the last email's subject matches the given string.
      *
-     * @param string        $subject
-     * @param Swift_Message $message
+     * @param string             $subject
+     * @param Swift_Message|null $message
      *
      * @return PHPUnit_Framework_TestCase $this
      */
@@ -219,8 +219,8 @@ protected function seeEmailSubject($subject, Swift_Message $message = null)
     /**
      * Assert that the last email was sent to the given recipient.
      *
-     * @param string        $recipient
-     * @param Swift_Message $message
+     * @param string             $recipient
+     * @param Swift_Message|null $message
      *
      * @return PHPUnit_Framework_TestCase $this
      */