Skip to content

Revert "feature #20973 [DI] Add getter injection (nicolas-grekas)" #22158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 25, 2017
Merged

Revert "feature #20973 [DI] Add getter injection (nicolas-grekas)" #22158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions src/Symfony/Component/DependencyInjection/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ CHANGELOG
* deprecated `ContainerBuilder::getClassResource()`, use `ContainerBuilder::getReflectionClass()` or `ContainerBuilder::addObjectResource()` instead
* added `ContainerBuilder::fileExists()` for checking and tracking file or directory existence
* deprecated autowiring-types, use aliases instead
* [EXPERIMENTAL] added support for getter autowiring
* [EXPERIMENTAL] added support for getter-injection
* added support for omitting the factory class name in a service definition if the definition class is set
* deprecated case insensitivity of service identifiers
* added "iterator" argument type for lazy iteration over a set of values and services
Expand Down
1 change: 0 additions & 1 deletion src/Symfony/Component/DependencyInjection/Compiler/AbstractRecursivePass.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,6 @@ protected function processValue($value, $isRoot = false)
} elseif ($value instanceof Definition) {
$value->setArguments($this->processValue($value->getArguments()));
$value->setProperties($this->processValue($value->getProperties()));
$value->setOverriddenGetters($this->processValue($value->getOverriddenGetters()));
$value->setMethodCalls($this->processValue($value->getMethodCalls()));

if ($v = $value->getFactory()) {
Expand Down
3 changes: 0 additions & 3 deletions src/Symfony/Component/DependencyInjection/Compiler/AnalyzeServiceReferencesPass.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,9 +109,6 @@ protected function processValue($value, $isRoot = false)

if (!$this->onlyConstructorArguments) {
$this->processValue($value->getProperties());
$this->lazy = true;
$this->processValue($value->getOverriddenGetters());
$this->lazy = false;
$this->processValue($value->getMethodCalls());
$this->processValue($value->getConfigurator());
}
Expand Down
49 changes: 3 additions & 46 deletions src/Symfony/Component/DependencyInjection/Compiler/AutowirePass.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Definition;
use Symfony\Component\DependencyInjection\Exception\RuntimeException;
use Symfony\Component\DependencyInjection\LazyProxy\InheritanceProxyHelper;
use Symfony\Component\DependencyInjection\LazyProxy\ProxyHelper;
use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\DependencyInjection\TypedReference;

Expand Down Expand Up @@ -125,7 +125,6 @@ protected function processValue($value, $isRoot = false)
}

$methodCalls = $this->autowireCalls($reflectionClass, $methodCalls, $autowiredMethods);
$overriddenGetters = $this->autowireOverridenGetters($value->getOverriddenGetters(), $autowiredMethods);

if ($constructor) {
list(, $arguments) = array_shift($methodCalls);
Expand All @@ -139,10 +138,6 @@ protected function processValue($value, $isRoot = false)
$value->setMethodCalls($methodCalls);
}

if ($overriddenGetters !== $value->getOverriddenGetters()) {
$value->setOverriddenGetters($overriddenGetters);
}

return parent::processValue($value, $isRoot);
} finally {
$this->currentDefinition = $parentDefinition;
Expand All @@ -165,7 +160,7 @@ private function getMethodsToAutowire(\ReflectionClass $reflectionClass)
$methodsToAutowire[strtolower($reflectionMethod->name)] = $reflectionMethod;
}

foreach ($reflectionClass->getMethods(\ReflectionMethod::IS_PUBLIC | \ReflectionMethod::IS_PROTECTED) as $reflectionMethod) {
foreach ($reflectionClass->getMethods() as $reflectionMethod) {
$r = $reflectionMethod;

while (true) {
Expand Down Expand Up @@ -224,9 +219,6 @@ private function autowireCalls(\ReflectionClass $reflectionClass, array $methodC
}

foreach ($autowiredMethods as $lcMethod => $reflectionMethod) {
if (!$reflectionMethod->getNumberOfParameters()) {
continue; // skip getters
}
$method = $reflectionMethod->name;

if (!$reflectionMethod->isPublic()) {
Expand Down Expand Up @@ -270,7 +262,7 @@ private function autowireMethod(\ReflectionMethod $reflectionMethod, array $argu
continue;
}

$type = InheritanceProxyHelper::getTypeHint($reflectionMethod, $parameter, true);
$type = ProxyHelper::getTypeHint($reflectionMethod, $parameter, true);

if (!$type) {
// no default value? Then fail
Expand Down Expand Up @@ -311,41 +303,6 @@ private function autowireMethod(\ReflectionMethod $reflectionMethod, array $argu
return $arguments;
}

/**
* Autowires getters.
*
* @param array $overridenGetters
* @param array $autowiredMethods
*
* @return array
*/
private function autowireOverridenGetters(array $overridenGetters, array $autowiredMethods)
{
foreach ($autowiredMethods as $lcMethod => $reflectionMethod) {
if (isset($overridenGetters[$lcMethod]) || $reflectionMethod->getNumberOfParameters() || $reflectionMethod->isConstructor()) {
continue;
}
$class = $reflectionMethod->class;
$method = $reflectionMethod->name;

if (!$type = InheritanceProxyHelper::getTypeHint($reflectionMethod, null, true)) {
$type = InheritanceProxyHelper::getTypeHint($reflectionMethod);

throw new RuntimeException(sprintf('Cannot autowire service "%s": getter %s() must%s have its return value be configured explicitly.', $this->currentId, $class !== $this->currentId ? $class.'::'.$method : $method, $type ? '' : ' have a return-type hint or'));
}

if (!$typeRef = $this->getAutowiredReference($type)) {
$this->container->log($this, $this->createTypeNotFoundMessage($type, sprintf('return value of method %s()', $class !== $this->currentId ? $class.'::'.$method : $method)));
continue;
}

$overridenGetters[$lcMethod] = $typeRef;
$this->usedTypes[$type] = $this->currentId;
}

return $overridenGetters;
}

/**
* @return Reference|null A reference to the service matching the given type, if any
*/
Expand Down
6 changes: 0 additions & 6 deletions src/Symfony/Component/DependencyInjection/Compiler/ResolveDefinitionTemplatesPass.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,6 @@ private function doResolveDefinition(ChildDefinition $definition)
$def->setClass($parentDef->getClass());
$def->setArguments($parentDef->getArguments());
$def->setMethodCalls($parentDef->getMethodCalls());
$def->setOverriddenGetters($parentDef->getOverriddenGetters());
$def->setProperties($parentDef->getProperties());
if ($parentDef->getAutowiringTypes(false)) {
$def->setAutowiringTypes($parentDef->getAutowiringTypes(false));
Expand Down Expand Up @@ -183,10 +182,5 @@ public static function mergeDefinition(Definition $def, ChildDefinition $definit
if ($calls = $definition->getMethodCalls()) {
$def->setMethodCalls(array_merge($def->getMethodCalls(), $calls));
}

// merge overridden getters
foreach ($definition->getOverriddenGetters() as $k => $v) {
$def->setOverriddenGetter($k, $v);
}
}
}
1 change: 0 additions & 1 deletion src/Symfony/Component/DependencyInjection/Compiler/ResolveInvalidReferencesPass.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@ private function processValue($value, $rootLevel = 0, $level = 0)
}
$value->setArguments($this->processValue($value->getArguments(), 0));
$value->setProperties($this->processValue($value->getProperties(), 1));
$value->setOverriddenGetters($this->processValue($value->getOverriddenGetters(), 1));
$value->setMethodCalls($this->processValue($value->getMethodCalls(), 2));
} elseif (is_array($value)) {
$i = 0;
Expand Down
1 change: 0 additions & 1 deletion src/Symfony/Component/DependencyInjection/Compiler/ResolveReferencesToAliasesPass.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ 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
67 changes: 2 additions & 65 deletions src/Symfony/Component/DependencyInjection/ContainerBuilder.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,6 @@
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\InheritanceProxyHelper;
use Symfony\Component\DependencyInjection\LazyProxy\InheritanceProxyInterface;
use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
use Symfony\Component\ExpressionLanguage\Expression;
use Symfony\Component\ExpressionLanguage\ExpressionFunctionProviderInterface;
Expand Down Expand Up @@ -1042,9 +1040,6 @@ 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 @@ -1063,31 +1058,11 @@ 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 $getters%4$s; %s }', $r->name, InheritanceProxyInterface::class, $this->generateOverriddenMethods($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, $g, $s) { $this->{'container'.$s} = $c; $this->{'getters'.$s} = $g; }, $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 @@ -1348,44 +1323,6 @@ public function getEnvCounters()
return $this->envCounters;
}

private function generateOverriddenMethods($id, Definition $definition, \ReflectionClass $class, $salt)
{
if ($class->isFinal()) {
throw new RuntimeException(sprintf('Unable to configure service "%s": class "%s" cannot be marked as final.', $id, $class->name));
}

return $this->generateOverriddenGetters($id, $definition, $class, $salt);
}

private function generateOverriddenGetters($id, Definition $definition, \ReflectionClass $class, $salt)
{
$getters = '';

foreach ($definition->getOverriddenGetters() as $name => $returnValue) {
$r = InheritanceProxyHelper::getGetterReflector($class, $name, $id);
$signature = InheritanceProxyHelper::getSignature($r);
$visibility = $r->isProtected() ? 'protected' : 'public';
$getters .= <<<EOF

{$visibility} function {$signature} {
\$c = \$this->container{$salt};
\$b = \$c->getParameterBag();
\$v = \$this->getters{$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
*/
Expand Down
36 changes: 0 additions & 36 deletions src/Symfony/Component/DependencyInjection/Definition.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ 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 $instanceof = array();
private $configurator;
private $tags = array();
Expand Down Expand Up @@ -329,41 +328,6 @@ public function getMethodCalls()
return $this->calls;
}

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

return $this;
}

/**
* @return $this
*
* @experimental in version 3.3
*/
public function setOverriddenGetters(array $getters)
{
$this->getters = array_change_key_case($getters, CASE_LOWER);

return $this;
}

/**
* @experimental in version 3.3
*/
public function getOverriddenGetters()
{
return $this->getters;
}

/**
* Sets the definition templates to conditionally apply on the current definition, keyed by parent interface/class.
*
Expand Down
7 changes: 0 additions & 7 deletions src/Symfony/Component/DependencyInjection/Dumper/GraphvizDumper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,13 +80,6 @@ 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
Loading