# sd-module 外包快速开发 #####version 3.0 ##数据库推荐规则 * 主键：`id` 类型`int` * 创建时间：`create_time` 类型`datetime` * 修改时间：`update_time` 类型`datetime` * 软删除字段：`delete_time` 类型`int` 默认 0 * 关联字段：`表名_id` （例：`user_id`） * 父级字段：`pid` ##创建CURD > 创建完成后有默认功能 > * 列表数据 ( `index`，post（或异步ajax）请求返回数据，get请求返回页面) > * 新增数据 ( `create`，post请求保存数据，get请求渲染页面， 自定义action(已验证数据，获取全部数据请用TP request):`customAdd`, 或定义对应Model的`addHandle`) > * 修改数据 ( `update`，post请求保存数据，get请求渲染页面， 自定义action(已验证数据，获取全部数据请用TP request):`customEdit`, 或定义对应Model的`editHandle`) > * 删除数据 `del`(自定义method：`delete`) >> 写入数据之前操作写入的数据 method ,用来处理写入前需要处理的数据 >> ``` >> protected function beforeWrite(&$data){} >> ``` ##listData 数据调用 ```php public function listData(){} ``` ``` * ->setAlias(string $alias) 设置表别名 * ->setSort(string $sort) 设置排序字段 * ->setEach(\Closure $callback) 设置数据处理 * ->setJoin(array $join) 设置关联,二维数组 * ->setWith($whit) 设置TP关联 * ->setField(string $field) 设置查询字段 * ->setWhere(array $where) 设置查询条件 * ->setGroup(string $group) 设置分组条件 * ->setCustomReturn($return) 设置返回格式 ``` 例子： ```php return $this->setJoin([ ['role r', 'r.id = i.role_id'] ])->setField('i.id,i.name,i.account,i.status,r.role,i.lately_time,i.create_time') ->setWhere(['r.administrators_id' => admin_session('id')]) ->setSort('i,id,desc') // 别名， 字段， 方式 ->listsRequest(); ``` ## 列表搜索表单创建 支持4种类型表单： 1. 文本 `SearchForm::Text(string $name, string $placehoder)` 2. 下拉单选 `SearchForm::Select(string $name, string $placehoder)` 3. 时间 `SearchForm::Time(string $name, string $placehoder)` 4. 时间范围 `SearchForm::TimeRange(string $name, string $placehoder)` > 生成表单调用：`->html()`; 时间和时间范围表单可传参数： `date` `datetime` `month` `year`，默认： `date` > 下拉单选需传数组：[ value => title,.... ], 例：`[1 => 待付款， 2 => 已付款，...]`， > 调用`->label(true)`可生成表单label >> 参数 `name` 最后两位匹配搜索规则，匹配不上则表示 `=` >> ```php >> [ >> '_=' => '=', >> '_<' => '<', >> '_>' => '>', >> '<=' => '<=', >> '>=' => '>=', >> '%%' => 'LIKE', >> '_%' => 'RIGHT LIKE', >> '%_' => 'LEFT LIKE', >> '_I' => 'IN', >> '_N' => 'NULL', >> '_B' => 'BETWEEN', >> '>t' => '> TIME', >> '>T' => '>= TIME', >> ' '< TIME', >> ' '<= TIME', >> '<>' => '<>', >> '_~' => '~' // 范围查询 >> ]; >> ``` 示例代码： ```php // model use sdModule\layuiSearch\SearchForm; use sdModule\layui\Layui; class test { public static function searchFormData():array { return [ SearchForm::Text('i.id', "ID")->label(true)->html(), SearchForm::Text('i.title%%', "标题")->label(true)->html(), SearchForm::Text('i.intro%%', "简介")->label(true)->html(), SearchForm::Select('i.status', "状态")->label(true)->html(self::getStatusSc(false)), SearchForm::Text('administrators.name%%', "管理员")->label(true)->html(), SearchForm::Text('test.title%%', "上级")->label(true)->html(), SearchForm::TimeRange("i.create_time_~", "创建时间")->label(true)->html(TimeRange::TYPE_DATETIME), ]; } public static function getStatusSc($tag = true) { return $tag === true ? [ '1' => Layui::tag()->green('正常'), '2' => Layui::tag()->red('冻结'), '3' => Layui::tag()->blue('隐藏'), '4' => Layui::tag()->black('你好'), ] : [ '1' => '正常', '2' => '冻结', '3' => '隐藏', '4' => '你好', ]; } } ``` #### sd-module后台配置文件《 admin.php 》 ```php [ // 维护模式后台账号登录的规则 'maintain_admin_rule' => [ 'account' => '/__mt$/', 'password' => '/^__mt/' ], // 后台登录密码最大错误次数 'max_error_password_number' => 10, // 缓存全部路由的键 'route_cache' => 'route_sd_cache_2_0', // 后台中间件注册 'middleware' => [ // 登录验证， 必须 LoginMiddleware::class, // 单点登陆 SinglePoint::class, // 权限验证 PowerAuth::class, // 日志记录 Log::class // 表单token验证 // FormTokenVerify::class ], // 日志写入的请求方式,开启日志有效 // 'log_write' => ['GET', 'POST'], 'log_write' => ['POST'], // 表主键 'primary_key' => 'id', // 百度编辑器上传地址 'editor_upload' => '', // 软删除 'soft_delete' => [ // 字段 'field' => 'delete_time', // 默认值 'default' => 0, // 删除后的值，timestamp(时间戳)|mixed 'value' => 'timestamp', ], // 表时间字段处理：type 可取 datetime | timestamp 'time_field' => [ 'create_time' => [ 'field' => 'create_time', 'type' => 'datetime' ], 'update_time' => [ 'field' => 'update_time', 'type' => 'datetime' ], ], // table list 的表格默认配置，参考layui的表格基础参数配置 'layui_config' => [ 'skin' => 'nob', // 'size' => 'lg', 'even' => true ], // 数据权限配置 'data_auth' => [ ['table' => 'role', 'field' => 'role', 'remark' => '角色', ], ['table' => 'test', 'field' => 'title', 'remark' => '测试', ], ['table' => 'administrators', 'field' => 'name', 'remark' => '管理员', ], ] ]; ``` ## 列表页面简单操作 示例代码 ```php use sdModule\layui\TablePage; use sdModule\layui\TablePage\TableAux; use sdModule\layui\Layui; $table = TablePage::create([ TableAux::column(['type' => 'checkbox']), // 直接传定义列属性的数组，参考layui table TableAux::column('id', 'ID'), TableAux::column('title', '标题'), TableAux::column('cover', '封面', '@image'), // 图片 TableAux::column('intro', '简介', function(){ // 自定义展示方式 return "if (d.intro == 1) {return 1}else{return 2}"; // 写js代码 }), TableAux::column('status', '状态', '#line_id'), // 指定ID的模板 TableAux::column('administrators_name', '管理员', '', ['edit' =>true]), // 设置更多的列属性 TableAux::column('parent_title', '上级'), TableAux::column('create_time', '创建时间'), ]); $table->setHandleWidth(300); // 设置行操作栏宽度 $table->setEvent(['update', 'delete', 'detail', 'incd']);// 设置行操作事件 $table->setBarEvent(['create', 'delete',]);// 设置表格头部操作事件 $table->setEventWhere('create', 'd.status == 1', true); // 设置行事件的显示与隐藏 $table->addEvent('event'); // 添加事件 $table->addEvent(['event', 'event1']); // 添添加多个事件 $table->addBarEvent('event'); // 添添加头部事件 $table->addBarEvent(['event', 'event1']); // 添添加多个头部事件 $table->setConfig(['skin' => 'row']); // 设置layui渲染table的属性值 // 设置layui渲染table的属性值，有页面参数条件时 $table->setConfig(['where' => ['search' => ['id' => request()->get('id')]]]); // 设置事件html(行 $table->setEventHtml('detail', Layui::button('详情', 'read')->setEvent('detail')->primary('xs')); // 设置事件html(头部 $table->setBarEventHtml('incd', Layui::button('异步', 'ii')->setEvent('incd')->primary('xs')); // 设置事件js(头部，打开新的弹窗页面 $table->setEventJs('detail', TableAux::openPage([url('detail')], '详情', ['area' => ['90%', '50%']], true)); // 打开新的tabs页面 路劲带参数,第一个参数以数组方式传，后面的回取当前行的数据 $table->setEventJs('detail', TableAux::openTabs([url('detail'), 'id', 'status'], '详情')); // 设置事件js(头部，异步ajax请求 $table->setEventJs('incd', TableAux::ajax(url('incd'), 'get', '确认通过此审核此吗？')); // 设置js事件，增加列表搜索条件，并重置表格 $table->setEventJs('incd', TableAux::searchWhere(['id' => 1])); // 设置行事件的展示条件， d :当前行数据的对象， 要id => d.id $table->setEventWhere('event', 'd.status_ == 1'); //设置表格大小 $table->setSize('lg'); // 设置操作风格 $table->setHandleStyle(TablePage::HANDLE_STYLE_NORMAL); $table->setHandleStyle(TablePage::HANDLE_STYLE_ALL ^ TablePage::HANDLE_STYLE_CONTEXT_BUTTON); ``` ### 自定义html页面，复制view/admin/common/custom_page.php 文件 ### 该写HTML页面的时候，就要写 ### 该写HTML页面的时候，就要写 ### 该写HTML页面的时候，就要写 ## 合并工具类 ```php use sdModule\common\Sc; Sc::jwt(['id' => 2])->getToken(); $inputFileName = root_path() . '102ss9.xls'; // 下载excel Sc::excel($inputFileName, 'write', 'Xls') ->writeFromArray(['标题','年龄']) ->writeFromArray( [ ['asd', 'asd', 'asd'], ['asd', 'asd', 'asd'], ] , 'test') ->download(); // 详情请自行调用Sc类{sdModule\common\Sc} ``` ## 表单生成 示例代码 ```php use sdModule\layui\defaultForm\FormData; //初始化表单 $form = \sdModule\layui\defaultForm\Form::create([ FormData::hidden('id'), FormData::text('title', '标题')->preset('asd'), // 设置表单默认值 FormData::image('cover', '封面')->inputAttr(['add' => 'disable']), // 设置对应场景该表单 的HTML属性值 FormData::images('show_images', '展示图')->removeScene(['add']), // 删除在指定场景的该表单 FormData::text('intro', '简介'), FormData::radio('status', '状态', self::getStatusSc(false))->unitConfig(['ss' => 'ss']), // 设置该表单的js配置项，目前只针对selects表单 FormData::select('administrators_id', '管理员', Administrators::addSoftDelWhere()->column('name', 'id')), FormData::select('pid', '上级', Test::addSoftDelWhere()->column('title', 'id')), FormData::uEditor('content', '详情'), FormData::build( // 一行包含多个表单 FormData::text('title', '标题')->preset('asd'), FormData::text('intro', '简介'), ), "这是label" => FormData::table( // table 里面的表单， 一个数组就是一行，每个元素可以使字符串 或FormData ["标题", "简介"], [FormData::text('title')->preset('asd'), FormData::text('intro')], // 如果是数组，第一个则是单元格td的内容，第二个则是单元格的属性（可定义id,class,style,colspan,rowspan, ...） [['测试属性', 'colspan="3"'], ['测试属性', 'style="color:#fff"']], ), "T_*.." => FormData::table(), // 不展示label ], 'add'); // 设置默认值 $form->setDefaultData(['id' => 1, 'title' => 'asdasd']); // 设置表单占中心页面比例，设置后提交按钮会重置到表单下方 $form->setCustomMd(12); /** @see app\common\BasePage::$md */ // 自定义js代码， $form->setJs('location.reload()'); /** @see app\common\BasePage::formJs() */ // 设置短标签 $form->setShortFrom([ 'title' => '这是短标签提示语，可为空' ]); /** @see app\common\BasePage::shortInput() */ ``` * 支持类型 ```php use sdModule\layui\defaultForm\FormData; FormData::text('id', 'ID'); FormData::image('id', 'ID'); FormData::images('id', 'ID'); FormData::radio('id', 'ID', ['1' => 'normal']); FormData::checkbox('id', 'ID', ['1' => 'normal']); FormData::select('id', 'ID', ['1' => 'normal']); FormData::textarea('id', 'ID'); FormData::password('id', 'ID'); FormData::hidden('id'); FormData::time('id', 'ID', 'date', true); FormData::uEditor('id', 'ID'); FormData::upload('id', 'ID'); FormData::switch_('id', 'ID', [1=>2,2=>3], 2); FormData::selects('id', 'ID', [1 => '12'], '请选择'); FormData::build( // 组合，一行包含多个表单 FormData::text('id', 'ID'), FormData::image('id', 'ID') ); // 预设值 FormData::text('id', 'ID')->preset('298'); // 指定场景不展示该字段 FormData::text('id', 'ID')->removeScene(['edit']); // 指定场景给该元素加额外的html标签属性 FormData::text('id', 'ID')->inputAttr([ 'edit' => 'disable' ]); // js独立配置 FormData::selects('id', 'ID', [1 => '12'], '请选择')->unitConfig(['search' => true]); // 远程搜索 FormData::selects('id', 'ID', [1 => '12'], '请选择')->unitConfig(['remote' => (string)url('index')]); // 远程搜索返回值 return ResponseJson::success(['data' => $data, 'page' => 10]); ``` ## 静态表格数据（适用数据详情） ```php use sdModule\layui\tableDetail\TableConstruct as T; $data = ['nickname' => '这是测试的', 'phone' => '15896968585']; // 单个表格 T::data($data)->title('测试')->render([ T::tr( T::td('昵称', 'nickname'), T::td('电话', 'phone') ) ]); // 多个表格 T::data([$data, $data], true)->title(['测试', '测试1'])->render([ [ T::tr( T::td('昵称', 'nickname'), T::td('电话', 'phone') ) ],[ T::tr( T::td('昵称', 'nickname'), T::td('电话', 'phone') ) ], ]); // 加按钮事件 T::data($data)->afterButton( T::button('按钮文字', url("请求地址"), '请求数据 array '), T::button('按钮文字2', url("detail"), ['id' => $data['id'], 'sd' => 'asdasd']) ); T::data($data)->beforeButton( T::button('按钮文字', url("请求地址"), '请求数据 array '), T::button('按钮文字2', url("detail"), ['id' => $data['id'], 'sd' => 'asdasd']) ); ``` > ::td('title', 'name', td_grid, type); name 表示对应 data的键值，td_grid 值占用列数，type 类型：text|image|images, > images的路径用英文逗号隔开, 默认text, 可用::tdImage() ,tdImages(). ## 外部接口中间件 * Token.php 自动验证Token,传输Token方式`Header`，参数名：`Token`, 刷新Token的参数名：`Refresh-Token`,开发模式下 可配置参数`NO_TOKEN` 值,以他的值传参数，可不用`token`, 如配置：NO_TOKEN = 123123123 `header`参数传输示例，`"123123123":"key=value&key=value..."`形式传参 >已内置到接口基类 `app\common\controller\Api` ### RequestListen.php 路由中间件（请求监听，记录详细日志，默认未启用），启用中间件的第二个参数为监听时间值为数组： `['开始时间|指定某一秒'， '结束时间'， '是否每天执行（布尔值，可选）']`， > ```php > use think\facade\Route; > // 不指定时间 > Route::get('request-listen', 'index/index')->middleware(\app\middleware\RequestListen::class, []); > // 指定某一段 > Route::get('request-listen', 'index/index')->middleware(\app\middleware\RequestListen::class, ['2020-07-01 12:11:00','2020-07-02 12:11:00']); > // 指定每天某一段 > Route::get('request-listen', 'index/index')->middleware(\app\middleware\RequestListen::class, ['12:11:00','14:11:00', true]); > // 指定某一刻 > Route::get('request-listen', 'index/index')->middleware(\app\middleware\RequestListen::class, ['12:11:00']); > >``` ## 其他 ###创建layui样式的button 及tag ```php use sdModule\layui\Layui; Layui::button('按钮', 'layui-icon-read')->setEvent('incd')->danger(); Layui::tag()->blue('你好'); Layui::tag()->customColorFFFFFF('你好');// 自定义标签颜色 ``` ### redis 加锁执行代码 ```php use sdModule\common\Sc; // 加锁执行 Sc::redis()->lock([$this, 'test']); Sc::redis()->lock('app::test'); Sc::redis()->lock(fn()=>1); // 等待执行，默认最长时间10S Sc::redis()->wait(fn()=>1); ``` ### 简单文件存储数据 ```php use sdModule\common\sc; // 设置 sc::fileStorage()->set(['test' => 'test']); sc::fileStorage()->set('test', 'test'); // 获取 sc::fileStorage()->get('get'); // 删除 sc::fileStorage()->del('get'); // 分组操作 sc::fileStorage('test')->set('get', 'get'); sc::fileStorage('test')->get('get'); sc::fileStorage('test')->get(); // 获取该组全部数据 sc::fileStorage('test')->del('get'); sc::fileStorage('test')->del(); // 删除该组全部数据 // 设置有效期 sc::fileStorage('test')->set('get', 'get', 30); sc::fileStorage('test')->set(['test' => 'test'], 30); ``` ### JWT ```php use sdModule\common\Sc; Sc::jwt(['user_id' => 23232323])->getToken(); Sc::jwt(['user_id' => 23232323])->getRefresh(30)->getToken(); ``` ### 邮件发送 ```php use PHPMailer\SdMailer; SdMailer::getInstance('chenlong', 'vip_chenlong@163.com', 'password') ->setAddress('sd.chenlong@gmail.com', 'chenlong') ->provider($config, 'utf8'); ``` ### 传承短信 > `.env`文件里面配置`[CC_SMS]`参数 ```php use sdModule\common\Sc; Sc::CcSms('183****8033')->templateId(1)->send(); ``` ### ajax 请求返回json 格式化 ```php use app\common\ResponseJson; ResponseJson::fail( '失败'); ResponseJson::fail( '失败', 203); ResponseJson::success('成功'); ResponseJson::success('成功', '请求成功！'); ``` ### 字符双向加密 ```php use sdModule\common\Sc; // 加密 $q0 = Sc::ciphertext()->encrypt('1310-1019'); $q1 = Sc::ciphertext()->encrypt('1310-1019', '2e', 'aes-192-ccm'); $q2 = Sc::ciphertext()->encrypt('1310-1019', '', 'aes-192-ofb'); // 解密 Sc::ciphertext()->decrypt($q0); Sc::ciphertext()->decrypt($q1, '', 'aes-192-ofb'); Sc::ciphertext()->decrypt($q2, '2e', 'aes-192-ccm'); // 设置固定IV $q4 = Sc::ciphertext()->setIV('this IV')->encrypt('1310-1019'); Sc::ciphertext()->setIV('this IV')->decrypt($q4); ``` ### 密码单项加密，验证 ```php use sdModule\common\Sc; // 加密 Sc::password()->encryption('123456'); Sc::password()->verify("123", "asdasdasd"); ``` ### excel >此项不适合大文件操作 ```php use sdModule\common\Sc; Sc::excel('index.xls', 'write', 'Xls')->getActiveData(); Sc::excel('index.xls', 'write', 'Xls')->getActiveData(true); // 批次处理 Sc::excel('index.xls', 'write', 'Xls')->batchRead(function($data, $info){}, 500); ``` ### 资源读取输出 ```php use sdModule\common\Sc; Sc::resource()->remote('http://127.0.0.1/t.mp4'); // 远程读取并输出 Sc::resource()->localhost('C:\Users\Administrator\Desktop\ccc.pdf'); // 本地读取并输出 ``` ### 阿里云短信 ```php use sdModule\common\Sc; // 发送单条短讯 Sc::aLiYunSms()->send('1838****033', '2023'); // 单条信息多个参数，配置env后 Sc::aLiYunSms()->send('1838****033', '2023','asdasd'); // 单条信息多个参数，未配置env template Sc::aLiYunSms()->send('1838****033', [ 'code' => '2023', 'msg' => 'asdasd']); // 批次发送信息 Sc::aLiYunSms()->batchSend(['1838****033', '1832****72'], [ ['code' => '123'], ['code' => '456'] ]); ```