tocgis / php-activerecord
tocgis项目中的php-activerecord是一个基于ActiveRecord模式的开源ORM库。
Requires
- php: >=5.3.0
This package is auto-updated.
Last update: 2024-09-09 07:55:22 UTC
README
由
- @kla - Kien La
- @jpfuentes2 - Jacques Fuentes
- 以及这些出色的贡献者
http://www.phpactiverecord.org/
简介
ActiveRecord的简要概述
ActiveRecord是一种访问数据库数据的方法。数据库表或视图被封装到一个类中,因此对象实例与表中的一行绑定。创建对象后,在保存时会在表中添加新行。任何加载的对象都从数据库中获取其信息;当对象更新时,表中的相应行也会更新。封装类为表或视图中的每一列实现访问器方法或属性。
更多详情请见这里。
此实现受到了Ruby on Rails的ActiveRecord的启发,因此大量借鉴了其模式。我们在保持其约定的同时,主要由于便利性或必要性而有所偏离。当然,对于熟悉Rails的用户来说,会有一些明显的差异。
最低要求
- PHP 5.3+
- 对应数据库的PDO驱动
支持的数据库
- MySQL
- SQLite
- PostgreSQL
- Oracle
功能
- 查找方法
- 动态查找方法
- 写入方法
- 关系
- 验证
- 回调
- 序列化(json/xml)
- 事务
- 支持多个适配器
- 一些其他选项,如:别名/受保护/可访问属性
安装
设置非常简单直接。实际上只有三个配置点需要你关注
- 设置模型自动加载目录。
- 配置数据库连接。
- 设置用于您环境的数据库连接。
示例
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'