boaPHP开发手册v5.5

archive类
版本 1.0+
命名空间 boa
文件 boa/archive.php
说明 压缩解压类,配置:'ARCHIVE' => [],
配置
配置项 默认值 类型 说明
driver zip string 文件压缩解压驱动类型,可选值:phar, zip
目录
方法 说明
__construct() 初始化
obj() 返回当前驱动初始化后的对象,方便直接访问该对象中方法,当各驱动功能有差异时,具有灵活性
cfg() 获取或设置配置信息
encode() 压缩字符串
decode() 解压字符串
compress() 压缩文件
decompress() 解压文件
方法

__construct()

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

obj()

说明
返回当前驱动初始化后的对象,方便直接访问该对象中方法,当各驱动功能有差异时,具有灵活性
返回值
返回驱动类(object)
示例
$obj = $archive()->obj();

cfg()

说明
获取或设置配置信息
参数 必须 默认值 类型 说明
$k null string
$v null string
返回值
同 base 类

encode()

说明
压缩字符串
参数 必须 默认值 类型 说明
$data Y string 待压缩字符串
$type zlib string 压缩类型,可选值:raw, zlib, deflate, lzf, bzip2
$level -1 int 压缩级别,可选值:0-9,对lzf无效
返回值
返回压缩后的字符串(string),出错则报错
示例
$res = $archive->encode($data);

decode()

说明
解压字符串
参数 必须 默认值 类型 说明
$data Y string 待解压字符串
$type zlib string 解压类型,可选值:raw, zlib, deflate, lzf, bzip2
返回值
返回解压后的字符串(string),出错则报错
示例
$res = $archive->decode($data);

compress()

说明
压缩文件
参数 必须 默认值 类型 说明
$source Y string 文件目录
$dest Y string 压缩文件
返回值
成功返回true(bool),出错则报错
示例
$res = $archive->compress('D:/www/boa', 'D:/boa.zip');

decompress()

说明
解压文件
参数 必须 默认值 类型 说明
$source Y string 压缩文件
$dest Y string 解压目录
返回值
成功返回true(bool),出错则报错
示例
$res = $archive->decompress('D:/boa.zip', 'D:/www/boa');