API 文档 - ginkgo


ginkgo\File

文件系统


类摘要

namespace ginkgo;

class File {
    // 属性
    public $error;
    public $rule = 'md5';
    public $mimeRows = array();
    public $fileInfo = array(
        'name'      => '',
        'tmp_name'  => '',
        'ext'       => '',
        'mime'      => '',
        'size'      => 0,
    );

    protected static $instance;

    // 方法
    public static instance( [ array $config ] ) : object
    public static dirHas( string $path ) : bool
    public static fileHas( string $path ) : bool
    public dirList( string $path [ , string $ext ] ) : array
    public dirMk( string $path ) : bool
    public dirCopy( string $src, string $dst ) : bool
    public dirDelete( string $path ) : bool
    public fileRead( string $path ) : string
    public fileMove( string $src, string $dst ) : bool
    public fileWrite( string $path, string $content [, bool $append = false ] ) : int
    public fileCopy( string $src, string $dst ) : bool
    public fileDelete( string $path ) : bool
    public getMime( string $path [, $mime = false ] ) : string
    public getExt( string $path [, $mime = false ] ) : string
    public getInfo( [ string $name ] ) : mixed
    public setMime( mixed $mime [, array $value ] )
    public rule( string $rule )

    protected __construct( [ array $config ] )
    protected __clone()

    protected genFilename( [ bool $name = true ] ) : string
    protected verifyFile( string $ext [, string $mime ] ) : bool
}

成员目录

- 权限 类型 描述
属性 - - -
$error public string 错误
$rule public string 生成文件名规则(函数名)
$mimeRows public array MIME 池
$instance protected object static 本类实例
$fileInfo protected array 默认 $_FILES 结构
方法 - - -
instance() public static 实例化
dirHas() public static 文件夹是否存在
fileHas() public static 文件是否存在
dirList() public 列出目录结构
dirMk() public 创建目录
dirCopy() public 拷贝整个目录
dirDelete() public 递归删除整个目录
fileRead() public 读取文件
fileMove() public 移动文件(更名)
fileWrite() public 写入文件
fileCopy() public 复制文件
fileDelete() public 删除文件
getMime() public 获取文件的 MIME 类型
getExt() public 获取文件的扩展名
getInfo() public 获取文件信息
setMime() public 设置生成文件名规则(函数名)
rule() public 设置 MIME
__construct() protected 构造函数,无实际功能,仅供限制为单例模式使用
__clone() protected 克隆,无实际功能,仅供限制为单例模式使用
genFilename() protected 生成文件名
verifyFile() protected 验证是否为允许的文件

$fileInfo 默认 $_FILES 结构

public $fileInfo;

结构

名称 类型 默认 描述
name string 原始文件名
tmp_name string 临时文件名
ext string 扩展名
mime string MIME
size int 0 文件大小

instance() 实例化方法

public static function instance( [ array $config ] ) : object

参数

  • config 配置参数

返回

  • 本类的实例

dirList() 列出目录结构

public function dirList( string $path [ , string $ext ] ) : array

参数

  • path 路径
  • ext 指定扩展名

返回

  • 目录列表

dirMk() 创建目录

public function dirMk( string $path ) : bool

参数

  • path 路径

返回

  • 布尔值

dirCopy() 拷贝整个目录

public function dirCopy( string $src, string $dst ) : bool

参数

  • src 源路径
  • dst 目的路径

返回

  • 布尔值

dirDelete() 递归删除整个目录

public function dirDelete( string $path ) : bool

参数

  • path 路径

返回

  • 布尔值

dirHas() 文件夹是否存在

public static function dirHas( string $path ) : bool

参数

  • path 路径

返回

  • 布尔值

fileRead() 读取文件

public function fileRead( string $path ) : string

参数

  • path 路径

返回

  • 文件内容

fileMove() 移动文件(更名)

public function fileMove( string $src, string $dst ) : bool

参数

  • src 源路径
  • dst 目的路径

返回

  • 布尔值

fileWrite() 写入文件

public function fileWrite( string $path, string $content [, bool $append = false ] ) : int

参数

  • path 路径
  • content 内容
  • append 是否追加

返回

  • 写入字节数

fileCopy() 写入文件

public function fileCopy( string $src, string $dst ) : bool

参数

  • src 源路径
  • dst 目的路径

返回

  • 布尔值

fileDelete() 删除文件

public function fileDelete( string $path ) : bool

参数

  • path 路径

返回

  • 布尔值

fileHas() 文件是否存在

public static function fileHas( string $path ) : bool

参数

  • path 路径

返回

  • 布尔值