Lazzard/FtpClient

This library provides helper classes and methods to manage your FTP files in an OOP way.

Note: This library aimed to be a full FTP/FTPS client solution for the old(^5.5)and newer PHP releases(^8.0)* that support FTP extension.*

Quick Start

composer require lazzard/php-ftp-client

<?php

require __DIR__ . '/vendor/autoload.php';

use Lazzard\FtpClient\Connection\FtpSSLConnection;
use Lazzard\FtpClient\Config\FtpConfig;
use Lazzard\FtpClient\FtpClient;

try {
    if (!extension_loaded('ftp')) {
        throw new \RuntimeException("FTP extension not loaded.");
    }

    $connection = new FtpSSLConnection('host', 'username', 'password');
    $connection->open();

    $config = new FtpConfig($connection);
    $config->setPassive(true);

    $client = new FtpClient($connection);

    print_r($client->getFeatures());

    $connection->close();

} catch (Throwable $ex) {
    print_r($ex->getMessage());
}

Usage

upload/download

// download a remote file
$client->download('path/to/remote/file', 'path/to/local/file');

// upload a local file to remote server
$client->upload('path/to/local/file', 'path/to/remote/file');

Asynchronous upload/download

// download a remote file asynchronously
$client->asyncDownload('path/to/remote/file', 'path/to/local/file', function ($state) {
    // do something every second while downloading this file
}, 1, FtpWrapper::BINARY);

// upload a remote file asynchronously
$client->asyncUpload('path/to/local/file', 'path/to/remote/file', function ($state) {
    // do something 
}, 1, FtpWrapper::BINARY);

Find more about asynchronous stuff here.

listing

// get files names within an FTP directory
$client->listDir('path/to/directory');

// get only directories
$client->listDir('path/to/directory', FtpClient::DIR_TYPE);

// get detailed information of each file within a remote directory including 
// the file path of each file
$client->listDirDetails('path/to/directory');

// recursively
$client->listDirDetails('path/to/directory', true);

copy

// copy a remote file/directory to another directory
$client->copy('path/to/remote/source', 'path/to/remote/directory');

// copy a local file/directory to the server
$client->copyFromLocal('path/to/local/file', 'path/to/remote/directory'); 

// copy a remote file/directory to local machine
$client->copyToLocal('path/to/remote/source', 'path/to/local/directory'); 

search

// get all png files within the giving directory with their details
$client->find('/.*\.png$/i', 'path/to/directory'); 

// recursively
$client->find('/.*\.png$/i', 'path/to/directory', true); 

size

// get file size
$client->fileSize('path/to/file');

// get directory size
$client->dirSize('path/to/directory');

file/directory creating

// create an FTP file
$client->createFile('path/to/file');

// create a file with content
$client->createFile('path/to/file', 'Hello world!!');

// create a remote directory
// note: this method supports recursive directory creation
$client->createDir('directory');

append

// append the giving content to a remote file
$client->appendFile('path/to/file', $content);

remove/rename

// remove an FTP file
$client->removeFile('path/to/file');

// remove an FTP directory (be careful all the files within this directory will be removed)
$client->removeDir('path/to/directory');

// rename an FTP file/directory
$client->rename('path/to/file', $newName);

move

// move an FTP file or directory to another folder
$client->move('path/to/file', 'path/to/directory');

count

// get the count of all the files within a directory
$client->getCount('path/to/directory');

// recursively
$client->getCount('path/to/directory', true);

// recursively and files only
$client->getCount('path/to/directory', true, FtpClient::FILE_TYPE);

permissions

// set a permissions on the giving FTP file/directory 
$client->setPermissions('path/to/file', [
    'owner' => 'r-w', // read & write
    'group' => 'w',
    'world' => 'w-r-e'
]);

// or you can use the UNIX file permission digits 
$client->setPermissions('path/to/file', 777);

is methods

// is an ftp directory ?
$client->isDir('path/to/file/or/directory');

// is a file type ?
$client->isFile('path/to/file/or/directory');

// is an empty file/directory ?
$client->isEmpty('path/to/file/or/directory');

// is exists on the FTP server ?
$client->isExists('path/to/file/or/directory');

// is the server support the size feature ?
$client->isFeatureSupported('SIZE');

others

// get the last modified time of the giving file (not working with directories)
$client->lastMTime('path/to/file');

// get a content of an FTP file
$client->getFileContent('path/to/file', FtpWrapper::ASCII);

// get all supported features by the FTP server
$client->getFeatures();

// get the server system
$client->getSystem();

// send a request to allocate a space of bytes for the next transfer operation
// some FTP servers requires this before transfer operations 
$client->allocateSpace(2048);

// prevent the server from closing the connection and keeping it alive
$client->keepAlive();

You can see all available methods here.

More documentation

• [Manipulate the FTP connection with ConnectionInterface.][1]
• [Configure the connection instance with FtpConfig.][2]
• [Start working with the base class FtpClient.][3]
• [Sending FTP commands with FtpCommand.][4]
• [How to use the FtpWrapper class directly.][5]
• [Running the integration tests.][6]

[1]: docs/ConnectionInterface.md

[2]: docs/FtpConfig.md

[3]: docs/FtpClient.md

[4]: docs/FtpCommand.md

[5]: docs/FtpWrapper.md

[6]: docs/tests.md

Version Guidance

| 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.5.x | EOL | [v1.5.3][9] | ^7.2 \| 8.0.* | | 1.6.x | EOL | [v1.6.1][10] | ^7.4 \| 8.0.* | | 1.7.x | Latest | [v1.7.0][11] | ^7.4 \| ^8.0 |

[7]: https://github.com/lazzard/php-ftp-client/releases/tag/v1.0.2

[8]: https://github.com/lazzard/php-ftp-client/releases/tag/v1.1.0

[9]: https://github.com/lazzard/php-ftp-client/releases/tag/v1.5.3

[10]: https://github.com/lazzard/php-ftp-client/releases/tag/v1.6.1

[11]: https://github.com/lazzard/php-ftp-client/releases/tag/v1.7.0

Contribution

Feel free to fork this repo if you want to enhance it or adding new features, also reported some issues that may have you facing while using the library will be very appreciated, Thank you!

They support this project

<img width="150px" src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_square.png"/>

License

MIT License. please see the LICENSE FILE for more information.