Browse Source

Manual update

master
filesite 3 years ago
parent
commit
6a6456e77b
  1. 3
      Class_DirScanner.md
  2. 3
      Manual.md

3
Class_DirScanner.md

@ -31,6 +31,7 @@
## 私有方法 ## 私有方法
* isValid: 判断目录名或者文件名是否合法
* parseDescriptionFiles: 解析描述文件内容 * parseDescriptionFiles: 解析描述文件内容
* parseShortCuts: 解析快捷方式文件内容 * parseShortCuts: 解析快捷方式文件内容
* getId: 根据文件路径生成唯一编号 * getId: 根据文件路径生成唯一编号
@ -65,7 +66,7 @@
* isSecureOn: 获取是否开启防盗链 * isSecureOn: 获取是否开启防盗链
* scan: 扫描目录获取目录和文件列表,支持指定目录扫描深度(目录级数) * scan: 扫描目录获取目录和文件列表,支持指定目录扫描深度(目录级数)
* getScanResults: 获取扫描结果 * getScanResults: 获取扫描结果
* getMenus: 获取扫描结果中的目录结构 * getMenus: 获取扫描结果中的目录结构,其中pid指向父目录
* getMDTitles: 获取.md文件中的h1-h6标题 * getMDTitles: 获取.md文件中的h1-h6标题
* fixMDUrls: 替换.md文件解析之后的HTML中的静态文件URL为相对路径path * fixMDUrls: 替换.md文件解析之后的HTML中的静态文件URL为相对路径path
* getDefaultReadme: 获取名称为README.md的文件 * getDefaultReadme: 获取名称为README.md的文件

3
Manual.md

@ -59,6 +59,7 @@
``` ```
[ [
'id' => '根据完整路径生成的唯一编号', 'id' => '根据完整路径生成的唯一编号',
'pid' => '父目录id', //如果有父目录的话
'directory' => '倚天屠龙记', 'directory' => '倚天屠龙记',
'realpath' => '/www/webroot/content/倚天屠龙记/', 'realpath' => '/www/webroot/content/倚天屠龙记/',
'path' => '/list/?id={id}', 'path' => '/list/?id={id}',
@ -73,6 +74,7 @@
``` ```
[ [
'id' => '根据完整路径生成的唯一编号', 'id' => '根据完整路径生成的唯一编号',
'pid' => '父目录id', //如果有父目录的话
'filename' => '第一章', 'filename' => '第一章',
'realpath' => '/www/webroot/content/倚天屠龙记/第一章.md', 'realpath' => '/www/webroot/content/倚天屠龙记/第一章.md',
'path' => '/view/?id={id}', 'path' => '/view/?id={id}',
@ -110,6 +112,7 @@
``` ```
[ [
'id' => '根据完整路径生成的唯一编号', 'id' => '根据完整路径生成的唯一编号',
'pid' => '父目录id', //如果有父目录的话
'filename' => 'filesite.io', 'filename' => 'filesite.io',
'realpath' => '/www/webroot/content/网址导航/filesite.io.url', 'realpath' => '/www/webroot/content/网址导航/filesite.io.url',
'path' => '/link/?id={id}', 'path' => '/link/?id={id}',

Loading…
Cancel
Save