ginkgo\Ftp

FTP 文件传输

类摘要

namespace ginkgo;

class Ftp {
  // 属性
  public $config = array();
  public $caInfo;
  public $result;
  public $error;
  public $errno;
  public $statusCode;
  public $allowScheme = array('ftp', 'ftps', 'sftp');

  protected static $instance;

  private $configThis = array(
    'scheme'          => '',
    'host'            => '',
    'port'            => 21,
    'user'            => '',
    'pass'            => '',
    'path'            => '',
    'pasv'            => false,
    'verify_peer'     => false,
    'verify_host'     => false,
    'return_transfer' => true,
    'timeout'         => 30,
  );

  private $res_curl;
  private $userPass;
  private $hostUrl;
  private $hostPath;

  // 已弃用属性
  public $res_conn;

  // 方法
  public static instance( [ array $config ] ) : object
  public config( array $config )
  public init() : bool
  public pasv( [ bool $pasv ] )
  public port( [ int $port ] )
  public fileUpload( string $path_local, string $path_remote [, bool $ascii = true ] ) : bool
  public fileDelete( string $path_remote ) : bool
  public getError() : string
  public getErrno() : int

  protected __construct( [ array $config ] ) : object
  protected __clone()

  private optProcess( array $opts )
  private urlProcess() : bool
  private errRecord( string $msg ) // since 0.2.4

  // 已弃用方法
  public connect() : bool
  public login() : bool
  public dirList( string $path_remote [, bool $is_abs = false ] ) : array
  public dirMk( string $path_remote [, bool $is_abs = false ] ) : bool
  public dirDelete( string $path_remote [, bool $is_abs = false ] ) : bool
  public close()
  private initConfig() : bool
}

成员目录

$config 配置，$configThis 默认配置

public $config;
private $configThis;

结构

instance() 实例化方法

public static function instance( [ array $config ] ) : object

参数

• config 配置参数

返回

• 本类的实例

config() 配置

0.2.0 新增

public function config( array $config )

参数

• config 配置参数

返回

• 无

init() 初始化

0.2.0 之前，快速执行 connect() 和 login() 方法

public function init() : bool

参数

• 无

返回

• 布尔值

pasv() 设置被动模式

0.2.0 新增

public function pasv( [ bool $pasv = true ] )

参数

• pasv，是否开启被动模式

返回

• 无

port() 设置端口

0.2.0 新增

public function port( [ int $port = 21 ] )

参数

• port，端口

返回

• 无

fileUpload() 上传文件

public function fileUpload( string $path_local, string $path_remote [, bool $is_abs = false [, int $mod = FTP_ASCII ]] ) : bool // 0.2.0 前
public function fileUpload( string $path_local, string $path_remote [, bool $ascii = true ] ) : bool // 0.2.0 及以后

参数

• path_local 本地路径
• path_remote 远程路径
• $is_abs 给定的路径是否为绝对路径，0.2.0 弃用

• $mod 上传模式，0.2.0 弃用，可能的值如下：

  可能的值

  值	类型	描述
  FTP_ASCII（默认值）	预定义常量 ｜ 文本模式
  FTP_BINARY	预定义常量 ｜ 二进制模式

• $ascii 是否以 ASCII 码模式上传，0.2.0 新增

返回

• 布尔值

fileDelete() 删除文件

public function fileDelete( string $path_remote [, bool $is_abs = false ] ) : bool

参数

• path_remote 远程路径
• $is_abs 给定的路径是否为绝对路径 0.2.0 弃用

返回

• 布尔值

close() 关闭 FTP 连接

public function close()

参数

• 无

返回

• 无

getError() 获取错误

public function getError() : string

参数

• 无

返回

• 错误消息

optProcess() cURL 选项处理

0.2.0 新增

private function optProcess( $opts )

参数

• opts 选项

返回

• 无

urlProcess() 主机 URL 处理

0.2.0 新增

private function urlProcess() : bool

参数

• 无

返回

• 布尔值

connect() 连接服务器

0.2.0 弃用

public function connect() : bool

参数

• 无

返回

• 布尔值

login() 登录

0.2.0 弃用

public function login() : bool

参数

• 无

返回

• 布尔值

dirList() 列出目录结构

0.2.0 弃用

public function dirList( string $path_remote [, bool $is_abs = false ] ) : array

参数

• path_remote 远程路径
• $is_abs 给定的路径是否为绝对路径

返回

• 目录列表

dirMk() 创建目录

0.2.0 弃用

public function dirMk( string $path_remote [, bool $is_abs = false ] ) : bool

参数

• path_remote 远程路径
• $is_abs 给定的路径是否为绝对路径

返回

• 布尔值

dirDelete() 递归删除整个目录

0.2.0 弃用

public function dirDelete( string $path_remote [, bool $is_abs = false ] ) : bool

参数

• path_remote 远程路径
• $is_abs 给定的路径是否为绝对路径

返回

• 布尔值

initConfig() 配置初始化

0.2.0 弃用

private function initConfig() : bool

参数

• 无

返回

• 布尔值

errRecord() 记录错误

0.2.4 新增

private function errRecord( string $msg )

参数

• #msg 错误信息