belongsTo 从属关联

Testing Is Documentation

tests/Database/Ddd/Relation/BelongsToTest.phpbelongsTo 从属关联 - 图1

从属关联也是一对一的关联的一种，比如一篇文章属于某个用户发表。

从属关联支持类型关联项

关联项说明例子
\Leevel\Database\Ddd\Entity::BELONGS_TO从属关联实体\Tests\Database\Ddd\Entity\Relation\User::class
\Leevel\Database\Ddd\Entity::SOURCE_KEY关联查询源键字段user_id
\Leevel\Database\Ddd\Entity::TARGET_KEY关联目标键字段id
\Leevel\Database\Ddd\Entity::RELATION_SCOPE关联查询作用域foo

Uses

  1. <?php
  3. use Leevel\Collection\Collection;
  4. use Leevel\Database\Ddd\Relation\BelongsTo;
  5. use Leevel\Database\Ddd\Relation\Relation;
  6. use Leevel\Database\Ddd\Select;
  7. use Tests\Database\DatabaseTestCase as TestCase;
  8. use Tests\Database\Ddd\Entity\Relation\Post;
  9. use Tests\Database\Ddd\Entity\Relation\User;

基本使用方法

fixture 定义

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. }

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. }
  1. public function testBaseUse(): void
  2. {
  3.     $post = Post::select()->where('id', 1)->findOne();
  5.     $this->assertInstanceof(Post::class, $post);
  6.     $this->assertNull($post->id);
  8.     $connect = $this->createDatabaseConnect();
  10.     $this->assertSame(
  11.         1,
  12.         $connect
  13.             ->table('post')
  14.             ->insert([
  15.                 'title'     => 'hello world',
  16.                 'user_id'   => 1,
  17.                 'summary'   => 'Say hello to the world.',
  18.                 'delete_at' => 0,
  19.             ]),
  20.     );
  22.     $this->assertSame(
  23.         1,
  24.         $connect
  25.             ->table('user')
  26.             ->insert([
  27.                 'name' => 'niu',
  28.             ]),
  29.     );
  31.     $post = Post::select()->where('id', 1)->findOne();
  33.     $this->assertSame(1, $post->id);
  34.     $this->assertSame(1, $post['id']);
  35.     $this->assertSame(1, $post->getId());
  36.     $this->assertSame(1, $post->user_id);
  37.     $this->assertSame(1, $post->userId);
  38.     $this->assertSame(1, $post['user_id']);
  39.     $this->assertSame(1, $post->getUserId());
  40.     $this->assertSame('hello world', $post->title);
  41.     $this->assertSame('hello world', $post['title']);
  42.     $this->assertSame('hello world', $post->getTitle());
  43.     $this->assertSame('Say hello to the world.', $post->summary);
  44.     $this->assertSame('Say hello to the world.', $post['summary']);
  45.     $this->assertSame('Say hello to the world.', $post->getSummary());
  47.     $user = $post->user;
  49.     $this->assertInstanceof(User::class, $user);
  50.     $this->assertSame(1, $user->id);
  51.     $this->assertSame(1, $user['id']);
  52.     $this->assertSame(1, $user->getId());
  53.     $this->assertSame('niu', $user->name);
  54.     $this->assertSame('niu', $user['name']);
  55.     $this->assertSame('niu', $user->getName());
  56. }

eager 预加载关联

  1. public function testEager(): void
  2. {
  3.     $posts = Post::select()->limit(5)->findAll();
  5.     $this->assertInstanceof(Collection::class, $posts);
  6.     $this->assertCount(0, $posts);
  8.     $connect = $this->createDatabaseConnect();
  10.     for ($i = 0; $i <= 5; $i++) {
  11.         $this->assertSame(
  12.             $i + 1,
  13.             $connect
  14.                 ->table('post')
  15.                 ->insert([
  16.                     'title'     => 'hello world',
  17.                     'user_id'   => 1,
  18.                     'summary'   => 'Say hello to the world.',
  19.                     'delete_at' => 0,
  20.                 ]),
  21.         );
  22.     }
  24.     $this->assertSame(
  25.         1,
  26.         $connect
  27.             ->table('user')
  28.             ->insert([
  29.                 'name' => 'niu',
  30.             ]),
  31.     );
  33.     $posts = Post::eager(['user'])
  34.         ->limit(5)
  35.         ->findAll();
  37.     $this->assertInstanceof(Collection::class, $posts);
  38.     $this->assertCount(5, $posts);
  40.     foreach ($posts as $value) {
  41.         $user = $value->user;
  43.         $this->assertInstanceof(User::class, $user);
  44.         $this->assertSame(1, $user->id);
  45.         $this->assertSame('niu', $user->name);
  46.     }
  47. }

eager 预加载关联支持查询条件过滤

  1. public function testEagerWithCondition(): void
  2. {
  3.     $posts = Post::select()->limit(5)->findAll();
  5.     $this->assertInstanceof(Collection::class, $posts);
  6.     $this->assertCount(0, $posts);
  8.     $connect = $this->createDatabaseConnect();
  10.     for ($i = 0; $i <= 5; $i++) {
  11.         $this->assertSame(
  12.             $i + 1,
  13.             $connect
  14.                 ->table('post')
  15.                 ->insert([
  16.                     'title'     => 'hello world',
  17.                     'user_id'   => 1,
  18.                     'summary'   => 'Say hello to the world.',
  19.                     'delete_at' => 0,
  20.                 ]),
  21.         );
  22.     }
  24.     $this->assertSame(
  25.         1,
  26.         $connect
  27.             ->table('user')
  28.             ->insert([
  29.                 'name' => 'niu',
  30.             ]),
  31.     );
  33.     $posts = Post::eager(['user' => function (Relation $select) {
  34.         $select->where('id', '>', 99999);
  35.     }])
  36.         ->limit(5)
  37.         ->findAll();
  39.     $this->assertInstanceof(Collection::class, $posts);
  40.     $this->assertCount(5, $posts);
  42.     foreach ($posts as $value) {
  43.         $user = $value->user;
  44.         $this->assertInstanceof(User::class, $user);
  45.         $this->assertNotSame(1, $user->id);
  46.         $this->assertNotSame('niu', $user->name);
  47.         $this->assertNull($user->id);
  48.         $this->assertNull($user->name);
  49.     }
  50. }

relation 读取关联

  1. public function testRelationAsMethod(): void
  2. {
  3.     $connect = $this->createDatabaseConnect();
  5.     $this->assertSame(
  6.         1,
  7.         $connect
  8.             ->table('post')
  9.             ->insert([
  10.                 'title'     => 'hello world',
  11.                 'user_id'   => 1,
  12.                 'summary'   => 'Say hello to the world.',
  13.                 'delete_at' => 0,
  14.             ]),
  15.     );
  17.     $this->assertSame(
  18.         1,
  19.         $connect
  20.             ->table('user')
  21.             ->insert([
  22.                 'name' => 'niu',
  23.             ]),
  24.     );
  26.     $userRelation = Post::make()->relation('user');
  28.     $this->assertInstanceof(BelongsTo::class, $userRelation);
  29.     $this->assertSame('user_id', $userRelation->getSourceKey());
  30.     $this->assertSame('id', $userRelation->getTargetKey());
  31.     $this->assertInstanceof(Post::class, $userRelation->getSourceEntity());
  32.     $this->assertInstanceof(User::class, $userRelation->getTargetEntity());
  33.     $this->assertInstanceof(Select::class, $userRelation->getSelect());
  34. }

relation 关联模型数据不存在返回空实体

  1. public function testRelationDataWasNotFound(): void
  2. {
  3.     $post = Post::select()->where('id', 1)->findOne();
  5.     $this->assertInstanceof(Post::class, $post);
  6.     $this->assertNull($post->id);
  8.     $connect = $this->createDatabaseConnect();
  10.     $this->assertSame(
  11.         1,
  12.         $connect
  13.             ->table('post')
  14.             ->insert([
  15.                 'title'     => 'hello world',
  16.                 'user_id'   => 99999,
  17.                 'summary'   => 'Say hello to the world.',
  18.                 'delete_at' => 0,
  19.             ]),
  20.     );
  22.     $post = Post::select()->where('id', 1)->findOne();
  24.     $this->assertSame(1, $post->id);
  25.     $this->assertSame(1, $post['id']);
  26.     $this->assertSame(1, $post->getId());
  27.     $this->assertSame(99999, $post->user_id);
  28.     $this->assertSame(99999, $post->userId);
  29.     $this->assertSame(99999, $post['user_id']);
  30.     $this->assertSame(99999, $post->getUserId());
  31.     $this->assertSame('hello world', $post->title);
  32.     $this->assertSame('hello world', $post['title']);
  33.     $this->assertSame('hello world', $post->getTitle());
  34.     $this->assertSame('Say hello to the world.', $post->summary);
  35.     $this->assertSame('Say hello to the world.', $post['summary']);
  36.     $this->assertSame('Say hello to the world.', $post->getSummary());
  38.     $user = $post->user;
  40.     $this->assertInstanceof(User::class, $user);
  41.     $this->assertNull($user->id);
  42.     $this->assertNull($user['id']);
  43.     $this->assertNull($user->getId());
  44.     $this->assertNull($user->name);
  45.     $this->assertNull($user['name']);
  46.     $this->assertNull($user->getName());
  47. }