ddeboer · Slamdunk · Sep 26, 2017 · Sep 25, 2017 · Sep 25, 2017 · Sep 25, 2017
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 vendor/
+.php_cs.cache
 composer.lock
 phpunit.xml
diff --git a/.php_cs b/.php_cs
@@ -0,0 +1,41 @@
+<?php
+return PhpCsFixer\Config::create()
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@Symfony' => true,
+        '@Symfony:risky' => true,
+        '@PHP70Migration' => true,
+        '@PHP70Migration:risky' => true,
+        'align_multiline_comment' => true,
+        'array_syntax' => ['syntax' => 'short'],
+        'blank_line_before_statement' => true,
+        'concat_space' => ['spacing' => 'one'],
+        'heredoc_to_nowdoc' => true,
+        'list_syntax' => ['syntax' => 'long'],
+        'method_argument_space' => ['ensure_fully_multiline' => true],
+        'no_break_comment' => true,
+        'no_extra_consecutive_blank_lines' => ['tokens' => ['break', 'continue', 'extra', 'return', 'throw', 'use', 'parenthesis_brace_block', 'square_brace_block', 'curly_brace_block']],
+        'no_null_property_initialization' => true,
+        'no_php4_constructor' => true,
+        'no_short_echo_tag' => true,
+        'no_superfluous_elseif' => true,
+        'no_unneeded_curly_braces' => true,
+        'no_unneeded_final_method' => true,
+        'no_unreachable_default_argument_value' => true,
+        'no_useless_else' => true,
+        'ordered_imports' => true,
+        'phpdoc_add_missing_param_annotation' => true,
+        'phpdoc_order' => true,
+        'phpdoc_summary' => false,
+        'phpdoc_types_order' => true,
+        'semicolon_after_instruction' => true,
+        'simplified_null_return' => true,
+        'yoda_style' => false,
+    ])
+    ->setFinder(
+        PhpCsFixer\Finder::create()
+            ->in(__DIR__ . '/src')
+            ->in(__DIR__ . '/tests')
+    )
+;
+
diff --git a/.travis.yml b/.travis.yml
@@ -6,6 +6,7 @@ matrix:
   fast_finish: true
   include:
     - php: 7.0
+      env: CS_CHECK=1
     - php: 7.1
     - php: 7.2
       env: CODE_COVERAGE=1
@@ -28,10 +29,12 @@ cache:
 install:
   - sh .travis/dovecot_install.sh
   - if [ "$CODE_COVERAGE" != 1 ]; then phpenv config-rm xdebug.ini || true; fi
+  - if [ "$CS_CHECK" != 1 ]; then composer remove --no-update --no-scripts --dev friendsofphp/php-cs-fixer; fi
   - composer install
 
 script:
   - vendor/bin/phpunit --coverage-clover ./clover.xml
+  - if [ "$CS_CHECK" = 1 ]; then vendor/bin/php-cs-fixer fix --diff --dry-run --verbose; fi
 
 after_script:
   - if [ "$CODE_COVERAGE" = 1 ]; then wget https://scrutinizer-ci.com/ocular.phar; fi

diff --git a/composer.json b/composer.json
@@ -21,7 +21,8 @@
     "require-dev": {
         "ext-mbstring": "*",
         "ext-iconv": "*",
-        "phpunit/phpunit": "^5.7"
+        "phpunit/phpunit": "^5.7",
+        "friendsofphp/php-cs-fixer": "^2.6"
     },
     "autoload": {
         "psr-4": {

diff --git a/src/Connection.php b/src/Connection.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Ddeboer\Imap;
 
 use Ddeboer\Imap\Exception\Exception;
@@ -66,8 +68,9 @@ public function hasMailbox($name)
      *
      * @param string $name Mailbox name
      *
-     * @return Mailbox
      * @throws MailboxDoesNotExistException If mailbox does not exist
+     *
+     * @return Mailbox
      */
     public function getMailbox($name)
     {
@@ -93,8 +96,9 @@ public function count()
      *
      * @param $name
      *
-     * @return Mailbox
      * @throws Exception
+     *
+     * @return Mailbox
      */
     public function createMailbox($name)
     {
@@ -143,7 +147,7 @@ public function getResource()
 
     /**
      * Get mailbox names
-     * 
+     *
      * @return array
      */
     private function getMailboxNames()

diff --git a/src/Exception/AuthenticationFailedException.php b/src/Exception/AuthenticationFailedException.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Ddeboer\Imap\Exception;
 
 class AuthenticationFailedException extends Exception

diff --git a/src/Exception/Exception.php b/src/Exception/Exception.php
@@ -1,12 +1,14 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Ddeboer\Imap\Exception;
 
 class Exception extends \RuntimeException
 {
-    protected $errors = array();
+    protected $errors = [];
 
-    public function __construct($message, $code = null, $previous = null)
+    public function __construct($message, $code = 0, $previous = null)
     {
         parent::__construct($message, $code, $previous);
         $this->errors = imap_errors();

diff --git a/src/Exception/MailboxDoesNotExistException.php b/src/Exception/MailboxDoesNotExistException.php
@@ -1,11 +1,13 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Ddeboer\Imap\Exception;
 
 class MailboxDoesNotExistException extends Exception
 {
     public function __construct($mailbox)
     {
-        parent::__construct('Mailbox ' . $mailbox. ' does not exist');
+        parent::__construct('Mailbox ' . $mailbox . ' does not exist');
     }
 }
diff --git a/src/Exception/MessageDeleteException.php b/src/Exception/MessageDeleteException.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Ddeboer\Imap\Exception;
 
 class MessageDeleteException extends Exception

diff --git a/src/Exception/MessageDoesNotExistException.php b/src/Exception/MessageDoesNotExistException.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Ddeboer\Imap\Exception;
 
 class MessageDoesNotExistException extends Exception

diff --git a/src/Exception/MessageMoveException.php b/src/Exception/MessageMoveException.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Ddeboer\Imap\Exception;
 
 class MessageMoveException extends Exception

diff --git a/src/Mailbox.php b/src/Mailbox.php
@@ -1,10 +1,11 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Ddeboer\Imap;
 
 /**
  * An IMAP mailbox (commonly referred to as a ‘folder’)
- *
  */
 class Mailbox implements \Countable, \IteratorAggregate
 {
@@ -22,7 +23,7 @@ public function __construct($name, Connection $connection)
     {
         $this->mailbox = $name;
         $this->connection = $connection;
-        $this->name = substr($name, strpos($name, '}')+1);
+        $this->name = substr($name, strpos($name, '}') + 1);
     }
 
     /**
@@ -52,7 +53,7 @@ public function count()
      *
      * @param SearchExpression $search Search expression (optional)
      *
-     * @return MessageIterator|Message[]
+     * @return Message[]|MessageIterator
      */
     public function getMessages(SearchExpression $search = null)
     {
@@ -63,7 +64,7 @@ public function getMessages(SearchExpression $search = null)
         $messageNumbers = imap_search($this->connection->getResource(), $query, \SE_UID);
         if (false == $messageNumbers) {
             // imap_search can also return false
-            $messageNumbers = array();
+            $messageNumbers = [];
         }
 
         return new MessageIterator($this->connection->getResource(), $messageNumbers);
@@ -97,7 +98,6 @@ public function getIterator()
 
     /**
      * Delete this mailbox
-     *
      */
     public function delete()
     {
@@ -123,7 +123,7 @@ public function expunge()
      *
      * @param string $message
      *
-     * @return boolean
+     * @return bool
      */
     public function addMessage($message)
     {

diff --git a/src/Message.php b/src/Message.php
@@ -1,11 +1,13 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Ddeboer\Imap;
 
-use Ddeboer\Imap\Exception\MessageDoesNotExistException;
-use Ddeboer\Imap\Message\EmailAddress;
 use Ddeboer\Imap\Exception\MessageDeleteException;
+use Ddeboer\Imap\Exception\MessageDoesNotExistException;
 use Ddeboer\Imap\Exception\MessageMoveException;
+use Ddeboer\Imap\Message\EmailAddress;
 
 /**
  * An IMAP message (e-mail)
@@ -16,7 +18,7 @@ class Message extends Message\Part
     private $attachments;
 
     /**
-     * @var boolean
+     * @var bool
      */
     private $keepUnseen = false;
 
@@ -109,6 +111,8 @@ public function getSize()
     /**
      * Get raw part content
      *
+     * @param mixed $keepUnseen
+     *
      * @return string
      */
     public function getContent($keepUnseen = false)
@@ -123,7 +127,7 @@ public function getContent($keepUnseen = false)
     /**
      * Get message answered flag value (from headers)
      *
-     * @return boolean
+     * @return bool
      */
     public function isAnswered()
     {
@@ -133,7 +137,7 @@ public function isAnswered()
     /**
      * Get message deleted flag value (from headers)
      *
-     * @return boolean
+     * @return bool
      */
     public function isDeleted()
     {
@@ -143,7 +147,7 @@ public function isDeleted()
     /**
      * Get message draft flag value (from headers)
      *
-     * @return boolean
+     * @return bool
      */
     public function isDraft()
     {
@@ -153,14 +157,14 @@ public function isDraft()
     /**
      * Has the message been marked as read?
      *
-     * @return boolean
+     * @return bool
      */
     public function isSeen()
     {
-        return (
+        return
                 'R' === $this->getHeaders()->get('recent')
-            ||  ('' === $this->getHeaders()->get('recent') &&  '' !== $this->getHeaders()->get('unseen'))
-        );
+            || ('' === $this->getHeaders()->get('recent') && '' !== $this->getHeaders()->get('unseen'))
+        ;
     }
 
     /**
@@ -184,7 +188,7 @@ public function getHeaders()
             // imap_header is much faster than imap_fetchheader
             // imap_header returns only a subset of all mail headers,
             // but it does include the message flags.
-            $headers = imap_header($this->stream, imap_msgno($this->stream, $this->messageNumber));
+            $headers = imap_headerinfo($this->stream, imap_msgno($this->stream, $this->messageNumber));
             $this->headers = new Message\Headers($headers);
         }
 
@@ -232,7 +236,7 @@ public function getBodyText()
     public function getAttachments()
     {
         if (null === $this->attachments) {
-            $this->attachments = array();
+            $this->attachments = [];
             foreach ($this->getParts() as $part) {
                 if ($part instanceof Message\Attachment) {
                     $this->attachments[] = $part;
@@ -277,9 +281,11 @@ public function delete()
 
     /**
      * Move message to another mailbox
+     *
      * @param Mailbox $mailbox
      *
      * @throws MessageMoveException
+     *
      * @return Message
      */
     public function move(Mailbox $mailbox)

diff --git a/src/Message/Attachment.php b/src/Message/Attachment.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Ddeboer\Imap\Message;
 
 /**

diff --git a/src/Message/EmailAddress.php b/src/Message/EmailAddress.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Ddeboer\Imap\Message;
 
 /**
@@ -17,7 +19,7 @@ public function __construct($mailbox, $hostname = null, $name = null)
         $this->mailbox = $mailbox;
         $this->hostname = $hostname;
         $this->name = $name;
-        
+
         if ($hostname) {
             $this->address = $mailbox . '@' . $hostname;
         }
@@ -36,9 +38,9 @@ public function getAddress()
     public function getFullAddress()
     {
         if ($this->name) {
-            $address = sprintf("%s <%s@%s>", $this->name, $this->mailbox, $this->hostname);
+            $address = sprintf('%s <%s@%s>', $this->name, $this->mailbox, $this->hostname);
         } else {
-            $address = sprintf("%s@%s", $this->mailbox, $this->hostname);
+            $address = sprintf('%s@%s', $this->mailbox, $this->hostname);
         }
 
         return $address;