Grocery CRUD 技术文档

1. 安装指南

环境要求

• PHP版本：5.6及以上
• Codeigniter版本：2.x 或 3.x
• 数据库：MySQL

安装步骤

1. 将Grocery CRUD库下载到本地。
2. 将下载的库文件放置到Codeigniter项目的application/libraries目录下。
3. 确保你的项目中已经配置好了数据库连接信息。

2. 项目的使用说明

Grocery CRUD是一个自动化的PHP和Codeigniter框架库，它能够创建一个完整的CRUD系统，无需定制JavaScript或CSS。

基础使用

$crud = new GroceryCrud();

// 设置数据库表
$crud->setTable('customers');

// 设置主题
$crud->setTheme('flexigrid');

// 设置操作主体
$crud->setSubject('客户');

// 渲染输出
$output = $crud->render();

配置选项

• setTable()：设置要操作的数据库表名。
• setSubject()：设置CRUD操作的主题，如“客户”、“用户”等。
• setTheme()：设置界面主题，默认为flexigrid。
• columns()：设置要在列表中显示的列。
• fields()：设置在添加或编辑表单中显示的字段。

3. 项目API使用文档

常用方法

• $crud->setTable(string $table)：设置数据库表。
• $crud->setSubject(string $subject)：设置操作主题。
• $crud->setTheme(string $theme)：设置界面主题。
• $crud->columns(array $columns)：设置列表显示的列。
• $crud->fields(array $fields)：设置添加或编辑表单的字段。

高级配置

• $crud->displayAs(string $field_name, string $display_as)：设置字段显示名称。
• $crud->requiredFields(array $fields)：设置必填字段。
• $crud->uniqueFields(array $fields)：设置唯一字段。
• $crud->callbackBeforeInsert(array $callback)：插入前回调函数。
• $crud->callbackAfterInsert(array $callback)：插入后回调函数。

4. 项目安装方式

下载安装

1. 访问Grocery CRUD官方网站，下载最新版本的库文件。
2. 将下载的文件解压并放置到Codeigniter项目的application/libraries目录下。

通过Composer安装

如果你使用Composer管理项目依赖，可以通过以下命令安装Grocery CRUD：

composer require grocerycrud/grocerycrud

安装完成后，你可以在application/libraries目录下找到Grocery CRUD库文件。按照前面的使用说明进行配置和使用即可。