Joomla! CMS 5.1.x API » \Joomla\CMS\Client\FtpClient

FtpClient 对象构造函数

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

自	1.5

参数

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

响应

混合

FtpClient 对象析构函数

__destruct() :

关闭现有的连接（如果存在）

自	1.5

响应

混合

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

_findMode( fileName) :

自	1.5

参数

fileName: string文件名

响应

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

设置传输模式

_mode( mode) :

自	1.5

参数

mode: int数据传输模式的整数表示 [1:Binary|0:Ascii] 也可以使用定义的常量 [FTP_BINARY|FTP_ASCII]

响应

bool如果成功则为真

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

_passive() :

自	1.5

响应

bool如果成功则为真

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

_putCmd( cmd,  expectedResponse) :

自	1.5

参数

cmd: string要发送到 FTP 服务器的命令
expectedResponse: mixed整数响应代码或整数响应代码数组

响应

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

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

_verifyResponse( expected) :

自	1.5

参数

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

响应

bool如果服务器的响应代码符合预期则为真

用于将字符串追加到 FTP 服务器的方法

append( remote,  buffer) :

自	3.6.0

参数

remote: string要追加到的文件的 FTP 路径
buffer: string要追加到 FTP 服务器的内容

响应

bool如果成功则为真

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

chdir( path) :

自	1.5

参数

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

响应

bool如果成功则为真

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

chmod( path,  mode) :

自	1.5

参数

path: string要更改模式的路径
mode: mixed要更改到的八进制值，例如 '0777'、0777 或 511（字符串或整数）

响应

bool如果成功则为真

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

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

自	3.0.0

参数

host: string要连接到的主机 [默认值：127.0.0.1]
port: int要连接到的端口 [默认值：端口 21]

响应

bool如果成功则为真

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

create( path) :

自	1.5

参数

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

响应

bool如果成功则为真

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

delete( path) :

自	1.5

参数

path: string要删除的路径

响应

bool如果成功则为真

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

get( local,  remote) :

自	1.5

参数

local: string保存远程文件的本地路径
remote: string要在 FTP 服务器上获取的远程文件路径

响应

bool如果成功则为真

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

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

静态

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

自	1.5

参数

host: string要连接到的主机
port: string要连接到的端口
options: array<string|int, mixed>包含以下任何选项的数组：type=>[FTP_AUTOASCII|FTP_ASCII|FTP_BINARY]，timeout=>(int)
user: string用于连接的用户名
pass: string用于连接的密码

响应

FtpClientFTP 客户端对象。

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

isConnected() :

自	1.5

响应

bool如果已连接则为真

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

listDetails( path = null,  type = 'all') :

自	1.5

参数

path: string要存储在 FTP 服务器上的本地文件路径
type: string返回类型 [raw|all|folders|files]

响应

mixed如果 $type 为 raw：字符串目录列表，否则为包含文件名的字符串数组

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

listNames( path = null) :

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

自	1.5

参数

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

响应

string目录列表

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

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

自	1.5

参数

user: string登录到服务器的用户名
pass: string登录到服务器的密码

响应

bool如果成功则为真

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

mkdir( path) :

自	1.5

参数

path: string要创建的目录

响应

bool如果成功则为真

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

pwd() :

自	1.5

响应

string当前工作目录

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

quit() :

自	1.5

响应

bool如果成功则为真

用于将 FTP 服务器内容中的文件读取到缓冲区中的方法

read( remote,  &buffer) :

自	1.5

参数

remote: string要在 FTP 服务器上读取的远程文件路径
buffer: string要将文件内容读取到的缓冲区变量

响应

bool如果成功则为真

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

reinit() :

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

自	1.5

响应

bool如果成功则为真

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

rename( from,  to) :

自	1.5

参数

from: string要更改文件/文件夹的路径
to: string要更改文件/文件夹的路径

响应

bool如果成功则为真

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

restart( point) :

自	1.5

参数

point: int要重新启动传输的字节

响应

bool如果成功则为真

设置客户端选项

setOptions(mixed||string|int options) :

自	1.5

参数

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

响应

bool如果成功则为真

获取远程文件的大小。

size( remote) :

自	3.6.0

参数

remote: string要获取其大小的 FTP 文件路径

响应

mixed字节数或错误时的 false

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

store( local,  remote = null) :

自	1.5

参数

local: string要存储在 FTP 服务器上的本地文件路径
remote: string要创建的 FTP 文件路径

响应

bool如果成功则为真

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

syst() :

自	1.5

响应

string系统标识符字符串

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

write( remote,  buffer) :

自	1.5

参数

remote: string要写入的文件的 FTP 路径
buffer: string要写入 FTP 服务器的内容

响应

bool如果成功则为真

响应代码

自	4.3.0

类型(s)

字符串

响应消息

自	4.3.0

类型(s)

字符串

套接字资源

自	1.5

类型(s)

资源

数据端口连接资源

自	1.5

类型(s)

资源

被动连接信息

自	1.5

类型(s)

array<string|int, mixed>

响应消息

自	1.5

类型(s)

字符串

超时限制

自	1.5

类型(s)

int

传输类型

自	1.5

类型(s)

int

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

自	1.5

类型(s)

array<string|int, mixed>

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

自	1.5

类型(s)

array<string|int, mixed>

FtpClient 实例容器。

静态

自	2.5

类型(s)

array<string|int, mixed>