首页
/ 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 了。

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

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
143
1.92 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
929
553
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
422
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
65
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8