Cycle ORM 使用教程

Cycle ORM 使用教程

ormPHP DataMapper, ORM项目地址:https://gitcode.com/gh_mirrors/orm1/orm

1. 项目介绍

Cycle ORM 是一个用于 PHP 的对象关系映射（ORM）库，旨在简化数据库操作，使开发者能够以面向对象的方式与数据库进行交互。Cycle ORM 提供了强大的查询构建器、事务管理、数据映射等功能，适用于各种规模的项目。

2. 项目快速启动

安装

首先，通过 Composer 安装 Cycle ORM：

composer require cycle/orm

配置

创建一个简单的配置文件 config/database.php：

use Cycle\Database\Config\DatabaseConfig;
use Cycle\Database\Config\SQLiteDriverConfig;

return [
    'default' => 'default',
    'databases' => [
        'default' => ['connection' => 'sqlite']
    ],
    'connections' => [
        'sqlite' => new SQLiteDriverConfig(
            connection: new SQLiteDriverConfig\MemoryConnection()
        )
    ]
];

初始化 ORM

在应用入口文件中初始化 ORM：

use Cycle\ORM\ORM;
use Cycle\ORM\Schema;
use Cycle\Database\DatabaseManager;
use Cycle\ORM\Factory;

$dbal = new DatabaseManager(require 'config/database.php');
$factory = new Factory($dbal);
$orm = new ORM($factory, new Schema([]));

定义实体

创建一个简单的实体类 User.php：

namespace App\Entity;

use Cycle\Annotated\Annotation as ORM;

/**
 * @ORM\Entity(table: "users")
 */
class User
{
    /**
     * @ORM\Column(type: "primary")
     */
    protected $id;

    /**
     * @ORM\Column(type: "string")
     */
    protected $name;

    public function getId(): ?int
    {
        return $this->id;
    }

    public function getName(): string
    {
        return $this->name;
    }

    public function setName(string $name): void
    {
        $this->name = $name;
    }
}

使用 ORM

在控制器或服务中使用 ORM 进行数据库操作：

use Cycle\ORM\EntityManager;
use App\Entity\User;

$user = new User();
$user->setName('John Doe');

$em = new EntityManager($orm);
$em->persist($user)->run();

$users = $orm->getRepository(User::class)->findAll();
foreach ($users as $user) {
    echo $user->getName();
}

3. 应用案例和最佳实践

应用案例

Cycle ORM 适用于各种 PHP 项目，尤其是那些需要高效数据库操作和复杂查询的应用。例如：

• Web 应用：用于管理用户、内容和权限。
• API 服务：用于处理数据存储和检索。
• 命令行工具：用于批量数据处理和迁移。

最佳实践

• 使用事务：在复杂操作中使用事务以确保数据一致性。
• 缓存：利用缓存机制减少数据库查询次数。
• 分页：在查询大量数据时使用分页功能。

4. 典型生态项目

Cycle ORM 可以与以下生态项目结合使用，以增强功能和性能：

• Cycle Database：提供数据库连接和查询构建器。
• Cycle Schema：用于定义和管理数据库模式。
• Cycle Annotated：通过注解简化实体定义。
• Cycle Migrations：用于数据库迁移和版本控制。

通过这些生态项目的结合，Cycle ORM 可以提供更完整的数据库解决方案，满足各种复杂应用的需求。

ormPHP DataMapper, ORM项目地址:https://gitcode.com/gh_mirrors/orm1/orm