FtpClient

FTP 客户端类

1.0

Joomla 框架

方法

__construct

FtpClient 对象构造函数

__construct(mixed||string|int options = []) : 

1.0

参数

options

array<string|int, mixed>要设置的选项的关联数组

响应

mixed

__destruct

FtpClient 对象析构函数

__destruct() : 

关闭现有连接(如果有)

1.0

响应

mixed

_findMode

用于确定特定文件的正确传输模式的方法

_findMode( fileName) : 

1.0

参数

fileName

string文件名

响应

int此文件类型的传输模式 [FTP_ASCII|FTP_BINARY]

_mode

设置传输模式

_mode( mode) : 

1.0

抛出

FilesystemException

参数

mode

int数据传输模式的整数表示形式 [1:二进制|0:ASCII],也可以使用定义的常量 [FTP_BINARY|FTP_ASCII]

响应

bool如果成功则为真

_passive

将服务器设置为被动模式并打开数据端口连接

_passive() : 

1.0

抛出

FilesystemException

响应

bool如果成功则为真

_putCmd

向 FTP 服务器发送命令并验证预期响应代码

_putCmd( cmd,  expectedResponse) : 

1.0

抛出

FilesystemException

参数

cmd

string要发送到 FTP 服务器的命令

expectedResponse

mixed整数响应代码或整数响应代码数组

响应

bool如果命令成功执行则为真

_verifyResponse

验证来自服务器的响应代码,如果设置了标志,则记录响应

_verifyResponse( expected) : 

1.0

抛出

FilesystemException

参数

expected

mixed整数响应代码或整数响应代码数组

响应

bool如果来自服务器的响应代码是预期的,则为真

chdir

用于在 FTP 服务器上更改当前工作目录的方法

chdir( path) : 

1.0

抛出

FilesystemException

参数

path

string要在服务器上更改到的路径

响应

bool如果成功则为真

chmod

用于更改 FTP 服务器上路径的模式的方法

chmod( path,  mode) : 

1.0

抛出

FilesystemException

参数

path

string要更改模式的路径

mode

mixed要更改为的八进制值,例如 '0777'、0777 或 511(字符串或整数)

响应

bool如果成功则为真

connect

用于连接到 FTP 服务器的方法

connect( host = '127.0.0.1',  port = 21) : 

1.0

抛出

FilesystemException

参数

host

string要连接到的主机 [默认值:127.0.0.1]

port

int要连接到的端口 [默认值:端口 21]

响应

bool如果成功则为真

create

用于在 FTP 服务器上创建空文件的方法

create( path) : 

1.0

抛出

FilesystemException

参数

path

string要存储在 FTP 服务器上的本地文件路径

响应

bool如果成功则为真

delete

用于删除 FTP 服务器上的路径 [文件/文件夹] 的方法

delete( path) : 

1.0

抛出

FilesystemException

参数

path

string要删除的路径

响应

bool如果成功则为真

get

用于从 FTP 服务器获取文件并将其保存到本地文件的方法

get( local,  remote) : 

1.0

抛出

FilesystemException

参数

local

string保存远程文件的本地路径

remote

string要获取的远程文件的路径

响应

bool如果成功则为真

getInstance

返回全局 FTP 连接器对象,仅在它不存在时创建它。

getInstance( host = '127.0.0.1',  port = '21', mixed||string|int options = [],  user = null,  pass = null) : \Joomla\Filesystem\Clients\FtpClient
static

您可以在参数中选择性地指定用户名和密码。如果您这样做,则不能使用相同对象再次使用不同的凭据登录()。如果您不使用此选项,则必须在完成操作时退出()当前连接,以释放它供其他人使用。

1.0

参数

host

string要连接到的主机

port

string要连接到的端口

options

array<string|int, mixed>包含以下任何选项的数组:type=>[FTP_AUTOASCII|FTP_ASCII|FTP_BINARY]、timeout=>(int)

user

string用于连接的用户名

pass

string用于连接的密码

响应

FtpClientFTP 客户端对象。

isConnected

用于确定对象是否已连接到 FTP 服务器的方法

isConnected() : 

1.0

响应

bool如果已连接,则为真

listDetails

用于列出 FTP 服务器上目录的内容的方法

listDetails( path = null,  type = 'all') : string||string|int

1.0

抛出

FilesystemException

参数

path

string要存储在 FTP 服务器上的本地文件路径

type

string返回类型 [raw|all|folders|files]

响应

array<string|int, string>如果 $type 为 raw:字符串目录列表,否则为包含文件名的字符串数组

listNames

用于列出 FTP 服务器上目录内容的文件名的方法

listNames( path = null) : 

注意:某些服务器还会返回文件夹名称。但是,为了确保在所有服务器上列出文件夹,如果您还需要处理文件夹,则应使用 listDetails()。

1.0

抛出

FilesystemException

参数

path

string要存储在 FTP 服务器上的本地文件路径

响应

string目录列表

login

用于在连接后登录到服务器的方法

login( user = 'anonymous',  pass = '[email protected]') : 

1.0

抛出

FilesystemException

参数

user

string用于登录到服务器的用户名

pass

string用于登录到服务器的密码

响应

bool如果成功则为真

mkdir

用于在 FTP 服务器上创建目录的方法

mkdir( path) : 

1.0

抛出

FilesystemException

参数

path

string要创建的目录

响应

bool如果成功则为真

pwd

用于检索 FTP 服务器上的当前工作目录的方法

pwd() : 

1.0

抛出

FilesystemException

响应

string当前工作目录

quit

用于退出并关闭连接的方法

quit() : 

1.0

响应

bool如果成功则为真

read

用于将 FTP 服务器上的文件内容读入缓冲区的方法

read( remote,  &buffer) : 

1.0

抛出

FilesystemException

参数

remote

string要从 FTP 服务器上读取的远程文件路径

buffer

string要将文件内容读入的缓冲区变量

响应

bool如果成功则为真

reinit

用于重新初始化服务器的方法,即需要再次登录。

reinit() : 

注意:此命令并非所有服务器都可用。

1.0

抛出

FilesystemException

响应

bool如果成功则为真

rename

用于重命名 FTP 服务器上的文件/文件夹的方法

rename( from,  to) : 

1.0

抛出

FilesystemException

参数

from

string要更改的文件/文件夹路径

to

string要更改到的文件/文件夹路径

响应

bool如果成功则为真

restart

用于在给定字节处重新启动数据传输的方法

restart( point) : 

1.0

抛出

FilesystemException

参数

point

int要从其处重新启动传输的字节

响应

bool如果成功则为真

setOptions

设置客户端选项

setOptions(mixed||string|int options) : 

1.0

参数

options

array<string|int, mixed>要设置的选项的关联数组

响应

bool如果成功则为真

store

用于将文件存储到 FTP 服务器的方法

store( local,  remote = null) : 

1.0

抛出

FilesystemException

参数

local

string要存储在 FTP 服务器上的本地文件路径

remote

string要创建的文件的 FTP 路径

响应

bool如果成功则为真

syst

用于从 FTP 服务器获取系统字符串的方法

syst() : 

1.0

抛出

FilesystemException

响应

string系统标识符字符串

write

用于将字符串写入 FTP 服务器的方法

write( remote,  buffer) : 

1.0

抛出

FilesystemException

参数

remote

string要写入的 FTP 文件路径

buffer

string要写入 FTP 服务器的内容

响应

bool如果成功则为真

属性

conn

套接字资源

1.0

类型

连接

dataconn

数据端口连接资源

1.0

类型

resource

pasv

被动连接信息

1.0

类型

array<string|int, mixed>

response

响应消息

1.0

类型

string

responseCode

响应代码

1.0

类型

int

responseMsg

响应消息

1.0

类型

string

timeout

超时限制

1.0

类型

int

type

传输类型

1.0

类型

int

autoAscii

用于保存 ASCII 格式文件扩展名的数组

1.0

类型

array<string|int, mixed>

lineEndings

用于保存本机换行符的数组

1.0

类型

array<string|int, mixed>

instances

FtpClient 实例容器。

static

1.0

类型

array<string|int, FtpClient>