Skip to content

Commit

Permalink
更新:项目文档
Browse files Browse the repository at this point in the history
  • Loading branch information
dxkite committed Sep 11, 2018
1 parent 85564e0 commit d35adc0
Show file tree
Hide file tree
Showing 141 changed files with 621 additions and 336 deletions.
6 changes: 4 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,10 @@
"": "system/src/"
}
},
"require": {},
"require": {
"php": "^7.2.0"
},
"bin": [
"system/suda-cli"
]
}
}
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
> **注:** 文档由程序自动生成
- suda 2.0.1
- 生成时间:2018-09-10 16:35:25
- 生成时间:2018-09-11 13:00:44
## 函数列表

- [函数列表](functions/README.md)
Expand Down
381 changes: 193 additions & 188 deletions docs/SUMMARY.md

Large diffs are not rendered by default.

17 changes: 9 additions & 8 deletions docs/classes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
> **注:** 文档由程序自动生成
- suda 2.0.1
- 2018-09-10 16:35:25
- 2018-09-11 13:00:44


## 类列表
Expand All @@ -19,13 +19,9 @@
|[suda\tool\ArrayHelper](suda/tool/ArrayHelper.md) | 数组操纵 |
|[suda\core\Storage](suda/core/Storage.md) | 文件存储系统包装类,封装了常用的文件系统函数 |
|[suda\core\storage\FileStorage](suda/core/storage/FileStorage.md) | 文件存储系统包装类 |
|[system](system.md) | 系统类,处理系统报错函数以及程序加载 |
|[suda\core\Hook](suda/core/Hook.md) | 系统钩子,监听系统内部一些操作并载入一些自定义行为 |
|[suda\core\Locale](suda/core/Locale.md) | I18N 国际化支持 |
|[suda\core\Application](suda/core/Application.md) | 应用处理类 |
|[suda\template\Manager](suda/template/Manager.md) | 模板管理类 |
|[suda\template\compiler\suda\Compiler](suda/template/compiler/suda/Compiler.md) | Suda 模板编译器 |
|[suda\tool\ZipHelper](suda/tool/ZipHelper.md) | |
|[suda\tool\Command](suda/tool/Command.md) | |
|[suda\archive\Connection](suda/archive/Connection.md) | 数据表链接对象 |
|[suda\archive\creator\Field](suda/archive/creator/Field.md) | |
|[suda\archive\creator\InputValue](suda/archive/creator/InputValue.md) | |
Expand All @@ -34,6 +30,7 @@
|[suda\archive\SQLQuery](suda/archive/SQLQuery.md) | 数据库查询方案,简化数据库查 |
|[suda\archive\Table](suda/archive/Table.md) | 数据表抽象对象 |
|[suda\archive\TableInstance](suda/archive/TableInstance.md) | |
|[suda\core\Application](suda/core/Application.md) | 应用处理类 |
|[suda\core\cache\FileCache](suda/core/cache/FileCache.md) | 文件缓存 |
|[suda\core\Cache](suda/core/Cache.md) | 缓存系统 |
|[suda\core\Cookie](suda/core/Cookie.md) | Cookie操作封装类 |
Expand All @@ -57,16 +54,20 @@
|[suda\mail\message\HTMLMessage](suda/mail/message/HTMLMessage.md) | HTML邮件信息 |
|[suda\mail\sender\MailSender](suda/mail/sender/MailSender.md) | sendmail 邮件发送 |
|[suda\mail\sender\StmpSender](suda/mail/sender/StmpSender.md) | SMTP邮件发送器 |
|[suda\template\compiler\suda\Compiler](suda/template/compiler/suda/Compiler.md) | Suda 模板编译器 |
|[suda\template\compiler\suda\Template](suda/template/compiler/suda/Template.md) | |
|[suda\template\compiler\suda\TemplateInfo](suda/template/compiler/suda/TemplateInfo.md) | |
|[suda\template\Manager](suda/template/Manager.md) | 模板管理类 |
|[suda\tool\ArrayValue](suda/tool/ArrayValue.md) | |
|[suda\tool\Command](suda/tool/Command.md) | |
|[suda\tool\CookieSetter](suda/tool/CookieSetter.md) | |
|[suda\tool\EchoValue](suda/tool/EchoValue.md) | |
|[suda\tool\Json](suda/tool/Json.md) | |
|[suda\tool\Pinyin](suda/tool/Pinyin.md) | 将中文转换成拼音 |
|[suda\tool\ZipHelper](suda/tool/ZipHelper.md) | |
|[suda\core\storage\Storage](suda/core/storage/Storage.md) | 存储系统 |
|[suda\template\Compiler](suda/template/Compiler.md) | 编译器接口 |
|[suda\archive\SQLStatement](suda/archive/SQLStatement.md) | 数据库查询语句接口 |
|[suda\core\cache\Cache](suda/core/cache/Cache.md) | 缓存接口 |
|[suda\core\session\Session](suda/core/session/Session.md) | Session 接口 |
|[suda\mail\sender\Sender](suda/mail/sender/Sender.md) | |
|[suda\mail\sender\Sender](suda/mail/sender/Sender.md) | |
|[suda\template\Compiler](suda/template/Compiler.md) | 编译器接口 |
11 changes: 10 additions & 1 deletion docs/classes/suda/archive/Table/count.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,16 @@
| 参数名 | 类型 | 默认值 | 说明 |
|--------|-----|-------|-------|
| where | # Error> htmlspecialchars() expects parameter 1 to be string, array given
Cause By D:\Server\vhost\atd3.org\suda\script\docme\template\method.md.tpl:25
Cause By D:\Server\vhost\atd3.org\suda\script\docme\template\method.md.tpl:25
=> suda\core\System::uncaughtError(2,htmlspecialchars() expects parameter 1 to be string, array given,D:\Server\vhost\atd3.org\suda\script\docme\template\method.md.tpl,25,{"param":{"default":"1"},"name":"where"})
=> D:\Server\vhost\atd3.org\suda\script\docme\template\method.md.tpl:25 htmlspecialchars(["\u65e0"])
=> D:\Server\vhost\atd3.org\suda\system\src\suda\template\compiler\suda\Template.php:127 Class860d7316e63cf22173dfe0b15c6a4979->_render_template()
=> D:\Server\vhost\atd3.org\suda\system\src\suda\template\compiler\suda\Template.php:91 suda\template\compiler\suda\Template->echo()
=> D:\Server\vhost\atd3.org\suda\script\docme\src\ExportTemplate.php:45 suda\template\compiler\suda\Template->getRenderedString()
=> D:\Server\vhost\atd3.org\suda\script\docme\src\ClassExport.php:103 docme\ExportTemplate->export(D:\Server\vhost\atd3.org\suda\script/../docs/classes/suda\archive\Table/count.md)
=> D:\Server\vhost\atd3.org\suda\script\docme\src\ClassExport.php:65 docme\ClassExport->exportMethod(class ReflectionMethod,{"description":"\u6570\u636e\u8868\u62bd\u8c61\u5bf9\u8c61","document":"\r\n\u7528\u4e8e\u63d0\u4f9b\u5bf9\u6570\u636e\u8868\u7684\u64cd\u4f5c\r\n","className":"Table","classFullName":"suda\\archive\\Table","classDoc":"\u6570\u636e\u8868\u62bd\u8c61\u5bf9\u8c61","constants":{"ORDER_ASC":0,"ORDER_DESC":1},"fileName":"suda\\archive\\Table.php","lineStart":31,"lineEnd":944,"properties":{"fields":{"visibility":"protected","static":"","docs":false},"wants":{"visibility":"protected","static":"","docs":false},"primaryKey":{"visibility":"protected","static":"","docs":false},"tableName":{"visibility":"protected","static":"","docs":false},"cachePath":{"visibility":"protected","static":"","docs":false},"creator":{"visibility":"protected","static":"","docs":false},"orderField":{"visibility":"protected","static":"","docs":false},"order":{"visibility":"protected","static":"","docs":false},"allFields":{"visibility":"protected","static":"","docs":false},"exportFields":{"visibility":"protected","static":"","docs":"\u8bbe\u7f6e\u5bfc\u51fa\u5217\u5927\u5c0f"},"exportBlockSize":{"visibility":"protected","static":"","docs":"\u8bbe\u7f6e\u5bfc\u51fa\u6570\u636e\u5206\u5757\u5927\u5c0f"}}},D:\Server\vhost\atd3.org\suda\script/../docs/classes/suda\archive\Table)
=> D:\Server\vhost\atd3.org\suda\script\docme\src\Docme.php:90 docme\ClassExport->export(D:\Server\vhost\atd3.org\suda\script/../docs/classes)
=> D:\Server\vhost\atd3.org\suda\script\docme.php:30 docme\Docme->export(D:\Server\vhost\atd3.org\suda\script/../docs)
| 1 ||
| binds | array | Array ||

Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application

> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757

应用处理类
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/__construct.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::__construct

> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/activeModule.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::activeModule
激活运行的模块
> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/addModulesPath.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::addModulesPath
添加模块扫描目录
> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/checkModuleExist.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::checkModuleExist
检查模块是否存在
> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/checkModuleRequire.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::checkModuleRequire
检查模块依赖
> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/getActiveModule.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::getActiveModule
获取当前激活的模块
> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/getConfig.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::getConfig
获取app/resource/config下的配置
> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/getFileModule.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::getFileModule
根据文件名判断所属模块
> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/getInstance.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::getInstance

> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/getLiveModules.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::getLiveModules
获取激活的模块
> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/getModuleConfig.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::getModuleConfig
获取模块的配置信息
> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/getModuleConfigPath.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::getModuleConfigPath
获取模块 resource/config 路径
> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/getModuleDir.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::getModuleDir
获取模块所在的文件夹名
> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/getModuleDirs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::getModuleDirs
获取所有模块的目录
> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/getModuleFullName.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::getModuleFullName
获取模块全名(包括版本)
> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/getModuleName.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::getModuleName
获取模块名,不包含版本号
> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/getModulePath.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::getModulePath

> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/getModulePrefix.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::getModulePrefix
获取模块网页前缀
> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::getModuleResourcePath
获取模块 resouce 目录路径
> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/getModules.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::getModules
获取所有的模块
> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/getModulesInfo.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::getModulesInfo

> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/getReachableModules.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::getReachableModules
获取网页端可达的模块
> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/getThisModule.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::getThisModule
根据函数调用栈判断调用时所属模块
> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/init.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::init

> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/initDatabase.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::initDatabase

> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/installModule.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::installModule
安装有自动安装功能的模块
> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/isModuleReachable.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::isModuleReachable

> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/loadModules.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::loadModules
载入模块
> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/moduleName.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::moduleName
根据模块目录名转换成模块名
> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/onRequest.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::onRequest
截获请求,请求发起的时候会调用
> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/onShutdown.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::onShutdown
请求关闭的时候会调用
> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/registerModule.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::registerModule

> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/uncaughtException.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::uncaughtException
请求发生异常的时候会调用
> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/suda/core/Application/versionCompire.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application::versionCompire
比较版本
> *文件信息* suda\core\Application.php: 30~756
> *文件信息* suda\core\Application.php: 30~757
## 所属类

[Application](../Application.md)
Expand Down
4 changes: 3 additions & 1 deletion docs/classes/suda/core/Autoloader.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Autoloader

> *文件信息* suda\core\Autoloader.php: 22~146
> *文件信息* suda\core\Autoloader.php: 22~198

自动加载控制器
Expand Down Expand Up @@ -33,6 +33,8 @@
| public static|[getIncludePath](Autoloader/getIncludePath.md) | |
| public static|[getNamespace](Autoloader/getNamespace.md) | |
| public static|[setNamespace](Autoloader/setNamespace.md) | |
| public static|[absolutePath](Autoloader/absolutePath.md) | |
| public static|[parsePath](Autoloader/parsePath.md) | |


## 例子
Expand Down
Loading

0 comments on commit d35adc0

Please sign in to comment.