Chris@0
|
1 <?php
|
Chris@0
|
2
|
Chris@0
|
3 /*
|
Chris@0
|
4 * This file is part of the Symfony package.
|
Chris@0
|
5 *
|
Chris@0
|
6 * (c) Fabien Potencier <fabien@symfony.com>
|
Chris@0
|
7 *
|
Chris@0
|
8 * For the full copyright and license information, please view the LICENSE
|
Chris@0
|
9 * file that was distributed with this source code.
|
Chris@0
|
10 */
|
Chris@0
|
11
|
Chris@0
|
12 namespace Symfony\Component\DependencyInjection\Dumper;
|
Chris@0
|
13
|
Chris@0
|
14 use Symfony\Component\DependencyInjection\Alias;
|
Chris@14
|
15 use Symfony\Component\DependencyInjection\Argument\ArgumentInterface;
|
Chris@14
|
16 use Symfony\Component\DependencyInjection\Argument\IteratorArgument;
|
Chris@14
|
17 use Symfony\Component\DependencyInjection\Argument\ServiceClosureArgument;
|
Chris@14
|
18 use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
|
Chris@0
|
19 use Symfony\Component\DependencyInjection\ContainerInterface;
|
Chris@0
|
20 use Symfony\Component\DependencyInjection\Definition;
|
Chris@17
|
21 use Symfony\Component\DependencyInjection\Exception\RuntimeException;
|
Chris@0
|
22 use Symfony\Component\DependencyInjection\Parameter;
|
Chris@0
|
23 use Symfony\Component\DependencyInjection\Reference;
|
Chris@0
|
24 use Symfony\Component\ExpressionLanguage\Expression;
|
Chris@17
|
25 use Symfony\Component\Yaml\Dumper as YmlDumper;
|
Chris@17
|
26 use Symfony\Component\Yaml\Parser;
|
Chris@17
|
27 use Symfony\Component\Yaml\Tag\TaggedValue;
|
Chris@17
|
28 use Symfony\Component\Yaml\Yaml;
|
Chris@0
|
29
|
Chris@0
|
30 /**
|
Chris@0
|
31 * YamlDumper dumps a service container as a YAML string.
|
Chris@0
|
32 *
|
Chris@0
|
33 * @author Fabien Potencier <fabien@symfony.com>
|
Chris@0
|
34 */
|
Chris@0
|
35 class YamlDumper extends Dumper
|
Chris@0
|
36 {
|
Chris@0
|
37 private $dumper;
|
Chris@0
|
38
|
Chris@0
|
39 /**
|
Chris@0
|
40 * Dumps the service container as an YAML string.
|
Chris@0
|
41 *
|
Chris@0
|
42 * @return string A YAML string representing of the service container
|
Chris@0
|
43 */
|
Chris@17
|
44 public function dump(array $options = [])
|
Chris@0
|
45 {
|
Chris@0
|
46 if (!class_exists('Symfony\Component\Yaml\Dumper')) {
|
Chris@0
|
47 throw new RuntimeException('Unable to dump the container as the Symfony Yaml Component is not installed.');
|
Chris@0
|
48 }
|
Chris@0
|
49
|
Chris@0
|
50 if (null === $this->dumper) {
|
Chris@0
|
51 $this->dumper = new YmlDumper();
|
Chris@0
|
52 }
|
Chris@0
|
53
|
Chris@0
|
54 return $this->container->resolveEnvPlaceholders($this->addParameters()."\n".$this->addServices());
|
Chris@0
|
55 }
|
Chris@0
|
56
|
Chris@0
|
57 /**
|
Chris@0
|
58 * Adds a service.
|
Chris@0
|
59 *
|
Chris@0
|
60 * @param string $id
|
Chris@0
|
61 * @param Definition $definition
|
Chris@0
|
62 *
|
Chris@0
|
63 * @return string
|
Chris@0
|
64 */
|
Chris@14
|
65 private function addService($id, Definition $definition)
|
Chris@0
|
66 {
|
Chris@0
|
67 $code = " $id:\n";
|
Chris@0
|
68 if ($class = $definition->getClass()) {
|
Chris@0
|
69 if ('\\' === substr($class, 0, 1)) {
|
Chris@0
|
70 $class = substr($class, 1);
|
Chris@0
|
71 }
|
Chris@0
|
72
|
Chris@0
|
73 $code .= sprintf(" class: %s\n", $this->dumper->dump($class));
|
Chris@0
|
74 }
|
Chris@0
|
75
|
Chris@14
|
76 if (!$definition->isPrivate()) {
|
Chris@14
|
77 $code .= sprintf(" public: %s\n", $definition->isPublic() ? 'true' : 'false');
|
Chris@0
|
78 }
|
Chris@0
|
79
|
Chris@0
|
80 $tagsCode = '';
|
Chris@0
|
81 foreach ($definition->getTags() as $name => $tags) {
|
Chris@0
|
82 foreach ($tags as $attributes) {
|
Chris@17
|
83 $att = [];
|
Chris@0
|
84 foreach ($attributes as $key => $value) {
|
Chris@0
|
85 $att[] = sprintf('%s: %s', $this->dumper->dump($key), $this->dumper->dump($value));
|
Chris@0
|
86 }
|
Chris@0
|
87 $att = $att ? ', '.implode(', ', $att) : '';
|
Chris@0
|
88
|
Chris@0
|
89 $tagsCode .= sprintf(" - { name: %s%s }\n", $this->dumper->dump($name), $att);
|
Chris@0
|
90 }
|
Chris@0
|
91 }
|
Chris@0
|
92 if ($tagsCode) {
|
Chris@0
|
93 $code .= " tags:\n".$tagsCode;
|
Chris@0
|
94 }
|
Chris@0
|
95
|
Chris@0
|
96 if ($definition->getFile()) {
|
Chris@0
|
97 $code .= sprintf(" file: %s\n", $this->dumper->dump($definition->getFile()));
|
Chris@0
|
98 }
|
Chris@0
|
99
|
Chris@0
|
100 if ($definition->isSynthetic()) {
|
Chris@0
|
101 $code .= " synthetic: true\n";
|
Chris@0
|
102 }
|
Chris@0
|
103
|
Chris@0
|
104 if ($definition->isDeprecated()) {
|
Chris@17
|
105 $code .= sprintf(" deprecated: %s\n", $this->dumper->dump($definition->getDeprecationMessage('%service_id%')));
|
Chris@0
|
106 }
|
Chris@0
|
107
|
Chris@0
|
108 if ($definition->isAutowired()) {
|
Chris@0
|
109 $code .= " autowire: true\n";
|
Chris@0
|
110 }
|
Chris@0
|
111
|
Chris@0
|
112 $autowiringTypesCode = '';
|
Chris@14
|
113 foreach ($definition->getAutowiringTypes(false) as $autowiringType) {
|
Chris@0
|
114 $autowiringTypesCode .= sprintf(" - %s\n", $this->dumper->dump($autowiringType));
|
Chris@0
|
115 }
|
Chris@0
|
116 if ($autowiringTypesCode) {
|
Chris@0
|
117 $code .= sprintf(" autowiring_types:\n%s", $autowiringTypesCode);
|
Chris@0
|
118 }
|
Chris@0
|
119
|
Chris@14
|
120 if ($definition->isAutoconfigured()) {
|
Chris@14
|
121 $code .= " autoconfigure: true\n";
|
Chris@14
|
122 }
|
Chris@14
|
123
|
Chris@14
|
124 if ($definition->isAbstract()) {
|
Chris@14
|
125 $code .= " abstract: true\n";
|
Chris@14
|
126 }
|
Chris@14
|
127
|
Chris@0
|
128 if ($definition->isLazy()) {
|
Chris@0
|
129 $code .= " lazy: true\n";
|
Chris@0
|
130 }
|
Chris@0
|
131
|
Chris@0
|
132 if ($definition->getArguments()) {
|
Chris@0
|
133 $code .= sprintf(" arguments: %s\n", $this->dumper->dump($this->dumpValue($definition->getArguments()), 0));
|
Chris@0
|
134 }
|
Chris@0
|
135
|
Chris@0
|
136 if ($definition->getProperties()) {
|
Chris@0
|
137 $code .= sprintf(" properties: %s\n", $this->dumper->dump($this->dumpValue($definition->getProperties()), 0));
|
Chris@0
|
138 }
|
Chris@0
|
139
|
Chris@0
|
140 if ($definition->getMethodCalls()) {
|
Chris@0
|
141 $code .= sprintf(" calls:\n%s\n", $this->dumper->dump($this->dumpValue($definition->getMethodCalls()), 1, 12));
|
Chris@0
|
142 }
|
Chris@0
|
143
|
Chris@0
|
144 if (!$definition->isShared()) {
|
Chris@0
|
145 $code .= " shared: false\n";
|
Chris@0
|
146 }
|
Chris@0
|
147
|
Chris@0
|
148 if (null !== $decorated = $definition->getDecoratedService()) {
|
Chris@0
|
149 list($decorated, $renamedId, $priority) = $decorated;
|
Chris@0
|
150 $code .= sprintf(" decorates: %s\n", $decorated);
|
Chris@0
|
151 if (null !== $renamedId) {
|
Chris@0
|
152 $code .= sprintf(" decoration_inner_name: %s\n", $renamedId);
|
Chris@0
|
153 }
|
Chris@0
|
154 if (0 !== $priority) {
|
Chris@0
|
155 $code .= sprintf(" decoration_priority: %s\n", $priority);
|
Chris@0
|
156 }
|
Chris@0
|
157 }
|
Chris@0
|
158
|
Chris@0
|
159 if ($callable = $definition->getFactory()) {
|
Chris@0
|
160 $code .= sprintf(" factory: %s\n", $this->dumper->dump($this->dumpCallable($callable), 0));
|
Chris@0
|
161 }
|
Chris@0
|
162
|
Chris@0
|
163 if ($callable = $definition->getConfigurator()) {
|
Chris@0
|
164 $code .= sprintf(" configurator: %s\n", $this->dumper->dump($this->dumpCallable($callable), 0));
|
Chris@0
|
165 }
|
Chris@0
|
166
|
Chris@0
|
167 return $code;
|
Chris@0
|
168 }
|
Chris@0
|
169
|
Chris@0
|
170 /**
|
Chris@0
|
171 * Adds a service alias.
|
Chris@0
|
172 *
|
Chris@0
|
173 * @param string $alias
|
Chris@0
|
174 * @param Alias $id
|
Chris@0
|
175 *
|
Chris@0
|
176 * @return string
|
Chris@0
|
177 */
|
Chris@14
|
178 private function addServiceAlias($alias, Alias $id)
|
Chris@0
|
179 {
|
Chris@14
|
180 if ($id->isPrivate()) {
|
Chris@0
|
181 return sprintf(" %s: '@%s'\n", $alias, $id);
|
Chris@0
|
182 }
|
Chris@0
|
183
|
Chris@14
|
184 return sprintf(" %s:\n alias: %s\n public: %s\n", $alias, $id, $id->isPublic() ? 'true' : 'false');
|
Chris@0
|
185 }
|
Chris@0
|
186
|
Chris@0
|
187 /**
|
Chris@0
|
188 * Adds services.
|
Chris@0
|
189 *
|
Chris@0
|
190 * @return string
|
Chris@0
|
191 */
|
Chris@0
|
192 private function addServices()
|
Chris@0
|
193 {
|
Chris@0
|
194 if (!$this->container->getDefinitions()) {
|
Chris@0
|
195 return '';
|
Chris@0
|
196 }
|
Chris@0
|
197
|
Chris@0
|
198 $code = "services:\n";
|
Chris@0
|
199 foreach ($this->container->getDefinitions() as $id => $definition) {
|
Chris@0
|
200 $code .= $this->addService($id, $definition);
|
Chris@0
|
201 }
|
Chris@0
|
202
|
Chris@0
|
203 $aliases = $this->container->getAliases();
|
Chris@0
|
204 foreach ($aliases as $alias => $id) {
|
Chris@0
|
205 while (isset($aliases[(string) $id])) {
|
Chris@0
|
206 $id = $aliases[(string) $id];
|
Chris@0
|
207 }
|
Chris@0
|
208 $code .= $this->addServiceAlias($alias, $id);
|
Chris@0
|
209 }
|
Chris@0
|
210
|
Chris@0
|
211 return $code;
|
Chris@0
|
212 }
|
Chris@0
|
213
|
Chris@0
|
214 /**
|
Chris@0
|
215 * Adds parameters.
|
Chris@0
|
216 *
|
Chris@0
|
217 * @return string
|
Chris@0
|
218 */
|
Chris@0
|
219 private function addParameters()
|
Chris@0
|
220 {
|
Chris@0
|
221 if (!$this->container->getParameterBag()->all()) {
|
Chris@0
|
222 return '';
|
Chris@0
|
223 }
|
Chris@0
|
224
|
Chris@14
|
225 $parameters = $this->prepareParameters($this->container->getParameterBag()->all(), $this->container->isCompiled());
|
Chris@0
|
226
|
Chris@17
|
227 return $this->dumper->dump(['parameters' => $parameters], 2);
|
Chris@0
|
228 }
|
Chris@0
|
229
|
Chris@0
|
230 /**
|
Chris@0
|
231 * Dumps callable to YAML format.
|
Chris@0
|
232 *
|
Chris@0
|
233 * @param callable $callable
|
Chris@0
|
234 *
|
Chris@0
|
235 * @return callable
|
Chris@0
|
236 */
|
Chris@0
|
237 private function dumpCallable($callable)
|
Chris@0
|
238 {
|
Chris@17
|
239 if (\is_array($callable)) {
|
Chris@0
|
240 if ($callable[0] instanceof Reference) {
|
Chris@17
|
241 $callable = [$this->getServiceCall((string) $callable[0], $callable[0]), $callable[1]];
|
Chris@0
|
242 } else {
|
Chris@17
|
243 $callable = [$callable[0], $callable[1]];
|
Chris@0
|
244 }
|
Chris@0
|
245 }
|
Chris@0
|
246
|
Chris@0
|
247 return $callable;
|
Chris@0
|
248 }
|
Chris@0
|
249
|
Chris@0
|
250 /**
|
Chris@0
|
251 * Dumps the value to YAML format.
|
Chris@0
|
252 *
|
Chris@0
|
253 * @param mixed $value
|
Chris@0
|
254 *
|
Chris@0
|
255 * @return mixed
|
Chris@0
|
256 *
|
Chris@0
|
257 * @throws RuntimeException When trying to dump object or resource
|
Chris@0
|
258 */
|
Chris@0
|
259 private function dumpValue($value)
|
Chris@0
|
260 {
|
Chris@14
|
261 if ($value instanceof ServiceClosureArgument) {
|
Chris@14
|
262 $value = $value->getValues()[0];
|
Chris@14
|
263 }
|
Chris@14
|
264 if ($value instanceof ArgumentInterface) {
|
Chris@14
|
265 if ($value instanceof TaggedIteratorArgument) {
|
Chris@14
|
266 return new TaggedValue('tagged', $value->getTag());
|
Chris@14
|
267 }
|
Chris@14
|
268 if ($value instanceof IteratorArgument) {
|
Chris@14
|
269 $tag = 'iterator';
|
Chris@14
|
270 } else {
|
Chris@17
|
271 throw new RuntimeException(sprintf('Unspecified Yaml tag for type "%s".', \get_class($value)));
|
Chris@14
|
272 }
|
Chris@14
|
273
|
Chris@14
|
274 return new TaggedValue($tag, $this->dumpValue($value->getValues()));
|
Chris@14
|
275 }
|
Chris@14
|
276
|
Chris@17
|
277 if (\is_array($value)) {
|
Chris@17
|
278 $code = [];
|
Chris@0
|
279 foreach ($value as $k => $v) {
|
Chris@0
|
280 $code[$k] = $this->dumpValue($v);
|
Chris@0
|
281 }
|
Chris@0
|
282
|
Chris@0
|
283 return $code;
|
Chris@0
|
284 } elseif ($value instanceof Reference) {
|
Chris@0
|
285 return $this->getServiceCall((string) $value, $value);
|
Chris@0
|
286 } elseif ($value instanceof Parameter) {
|
Chris@0
|
287 return $this->getParameterCall((string) $value);
|
Chris@0
|
288 } elseif ($value instanceof Expression) {
|
Chris@0
|
289 return $this->getExpressionCall((string) $value);
|
Chris@14
|
290 } elseif ($value instanceof Definition) {
|
Chris@14
|
291 return new TaggedValue('service', (new Parser())->parse("_:\n".$this->addService('_', $value), Yaml::PARSE_CUSTOM_TAGS)['_']['_']);
|
Chris@17
|
292 } elseif (\is_object($value) || \is_resource($value)) {
|
Chris@0
|
293 throw new RuntimeException('Unable to dump a service container if a parameter is an object or a resource.');
|
Chris@0
|
294 }
|
Chris@0
|
295
|
Chris@0
|
296 return $value;
|
Chris@0
|
297 }
|
Chris@0
|
298
|
Chris@0
|
299 /**
|
Chris@0
|
300 * Gets the service call.
|
Chris@0
|
301 *
|
Chris@0
|
302 * @param string $id
|
Chris@0
|
303 * @param Reference $reference
|
Chris@0
|
304 *
|
Chris@0
|
305 * @return string
|
Chris@0
|
306 */
|
Chris@0
|
307 private function getServiceCall($id, Reference $reference = null)
|
Chris@0
|
308 {
|
Chris@14
|
309 if (null !== $reference) {
|
Chris@14
|
310 switch ($reference->getInvalidBehavior()) {
|
Chris@14
|
311 case ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE: break;
|
Chris@14
|
312 case ContainerInterface::IGNORE_ON_UNINITIALIZED_REFERENCE: return sprintf('@!%s', $id);
|
Chris@14
|
313 default: return sprintf('@?%s', $id);
|
Chris@14
|
314 }
|
Chris@0
|
315 }
|
Chris@0
|
316
|
Chris@0
|
317 return sprintf('@%s', $id);
|
Chris@0
|
318 }
|
Chris@0
|
319
|
Chris@0
|
320 /**
|
Chris@0
|
321 * Gets parameter call.
|
Chris@0
|
322 *
|
Chris@0
|
323 * @param string $id
|
Chris@0
|
324 *
|
Chris@0
|
325 * @return string
|
Chris@0
|
326 */
|
Chris@0
|
327 private function getParameterCall($id)
|
Chris@0
|
328 {
|
Chris@0
|
329 return sprintf('%%%s%%', $id);
|
Chris@0
|
330 }
|
Chris@0
|
331
|
Chris@0
|
332 private function getExpressionCall($expression)
|
Chris@0
|
333 {
|
Chris@0
|
334 return sprintf('@=%s', $expression);
|
Chris@0
|
335 }
|
Chris@0
|
336
|
Chris@0
|
337 /**
|
Chris@0
|
338 * Prepares parameters.
|
Chris@0
|
339 *
|
Chris@0
|
340 * @param array $parameters
|
Chris@0
|
341 * @param bool $escape
|
Chris@0
|
342 *
|
Chris@0
|
343 * @return array
|
Chris@0
|
344 */
|
Chris@0
|
345 private function prepareParameters(array $parameters, $escape = true)
|
Chris@0
|
346 {
|
Chris@17
|
347 $filtered = [];
|
Chris@0
|
348 foreach ($parameters as $key => $value) {
|
Chris@17
|
349 if (\is_array($value)) {
|
Chris@0
|
350 $value = $this->prepareParameters($value, $escape);
|
Chris@17
|
351 } elseif ($value instanceof Reference || \is_string($value) && 0 === strpos($value, '@')) {
|
Chris@0
|
352 $value = '@'.$value;
|
Chris@0
|
353 }
|
Chris@0
|
354
|
Chris@0
|
355 $filtered[$key] = $value;
|
Chris@0
|
356 }
|
Chris@0
|
357
|
Chris@0
|
358 return $escape ? $this->escape($filtered) : $filtered;
|
Chris@0
|
359 }
|
Chris@0
|
360
|
Chris@0
|
361 /**
|
Chris@0
|
362 * Escapes arguments.
|
Chris@0
|
363 *
|
Chris@0
|
364 * @return array
|
Chris@0
|
365 */
|
Chris@0
|
366 private function escape(array $arguments)
|
Chris@0
|
367 {
|
Chris@17
|
368 $args = [];
|
Chris@0
|
369 foreach ($arguments as $k => $v) {
|
Chris@17
|
370 if (\is_array($v)) {
|
Chris@0
|
371 $args[$k] = $this->escape($v);
|
Chris@17
|
372 } elseif (\is_string($v)) {
|
Chris@0
|
373 $args[$k] = str_replace('%', '%%', $v);
|
Chris@0
|
374 } else {
|
Chris@0
|
375 $args[$k] = $v;
|
Chris@0
|
376 }
|
Chris@0
|
377 }
|
Chris@0
|
378
|
Chris@0
|
379 return $args;
|
Chris@0
|
380 }
|
Chris@0
|
381 }
|