Merge branch 'docs/#171-completing-ide-hints' into develop

Close #171
zendframework · Mar 1, 2018 · 0c37b59 · 0c37b59
2 parents 5548138 + 4f61536
commit 0c37b59
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 4 deletions.
diff --git a/src/Address.php b/src/Address.php
@@ -23,7 +23,6 @@ class Address implements Address\AddressInterface
      * @param  string $email
      * @param  null|string $name
      * @throws Exception\InvalidArgumentException
-     * @return Address
      */
     public function __construct($email, $name = null)
     {

diff --git a/src/Header/GenericHeader.php b/src/Header/GenericHeader.php
@@ -30,6 +30,10 @@ class GenericHeader implements HeaderInterface, UnstructuredInterface
      */
     protected $encoding;
 
+    /**
+     * @param string $headerLine
+     * @return GenericHeader
+     */
     public static function fromString($headerLine)
     {
         list($name, $value) = self::splitHeaderLine($headerLine);

diff --git a/src/Headers.php b/src/Headers.php
@@ -14,6 +14,8 @@
 use Iterator;
 use Traversable;
 use Zend\Loader\PluginClassLocator;
+use Zend\Mail\Header\GenericHeader;
+use Zend\Mail\Header\HeaderInterface;
 
 /**
  * Basic mail headers collection functionality
@@ -478,6 +480,8 @@ public function forceLoading()
     public function loadHeader($headerLine)
     {
         list($name, ) = Header\GenericHeader::splitHeaderLine($headerLine);
+
+        /** @var HeaderInterface $class */
         $class = $this->getPluginClassLoader()->load($name) ?: Header\GenericHeader::class;
         return $class::fromString($headerLine);
     }
@@ -491,6 +495,8 @@ protected function lazyLoadHeader($index)
         $current = $this->headers[$index];
 
         $key   = $this->headersKeys[$index];
+
+        /** @var GenericHeader $class */
         $class = ($this->getPluginClassLoader()->load($key)) ?: 'Zend\Mail\Header\GenericHeader';
 
         $encoding = $current->getEncoding();

diff --git a/src/Message.php b/src/Message.php
@@ -10,14 +10,16 @@
 namespace Zend\Mail;
 
 use Traversable;
+use Zend\Mail\Header\ContentType;
+use Zend\Mail\Header\Sender;
 use Zend\Mime;
 
 class Message
 {
     /**
      * Content of the message
      *
-     * @var string|object
+     * @var string|object|Mime\Message
      */
     protected $body;
 
@@ -302,6 +304,7 @@ public function getReplyTo()
      */
     public function setSender($emailOrAddress, $name = null)
     {
+        /** @var Sender $header */
         $header = $this->getHeaderByName('sender', __NAMESPACE__ . '\Header\Sender');
         $header->setAddress($emailOrAddress, $name);
         return $this;
@@ -318,6 +321,8 @@ public function getSender()
         if (! $headers->has('sender')) {
             return null;
         }
+
+        /** @var Sender $header */
         $header = $this->getHeaderByName('sender', __NAMESPACE__ . '\Header\Sender');
         return $header->getAddress();
     }
@@ -397,6 +402,8 @@ public function setBody($body)
         // Multipart content headers
         if ($this->body->isMultiPart()) {
             $mime   = $this->body->getMime();
+
+            /** @var ContentType $header */
             $header = $this->getHeaderByName('content-type', __NAMESPACE__ . '\Header\ContentType');
             $header->setType('multipart/mixed');
             $header->addParameter('boundary', $mime->boundary());
@@ -415,7 +422,7 @@ public function setBody($body)
     /**
      * Return the currently set message body
      *
-     * @return string|object
+     * @return object|string|Mime\Message
      */
     public function getBody()
     {
@@ -553,6 +560,8 @@ public function toString()
     public static function fromString($rawMessage)
     {
         $message = new static();
+
+        /** @var Headers $headers */
         $headers = null;
         $content = null;
         Mime\Decode::splitMessage($rawMessage, $headers, $content, Headers::EOL);

diff --git a/src/Protocol/Smtp.php b/src/Protocol/Smtp.php
@@ -160,6 +160,7 @@ public function __construct($host = '127.0.0.1', $port = null, array $config = n
      * Set whether or not send QUIT command
      *
      * @param int $useCompleteQuit use complete quit
+     * @return bool
      */
     public function setUseCompleteQuit($useCompleteQuit)
     {

diff --git a/src/Transport/Sendmail.php b/src/Transport/Sendmail.php
@@ -152,6 +152,7 @@ protected function prepareRecipients(Mail\Message $message)
             throw new Exception\RuntimeException('Invalid email; contains no "To" header');
         }
 
+        /** @var Mail\Header\To $to */
         $to   = $headers->get('to');
         $list = $to->getAddressList();
         if (0 == count($list)) {
@@ -225,7 +226,7 @@ protected function prepareHeaders(Mail\Message $message)
         $headers->removeHeader('To');
         $headers->removeHeader('Subject');
 
-        // Sanitize the From header
+        /** @var Mail\Header\From $from Sanitize the From header*/
         $from = $headers->get('From');
         if ($from) {
             foreach ($from->getAddressList() as $address) {