Upgraded the code base to PHP '^7.4'

Author: AmraniCh

src/Command/FtpCommand.php

@@ -23,57 +23,35 @@
  */
 class FtpCommand
 {
-    /** @var ConnectionInterface */
-    protected $connection;
+    protected ConnectionInterface $connection;
+    protected FtpWrapper $wrapper;
 
-    /** @var FtpWrapper */
-    protected $wrapper;
-
-    /**
-     * FtpCommand constructor.
-     *
-     * @param ConnectionInterface $connection
-     */
     public function __construct(ConnectionInterface $connection)
     {
         $this->connection = $connection;
         $this->wrapper    = new FtpWrapper($connection);
     }
 
-    /**
-     * @return ConnectionInterface
-     */
     public function getConnection() : ConnectionInterface
     {
         return $this->connection;
     }
 
     /**
-     * @param ConnectionInterface $connection
-     *
      * @since 1.5.3
-     *
-     * @return void
      */
     public function setConnection(ConnectionInterface $connection) : void
     {
         $this->connection = $connection;
     }
 
-    /**
-     * @param FtpWrapper $wrapper
-     *
-     * @return void
-     */
     public function setWrapper(FtpWrapper $wrapper) : void
     {
         $this->wrapper = $wrapper;
     }
 
     /**
      * @since 1.5.3
-     *
-     * @return FtpWrapper
      */
     public function getWrapper() : FtpWrapper
     {
@@ -127,10 +105,6 @@ public function site(string $command) : bool
      *
      * Note! Not all FTP servers support this command.
      *
-     * @param string $command
-     *
-     * @return bool
-     *
      * @throws CommandException
      */
     public function exec(string $command) : bool
@@ -165,11 +139,6 @@ public function supportedSiteCommands() : array
         return array_map('ltrim', $response['body']);
     }
 
-    /**
-     * @param array $response
-     *
-     * @return array
-     */
     protected function parseRawResponse(array $response) : array
     {
         $code = $message = $body = $endMessage = null;

src/Config/FtpConfig.php

@@ -23,56 +23,34 @@
  */
 class FtpConfig
 {
-    /** @var ConnectionInterface */
-    protected $connection;
+    protected ConnectionInterface $connection;
+    protected FtpWrapper $wrapper;
 
-    /** @var FtpWrapper */
-    protected $wrapper;
-
-    /**
-     * FtpConfig constructor.
-     *
-     * @param ConnectionInterface $connection
-     */
     public function __construct(ConnectionInterface $connection)
     {
         $this->connection = $connection;
         $this->wrapper    = new FtpWrapper($connection);
     }
 
-    /**
-     * @return ConnectionInterface
-     */
     public function getConnection() : ConnectionInterface
     {
         return $this->connection;
     }
 
     /**
-     * @param ConnectionInterface $connection
-     *
      * @since 1.5.3
-     *
-     * @return void
      */
     public function setConnection(ConnectionInterface $connection) : void
     {
         $this->connection = $connection;
     }
 
-    /**
-     * @param FtpWrapper $wrapper
-     *
-     * @return void
-     */
     public function setWrapper(FtpWrapper $wrapper) : void
     {
         $this->wrapper = $wrapper;
     }
 
     /**
-     * @return FtpWrapper
-     *
      * @since 1.5.3
      */
     public function getWrapper() : FtpWrapper
@@ -83,8 +61,6 @@ public function getWrapper() : FtpWrapper
     /**
      * Turn the passive mode on or off.
      *
-     * @param bool $value
-     *
      * @return bool Returns true in success, if not an exception throws.
      *
      * @throws ConfigException
@@ -110,8 +86,8 @@ public function setPassive(bool $value) : bool
      */
     public function setTimeout(int $value) : bool
     {
-        if (!is_int($value) || $value < 0) {
-            throw new ConfigException("[{$value}] Timeout option value must be of type integer and greater than 0.");
+        if ($value < 0) {
+            throw new ConfigException("[{$value}] Timeout option value must be greater than 0.");
         }
 
         if (!$this->wrapper->set_option(FtpWrapper::TIMEOUT_SEC, $value)) {
@@ -123,20 +99,14 @@ public function setTimeout(int $value) : bool
     }
 
     /**
-     * Specifies if the IP address returned via the PASV command will be used to open the data channel.
-     *
-     * @param bool $value
+     * Specifies if the IP address returned via the 'PASV' command will be used to open the data channel.
      *
      * @return bool Returns true in success, if not an exception throws.
      *
      * @throws ConfigException
      */
     public function usePassiveAddress(bool $value) : bool
     {
-        if (!is_bool($value)) {
-            throw new ConfigException("[{$value}] usePassiveAddress option value must be of type boolean.");
-        }
-
         if (!$this->wrapper->set_option(FtpWrapper::USEPASVADDRESS, $value)) {
             throw new ConfigException($this->wrapper->getErrorMessage()
                 ?: "Unable to set usePassiveAddress runtime option.");
@@ -148,18 +118,12 @@ public function usePassiveAddress(bool $value) : bool
     /**
      * Sets the autoSeek option on/off.
      *
-     * @param bool $value
-     *
      * @return bool Returns true in success, if not an exception throws.
      *
      * @throws ConfigException
      */
     public function setAutoSeek(bool $value) : bool
     {
-        if (!is_bool($value)) {
-            throw new ConfigException("[{$value}] AutoSeek option value must be of type boolean.");
-        }
-
         if (!$this->wrapper->set_option(FtpWrapper::AUTOSEEK, $value)) {
             throw new ConfigException($this->wrapper->getErrorMessage()
                 ?: "Unable to set AutoSeek runtime option.");
@@ -171,8 +135,6 @@ public function setAutoSeek(bool $value) : bool
     /**
      * Gets the timeout option value.
      *
-     * @return int
-     *
      * @throws ConfigException
      */
     public function getTimeout() : int
@@ -187,19 +149,15 @@ public function getTimeout() : int
 
     /**
      * Checks if the autoSeek option enabled or not.
-     *
-     * @return bool
      */
     public function isAutoSeek() : bool
     {
         return $this->wrapper->get_option(FtpWrapper::AUTOSEEK);
     }
 
     /**
-     * Checks if the passive address returned in the PASV response
+     * Checks if the passive address returned to the 'PASV' response
      * is used by the control channel or not.
-     *
-     * @return bool
      */
     public function isUsePassiveAddress() : bool
     {

src/Connection/Connection.php

@@ -22,29 +22,17 @@
  */
 abstract class Connection implements ConnectionInterface
 {
-    /** @var FtpWrapper */
-    protected $wrapper;
+    protected FtpWrapper $wrapper;
 
     /** @var resource */
     protected $stream;
 
-    /** @var string */
-    protected $host;
-
-    /** @var int */
-    protected $port;
-
-    /** @var int */
-    protected $timeout;
-
-    /** @var string */
-    protected $username;
-
-    /* @var string */
-    protected $password;
-
-    /** @var bool */
-    protected $isConnected;
+    protected string $host;
+    protected int $port;
+    protected int $timeout;
+    protected string $username;
+    protected string $password;
+    protected bool $isConnected;
 
     /**
      * Prepares an FTP connection.
@@ -68,20 +56,13 @@ public function __construct(string $host, string $username, string $password, in
         $this->wrapper = new FtpWrapper($this);
     }
 
-    /**
-     * @param FtpWrapper $wrapper
-     *
-     * @return void
-     */
     public function setWrapper(FtpWrapper $wrapper) : void
     {
         $this->wrapper = $wrapper;
     }
 
     /**
      * @since 1.5.3
-     *
-     * @return FtpWrapper
      */
     public function getWrapper() : FtpWrapper
     {
@@ -102,49 +83,31 @@ public function getStream()
         return $this->stream;
     }
 
-    /**
-     * @inheritDoc
-     */
     public function getHost() : string
     {
         return $this->host;
     }
 
-    /**
-     * @inheritDoc
-     */
     public function getPort() : int
     {
         return $this->port;
     }
 
-    /**
-     * @inheritDoc
-     */
     public function getTimeout() : int
     {
         return $this->timeout;
     }
 
-    /**
-     * @inheritDoc
-     */
     public function getUsername() : string
     {
         return $this->username;
     }
 
-    /**
-     * @inheritDoc
-     */
     public function getPassword() : string
     {
         return $this->password;
     }
 
-    /**
-     * @inheritDoc
-     */
     public function isConnected() : bool
     {
         return $this->isConnected;

src/Connection/ConnectionInterface.php

@@ -21,15 +21,11 @@ interface ConnectionInterface
 {
     /**
      * Opens the FTP connection.
-     *
-     * @return bool
      */
     public function open() : bool;
 
     /**
      * Closes the FTP connection.
-     *
-     * @return bool
      */
     public function close() : bool;
 
@@ -38,33 +34,15 @@ public function close() : bool;
      */
     public function getStream();
 
-    /**
-     * @return string
-     */
     public function getHost() : string;
 
-    /**
-     * @return int
-     */
     public function getPort() : int;
 
-    /**
-     * @return int
-     */
     public function getTimeout() : int;
 
-    /**
-     * @return string
-     */
     public function getUsername() : string;
 
-    /**
-     * @return string
-     */
     public function getPassword() : string;
 
-    /**
-     * @return bool
-     */
     public function isConnected() : bool;
 }

src/Connection/FtpSSLConnection.php

@@ -54,8 +54,6 @@ protected function connect() : void
                 ?: 'SSL connection failed to the FTP server.');
         }
 
-        $this->isSecure = true;
-
         $this->wrapper->setConnection($this);
     }
 }