boa框架开发手册v5.2

msg类
版本 1.0+
命名空间 boa
文件 boa/msg.php
说明 消息类,静态类,配置:
'MSG_DISPLAY' => '',
'MSG_TYPE_VAR' => '',
'MSG_TYPE_VAL' => '',
'MSG_JSONP_CB' => '',
'MSG_STR_CLASS' => '',
'MSG_LOG_NOTICE' => ,
配置
配置项 默认值 类型 说明
MSG_DISPLAY php_exception,php_error string 可选;设置PHP错误输出类型,可选值:php_exception, php_warning, php_error, php_deprecated, php_strict
MSG_TYPE_VAR _msg string 可选;通过前端设置消息输出类型,$_REQUEST取值时的键,表示取_msg字段
MSG_TYPE_VAL json string 可选;通过前端设置消息输出类型,$_REQUEST取值时的值,表示为json类型
MSG_JSONP_CB message string 可选;当消息为jsonp类型时,前端JS回调函数名称
MSG_STR_CLASS boa_msg string 可选;当消息输出时,前端CSS默认class名称
MSG_LOG_NOTICE false bool 可选;是否处理PHP的notice消息
目录
方法 说明
set_data() 设置数据,可以作为json、xml等类型输出时的数据项
set_type() 设置消息输出类型,默认跟随系统,无需手动设置
begin() 开启批量输出,默认每产生一条消息就会自动输出,调用此方法关闭自动输出
commit() 手动确认输出,配合begin()使用
setE() 设置PHP错误
setEx() 设置PHP异常
set() 设置系统消息
方法

set_data()

说明
设置数据,可以作为json、xml等类型输出时的数据项
参数 必须 默认值 类型 说明
$data [] array 附加数据
示例
msg::set_data([...]);
msg::set('boa.info.done');

set_type()

说明
设置消息输出类型,默认跟随系统,无需手动设置
参数 必须 默认值 类型 说明
$type Y string 消息类型,可选值:
  • xml:以XML格式输出
  • json:以JSON格式输出
  • str:以HTML片段输出
  • msg:使用消息模板输出
  • cli:命令行下输出
  • jsonp:以JSONP格式输出
示例
msg::set_type('xml');
msg::set("It's wrong!");

begin()

说明
开启批量输出,默认每产生一条消息就会自动输出,调用此方法关闭自动输出
示例
msg::begin();
...
msg::set('boa.error.1', 'wrong1');
...
msg::set('boa.error.2', 'wrong2');
...
msg::commit();

commit()

说明
手动确认输出,配合begin()使用

setE()

说明
设置PHP错误
参数 必须 默认值 类型 说明
$no Y int 错误码
$str Y string 错误描述
$file Y string 发生文件
$line Y int 发生行号

setEx()

说明
设置PHP异常
参数 必须 默认值 类型 说明
$e Y object 异常

set()

说明
设置系统消息
参数 必须 默认值 类型 说明
$... Y mixed 动态参数
  • 首个参数:消息内容,必须的,支持节点式语言标签
  • 更多参数,参见boa::lang(),可选的
示例
msg::set('You are awesome!');
msg::set('boa.error.1', 'You are wrong!');
msg::set('boa.error.5', 'test');
msg::set('home.error.10', 'test', 1);