php-ssh2-sftp-client

PHP Sftp Client Class using SSH2 functions and shell commands, with server-side error handlings

Copyright (c) 2015 GR
licensed under the MIT licenses
http://www.opensource.org/licenses/mit-license.html

USAGE

Connect to an SSH server & authenticate:

<?php

// initialize
$sftp = new \GR\SftpClient();

// connect
$sftp->connect($host, $port, $timeout);

// login
$sftp->login($user, $pass);

Get current directory:

<?php

$sftp->getCurrentDirectory();

Create directory

<?php

$sftp->createDirectory($path, $ignore_if_exists);

Delete directory

<?php

$sftp->deleteDirectory($path);

Delete file

<?php

$sftp->deleteFile($path);

Get directory content list

<?php

// just names
$sftp->getDirectoryList($path, $recursive);

// rawlist
$sftp->getDirectoryRawList($path, $recursive);

// <b>formated</b> rawlist
$sftp->getDirectoryRawListFormatted($path, $recursive);

Get file stat

<?php

$stat = $sftp->stat($path);

Download a file

<?php

$sftp->downloadFile($remote_file, $local_file);

Upload a file

<?php

$sftp->uploadFile($local_file, $remote_file[, int $create_mode = 0644 ] );

Rename file/directory

<?php

// Rename File
$sftp->renameFile($oldname, $newname);

// Rename Folder
$sftp->renameDirectory($oldname, $newname);

// both of them are alias of
$sftp->renameFileOrFolder($oldname, $newname);

Create Symlink

<?php

$sftp->createSymlink($target, $link);

Execute custom command

<?php

$sftp->ssh2_exec($cmd);

Close connection

<?php

$sftp->close();

Handle Errors

<?php

try {
	$sftp = new \GR\SftpClient();
	$sftp->connect($host, $port, $timeout);
	$sftp->login($user, $pass);
}
catch(ErrorException $e) {
	// handle the error
}

SUXUMI/php-ssh2-sftp-client