autoframe/components-ftp-transfer

Transfer files/folders from local to ftp with php. Resumable transfers, cli ftp, upload progress...

1.0.1 2023-10-22 19:03 UTC

Requires

• php: >=7.4
• ext-ftp: *
• autoframe/components-filesystem: ^2.0
• autoframe/process-control: ^1.0

Requires (Dev)

• phpunit/phpunit: ^9.6 || ^10

MIT

• Nistor Alexandru Marius

• ftp
• file system
• looping
• Recoursive copy
• Upload pregress

README

PHP File copy to FTP protocol via CLI uploader and reporter

namespace Autoframe\Components\FtpTransfer;
...
class AfrFtpBackupConfig
{
    protected string $sBusinessLogicClass = AfrFtpPutBigData::class; //Class must implement AfrFtpBusinessLogicInterface::class
    public function setBusinessLogic(string $BusinessLogicClass): void {}
    public function getBusinessLogic(): string {}
    
    protected ?string $sReportClass = null;  //Class must implement AfrFtpReportInterface::class
    public function setReportClass(string $sReportClass): void {}
    public function getReportClass(): string {}
    
    public string $sTodayFolderName = 'today';
    public string $sLatestFolderName = '!latest';
    public string $sResumeDump = __DIR__ . DIRECTORY_SEPARATOR . 'self.resume.php';

    /**
     * From local dir path is in key,
     * Ftp destination dir path is into value
     * = [ 'C:\xampp\htdocs\afr\src\FtpBackup' => '/bpg-backup/MG1/test2/resume']
     */
    public array $aFromToPaths;
    
    public string $ConServer; //Server ip or hostname
    public string $ConUsername;
    public string $ConPassword;
    public int $ConPort = 21;
    public int $ConTimeout = 90;
    public bool $ConPassive = true;
    public int $iDirPermissions = 0775;
 
    public string $sReportTarget = '';
    public string $sReportTo = '';
    public string $sReportToSecond = '';
    public string $sReportSubject = 'Ftp upload report';
    public string $sReportBody ;
    public $mReportMixedA = null;
    public $mReportMixedS = null;
    public $mReportMixedI = null;
    public int $iLogUploadProgressEveryXSeconds = 60;

    public function __construct(string $sTodayFolderName = null)
    {
        if ($sTodayFolderName === null) {
            $sTodayFolderName = date('Ymd');
        }
        $this->sTodayFolderName = $sTodayFolderName;
    }

}

namespace Autoframe\Components\FtpTransfer\Connection;
...
interface AfrFtpConnectionInterface
{
    public function connect();
    public function disconnect(): void;
    public function reconnect(int $iTimeoutMs = 10);
    public function getConnection();
    public function getLoginResult(): bool;
    public function getError(): string;
    public function __destruct();
    public function getDirPerms(): int; //from ftpConfig object
}

namespace Autoframe\Components\FtpTransfer\FtpBusinessLogic;
...
interface AfrFtpBusinessLogicInterface
{
    public function makeBackup(): void;
}

namespace Autoframe\Components\FtpTransfer\Log;
...
interface AfrFtpLogInterface
{
    public const FATAL_ERR = 1;
    public const MESSAGE = 2;

    public function newLog(): self;
    public function logMessage(string $sMessage, int $iType): self;
    public function closeLog(): self;
}

namespace Autoframe\Components\FtpTransfer\Report;
...
interface AfrFtpReportInterface
{
    public function ftpReport(AfrFtpBackupConfig $oFtpConfig): array;
}