Ftp

<br/> >i 本文档的最新修订日期是: > **2020-12-27** # Ftp ## 模块简述 通过FTP进行上传、下载等操作。 ## 模块配置 配置文件位于 <font color="#c7254e">`/Config/Ftp.php`</font> 。 * **<font color="#ff6600">`Server`</font>** <font color="#0099ff">`(String)`</font> <font color="#bbbbbb">`''`</font> : 指定FTP连接地址。 * **<font color="#ff6600">`Port`</font>** <font color="#0099ff">`(Int)`</font> <font color="#bbbbbb">`21`</font> : 指定远程服务器的FTP服务的端口。 * **<font color="#ff6600">`User`</font>** <font color="#0099ff">`(String)`</font> <font color="#bbbbbb">`''`</font> : 指定连接FTP时提供的用户名。 * **<font color="#ff6600">`Password`</font>** <font color="#0099ff">`(String)`</font> <font color="#bbbbbb">`''`</font> : 指定连接FTP时提供的密码。 ## 公共参数 * **<font color="#ff6600">`timeout(超时时间)`</font>** <font color="#0099ff">`(Int)`</font> <font color="#BBBBBB">`默认值见方法参数`</font>: 用以指定超时时间。 值的单位为秒(s)。 ## :: Up()方法 ### 语法 **<font color="#0099ff"><font color="#ff6600">Ftp</font> :: <font color="#ff6600">Up</font> ( <kbd>传参数组</kbd> ) </font>** ### 说明 将一个文件通过FTP上传到远程服务器上的指定的位置。 此方法 <font color="#c7254e">`支持`</font> 中文参数名。 ### 参数 * **<font color="#ff6600">`from(本地路径)`</font>** <font color="#0099ff">`(String)`</font> <font color="#BBBBBB">`<必须>`</font>: 指定需要上传的文件路径,值为相对于 <font color="#c7254e">`应用根目录`</font> (即Core、Source文件夹所在的目录,通常是站点根目录)的路径,以 <font color="#c7254e">`/`</font> 开始。 * **<font color="#ff6600">`to(远程路径)`</font>** <font color="#0099ff">`(String)`</font> <font color="#BBBBBB">`<必须>`</font>: 指定上传的文件在远程符服务器存储的路径。 * **<font color="#ff6600">`timeout(连接信息)`</font>** <font color="#0099ff">`(Int)`</font> <font color="#BBBBBB">`90`</font>: 详见本模块 <font color="#c7254e">`公共参数`</font> 部分的说明。 ### 返回 <font color="#0099ff">`(Bool)`</font> 类型。 返回值为 <font color="#c7254e">`TRUE`</font> 时代表操作成功完成、<font color="#c7254e">`FALSE`</font> 代表操作失败。 ## :: Down()方法 ### 语法 **<font color="#0099ff"><font color="#ff6600">Ftp</font> :: <font color="#ff6600">Down</font> ( <kbd>传参数组</kbd> )</font>** ### 说明 将远程服务器上的一个文件通过FTP下载到指定的位置。 此方法 <font color="#c7254e">`支持`</font> 中文参数名。 ### 参数 * **<font color="#ff6600">`from(远程路径)`</font>** <font color="#0099ff">`(String)`</font> <font color="#BBBBBB">`<必须>`</font>: 指定需要下载的文件在远程服务器上的存储路径。 * **<font color="#ff6600">`to(本地路径)`</font>** <font color="#0099ff">`(String)`</font> <font color="#BBBBBB">`<必须>`</font>: 指定将下载的文件存储到何处,值为相对于 <font color="#c7254e">`应用根目录`</font> (即Core、Source文件夹所在的目录,通常是站点根目录)的路径,以 <font color="#c7254e">`/`</font> 开始。 * **<font color="#ff6600">`timeout(连接信息)`</font>** <font color="#0099ff">`(Int)`</font> <font color="#BBBBBB">`90`</font>: 详见本模块 <font color="#c7254e">`公共参数`</font> 部分的说明。 ### 返回 <font color="#0099ff">`(Bool)`</font> 类型。 返回值为 <font color="#c7254e">`TRUE`</font> 时代表操作成功完成、<font color="#c7254e">`FALSE`</font> 代表操作失败。