HasMany::inverseTargets()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 2
nc 1
nop 1
dl 0
loc 4
rs 10
c 0
b 0
f 0
1
<?php
2
/**
3
 * Cycle ORM Schema Builder.
4
 *
5
 * @license   MIT
6
 * @author    Anton Titov (Wolfy-J)
7
 */
8
declare(strict_types=1);
9
10
namespace Cycle\Schema\Relation;
11
12
use Cycle\ORM\Relation;
13
use Cycle\Schema\Exception\RelationException;
14
use Cycle\Schema\InversableInterface;
15
use Cycle\Schema\Registry;
16
use Cycle\Schema\Relation\Traits\FieldTrait;
17
use Cycle\Schema\Relation\Traits\ForeignKeyTrait;
18
use Cycle\Schema\RelationInterface;
19
20
final class HasMany extends RelationSchema implements InversableInterface
21
{
22
    use FieldTrait, ForeignKeyTrait;
23
24
    // internal relation type
25
    protected const RELATION_TYPE = Relation::HAS_MANY;
26
27
    // relation schema options
28
    protected const RELATION_SCHEMA = [
29
        // save with parent
30
        Relation::CASCADE            => true,
31
32
        // do not pre-load relation by default
33
        Relation::LOAD               => Relation::LOAD_PROMISE,
34
35
        // not nullable by default
36
        Relation::NULLABLE           => false,
37
38
        // custom where condition
39
        Relation::WHERE              => [],
40
41
        // link to parent entity primary key by default
42
        Relation::INNER_KEY          => '{source:primaryKey}',
43
44
        // default field name for inner key
45
        Relation::OUTER_KEY          => '{source:role}_{innerKey}',
46
47
        // rendering options
48
        RelationSchema::INDEX_CREATE => true,
49
        RelationSchema::FK_CREATE    => true,
50
        RelationSchema::FK_ACTION    => 'CASCADE'
51
    ];
52
53
    /**
54
     * @param Registry $registry
55
     */
56
    public function compute(Registry $registry)
57
    {
58
        parent::compute($registry);
59
60
        $source = $registry->getEntity($this->source);
61
        $target = $registry->getEntity($this->target);
62
63
        // create target outer field
64
        $this->ensureField(
65
            $target,
66
            $this->options->get(Relation::OUTER_KEY),
67
            $this->getField($source, Relation::INNER_KEY),
68
            $this->options->get(Relation::NULLABLE)
0 ignored issues
show
Bug introduced by Wolfy-J
It seems like $this->options->get(Cycle\ORM\Relation::NULLABLE) can also be of type string; however, parameter $nullable of Cycle\Schema\Relation\HasMany::ensureField() does only seem to accept boolean, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

68
            /** @scrutinizer ignore-type */ $this->options->get(Relation::NULLABLE)
Loading history...
69
        );
70
    }
71
72
    /**
73
     * @param Registry $registry
74
     */
75
    public function render(Registry $registry)
76
    {
77
        $source = $registry->getEntity($this->source);
78
        $target = $registry->getEntity($this->target);
79
80
        $innerField = $this->getField($source, Relation::INNER_KEY);
81
        $outerField = $this->getField($target, Relation::OUTER_KEY);
82
83
        $table = $registry->getTableSchema($target);
84
85
        if ($this->options->get(self::INDEX_CREATE)) {
86
            $table->index([$outerField->getColumn()]);
87
        }
88
89
        if ($this->options->get(self::FK_CREATE)) {
90
            $this->createForeignKey($registry, $source, $target, $innerField, $outerField);
91
        }
92
    }
93
94
    /**
95
     * @param Registry $registry
96
     * @return array
97
     */
98
    public function inverseTargets(Registry $registry): array
99
    {
100
        return [
101
            $registry->getEntity($this->target)
102
        ];
103
    }
104
105
    /**
106
     * @param RelationInterface $relation
107
     * @param string            $into
108
     * @param int|null          $load
109
     * @return RelationInterface
110
     *
111
     * @throws RelationException
112
     */
113
    public function inverseRelation(RelationInterface $relation, string $into, ?int $load = null): RelationInterface
114
    {
115
        if (!$relation instanceof BelongsTo && !$relation instanceof RefersTo) {
116
            throw new RelationException("HasMany relation can only be inversed into BelongsTo or RefersTo");
117
        }
118
119
        if (!empty($this->options->get(Relation::WHERE))) {
120
            throw new RelationException("Unable to inverse HasMany relation with where constrain");
121
        }
122
123
        return $relation->withContext(
124
            $into,
125
            $this->target,
126
            $this->source,
127
            $this->options->withOptions([
128
                Relation::LOAD      => $load,
129
                Relation::INNER_KEY => $this->options->get(Relation::OUTER_KEY),
130
                Relation::OUTER_KEY => $this->options->get(Relation::INNER_KEY),
131
            ])
132
        );
133
    }
134
}
135