QQ扫一扫联系
获取MSCore版本
modstart_version( )
string 版本号生成Admin的路径,自动加前缀
modstart_admin_url( string, array )
string $url 路径array $param 参数string
代码示例
// 返回 /admin/aaa/bbb
modstart_admin_url('aaa/bbb')
// 返回 /admin/aaa/bbb?x=y
modstart_admin_url('aaa/bbb',['x'=>'y'])
modstart_web_full_url( string, array )
string $url 路径array $param 参数string 地址代码示例
// 返回 http://www.example.com/aaa/bbb
modstart_web_full_url('aaa/bbb')
// 返回 http://www.example.com/aaa/bbb?x=y
modstart_web_full_url('aaa/bbb',['x'=>'y'])
生成Web的路径,自动加前缀
modstart_web_url( string, array )
string $url 路径array $param 参数string 地址代码示例
// 返回 /aaa/bbb
modstart_web_url('aaa/bbb')
// 返回 /aaa/bbb?x=y
modstart_web_url('aaa/bbb',['x'=>'y'])
生成Api的路径,自动加前缀
modstart_api_url( string, array )
string $url 路径array $param 参数string
代码示例
// 返回 /api/aaa/bbb
modstart_api_url('aaa/bbb')
// 返回 /api/aaa/bbb?x=y
modstart_api_url('aaa/bbb',['x'=>'y'])
modstart_configs( $keys, $default )
$keys array 多个配置名$default string 默认值void array|bool|int|mixed|\ModStart\Core\Config\MConfig|string用于获取表 config 中的配置选项
modstart_config( $key, $default, $useCache )
$key string 配置名称$default string|array|boolean|integer 默认值,不能为 null$useCache boolean 启用缓存,默认为truestring|array|boolean|integer|\ModStart\Core\Config\MConfig 返回配置值或配置对象代码示例
// 网站名称
modstart_config('siteName','[默认名称]');
// 获取一个配置数组,数组需存储成 json 格式
modstart_config()->getArray('xxx')
// 设置配置项
modstart_config()->set('xxx','aaa')
modstart_config_asset_url( $key, $default )
$key string 配置名称$default string 默认值string
判断模块是否已安装并启用
modstart_module_enabled( $module, $version )
$module string 模块名称,如 Member$version string 模块版本要求,如 1.0.0, >=1.0.0boolean 模块是否安装并启用代码示例
// 模块Member是否安装并启用
modstart_module_enabled('Member')
// 模块Member是否安装了 >=1.2.0 的版本
modstart_module_enabled('Member','>=1.2.0')
LM( $module, $name, ...$params )
$module string 模块名称$name string 多语言...$params string|int 多语言参数string 多语言翻译代码示例
// 获取模块Member的多语言
LM('Member','Message')
// 获取模块Member的多语言,带参数
LM('Member','File Size Limit %s','10M')
获取多语言翻译
L( $name, ...$params )
$name string 多语言...$params string|int 多语言参数string 多语言翻译代码示例
// 返回 消息
L('Message');
// 返回 文件最大为10M
L('File Size Limit %s','10M');
ModelUtil::model( $model )
$model string 数据表Model|Builder 数据库模型代码示例
// 查询
ModelUtil::model('user')->where(['id'=>1])->get()->toArray();
ModelUtil::model('user')->where('id','>',5)->get()->toArray();
// 查询-like
ModelUtil::model('user')->where('username','like','%keywords%')->get()->toArray();
// 查询-limit
ModelUtil::model('user')->limit(5)->get()->toArray();
// 查询-原生SQL
ModelUtil::model('user')->whereRaw(DB::raw('id > 0 OR id is null'))->get()->toArray();
// 删除
ModelUtil::model('user')->where(['id'=>1])->delete();
// 更新
ModelUtil::model('user')->where(['id'=>1])->update(['username'=>'aaa']);
ModelUtil::insert( $model, $data )
$model string 数据表$data array 数据数组array 插入的数据记录代码示例
ModelUtil::insert('user',['username'=>'aaa','nickname'=>'bbb']);
ModelUtil::insertAll( $model, $records, $updateTimestamp )
$model string 数据表$records array 多条数据数组$updateTimestamp boolean 是否更新时间戳,默认为truevoid
代码示例
ModelUtil::insertAll('user',[ ['username'=>'aaa','nickname'=>'bbb'], ['username'=>'ccc','nickname'=>'ddd'] ]);
ModelUtil::delete( $model, $where )
$model string 数据表$where array|int 条件数组或数据IDinteger 被删除的记录数量代码示例
// 删除ID为1的用户
ModelUtil::delete('user',1);
// 删除用户名为aaa的用户
ModelUtil::delete('user',['username'=>'aaa']);
ModelUtil::get( $model, $where, $fields, $order )
$model string 数据表$where int|array 条件$fields array 数据表字段$order array 排序,如 ['id','asc']array|null 数据记录代码示例
ModelUtil::get('user',1);
ModelUtil::get('user',['username'=>'xxx']);
更复杂的数据获取可以使用 ModelUtil::model('xxx') 进行操作
AgentUtil::getUserAgent( )
string
AgentUtil::device( )
string pc, mobileAgentUtil::isWechat( )
boolean
AgentUtil::isWechatMobile( )
boolean
AgentUtil::isWechatPC( )
boolean
AgentUtil::isMobile( )
boolean
AgentUtil::isPC( )
boolean
AgentUtil::detectRobot( $userAgent )
$userAgent string|null 浏览器UserAgent,为空时自动获取string|null 机器人名称,非机器人时返回nullEventUtil::fire( $event )
$event object|string
void
EventUtil::listen( $eventClass, $callback )
$eventClass string 事件类名$callback callable 回调函数void
FileUtil::mime( $ext )
$ext string 文件后缀string|null
FileUtil::mimeToExt( $mime )
$mime string MIME类型字符串string|null
FileUtil::write( $path, $content )
$path string
$content string
boolean 是否写入成功FileUtil::extension( $pathname )
$pathname string 文件路径string
FileUtil::listAllFiles( $dir, $filter )
$dir string 目录$filter Closure 过滤器,为空表示不过滤array
FileUtil::listFiles( $filename, $pattern )
$filename string
$pattern string 后缀过滤,如 *.txt *.php 等array
FileUtil::formatByte( $bytes, $decimals )
$bytes integer 字节数$decimals integer 小数最多保留位数,默认为2string
代码示例
// 返回 1 MB
FileUtil::formatByte(1024*1024)
// 返回 1.5 GB
FileUtil::formatByte(1024*1024*1024*1.5)
FileUtil::formatByteSimple( $bytes, $decimals )
$bytes integer 字节数$decimals integer 小数最多保留位数,默认为2string
代码示例
// 返回 1 M
FileUtil::formatByte(1024*1024)
// 返回 1.5 G
FileUtil::formatByte(1024*1024*1024*1.5)
FileUtil::formattedSizeToBytes( $sizeString )
$sizeString string 如 1Minteger
FileUtil::copy( $src, $dst, $replaceExt, $callback, $filter )
$src string 源路径,必须给出,不能为空$dst string 源路径,必须给出,不能为空$replaceExt string|null 如果文件存在需要添加的后缀名,作为备份使用,如果不传表示不备份$callback Closure|null 复制回调$filter Closure|null 复制过滤器null 注意:src 和 dst 如果是文件,需同时是文件,如果是目录,需同时是目录FileUtil::rm( $dir, $removeSelf )
$dir string 目录$removeSelf boolean 是否删除本身boolean
一般用于页面渲染时页面元素唯一ID
IdUtil::generate( string )
string $group
string 生成的ID字符串代码示例
// 将生成 Aaa_1 Aaa_2 Aaa_3
IdUtil::generate('Aaa')
IdUtil::next64BitId( )
string ID字符串一个19位长的(BigInteger)
IdUtil::generateSN( )
string
代码示例
// 生成 20210101010101+12121
IdUtil::generateSN()
PageHtmlUtil::nextPageUrl( $total, $pageSize, $currentPage, $url )
$total integer 总记录数$pageSize integer 每页记录数$currentPage integer 当前页$url string 分页链接,页码使用 {page} 占位void
PageHtmlUtil::prevPageUrl( $total, $pageSize, $currentPage, $url )
$total integer 总记录数$pageSize integer 每页记录数$currentPage integer 当前页$url string 分页链接,页码使用 {page} 占位void
PageHtmlUtil::render( $total, $pageSize, $currentPage, $url, $template )
$total integer 总记录数$pageSize integer 每页记录数$currentPage integer 当前页$url string 分页链接,页码使用 {page} 占位$template string 模板void
生成PNG格式的二维码图片
QrcodeUtil::png( $content, $size )
$content string 二维码内容$size integer 大小,默认200string 图片二进制串生成二维码Base64串
QrcodeUtil::pngBase64String( $content, $size )
$content string 二维码内容$size integer 大小,默认200string 二维码Base64字符串代码示例
// 返回 data:image/png;base64,xxxxxxxx
QrcodeUtil::pngBase64String('http://www.xxx.com')
RandomUtil::number( $length )
$length integer 长度string 字符串RandomUtil::string( $length )
$length integer 长度string 字符串去掉0、O等相似字符
RandomUtil::readableString( $length )
$length integer 长度string 字符串RandomUtil::lowerReadableString( $length )
$length integer 长度string 字符串RandomUtil::upperReadableString( $length )
$length integer 长度string 字符串RandomUtil::hexString( $length )
$length integer 长度string 字符串RandomUtil::lowerString( $length )
$length integer 长度string 字符串只包含字母
RandomUtil::lowerChar( $length )
$length integer 长度string 字符串只包含字母
RandomUtil::upperChar( $length )
$length integer 长度string 字符串RandomUtil::upperString( $length )
$length integer 长度string 字符串使用年月日构造
RandomUtil::uuid( )
string UUIDRandomUtil::percent( $value )
$value integer 概率值boolean 是否成功StrUtil::mbLimit( $text, $limit )
$text string 待裁剪字符串$limit integer 裁剪长度string
StrUtil::mbLimitChars( $text, $limit )
$text string 待裁剪字符串$limit integer 裁剪长度void
StrUtil::mbLength( $text )
$text string
integer
StrUtil::wordSplit( $content )
$content string 分词的内容array 分词结果TreeUtil::itemsMergeLevel( $items, $idName, $pidName, $sortName, $pid )
$items array|Collection 数据记录$idName string ID字段名,默认为 id$pidName string 父级ID字段名,默认为 pid$sortName string 排序字段名,默认为 sort$pid int|string 父级ID,默认为 0Collection 返回带有 _level 属性的集合