Skip to content

Commit

Permalink
[DI] Add getter injection
Browse files Browse the repository at this point in the history
  • Loading branch information
@nicolas-grekas
nicolas-grekas committed Jan 18, 2017
1 parent 5921530 commit 6d7ff13
Show file tree
Hide file tree
Showing 33 changed files with 822 additions and 47 deletions.
1 change: 1 addition & 0 deletions src/Symfony/Component/DependencyInjection/CHANGELOG.md
View file
Expand Up @@ -4,6 +4,7 @@ CHANGELOG
3.3.0
-----

* added support for getter-injection
* deprecated case insensitivity of service identifiers
* added "iterator" argument type for lazy iteration over a set of values and services
* added "closure-proxy" argument type for turning services' methods into lazy callables
Expand Down
2 changes: 2 additions & 0 deletions src/Symfony/Component/DependencyInjection/Compiler/AnalyzeServiceReferencesPass.php
View file
Expand Up @@ -76,6 +76,7 @@ public function process(ContainerBuilder $container)

if (!$this->onlyConstructorArguments) {
$this->processArguments($definition->getMethodCalls());
$this->processArguments($definition->getOverriddenGetters());
$this->processArguments($definition->getProperties());
if ($definition->getConfigurator()) {
$this->processArguments(array($definition->getConfigurator()));
Expand Down Expand Up @@ -115,6 +116,7 @@ private function processArguments(array $arguments, $lazy = false)
} elseif ($argument instanceof Definition) {
$this->processArguments($argument->getArguments());
$this->processArguments($argument->getMethodCalls());
$this->processArguments($argument->getOverriddenGetters());
$this->processArguments($argument->getProperties());

if (is_array($argument->getFactory())) {
Expand Down
1 change: 1 addition & 0 deletions ...y/Component/DependencyInjection/Compiler/CheckExceptionOnInvalidReferenceBehaviorPass.php
View file
Expand Up @@ -42,6 +42,7 @@ private function processDefinition(Definition $definition)
{
$this->processReferences($definition->getArguments());
$this->processReferences($definition->getMethodCalls());
$this->processReferences($definition->getOverriddenGetters());
$this->processReferences($definition->getProperties());
}

Expand Down
1 change: 1 addition & 0 deletions src/Symfony/Component/DependencyInjection/Compiler/CheckReferenceValidityPass.php
View file
Expand Up @@ -48,6 +48,7 @@ public function process(ContainerBuilder $container)

$this->validateReferences($definition->getArguments());
$this->validateReferences($definition->getMethodCalls());
$this->validateReferences($definition->getOverriddenGetters());
$this->validateReferences($definition->getProperties());
}
}
Expand Down
1 change: 1 addition & 0 deletions src/Symfony/Component/DependencyInjection/Compiler/InlineServiceDefinitionsPass.php
View file
Expand Up @@ -87,6 +87,7 @@ private function inlineArguments(ContainerBuilder $container, array $arguments,
} elseif ($argument instanceof Definition) {
$argument->setArguments($this->inlineArguments($container, $argument->getArguments()));
$argument->setMethodCalls($this->inlineArguments($container, $argument->getMethodCalls()));
$argument->setOverriddenGetters($this->inlineArguments($container, $argument->getOverriddenGetters()));
$argument->setProperties($this->inlineArguments($container, $argument->getProperties()));

$configurator = $this->inlineArguments($container, array($argument->getConfigurator()));
Expand Down
1 change: 1 addition & 0 deletions src/Symfony/Component/DependencyInjection/Compiler/ReplaceAliasByActualDefinitionPass.php
View file
Expand Up @@ -77,6 +77,7 @@ public function process(ContainerBuilder $container)
foreach ($container->getDefinitions() as $definitionId => $definition) {
$definition->setArguments($this->updateArgumentReferences($replacements, $definitionId, $definition->getArguments()));
$definition->setMethodCalls($this->updateArgumentReferences($replacements, $definitionId, $definition->getMethodCalls()));
$definition->setOverriddenGetters($this->updateArgumentReferences($replacements, $definitionId, $definition->getOverriddenGetters()));
$definition->setProperties($this->updateArgumentReferences($replacements, $definitionId, $definition->getProperties()));
$definition->setFactory($this->updateFactoryReference($replacements, $definition->getFactory()));
}
Expand Down
7 changes: 7 additions & 0 deletions src/Symfony/Component/DependencyInjection/Compiler/ResolveDefinitionTemplatesPass.php
View file
Expand Up @@ -75,6 +75,7 @@ private function resolveArguments(ContainerBuilder $container, array $arguments,
}
$argument->setArguments($this->resolveArguments($container, $argument->getArguments()));
$argument->setMethodCalls($this->resolveArguments($container, $argument->getMethodCalls()));
$argument->setOverriddenGetters($this->resolveArguments($container, $argument->getOverriddenGetters()));
$argument->setProperties($this->resolveArguments($container, $argument->getProperties()));

$configurator = $this->resolveArguments($container, array($argument->getConfigurator()));
Expand Down Expand Up @@ -134,6 +135,7 @@ private function doResolveDefinition(ContainerBuilder $container, ChildDefinitio
$def->setClass($parentDef->getClass());
$def->setArguments($parentDef->getArguments());
$def->setMethodCalls($parentDef->getMethodCalls());
$def->setOverriddenGetters($parentDef->getOverriddenGetters());
$def->setProperties($parentDef->getProperties());
$def->setAutowiringTypes($parentDef->getAutowiringTypes());
if ($parentDef->isDeprecated()) {
Expand Down Expand Up @@ -206,6 +208,11 @@ private function doResolveDefinition(ContainerBuilder $container, ChildDefinitio
$def->setMethodCalls(array_merge($def->getMethodCalls(), $calls));
}

// merge overridden getters
foreach ($definition->getOverriddenGetters() as $k => $v) {
$def->setOverriddenGetter($k, $v);
}

// merge autowiring types
foreach ($definition->getAutowiringTypes() as $autowiringType) {
$def->addAutowiringType($autowiringType);
Expand Down
11 changes: 11 additions & 0 deletions src/Symfony/Component/DependencyInjection/Compiler/ResolveInvalidReferencesPass.php
View file
Expand Up @@ -54,6 +54,17 @@ public function process(ContainerBuilder $container)
}
$definition->setMethodCalls($calls);

$getters = array();
foreach ($definition->getOverriddenGetters() as $name => $value) {
try {
$value = $this->processArguments(array($value), true);
$getters[$name] = reset($value);
} catch (RuntimeException $e) {
// this call is simply removed
}
}
$definition->setOverriddenGetters($getters);

$properties = array();
foreach ($definition->getProperties() as $name => $value) {
try {
Expand Down
1 change: 1 addition & 0 deletions src/Symfony/Component/DependencyInjection/Compiler/ResolveParameterPlaceHoldersPass.php
View file
Expand Up @@ -51,6 +51,7 @@ public function process(ContainerBuilder $container)
}
$definition->setMethodCalls($calls);

$definition->setOverriddenGetters($parameterBag->resolveValue($definition->getOverriddenGetters()));
$definition->setProperties($parameterBag->resolveValue($definition->getProperties()));
} catch (ParameterNotFoundException $e) {
$e->setSourceId($id);
Expand Down
1 change: 1 addition & 0 deletions src/Symfony/Component/DependencyInjection/Compiler/ResolveReferencesToAliasesPass.php
View file
Expand Up @@ -42,6 +42,7 @@ public function process(ContainerBuilder $container)

$definition->setArguments($this->processArguments($definition->getArguments()));
$definition->setMethodCalls($this->processArguments($definition->getMethodCalls()));
$definition->setOverriddenGetters($this->processArguments($definition->getOverriddenGetters()));
$definition->setProperties($this->processArguments($definition->getProperties()));
$definition->setFactory($this->processFactory($definition->getFactory()));
}
Expand Down
124 changes: 122 additions & 2 deletions src/Symfony/Component/DependencyInjection/ContainerBuilder.php
View file
Expand Up @@ -29,6 +29,7 @@
use Symfony\Component\Config\Resource\ResourceInterface;
use Symfony\Component\DependencyInjection\LazyProxy\Instantiator\InstantiatorInterface;
use Symfony\Component\DependencyInjection\LazyProxy\Instantiator\RealServiceInstantiator;
use Symfony\Component\DependencyInjection\LazyProxy\GetterProxyInterface;
use Symfony\Component\ExpressionLanguage\Expression;
use Symfony\Component\ExpressionLanguage\ExpressionFunctionProviderInterface;

Expand Down Expand Up @@ -890,6 +891,9 @@ private function createService(Definition $definition, $id, $tryProxy = true)
$arguments = $this->resolveServices($parameterBag->unescapeValue($parameterBag->resolveValue($definition->getArguments())));

if (null !== $factory = $definition->getFactory()) {
if ($definition->getOverriddenGetters()) {
throw new RuntimeException(sprintf('Cannot create service "%s": factories and overridden getters are incompatible with each other.', $id));
}
if (is_array($factory)) {
$factory = array($this->resolveServices($parameterBag->resolveValue($factory[0])), $factory[1]);
} elseif (!is_string($factory)) {
Expand All @@ -908,11 +912,31 @@ private function createService(Definition $definition, $id, $tryProxy = true)
} else {
$r = new \ReflectionClass($parameterBag->resolveValue($definition->getClass()));

$service = null === $r->getConstructor() ? $r->newInstance() : $r->newInstanceArgs($arguments);

if (!$definition->isDeprecated() && 0 < strpos($r->getDocComment(), "\n * @deprecated ")) {
@trigger_error(sprintf('The "%s" service relies on the deprecated "%s" class. It should either be deprecated or its implementation upgraded.', $id, $r->name), E_USER_DEPRECATED);
}
if ($definition->getOverriddenGetters()) {
static $salt;
if (null === $salt) {
$salt = str_replace('.', '', uniqid('', true));
}
$service = sprintf('%s implements \\%s { private $container%4$s; private $values%4$s; %s }', $r->name, GetterProxyInterface::class, $this->generateOverriddenGetters($id, $definition, $r, $salt), $salt);
if (!class_exists($proxyClass = 'SymfonyProxy_'.md5($service), false)) {
eval(sprintf('class %s extends %s', $proxyClass, $service));
}
$r = new \ReflectionClass($proxyClass);
$constructor = $r->getConstructor();
if ($constructor && !defined('HHVM_VERSION') && $constructor->getDeclaringClass()->isInternal()) {
$constructor = null;
}
$service = $constructor ? $r->newInstanceWithoutConstructor() : $r->newInstanceArgs($arguments);
call_user_func(\Closure::bind(function ($c, $v, $s) { $this->{'container'.$s} = $c; $this->{'values'.$s} = $v; }, $service, $service), $this, $definition->getOverriddenGetters(), $salt);
if ($constructor) {
$constructor->invokeArgs($service, $arguments);
}
} else {
$service = null === $r->getConstructor() ? $r->newInstance() : $r->newInstanceArgs($arguments);
}
}

if ($tryProxy || !$definition->isLazy()) {
Expand Down Expand Up @@ -1155,6 +1179,102 @@ public function getEnvCounters()
return $this->envCounters;
}

private function generateOverriddenGetters($id, Definition $definition, \ReflectionClass $class, $salt)
{
if ($class->isFinal()) {
throw new RuntimeException(sprintf('Unable to configure getter injection for service "%s": class "%s" cannot be marked as final.', $id, $class->name));
}
$getters = '';
foreach ($definition->getOverriddenGetters() as $name => $returnValue) {
$r = self::getGetterReflector($class, $name, $id, $type);
$visibility = $r->isProtected() ? 'protected' : 'public';
$name = var_export($name, true);
$getters .= <<<EOF
{$visibility} function {$r->name}(){$type} {
\$c = \$this->container{$salt};
\$b = \$c->getParameterBag();
\$v = \$this->values{$salt}[{$name}];
foreach (\$c->getServiceConditionals(\$v) as \$s) {
if (!\$c->has(\$s)) {
return parent::{$r->name}();
}
}
return \$c->resolveServices(\$b->unescapeValue(\$b->resolveValue(\$v)));
}
EOF;
}

return $getters;
}

/**
* @internal
*/
public static function getGetterReflector(\ReflectionClass $class, $name, $id, &$type)
{
if (!$class->hasMethod($name)) {
throw new RuntimeException(sprintf('Unable to configure getter injection for service "%s": method "%s::%s" does not exist.', $id, $class->name, $name));
}
$r = $class->getMethod($name);
if ($r->isPrivate()) {
throw new RuntimeException(sprintf('Unable to configure getter injection for service "%s": method "%s::%s" must be public or protected.', $id, $class->name, $r->name));
}
if ($r->isStatic()) {
throw new RuntimeException(sprintf('Unable to configure getter injection for service "%s": method "%s::%s" cannot be static.', $id, $class->name, $r->name));
}
if ($r->isFinal()) {
throw new RuntimeException(sprintf('Unable to configure getter injection for service "%s": method "%s::%s" cannot be marked as final.', $id, $class->name, $r->name));
}
if ($r->returnsReference()) {
throw new RuntimeException(sprintf('Unable to configure getter injection for service "%s": method "%s::%s" cannot return by reference.', $id, $class->name, $r->name));
}
if (0 < $r->getNumberOfParameters()) {
throw new RuntimeException(sprintf('Unable to configure getter injection for service "%s": method "%s::%s" cannot have any arguments.', $id, $class->name, $r->name));
}
if ($type = method_exists($r, 'getReturnType') ? $r->getReturnType() : null) {
$type = ': '.($type->allowsNull() ? '?' : '').self::generateTypeHint($type, $r);
}

return $r;
}

/**
* @internal
*/
public static function generateTypeHint($type, \ReflectionFunctionAbstract $r)
{
if (is_string($type)) {
$name = $type;

if ('callable' === $name || 'array' === $name) {
return $name;
}
} else {
$name = $type instanceof \ReflectionNamedType ? $type->getName() : $type->__toString();

if ($type->isBuiltin()) {
return $name;
}
}
$lcName = strtolower($name);

if ('self' !== $lcName && 'parent' !== $lcName) {
return '\\'.$name;
}
if (!$r instanceof \ReflectionMethod) {
return;
}
if ('self' === $lcName) {
return '\\'.$r->getDeclaringClass()->name;
}
if ($parent = $r->getDeclaringClass()->getParentClass()) {
return '\\'.$parent->name;
}
}

/**
* @internal
*/
Expand Down
23 changes: 23 additions & 0 deletions src/Symfony/Component/DependencyInjection/Definition.php
View file
Expand Up @@ -29,6 +29,7 @@ class Definition
private $deprecationTemplate = 'The "%service_id%" service is deprecated. You should stop using it, as it will soon be removed.';
private $properties = array();
private $calls = array();
private $getters = array();
private $configurator;
private $tags = array();
private $public = true;
Expand Down Expand Up @@ -319,6 +320,28 @@ public function getMethodCalls()
return $this->calls;
}

public function setOverriddenGetter($name, $returnValue)
{
if (!$name) {
throw new InvalidArgumentException(sprintf('Getter name cannot be empty.'));
}
$this->getters[strtolower($name)] = $returnValue;

return $this;
}

public function setOverriddenGetters(array $getters)
{
$this->getters = array_change_key_case($getters, CASE_LOWER);

return $this;
}

public function getOverriddenGetters()
{
return $this->getters;
}

/**
* Sets tags for this definition.
*
Expand Down
7 changes: 7 additions & 0 deletions src/Symfony/Component/DependencyInjection/Dumper/GraphvizDumper.php
View file
Expand Up @@ -80,6 +80,13 @@ public function dump(array $options = array())
$this->findEdges($id, $call[1], false, $call[0].'()')
);
}

foreach ($definition->getOverriddenGetters() as $name => $value) {
$this->edges[$id] = array_merge(
$this->edges[$id],
$this->findEdges($id, $value, false, $name.'()')
);
}
}

return $this->container->resolveEnvPlaceholders($this->startDot().$this->addNodes().$this->addEdges().$this->endDot(), '__ENV_%s__');
Expand Down

0 comments on commit 6d7ff13

Please sign in to comment.