实体 ¶
Testing Is Documentation
实体是整个系统最为核心的基本单位,实体封装了一些常用的功能。
Uses
php
<?php
use Leevel\Database\Condition;
use Leevel\Di\Container;
use Tests\Database\DatabaseTestCase as TestCase;
use Tests\Database\Ddd\Entity\CompositeId;
use Tests\Database\Ddd\Entity\DemoVersion;
use Tests\Database\Ddd\Entity\EntityWithEnum;
use Tests\Database\Ddd\Entity\EntityWithoutAnyField;
use Tests\Database\Ddd\Entity\EntityWithoutPrimaryKey;
use Tests\Database\Ddd\Entity\EntityWithoutPrimaryKeyNullInArray;
use Tests\Database\Ddd\Entity\Relation\Post;
use Tests\Database\Ddd\Entity\Relation\PostForReplace;
use Tests\Database\Ddd\Entity\StatusEnum;
use Tests\Database\Ddd\Entity\WithoutPrimarykey;
use Tests\Database\Ddd\Entity\WithoutPrimarykeyAndAllAreKey;
withProps 批量设置属性数据 ¶
php
public function testWithProps(): void
{
$entity = new Post();
$entity->withProps([
'title' => 'foo',
'summary' => 'bar',
]);
static::assertSame('foo', $entity->title);
static::assertSame('bar', $entity->summary);
static::assertSame(['title', 'summary'], $entity->changed());
}
description 获取枚举值对应的描述 ¶
fixture 定义
Tests\Database\Ddd\Entity\EntityWithEnum
php
namespace Tests\Database\Ddd\Entity;
use Leevel\Database\Ddd\Entity;
use Leevel\Database\Ddd\Struct;
class EntityWithEnum extends Entity
{
public const TABLE = 'entity_with_enum';
public const ID = 'id';
public const AUTO = 'id';
#[Struct([
self::READONLY => true,
])]
protected ?int $id = null;
#[Struct([
])]
protected ?string $title = null;
#[Struct([
self::ENUM_CLASS => StatusEnum::class,
])]
protected ?string $status = null;
}
php
public function testEntityWithEnumDescription(): void
{
$this->initI18n();
$entity = new EntityWithEnum([
'title' => 'foo',
'status' => '1',
]);
static::assertSame('foo', $entity->title);
static::assertSame('1', $entity->status);
$data = <<<'eot'
{
"title": "foo"
}
eot;
static::assertSame(
$data,
$this->varJson(
$entity
->only(['title'])
->toArray()
)
);
$data = <<<'eot'
{
"title": "foo",
"status": "1",
"status_enum": "启用"
}
eot;
static::assertSame(
$data,
$this->varJson(
$entity->toArray(),
2
)
);
static::assertSame('启用', StatusEnum::description('1'));
static::assertSame('禁用', StatusEnum::description('0'));
$data = <<<'eot'
{
"value": {
"DISABLE": 0,
"ENABLE": 1
},
"description": {
"DISABLE": "禁用",
"ENABLE": "启用"
}
}
eot;
static::assertSame(
$data,
$this->varJson(
StatusEnum::descriptions(),
3
)
);
}
hasChanged 检测属性是否已经改变 ¶
php
public function testHasChanged(): void
{
$entity = new Post();
static::assertFalse($entity->hasChanged('title'));
$entity->title = 'change';
static::assertTrue($entity->hasChanged('title'));
}
addChanged 添加指定属性为已改变 ¶
php
public function testAddChanged(): void
{
$entity = new Post();
$data = <<<'eot'
[]
eot;
static::assertSame(
$data,
$this->varJson(
$entity->changed()
)
);
$entity->addChanged(['user_id', 'title']);
$data = <<<'eot'
[
"user_id",
"title"
]
eot;
static::assertSame(
$data,
$this->varJson(
$entity->changed(),
1
)
);
}
deleteChanged 删除已改变属性 ¶
php
public function testDeleteChanged(): void
{
$entity = new Post();
$data = <<<'eot'
[]
eot;
static::assertSame(
$data,
$this->varJson(
$entity->changed()
)
);
$entity->addChanged(['user_id', 'title']);
$data = <<<'eot'
[
"user_id",
"title"
]
eot;
static::assertSame(
$data,
$this->varJson(
$entity->changed(),
1,
)
);
$entity->deleteChanged(['user_id']);
$data = <<<'eot'
[
"title"
]
eot;
static::assertSame(
$data,
$this->varJson(
$entity->changed(),
2,
)
);
}
clearChanged 清空已改变属性 ¶
php
public function testClearChanged(): void
{
$entity = new Post();
$data = <<<'eot'
[]
eot;
static::assertSame(
$data,
$this->varJson(
$entity->changed()
)
);
$entity->addChanged(['user_id', 'title']);
$data = <<<'eot'
[
"user_id",
"title"
]
eot;
static::assertSame(
$data,
$this->varJson(
$entity->changed(),
1,
)
);
$entity->clearChanged(['user_id']);
$data = <<<'eot'
[]
eot;
static::assertSame(
$data,
$this->varJson(
$entity->changed(),
2,
)
);
}
idCondition 获取查询主键条件 ¶
php
public function testIdCondition(): void
{
$entity = new Post(['id' => 5]);
static::assertSame(['id' => 5], $entity->idCondition());
}
实体属性数组访问 ArrayAccess.offsetExists 支持 ¶
php
public function testArrayAccessOffsetExists(): void
{
$entity = new Post(['id' => 5, 'title' => 'hello']);
static::assertTrue(isset($entity['title']));
static::assertFalse(isset($entity['user_id']));
}
实体属性数组访问 ArrayAccess.offsetSet 支持 ¶
php
public function testArrayAccessOffsetSet(): void
{
$entity = new Post(['id' => 5]);
static::assertFalse(isset($entity['title']));
static::assertNull($entity->title);
$entity['title'] = 'world';
static::assertTrue(isset($entity['title']));
static::assertSame('world', $entity->title);
}
实体属性数组访问 ArrayAccess.offsetGet 支持 ¶
php
public function testArrayAccessOffsetGet(): void
{
$entity = new Post(['id' => 5]);
static::assertNull($entity['title']);
$entity['title'] = 'world';
static::assertSame('world', $entity['title']);
}
实体属性数组访问 ArrayAccess.offsetUnset 支持 ¶
php
public function testArrayAccessOffsetUnset(): void
{
$entity = new Post(['id' => 5]);
static::assertNull($entity['title']);
$entity['title'] = 'world';
static::assertSame('world', $entity['title']);
unset($entity['title']);
static::assertNull($entity['title']);
}
实体属性访问魔术方法 __isset 支持 ¶
php
public function testMagicIsset(): void
{
$entity = new Post(['id' => 5, 'title' => 'hello']);
static::assertTrue(isset($entity->title));
static::assertFalse(isset($entity->userId));
}
实体属性访问魔术方法 __set 支持 ¶
php
public function testMagicSet(): void
{
$entity = new Post(['id' => 5]);
static::assertFalse(isset($entity->title));
static::assertNull($entity->title);
$entity->title = 'world';
static::assertTrue(isset($entity->title));
static::assertSame('world', $entity->title);
}
实体属性访问魔术方法 __get 支持 ¶
php
public function testMagicGet(): void
{
$entity = new Post(['id' => 5]);
static::assertNull($entity->title);
$entity->title = 'world';
static::assertSame('world', $entity->title);
}
实体属性访问魔术方法 __unset 支持 ¶
php
public function testMagicUnset(): void
{
$entity = new Post(['id' => 5]);
static::assertNull($entity->title);
$entity->title = 'world';
static::assertSame('world', $entity->title);
$entity->title = null;
static::assertNull($entity->title);
}
setter 设置属性值 ¶
php
public function testCallSetter(): void
{
$entity = new Post(['id' => 5]);
static::assertNull($entity->title);
static::assertNull($entity->userId);
$entity->setTitle('hello');
$entity->setUserId(5);
static::assertSame('hello', $entity->title);
static::assertSame(5, $entity->userId);
}
getter 获取属性值 ¶
php
public function testCallGetter(): void
{
$entity = new Post(['id' => 5]);
static::assertNull($entity->getTitle());
static::assertNull($entity->getUserId());
$entity->setTitle('hello');
$entity->setUserId(5);
static::assertSame('hello', $entity->getTitle());
static::assertSame(5, $entity->getUserId());
}
find 获取实体查询对象 ¶
php
public function testStaticFind(): void
{
$connect = $this->createDatabaseConnect();
static::assertSame(
1,
$connect
->table('post')
->insert([
'title' => 'hello world',
'user_id' => 1,
'summary' => 'post summary',
'delete_at' => 0,
])
);
$post = Post::find()->where('id', 1)->findOne();
static::assertSame('hello world', $post->title);
static::assertSame(1, $post->userId);
static::assertSame('post summary', $post->summary);
}
connectSandbox 数据库连接沙盒 ¶
php
public function testConnectSandbox(): void
{
$connect = $this->createDatabaseConnect();
static::assertSame(
1,
$connect
->table('post')
->insert([
'title' => 'hello world',
'user_id' => 1,
'summary' => 'post summary',
'delete_at' => 0,
])
);
$post = Post::connectSandbox('password_right', function () {
return Post::find()->where('id', 1)->findOne();
});
static::assertSame('hello world', $post->title);
static::assertSame(1, $post->userId);
static::assertSame('post summary', $post->summary);
}
newed 确定对象是否对应数据库中的一条记录 ¶
php
public function testNewed(): void
{
$entity = new Post();
static::assertTrue($entity->newed());
$entity = new Post(['id' => 5]);
static::assertTrue($entity->newed());
$entity = new Post(['id' => 5], true);
static::assertFalse($entity->newed());
}
withNewed 设置确定对象是否对应数据库中的一条记录 ¶
php
public function testWithNewed(): void
{
$entity = new Post();
static::assertTrue($entity->newed());
$entity->withNewed(false);
static::assertFalse($entity->newed());
$entity = new Post(['id' => 5]);
static::assertTrue($entity->newed());
$entity->withNewed(false);
static::assertFalse($entity->newed());
$entity = new Post(['id' => 5], true);
static::assertFalse($entity->newed());
$entity->withNewed(true);
static::assertTrue($entity->newed());
}
original 获取原始数据 ¶
php
public function testOriginal(): void
{
$entity = new Post();
static::assertSame([], $entity->original());
$entity = new Post($data = [
'title' => 'hello',
'summary' => 'world',
'foo' => 'bar',
], false, true);
static::assertSame($data, $entity->original());
static::assertSame('hello', $entity->title);
static::assertSame('world', $entity->summary);
}
id 获取主键值 ¶
php
public function testId(): void
{
$entity = new Post();
static::assertFalse($entity->id());
$entity = new Post(['id' => 5]);
static::assertSame(['id' => 5], $entity->id());
}
id 获取复合主键值 ¶
fixture 定义
Tests\Database\Ddd\Entity\CompositeId
php
namespace Tests\Database\Ddd\Entity;
use Leevel\Database\Ddd\Entity;
use Leevel\Database\Ddd\Struct;
class CompositeId extends Entity
{
public const TABLE = 'composite_id';
public const ID = ['id1', 'id2'];
public const AUTO = null;
#[Struct([
])]
protected ?int $id1 = null;
#[Struct([
])]
protected ?int $id2 = null;
#[Struct([
])]
protected ?string $name = null;
}
php
public function testCompositeId(): void
{
$entity = new CompositeId();
static::assertFalse($entity->id(false));
static::assertFalse($entity->id());
$entity = new CompositeId(['id1' => 5]);
static::assertFalse($entity->id(false));
static::assertFalse($entity->id());
$entity = new CompositeId(['id1' => 5, 'id2' => 8]);
static::assertSame(['id1' => 5, 'id2' => 8], $entity->id(false));
static::assertSame(['id1' => 5, 'id2' => 8], $entity->id());
}
refresh 从数据库重新读取当前对象的属性 ¶
php
public function testRefresh(): void
{
$post1 = new Post();
$post1->create()->flush();
$this->assertInstanceof(Post::class, $post1);
static::assertSame(1, $post1->id);
static::assertNull($post1->userId);
static::assertNull($post1->title);
static::assertNull($post1->summary);
static::assertNull($post1->delete_at);
$post1->refresh();
static::assertSame(1, $post1->id);
static::assertSame(0, $post1->userId);
static::assertSame('', $post1->title);
static::assertSame('', $post1->summary);
static::assertSame(0, $post1->delete_at);
}
refresh 从数据库重新读取当前对象的属性支持复合主键 ¶
php
public function testRefreshWithCompositeId(): void
{
$entity = new CompositeId(['id1' => 1, 'id2' => 3]);
$entity->create()->flush();
$this->assertInstanceof(CompositeId::class, $entity);
static::assertSame(1, $entity->id1);
static::assertSame(3, $entity->id2);
static::assertNull($entity->name);
$entity->refresh();
static::assertSame(1, $entity->id1);
static::assertSame(3, $entity->id2);
static::assertSame('', $entity->name);
}
构造器支持忽略未定义属性 ¶
$ignoreUndefinedProp
用于数据库添加了字段,但是我们的实体并没有更新字段,查询得到的实体对象将会忽略掉新增的字段而不报错。
php
public function testIgnoreUndefinedProp(): void
{
$entity = new Post(['undefined_prop' => 5], true, true);
static::assertSame([], $entity->toArray());
}
update 更新数据带上版本号 ¶
可以用于并发控制,例如商品库存,客户余额等。
fixture 定义
Tests\Database\Ddd\Entity\DemoVersion
php
namespace Tests\Database\Ddd\Entity;
use Leevel\Database\Ddd\Entity;
use Leevel\Database\Ddd\Struct;
class DemoVersion extends Entity
{
public const TABLE = 'test_version';
public const ID = 'id';
public const AUTO = 'id';
public const VERSION = 'version';
#[Struct([
self::READONLY => true,
])]
protected ?int $id = null;
#[Struct([
])]
protected ?string $name = null;
#[Struct([
])]
protected ?string $availableNumber = null;
#[Struct([
])]
protected ?string $realNumber = null;
#[Struct([
])]
protected ?int $version = null;
protected bool $enabledVersionFramework = true;
}
php
public function testUpdateWithVersion(): void
{
$connect = $this->createDatabaseConnect();
static::assertSame(
1,
$connect
->table('test_version')
->insert([
'name' => 'xiaoniuge',
])
);
$testVersion = DemoVersion::select()->findEntity(1);
$this->assertInstanceof(DemoVersion::class, $testVersion);
static::assertSame(1, $testVersion->id);
static::assertSame('xiaoniuge', $testVersion->name);
static::assertSame('0.0000', $testVersion->availableNumber);
static::assertSame('0.0000', $testVersion->realNumber);
$condition = [
'available_number' => $testVersion->availableNumber,
'real_number' => $testVersion->realNumber,
];
$testVersion->name = 'aniu';
$testVersion->availableNumber = Condition::raw('[available_number]+1');
$testVersion->realNumber = Condition::raw('[real_number]+3');
static::assertSame(
1,
$testVersion
->condition($condition)
->update()
->flush()
);
static::assertSame('SQL: [499] UPDATE `test_version` SET `test_version`.`name` = :pdonamedparameter_name,`test_version`.`available_number` = `test_version`.`available_number`+1,`test_version`.`real_number` = `test_version`.`real_number`+3,`test_version`.`version` = `test_version`.`version`+1 WHERE `test_version`.`available_number` = :test_version_available_number AND `test_version`.`real_number` = :test_version_real_number AND `test_version`.`id` = :test_version_id AND `test_version`.`version` = :test_version_version LIMIT 1 | Params: 5 | Key: Name: [23] :pdonamedparameter_name | paramno=0 | name=[23] ":pdonamedparameter_name" | is_param=1 | param_type=2 | Key: Name: [30] :test_version_available_number | paramno=1 | name=[30] ":test_version_available_number" | is_param=1 | param_type=2 | Key: Name: [25] :test_version_real_number | paramno=2 | name=[25] ":test_version_real_number" | is_param=1 | param_type=2 | Key: Name: [16] :test_version_id | paramno=3 | name=[16] ":test_version_id" | is_param=1 | param_type=1 | Key: Name: [21] :test_version_version | paramno=4 | name=[21] ":test_version_version" | is_param=1 | param_type=1 (UPDATE `test_version` SET `test_version`.`name` = \'aniu\',`test_version`.`available_number` = `test_version`.`available_number`+1,`test_version`.`real_number` = `test_version`.`real_number`+3,`test_version`.`version` = `test_version`.`version`+1 WHERE `test_version`.`available_number` = \'0.0000\' AND `test_version`.`real_number` = \'0.0000\' AND `test_version`.`id` = 1 AND `test_version`.`version` = 0 LIMIT 1)', $testVersion->select()->getLastSql());
$testVersion->name = 'hello';
static::assertSame(1, $testVersion->update()->flush());
static::assertSame('SQL: [233] UPDATE `test_version` SET `test_version`.`version` = `test_version`.`version`+1,`test_version`.`name` = :pdonamedparameter_name WHERE `test_version`.`id` = :test_version_id AND `test_version`.`version` = :test_version_version LIMIT 1 | Params: 3 | Key: Name: [23] :pdonamedparameter_name | paramno=0 | name=[23] ":pdonamedparameter_name" | is_param=1 | param_type=2 | Key: Name: [16] :test_version_id | paramno=1 | name=[16] ":test_version_id" | is_param=1 | param_type=1 | Key: Name: [21] :test_version_version | paramno=2 | name=[21] ":test_version_version" | is_param=1 | param_type=1 (UPDATE `test_version` SET `test_version`.`version` = `test_version`.`version`+1,`test_version`.`name` = \'hello\' WHERE `test_version`.`id` = 1 AND `test_version`.`version` = 1 LIMIT 1)', $testVersion->select()->getLastSql());
}
update 更新数据不含版本数据则不会带上版本号 ¶
version 对应的字段无数据,将会忽略版本号。
php
public function testUpdateNoVersionDataWithoutVersion(): void
{
$connect = $this->createDatabaseConnect();
static::assertSame(
1,
$connect
->table('test_version')
->insert([
'name' => 'xiaoniuge',
])
);
$testVersion = DemoVersion::select()
->findEntity(1, ['id,name,available_number,real_number'])
;
$this->assertInstanceof(DemoVersion::class, $testVersion);
static::assertSame(1, $testVersion->id);
static::assertNull($testVersion->version);
static::assertSame('xiaoniuge', $testVersion->name);
static::assertSame('0.0000', $testVersion->availableNumber);
static::assertSame('0.0000', $testVersion->realNumber);
$condition = [
'available_number' => $testVersion->availableNumber,
'real_number' => $testVersion->realNumber,
];
$testVersion->name = 'aniu';
$testVersion->availableNumber = Condition::raw('[available_number]+1');
$testVersion->realNumber = Condition::raw('[real_number]+3');
static::assertSame(
1,
$testVersion
->condition($condition)
->update()
->flush()
);
static::assertSame('SQL: [392] UPDATE `test_version` SET `test_version`.`name` = :pdonamedparameter_name,`test_version`.`available_number` = `test_version`.`available_number`+1,`test_version`.`real_number` = `test_version`.`real_number`+3 WHERE `test_version`.`available_number` = :test_version_available_number AND `test_version`.`real_number` = :test_version_real_number AND `test_version`.`id` = :test_version_id LIMIT 1 | Params: 4 | Key: Name: [23] :pdonamedparameter_name | paramno=0 | name=[23] ":pdonamedparameter_name" | is_param=1 | param_type=2 | Key: Name: [30] :test_version_available_number | paramno=1 | name=[30] ":test_version_available_number" | is_param=1 | param_type=2 | Key: Name: [25] :test_version_real_number | paramno=2 | name=[25] ":test_version_real_number" | is_param=1 | param_type=2 | Key: Name: [16] :test_version_id | paramno=3 | name=[16] ":test_version_id" | is_param=1 | param_type=1 (UPDATE `test_version` SET `test_version`.`name` = \'aniu\',`test_version`.`available_number` = `test_version`.`available_number`+1,`test_version`.`real_number` = `test_version`.`real_number`+3 WHERE `test_version`.`available_number` = \'0.0000\' AND `test_version`.`real_number` = \'0.0000\' AND `test_version`.`id` = 1 LIMIT 1)', $testVersion->select()->getLastSql());
$testVersion->name = 'hello';
static::assertSame(1, $testVersion->update()->flush());
static::assertSame('SQL: [126] UPDATE `test_version` SET `test_version`.`name` = :pdonamedparameter_name WHERE `test_version`.`id` = :test_version_id LIMIT 1 | Params: 2 | Key: Name: [23] :pdonamedparameter_name | paramno=0 | name=[23] ":pdonamedparameter_name" | is_param=1 | param_type=2 | Key: Name: [16] :test_version_id | paramno=1 | name=[16] ":test_version_id" | is_param=1 | param_type=1 (UPDATE `test_version` SET `test_version`.`name` = \'hello\' WHERE `test_version`.`id` = 1 LIMIT 1)', $testVersion->select()->getLastSql());
}
version.condition 设置是否启用乐观锁版本字段配合设置扩展查询条件 ¶
php
public function testUpdateWithVersionAndWithCondition(): void
{
$connect = $this->createDatabaseConnect();
static::assertSame(
1,
$connect
->table('test_version')
->insert([
'name' => 'xiaoniuge',
])
);
$testVersion = DemoVersion::select()->findEntity(1);
$this->assertInstanceof(DemoVersion::class, $testVersion);
static::assertSame(1, $testVersion->id);
static::assertSame('xiaoniuge', $testVersion->name);
static::assertSame('0.0000', $testVersion->availableNumber);
static::assertSame('0.0000', $testVersion->realNumber);
$testVersion->name = 'aniu';
$testVersion->availableNumber = Condition::raw('[available_number]+1');
$testVersion->realNumber = Condition::raw('[real_number]+3');
static::assertSame(1, $testVersion->version(true)->update()->flush());
static::assertSame('SQL: [367] UPDATE `test_version` SET `test_version`.`name` = :pdonamedparameter_name,`test_version`.`available_number` = `test_version`.`available_number`+1,`test_version`.`real_number` = `test_version`.`real_number`+3,`test_version`.`version` = `test_version`.`version`+1 WHERE `test_version`.`id` = :test_version_id AND `test_version`.`version` = :test_version_version LIMIT 1 | Params: 3 | Key: Name: [23] :pdonamedparameter_name | paramno=0 | name=[23] ":pdonamedparameter_name" | is_param=1 | param_type=2 | Key: Name: [16] :test_version_id | paramno=1 | name=[16] ":test_version_id" | is_param=1 | param_type=1 | Key: Name: [21] :test_version_version | paramno=2 | name=[21] ":test_version_version" | is_param=1 | param_type=1 (UPDATE `test_version` SET `test_version`.`name` = \'aniu\',`test_version`.`available_number` = `test_version`.`available_number`+1,`test_version`.`real_number` = `test_version`.`real_number`+3,`test_version`.`version` = `test_version`.`version`+1 WHERE `test_version`.`id` = 1 AND `test_version`.`version` = 0 LIMIT 1)', $testVersion->select()->getLastSql());
$testVersion->refresh();
$condition = ['available_number' => $testVersion->availableNumber];
$testVersion->name = 'hello';
$testVersion->availableNumber = Condition::raw('[available_number]+8');
static::assertSame(1, $testVersion->condition($condition)->update()->flush());
static::assertSame('SQL: [376] UPDATE `test_version` SET `test_version`.`version` = `test_version`.`version`+1,`test_version`.`name` = :pdonamedparameter_name,`test_version`.`available_number` = `test_version`.`available_number`+8 WHERE `test_version`.`available_number` = :test_version_available_number AND `test_version`.`id` = :test_version_id AND `test_version`.`version` = :test_version_version LIMIT 1 | Params: 4 | Key: Name: [23] :pdonamedparameter_name | paramno=0 | name=[23] ":pdonamedparameter_name" | is_param=1 | param_type=2 | Key: Name: [30] :test_version_available_number | paramno=1 | name=[30] ":test_version_available_number" | is_param=1 | param_type=2 | Key: Name: [16] :test_version_id | paramno=2 | name=[16] ":test_version_id" | is_param=1 | param_type=1 | Key: Name: [21] :test_version_version | paramno=3 | name=[21] ":test_version_version" | is_param=1 | param_type=1 (UPDATE `test_version` SET `test_version`.`version` = `test_version`.`version`+1,`test_version`.`name` = \'hello\',`test_version`.`available_number` = `test_version`.`available_number`+8 WHERE `test_version`.`available_number` = \'1.0000\' AND `test_version`.`id` = 1 AND `test_version`.`version` = 1 LIMIT 1)', $testVersion->select()->getLastSql());
}
version 设置是否启用乐观锁版本字段支持取消 ¶
php
public function testUpdateWithVersionAndWithoutVersionCondition(): void
{
$connect = $this->createDatabaseConnect();
static::assertSame(
1,
$connect
->table('test_version')
->insert([
'name' => 'xiaoniuge',
])
);
$testVersion = DemoVersion::select()->findEntity(1);
$this->assertInstanceof(DemoVersion::class, $testVersion);
static::assertSame(1, $testVersion->id);
static::assertSame('xiaoniuge', $testVersion->name);
static::assertSame('0.0000', $testVersion->availableNumber);
static::assertSame('0.0000', $testVersion->realNumber);
$testVersion->name = 'aniu';
$testVersion->availableNumber = Condition::raw('[available_number]+1');
$testVersion->realNumber = Condition::raw('[real_number]+3');
static::assertSame(1, $testVersion->version(false)->update()->flush());
static::assertSame('SQL: [260] UPDATE `test_version` SET `test_version`.`name` = :pdonamedparameter_name,`test_version`.`available_number` = `test_version`.`available_number`+1,`test_version`.`real_number` = `test_version`.`real_number`+3 WHERE `test_version`.`id` = :test_version_id LIMIT 1 | Params: 2 | Key: Name: [23] :pdonamedparameter_name | paramno=0 | name=[23] ":pdonamedparameter_name" | is_param=1 | param_type=2 | Key: Name: [16] :test_version_id | paramno=1 | name=[16] ":test_version_id" | is_param=1 | param_type=1 (UPDATE `test_version` SET `test_version`.`name` = \'aniu\',`test_version`.`available_number` = `test_version`.`available_number`+1,`test_version`.`real_number` = `test_version`.`real_number`+3 WHERE `test_version`.`id` = 1 LIMIT 1)', $testVersion->select()->getLastSql());
$testVersion->name = 'hello';
static::assertSame(1, $testVersion->update()->flush());
static::assertSame('SQL: [126] UPDATE `test_version` SET `test_version`.`name` = :pdonamedparameter_name WHERE `test_version`.`id` = :test_version_id LIMIT 1 | Params: 2 | Key: Name: [23] :pdonamedparameter_name | paramno=0 | name=[23] ":pdonamedparameter_name" | is_param=1 | param_type=2 | Key: Name: [16] :test_version_id | paramno=1 | name=[16] ":test_version_id" | is_param=1 | param_type=1 (UPDATE `test_version` SET `test_version`.`name` = \'hello\' WHERE `test_version`.`id` = 1 LIMIT 1)', $testVersion->select()->getLastSql());
}
condition 设置扩展查询条件支持直接设置版本查询条件 ¶
php
public function testUpdateWithCondition(): void
{
$connect = $this->createDatabaseConnect();
static::assertSame(
1,
$connect
->table('test_version')
->insert([
'name' => 'xiaoniuge',
])
);
$testVersion = DemoVersion::select()->findEntity(1);
$this->assertInstanceof(DemoVersion::class, $testVersion);
static::assertSame(1, $testVersion->id);
static::assertSame('xiaoniuge', $testVersion->name);
static::assertSame('0.0000', $testVersion->availableNumber);
static::assertSame('0.0000', $testVersion->realNumber);
$testVersion->name = 'aniu';
$testVersion->availableNumber = Condition::raw('[available_number]+1');
$testVersion->realNumber = Condition::raw('[real_number]+3');
static::assertSame(1, $testVersion->version(true)->update()->flush());
static::assertSame('SQL: [367] UPDATE `test_version` SET `test_version`.`name` = :pdonamedparameter_name,`test_version`.`available_number` = `test_version`.`available_number`+1,`test_version`.`real_number` = `test_version`.`real_number`+3,`test_version`.`version` = `test_version`.`version`+1 WHERE `test_version`.`id` = :test_version_id AND `test_version`.`version` = :test_version_version LIMIT 1 | Params: 3 | Key: Name: [23] :pdonamedparameter_name | paramno=0 | name=[23] ":pdonamedparameter_name" | is_param=1 | param_type=2 | Key: Name: [16] :test_version_id | paramno=1 | name=[16] ":test_version_id" | is_param=1 | param_type=1 | Key: Name: [21] :test_version_version | paramno=2 | name=[21] ":test_version_version" | is_param=1 | param_type=1 (UPDATE `test_version` SET `test_version`.`name` = \'aniu\',`test_version`.`available_number` = `test_version`.`available_number`+1,`test_version`.`real_number` = `test_version`.`real_number`+3,`test_version`.`version` = `test_version`.`version`+1 WHERE `test_version`.`id` = 1 AND `test_version`.`version` = 0 LIMIT 1)', $testVersion->select()->getLastSql());
$testVersion->refresh();
$condition = ['available_number' => $testVersion->availableNumber, DemoVersion::VERSION => 9999];
$testVersion->name = 'hello';
$testVersion->availableNumber = Condition::raw('[available_number]+8');
static::assertSame(0, $testVersion->condition($condition)->update()->flush());
static::assertSame('SQL: [376] UPDATE `test_version` SET `test_version`.`version` = `test_version`.`version`+1,`test_version`.`name` = :pdonamedparameter_name,`test_version`.`available_number` = `test_version`.`available_number`+8 WHERE `test_version`.`available_number` = :test_version_available_number AND `test_version`.`version` = :test_version_version AND `test_version`.`id` = :test_version_id LIMIT 1 | Params: 4 | Key: Name: [23] :pdonamedparameter_name | paramno=0 | name=[23] ":pdonamedparameter_name" | is_param=1 | param_type=2 | Key: Name: [30] :test_version_available_number | paramno=1 | name=[30] ":test_version_available_number" | is_param=1 | param_type=2 | Key: Name: [21] :test_version_version | paramno=2 | name=[21] ":test_version_version" | is_param=1 | param_type=1 | Key: Name: [16] :test_version_id | paramno=3 | name=[16] ":test_version_id" | is_param=1 | param_type=1 (UPDATE `test_version` SET `test_version`.`version` = `test_version`.`version`+1,`test_version`.`name` = \'hello\',`test_version`.`available_number` = `test_version`.`available_number`+8 WHERE `test_version`.`available_number` = \'1.0000\' AND `test_version`.`version` = 9999 AND `test_version`.`id` = 1 LIMIT 1)', $testVersion->select()->getLastSql());
}
实体设置虚拟主键可以解决没有主键的表数据更新问题 ¶
fixture 定义
without_primarykey
sql
CREATE TABLE `without_primarykey` (
`goods_id` bigint(20) NOT NULL DEFAULT '0' COMMENT '商品 ID',
`description` varchar(255) NOT NULL DEFAULT '' COMMENT '商品描述',
`name` varchar(100) NOT NULL DEFAULT '' COMMENT '商品名称'
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='没有主键的表';
Tests\Database\Ddd\Entity\WithoutPrimarykey
php
namespace Tests\Database\Ddd\Entity;
use Leevel\Database\Ddd\Entity;
use Leevel\Database\Ddd\Struct;
class WithoutPrimarykey extends Entity
{
public const TABLE = 'without_primarykey';
public const ID = 'goods_id';
public const AUTO = null;
#[Struct([
self::READONLY => true,
])]
protected ?int $goodsId = null;
#[Struct([
])]
protected ?string $description = null;
#[Struct([
])]
protected ?string $name = null;
}
php
public function testUpdateWithoutPrimarykey(): void
{
$connect = $this->createDatabaseConnect();
static::assertSame(
1,
$connect
->table('without_primarykey')
->insert([
'goods_id' => 1,
'description' => 'hello',
])
);
$withoutPrimarykey = WithoutPrimarykey::select()->findEntity(1);
static::assertSame(['goods_id'], WithoutPrimarykey::primaryKey());
$this->assertInstanceof(WithoutPrimarykey::class, $withoutPrimarykey);
static::assertSame(1, $withoutPrimarykey->goodsId);
static::assertSame('hello', $withoutPrimarykey->description);
$withoutPrimarykey->description = 'world';
static::assertSame(1, $withoutPrimarykey->update()->flush());
static::assertSame('SQL: [176] UPDATE `without_primarykey` SET `without_primarykey`.`description` = :pdonamedparameter_description WHERE `without_primarykey`.`goods_id` = :without_primarykey_goods_id LIMIT 1 | Params: 2 | Key: Name: [30] :pdonamedparameter_description | paramno=0 | name=[30] ":pdonamedparameter_description" | is_param=1 | param_type=2 | Key: Name: [28] :without_primarykey_goods_id | paramno=1 | name=[28] ":without_primarykey_goods_id" | is_param=1 | param_type=1 (UPDATE `without_primarykey` SET `without_primarykey`.`description` = \'world\' WHERE `without_primarykey`.`goods_id` = 1 LIMIT 1)', $withoutPrimarykey->select()->getLastSql());
}
实体未设置主键所有非关联字段将变为虚拟主键 ¶
fixture 定义
without_primarykey
sql
CREATE TABLE `without_primarykey` (
`goods_id` bigint(20) NOT NULL DEFAULT '0' COMMENT '商品 ID',
`description` varchar(255) NOT NULL DEFAULT '' COMMENT '商品描述',
`name` varchar(100) NOT NULL DEFAULT '' COMMENT '商品名称'
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='没有主键的表';
Tests\Database\Ddd\Entity\WithoutPrimarykeyAndAllAreKey
php
namespace Tests\Database\Ddd\Entity;
use Leevel\Database\Ddd\Entity;
use Leevel\Database\Ddd\Struct;
class WithoutPrimarykeyAndAllAreKey extends Entity
{
public const TABLE = 'without_primarykey';
public const ID = null;
public const AUTO = null;
#[Struct([
self::READONLY => true,
])]
protected ?int $goodsId = null;
#[Struct([
])]
protected ?string $description = null;
#[Struct([
])]
protected ?string $name = null;
}
php
public function testUpdateWithoutPrimarykeyAndAllAreKey(): void
{
$connect = $this->createDatabaseConnect();
static::assertSame(
1,
$connect
->table('without_primarykey')
->insert([
'goods_id' => 1,
'description' => 'hello',
'name' => 'world',
])
);
$withoutPrimarykey = WithoutPrimarykeyAndAllAreKey::select()->findOne();
static::assertSame(['goods_id', 'description', 'name'], WithoutPrimarykeyAndAllAreKey::primaryKey());
$this->assertInstanceof(WithoutPrimarykeyAndAllAreKey::class, $withoutPrimarykey);
static::assertSame(1, $withoutPrimarykey->goodsId);
static::assertSame('hello', $withoutPrimarykey->description);
static::assertSame('world', $withoutPrimarykey->name);
$withoutPrimarykey->description = 'my';
$withoutPrimarykey->name = 'php';
static::assertSame(1, $withoutPrimarykey->update()->flush());
static::assertSame('SQL: [362] UPDATE `without_primarykey` SET `without_primarykey`.`description` = :pdonamedparameter_description,`without_primarykey`.`name` = :pdonamedparameter_name WHERE `without_primarykey`.`goods_id` = :without_primarykey_goods_id AND `without_primarykey`.`description` = :without_primarykey_description AND `without_primarykey`.`name` = :without_primarykey_name LIMIT 1 | Params: 5 | Key: Name: [30] :pdonamedparameter_description | paramno=0 | name=[30] ":pdonamedparameter_description" | is_param=1 | param_type=2 | Key: Name: [23] :pdonamedparameter_name | paramno=1 | name=[23] ":pdonamedparameter_name" | is_param=1 | param_type=2 | Key: Name: [28] :without_primarykey_goods_id | paramno=2 | name=[28] ":without_primarykey_goods_id" | is_param=1 | param_type=1 | Key: Name: [31] :without_primarykey_description | paramno=3 | name=[31] ":without_primarykey_description" | is_param=1 | param_type=2 | Key: Name: [24] :without_primarykey_name | paramno=4 | name=[24] ":without_primarykey_name" | is_param=1 | param_type=2 (UPDATE `without_primarykey` SET `without_primarykey`.`description` = \'my\',`without_primarykey`.`name` = \'php\' WHERE `without_primarykey`.`goods_id` = 1 AND `without_primarykey`.`description` = \'hello\' AND `without_primarykey`.`name` = \'world\' LIMIT 1)', $withoutPrimarykey->select()->getLastSql());
$withoutPrimarykey->name = 'new name';
static::assertSame(1, $withoutPrimarykey->update()->flush());
static::assertSame('SQL: [294] UPDATE `without_primarykey` SET `without_primarykey`.`name` = :pdonamedparameter_name WHERE `without_primarykey`.`goods_id` = :without_primarykey_goods_id AND `without_primarykey`.`description` = :without_primarykey_description AND `without_primarykey`.`name` = :without_primarykey_name LIMIT 1 | Params: 4 | Key: Name: [23] :pdonamedparameter_name | paramno=0 | name=[23] ":pdonamedparameter_name" | is_param=1 | param_type=2 | Key: Name: [28] :without_primarykey_goods_id | paramno=1 | name=[28] ":without_primarykey_goods_id" | is_param=1 | param_type=1 | Key: Name: [31] :without_primarykey_description | paramno=2 | name=[31] ":without_primarykey_description" | is_param=1 | param_type=2 | Key: Name: [24] :without_primarykey_name | paramno=3 | name=[24] ":without_primarykey_name" | is_param=1 | param_type=2 (UPDATE `without_primarykey` SET `without_primarykey`.`name` = \'new name\' WHERE `without_primarykey`.`goods_id` = 1 AND `without_primarykey`.`description` = \'my\' AND `without_primarykey`.`name` = \'php\' LIMIT 1)', $withoutPrimarykey->select()->getLastSql());
$withoutPrimarykey->name = 'new and new';
$withoutPrimarykey->update();
$withoutPrimarykey->name = 'new and new2';
static::assertSame(1, $withoutPrimarykey->update()->flush());
static::assertSame('SQL: [294] UPDATE `without_primarykey` SET `without_primarykey`.`name` = :pdonamedparameter_name WHERE `without_primarykey`.`goods_id` = :without_primarykey_goods_id AND `without_primarykey`.`description` = :without_primarykey_description AND `without_primarykey`.`name` = :without_primarykey_name LIMIT 1 | Params: 4 | Key: Name: [23] :pdonamedparameter_name | paramno=0 | name=[23] ":pdonamedparameter_name" | is_param=1 | param_type=2 | Key: Name: [28] :without_primarykey_goods_id | paramno=1 | name=[28] ":without_primarykey_goods_id" | is_param=1 | param_type=1 | Key: Name: [31] :without_primarykey_description | paramno=2 | name=[31] ":without_primarykey_description" | is_param=1 | param_type=2 | Key: Name: [24] :without_primarykey_name | paramno=3 | name=[24] ":without_primarykey_name" | is_param=1 | param_type=2 (UPDATE `without_primarykey` SET `without_primarykey`.`name` = \'new and new2\' WHERE `without_primarykey`.`goods_id` = 1 AND `without_primarykey`.`description` = \'my\' AND `without_primarykey`.`name` = \'new name\' LIMIT 1)', $withoutPrimarykey->select()->getLastSql());
}
__clone 实体克隆 ¶
复制的实体没有主键值,保存数据时将会在数据库新增一条记录。
php
public function testEntityClone(): void
{
$connect = $this->createDatabaseConnect();
static::assertSame(
1,
$connect
->table('post')
->insert([
'title' => 'hello world',
'user_id' => 1,
'summary' => 'post summary',
'delete_at' => 0,
])
);
$post = Post::find()->where('id', 1)->findOne();
static::assertSame(1, $post->id);
static::assertSame('hello world', $post->title);
static::assertSame(1, $post->userId);
static::assertSame('post summary', $post->summary);
$postClone = clone $post;
static::assertNull($postClone->id);
static::assertSame('hello world', $postClone->title);
static::assertSame(1, $postClone->userId);
static::assertSame('post summary', $postClone->summary);
$post->title = 'world';
static::assertSame('hello world', $postClone->title);
$postClone->title = 'goods';
static::assertSame('world', $post->title);
}
make 创建实例 ¶
php
public function testEntityMake(): void
{
$post = Post::make([
'title' => 'hello world',
'user_id' => 1,
'summary' => 'post summary',
'delete_at' => 0,
]);
static::assertTrue($post->newed());
static::assertNull($post->id);
static::assertSame('hello world', $post->title);
static::assertSame(1, $post->userId);
static::assertSame('post summary', $post->summary);
}
createAssign 新增批量赋值 ¶
php
public function testEntityCreateAssign(): void
{
$post = Post::createAssign([
'title' => 'hello world',
'user_id' => 1,
'summary' => 'post summary',
'delete_at' => 0,
]);
static::assertTrue($post->newed());
static::assertNull($post->id);
static::assertSame('hello world', $post->title);
static::assertSame(1, $post->userId);
static::assertSame('post summary', $post->summary);
}
updateAssign 更新批量赋值 ¶
php
public function testEntityUpdateAssign(): void
{
$post = Post::updateAssign([
'id' => 1,
'title' => 'hello world',
'user_id' => 1,
'summary' => 'post summary',
'delete_at' => 0,
]);
static::assertFalse($post->newed());
static::assertSame(1, $post->id);
static::assertSame('hello world', $post->title);
static::assertSame(1, $post->userId);
static::assertSame('post summary', $post->summary);
}