首页
/ Simple ORM 技术文档

Simple ORM 技术文档

2024-12-25 09:34:22作者:史锋燃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 了。

热门项目推荐
相关项目推荐

项目优选

收起
Python-100-DaysPython-100-Days
Python - 100天从新手到大师
Python
679
124
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
13
32
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
60
48
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
213
62
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
292
83
inferenceinference
通过更改一行代码,您可以在应用程序中用另一个大型语言模型(LLM)替换OpenAI GPT。Xinference赋予您使用任何所需LLM的自由。借助Xinference,您能够在云端、本地、甚至笔记本电脑上运行任何开源语言模型、语音识别模型和多模态模型的推理。
Python
8
0
arkanalyzerarkanalyzer
方舟分析器:面向ArkTS语言的静态程序分析框架
TypeScript
8
11
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
429
38
RuoYi-Cloud-Vue3RuoYi-Cloud-Vue3
🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
47
31
open-eBackupopen-eBackup
open-eBackup是一款开源备份软件,采用集群高扩展架构,通过应用备份通用框架、并行备份等技术,为主流数据库、虚拟化、文件系统、大数据等应用提供E2E的数据备份、恢复等能力,帮助用户实现关键数据高效保护。
HTML
90
64