Jelly ORM 技术文档

1. 安装指南

环境要求

• PHP 5.3 或更高版本
• Kohana 3.3 或更高版本
• 支持的数据库：MySQL、SQLite、PostgreSQL

安装步骤

1. 下载Jelly ORM
   你可以通过以下命令从GitHub下载Jelly ORM：

   git clone https://github.com/jonathangeiger/kohana-jelly.git
   

2. 将Jelly ORM添加到Kohana项目中
   将下载的kohana-jelly目录复制到你的Kohana项目的modules目录下。

3. 启用Jelly模块
   在Kohana的application/bootstrap.php文件中，添加以下代码以启用Jelly模块：

   Kohana::modules(array(
       'jelly' => MODPATH.'kohana-jelly',
       // 其他模块
   ));
   

4. 配置数据库
   确保你的Kohana项目已经正确配置了数据库连接。你可以在application/config/database.php中进行配置。

5. 运行单元测试
   为了确保Jelly ORM在你的环境中正常工作，建议运行单元测试：

   phpunit --bootstrap=modules/kohana-jelly/bootstrap.php modules/kohana-jelly/tests
   

2. 项目的使用说明

创建模型

Jelly ORM使用模型来表示数据库表。你可以通过继承Jelly_Model类来创建模型。例如：

class Model_User extends Jelly_Model {
    public static function initialize($meta) {
        $meta->fields(array(
            'id' => new Field_Primary,
            'name' => new Field_String,
            'email' => new Field_String,
        ));
    }
}

基本操作

• 创建记录

  $user = Jelly::factory('user');
  $user->name = 'John Doe';
  $user->email = '[e-mail]';
  $user->save();
  

• 查询记录

  $users = Jelly::select('user')->where('name', '=', 'John Doe')->execute();
  

• 更新记录

  $user = Jelly::select('user')->where('id', '=', 1)->load();
  $user->email = '[e-mail]';
  $user->save();
  

• 删除记录

  $user = Jelly::select('user')->where('id', '=', 1)->load();
  $user->delete();
  

3. 项目API使用文档

主要API

• Jelly::factory($model)
  创建一个新的模型实例。

  $user = Jelly::factory('user');
  

• Jelly::select($model)
  创建一个查询构建器实例。

  $users = Jelly::select('user')->where('name', '=', 'John Doe')->execute();
  

• Jelly::meta($model)
  获取模型的元数据。

  $meta = Jelly::meta('user');
  

字段类型

Jelly ORM支持多种字段类型，包括：

• Field_Primary：主键字段
• Field_String：字符串字段
• Field_Integer：整数字段
• Field_Float：浮点数字段
• Field_Boolean：布尔字段
• Field_Text：文本字段
• Field_Date：日期字段
• Field_DateTime：日期时间字段

关系类型

Jelly ORM支持以下关系类型：

• belongs_to：一对一关系
• has_many：一对多关系
• many_to_many：多对多关系

4. 项目安装方式

通过Composer安装

1. 在项目的composer.json文件中添加Jelly ORM的依赖：

   "require": {
       "jonathangeiger/kohana-jelly": "dev-master"
   }
   

2. 运行Composer安装命令：

   composer install
   

3. 在Kohana的bootstrap.php中启用Jelly模块：

   Kohana::modules(array(
       'jelly' => MODPATH.'kohana-jelly',
       // 其他模块
   ));
   

手动安装

按照安装指南中的步骤手动下载并安装Jelly ORM。

---

通过以上文档，你应该能够顺利安装、使用并深入了解Jelly ORM的功能和API。