PHP Class think\File

Mostra file Open project: top-think/framework Class Usage Examples

Protected Properties

Property Type Description
$filename 当前完整文件名
$hash 文件hash信息
$info 上传文件信息
$isTest 单元测试
$rule 文件上传命名规则
$saveName 上传文件名
$validate 文件上传验证规则

Public Methods

Method Description
__call ( $method, $args )
__construct ( $filename, $mode = 'r' )
check ( array $rule = [] ) : boolean 检测上传文件
checkExt ( array | string $ext ) : boolean 检测上传文件后缀
checkImg ( ) : boolean 检测图像文件
checkMime ( array | string $mime ) : boolean 检测上传文件类型
checkSize ( integer $size ) : boolean 检测上传文件大小
getError ( ) : mixed 获取错误信息
getInfo ( string $name = '' ) : array | string 获取上传文件的信息
getMime ( ) : string 获取文件类型信息
getSaveName ( ) : string 获取上传文件的文件名
hash ( $type = 'sha1' ) 获取文件的哈希散列值
isTest ( boolean $test = false ) 是否测试
isValid ( ) : boolean 检测是否合法的上传文件
move ( string $path, string | boolean $savename = true, boolean $replace = true ) : false | SplFileInf\SplFileInfo 移动文件
rule ( string $rule ) 设置文件的命名规则
setSaveName ( string $saveName ) 设置上传文件的保存文件名
setUploadInfo ( array $info ) 设置上传信息
validate ( array $rule = [] ) 设置上传文件的验证规则

Protected Methods

Method Description
buildSaveName ( string | boolean $savename ) : string 获取保存文件名
checkPath ( string $path ) : boolean 检查目录是否可写
getImageType ( $image ) 判断图像类型

Private Methods

Method Description
error ( integer $errorNo ) 获取错误代码信息

Method Details

__call() public method

public __call ( $method, $args )

__construct() public method

public __construct ( $filename, $mode = 'r' )

buildSaveName() protected method

获取保存文件名
protected buildSaveName ( string | boolean $savename ) : string
$savename string | boolean 保存的文件名 默认自动生成
return string

check() public method

检测上传文件
public check ( array $rule = [] ) : boolean
$rule array 验证规则
return boolean

checkExt() public method

检测上传文件后缀
public checkExt ( array | string $ext ) : boolean
$ext array | string 允许后缀
return boolean

checkImg() public method

检测图像文件
public checkImg ( ) : boolean
return boolean

checkMime() public method

检测上传文件类型
public checkMime ( array | string $mime ) : boolean
$mime array | string 允许类型
return boolean

checkPath() protected method

检查目录是否可写
protected checkPath ( string $path ) : boolean
$path string 目录
return boolean

checkSize() public method

检测上传文件大小
public checkSize ( integer $size ) : boolean
$size integer 最大大小
return boolean

getError() public method

获取错误信息
public getError ( ) : mixed
return mixed

getImageType() protected method

判断图像类型
protected getImageType ( $image )

getInfo() public method

获取上传文件的信息
public getInfo ( string $name = '' ) : array | string
$name string
return array | string

getMime() public method

获取文件类型信息
public getMime ( ) : string
return string

getSaveName() public method

获取上传文件的文件名
public getSaveName ( ) : string
return string

hash() public method

获取文件的哈希散列值
public hash ( $type = 'sha1' )

isTest() public method

是否测试
public isTest ( boolean $test = false )
$test boolean 是否测试

isValid() public method

检测是否合法的上传文件
public isValid ( ) : boolean
return boolean

move() public method

移动文件
public move ( string $path, string | boolean $savename = true, boolean $replace = true ) : false | SplFileInf\SplFileInfo
$path string 保存路径
$savename string | boolean 保存的文件名 默认自动生成
$replace boolean 同名文件是否覆盖
return false | SplFileInf\SplFileInfo false-失败 否则返回SplFileInfo实例

rule() public method

设置文件的命名规则
public rule ( string $rule )
$rule string 文件命名规则

setSaveName() public method

设置上传文件的保存文件名
public setSaveName ( string $saveName )
$saveName string

setUploadInfo() public method

设置上传信息
public setUploadInfo ( array $info )
$info array 上传文件信息

validate() public method

设置上传文件的验证规则
public validate ( array $rule = [] )
$rule array 验证规则

Property Details

$filename protected_oe property

当前完整文件名
protected $filename

$hash protected_oe property

文件hash信息
protected $hash

$info protected_oe property

上传文件信息
protected $info

$isTest protected_oe property

单元测试
protected $isTest

$rule protected_oe property

文件上传命名规则
protected $rule

$saveName protected_oe property

上传文件名
protected $saveName

$validate protected_oe property

文件上传验证规则
protected $validate