Embedded::getReferenceScope() - Code Metrics - Inspection of "load eager test" - cycle/orm - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — 2.x (#517)

by Aleksei

created 2025-05-04 10:37 UTC

Embedded::getReferenceScope() A

↳ Parent: Embedded

Complexity

Conditions	3
Paths	3

Size

Total Lines	12
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	3

Importance

Changes

Metric	Value
cc	3
eloc	8
nc	3
nop	1
dl	0
loc	12
ccs	4
cts	4
cp	1
crap	3
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Cycle\ORM\Relation;

use Cycle\ORM\Command\StoreCommandInterface;
use Cycle\ORM\Exception\Relation\NullException;
use Cycle\ORM\Heap\Node;
use Cycle\ORM\Heap\State;
use Cycle\ORM\MapperInterface;
use Cycle\ORM\ORMInterface;
use Cycle\ORM\Reference\EmptyReference;
use Cycle\ORM\Reference\Reference;
use Cycle\ORM\Reference\ReferenceInterface;
use Cycle\ORM\SchemaInterface;
use Cycle\ORM\Service\EntityFactoryInterface;
use Cycle\ORM\Service\EntityProviderInterface;
use Cycle\ORM\Service\MapperProviderInterface;
use Cycle\ORM\Transaction\Pool;
use Cycle\ORM\Transaction\Tuple;

/**
 * Embeds one object to another.
 *
 * @internal
 */
final class Embedded implements SameRowRelationInterface
{
    private MapperInterface $mapper;
    private MapperProviderInterface $mapperProvider;
    private EntityProviderInterface $entityProvider;

    /** @var string[] */
    private array $primaryKeys;

    private array $columns;

    public function __construct(
        /** @internal */
        ORMInterface $orm,
        private string $name,
        private string $target,
    ) {
        $this->mapperProvider = $orm->getService(MapperProviderInterface::class);
        $this->entityProvider = $orm->getService(EntityProviderInterface::class);
        $this->mapper = $this->mapperProvider->getMapper($target);

        // this relation must manage column association manually, bypassing related mapper
        $this->primaryKeys = (array) $orm->getSchema()->define($target, SchemaInterface::PRIMARY_KEY);
        $this->columns = $orm->getSchema()->define($target, SchemaInterface::COLUMNS);
    }

    public function getName(): string
    {
        return $this->name;
    }

    public function getInnerKeys(): array
    {
        return $this->primaryKeys;
    }

    public function getTarget(): string
    {
        return $this->target;
    }

    public function isCascade(): bool
    {
        // always cascade
        return true;
    }

    public function init(EntityFactoryInterface $factory, Node $node, array $data): object
    {
        foreach ($this->primaryKeys as $key) {
            // ensure proper object reference
            $data[$key] = $node->getData()[$key];
        }

        $item = $factory->make($this->target, $data, Node::MANAGED);
        $node->setRelation($this->getName(), $item);

        return $item;
    }

    public function cast(?array $data): ?array
    {
        return $data === null

            ? null
            : $this->mapperProvider->getMapper($this->target)->cast($data);
    }

    public function collect(mixed $data): ?object
    {
        \assert($data === null || \is_object($data));
        return $data;
    }

    public function initReference(Node $node): ReferenceInterface
    {
        $scope = $this->getReferenceScope($node);
        if ($scope === null) {
            $result = new Reference($this->target, []);
            $result->setValue(null);
            return $result;
        }
        return $scope === [] ? new EmptyReference($this->target, null) : new Reference($this->target, $scope);
    }

    public function prepare(Pool $pool, Tuple $tuple, mixed $related, bool $load = true): void
    {
        // $related = $tuple->state->getRelation($this->getName());
        // $pool->attach($related, Tuple::TASK_STORE, false);
    }

    public function queue(Pool $pool, Tuple $tuple, ?StoreCommandInterface $command = null): void
    {
        if ($tuple->task !== Tuple::TASK_STORE) {
            return;
        }

        if (!$tuple->state->hasRelation($this->getName())) {
            $tuple->state->setRelationStatus($this->getName(), RelationInterface::STATUS_RESOLVED);
            return;
        }

        $related = $tuple->state->getRelation($this->getName());

        // Master Node
        $original = $tuple->node->getRelation($this->getName());

        if ($related instanceof ReferenceInterface) {
            if ($related === $original) {
                if (!$related->hasValue() || $this->resolve($related, false) === null) {
                    // do not update non resolved and non changed promises
                    return;
                }
                $related = $related->getValue();
            } else {
                // do not affect parent embeddings
                $related = clone $this->resolve($related, true);
            }
        }

        if ($related === null) {
            throw new NullException("Embedded relation `{$this->name}` can't be null.");
        }
        $tuple->state->setRelation($this->getName(), $related);

        $rTuple = $pool->attach($related, Tuple::TASK_STORE, false);
        // calculate embedded node changes
        $changes = $this->getChanges($related, $rTuple->state);
        foreach ($this->primaryKeys as $key) {
            if (isset($changes[$key])) {
                $rTuple->state->register($key, $changes[$key]);
            }
        }

        if ($command !== null) {
            $mapper = $this->mapperProvider->getMapper($this->target);
            $changes = $mapper->uncast($changes);
            foreach ($mapper->mapColumns($changes) as $field => $value) {
                $command->registerColumn($field, $value);
            }
        }
        $rTuple->state->setStatus(Node::MANAGED);
        $rTuple->state->updateTransactionData();

        $tuple->state->setRelationStatus($this->getName(), RelationInterface::STATUS_RESOLVED);
        $tuple->state->setRelationStatus($rTuple->node->getRole() . ':' . $this->getName(), RelationInterface::STATUS_RESOLVED);
    }

    /**
     * Resolve the reference to the object.
     */
    public function resolve(ReferenceInterface $reference, bool $load): ?object
    {
        if ($reference->hasValue()) {
            return $reference->getValue();
        }

        $result = $this->entityProvider->get($reference->getRole(), $reference->getScope(), $load);
        if ($load === true || $result !== null) {
            $reference->setValue($result);
        }
        return $result;
    }

    private function getReferenceScope(Node $node): ?array
    {
        $scope = [];
        $nodeData = $node->getData();
        foreach ($this->primaryKeys as $key) {
            $value = $nodeData[$key] ?? null;
            if (empty($value)) {
                return null;
            }
            $scope[$key] = $value;
        }
        return $scope;
    }

    private function getChanges(object $related, State $state): array
    {
        $data = \array_intersect_key($this->mapper->extract($related), $this->columns);
        // Embedded entity does not override PK values of the parent
        foreach ($this->primaryKeys as $key) {
            unset($data[$key]);
        }

        return \array_udiff_assoc($data, $state->getTransactionData(), [Node::class, 'compare']);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Cycle\ORM\Relation;
6
7		use Cycle\ORM\Command\StoreCommandInterface;
8		use Cycle\ORM\Exception\Relation\NullException;
9		use Cycle\ORM\Heap\Node;
10		use Cycle\ORM\Heap\State;
11		use Cycle\ORM\MapperInterface;
12		use Cycle\ORM\ORMInterface;
13		use Cycle\ORM\Reference\EmptyReference;
14		use Cycle\ORM\Reference\Reference;
15		use Cycle\ORM\Reference\ReferenceInterface;
16		use Cycle\ORM\SchemaInterface;
17		use Cycle\ORM\Service\EntityFactoryInterface;
18		use Cycle\ORM\Service\EntityProviderInterface;
19		use Cycle\ORM\Service\MapperProviderInterface;
20		use Cycle\ORM\Transaction\Pool;
21		use Cycle\ORM\Transaction\Tuple;
22
23		/**
24		* Embeds one object to another.
25		*
26		* @internal
27		*/
28		final class Embedded implements SameRowRelationInterface
29		{
30		private MapperInterface $mapper;
31		private MapperProviderInterface $mapperProvider;
32		private EntityProviderInterface $entityProvider;
33
34		/** @var string[] */
35		private array $primaryKeys;
36
37		private array $columns;
38
39	344	public function __construct(
40		/** @internal */
41		ORMInterface $orm,
42		private string $name,
43		private string $target,
44		) {
45	344	$this->mapperProvider = $orm->getService(MapperProviderInterface::class);
46	344	$this->entityProvider = $orm->getService(EntityProviderInterface::class);
47	344	$this->mapper = $this->mapperProvider->getMapper($target);
48
49		// this relation must manage column association manually, bypassing related mapper
50	344	$this->primaryKeys = (array) $orm->getSchema()->define($target, SchemaInterface::PRIMARY_KEY);
51	344	$this->columns = $orm->getSchema()->define($target, SchemaInterface::COLUMNS);
52		}
53
54	216	public function getName(): string
55		{
56	216	return $this->name;
57		}
58
59		public function getInnerKeys(): array
60		{
61		return $this->primaryKeys;
62		}
63
64		public function getTarget(): string
65		{
66		return $this->target;
67		}
68
69		public function isCascade(): bool
70		{
71		// always cascade
72		return true;
73		}
74
75	168	public function init(EntityFactoryInterface $factory, Node $node, array $data): object
76		{
77	168	foreach ($this->primaryKeys as $key) {
78		// ensure proper object reference
79	168	$data[$key] = $node->getData()[$key];
80		}
81
82	168	$item = $factory->make($this->target, $data, Node::MANAGED);
83	168	$node->setRelation($this->getName(), $item);
84
85	168	return $item;
86		}
87
88	264	public function cast(?array $data): ?array
89		{
90	264	return $data === null
		0 ignored issues – show introduced 2022-01-10 12:45 UTC by Report Bug Copy Issue Report The condition `$data === null` is always `false`. Loading history...
91		? null
92	264	: $this->mapperProvider->getMapper($this->target)->cast($data);
93		}
94
95	32	public function collect(mixed $data): ?object
96		{
97		\assert($data === null \|\| \is_object($data));
98	32	return $data;
99		}
100
101	120	public function initReference(Node $node): ReferenceInterface
102		{
103	120	$scope = $this->getReferenceScope($node);
104	120	if ($scope === null) {
105		$result = new Reference($this->target, []);
106		$result->setValue(null);
107		return $result;
108		}
109	120	return $scope === [] ? new EmptyReference($this->target, null) : new Reference($this->target, $scope);
110		}
111
112	120	public function prepare(Pool $pool, Tuple $tuple, mixed $related, bool $load = true): void
113		{
114	120	// $related = $tuple->state->getRelation($this->getName());
115	120	// $pool->attach($related, Tuple::TASK_STORE, false);
116	120	}
117	120
118	120	public function queue(Pool $pool, Tuple $tuple, ?StoreCommandInterface $command = null): void
119		{
120		if ($tuple->task !== Tuple::TASK_STORE) {
121	120	return;
122		}
123	120
124		if (!$tuple->state->hasRelation($this->getName())) {
125		$tuple->state->setRelationStatus($this->getName(), RelationInterface::STATUS_RESOLVED);
126		return;
127		}
128
129		$related = $tuple->state->getRelation($this->getName());
130
131		// Master Node
132	168	$original = $tuple->node->getRelation($this->getName());
133
134	168	if ($related instanceof ReferenceInterface) {
135		if ($related === $original) {
136		if (!$related->hasValue() \|\| $this->resolve($related, false) === null) {
137	168	// do not update non resolved and non changed promises
138		return;
139		}
140	168	$related = $related->getValue();
141		} else {
142	168	// do not affect parent embeddings
143	56	$related = clone $this->resolve($related, true);
144	32	}
145		}
146	32
147		if ($related === null) {
148		throw new NullException("Embedded relation `{$this->name}` can't be null.");
149		}
150		$tuple->state->setRelation($this->getName(), $related);
151	24
152		$rTuple = $pool->attach($related, Tuple::TASK_STORE, false);
153		// calculate embedded node changes
154		$changes = $this->getChanges($related, $rTuple->state);
155	136	foreach ($this->primaryKeys as $key) {
156	16	if (isset($changes[$key])) {
157		$rTuple->state->register($key, $changes[$key]);
158	120	}
159		}
160	120
161		if ($command !== null) {
162	120	$mapper = $this->mapperProvider->getMapper($this->target);
163	120	$changes = $mapper->uncast($changes);
164	120	foreach ($mapper->mapColumns($changes) as $field => $value) {
165		$command->registerColumn($field, $value);
166		}
167		}
168		$rTuple->state->setStatus(Node::MANAGED);
169	120	$rTuple->state->updateTransactionData();
170	120
171	120	$tuple->state->setRelationStatus($this->getName(), RelationInterface::STATUS_RESOLVED);
172	120	$tuple->state->setRelationStatus($rTuple->node->getRole() . ':' . $this->getName(), RelationInterface::STATUS_RESOLVED);
173	104	}
174
175		/**
176	120	* Resolve the reference to the object.
177	120	*/
178		public function resolve(ReferenceInterface $reference, bool $load): ?object
179	120	{
180	120	if ($reference->hasValue()) {
181		return $reference->getValue();
182		}
183	120
184		$result = $this->entityProvider->get($reference->getRole(), $reference->getScope(), $load);
185	120	if ($load === true \|\| $result !== null) {
186		$reference->setValue($result);
187	120	}
188	120	return $result;
189		}
190
191	120	private function getReferenceScope(Node $node): ?array
192		{
193		$scope = [];
194		$nodeData = $node->getData();
195		foreach ($this->primaryKeys as $key) {
196		$value = $nodeData[$key] ?? null;
197	56	if (empty($value)) {
198		return null;
199	56	}
200	8	$scope[$key] = $value;
201		}
202		return $scope;
203	48	}
204	48
205	48	private function getChanges(object $related, State $state): array
206		{
207	48	$data = \array_intersect_key($this->mapper->extract($related), $this->columns);
208		// Embedded entity does not override PK values of the parent
209		foreach ($this->primaryKeys as $key) {
210		unset($data[$key]);
211		}
212
213		return \array_udiff_assoc($data, $state->getTransactionData(), [Node::class, 'compare']);
214		}
215		}
216

cycle / orm

Pull Request — 2.x (#517)

Embedded::getReferenceScope() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like