forked from nette/nette
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ContainerBuilder.php
577 lines (465 loc) · 16.4 KB
/
ContainerBuilder.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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
<?php
/**
* This file is part of the Nette Framework (http://nette.org)
*
* Copyright (c) 2004 David Grudl (http://davidgrudl.com)
*
* For the full copyright and license information, please view
* the file license.txt that was distributed with this source code.
*/
namespace Nette\DI;
use Nette,
Nette\Utils\Validators,
Nette\Utils\Strings,
Nette\Utils\PhpGenerator\Helpers as PhpHelpers,
Nette\Utils\PhpGenerator\PhpLiteral;
/**
* Basic container builder.
*
* @author David Grudl
* @property-read array $definitions
* @property-read array $dependencies
*/
class ContainerBuilder extends Nette\Object
{
const CREATED_SERVICE = 'self',
THIS_CONTAINER = 'container';
/** @var array %param% will be expanded */
public $parameters = array();
/** @var array of ServiceDefinition */
private $definitions = array();
/** @var array for auto-wiring */
private $classes;
/** @var array of file names */
private $dependencies = array();
/**
* Adds new service definition. The expressions %param% and @service will be expanded.
* @param string
* @return ServiceDefinition
*/
public function addDefinition($name)
{
if (isset($this->definitions[$name])) {
throw new Nette\InvalidStateException("Service '$name' has already been added.");
}
return $this->definitions[$name] = new ServiceDefinition;
}
/**
* Removes the specified service definition.
* @param string
* @return void
*/
public function removeDefinition($name)
{
unset($this->definitions[$name]);
}
/**
* Gets the service definition.
* @param string
* @return ServiceDefinition
*/
public function getDefinition($name)
{
if (!isset($this->definitions[$name])) {
throw new MissingServiceException("Service '$name' not found.");
}
return $this->definitions[$name];
}
/**
* Gets all service definitions.
* @return array
*/
public function getDefinitions()
{
return $this->definitions;
}
/**
* Does the service definition exist?
* @param string
* @return bool
*/
public function hasDefinition($name)
{
return isset($this->definitions[$name]);
}
/********************* class resolving ****************d*g**/
/**
* Resolves service name by type.
* @param string class or interface
* @return string service name or NULL
* @throws ServiceCreationException
*/
public function getByType($class)
{
$lower = ltrim(strtolower($class), '\\');
if (!isset($this->classes[$lower])) {
return;
} elseif (count($this->classes[$lower]) === 1) {
return $this->classes[$lower][0];
} else {
throw new ServiceCreationException("Multiple services of type $class found: " . implode(', ', $this->classes[$lower]));
}
}
/**
* Gets the service objects of the specified tag.
* @param string
* @return array of [service name => tag attributes]
*/
public function findByTag($tag)
{
$found = array();
foreach ($this->definitions as $name => $def) {
if (isset($def->tags[$tag]) && $def->shared) {
$found[$name] = $def->tags[$tag];
}
}
return $found;
}
/**
* Creates a list of arguments using autowiring.
* @return array
*/
public function autowireArguments($class, $method, array $arguments)
{
$rc = Nette\Reflection\ClassType::from($class);
if (!$rc->hasMethod($method)) {
if (!Nette\Utils\Validators::isList($arguments)) {
throw new ServiceCreationException("Unable to pass specified arguments to $class::$method().");
}
return $arguments;
}
$rm = $rc->getMethod($method);
if ($rm->isAbstract() || !$rm->isPublic()) {
throw new ServiceCreationException("$rm is not callable.");
}
$this->addDependency($rm->getFileName());
return Helpers::autowireArguments($rm, $arguments, $this);
}
/**
* Generates $dependencies, $classes and expands and normalize class names.
* @return array
*/
public function prepareClassList()
{
// complete class-factory pairs; expand classes
foreach ($this->definitions as $name => $def) {
if ($def->class) {
$def->class = $def->class === self::CREATED_SERVICE ? $name : $this->expand($def->class);
if (!$def->factory) {
$def->factory = new Statement($def->class);
}
} elseif (!$def->factory) {
throw new ServiceCreationException("Class and factory are missing in service '$name' definition.");
}
if ($def->factory && $def->factory->entity === self::CREATED_SERVICE) {
$def->factory->entity = $name;
}
}
// complete classes
$this->classes = FALSE;
foreach ($this->definitions as $name => $def) {
$this->resolveClass($name);
}
// build auto-wiring list
$this->classes = array();
foreach ($this->definitions as $name => $def) {
if (!$def->class) {
continue;
}
if (!class_exists($def->class) && !interface_exists($def->class)) {
throw new Nette\InvalidStateException("Class $def->class has not been found.");
}
$def->class = Nette\Reflection\ClassType::from($def->class)->getName();
if ($def->autowired) {
foreach (class_parents($def->class) + class_implements($def->class) + array($def->class) as $parent) {
$this->classes[strtolower($parent)][] = $name;
}
}
}
foreach ($this->classes as $class => $foo) {
$this->addDependency(Nette\Reflection\ClassType::from($class)->getFileName());
}
}
private function resolveClass($name, $recursive = array())
{
if (isset($recursive[$name])) {
throw new Nette\InvalidArgumentException('Circular reference detected for services: ' . implode(', ', array_keys($recursive)) . '.');
}
$recursive[$name] = TRUE;
$def = $this->definitions[$name];
$factory = $this->normalizeEntity($this->expand($def->factory->entity));
if ($def->class) {
return $def->class;
} elseif (is_array($factory)) { // method calling
if ($service = $this->getServiceName($factory[0])) {
if (Strings::contains($service, '\\')) { // @\Class
throw new ServiceCreationException("Unable resolve class name for service '$name'.");
}
$factory[0] = $this->resolveClass($service, $recursive);
if (!$factory[0]) {
return;
}
}
$factory = callback($factory);
if (!$factory->isCallable()) {
throw new Nette\InvalidStateException("Factory '$factory' is not callable.");
}
try {
$reflection = $factory->toReflection();
$def->class = preg_replace('#[|\s].*#', '', $reflection->getAnnotation('return'));
if ($def->class && !class_exists($def->class) && $def->class[0] !== '\\' && $reflection instanceof \ReflectionMethod) {
/**/$def->class = $reflection->getDeclaringClass()->getNamespaceName() . '\\' . $def->class;/**/
}
} catch (\ReflectionException $e) {
}
} elseif ($service = $this->getServiceName($factory)) { // alias or factory
if (Strings::contains($service, '\\')) { // @\Class
/*5.2* $service = ltrim($service, '\\');*/
$def->autowired = FALSE;
return $def->class = $service;
}
if ($this->definitions[$service]->shared) {
$def->autowired = FALSE;
}
return $def->class = $this->resolveClass($service, $recursive);
} else {
return $def->class = $factory; // class name
}
}
/**
* Adds a file to the list of dependencies.
* @return ContainerBuilder provides a fluent interface
*/
public function addDependency($file)
{
$this->dependencies[$file] = TRUE;
return $this;
}
/**
* Returns the list of dependent files.
* @return array
*/
public function getDependencies()
{
unset($this->dependencies[FALSE]);
return array_keys($this->dependencies);
}
/********************* code generator ****************d*g**/
/**
* Generates PHP class.
* @return Nette\Utils\PhpGenerator\ClassType
*/
public function generateClass($parentClass = 'Nette\DI\Container')
{
unset($this->definitions[self::THIS_CONTAINER]);
$this->addDefinition(self::THIS_CONTAINER)->setClass($parentClass);
$this->prepareClassList();
$class = new Nette\Utils\PhpGenerator\ClassType('Container');
$class->addExtend($parentClass);
$class->addMethod('__construct')
->addBody('parent::__construct(?);', array($this->expand($this->parameters)));
$classes = $class->addProperty('classes', array());
foreach ($this->classes as $name => $foo) {
try {
$classes->value[$name] = $this->getByType($name);
} catch (ServiceCreationException $e) {
$classes->value[$name] = new PhpLiteral('FALSE, //' . strstr($e->getMessage(), ':'));
}
}
$definitions = $this->definitions;
ksort($definitions);
$meta = $class->addProperty('meta', array());
foreach ($definitions as $name => $def) {
if ($def->shared) {
foreach ($this->expand($def->tags) as $tag => $value) {
$meta->value[$name][Container::TAGS][$tag] = $value;
}
}
}
foreach ($definitions as $name => $def) {
try {
$type = $def->class ?: 'object';
$methodName = Container::getMethodName($name, $def->shared);
if (!PhpHelpers::isIdentifier($methodName)) {
throw new ServiceCreationException('Name contains invalid characters.');
}
if ($def->shared && PhpHelpers::isIdentifier($name)) {
$class->addDocument("@property $type \$$name");
}
$method = $class->addMethod($methodName)
->addDocument("@return $type")
->setVisibility($def->shared || $def->internal ? 'protected' : 'public')
->setBody($name === self::THIS_CONTAINER ? 'return $this;' : $this->generateService($name));
foreach ($this->expand($def->parameters) as $k => $v) {
$tmp = explode(' ', is_int($k) ? $v : $k);
$param = is_int($k) ? $method->addParameter(end($tmp)) : $method->addParameter(end($tmp), $v);
if (isset($tmp[1])) {
$param->setTypeHint($tmp[0]);
}
}
} catch (\Exception $e) {
throw new ServiceCreationException("Service '$name': " . $e->getMessage()/**/, NULL, $e/**/);
}
}
return $class;
}
/**
* Generates body of service method.
* @return string
*/
private function generateService($name)
{
$def = $this->definitions[$name];
$parameters = $this->parameters;
foreach ($this->expand($def->parameters) as $k => $v) {
$v = explode(' ', is_int($k) ? $v : $k);
$parameters[end($v)] = new PhpLiteral('$' . end($v));
}
$code = '$service = ' . $this->formatStatement(Helpers::expand($def->factory, $parameters, TRUE)) . ";\n";
$entity = $this->normalizeEntity($def->factory->entity);
if ($def->class && $def->class !== $entity && !$this->getServiceName($entity)) {
$code .= PhpHelpers::formatArgs("if (!\$service instanceof $def->class) {\n"
. "\tthrow new Nette\\UnexpectedValueException(?);\n}\n",
array("Unable to create service '$name', value returned by factory is not $def->class type.")
);
}
foreach ((array) $def->setup as $setup) {
$setup = Helpers::expand($setup, $parameters, TRUE);
if (is_string($setup->entity) && strpbrk($setup->entity, ':@?') === FALSE) { // auto-prepend @self
$setup->entity = array("@$name", $setup->entity);
}
$code .= $this->formatStatement($setup, $name) . ";\n";
}
return $code .= 'return $service;';
}
/**
* Formats PHP code for class instantiating, function calling or property setting in PHP.
* @return string
* @internal
*/
public function formatStatement(Statement $statement, $self = NULL)
{
$entity = $this->normalizeEntity($statement->entity);
$arguments = (array) $statement->arguments;
if (is_string($entity) && Strings::contains($entity, '?')) { // PHP literal
return $this->formatPhp($entity, $arguments, $self);
} elseif ($service = $this->getServiceName($entity)) { // factory calling or service retrieving
if ($this->definitions[$service]->shared) {
if ($arguments) {
throw new ServiceCreationException("Unable to call service '$entity'.");
}
return $this->formatPhp('$this->?', array($service));
}
$params = array();
foreach ($this->definitions[$service]->parameters as $k => $v) {
$params[] = preg_replace('#\w+$#', '\$$0', (is_int($k) ? $v : $k)) . (is_int($k) ? '' : ' = ' . PhpHelpers::dump($v));
}
$rm = new \ReflectionFunction(create_function(implode(', ', $params), ''));
$arguments = Helpers::autowireArguments($rm, $arguments, $this);
return $this->formatPhp('$this->?(?*)', array(Container::getMethodName($service, FALSE), $arguments), $self);
} elseif ($entity === 'not') { // operator
return $this->formatPhp('!?', array($arguments[0]));
} elseif (is_string($entity)) { // class name
if ($constructor = Nette\Reflection\ClassType::from($entity)->getConstructor()) {
$this->addDependency($constructor->getFileName());
$arguments = Helpers::autowireArguments($constructor, $arguments, $this);
} elseif ($arguments) {
throw new ServiceCreationException("Unable to pass arguments, class $entity has no constructor.");
}
return $this->formatPhp("new $entity" . ($arguments ? '(?*)' : ''), array($arguments), $self);
} elseif (!Validators::isList($entity) || count($entity) !== 2) {
throw new Nette\InvalidStateException("Expected class, method or property, " . PhpHelpers::dump($entity) . " given.");
} elseif ($entity[0] === '') { // globalFunc
return $this->formatPhp("$entity[1](?*)", array($arguments), $self);
} elseif (Strings::contains($entity[1], '$')) { // property setter
if ($this->getServiceName($entity[0], $self)) {
return $this->formatPhp('?->? = ?', array($entity[0], substr($entity[1], 1), $statement->arguments), $self);
} else {
return $this->formatPhp($entity[0] . '::$? = ?', array(substr($entity[1], 1), $statement->arguments), $self);
}
} elseif ($service = $this->getServiceName($entity[0], $self)) { // service method
if ($this->definitions[$service]->class) {
$arguments = $this->autowireArguments($this->definitions[$service]->class, $entity[1], $arguments);
}
return $this->formatPhp('?->?(?*)', array($entity[0], $entity[1], $arguments), $self);
} else { // static method
$arguments = $this->autowireArguments($entity[0], $entity[1], $arguments);
return $this->formatPhp("$entity[0]::$entity[1](?*)", array($arguments), $self);
}
}
/**
* Formats PHP statement.
* @return string
*/
public function formatPhp($statement, $args, $self = NULL)
{
$that = $this;
array_walk_recursive($args, function(&$val) use ($self, $that) {
list($val) = $that->normalizeEntity(array($val));
if ($val instanceof Statement) {
$val = new PhpLiteral($that->formatStatement($val, $self));
} elseif ($val === '@' . ContainerBuilder::THIS_CONTAINER) {
$val = new PhpLiteral('$this');
} elseif ($service = $that->getServiceName($val, $self)) {
$val = $service === $self ? '$service' : $that->formatStatement(new Statement($val));
$val = new PhpLiteral($val, $self);
}
});
return PhpHelpers::formatArgs($statement, $args);
}
/**
* Expands %placeholders% in strings (recursive).
* @param mixed
* @return mixed
*/
public function expand($value)
{
return Helpers::expand($value, $this->parameters, TRUE);
}
/** @internal */
public function normalizeEntity($entity)
{
if (is_string($entity) && Strings::contains($entity, '::') && !Strings::contains($entity, '?')) { // Class::method -> [Class, method]
$entity = explode('::', $entity);
}
if (is_array($entity) && $entity[0] instanceof ServiceDefinition) { // [ServiceDefinition, ...] -> [@serviceName, ...]
$tmp = array_keys($this->definitions, $entity[0], TRUE);
$entity[0] = "@$tmp[0]";
} elseif ($entity instanceof ServiceDefinition) { // ServiceDefinition -> @serviceName
$tmp = array_keys($this->definitions, $entity, TRUE);
$entity = "@$tmp[0]";
} elseif (is_array($entity) && $entity[0] === $this) { // [$this, ...] -> [@container, ...]
$entity[0] = '@' . ContainerBuilder::THIS_CONTAINER;
}
return $entity; // Class, @service, [Class, member], [@service, member], [, globalFunc]
}
/**
* Converts @service or @\Class -> service name and checks its existence.
* @param mixed
* @return string of FALSE, if argument is not service name
*/
public function getServiceName($arg, $self = NULL)
{
if (!is_string($arg) || !preg_match('#^@[\w\\\\.].+$#', $arg)) {
return FALSE;
}
$service = substr($arg, 1);
if ($service === self::CREATED_SERVICE) {
$service = $self;
}
if (Strings::contains($service, '\\')) {
if ($this->classes === FALSE) { // may be disabled by prepareClassList
return $service;
}
$res = $this->getByType($service);
if (!$res) {
throw new ServiceCreationException("Reference to missing service of type $service.");
}
return $res;
}
if (!isset($this->definitions[$service])) {
throw new ServiceCreationException("Reference to missing service '$service'.");
}
return $service;
}
}