Add returntypes where possible (#48)

* In case the exact returntype is not yet possible, add it in docblock with a ReturnTypeWillChange-attribute.
* Changed some instances of "static public function foo()" to "public
  static function foo()".
* Added "public" to all constants which were public implicitly

Author: Zombaya

composer.json

@@ -13,7 +13,8 @@
     },
     "require-dev": {
         "swiftmailer/swiftmailer": "^6.1",
-        "phpunit/phpunit": "^8.3"
+        "phpunit/phpunit": "^8.3",
+        "pear/pear-core-minimal": "^1.10"
     },
     "suggest": {
         "swiftmailer/swiftmailer": "Conversion to MIME (eml file) message format"  

src/MAPI/Item/Attachment.php

@@ -25,7 +25,7 @@ public function copyToStream($stream)
         fwrite($stream, $this->getData() ?? '');
     }
 
-    protected function storeEmbeddedOle($stream)
+    protected function storeEmbeddedOle($stream): void
     {
         // this is very untested...
         //throw new \RuntimeException('Saving an OLE Compound Document is not supported');

src/MAPI/Message/Attachment.php

@@ -97,7 +97,7 @@ public function getContentId(): ?string
         return $this->properties['attach_content_id'] ?? null;
     }
 
-    public function getEmbeddedOleData()
+    public function getEmbeddedOleData(): ?string
     {
         $compobj = $this->properties["\01CompObj"];
         if (is_null($compobj)) {
@@ -106,7 +106,7 @@ public function getEmbeddedOleData()
         return substr($compobj, 32);
     }
 
-    public function isValid()
+    public function isValid(): bool
     {
         return $this->properties !== null;
     }

src/MAPI/Message/Message.php

@@ -88,18 +88,18 @@ protected function buildRecipients()
     }
 
     /** @return Attachment[] */
-    public function getAttachments()
+    public function getAttachments(): array
     {
         return $this->attachments;
     }
 
     /** @return  Recipient[] */
-    public function getRecipients()
+    public function getRecipients(): array
     {
         return $this->recipients;
     }
 
-    public function getRecipientsOfType($type)
+    public function getRecipientsOfType($type): array
     {
         $response = [];
         foreach ($this->recipients as $r) {

src/MAPI/Mime/HeaderCollection.php

@@ -6,12 +6,12 @@ class HeaderCollection implements \IteratorAggregate
 {
     protected $rawHeaders = [];
 
-    public function getIterator()
+    public function getIterator(): \ArrayIterator
     {
         return new \ArrayIterator($this->rawHeaders);
     }
 
-    public function add($header, $value = null)
+    public function add($header, $value = null): void
     {
         if (is_null($value)) {
             //echo $header . "\n";
@@ -40,7 +40,7 @@ public function add($header, $value = null)
         }
     }
 
-    public function set($header, $value)
+    public function set($header, $value): void
     {
         $key = strtolower($header);
         $val = [
@@ -77,13 +77,13 @@ public function getValue($header)
 
     }
 
-    public function has($header) 
+    public function has($header): bool
     {
         $key = strtolower($header);
         return isset($this->rawHeaders[$key]);
     }
 
-    public function unset($header) 
+    public function unset($header): void
     {
         $key = strtolower($header);
         unset($this->rawHeaders[$key]);

src/MAPI/Mime/Swiftmailer/Adapter/DependencySet.php

@@ -8,7 +8,7 @@
 class DependencySet {
 
     // override the HeaderFactory registration in the DI container
-    public static function register($force = false)
+    public static function register($force = false): void
     {
         static $registered = false;
 

src/MAPI/Mime/Swiftmailer/Adapter/HeaderFactory.php

@@ -22,7 +22,7 @@ public function __construct(Swift_Mime_HeaderEncoder $encoder, Swift_Encoder $pa
         $this->charset = $charset;
     }
 
-    public function createTextHeader($name, $value = null)
+    public function createTextHeader($name, $value = null): UnstructuredHeader
     {
         $header = new UnstructuredHeader($name, $this->encoder);
         if (isset($value)) {
@@ -33,7 +33,7 @@ public function createTextHeader($name, $value = null)
         return $header;
     }
 
-    protected function setHeaderCharset(Swift_Mime_Header $header)
+    protected function setHeaderCharset(Swift_Mime_Header $header): void
     {
         if (isset($this->charset)) {
             $header->setCharset($this->charset);

src/MAPI/Mime/Swiftmailer/Adapter/UnstructuredHeader.php

@@ -18,7 +18,7 @@ class UnstructuredHeader extends Swift_Mime_Headers_UnstructuredHeader
      *
      * @return bool
      */
-    protected function tokenNeedsEncoding($token)
+    protected function tokenNeedsEncoding($token): bool
     {
         static $prevToken = '';
 

src/MAPI/Mime/Swiftmailer/Attachment.php

@@ -17,7 +17,7 @@ public static function wrap(BaseAttachment $attachment)
         return new self($attachment->obj, $attachment->parent);
     }
 
-    public function toMime()
+    public function toMime(): \Swift_Attachment
     {
         DependencySet::register();
 
@@ -67,7 +67,7 @@ public function toMimeString(): string
         return (string)$this->toMime();
     }
 
-    public function copyMimeToStream($stream)
+    public function copyMimeToStream($stream): void
     {
         fwrite($stream, $this->toMimeString());
     }

src/MAPI/Mime/Swiftmailer/Factory.php

@@ -16,9 +16,9 @@ public function __construct(bool $muteConversionExceptions = false)
         $this->muteConversionExceptions = $muteConversionExceptions;
     }
 
-    public function parseMessage(Element $root)
+    public function parseMessage(Element $root): Message
     {
-        $message = new \Hfig\MAPI\Mime\Swiftmailer\Message($root);
+        $message = new Message($root);
         $message->setMuteConversionExceptions($this->muteConversionExceptions);
 
         return $message;