实体导出数组

Testing Is Documentation

tests/Database/Ddd/EntityToArrayTest.php实体导出数组 - 图1

我们可以将实体导出为数组来方便处理数据。

Uses

  1. <?php
  3. use Leevel\Database\Ddd\Entity;
  4. use Tests\Database\DatabaseTestCase as TestCase;
  5. use Tests\Database\Ddd\Entity\DemoToArrayBlackEntity;
  6. use Tests\Database\Ddd\Entity\DemoToArrayEntity;
  7. use Tests\Database\Ddd\Entity\DemoToArrayShowPropNullEntity;
  8. use Tests\Database\Ddd\Entity\DemoToArrayShowPropNullRelationEntity;
  9. use Tests\Database\Ddd\Entity\DemoToArrayShowPropNullRelationTargetEntity;
  10. use Tests\Database\Ddd\Entity\DemoToArrayWhiteEntity;
  11. use Tests\Database\Ddd\Entity\Relation\Post;
  12. use Tests\Database\Ddd\Entity\Relation\User;

toArray 基本使用方法

fixture 定义

  1. # Tests\Database\Ddd\EntityToArrayTest::makeEntity
  2. protected function makeEntity(): DemoToArrayEntity
  3. {
  4.     $entity = new DemoToArrayEntity();
  5.     $this->assertInstanceof(Entity::class, $entity);
  6.     $entity->name = '实体名字';
  7.     $entity->description = 'goods name';
  8.     $entity->address = '四川成都';
  9.     $entity->foo_bar = 'foo';
  10.     $entity->hello = 'hello world';
  12.     return $entity;
  13. }

Tests\Database\Ddd\Entity\DemoToArrayEntity

  1. namespace Tests\Database\Ddd\Entity;
  3. use Leevel\Database\Ddd\Entity;
  4. use Leevel\Database\Ddd\GetterSetter;
  6. class DemoToArrayEntity extends Entity
  7. {
  8.     use GetterSetter;
  10.     const TABLE = 'test';
  12.     const ID = 'id';
  14.     const AUTO = 'id';
  16.     const STRUCT = [
  17.         'id'          => [],
  18.         'name'        => [],
  19.         'description' => [],
  20.         'address'     => [],
  21.         'foo_bar'     => [],
  22.         'hello'       => [],
  23.     ];
  24. }
  1. public function testBaseUse(): void
  2. {
  3.     $entity = $this->makeEntity();
  5.     $data = <<<'eot'
  6.         {
  7.             "name": "实体名字",
  8.             "description": "goods name",
  9.             "address": "四川成都",
  10.             "foo_bar": "foo",
  11.             "hello": "hello world"
  12.         }
  13.         eot;
  15.     $this->assertSame(
  16.         $data,
  17.         $this->varJson(
  18.             $entity->toArray()
  19.         )
  20.     );
  21. }

toArray 实体对象转数组支持白名单

toArray 第一个参数为白名单，设置了白名单，只有白名单的字段才能够转换为数组数据。

  1. public function testWithWhite(): void
  2. {
  3.     $entity = $this->makeEntity();
  5.     $data = <<<'eot'
  6.         {
  7.             "name": "实体名字",
  8.             "description": "goods name",
  9.             "address": "四川成都",
  10.             "foo_bar": "foo",
  11.             "hello": "hello world"
  12.         }
  13.         eot;
  15.     $this->assertSame(
  16.         $data,
  17.         $this->varJson(
  18.             $entity->toArray()
  19.         )
  20.     );
  22.     $data = <<<'eot'
  23.         {
  24.             "name": "实体名字"
  25.         }
  26.         eot;
  28.     $this->assertSame(
  29.         $data,
  30.         $this->varJson(
  31.             $entity->toArray(['name']),
  32.             1
  33.         )
  34.     );
  36.     $data = <<<'eot'
  37.         {
  38.             "name": "实体名字",
  39.             "description": "goods name"
  40.         }
  41.         eot;
  43.     $this->assertSame(
  44.         $data,
  45.         $this->varJson(
  46.             $entity->toArray(['name', 'description']),
  47.             2
  48.         )
  49.     );
  51.     $data = <<<'eot'
  52.         {
  53.             "name": "实体名字",
  54.             "description": "goods name",
  55.             "hello": "hello world"
  56.         }
  57.         eot;
  59.     $this->assertSame(
  60.         $data,
  61.         $this->varJson(
  62.             $entity->toArray(['name', 'description', 'hello']),
  63.             3
  64.         )
  65.     );
  66. }

toArray 实体对象转数组支持黑名单

toArray 第二个参数为白名单，设置了黑名单但是没有设置白名单，只有不属于黑名单的字段才能够转换为数组数据。

  1. public function testWithBlack(): void
  2. {
  3.     $entity = $this->makeEntity();
  5.     $data = <<<'eot'
  6.         {
  7.             "name": "实体名字",
  8.             "description": "goods name",
  9.             "address": "四川成都",
  10.             "foo_bar": "foo",
  11.             "hello": "hello world"
  12.         }
  13.         eot;
  15.     $this->assertSame(
  16.         $data,
  17.         $this->varJson(
  18.             $entity->toArray()
  19.         )
  20.     );
  22.     $data = <<<'eot'
  23.         {
  24.             "description": "goods name",
  25.             "address": "四川成都",
  26.             "foo_bar": "foo",
  27.             "hello": "hello world"
  28.         }
  29.         eot;
  31.     $this->assertSame(
  32.         $data,
  33.         $this->varJson(
  34.             $entity->toArray([], ['name']),
  35.             1
  36.         )
  37.     );
  39.     $data = <<<'eot'
  40.         {
  41.             "address": "四川成都",
  42.             "foo_bar": "foo",
  43.             "hello": "hello world"
  44.         }
  45.         eot;
  47.     $this->assertSame(
  48.         $data,
  49.         $this->varJson(
  50.             $entity->toArray([], ['name', 'description']),
  51.             2
  52.         )
  53.     );
  55.     $data = <<<'eot'
  56.         {
  57.             "description": "goods name",
  58.             "hello": "hello world"
  59.         }
  60.         eot;
  62.     $this->assertSame(
  63.         $data,
  64.         $this->varJson(
  65.             $entity->toArray([], ['foo_bar', 'name', 'address']),
  66.             3
  67.         )
  68.     );
  69. }

toArray 实体对象转数组支持字段设置为白名单

可以通过 STRUCT 中的定义 \Leevel\Database\Ddd\Entity::SHOW_PROP_WHITE 来设置字段白名单。

值得注意的是， toArray 的第一个参数白名单优先级更高。

如果设置了白名单，只有白名单的字段才能够转换为数组数据。

fixture 定义

  1. # Tests\Database\Ddd\EntityToArrayTest::makeWhiteEntity
  2. protected function makeWhiteEntity(): DemoToArrayWhiteEntity
  3. {
  4.     $entity = new DemoToArrayWhiteEntity();
  5.     $this->assertInstanceof(Entity::class, $entity);
  6.     $entity->name = '实体名字';
  7.     $entity->description = 'goods name';
  8.     $entity->address = '四川成都';
  9.     $entity->foo_bar = 'foo';
  10.     $entity->hello = 'hello world';
  12.     return $entity;
  13. }

Tests\Database\Ddd\Entity\DemoToArrayWhiteEntity

  1. namespace Tests\Database\Ddd\Entity;
  3. use Leevel\Database\Ddd\Entity;
  4. use Leevel\Database\Ddd\GetterSetter;
  6. class DemoToArrayWhiteEntity extends Entity
  7. {
  8.     use GetterSetter;
  10.     const TABLE = 'test';
  12.     const ID = 'id';
  14.     const AUTO = 'id';
  16.     const STRUCT = [
  17.         'id'          => [],
  18.         'name'        => [],
  19.         'description' => [
  20.             self::SHOW_PROP_WHITE => true,
  21.         ],
  22.         'address'     => [],
  23.         'foo_bar'     => [
  24.             self::SHOW_PROP_WHITE => true,
  25.         ],
  26.         'hello'       => [],
  27.     ];
  28. }
  1. public function testWithWhiteEntity(): void
  2. {
  3.     $entity = $this->makeWhiteEntity();
  5.     $data = <<<'eot'
  6.         {
  7.             "description": "goods name",
  8.             "foo_bar": "foo"
  9.         }
  10.         eot;
  12.     $this->assertSame(
  13.         $data,
  14.         $this->varJson(
  15.             $entity->toArray()
  16.         )
  17.     );
  18. }

toArray 实体对象转数组支持字段设置为黑名单

可以通过 STRUCT 中的定义 \Leevel\Database\Ddd\Entity::SHOW_PROP_BLACK 来设置字段黑名单。

值得注意的是， toArray 的第二个参数黑名单优先级更高。

如果设置了黑名单，设置了黑名单但是没有设置白名单，只有不属于黑名单的字段才能够转换为数组数据。

fixture 定义

  1. # Tests\Database\Ddd\EntityToArrayTest::makeBlackEntity
  2. protected function makeBlackEntity(): DemoToArrayBlackEntity
  3. {
  4.     $entity = new DemoToArrayBlackEntity();
  5.     $this->assertInstanceof(Entity::class, $entity);
  6.     $entity->name = '实体名字';
  7.     $entity->description = 'goods name';
  8.     $entity->address = '四川成都';
  9.     $entity->foo_bar = 'foo';
  10.     $entity->hello = 'hello world';
  12.     return $entity;
  13. }

Tests\Database\Ddd\Entity\DemoToArrayBlackEntity

  1. namespace Tests\Database\Ddd\Entity;
  3. use Leevel\Database\Ddd\Entity;
  4. use Leevel\Database\Ddd\GetterSetter;
  6. class DemoToArrayBlackEntity extends Entity
  7. {
  8.     use GetterSetter;
  10.     const TABLE = 'test';
  12.     const ID = 'id';
  14.     const AUTO = 'id';
  16.     const STRUCT = [
  17.         'id'          => [],
  18.         'name'        => [],
  19.         'description' => [
  20.             self::SHOW_PROP_BLACK => true,
  21.         ],
  22.         'address'     => [],
  23.         'foo_bar'     => [
  24.             self::SHOW_PROP_BLACK => true,
  25.         ],
  26.         'hello'       => [],
  27.     ];
  28. }
  1. public function testWithBlackEntity(): void
  2. {
  3.     $entity = $this->makeBlackEntity();
  5.     $data = <<<'eot'
  6.         {
  7.             "name": "实体名字",
  8.             "address": "四川成都",
  9.             "hello": "hello world"
  10.         }
  11.         eot;
  13.     $this->assertSame(
  14.         $data,
  15.         $this->varJson(
  16.             $entity->toArray()
  17.         )
  18.     );
  19. }

toArray 实体对象转数组支持转换关联实体数据

fixture 定义

  1. # Tests\Database\Ddd\EntityToArrayTest::makeRelationEntity
  2. protected function makeRelationEntity(): Post
  3. {
  4.     $user = new User(['id' => 7]);
  5.     $user->name = 'xiaoniuge';
  7.     $entity = new Post(['id' => 5]);
  8.     $this->assertInstanceof(Post::class, $entity);
  9.     $entity->title = 'I am title';
  10.     $entity->summary = 'I am summary';
  11.     $entity->userId = 7;
  12.     $entity->withRelationProp('user', $user);
  14.     return $entity;
  15. }

Tests\Database\Ddd\Entity\Relation\User

  1. namespace Tests\Database\Ddd\Entity\Relation;
  3. use Leevel\Database\Ddd\Entity;
  4. use Leevel\Database\Ddd\GetterSetter;
  5. use Leevel\Database\Ddd\Relation\ManyMany;
  7. class User extends Entity
  8. {
  9.     use GetterSetter;
  11.     const TABLE = 'user';
  13.     const ID = 'id';
  15.     const AUTO = 'id';
  17.     const STRUCT = [
  18.         'id'        => [],
  19.         'name'      => [],
  20.         'create_at' => [],
  21.         'role'      => [
  22.             self::MANY_MANY         => Role::class,
  23.             self::MIDDLE_ENTITY     => UserRole::class,
  24.             self::SOURCE_KEY        => 'id',
  25.             self::TARGET_KEY        => 'id',
  26.             self::MIDDLE_SOURCE_KEY => 'user_id',
  27.             self::MIDDLE_TARGET_KEY => 'role_id',
  28.         ],
  29.         'role_soft_deleted'      => [
  30.             self::MANY_MANY         => RoleSoftDeleted::class,
  31.             self::MIDDLE_ENTITY     => UserRoleSoftDeleted::class,
  32.             self::SOURCE_KEY        => 'id',
  33.             self::TARGET_KEY        => 'id',
  34.             self::MIDDLE_SOURCE_KEY => 'user_id',
  35.             self::MIDDLE_TARGET_KEY => 'role_id',
  36.         ],
  37.         'role_middle_with_soft_deleted'      => [
  38.             self::MANY_MANY         => RoleSoftDeleted::class,
  39.             self::MIDDLE_ENTITY     => UserRoleSoftDeleted::class,
  40.             self::SOURCE_KEY        => 'id',
  41.             self::TARGET_KEY        => 'id',
  42.             self::MIDDLE_SOURCE_KEY => 'user_id',
  43.             self::MIDDLE_TARGET_KEY => 'role_id',
  44.             self::RELATION_SCOPE    => 'withSoftDeleted',
  45.         ],
  46.         'role_middle_only_soft_deleted'      => [
  47.             self::MANY_MANY         => RoleSoftDeleted::class,
  48.             self::MIDDLE_ENTITY     => UserRoleSoftDeleted::class,
  49.             self::SOURCE_KEY        => 'id',
  50.             self::TARGET_KEY        => 'id',
  51.             self::MIDDLE_SOURCE_KEY => 'user_id',
  52.             self::MIDDLE_TARGET_KEY => 'role_id',
  53.             self::RELATION_SCOPE    => 'onlySoftDeleted',
  54.         ],
  55.         'role_relation_scope_not_found'      => [
  56.             self::MANY_MANY         => RoleSoftDeleted::class,
  57.             self::MIDDLE_ENTITY     => UserRoleSoftDeleted::class,
  58.             self::SOURCE_KEY        => 'id',
  59.             self::TARGET_KEY        => 'id',
  60.             self::MIDDLE_SOURCE_KEY => 'user_id',
  61.             self::MIDDLE_TARGET_KEY => 'role_id',
  62.             self::RELATION_SCOPE    => 'notFound',
  63.         ],
  64.         'role_relation_scope_found_but_private'      => [
  65.             self::MANY_MANY         => RoleSoftDeleted::class,
  66.             self::MIDDLE_ENTITY     => UserRoleSoftDeleted::class,
  67.             self::SOURCE_KEY        => 'id',
  68.             self::TARGET_KEY        => 'id',
  69.             self::MIDDLE_SOURCE_KEY => 'user_id',
  70.             self::MIDDLE_TARGET_KEY => 'role_id',
  71.             self::RELATION_SCOPE    => 'foundButPrivate',
  72.         ],
  73.         'role_not_defined_middle_entity'      => [
  74.             self::MANY_MANY         => Role::class,
  75.             self::SOURCE_KEY        => 'id',
  76.             self::TARGET_KEY        => 'id',
  77.             self::MIDDLE_SOURCE_KEY => 'user_id',
  78.             self::MIDDLE_TARGET_KEY => 'role_id',
  79.         ],
  80.         'role_not_defined_source_key'      => [
  81.             self::MANY_MANY         => Role::class,
  82.             self::MIDDLE_ENTITY     => UserRole::class,
  83.             self::TARGET_KEY        => 'id',
  84.             self::MIDDLE_SOURCE_KEY => 'user_id',
  85.             self::MIDDLE_TARGET_KEY => 'role_id',
  86.         ],
  87.         'role_not_defined_target_key'      => [
  88.             self::MANY_MANY         => Role::class,
  89.             self::MIDDLE_ENTITY     => UserRole::class,
  90.             self::SOURCE_KEY        => 'id',
  91.             self::MIDDLE_SOURCE_KEY => 'user_id',
  92.             self::MIDDLE_TARGET_KEY => 'role_id',
  93.         ],
  94.         'role_not_defined_middle_source_key'      => [
  95.             self::MANY_MANY         => Role::class,
  96.             self::MIDDLE_ENTITY     => UserRole::class,
  97.             self::SOURCE_KEY        => 'id',
  98.             self::TARGET_KEY        => 'id',
  99.             self::MIDDLE_TARGET_KEY => 'role_id',
  100.         ],
  101.         'role_not_defined_middle_target_key'      => [
  102.             self::MANY_MANY         => Role::class,
  103.             self::MIDDLE_ENTITY     => UserRole::class,
  104.             self::SOURCE_KEY        => 'id',
  105.             self::TARGET_KEY        => 'id',
  106.             self::MIDDLE_SOURCE_KEY => 'user_id',
  107.         ],
  108.         'role_middle_field'      => [
  109.             self::MANY_MANY         => Role::class,
  110.             self::MIDDLE_ENTITY     => UserRole::class,
  111.             self::SOURCE_KEY        => 'id',
  112.             self::TARGET_KEY        => 'id',
  113.             self::MIDDLE_SOURCE_KEY => 'user_id',
  114.             self::MIDDLE_TARGET_KEY => 'role_id',
  115.             self::RELATION_SCOPE    => 'middleField',
  116.         ],
  117.         'role_middle_only_soft_deleted_and_middle_field_and_other_table_condition' => [
  118.             self::MANY_MANY         => RoleSoftDeleted::class,
  119.             self::MIDDLE_ENTITY     => UserRoleSoftDeleted::class,
  120.             self::SOURCE_KEY        => 'id',
  121.             self::TARGET_KEY        => 'id',
  122.             self::MIDDLE_SOURCE_KEY => 'user_id',
  123.             self::MIDDLE_TARGET_KEY => 'role_id',
  124.             self::RELATION_SCOPE    => 'middleOnlySoftDeletedAndMiddleFieldAndOtherTableCondition',
  125.         ],
  126.     ];
  128.     protected function relationScopeWithSoftDeleted(ManyMany $relation): void
  129.     {
  130.         $relation->middleWithSoftDeleted();
  131.     }
  133.     protected function relationScopeOnlySoftDeleted(ManyMany $relation): void
  134.     {
  135.         $relation->middleOnlySoftDeleted();
  136.     }
  138.     protected function relationScopeMiddleField(ManyMany $relation): void
  139.     {
  140.         $relation->middleField(['create_at', 'middle_id' => 'id']);
  141.     }
  143.     protected function relationScopeMiddleOnlySoftDeletedAndMiddleFieldAndOtherTableCondition(ManyMany $relation): void
  144.     {
  145.         $relation
  146.             ->middleOnlySoftDeleted()
  147.             ->middleField(['create_at', 'middle_id' => 'id'])
  148.             ->setColumns('id,name')
  149.             ->where('id', '>', 3);
  150.     }
  152.     private function relationScopeFoundButPrivate(ManyMany $relation): void
  153.     {
  154.     }
  155. }

Tests\Database\Ddd\Entity\Relation\Post

  1. namespace Tests\Database\Ddd\Entity\Relation;
  3. use Leevel\Database\Ddd\Entity;
  4. use Leevel\Database\Ddd\GetterSetter;
  5. use Leevel\Database\Ddd\Relation\Relation;
  7. class Post extends Entity
  8. {
  9.     use GetterSetter;
  11.     const TABLE = 'post';
  13.     const ID = 'id';
  15.     const AUTO = 'id';
  17.     const STRUCT = [
  18.         'id' => [
  19.             self::READONLY           => true,
  20.         ],
  21.         'title'     => [],
  22.         'user_id'   => [],
  23.         'summary'   => [],
  24.         'create_at' => [],
  25.         'delete_at' => [
  26.             self::CREATE_FILL => 0,
  27.         ],
  28.         'user'      => [
  29.             self::BELONGS_TO     => User::class,
  30.             self::SOURCE_KEY     => 'user_id',
  31.             self::TARGET_KEY     => 'id',
  32.         ],
  33.         'comment' => [
  34.             self::HAS_MANY          => Comment::class,
  35.             self::SOURCE_KEY        => 'id',
  36.             self::TARGET_KEY        => 'post_id',
  37.             self::RELATION_SCOPE    => 'comment',
  38.         ],
  39.         'post_content' => [
  40.             self::HAS_ONE     => PostContent::class,
  41.             self::SOURCE_KEY  => 'id',
  42.             self::TARGET_KEY  => 'post_id',
  43.         ],
  44.         'user_not_defined_source_key'      => [
  45.             self::BELONGS_TO     => User::class,
  46.             self::TARGET_KEY     => 'id',
  47.         ],
  48.         'user_not_defined_target_key'      => [
  49.             self::BELONGS_TO     => User::class,
  50.             self::SOURCE_KEY     => 'id',
  51.         ],
  52.         'comment_not_defined_source_key' => [
  53.             self::HAS_MANY          => Comment::class,
  54.             self::TARGET_KEY        => 'post_id',
  55.             self::RELATION_SCOPE    => 'comment',
  56.         ],
  57.         'comment_not_defined_target_key' => [
  58.             self::HAS_MANY          => Comment::class,
  59.             self::SOURCE_KEY        => 'id',
  60.             self::RELATION_SCOPE    => 'comment',
  61.         ],
  62.         'post_content_not_defined_source_key' => [
  63.             self::HAS_ONE     => PostContent::class,
  64.             self::TARGET_KEY  => 'post_id',
  65.         ],
  66.         'post_content_not_defined_target_key' => [
  67.             self::HAS_ONE     => PostContent::class,
  68.             self::SOURCE_KEY  => 'id',
  69.         ],
  70.     ];
  72.     const DELETE_AT = 'delete_at';
  74.     protected function relationScopeComment(Relation $relation): void
  75.     {
  76.         $relation->where('id', '>', 4);
  77.     }
  78. }
  1. public function testWithRelation(): void
  2. {
  3.     $entity = $this->makeRelationEntity();
  5.     $data = <<<'eot'
  6.         {
  7.             "id": 5,
  8.             "title": "I am title",
  9.             "user_id": 7,
  10.             "summary": "I am summary",
  11.             "user": {
  12.                 "id": 7,
  13.                 "name": "xiaoniuge"
  14.             }
  15.         }
  16.         eot;
  18.     $this->assertSame(
  19.         $data,
  20.         $this->varJson(
  21.             $entity->toArray()
  22.         )
  23.     );
  24. }

toArray 实体对象转数组支持转换关联实体数据（黑白名单）

toArray 第三个参数为关联实体的黑白名单。

  1. public function testWithRelationWhiteAndBlack(): void
  2. {
  3.     $entity = $this->makeRelationEntity();
  5.     $data = <<<'eot'
  6.         {
  7.             "id": 5,
  8.             "title": "I am title",
  9.             "user_id": 7,
  10.             "summary": "I am summary",
  11.             "user": {
  12.                 "name": "xiaoniuge"
  13.             }
  14.         }
  15.         eot;
  17.     $this->assertSame(
  18.         $data,
  19.         $this->varJson(
  20.             $entity->toArray([], [], ['user' => [['name']]])
  21.         )
  22.     );
  23. }

toArray 实体对象转数组支持 NULL 值字段默认指定数据

fixture 定义

  1. # Tests\Database\Ddd\EntityToArrayTest::makeShowPropNullEntity
  2. protected function makeShowPropNullEntity(): DemoToArrayShowPropNullEntity
  3. {
  4.     $entity = new DemoToArrayShowPropNullEntity();
  5.     $this->assertInstanceof(Entity::class, $entity);
  6.     $entity->name = '实体名字';
  7.     $entity->description = 'goods name';
  9.     return $entity;
  10. }

Tests\Database\Ddd\Entity\DemoToArrayShowPropNullEntity

  1. namespace Tests\Database\Ddd\Entity;
  3. use Leevel\Database\Ddd\Entity;
  4. use Leevel\Database\Ddd\GetterSetter;
  6. class DemoToArrayShowPropNullEntity extends Entity
  7. {
  8.     use GetterSetter;
  10.     const TABLE = 'test';
  12.     const ID = 'id';
  14.     const AUTO = 'id';
  16.     const STRUCT = [
  17.         'id'          => [],
  18.         'name'        => [],
  19.         'description' => [],
  20.         'address'     => [
  21.             self::SHOW_PROP_NULL => '',
  22.         ],
  23.         'foo_bar'     => [
  24.             self::SHOW_PROP_NULL => null,
  25.         ],
  26.         'hello'       => [
  27.             self::SHOW_PROP_NULL => 'default_value',
  28.         ],
  29.     ];
  30. }
  1. public function testWithShowPropNull(): void
  2. {
  3.     $entity = $this->makeShowPropNullEntity();
  5.     $data = <<<'eot'
  6.         {
  7.             "name": "实体名字",
  8.             "description": "goods name",
  9.             "address": "",
  10.             "foo_bar": null,
  11.             "hello": "default_value"
  12.         }
  13.         eot;
  15.     $this->assertSame(
  16.         $data,
  17.         $this->varJson(
  18.             $entity->toArray()
  19.         )
  20.     );
  21. }

toArray 实体对象转数组支持 NULL 值字段默认指定数据（关联模型）

fixture 定义

  1. # Tests\Database\Ddd\EntityToArrayTest::makeRelationShowPropNullEntity
  2. protected function makeRelationShowPropNullEntity(): DemoToArrayShowPropNullRelationEntity
  3. {
  4.     $target = new DemoToArrayShowPropNullRelationTargetEntity(['id' => 5]);
  5.     $target->name = 'xiaoniuge';
  7.     $entity = new DemoToArrayShowPropNullRelationEntity(['id' => 5]);
  8.     $this->assertInstanceof(DemoToArrayShowPropNullRelationEntity::class, $entity);
  9.     $entity->name = 'I am name';
  10.     $entity->description = 'I am description';
  11.     $entity->withRelationProp('target', $target);
  13.     return $entity;
  14. }

Tests\Database\Ddd\Entity\DemoToArrayShowPropNullRelationTargetEntity

  1. namespace Tests\Database\Ddd\Entity;
  3. use Leevel\Database\Ddd\Entity;
  4. use Leevel\Database\Ddd\GetterSetter;
  6. class DemoToArrayShowPropNullRelationTargetEntity extends Entity
  7. {
  8.     use GetterSetter;
  10.     const TABLE = 'test';
  12.     const ID = 'id';
  14.     const AUTO = 'id';
  16.     const STRUCT = [
  17.         'id'          => [],
  18.         'name'        => [],
  19.     ];
  20. }

Tests\Database\Ddd\Entity\DemoToArrayShowPropNullRelationEntity

  1. namespace Tests\Database\Ddd\Entity;
  3. use Leevel\Database\Ddd\Entity;
  4. use Leevel\Database\Ddd\GetterSetter;
  6. class DemoToArrayShowPropNullRelationEntity extends Entity
  7. {
  8.     use GetterSetter;
  10.     const TABLE = 'test';
  12.     const ID = 'id';
  14.     const AUTO = 'id';
  16.     const STRUCT = [
  17.         'id'          => [],
  18.         'name'        => [],
  19.         'description' => [],
  20.         'address'     => [
  21.             self::SHOW_PROP_NULL => '',
  22.         ],
  23.         'foo_bar'     => [
  24.             self::SHOW_PROP_NULL => null,
  25.         ],
  26.         'hello'       => [
  27.             self::SHOW_PROP_NULL => 'default_value',
  28.         ],
  29.         'target' => [
  30.             self::HAS_ONE     => DemoToArrayShowPropNullRelationTargetEntity::class,
  31.             self::SOURCE_KEY  => 'id',
  32.             self::TARGET_KEY  => 'id',
  33.         ],
  34.     ];
  35. }
  1. public function testWithShowPropNullForRelation(): void
  2. {
  3.     $entity = $this->makeRelationShowPropNullEntity();
  5.     $data = <<<'eot'
  6.         {
  7.             "id": 5,
  8.             "name": "I am name",
  9.             "description": "I am description",
  10.             "address": "",
  11.             "foo_bar": null,
  12.             "hello": "default_value",
  13.             "target": {
  14.                 "id": 5,
  15.                 "name": "xiaoniuge"
  16.             }
  17.         }
  18.         eot;
  20.     $this->assertSame(
  21.         $data,
  22.         $this->varJson(
  23.             $entity->toArray()
  24.         )
  25.     );
  26. }