Module
extends FrameBase
in package
Tags
Table of Contents
- $appDelegate : Delegate
- $config : Config
- $link : RedisDriver|CouchDriver|MongoDriver|PDOSqlDriver
- $request : Request
- $response : Response
- $view : View
- $action : string
- action名称
- $actionAnnotate : array<string|int, mixed>
- 当前方法的注释配置
- $controller : string
- 控制器名称
- $dbConfigFile : string
- 连接配置文件名 <pre> 默认为项目目录下的config/db.config.php 可以在app目录下init.php文件中通过'sys' => 'db_config'指定 </pre>
- $delegate : Delegate
- $params : array<string|int, mixed>
- 参数列表
- $viewController : string
- 视图控制器命名空间
- $linkConfig : array<string|int, mixed>
- 数据库连接的model配置
- $linkName : string
- 数据库连接的model名称
- $linkType : string
- 数据库连接model类型
- __construct() : mixed
- 解析要连接model的参数
- __get() : RedisDriver|Config|CouchDriver|MongoDriver|PDOSqlDriver|Request|Response|View|mixed|null
- 访问link属性时才实例化model
- getConfig() : Config
- getDelegate() : Delegate
- getFilePath() : string
- 解析文件路径 <pre> 格式如下: 1 ::[path/file_name] 从当前项目根目录查找 2 app::[path/file_name] 当前app路径 3 static::[path/file_name] 静态资源目录 4 cache::[path/file_name] 缓存路径 5 config::[path/file_name] 配置路径 </pre>
- getLinkConfig() : array<string|int, mixed>
- 当前link的model详细配置信息
- getLinkName() : string
- 当前link的model名称
- getLinkType() : string
- 当前link的model类型
- getModel() : RedisDriver|CouchDriver|MongoDriver|PDOSqlDriver|mixed
- 创建model实例,参数格式和构造函数一致
- getPrefix() : string
- 获取带配置前缀的表名
- loadConfig() : Config
- 读取配置文件
- parseGetFile() : mixed
- 获取文件路径
- responseData() : ResponseData
- 返回一个ResponseData对象
- databaseConfig() : Config
- 读取并解析数据库配置
- getAuth() : bool|mixed|string
- 解密会话
- getUrlEncryptKey() : string
- 获取uri加密/解密时用到的key
- initView() : mixed
- 初始化视图控制器
- parseModelParams() : array<string|int, mixed>
- 解析指定model的类型和参数
- setAuth() : bool
- 加密会话 <pre> sys.auth 中指定cookie/session </pre>
- setDatabaseConfigFile() : void
- 设置配置文件名
- sParams() : array<string|int, mixed>|bool|string
- 还原加密后的参数
- urlEncrypt() : bool|string
- uri参数加密
- getLink() : RedisDriver|CouchDriver|MongoDriver|PDOSqlDriver|mixed
- 获取默认model的实例
- getModuleConfigFile() : mixed
- 获取连接配置文件名
Properties
$appDelegate
public
static Delegate
$appDelegate
$config
public
Config
$config
$link
public
RedisDriver|CouchDriver|MongoDriver|PDOSqlDriver
$link
$request
public
Request
$request
$response
public
Response
$response
$view
public
View
$view
$action
action名称
protected
string
$action
$actionAnnotate
当前方法的注释配置
protected
array<string|int, mixed>
$actionAnnotate
$controller
控制器名称
protected
string
$controller
$dbConfigFile
连接配置文件名 <pre> 默认为项目目录下的config/db.config.php 可以在app目录下init.php文件中通过'sys' => 'db_config'指定 </pre>
protected
string
$dbConfigFile
$delegate
protected
Delegate
$delegate
$params
参数列表
protected
array<string|int, mixed>
$params
$viewController
视图控制器命名空间
protected
string
$viewController
$linkConfig
数据库连接的model配置
private
array<string|int, mixed>
$linkConfig
$linkName
数据库连接的model名称
private
string
$linkName
$linkType
数据库连接model类型
private
string
$linkType
Methods
__construct()
解析要连接model的参数
public
__construct([string $params = '' ]) : mixed
Parameters
- $params : string = ''
-
指定要连接的数据库和配置项的key, 如mysql['db']这里的params应该为mysql:db
Tags
Return values
mixed —__get()
访问link属性时才实例化model
public
__get(mixed $property) : RedisDriver|Config|CouchDriver|MongoDriver|PDOSqlDriver|Request|Response|View|mixed|null
Parameters
- $property : mixed
Tags
Return values
RedisDriver|Config|CouchDriver|MongoDriver|PDOSqlDriver|Request|Response|View|mixed|null —getConfig()
public
final getConfig() : Config
Return values
Config —getDelegate()
public
final getDelegate() : Delegate
Return values
Delegate —getFilePath()
解析文件路径 <pre> 格式如下: 1 ::[path/file_name] 从当前项目根目录查找 2 app::[path/file_name] 当前app路径 3 static::[path/file_name] 静态资源目录 4 cache::[path/file_name] 缓存路径 5 config::[path/file_name] 配置路径 </pre>
public
getFilePath(string $name) : string
Parameters
- $name : string
Return values
string —getLinkConfig()
当前link的model详细配置信息
public
getLinkConfig() : array<string|int, mixed>
Return values
array<string|int, mixed> —getLinkName()
当前link的model名称
public
getLinkName() : string
Return values
string —getLinkType()
当前link的model类型
public
getLinkType() : string
Return values
string —getModel()
创建model实例,参数格式和构造函数一致
public
getModel([string $params = '' ][, array<string|int, mixed> &$config = [] ]) : RedisDriver|CouchDriver|MongoDriver|PDOSqlDriver|mixed
Parameters
- $params : string = ''
- $config : array<string|int, mixed> = []
Tags
Return values
RedisDriver|CouchDriver|MongoDriver|PDOSqlDriver|mixed —getPrefix()
获取带配置前缀的表名
public
getPrefix([string $table = '' ]) : string
Parameters
- $table : string = ''
Return values
string —loadConfig()
读取配置文件
public
loadConfig(string $configFile) : Config
Parameters
- $configFile : string
Tags
Return values
Config —parseGetFile()
获取文件路径
public
parseGetFile(string $name[, bool $getFileContent = false ]) : mixed
Parameters
- $name : string
- $getFileContent : bool = false
Tags
Return values
mixed —responseData()
返回一个ResponseData对象
public
responseData([int $status = 1 ][, array<string|int, mixed> $data = [] ]) : ResponseData
Parameters
- $status : int = 1
- $data : array<string|int, mixed> = []
Return values
ResponseData —databaseConfig()
读取并解析数据库配置
protected
databaseConfig() : Config
Tags
Return values
Config —getAuth()
解密会话
protected
getAuth(string $key[, bool $deCode = false ]) : bool|mixed|string
Parameters
- $key : string
- $deCode : bool = false
Tags
Return values
bool|mixed|string —getUrlEncryptKey()
获取uri加密/解密时用到的key
protected
getUrlEncryptKey([string $type = 'auth' ]) : string
Parameters
- $type : string = 'auth'
Return values
string —initView()
初始化视图控制器
protected
initView() : mixed
Return values
mixed —parseModelParams()
解析指定model的类型和参数
protected
parseModelParams([string $params = '' ]) : array<string|int, mixed>
Parameters
- $params : string = ''
Tags
Return values
array<string|int, mixed> —setAuth()
加密会话 <pre> sys.auth 中指定cookie/session </pre>
protected
setAuth(string $key, string|array<string|int, mixed> $value[, int $expire = 86400 ]) : bool
Parameters
- $key : string
-
key
- $value : string|array<string|int, mixed>
-
值
- $expire : int = 86400
-
过期时间(默认一天过期)
Tags
Return values
bool —setDatabaseConfigFile()
设置配置文件名
protected
setDatabaseConfigFile(string $linkConfigFile) : void
Parameters
- $linkConfigFile : string
Return values
void —sParams()
还原加密后的参数
protected
sParams([bool $useAnnotate = true ][, null|string $params = null ]) : array<string|int, mixed>|bool|string
Parameters
- $useAnnotate : bool = true
- $params : null|string = null
Return values
array<string|int, mixed>|bool|string —urlEncrypt()
uri参数加密
protected
urlEncrypt(string $params[, string $type = 'encode' ]) : bool|string
Parameters
- $params : string
- $type : string = 'encode'
Return values
bool|string —getLink()
获取默认model的实例
private
getLink() : RedisDriver|CouchDriver|MongoDriver|PDOSqlDriver|mixed
Tags
Return values
RedisDriver|CouchDriver|MongoDriver|PDOSqlDriver|mixed —getModuleConfigFile()
获取连接配置文件名
private
getModuleConfigFile() : mixed