README

Corma是一个基于Doctrine DBAL的高性能、基于约定的ORM。

Corma之所以优秀，是因为

• 没有复杂且难以验证的注解或配置文件
• 促进代码组织的一致性
• 加载和保存一对一、一对多、多对多和多态关系
• 可以单个查询中保存多个对象（使用upsert）
• 易于缓存并避免数据库查询
• 支持软删除
• 在单元工作中轻松处理事务
• 高度可定制

Corma不

• 默认自动加载或懒加载关系
• 进行迁移或代码生成

在MySQL和PostgreSQL上运行。

通过Composer安装

通过命令行

composer.phar require thewunder/corma ^5.0

或将以下内容添加到composer.json中的require部分

"thewunder/corma": "^5.0"

对于PHP版本< 8.1，请使用Corma版本~3.0

基本用法

创建一个DataObject

namespace YourNamespace\Dataobjects;

use Corma\Relationship\ManyToMany;
use Corma\Relationship\OneToMany;
use Corma\Relationship\OneToOne;

class YourDataObject {
    protected $id;

    //If the property name == column name on the table your_data_objects it will be saved
    protected $myColumn;

    protected ?int $otherObjectId = null;
    
    #[OneToOne]
    protected ?OtherObject $otherObject = null;
    
    #[OneToMany(AnotherObject::class)]
    protected ?array $anotherObjects = null;
    
    #[ManyToMany(DifferentObject::class, 'your_data_object_different_link_table')]
    protected ?array $differentObjects = null;
    //Getters and setters..
}

以及一个Repository（可选）

namespace YourNamespace\Dataobjects\Repository;

class YourDataObjectRepository extends ObjectRepository {
    //Override default behavior and add custom methods...
}

创建orm并使用它

$db = DriverManager::getConnection(...); //see Doctrine DBAL docs
$orm = ObjectMapper::withDefaults($db, $container); //uses any PSR-11 compatible DI container

$object = $orm->create(YourDataObject::class);
//Call setters...
$orm->save($object);
//Call more setters...
$orm->save($object);

//Call more setters on $object...
$objects = [$object];
$newObject = $orm->create(YourDataObject::class);
//call setters on $newObject...
$objects[] = $newObject;

$orm->saveAll($objects);

//find existing object by id
$existingObject = $orm->find(YourDataObject::class, 5);

//find existing objects with myColumn >= 42 AND otherColumn = 1
$existingObjects = $orm->findBy(YourDataObject::class, ['myColumn >='=>42, 'otherColumn'=>1], ['sortColumn'=>'ASC']);

//load relationships
$orm->load($existingObjects, 'otherObject');
$orm->load($existingObjects, 'anotherObjects');
$orm->load($existingObjects, 'differentObjects');

//delete those
$orm->deleteAll($existingObjects);

文档

有关完整文档，请参阅Wiki。

贡献

有关详细信息，请参阅CONTRIBUTING。