-
Notifications
You must be signed in to change notification settings - Fork 351
/
MetadataProvider.php
176 lines (159 loc) · 5.27 KB
/
MetadataProvider.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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
<?php
namespace Oro\Bundle\ApiBundle\Provider;
use Oro\Bundle\ApiBundle\Config\EntityDefinitionConfig;
use Oro\Bundle\ApiBundle\Metadata\EntityMetadata;
use Oro\Bundle\ApiBundle\Metadata\MetadataExtraInterface;
use Oro\Bundle\ApiBundle\Processor\GetMetadata\MetadataContext;
use Oro\Bundle\ApiBundle\Request\RequestType;
use Oro\Component\ChainProcessor\ActionProcessorInterface;
/**
* Provides the metadata for a specific Data API resource.
*/
class MetadataProvider
{
/** @var ActionProcessorInterface */
private $processor;
/** @var array */
private $cache = [];
/**
* @param ActionProcessorInterface $processor
*/
public function __construct(ActionProcessorInterface $processor)
{
$this->processor = $processor;
}
/**
* Gets metadata for the given version of an entity.
*
* @param string $className The FQCN of an entity
* @param string $version The version of a config
* @param RequestType $requestType The request type, for example "rest", "soap", etc.
* @param EntityDefinitionConfig $config The configuration of an entity
* @param MetadataExtraInterface[] $extras Requests for additional metadata information
* @param bool $withExcludedProperties Whether excluded fields and associations
* should not be removed
*
* @return EntityMetadata|null
*/
public function getMetadata(
string $className,
string $version,
RequestType $requestType,
EntityDefinitionConfig $config,
array $extras = [],
bool $withExcludedProperties = false
): ?EntityMetadata {
if (empty($className)) {
throw new \InvalidArgumentException('$className must not be empty.');
}
$configKey = $config->getKey();
if (!$configKey) {
return $this->loadMetadata(
$className,
$version,
$requestType,
$config,
$extras,
$withExcludedProperties
);
}
$cacheKey = $this->buildCacheKey(
$className,
$version,
$requestType,
$extras,
$withExcludedProperties,
$configKey
);
if (array_key_exists($cacheKey, $this->cache)) {
$metadata = $this->cache[$cacheKey];
} else {
$metadata = $this->loadMetadata(
$className,
$version,
$requestType,
$config,
$extras,
$withExcludedProperties
);
$this->cache[$cacheKey] = $metadata;
}
if (null === $metadata) {
return null;
}
return clone $metadata;
}
/**
* Removes all already built metadatas from the internal cache.
*/
public function clearCache(): void
{
$this->cache = [];
}
/**
* @param string $className
* @param string $version
* @param RequestType $requestType
* @param EntityDefinitionConfig $config
* @param MetadataExtraInterface[] $extras
* @param bool $withExcludedProperties
*
* @return EntityMetadata|null
*/
private function loadMetadata(
string $className,
string $version,
RequestType $requestType,
EntityDefinitionConfig $config,
array $extras,
bool $withExcludedProperties
): ?EntityMetadata {
/** @var MetadataContext $context */
$context = $this->processor->createContext();
$context->setClassName($className);
$context->setVersion($version);
$context->getRequestType()->set($requestType);
$context->setConfig($config);
if (!empty($extras)) {
$context->setExtras($extras);
}
$context->setWithExcludedProperties($withExcludedProperties);
$this->processor->process($context);
$result = null;
if ($context->hasResult()) {
$result = $context->getResult();
}
return $result;
}
/**
* @param string $className
* @param string $version
* @param RequestType $requestType
* @param MetadataExtraInterface[] $extras
* @param bool $withExcludedProperties
* @param string $configKey
*
* @return string
*/
private function buildCacheKey(
string $className,
string $version,
RequestType $requestType,
array $extras,
bool $withExcludedProperties,
string $configKey
): string {
$cacheKey = (string)$requestType
. '|' . $version
. '|' . $className
. '|' . ($withExcludedProperties ? '1' : '0');
foreach ($extras as $extra) {
$part = $extra->getCacheKeyPart();
if (!empty($part)) {
$cacheKey .= '|' . $part;
}
}
$cacheKey .= '|' . $configKey;
return $cacheKey;
}
}