首页
/ Simple ORM 技术文档

Simple ORM 技术文档

2024-12-25 00:44:59作者:史锋燃Gardner

1. 安装指南

环境要求

  • PHP 5.3 或更高版本
  • MySQL 数据库

安装步骤

  1. 下载 SimpleOrm.class.php 文件。
  2. 将文件放置在你的项目目录中。
  3. 确保你的项目中已经配置好 MySQL 数据库连接。

2. 项目的使用说明

配置

在使用 Simple ORM 之前,需要进行以下配置:

  1. 包含 SimpleOrm.class.php 文件。
  2. 创建一个 mysqli 对象。
  3. 告诉 SimpleOrm 使用你创建的 mysqli 连接。

示例代码:

// 包含 Simple ORM 类
include 'SimpleOrm.class.php';

// 连接到数据库
$conn = new mysqli('host', 'user', 'password');

if ($conn->connect_error)
  die(sprintf('无法连接到数据库。 %s', $conn->connect_error));

// 告诉 Simple ORM 使用你创建的连接
SimpleOrm::useConnection($conn, 'database');

对象/表定义

定义一个与数据库表相关联的对象:

class Blog extends SimpleOrm { }

基本用法

  • 创建记录

    $entry = new Blog;
    $entry->title = 'Hello';
    $entry->body = 'World!';
    $entry->save();
    
  • 通过主键检索记录

    $entry = Blog::retrieveByPK(1);
    
  • 通过列名检索记录

    $entry = Blog::retrieveByTitle('Hello', SimpleOrm::FETCH_ONE);
    
  • 更新记录

    $entry->body = 'Mars!';
    $entry->save();
    
  • 删除记录

    $entry->delete();
    

3. 项目API使用文档

类配置

基本对象

class Foo extends SimpleOrm {}

类命名

  • 数据库:使用 mysqli 对象中加载的数据库。
  • 表名:类名的小写形式。
  • 主键:默认为 id

自定义

可以通过以下静态属性自定义:

  • database
  • table
  • pk

示例:

class Foo extends SimpleOrm
{
    protected static
      $database = 'test',
      $table = 'foobar',
      $pk = 'fooid';
}

数据操作

创建/插入新记录

$foo = new Foo;
$foo->title = 'hi!';
$foo->save();

$foo = new Foo(array('title'=>'hi!'));
$foo->save();

更新记录

$foo->title = 'hi!';
$foo->save();

删除记录

$foo->delete();

数据检索

使用主键

$foo = Foo::retrieveByPK(1);

$foo = new Foo(1);

使用列名

$foo = Foo::retrieveByField('bar', SimpleOrm::FETCH_ONE);

检索所有记录

$foo = Foo::all();

过滤器

输入过滤器

class Foo extends SimpleOrm
{
    protected function filterIn_dates ($data)
    {
        $data['updated_at'] = time();
        return $data;
    }
}

输出过滤器

class Foo extends SimpleOrm
{
    protected function filterOut ()
    {
        $this->foo = unserialize($this->foo);
    }
}

4. 项目安装方式

  1. 下载 SimpleOrm.class.php 文件。
  2. 将文件放置在你的项目目录中。
  3. 确保你的项目中已经配置好 MySQL 数据库连接。

通过以上步骤,你就可以在你的项目中使用 Simple ORM 了。

登录后查看全文
热门项目推荐