adnow-vn/php-activerecord

php-activerecord 是一个基于 ActiveRecord 模式的开源 ORM 库。

v1.2.3 2021-08-27 07:11 UTC

This package is not auto-updated.

Last update: 2024-09-20 22:09:23 UTC


README

Build Status

http://www.phpactiverecord.org/

介绍

ActiveRecord 的简要概述

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

更多详细信息请参阅 此处

此实现受到了 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'

贡献

请参阅 CONTRIBUTING.md 了解如何为 PHP ActiveRecord 做贡献。