/includes/file.inc

Description
Functions
file_create_name (line 422)

保存前检查文件名

void file_create_name ( &$file, [(array) $validate = NULL], [(int) $rename = 1], (object) $file)
  • (object) $file: 文件对象
  • (array) $validate: 验证参数
  • (int) $rename: 若同名文件存在,可选设置,默认为重命名
  • &$file
file_delete (line 911)

删除数据库记录及文件

  • return: true
数据库记录删除成功则返回 file_delete ((int) $fid, [(bool) $thumb = true], [(string) $filepath = 0])
  • (int) $fid: table.files.fid
  • (bool) $thumb: 是否同时删除缩略图,非图片文件没有缩略图,可传递 false
  • (string) $filepath: 文件路径,若不传递,将从 files 可查询
file_delete_array (line 969)

删除一组文件

  • return: false
删除失败则退出,不再删除后面的文件,并返回 file_delete_array ([(array) $files = array()])
  • (array) $files: 文件路径
file_delete_dir (line 947)

递归删除目录及其所有文件

静默,并屏蔽错误抛出 file_delete_dir ((string) $dir, [ $recursive = 1])
  • (string) $dir: 目录路径
  • $recursive
file_delete_file (line 931)

删除文件及其缩略图

  • return: true,缩略图文件夹删除操作将静默。
文件删除成功返回 file_delete_file ((string) $filepath, [(string) $fid = NULL])
  • (string) $filepath: 文件路径
  • (string) $fid: 若传递此值,将尝试删除以 $fid 命名的缩略图文件夹。 通常 $fid 等于 files 表中的 fid,某些时候,数据库中并没有记录,但文件也需要缩略图,fid 则可随意指定
file_directory_path (line 836)

文件系统根目录

void file_directory_path ()
file_down_image (line 652)

分析字符串 img 标签,并下载到本地

void file_down_image ( $text, [ $validate = array()], [ $rename = 1])
  • $text
  • $validate
  • $rename
file_form_save (line 282)

处理上传文件,默认调用 file_save_upload() 保存

若设置 $form['#validate']['call_function'],回调该函数,传递字段名及文件对象

void file_form_save ( $form,  $files)
  • $form
  • $files
file_form_validate (line 113)

验证上传字段

void file_form_validate ((array) $form, [(bool) $save = true])
  • (array) $form: 表单
  • (bool) $save: 验证完成后是否保存
file_get_array_data (line 213)

将 $_FILES 转换为二维数组,排除未上传字段

void file_get_array_data ()
file_get_form (line 60)

上传字段 HTML

void file_get_form ( $field)
  • $field
file_get_mimetype (line 987)

文件 mime 类型及扩展名

  • return: mime 类型。反之亦然。
传递扩展名,则返回 file_get_mimetype ((string) $key, [(string) $value = 0])
  • (string) $key: 文件扩展名
  • (string) $value: mime 类型
file_get_path (line 816)

获取用户文件存储目录

返回用户存储目录,默认为用户id及年月命名 file_get_path ([(object) $ac = NULL])
  • (object) $ac: 若无,则取当前用户
file_image_view (line 92)

读取数据库,并显示图片

void file_image_view ( $fid, [ $opt = array()])
  • $fid
  • $opt
file_is_access (line 882)

文件权限验证

void file_is_access ( $file, [ $op = 'view'])
  • $file
  • $op
file_load (line 893)

加载文件

void file_load ((int) $fid, [(bool) $invoke = true])
  • (int) $fid: 文件 Id
  • (bool) $invoke: 是否触发 hook_file_load()
file_mkdir (line 851)

判断文件夹是否存在,若不存在,则创建

  • return: false
返回目录路径,若创建失败,则返回 file_mkdir ((string) $path, [(int) $mode = 0775], [(bool) $recursive = 1])
  • (string) $path: 目录路径
  • (int) $mode: 新建文件夹权限
  • (bool) $recursive: 是否递归创建文件夹
file_operate (line 864)

文件删除、更新、浏览操作

void file_operate ( $file,  $op)
  • $file
  • $op
file_require_empty (line 266)

判断必需上传字段是否为空

void file_require_empty ( $array)
  • $array
file_save (line 614)

文件信息写入数据库

  • return: false
  • access: public
bool|object 成功返回 file_save (object $file)
  • object $file: 待写入的文件对象
file_save_copy (line 331)

复制文件

void file_save_copy ((string) $source, [(array) $validate = NULL], [(int) $rename = 1])
  • (string) $source: 原文件路径,必须可读
  • (array) $validate: 配置参数,见上传示例
  • (int) $rename: 若同名文件存在,可选设置,默认为重命名
file_save_data (line 385)

字符串保存为文件

void file_save_data ((string) $data, [(array) $validate = array()], [(int) $rename = 1])
  • (string) $data: 待保存的字符串
  • (array) $validate: 配置参数,见上传示例。必须有 filename 参数,即文件名
  • (int) $rename: 若同名文件存在,可选设置,默认为重命名
file_save_move (line 358)

移动文件

void file_save_move ((string) $source, [(array) $validate = NULL], [(int) $rename = 1])
  • (string) $source: 原文件路径,必须可读
  • (array) $validate: 配置参数,见上传示例
  • (int) $rename: 若同名文件存在,可选设置,默认为重命名
file_save_upload (line 305)

保存上传文件

void file_save_upload ((string) $file, [(array) $validate = NULL], [(int) $rename = 1])
  • (string) $file: 表单上传数组
  • (array) $validate: 配置参数,见上传示例
  • (int) $rename: 若同名文件存在,可选设置,默认为重命名
file_save_validate (line 522)

验证已保存的文件

void file_save_validate ( &$file,  $validate)
  • &$file
  • $validate
file_validate_error (line 788)

文件上传状态代码解析

void file_validate_error ( $error)
  • $error
file_validate_image (line 705)

验证图片

void file_validate_image ( &$file,  $val)
  • &$file
  • $val
file_validate_mime (line 774)

验证文件类型,仅根据文件名判断。

  • return: mimetype
返回文件 file_validate_mime ( &$file, [(array) $val = array()], (object) $file)
  • (object) $file: 一个文件对象
  • (array) $val: 允许的文件类型
  • &$file
file_validate_size (line 758)

验证文件大小

void file_validate_size ( &$file,  $val)
  • &$file
  • $val
file_validate_usersize (line 744)

验证用户文件空间是否超过限制

void file_validate_usersize ( $file)
  • $file
_file_down_image (line 664)
void _file_down_image ( $mat)
  • $mat
_file_form_subvalidate (line 180)

检查子字段

void _file_form_subvalidate ( $form,  $files, [ $save = true])
  • $form
  • $files
  • $save
_file_form_validate (line 145)

检查上传字段

void _file_form_validate ((array) $files, (array) $field, [(bool) $save = true])
  • (array) $files: 文件对象
  • (array) $field: 表单字段
  • (bool) $save: 检查通过后是否保存
_file_get_array_data (line 230)
void _file_get_array_data ( $array, [ $keys = ''])
  • $array
  • $keys
_file_save_data (line 692)

数据保存为文件,不做任何验证,文件存在则覆盖

void _file_save_data ( $data,  $filepath)
  • $data
  • $filepath

Documentation generated on Wed, 04 Jul 2012 14:35:57 +0800 by phpDocumentor 1.4.3