-
-
Notifications
You must be signed in to change notification settings - Fork 71
/
RootLoader.php
157 lines (134 loc) · 3.97 KB
/
RootLoader.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
<?php
declare(strict_types=1);
namespace Cycle\ORM\Select;
use Cycle\Database\Query\SelectQuery;
use Cycle\Database\StatementInterface;
use Cycle\ORM\FactoryInterface;
use Cycle\ORM\Parser\AbstractNode;
use Cycle\ORM\Parser\RootNode;
use Cycle\ORM\Service\SourceProviderInterface;
use Cycle\ORM\SchemaInterface;
use Cycle\ORM\Select\Traits\ColumnsTrait;
use Cycle\ORM\Select\Traits\ScopeTrait;
/**
* Primary ORM loader. Loader wraps at top of select query in order to modify it's conditions, joins
* and etc based on nested loaders.
*
* Root load does not load constrain from ORM by default.
*
* @method RootNode createNode()
*
* @internal
*/
final class RootLoader extends AbstractLoader
{
use ColumnsTrait;
use ScopeTrait;
/** @var array */
protected array $options = [
'load' => true,
'scope' => true,
];
private SelectQuery $query;
/**
* @param bool $loadRelations Define loading eager relations and JTI hierarchy.
*/
public function __construct(
SchemaInterface $ormSchema,
SourceProviderInterface $sourceProvider,
FactoryInterface $factory,
string $target,
bool $loadRelations = true,
) {
parent::__construct($ormSchema, $sourceProvider, $factory, $target);
$this->query = $this->source->getDatabase()->select()->from(
sprintf('%s AS %s', $this->source->getTable(), $this->getAlias())
);
$this->columns = $this->normalizeColumns($this->define(SchemaInterface::COLUMNS));
if ($loadRelations) {
foreach ($this->getEagerLoaders() as $relation) {
$this->loadRelation($relation, [], false, true);
}
}
}
/**
* Clone the underlying query.
*/
public function __clone()
{
$this->query = clone $this->query;
parent::__clone();
}
public function getAlias(): string
{
return $this->target;
}
/**
* Primary column name list with table name like `table.column`.
*
* @return string|string[]
*/
public function getPK(): array|string
{
$pk = $this->define(SchemaInterface::PRIMARY_KEY);
if (\is_array($pk)) {
$result = [];
foreach ($pk as $key) {
$result[] = $this->getAlias() . '.' . $this->fieldAlias($key);
}
return $result;
}
return $this->getAlias() . '.' . $this->fieldAlias($pk);
}
/**
* Get list of primary fields.
*
* @return list<non-empty-string>
*/
public function getPrimaryFields(): array
{
return (array)$this->define(SchemaInterface::PRIMARY_KEY);
}
/**
* Return base query associated with the loader.
*/
public function getQuery(): SelectQuery
{
return $this->query;
}
/**
* Compile query with all needed conditions, columns and etc.
*/
public function buildQuery(): SelectQuery
{
return $this->configureQuery(clone $this->query);
}
public function loadData(AbstractNode $node, bool $includeRole = false): void
{
$statement = $this->buildQuery()->run();
foreach ($statement->fetchAll(StatementInterface::FETCH_NUM) as $row) {
$node->parseRow(0, $row);
}
$statement->close();
// loading child datasets
foreach ($this->load as $relation => $loader) {
$loader->loadData($node->getNode($relation), $includeRole);
}
$this->loadHierarchy($node, $includeRole);
}
public function isLoaded(): bool
{
// root loader is always loaded
return true;
}
protected function configureQuery(SelectQuery $query): SelectQuery
{
return parent::configureQuery(
$this->mountColumns($query, true, '', true)
);
}
protected function initNode(): RootNode
{
return new RootNode($this->columnNames(), (array)$this->define(SchemaInterface::PRIMARY_KEY));
}
}