Merge pull request #28 from lazzard/1.5

1.5

Author: AmraniCh

CHANGELOG.md

@@ -1,10 +1,18 @@
 # Change Log
 
+## 1.5.3 (2021-10-10)
+
+* Added new method `FtpClient::appendFile`.
+* Added getters and setters for various classes (see [commit](https://github.com/lazzard/php-ftp-client/commit/02df6b9be719a236701c2bcb78f990632131ffae)).
+* Removed the deprecated `ConnectionInterface::isSecure`.
+* Removed the deprecated `ConnectionInterface::isPassive`.
+* `FtpClient::fileSize` is now throw exception if the giving file is a directory type or an error occurs.
+
 ## 1.5.0 (2021-10-08)
 
 * Upgraded the code base to PHP v7.2.
 * Upgraded PHPUnit to ^8.0.
-* `FtpCommand::raw` is now throw exception in failure.
+* `FtpCommand::raw` is now throw an exception in failure.
 * `FtpWrapper::getErrorMessage` returns empty string instead of null if no error message is available.
 * `FtpClient::getFeatures` throws exception in failure.
 * Fixed `FtpClient::createDir` for multiple directory creation.

README.md

@@ -262,8 +262,8 @@ $client->keepAlive();
 
 | Version    | Status        | Last Release | PHP Version   |
 |:----------:|:-------------:|:------------:|:-------------:|
-| 1.0.x      | EOL           | [v1.0.2][7]  | > = 5.5        |
-| 1.4.x      | EOL           | [v1.4.2][9]  | > = 5.6        |
+| 1.0.x      | EOL           | [v1.0.2][7]  | >= 5.5        |
+| 1.4.x      | EOL           | [v1.4.2][9]  | >= 5.6        |
 | 1.5.x      | Latest        | [v1.5.3][9]  | ^7.2 \| 8.0.* |
 
 [7]: https://github.com/lazzard/php-ftp-client/releases/tag/v1.0.2

TODO.md

@@ -1,6 +1,6 @@
 # TODO LIST
 
-This document describes some desired features, API methods, and PHP/PHPUnit upgrades for the feature releases of this library.
+> This document describes some desired features, API methods, and PHP/PHPUnit upgrades for the feature releases of this library.
 
 ## The next PHP Upgrades
 
@@ -12,11 +12,5 @@ This document describes some desired features, API methods, and PHP/PHPUnit upgr
 
 ## API methods
 
-- [ ] Create a helper method for the `ftp_append` function.
-- [ ] Add `FtpClient::getTransferMode($file)` method to find the appropriate transfer mode (not based on file extension) for the giving **local** file.
+- [ ] Adding the `FtpClient::getTransferMode($file)` method to find the appropriate transfer mode (not based on file extension) for the giving **local** file.
 - [ ] Implement a method that allows to download all the files within the giving remote directory.
-
-## Not wrapped FTP extension functions - why ?
-
-- [ ] [ftp_quit](https://www.php.net/manual/en/function.ftp-quit.php) - is just an alias of [ftp_close](https://www.php.net/manual/en/function.ftp-close.php) function.
-- [ ] [ftp_np_put](https://www.php.net/manual/en/function.ftp-nb-put.php) - using [ftp_np_fput](https://www.php.net/manual/en/function.ftp-nb-fput.php) instead for the upload progress.

docs/FtpClient.md

@@ -11,44 +11,47 @@ $client = new FtpClient(ConnectionInterface $connection);
 
 ```php
 FtpClient::allocateSpace($bytes)
-FtpClient::asyncDownload($remoteFile, $localFile, $callback, $resume = true, $interval = 1, $mode = FtpWrapper::BINARY)
-FtpClient::asyncUpload($localFile, $remoteFile, $callback, $resume = true, $interval = 1, $mode = FtpWrapper::BINARY)
+FtpClient::appendFile(string $remoteFile, string $content, $mode = FtpWrapper::BINARY)
+FtpClient::asyncDownload(string $remoteFile, string $localFile, callable $callback, bool $resume = true, int $interval = 1, int $mode = FtpWrapper::BINARY)
+FtpClient::asyncUpload(string $localFile, string $remoteFile, callable $callback, bool $resume = true, int $interval = 1, int $mode = FtpWrapper::BINARY)
 FtpClient::back()
-FtpClient::changeDir($directory)
-FtpClient::copy($remoteSource, $remoteDirectory)
-FtpClient::copyFromLocal($source, $destinationFolder)
-FtpClient::copyToLocal($remoteSource, $destinationFolder)
-FtpClient::createDir($directory)
-FtpClient::createFile($remoteFile, $content = NULL, $mode = FtpWrapper::BINARY)
-FtpClient::dirSize($directory)
-FtpClient::download($remoteFile, $localFile, $resume = true, $mode = FtpWrapper::BINARY)
-FtpClient::fileSize($remoteFile)
-FtpClient::find($pattern, $directory, $recursive = false)
+FtpClient::changeDir(string $directory)
+FtpClient::copy(string $remoteSource, string $remoteDirectory)
+FtpClient::copyFromLocal(string $source, string $destinationFolder)
+FtpClient::copyToLocal(string $remoteSource, string $destinationFolder)
+FtpClient::createDir(string $directory)
+FtpClient::createFile(string $filename, $content = NULL, int $mode = FtpWrapper::BINARY)
+FtpClient::dirSize(string $directory)
+FtpClient::download(string $remoteFile, string $localFile, bool $resume = true, int $mode = FtpWrapper::BINARY)
+FtpClient::fileSize(string $remoteFile)
+FtpClient::find(string $pattern, string $directory, bool $recursive = false)
 FtpClient::getConnection()
-FtpClient::getCount($directory, $recursive = false, $filter = self::FILE_DIR_TYPE, $ignoreDots = true)
+FtpClient::getCount(string $directory, bool $recursive = false, int $filter = self::FILE_DIR_TYPE, bool $ignoreDots = true)
 FtpClient::getCurrentDir()
-FtpClient::getTransferType()
 FtpClient::getFeatures()
-FtpClient::getFileContent($remoteFile)
+FtpClient::getFileContent(string $remoteFile, int $mode = FtpWrapper::BINARY)
 FtpClient::getParent()
 FtpClient::getSystem()
-FtpClient::isDir($remoteFile)
-FtpClient::isEmpty($remoteFile)
-FtpClient::isExists($remoteFile)
-FtpClient::isFeatureSupported($feature)
-FtpClient::isFile($remoteFile)
+FtpClient::getTransferType()
+FtpClient::getWrapper()
+FtpClient::isDir(string $remoteFile)
+FtpClient::isEmpty(string $remoteFile)
+FtpClient::isExists(string $remoteFile)
+FtpClient::isFeatureSupported(string $feature)
+FtpClient::isFile(string $remoteFile)
 FtpClient::keepAlive()
-FtpClient::lastMTime($remoteFile, $format = NULL)
-FtpClient::listDir($directory, $filter = self::FILE_DIR_TYPE, $ignoreDots = true)
-FtpClient::listDirDetails($directory, $recursive = false, $filter = self::FILE_DIR_TYPE, $ignoreDots = true)
-FtpClient::move($source, $destinationFolder)
-FtpClient::removeDir($directory)
-FtpClient::removeFile($remoteFile)
-FtpClient::rename($remoteFile, $newName)
-FtpClient::setCommand($command)
-FtpClient::setPermissions($filename, $mode)
-FtpClient::setWrapper($wrapper)
-FtpClient::upload($localFile, $remoteFile, $resume = true, $mode = FtpWrapper::BINARY)
+FtpClient::lastMTime(string $remoteFile, string $format = NULL)
+FtpClient::listDir(string $directory, int $filter = self::FILE_DIR_TYPE, bool $ignoreDots = true)
+FtpClient::listDirDetails(string $directory, bool $recursive = false, int $filter = self::FILE_DIR_TYPE, bool $ignoreDots = true)
+FtpClient::move(string $source, string $destinationFolder)
+FtpClient::removeDir(string $directory)
+FtpClient::removeFile(string $remoteFile)
+FtpClient::rename(string $remoteFile, string $newName)
+FtpClient::setCommand(FtpCommand $command)
+FtpClient::setConnection(ConnectionInterface $connection)
+FtpClient::setPermissions(string $filename, $mode)
+FtpClient::setWrapper(FtpWrapper $wrapper)
+FtpClient::upload(string $localFile, string $remoteFile, bool $resume = true, int $mode = FtpWrapper::BINARY)
 ```
 
 ### Asynchronous transfer operations

src/Command/FtpCommand.php

@@ -48,14 +48,38 @@ 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
+    {
+        return $this->wrapper;
+    }
+
     /**
      * Executes an arbitrary command on the server.
      *

src/Config/FtpConfig.php

@@ -48,14 +48,38 @@ 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
+    {
+        return $this->wrapper;
+    }
+
     /**
      * Turn the passive mode on or off.
      *
@@ -72,8 +96,6 @@ public function setPassive(bool $value) : bool
                 ?: "Unable to switch FTP mode.");
         }
 
-        $this->connection->setIsPassive($value);
-
         return true;
     }
 

src/Connection/Connection.php

@@ -43,15 +43,9 @@ abstract class Connection implements ConnectionInterface
     /* @var string */
     protected $password;
 
-    /** @var bool */
-    protected $isSecure;
-
     /** @var bool */
     protected $isConnected;
 
-    /** @var bool */
-    protected $isPassive;
-
     /**
      * Prepares an FTP connection.
      *
@@ -69,20 +63,31 @@ public function __construct(string $host, string $username, string $password, in
         $this->password    = $password;
         $this->port        = $port;
         $this->timeout     = $timeout;
-        $this->isPassive   = false;
         $this->isConnected = false;
 
         $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
+    {
+        return $this->wrapper;
+    }
+
     /**
      * {@inheritDoc}
      * 
@@ -136,14 +141,6 @@ public function getPassword() : string
     {
         return $this->password;
     }
-    
-    /**
-     * @inheritDoc
-     */
-    public function isSecure() : bool
-    {
-        return $this->isSecure;
-    }
 
     /**
      * @inheritDoc
@@ -153,24 +150,6 @@ public function isConnected() : bool
         return $this->isConnected;
     }
 
-    /**
-     * @inheritDoc
-     */
-    public function isPassive() : bool
-    {
-        return $this->isPassive;
-    }
-
-    /**
-     * @param bool $bool
-     *
-     * @return void
-     */
-    public function setIsPassive(bool $bool) : void
-    {
-        $this->isPassive = $bool;
-    }
-
     /**
      * {@inheritDoc}
      *
@@ -202,18 +181,14 @@ public function close() : bool
     }
 
     /**
-     * @return bool
-     *
      * @throws ConnectionException
      */
-    protected function login() : bool
+    protected function login() : void
     {
         if (!$this->wrapper->login($this->getUsername(), $this->getPassword())) {
             throw new ConnectionException($this->wrapper->getErrorMessage()
                 ?: "Logging into the FTP server was failed.");
         }
-
-        return true;
     }
 
     /**
@@ -228,10 +203,6 @@ protected function connect() : void
 
     private function isValidHost($host) : bool
     {
-        if (filter_var(gethostbyname($host), FILTER_VALIDATE_IP) === false) {
-            return false;
-        }
-
-        return true;
+        return filter_var(gethostbyname($host), FILTER_VALIDATE_IP) !== false;
     }
 }

src/Connection/ConnectionInterface.php

@@ -63,22 +63,8 @@ public function getUsername() : string;
      */
     public function getPassword() : string;
 
-    /**
-     * @return bool
-     *
-     * @deprecated https://github.com/lazzard/php-ftp-client/issues/15
-     */
-    public function isSecure() : bool;
-
     /**
      * @return bool
      */
     public function isConnected() : bool;
-
-    /**
-     * @return bool
-     *
-     * @deprecated Deprecated and will be removed in future releases, relying on this method is discouraged.
-     */
-    public function isPassive() : bool;
 }

src/Connection/FtpConnection.php

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