README

by

• @kla - Kien La
• @jpfuentes2 - Jacques Fuentes
• 以及这些出色的贡献者

http://www.phpactiverecord.org/

简介

ActiveRecord 的简要概述

Active record 是一种访问数据库数据的方法。数据库表或视图被封装成一个类，因此对象实例与表中的一行绑定。创建对象后，在保存时会在表中添加新行。加载的对象从数据库获取其信息；当对象更新时，表中的对应行也会更新。包装类为表或视图中的每一列实现访问器方法或属性。

更多详情请参阅 这里。

这个实现受到了 Ruby on Rails 的 ActiveRecord 的启发，并大量借鉴了它的实现。我们尝试保持它们的约定，但在方便或必要时有所偏离。当然，如果用户熟悉 Rails，他们可能会发现一些明显的差异。

最低要求

• PHP 5.3+
• 相应数据库的 PDO 驱动程序

支持数据库

• MySQL
• SQLite
• PostgreSQL
• Oracle

功能

• 查找方法
• 动态查找方法
• 写入方法
• 关系
• 验证
• 回调
• 序列化（json/xml）
• 事务
• 支持多个适配器
• 其他选项，如：别名/受保护的/可访问的属性

安装

设置非常简单直接。您只需关注三个基本配置点

1. 设置模型自动加载目录。
2. 配置您的数据库连接。
3. 设置用于您环境的数据库连接。

示例

ActiveRecord\Config::initialize(function($cfg)
{
   $cfg->set_model_directory('/path/to/your/model_directory');
   $cfg->set_connections(
     array(
       'development' => 'mysql://username:password@localhost/development_database_name',
       'test' => 'mysql://username:password@localhost/test_database_name',
       'production' => 'mysql://username:password@localhost/production_database_name'
     )
   );
});

或者（无 5.3 闭包）

$cfg = ActiveRecord\Config::instance();
$cfg->set_model_directory('/path/to/your/model_directory');
$cfg->set_connections(
  array(
    'development' => 'mysql://username:password@localhost/development_database_name',
    'test' => 'mysql://username:password@localhost/test_database_name',
    'production' => 'mysql://username:password@localhost/production_database_name'
  )
);

PHP ActiveRecord 将默认使用您的开发数据库。对于测试或生产，您只需根据当前环境（'test' 或 'production'）设置默认连接即可

ActiveRecord\Config::initialize(function($cfg)
{
  $cfg->set_default_connection(your_environment);
});

一旦您配置了这三个设置，您就完成了。ActiveRecord 会为您处理其余工作。它不需要您将表模式映射到 yaml/xml 文件。它将查询数据库以获取此信息，并缓存它，以便不会对单个模式进行多次数据库调用。

基本 CRUD

检索

这些是您从数据库中查找和检索记录的基本方法。有关更多详细信息，请参阅 查找器 部分。

$post = Post::find(1);
echo $post->title; # 'My first blog post!!'
echo $post->author_id; # 5

# also the same since it is the first record in the db
$post = Post::first();

# finding using dynamic finders
$post = Post::find_by_name('The Decider');
$post = Post::find_by_name_and_id('The Bridge Builder',100);
$post = Post::find_by_name_or_id('The Bridge Builder',100);

# finding using a conditions array
$posts = Post::find('all',array('conditions' => array('name=? or id > ?','The Bridge Builder',100)));

创建

在这里，我们通过创建一个新的对象并调用 save() 方法来创建一个新的帖子。

$post = new Post();
$post->title = 'My first blog post!!';
$post->author_id = 5;
$post->save();
# INSERT INTO `posts` (title,author_id) VALUES('My first blog post!!', 5)

更新

要更新，您只需先找到一条记录，然后更改其属性之一。它保留一个属性数组，该数组标记为“脏”（已修改），因此我们的 SQL 将仅更新已修改的字段。

$post = Post::find(1);
echo $post->title; # 'My first blog post!!'
$post->title = 'Some real title';
$post->save();
# UPDATE `posts` SET title='Some real title' WHERE id=1

$post->title = 'New real title';
$post->author_id = 1;
$post->save();
# UPDATE `posts` SET title='New real title', author_id=1 WHERE id=1

删除

删除记录不会 销毁 对象。这意味着它将调用 SQL 删除数据库中的记录，但您仍然可以使用该对象。

$post = Post::find(1);
$post->delete();
# DELETE FROM `posts` WHERE id=1
echo $post->title; # 'New real title'

软删除

这是一种逻辑删除功能。在表中添加一个取值为“0”或“1”的列，并将其列名设置为静态类变量。

find、update、delete 方法将提取 active 为“1”的数据。

update_all、delete_all 将忽略 active 列。

class OUModel extends ActiveRecord\Model {
	public static $soft_delete_key = 'active';
}