一鍵生成CRUD · yzncms2.0使用手冊

## 一鍵生成CRUD 在YznCMS中可以快速的一鍵生成CRUD，自動生成后臺的控制器、模型、視圖、JS、菜單、回收站等，同時也支持使用`在線命令插件`實現本功能。 ***** 下面以`yzn_test`數據表為例，打開命令行控制臺進入到你的站點根目錄，也就是`think`文件所在的目錄，進行執行命令。 ### 常用命令 ~~~php //生成yzn_test表的CRUD php think crud -t test //生成yzn_test表的CRUD且一鍵生成菜單 php think crud -t test -u 1 //刪除yzn_test表生成的CRUD php think crud -t test -d 1 //生成yzn_test表的CRUD且控制器生成在二級目錄下 php think crud -t test -c mydir/test //刪除yzn_test表生成的二級目錄的CRUD php think crud -t test -c mydir/test -d 1 //生成yzn_test_log表的CRUD且生成對應的控制器為testlog php think crud -t test_log -c testlog //生成yzn_test表的CRUD且對應的模型名為testmodel php think crud -t test -m testmodel //生成yzn_test表的CRUD且生成關聯模型category，外鏈為category_id，關聯表主鍵為id php think crud -t test -r category -k category_id -p id //生成yzn_test表的CRUD且所有以list或data結尾的字段都生成復選框 php think crud -t test --setcheckboxsuffix=list --setcheckboxsuffix=data //生成yzn_test表的CRUD且所有以image和img結尾的字段都生成圖片上傳組件 php think crud -t test --imagefield=image --imagefield=img //關聯多個表,參數傳遞時請按順序依次傳遞，支持以下幾個參數relation/relationmodel/relationforeignkey/relationprimarykey/relationfields/relationmode php think crud -t test --relation=category --relation=admin --relationforeignkey=category_id --relationforeignkey=admin_id //生成v_phealth_db2數據庫下的yzn_test表的CRUD php think crud -t test --db=v_phealth_db2 ~~~ ***** ### 參數介紹 ~~~sql -t, --table=TABLE [必填]表名，帶不帶表前綴均可 -c, --controller[=CONTROLLER] [可選]生成的控制器名,默認根據表名進行自動解析 -m, --model[=MODEL] [可選]生成的模型名,默認根據表名進行自動解析 -i, --fields[=FIELDS] [可選]生成的數據列表中可見的字段,默認是全部 -f, --force[=FORCE] [可選]是否覆蓋模式,,如果目標位置已經有對應的控制器或模型會提示 -l, --local[=LOCAL] [可選]是否本地模型,默認1,置為0時,模型將生成在common模塊下 -r, --relation[=RELATION] [可選]關聯模型表名，帶不帶表前綴均可 -e, --relationmodel[=RELATIONMODEL] [可選]生成的關聯模型名,默認根據表名進行自動解析 -k, --relationforeignkey[=RELATIONFOREIGNKEY] [可選]表外鍵,默認會識別為使用模型_id 名稱 -p, --relationprimarykey[=RELATIONPRIMARYKEY] [可選]關聯模型表主鍵,默認會自動識別 -s, --relationfields[=RELATIONFIELDS] [可選]關聯模型表顯示的字段，默認是全部 -o, --relationmode[=RELATIONMODE] [可選]關聯模型,hasone/belongsto/hasmany [default: "belongsto"] -d, --delete[=DELETE] [可選]刪除模式,將刪除之前使用CRUD命令生成的相關文件 -u, --menu[=MENU] [可選]菜單模式,生成CRUD后將繼續一鍵生成菜單 --db[=key] [可選]多數據庫支持 --setcheckboxsuffix[=SETCHECKBOXSUFFIX] [可選]自動生成復選框的字段后綴 --enumradiosuffix[=ENUMRADIOSUFFIX] [可選]自動生成單選框的字段后綴 --imagefield[=IMAGEFIELD] [可選]自動生成圖片上傳組件的字段后綴 --filefield[=FILEFIELD] [可選]自動生成文件上傳組件的字段后綴 --intdatesuffix[=INTDATESUFFIX] [可選]自動生成日期組件的字段后綴 --switchsuffix[=SWITCHSUFFIX] [可選]自動生成可選組件的字段后綴 --citysuffix[=CITYSUFFIX] [可選]自動生成城市選擇組件的字段后綴 --selectpagesuffix[=SELECTPAGESUFFIX] [可選]自動生成Selectpage組件的字段后綴 --ignorefields[=IGNOREFIELDS] [可選]排除的字段 --editorclass[=EDITORCLASS] [可選]自動生成富文本組件的字段后綴 --headingfilterfield[=HEADINGFILTERFIELD] [可選]自動生成篩選過濾選項卡的字段，默認是status字段 --sortfield[=SORTFIELD] [可選]排序字段 ~~~ ***** # 數據表供參考 > **表注釋**和**字段注釋**請務必都填寫，以便生成對應字段中文，部分特殊字段需要參考下表的字段注釋規則 ``` CREATE TABLE `yzn_test` ( `id` int(10) unsigned NOT NULL AUTO_INCREMENT COMMENT 'ID', `user_id` int(10) DEFAULT '0' COMMENT '會員ID', `admin_id` int(10) unsigned DEFAULT '0' COMMENT '管理員ID(單選)', `admin_ids` varchar(100) DEFAULT NULL COMMENT '管理員ID(多選)', `tags` varchar(255) DEFAULT '' COMMENT '標簽', `week` enum('monday','tuesday','wednesday') DEFAULT NULL COMMENT '星期(單選):monday=星期一,tuesday=星期二,wednesday=星期三', `flag` set('hot','index','recommend') DEFAULT '' COMMENT '標志(多選):hot=熱門,index=首頁,recommend=推薦', `genderdata` enum('male','female') DEFAULT 'male' COMMENT '性別(單選):male=男,female=女', `hobbydata` set('music','reading','swimming') DEFAULT NULL COMMENT '愛好(多選):music=音樂,reading=讀書,swimming=游泳', `title` varchar(100) DEFAULT '' COMMENT '標題', `content` text COMMENT '內容', `image` varchar(100) DEFAULT '' COMMENT '圖片', `images` varchar(1500) DEFAULT '' COMMENT '圖片組', `attachfile` varchar(100) DEFAULT '' COMMENT '附件', `city` varchar(100) DEFAULT '' COMMENT '省市', `array` varchar(255) DEFAULT '' COMMENT '數組:value=值', `json` varchar(255) DEFAULT '' COMMENT '配置:key=名稱,value=值', `multiplejson` varchar(1500) DEFAULT '' COMMENT '二維數組:title=標題,intro=介紹,author=作者,age=年齡', `price` decimal(10,2) unsigned DEFAULT '0.00' COMMENT '價格', `views` int(10) unsigned DEFAULT '0' COMMENT '點擊', `workrange` varchar(100) DEFAULT '' COMMENT '時間區間', `startdate` date DEFAULT NULL COMMENT '開始日期', `activitytime` datetime DEFAULT NULL COMMENT '活動時間(datetime)', `year` year(4) DEFAULT NULL COMMENT '年', `times` time DEFAULT NULL COMMENT '時間', `refresh_time` bigint(16) DEFAULT NULL COMMENT '刷新時間', `create_time` bigint(16) DEFAULT NULL COMMENT '創建時間', `update_time` bigint(16) DEFAULT NULL COMMENT '更新時間', `delete_time` bigint(16) DEFAULT NULL COMMENT '刪除時間', `weigh` int(10) DEFAULT '0' COMMENT '權重', `switch` tinyint(1) DEFAULT '0' COMMENT '開關', `status` enum('normal','hidden') DEFAULT 'normal' COMMENT '狀態:hidden=禁用,normal=正常', `state` enum('0','1','2') DEFAULT '1' COMMENT '狀態值:0=禁用,1=正常,2=推薦', PRIMARY KEY (`id`) USING BTREE ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='測試表'; ``` ***** ## 根據字段類型 | 類型 | 備注 | 類型說明 | | --- | --- | --- | | int | 整型 | 自動生成type為number的文本框，步長為1 | | enum | 枚舉型 | 自動生成單選下拉列表框 | | set | set型 | 自動生成多選下拉列表框 | | float | 浮點型 | 自動生成type為number的文本框，步長根據小數點位數生成 | | text | 文本型 | 自動生成textarea文本框 | | datetime | 日期時間 | 自動生成日期時間的組件 | | date | 日期型 | 自動生成日期型的組件 | | timestamp | 時間戳 | 自動生成日期時間的組件 | | varchar | 字符串 | 自動生成textarea文本框| ***** ## 特殊字段 | 字段 | 字段名稱 | 字段類型 | 字段說明 | | --- | --- | --- | --- | | user_id | 會員ID | int | 將生成選擇會員的SelectPage組件，單選 | | user_ids | 會員ID集合 | varchar | 將生成選擇會員的SelectPage組件，多選 | | admin_id | 管理員ID | int | 將生成選擇管理員的SelectPage組件 | | admin_ids | 管理員ID集合 | varchar | 將生成選擇管理員的SelectPage組件，多選 | | weigh | 權重 | int | 后臺的排序字段，如果存在該字段將出現排序按鈕 | | create_time | 創建時間 | int/bigint/datetime | 記錄添加時間字段，不需要手動維護 | | update_time | 更新時間 | int/bigint/datetime | 記錄更新時間的字段，不需要手動維護 | | delete_time | 刪除時間 | int/bigint/datetime | 記錄刪除時間的字段，不需要手動維護，如果存在此字段將會生成回收站功能，字段默認值務必為`null` | | status | 狀態字段 | enum | 列表篩選字段 | ***** ## 以特殊字符結尾的規則 | 結尾字符 | 示例 | 類型要求 | 字段說明 | | --- | --- | --- | --- | | time | refreshtime | bigint/datetime | 識別為日期時間型數據，自動創建選擇時間的組件 | | image | smallimage | varchar | 識別為圖片文件，自動生成可上傳圖片的組件，單圖 | | images | smallimages | varchar | 識別為圖片文件，自動生成可上傳圖片的組件，多圖 | | file | attachfile | varchar | 識別為普通文件，自動生成可上傳文件的組件，單文件 | | files | attachfiles | varchar | 識別為普通文件，自動生成可上傳文件的組件，多文件 | | avatar | miniavatar | varchar | 識別為頭像，自動生成可上傳圖片的組件，單圖 | | avatars | miniavatars | varchar | 識別為頭像，自動生成可上傳圖片的組件，多圖 | | content | maincontent | text/mediumtext/longtext | 識別為內容 | | \_id | user\_id | int/varchar | 識別為關聯字段，自動生成可自動完成的文本框，單選 | | \_ids | user\_ids | varchar | 識別為關聯字段，自動生成可自動完成的文本框，多選 | | list | timelist | enum | 識別為列表字段，自動生成單選下拉列表 | | list | timelist | set | 識別為列表字段，自動生成多選下拉列表 | | data | hobbydata | enum | 識別為選項字段，自動生成單選框 | | data | hobbydata | set | 識別為選項字段，自動生成復選框 | | json | configjson | varchar | 識別為鍵值組件，自動生成鍵值錄入組件 | | switch | siteswitch | tinyint | 識別為開關字段，自動生成開關組件，默認值`1`為`ON`，`0`為`OFF`| | range | daterange | varchar | 識別為時間區間組件，自動生成時間區間組件 | | tag | articletag | varchar | 識別為Tagsinput，自動生成標簽輸入組件 | | tags | articletags | varchar | 識別為Tagsinput，自動生成標簽輸入組件 | > 溫馨提示：以list或data結尾的字段必須搭配enum或set類型才起作用 > 如果為多圖或多列表字段，請務必確保字段長度足夠 ***** ### 常見問題 1. CRUD的數據表有且只有一個`主鍵`，不支持`復合主鍵`。 2. 不可以對框架默認核心表進行CRUD，否則原有的框架后臺功能將無法正常使用。