boaPHP开发手册v5.5

download类
版本 1.0+
命名空间 boa
文件 boa/download.php
说明 下载类,继承base类,配置:'DOWNLOAD' => [],
配置
配置项 默认值 类型 说明
header [] array 附加的HTTP请求头
expire 0 int HTTP请求执行时长(秒),0=不限
size 2 float 允许的文件大小(MB),0=不限
exts jpg,png,gif string 允许的文件后缀
path BS_WWW .'file/' string 文件存放根目录
name null mixed 自定义文件保存名称(不含后缀,可以包含目录),支持单个(string)或多个(array)
ext null mixed 自定义文件保存后缀,不设定则自动使用原来文件后缀,支持单个(string)或多个(array),与name对应,单个的话所有文件均使用该后缀
default Y/m/d/Hisv string 没有自定义的情况下按此格式自动生成文件名称,date_format()函数支持的格式
break false bool 同时下载多个文件时,遇到失败是否终止,默认继续
auto false bool 下载图片时是否自动转换图片格式,默认否
目录
方法 说明
__construct() 初始化
cfg() 获取或设置配置信息
get_file() 获取单个下载文件信息
get_files() 获取全部下载文件信息,常用于more()
one() 单文件下载
more() 多文件下载
方法

__construct()

说明
初始化
参数 必须 默认值 类型 说明
$cfg [] array 配置数据
示例
$dn = boa::download();

cfg()

说明
获取或设置配置信息
参数 必须 默认值 类型 说明
$k null string
$v null string
返回值
同 base 类
示例
$dn->cfg('size', 2.5);

get_file()

说明
获取单个下载文件信息
参数 必须 默认值 类型 说明
$i 0 int 文件索引,当有多个文件时,指定文件序号
返回值
返回文件信息(array)
示例
$res = $dn->get_file();

get_files()

说明
获取全部下载文件信息,常用于more()
返回值
返回文件信息(array),同get_file(),但包含多个文件

one()

说明
单文件下载
参数 必须 默认值 类型 说明
$file Y string 远程文件地址
$name null string 自定义保存名称,同配置name项
$ext null string 自定义保存后缀,同配置ext项
返回值
成功返回true(bool),失败返回false(bool)
示例
$res = $dn->one('http://xxx.com/logo.gif');
$file = $dn->get_file();
if($res){
	echo $file['file'];
}else{
	echo $file['error'];
}

more()

说明
多文件下载
参数 必须 默认值 类型 说明
$files Y array 多个远程文件
$name [] array 自定义保存名称,同配置name项
$ext null array 自定义保存后缀,同配置ext项
返回值
成功返回true(bool),失败返回false(bool)
示例
$dn->more([...]);
print_r($dn->get_files());