hguenot/yii2-gsftp

Ftp is a FTP extension for [YII 2 Framework](http://www.yiiframework.com).

Installs: 80 537

Dependents: 0

Suggesters: 0

Security: 0

Stars: 11

Watchers: 6

Forks: 13

Open Issues: 2

Type:yii2-extension

3.0.0 2020-04-22 07:48 UTC

This package is auto-updated.

Last update: 2024-05-16 03:20:25 UTC


README

Latest Stable Version Total Downloads License

SFtp

SFtp is a FTP extension for YII 2 Framework based on Yii2-gftp extension.

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist hguenot/yii2-gsftp "*"

or add

"hguenot/yii2-gsftp": "*"

to the require section of your composer.json file.

Usage

Here is a basic usage of GFtp extension.

  • Create an FTP application component (in your Web config file)
return [
	// [...]
	'components'=>[
		// [...]
		'ftp' => [
			'class' => '\gftp\FtpComponent',
			'connectionString' => 'sftp://user:pass@host:22',
			'driverOptions' => [ 'timeout' => 120 ]
		]
	],
	// [...]
];
  • You can user either a connection string where protocol could be ftp or ftps or directly set protocol, user, pass, host and port properties :
return [
	// [...]
	'components'=>[
		// [...]
		'ftp' => [
			'class' => '\gftp\FtpComponent',
			'driverOptions' => [
				'class' => \gftp\FtpProtocol::valueOf('sftp')->driver,
				'user' => 'me@somewhere.otrb',
				'pass' => 'PassW0rd',
				'host' => 'ssh.somewhere.otrb',
				'port' => 22,
				'timeout' => 120
			]
		]
	],
	// [...]
];

Examples

You can find examples on Yii2-gftp extension site.