file类 - boa框架

boa框架开发手册v5.2

file类

版本	1.0+
命名空间	boa\archive
文件	boa/archive/file.php
说明	文件压缩解压类

配置

配置项	默认值	类型	说明
driver	zip	string	文件压缩解压驱动类型，可选值：phar, rar, zip

目录

方法	说明
__construct()	初始化
cfg()	获取或设置配置信息
compress()	压缩文件
decompress()	解压文件
open()	打开压缩文件
entries()	获取压缩文件中条目
comment()	获取压缩文件注释
close()	手动关闭打开的压缩文件

方法

__construct()
↑
说明
初始化
参数	必须	默认值	类型	说明
$cfg		[]	array	配置数据

cfg()
↑
说明
获取或设置配置信息
参数	必须	默认值	类型	说明
$k		null	string	键
$v		null	string	值
返回值
如果设定$k和$v：则设置配置中$k项，返回$this（object）；如果只设定$k：则返回配置中$k值（string）；如果都未设定：则返回整个配置数据（array）；

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

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

open()
↑
说明
打开压缩文件
参数	必须	默认值	类型	说明
$file	Y		string	压缩文件
$flag		null	bool	打开压缩文件flag
返回值
返回$this（object）

entries()
↑
说明
获取压缩文件中条目
返回值
返回条目（array）
示例
`$file = boa::archive()->file(); $zip = $file->open('D:/boa.zip'); print_r($zip->entries());`

comment()
↑
说明
获取压缩文件注释
返回值
返回注释（string）
示例
`$file = boa::archive()->file(); $zip = $file->open('D:/boa.zip'); echo $zip->comment();`

close()
↑
说明
手动关闭打开的压缩文件