diff --git a/Class_Dirscanner.md b/Class_Dirscanner.md new file mode 100644 index 0000000..662b138 --- /dev/null +++ b/Class_Dirscanner.md @@ -0,0 +1,47 @@ +# 类 Dirscanner 定义 + +## 私有属性 + +* nginxSecureOn: Nginx防盗链开启状态 +* nginxSecret: Nginx防盗链密钥 +* nginxSecureTimeout: Nginx防盗链有效期,单位:秒 +* nginxSecureLinkMd5Pattern: Nginx防盗链MD5加密方式 +* allowReadContentFileExtensions: 允许读取文件内容的文件类型 +* fields: 私有属性字段名和说明 +* scanResults: 目录扫描结果 + + +## 受保护属性 + +* supportFileExtensions: 支持的文件类型 +* maxReadFilesize: 默认每种文件读取内容最大大小 +* securedFileExtensions: 开启Nginx防盗链的文件类型 + + +## 公开属性 + +* scanTimeCost: 上一次目录扫描耗时,单位:微秒 + + +## 私有方法 + +* parseDescriptionFiles: 解析描述文件内容 +* parseShortCuts: 解析快捷方式文件内容 +* getId: 根据文件路径生成唯一编号 + + +## 受保护的方法 + +* getSecureLink: 根据文件生成防盗链网址 +* getFilePath: 根据文件生成相对路径 + + +## 公开方法 + +* setNginxSecure: 设置Nginx防盗链开启或关闭,以及密钥、加密方式 +* scan: 扫描目录获取目录和文件列表,支持指定目录扫描深度(目录级数) + + +## 参考 + +* http://nginx.org/en/docs/http/ngx_http_secure_link_module.html#secure_link_md5 diff --git a/manual.md b/manual.md index 903201c..04644b6 100644 --- a/manual.md +++ b/manual.md @@ -57,12 +57,14 @@ ### 目录 ``` -[ +[ + 'id' => '根据完整路径生成的唯一编号', 'directory' => '倚天屠龙记', 'realpath' => '/www/webroot/content/倚天屠龙记/', 'path' => '/list/?dir=倚天屠龙记', 'snapshot' => '/content/倚天屠龙记封面图.jpg', - 'files' => [...] + 'files' => [...], //文件列表 + 'directories' => [...] //目录列表 ] ``` @@ -70,6 +72,7 @@ ``` [ + 'id' => '根据完整路径生成的唯一编号', 'filename' => '第一章', 'realpath' => '/www/webroot/content/倚天屠龙记/第一章.md', 'path' => '/view/?file=第一章',