【system.file】使用说明

对象:system.file

说明:提供一系列针对文件操作的方法。

注意:参数中的filePath 均为相对网站根目录路径

目录:

方法 返回 说明
 system.file.exists(filePath)  [True | False]  检测文件是否存在
 system.file.name(filePath)  [String]  获取文件名(包含扩展名)
 system.file.extend(filePath)  [String]  获取文件扩展名
 system.file.baseName(filePath)  [String]  获取文件名(不包含扩展名)
 system.file.size(filePath)  [Number]  获取文件大小,单位字节。(文件不存在时返回0)
 system.file.formatSize(filePath)  [String]  获取文件大小字符串(比如 23.5M)
 system.file.createDate(filePath)  [Empty | Date]  获取文件创建日期(返回Empty表示文件不存在)
 system.file.accessDate(filePath)  [Empty | Date]  获取文件最后访问日期(返回Empty表示文件不存在)
 system.file.modifyDate(filePath)  [Empty | Date]  获取文件最后修改日期(返回Empty表示文件不存在)
 system.file.copy(sourcePath, targetPath, cover)  [True | False]  复制文件并返回复制结果(如果目标路径不存在则会创建该路径)
 system.file.move(sourcePath, targetPath, cover)  [True | False]  移动文件并返回移动结果(如果目标路径不存在则会创建该路径)
 system.file.delete(filePath)  [True | False]  删除文件并返回删除结果
 system.file.create(filePath, text_binary, charSet)  [True | False]  创建文件并返回创建结果,支持文本创建与流创建(如果文件保存路径不存在则会创建该路径)
 system.file.insertText(filePath, text, method)  [True | False]  在文件中插入字符串数据并返回插入结果
system.file.cutText(filePath, startPosition, length) [Empty | String]  截取文件中指定的部份(截取时去掉了文件内的BOM)
 system.file.insertBinary(filePath, binary, method)  [True | False]  在文件中插入流数据并返回插入结果
 system.file.cutBinary(filePath, startPosition, length)  [Empty | Byte()]  截取文件中指定的流数据(截取时去掉了文件内的BOM)
 system.file.text(filePath, charSet)  [Empty | String]  获取文件字符串数据(返回Empty表示获取失败)
 system.file.binary(filePath)  [Empty | Byte()]  获取文件流数据(返回Empty表示获取失败)
 system.file.down(filePath, fileName)  -  下载文件(文件不存在时输出错误,可下载任何类型文件,特殊文件请自已判断扩展名后再下载)
 system.file.reName(filePath, newName, cover)  [True | False]  重命名文件并返回处理结果
 system.file.charSet(filePath)  [Empty | GB2312 | UTF-8]  获取文件编码(仅支持utf-8与gb2312的判断,返回Empty表示获取失败)
 system.file.conversionCharSet(filePath, cSet, toCSet)  [True | False]   将文件进行编码转换并返回转换结果,目前只支持GB2312与UTF-8编码

 

方法:

原型: system.file.exists(filePath)
说明: 检测文件是否存在
返回: [True | False]
参数:
        filePath [必须 String] 文件相对路径

 

原型: system.file.name(filePath)
说明: 获取文件名(包含扩展名)
返回: [String]
参数:
        filePath [必须 String] 文件相对路径

 

原型: system.file.extend(filePath)
说明: 获取文件扩展名
返回: [String]
参数:
        filePath [必须 String] 文件相对路径

 

原型: system.file.baseName(filePath)
说明: 获取文件名(不包含扩展名)
返回: [String]
参数:
        filePath [必须 String] 文件相对路径

 

原型: system.file.size(filePath)
说明: 获取文件大小,单位字节。(文件不存在时返回0)
返回: [Number]
参数:
        filePath [必须 String] 文件相对路径

 

原型: system.file.formatSize(filePath)
说明: 获取文件大小字符串(比如 23.5M)
返回: [String]
参数:
        filePath [必须 String] 文件相对路径

 

原型: system.file.createDate(filePath)
说明: 获取文件创建日期(返回Empty表示文件不存在)
返回: [Empty | Date]
参数:
        filePath [必须 String] 文件相对路径

 

原型: system.file.accessDate(filePath)
说明: 获取文件最后访问日期(返回Empty表示文件不存在)
返回: [Empty | Date]
参数:
        filePath [必须 String] 文件相对路径

 

原型: system.file.modifyDate(filePath)
说明: 获取文件最后修改日期(返回Empty表示文件不存在)
返回: [Empty | Date]
参数:
        filePath [必须 String] 文件相对路径

 

原型: system.file.copy(sourcePath, targetPath, cover)
说明: 复制文件并返回复制结果(如果目标路径不存在则会创建该路径)
返回: [True | False]
参数: 
        sourcePath [必须 String] 源文件路径
        targetPath [必须 String] 目标文件路径,该路径有以下三种格式:
                      1) 文件路径+文件名:表示复制到该路径内并重命名,示例: /1/2/3/text.txt
                      2) 文件路径:表示复制到该路径内保留原文件名, 示例: /1/2/3
                      3) 文件名:表示复制到当前文件夹内并以该名称命名,示例: text.txt
        cover [可选 True|False] 是否覆盖掉已存在的文件,默认值false表示重名时不覆盖

 

原型: system.file.move(sourcePath, targetPath, cover)
说明: 移动文件并返回移动结果(如果目标路径不存在则会创建该路径)
返回: [True | False]
参数: 
        sourcePath  [必须 String] 源文件路径
        targetPath  [必须 String] 目标文件路径,该路径有以下三种格式:
                      1) 文件路径+文件名,表示移动到该路径内并重命名,示例: /1/2/3/text.txt
                      2) 文件路径,表示移动到该路径内保留原文件名, 示例: /1/2/3
                      3) 文件名,表示移动到当前文件夹内并以该名称命名,示例: text.txt
        cover [可选 True|False] 是否覆盖掉已存在的文件,默认值false表示重名时不覆盖

 

原型: system.file.delete(filePath)
说明: 删除文件并返回删除结果
返回: [True | False]
参数:
        filePath  [必须 String] 文件相对路径

 

原型: system.file.create(filePath, text_binary, charSet)
说明: 创建文件并返回创建结果,支持文本创建与流创建(如果文件保存路径不存在则会创建该路径)
返回: [True | False]
参数: 
        filePath [必须 String] 文件保存路径
        text_binary [必须 String|Binary] 文件内容,可以是流数据或文本数据
        charSet [可选 String] 不设置时表示用流数据创建文件,设置时表示创建文本文件

注意: 当使用流创建文件时,参数charSet请忽略,只有使用文本创建文件时才可以设置参数charSet

 

原型: system.file.insertText(filePath, text, method)
说明: 在文件中插入字符串数据并返回插入结果
返回: [True | False]
参数: 
        filePath [必须 String] 要插入的文件相对路径
        text [必须 String] 插入的文本或流数据
        method [可选 -1|0|正整数] 插入位置
               默认值-1, 在当前文件末尾处插入字符
               值0, 在当前文件开始处插处
               值>=1的正整数, 在指定位置处插入

注意: 不用设置读取文件编码,程序会自动分析文件编码

 

原型: system.file.insertBinary(filePath, binary, method)
说明: 在文件中插入流数据并返回插入结果
返回: [True | False]
参数: 
        filePath [必须 String] 文件相对路径
        binary [必须 Byte()] 流数据
        method [可选 -1|0|正整数] 插入位置
               默认值-1, 在当前文件末尾处插入
               值0, 在当前文件开始处插处
               值>=1的正整数, 在指定位置处插入

 

原型: system.file.cutBinary(filePath, startPosition, length)
说明: 截取文件中指定的流数据(截取时去掉了文件内的BOM)
返回: [Empty | Byte()] 返回Empty表示截取失败
参数: 
        filePath [必需 String] 文件相对路径
        startPosition [必需 Number] 截取流的起始位置,不设置时表示从头开始截取
        length [可选 Number] 截取长度,不设置时表示截取所有长度

 

原型: system.file.text(filePath, charSet)
说明: 获取文件字符串数据(返回Empty表示获取失败)
返回: [Empty | String] 返回Empty表示获取内容失败
参数: 
        filePath [必须 String] 文件相对路径
        charSet [可选 Number] 读取的编码,不设置时采用系统获取编码

 

原型: system.file.cutText(filePath, startPosition, length)
说明: 截取文件中指定的部份(截取时去掉了文件内的BOM)
返回: [Empty | String] 返回Empty表示截取失败
参数: 
        filePath [必需 String] 文件相对路径
        startPosition [必需 Number] 截取起始位置,不设置时表示从头开始截取
        length [可选 Number] 截取长度,不设置时表示截取所有长度

 

原型: system.file.binary(filePath)
说明: 获取文件流数据(返回Empty表示获取失败)
返回: [Empty | Byte()] 返回Empty表示获取流失败
参数: 
        filePath   [必须 String] 文件相对路径

 

原型: system.file.down(filePath, fileName)
说明: 下载文件(文件不存在时输出错误,可下载任何类型文件,特殊文件请自已判断扩展名后再下载)
返回: 无
参数:
        filePath [必须 String] 文件相对路径
        fileName [可选 String] 下载后的文件名

注意: 这里默认充可所有类型文件下载,敏感文件请自行检测文件类型

 

原型: system.file.reName(filePath, newName, cover)
说明: 重命名文件并返回处理结果
返回: [True | False]
参数: 
        filePath [必须 String] 文件相对路径
        newName [必须 String] 新文件名,不含路径的
        cover [可选 True|False] 是否覆盖已有的重名文件,默认值false表示不覆盖

 

原型: system.file.charSet(filePath)
说明: 获取文件编码(仅支持utf-8与gb2312的判断,返回Empty表示获取失败)
返回: [Empty | GB2312 | UTF-8] Empty表示获取错误
参数: 
        filePath   [必须 String] 文件相对路径

 

原型: system.file.conversionCharSet(filePath, cSet, toCSet)
说明: 将文件进行编码转换并返回转换结果,目前只支持GB2312与UTF-8编码
返回: [True | False] 
参数: 
        filePath   [必须 String] 文件相对路径
        cSet [可选 UTF-8|GB2312] 打开文件时的编码,没有设置时采用系统分析编码
        toCSet [必需 UTF-8|GB2312] 转换的编码
示例:
        system.file.conversionCharSet("123.txt", "gb2312") 表示将文件编辑转换成gb2312格式(此时读取文件方式采用系统分析)
        system.file.conversionCharSet("123.txt", "gb2312", "utf-8") 表示以gb2312方式读取文件,然后将文件换成utf-81格式

 

posted @ 2018-11-27 08:09 网申 阅读(...) 评论(...) 编辑 收藏