1783 lines
61 KiB
PHP
1783 lines
61 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the Symfony package.
|
|
*
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Symfony\Component\DependencyInjection\Dumper;
|
|
|
|
use Symfony\Component\DependencyInjection\Argument\ArgumentInterface;
|
|
use Symfony\Component\DependencyInjection\Argument\ClosureProxyArgument;
|
|
use Symfony\Component\DependencyInjection\Argument\IteratorArgument;
|
|
use Symfony\Component\DependencyInjection\Argument\ServiceClosureArgument;
|
|
use Symfony\Component\DependencyInjection\Variable;
|
|
use Symfony\Component\DependencyInjection\Definition;
|
|
use Symfony\Component\DependencyInjection\ContainerBuilder;
|
|
use Symfony\Component\DependencyInjection\Container;
|
|
use Symfony\Component\DependencyInjection\ContainerInterface;
|
|
use Symfony\Component\DependencyInjection\Reference;
|
|
use Symfony\Component\DependencyInjection\TypedReference;
|
|
use Symfony\Component\DependencyInjection\Parameter;
|
|
use Symfony\Component\DependencyInjection\Exception\EnvParameterException;
|
|
use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
|
|
use Symfony\Component\DependencyInjection\Exception\RuntimeException;
|
|
use Symfony\Component\DependencyInjection\Exception\ServiceCircularReferenceException;
|
|
use Symfony\Component\DependencyInjection\LazyProxy\ProxyHelper;
|
|
use Symfony\Component\DependencyInjection\LazyProxy\PhpDumper\DumperInterface as ProxyDumper;
|
|
use Symfony\Component\DependencyInjection\LazyProxy\PhpDumper\NullDumper;
|
|
use Symfony\Component\DependencyInjection\ExpressionLanguage;
|
|
use Symfony\Component\ExpressionLanguage\Expression;
|
|
use Symfony\Component\HttpKernel\Kernel;
|
|
|
|
/**
|
|
* PhpDumper dumps a service container as a PHP class.
|
|
*
|
|
* @author Fabien Potencier <fabien@symfony.com>
|
|
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
|
|
*/
|
|
class PhpDumper extends Dumper
|
|
{
|
|
/**
|
|
* Characters that might appear in the generated variable name as first character.
|
|
*
|
|
* @var string
|
|
*/
|
|
const FIRST_CHARS = 'abcdefghijklmnopqrstuvwxyz';
|
|
|
|
/**
|
|
* Characters that might appear in the generated variable name as any but the first character.
|
|
*
|
|
* @var string
|
|
*/
|
|
const NON_FIRST_CHARS = 'abcdefghijklmnopqrstuvwxyz0123456789_';
|
|
|
|
private $inlinedDefinitions;
|
|
private $definitionVariables;
|
|
private $referenceVariables;
|
|
private $variableCount;
|
|
private $reservedVariables = array('instance', 'class');
|
|
private $expressionLanguage;
|
|
private $targetDirRegex;
|
|
private $targetDirMaxMatches;
|
|
private $docStar;
|
|
private $serviceIdToMethodNameMap;
|
|
private $usedMethodNames;
|
|
private $baseClass;
|
|
|
|
/**
|
|
* @var \Symfony\Component\DependencyInjection\LazyProxy\PhpDumper\DumperInterface
|
|
*/
|
|
private $proxyDumper;
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function __construct(ContainerBuilder $container)
|
|
{
|
|
if (!$container->isCompiled()) {
|
|
@trigger_error('Dumping an uncompiled ContainerBuilder is deprecated since version 3.3 and will not be supported anymore in 4.0. Compile the container beforehand.', E_USER_DEPRECATED);
|
|
}
|
|
|
|
parent::__construct($container);
|
|
|
|
$this->inlinedDefinitions = new \SplObjectStorage();
|
|
}
|
|
|
|
/**
|
|
* Sets the dumper to be used when dumping proxies in the generated container.
|
|
*
|
|
* @param ProxyDumper $proxyDumper
|
|
*/
|
|
public function setProxyDumper(ProxyDumper $proxyDumper)
|
|
{
|
|
$this->proxyDumper = $proxyDumper;
|
|
}
|
|
|
|
/**
|
|
* Dumps the service container as a PHP class.
|
|
*
|
|
* Available options:
|
|
*
|
|
* * class: The class name
|
|
* * base_class: The base class name
|
|
* * namespace: The class namespace
|
|
*
|
|
* @param array $options An array of options
|
|
*
|
|
* @return string A PHP class representing of the service container
|
|
*
|
|
* @throws EnvParameterException When an env var exists but has not been dumped
|
|
*/
|
|
public function dump(array $options = array())
|
|
{
|
|
$this->targetDirRegex = null;
|
|
$options = array_merge(array(
|
|
'class' => 'ProjectServiceContainer',
|
|
'base_class' => 'Container',
|
|
'namespace' => '',
|
|
'debug' => true,
|
|
), $options);
|
|
|
|
$this->classResources = array();
|
|
$this->initializeMethodNamesMap($options['base_class']);
|
|
$this->baseClass = $options['base_class'];
|
|
|
|
$this->docStar = $options['debug'] ? '*' : '';
|
|
|
|
if (!empty($options['file']) && is_dir($dir = dirname($options['file']))) {
|
|
// Build a regexp where the first root dirs are mandatory,
|
|
// but every other sub-dir is optional up to the full path in $dir
|
|
// Mandate at least 2 root dirs and not more that 5 optional dirs.
|
|
|
|
$dir = explode(DIRECTORY_SEPARATOR, realpath($dir));
|
|
$i = count($dir);
|
|
|
|
if (3 <= $i) {
|
|
$regex = '';
|
|
$lastOptionalDir = $i > 8 ? $i - 5 : 3;
|
|
$this->targetDirMaxMatches = $i - $lastOptionalDir;
|
|
|
|
while (--$i >= $lastOptionalDir) {
|
|
$regex = sprintf('(%s%s)?', preg_quote(DIRECTORY_SEPARATOR.$dir[$i], '#'), $regex);
|
|
}
|
|
|
|
do {
|
|
$regex = preg_quote(DIRECTORY_SEPARATOR.$dir[$i], '#').$regex;
|
|
} while (0 < --$i);
|
|
|
|
$this->targetDirRegex = '#'.preg_quote($dir[0], '#').$regex.'#';
|
|
}
|
|
}
|
|
|
|
$code = $this->startClass($options['class'], $options['base_class'], $options['namespace']);
|
|
|
|
if ($this->container->isCompiled()) {
|
|
$code .= $this->addFrozenConstructor();
|
|
$code .= $this->addFrozenCompile();
|
|
$code .= $this->addFrozenIsCompiled();
|
|
} else {
|
|
$code .= $this->addConstructor();
|
|
}
|
|
|
|
$code .=
|
|
$this->addServices().
|
|
$this->addDefaultParametersMethod().
|
|
$this->endClass().
|
|
$this->addProxyClasses()
|
|
;
|
|
$this->targetDirRegex = null;
|
|
|
|
$unusedEnvs = array();
|
|
foreach ($this->container->getEnvCounters() as $env => $use) {
|
|
if (!$use) {
|
|
$unusedEnvs[] = $env;
|
|
}
|
|
}
|
|
if ($unusedEnvs) {
|
|
throw new EnvParameterException($unusedEnvs);
|
|
}
|
|
|
|
return $code;
|
|
}
|
|
|
|
/**
|
|
* Retrieves the currently set proxy dumper or instantiates one.
|
|
*
|
|
* @return ProxyDumper
|
|
*/
|
|
private function getProxyDumper()
|
|
{
|
|
if (!$this->proxyDumper) {
|
|
$this->proxyDumper = new NullDumper();
|
|
}
|
|
|
|
return $this->proxyDumper;
|
|
}
|
|
|
|
/**
|
|
* Generates Service local temp variables.
|
|
*
|
|
* @param string $cId
|
|
* @param string $definition
|
|
*
|
|
* @return string
|
|
*/
|
|
private function addServiceLocalTempVariables($cId, $definition)
|
|
{
|
|
static $template = " \$%s = %s;\n";
|
|
|
|
$localDefinitions = array_merge(
|
|
array($definition),
|
|
$this->getInlinedDefinitions($definition)
|
|
);
|
|
|
|
$calls = $behavior = array();
|
|
foreach ($localDefinitions as $iDefinition) {
|
|
$this->getServiceCallsFromArguments($iDefinition->getArguments(), $calls, $behavior);
|
|
$this->getServiceCallsFromArguments($iDefinition->getMethodCalls(), $calls, $behavior);
|
|
$this->getServiceCallsFromArguments($iDefinition->getProperties(), $calls, $behavior);
|
|
$this->getServiceCallsFromArguments(array($iDefinition->getConfigurator()), $calls, $behavior);
|
|
$this->getServiceCallsFromArguments(array($iDefinition->getFactory()), $calls, $behavior);
|
|
}
|
|
|
|
$code = '';
|
|
foreach ($calls as $id => $callCount) {
|
|
if ('service_container' === $id || $id === $cId) {
|
|
continue;
|
|
}
|
|
|
|
if ($callCount > 1) {
|
|
$name = $this->getNextVariableName();
|
|
$this->referenceVariables[$id] = new Variable($name);
|
|
|
|
if (ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE === $behavior[$id]) {
|
|
$code .= sprintf($template, $name, $this->getServiceCall($id));
|
|
} else {
|
|
$code .= sprintf($template, $name, $this->getServiceCall($id, new Reference($id, ContainerInterface::NULL_ON_INVALID_REFERENCE)));
|
|
}
|
|
}
|
|
}
|
|
|
|
if ('' !== $code) {
|
|
$code .= "\n";
|
|
}
|
|
|
|
return $code;
|
|
}
|
|
|
|
/**
|
|
* Generates code for the proxies to be attached after the container class.
|
|
*
|
|
* @return string
|
|
*/
|
|
private function addProxyClasses()
|
|
{
|
|
/* @var $definitions Definition[] */
|
|
$definitions = array_filter(
|
|
$this->container->getDefinitions(),
|
|
array($this->getProxyDumper(), 'isProxyCandidate')
|
|
);
|
|
$code = '';
|
|
$strip = '' === $this->docStar && method_exists('Symfony\Component\HttpKernel\Kernel', 'stripComments');
|
|
|
|
foreach ($definitions as $definition) {
|
|
$proxyCode = "\n".$this->getProxyDumper()->getProxyCode($definition);
|
|
if ($strip) {
|
|
$proxyCode = "<?php\n".$proxyCode;
|
|
$proxyCode = substr(Kernel::stripComments($proxyCode), 5);
|
|
}
|
|
$code .= $proxyCode;
|
|
}
|
|
|
|
return $code;
|
|
}
|
|
|
|
/**
|
|
* Generates the require_once statement for service includes.
|
|
*
|
|
* @param string $id The service id
|
|
* @param Definition $definition
|
|
*
|
|
* @return string
|
|
*/
|
|
private function addServiceInclude($id, $definition)
|
|
{
|
|
$template = " require_once %s;\n";
|
|
$code = '';
|
|
|
|
if (null !== $file = $definition->getFile()) {
|
|
$code .= sprintf($template, $this->dumpValue($file));
|
|
}
|
|
|
|
foreach ($this->getInlinedDefinitions($definition) as $definition) {
|
|
if (null !== $file = $definition->getFile()) {
|
|
$code .= sprintf($template, $this->dumpValue($file));
|
|
}
|
|
}
|
|
|
|
if ('' !== $code) {
|
|
$code .= "\n";
|
|
}
|
|
|
|
return $code;
|
|
}
|
|
|
|
/**
|
|
* Generates the inline definition of a service.
|
|
*
|
|
* @param string $id
|
|
* @param Definition $definition
|
|
*
|
|
* @return string
|
|
*
|
|
* @throws RuntimeException When the factory definition is incomplete
|
|
* @throws ServiceCircularReferenceException When a circular reference is detected
|
|
*/
|
|
private function addServiceInlinedDefinitions($id, $definition)
|
|
{
|
|
$code = '';
|
|
$variableMap = $this->definitionVariables;
|
|
$nbOccurrences = new \SplObjectStorage();
|
|
$processed = new \SplObjectStorage();
|
|
$inlinedDefinitions = $this->getInlinedDefinitions($definition);
|
|
|
|
foreach ($inlinedDefinitions as $definition) {
|
|
if (false === $nbOccurrences->contains($definition)) {
|
|
$nbOccurrences->offsetSet($definition, 1);
|
|
} else {
|
|
$i = $nbOccurrences->offsetGet($definition);
|
|
$nbOccurrences->offsetSet($definition, $i + 1);
|
|
}
|
|
}
|
|
|
|
foreach ($inlinedDefinitions as $sDefinition) {
|
|
if ($processed->contains($sDefinition)) {
|
|
continue;
|
|
}
|
|
$processed->offsetSet($sDefinition);
|
|
|
|
$class = $this->dumpValue($sDefinition->getClass());
|
|
if ($nbOccurrences->offsetGet($sDefinition) > 1 || $sDefinition->getMethodCalls() || $sDefinition->getProperties() || null !== $sDefinition->getConfigurator() || false !== strpos($class, '$')) {
|
|
$name = $this->getNextVariableName();
|
|
$variableMap->offsetSet($sDefinition, new Variable($name));
|
|
|
|
// a construct like:
|
|
// $a = new ServiceA(ServiceB $b); $b = new ServiceB(ServiceA $a);
|
|
// this is an indication for a wrong implementation, you can circumvent this problem
|
|
// by setting up your service structure like this:
|
|
// $b = new ServiceB();
|
|
// $a = new ServiceA(ServiceB $b);
|
|
// $b->setServiceA(ServiceA $a);
|
|
if ($this->hasReference($id, $sDefinition->getArguments())) {
|
|
throw new ServiceCircularReferenceException($id, array($id));
|
|
}
|
|
|
|
$code .= $this->addNewInstance($sDefinition, '$'.$name, ' = ', $id);
|
|
|
|
if (!$this->hasReference($id, $sDefinition->getMethodCalls(), true) && !$this->hasReference($id, $sDefinition->getProperties(), true)) {
|
|
$code .= $this->addServiceProperties(null, $sDefinition, $name);
|
|
$code .= $this->addServiceMethodCalls(null, $sDefinition, $name);
|
|
$code .= $this->addServiceConfigurator(null, $sDefinition, $name);
|
|
}
|
|
|
|
$code .= "\n";
|
|
}
|
|
}
|
|
|
|
return $code;
|
|
}
|
|
|
|
/**
|
|
* Adds the service return statement.
|
|
*
|
|
* @param string $id Service id
|
|
* @param Definition $definition
|
|
*
|
|
* @return string
|
|
*/
|
|
private function addServiceReturn($id, $definition)
|
|
{
|
|
if ($this->isSimpleInstance($id, $definition)) {
|
|
return " }\n";
|
|
}
|
|
|
|
return "\n return \$instance;\n }\n";
|
|
}
|
|
|
|
/**
|
|
* Generates the service instance.
|
|
*
|
|
* @param string $id
|
|
* @param Definition $definition
|
|
*
|
|
* @return string
|
|
*
|
|
* @throws InvalidArgumentException
|
|
* @throws RuntimeException
|
|
*/
|
|
private function addServiceInstance($id, Definition $definition)
|
|
{
|
|
$class = $definition->getClass();
|
|
|
|
if ('\\' === substr($class, 0, 1)) {
|
|
$class = substr($class, 1);
|
|
}
|
|
|
|
$class = $this->dumpValue($class);
|
|
|
|
if (0 === strpos($class, "'") && false === strpos($class, '$') && !preg_match('/^\'[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*(\\\{2}[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*)*\'$/', $class)) {
|
|
throw new InvalidArgumentException(sprintf('"%s" is not a valid class name for the "%s" service.', $class, $id));
|
|
}
|
|
|
|
$simple = $this->isSimpleInstance($id, $definition);
|
|
$isProxyCandidate = $this->getProxyDumper()->isProxyCandidate($definition);
|
|
$instantiation = '';
|
|
|
|
if (!$isProxyCandidate && $definition->isShared()) {
|
|
$instantiation = "\$this->services['$id'] = ".($simple ? '' : '$instance');
|
|
} elseif (!$simple) {
|
|
$instantiation = '$instance';
|
|
}
|
|
|
|
$return = '';
|
|
if ($simple) {
|
|
$return = 'return ';
|
|
} else {
|
|
$instantiation .= ' = ';
|
|
}
|
|
|
|
$code = $this->addNewInstance($definition, $return, $instantiation, $id);
|
|
|
|
if (!$simple) {
|
|
$code .= "\n";
|
|
}
|
|
|
|
return $code;
|
|
}
|
|
|
|
/**
|
|
* Checks if the definition is a simple instance.
|
|
*
|
|
* @param string $id
|
|
* @param Definition $definition
|
|
*
|
|
* @return bool
|
|
*/
|
|
private function isSimpleInstance($id, Definition $definition)
|
|
{
|
|
foreach (array_merge(array($definition), $this->getInlinedDefinitions($definition)) as $sDefinition) {
|
|
if ($definition !== $sDefinition && !$this->hasReference($id, $sDefinition->getMethodCalls())) {
|
|
continue;
|
|
}
|
|
|
|
if ($sDefinition->getMethodCalls() || $sDefinition->getProperties() || $sDefinition->getConfigurator()) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Adds method calls to a service definition.
|
|
*
|
|
* @param string $id
|
|
* @param Definition $definition
|
|
* @param string $variableName
|
|
*
|
|
* @return string
|
|
*/
|
|
private function addServiceMethodCalls($id, Definition $definition, $variableName = 'instance')
|
|
{
|
|
$calls = '';
|
|
foreach ($definition->getMethodCalls() as $call) {
|
|
$arguments = array();
|
|
foreach ($call[1] as $value) {
|
|
$arguments[] = $this->dumpValue($value);
|
|
}
|
|
|
|
$calls .= $this->wrapServiceConditionals($call[1], sprintf(" \$%s->%s(%s);\n", $variableName, $call[0], implode(', ', $arguments)));
|
|
}
|
|
|
|
return $calls;
|
|
}
|
|
|
|
private function addServiceProperties($id, Definition $definition, $variableName = 'instance')
|
|
{
|
|
$code = '';
|
|
foreach ($definition->getProperties() as $name => $value) {
|
|
$code .= sprintf(" \$%s->%s = %s;\n", $variableName, $name, $this->dumpValue($value));
|
|
}
|
|
|
|
return $code;
|
|
}
|
|
|
|
/**
|
|
* Generates the inline definition setup.
|
|
*
|
|
* @param string $id
|
|
* @param Definition $definition
|
|
*
|
|
* @return string
|
|
*
|
|
* @throws ServiceCircularReferenceException when the container contains a circular reference
|
|
*/
|
|
private function addServiceInlinedDefinitionsSetup($id, Definition $definition)
|
|
{
|
|
$this->referenceVariables[$id] = new Variable('instance');
|
|
|
|
$code = '';
|
|
$processed = new \SplObjectStorage();
|
|
foreach ($this->getInlinedDefinitions($definition) as $iDefinition) {
|
|
if ($processed->contains($iDefinition)) {
|
|
continue;
|
|
}
|
|
$processed->offsetSet($iDefinition);
|
|
|
|
if (!$this->hasReference($id, $iDefinition->getMethodCalls(), true) && !$this->hasReference($id, $iDefinition->getProperties(), true)) {
|
|
continue;
|
|
}
|
|
|
|
// if the instance is simple, the return statement has already been generated
|
|
// so, the only possible way to get there is because of a circular reference
|
|
if ($this->isSimpleInstance($id, $definition)) {
|
|
throw new ServiceCircularReferenceException($id, array($id));
|
|
}
|
|
|
|
$name = (string) $this->definitionVariables->offsetGet($iDefinition);
|
|
$code .= $this->addServiceProperties(null, $iDefinition, $name);
|
|
$code .= $this->addServiceMethodCalls(null, $iDefinition, $name);
|
|
$code .= $this->addServiceConfigurator(null, $iDefinition, $name);
|
|
}
|
|
|
|
if ('' !== $code) {
|
|
$code .= "\n";
|
|
}
|
|
|
|
return $code;
|
|
}
|
|
|
|
/**
|
|
* Adds configurator definition.
|
|
*
|
|
* @param string $id
|
|
* @param Definition $definition
|
|
* @param string $variableName
|
|
*
|
|
* @return string
|
|
*/
|
|
private function addServiceConfigurator($id, Definition $definition, $variableName = 'instance')
|
|
{
|
|
if (!$callable = $definition->getConfigurator()) {
|
|
return '';
|
|
}
|
|
|
|
if (is_array($callable)) {
|
|
if ($callable[0] instanceof Reference
|
|
|| ($callable[0] instanceof Definition && $this->definitionVariables->contains($callable[0]))) {
|
|
return sprintf(" %s->%s(\$%s);\n", $this->dumpValue($callable[0]), $callable[1], $variableName);
|
|
}
|
|
|
|
$class = $this->dumpValue($callable[0]);
|
|
// If the class is a string we can optimize call_user_func away
|
|
if (0 === strpos($class, "'") && false === strpos($class, '$')) {
|
|
return sprintf(" %s::%s(\$%s);\n", $this->dumpLiteralClass($class), $callable[1], $variableName);
|
|
}
|
|
|
|
if (0 === strpos($class, 'new ')) {
|
|
return sprintf(" (%s)->%s(\$%s);\n", $this->dumpValue($callable[0]), $callable[1], $variableName);
|
|
}
|
|
|
|
return sprintf(" call_user_func(array(%s, '%s'), \$%s);\n", $this->dumpValue($callable[0]), $callable[1], $variableName);
|
|
}
|
|
|
|
return sprintf(" %s(\$%s);\n", $callable, $variableName);
|
|
}
|
|
|
|
/**
|
|
* Adds a service.
|
|
*
|
|
* @param string $id
|
|
* @param Definition $definition
|
|
*
|
|
* @return string
|
|
*/
|
|
private function addService($id, Definition $definition)
|
|
{
|
|
if ($definition->isSynthetic()) {
|
|
return '';
|
|
}
|
|
$this->definitionVariables = new \SplObjectStorage();
|
|
$this->referenceVariables = array();
|
|
$this->variableCount = 0;
|
|
|
|
$return = array();
|
|
|
|
if ($class = $definition->getClass()) {
|
|
$class = $this->container->resolveEnvPlaceholders($class);
|
|
$return[] = sprintf('@return %s A %s instance', 0 === strpos($class, '%') ? 'object' : '\\'.ltrim($class, '\\'), ltrim($class, '\\'));
|
|
} elseif ($definition->getFactory()) {
|
|
$factory = $definition->getFactory();
|
|
if (is_string($factory)) {
|
|
$return[] = sprintf('@return object An instance returned by %s()', $factory);
|
|
} elseif (is_array($factory) && (is_string($factory[0]) || $factory[0] instanceof Definition || $factory[0] instanceof Reference)) {
|
|
if (is_string($factory[0]) || $factory[0] instanceof Reference) {
|
|
$return[] = sprintf('@return object An instance returned by %s::%s()', (string) $factory[0], $factory[1]);
|
|
} elseif ($factory[0] instanceof Definition) {
|
|
$return[] = sprintf('@return object An instance returned by %s::%s()', $factory[0]->getClass(), $factory[1]);
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($definition->isDeprecated()) {
|
|
if ($return && 0 === strpos($return[count($return) - 1], '@return')) {
|
|
$return[] = '';
|
|
}
|
|
|
|
$return[] = sprintf('@deprecated %s', $definition->getDeprecationMessage($id));
|
|
}
|
|
|
|
$return = str_replace("\n * \n", "\n *\n", implode("\n * ", $return));
|
|
$return = $this->container->resolveEnvPlaceholders($return);
|
|
|
|
$doc = '';
|
|
if ($definition->isShared()) {
|
|
$doc .= <<<'EOF'
|
|
|
|
*
|
|
* This service is shared.
|
|
* This method always returns the same instance of the service.
|
|
EOF;
|
|
}
|
|
|
|
if (!$definition->isPublic()) {
|
|
$doc .= <<<'EOF'
|
|
|
|
*
|
|
* This service is private.
|
|
* If you want to be able to request this service from the container directly,
|
|
* make it public, otherwise you might end up with broken code.
|
|
EOF;
|
|
}
|
|
|
|
if ($definition->isAutowired()) {
|
|
$doc .= <<<EOF
|
|
|
|
*
|
|
* This service is autowired.
|
|
EOF;
|
|
}
|
|
|
|
if ($definition->isLazy()) {
|
|
$lazyInitialization = '$lazyLoad = true';
|
|
$lazyInitializationDoc = "\n * @param bool \$lazyLoad whether to try lazy-loading the service with a proxy\n *";
|
|
} else {
|
|
$lazyInitialization = '';
|
|
$lazyInitializationDoc = '';
|
|
}
|
|
|
|
// with proxies, for 5.3.3 compatibility, the getter must be public to be accessible to the initializer
|
|
$isProxyCandidate = $this->getProxyDumper()->isProxyCandidate($definition);
|
|
$visibility = $isProxyCandidate ? 'public' : 'protected';
|
|
$methodName = $this->generateMethodName($id);
|
|
$code = <<<EOF
|
|
|
|
/*{$this->docStar}
|
|
* Gets the '$id' service.$doc
|
|
*$lazyInitializationDoc
|
|
* $return
|
|
*/
|
|
{$visibility} function {$methodName}($lazyInitialization)
|
|
{
|
|
|
|
EOF;
|
|
|
|
$code .= $isProxyCandidate ? $this->getProxyDumper()->getProxyFactoryCode($definition, $id, $methodName) : '';
|
|
|
|
if ($definition->isDeprecated()) {
|
|
$code .= sprintf(" @trigger_error(%s, E_USER_DEPRECATED);\n\n", $this->export($definition->getDeprecationMessage($id)));
|
|
}
|
|
|
|
$code .=
|
|
$this->addServiceInclude($id, $definition).
|
|
$this->addServiceLocalTempVariables($id, $definition).
|
|
$this->addServiceInlinedDefinitions($id, $definition).
|
|
$this->addServiceInstance($id, $definition).
|
|
$this->addServiceInlinedDefinitionsSetup($id, $definition).
|
|
$this->addServiceProperties($id, $definition).
|
|
$this->addServiceMethodCalls($id, $definition).
|
|
$this->addServiceConfigurator($id, $definition).
|
|
$this->addServiceReturn($id, $definition)
|
|
;
|
|
|
|
$this->definitionVariables = null;
|
|
$this->referenceVariables = null;
|
|
|
|
return $code;
|
|
}
|
|
|
|
/**
|
|
* Adds multiple services.
|
|
*
|
|
* @return string
|
|
*/
|
|
private function addServices()
|
|
{
|
|
$publicServices = $privateServices = '';
|
|
$definitions = $this->container->getDefinitions();
|
|
ksort($definitions);
|
|
foreach ($definitions as $id => $definition) {
|
|
if ($definition->isPublic()) {
|
|
$publicServices .= $this->addService($id, $definition);
|
|
} else {
|
|
$privateServices .= $this->addService($id, $definition);
|
|
}
|
|
}
|
|
|
|
return $publicServices.$privateServices;
|
|
}
|
|
|
|
private function addNewInstance(Definition $definition, $return, $instantiation, $id)
|
|
{
|
|
$class = $this->dumpValue($definition->getClass());
|
|
|
|
$arguments = array();
|
|
foreach ($definition->getArguments() as $value) {
|
|
$arguments[] = $this->dumpValue($value);
|
|
}
|
|
|
|
if (null !== $definition->getFactory()) {
|
|
$callable = $definition->getFactory();
|
|
if (is_array($callable)) {
|
|
if (!preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/', $callable[1])) {
|
|
throw new RuntimeException(sprintf('Cannot dump definition because of invalid factory method (%s)', $callable[1] ?: 'n/a'));
|
|
}
|
|
|
|
if ($callable[0] instanceof Reference
|
|
|| ($callable[0] instanceof Definition && $this->definitionVariables->contains($callable[0]))) {
|
|
return sprintf(" $return{$instantiation}%s->%s(%s);\n", $this->dumpValue($callable[0]), $callable[1], $arguments ? implode(', ', $arguments) : '');
|
|
}
|
|
|
|
$class = $this->dumpValue($callable[0]);
|
|
// If the class is a string we can optimize call_user_func away
|
|
if (0 === strpos($class, "'") && false === strpos($class, '$')) {
|
|
if ("''" === $class) {
|
|
throw new RuntimeException(sprintf('Cannot dump definition: The "%s" service is defined to be created by a factory but is missing the service reference, did you forget to define the factory service id or class?', $id));
|
|
}
|
|
|
|
return sprintf(" $return{$instantiation}%s::%s(%s);\n", $this->dumpLiteralClass($class), $callable[1], $arguments ? implode(', ', $arguments) : '');
|
|
}
|
|
|
|
if (0 === strpos($class, 'new ')) {
|
|
return sprintf(" $return{$instantiation}(%s)->%s(%s);\n", $this->dumpValue($callable[0]), $callable[1], $arguments ? implode(', ', $arguments) : '');
|
|
}
|
|
|
|
return sprintf(" $return{$instantiation}call_user_func(array(%s, '%s')%s);\n", $this->dumpValue($callable[0]), $callable[1], $arguments ? ', '.implode(', ', $arguments) : '');
|
|
}
|
|
|
|
return sprintf(" $return{$instantiation}%s(%s);\n", $this->dumpLiteralClass($this->dumpValue($callable)), $arguments ? implode(', ', $arguments) : '');
|
|
}
|
|
|
|
if (false !== strpos($class, '$')) {
|
|
return sprintf(" \$class = %s;\n\n $return{$instantiation}new \$class(%s);\n", $class, implode(', ', $arguments));
|
|
}
|
|
|
|
return sprintf(" $return{$instantiation}new %s(%s);\n", $this->dumpLiteralClass($class), implode(', ', $arguments));
|
|
}
|
|
|
|
/**
|
|
* Adds the class headers.
|
|
*
|
|
* @param string $class Class name
|
|
* @param string $baseClass The name of the base class
|
|
* @param string $namespace The class namespace
|
|
*
|
|
* @return string
|
|
*/
|
|
private function startClass($class, $baseClass, $namespace)
|
|
{
|
|
$bagClass = $this->container->isCompiled() ? 'use Symfony\Component\DependencyInjection\ParameterBag\FrozenParameterBag;' : 'use Symfony\Component\DependencyInjection\ParameterBag\\ParameterBag;';
|
|
$namespaceLine = $namespace ? "namespace $namespace;\n" : '';
|
|
|
|
return <<<EOF
|
|
<?php
|
|
$namespaceLine
|
|
use Symfony\Component\DependencyInjection\Argument\RewindableGenerator;
|
|
use Symfony\Component\DependencyInjection\ContainerInterface;
|
|
use Symfony\Component\DependencyInjection\Container;
|
|
use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
|
|
use Symfony\Component\DependencyInjection\Exception\LogicException;
|
|
use Symfony\Component\DependencyInjection\Exception\RuntimeException;
|
|
$bagClass
|
|
|
|
/*{$this->docStar}
|
|
* $class.
|
|
*
|
|
* This class has been auto-generated
|
|
* by the Symfony Dependency Injection Component.
|
|
*
|
|
* @final since Symfony 3.3
|
|
*/
|
|
class $class extends $baseClass
|
|
{
|
|
private \$parameters;
|
|
private \$targetDirs = array();
|
|
|
|
EOF;
|
|
}
|
|
|
|
/**
|
|
* Adds the constructor.
|
|
*
|
|
* @return string
|
|
*/
|
|
private function addConstructor()
|
|
{
|
|
$targetDirs = $this->exportTargetDirs();
|
|
$arguments = $this->container->getParameterBag()->all() ? 'new ParameterBag($this->getDefaultParameters())' : null;
|
|
|
|
$code = <<<EOF
|
|
|
|
/*{$this->docStar}
|
|
* Constructor.
|
|
*/
|
|
public function __construct()
|
|
{{$targetDirs}
|
|
parent::__construct($arguments);
|
|
|
|
EOF;
|
|
|
|
$code .= $this->addNormalizedIds();
|
|
$code .= $this->addMethodMap();
|
|
$code .= $this->addPrivateServices();
|
|
$code .= $this->addAliases();
|
|
|
|
$code .= <<<'EOF'
|
|
}
|
|
|
|
EOF;
|
|
|
|
return $code;
|
|
}
|
|
|
|
/**
|
|
* Adds the constructor for a compiled container.
|
|
*
|
|
* @return string
|
|
*/
|
|
private function addFrozenConstructor()
|
|
{
|
|
$targetDirs = $this->exportTargetDirs();
|
|
|
|
$code = <<<EOF
|
|
|
|
/*{$this->docStar}
|
|
* Constructor.
|
|
*/
|
|
public function __construct()
|
|
{{$targetDirs}
|
|
EOF;
|
|
|
|
if ($this->container->getParameterBag()->all()) {
|
|
$code .= "\n \$this->parameters = \$this->getDefaultParameters();\n";
|
|
}
|
|
|
|
$code .= "\n \$this->services = array();\n";
|
|
$code .= $this->addNormalizedIds();
|
|
$code .= $this->addMethodMap();
|
|
$code .= $this->addPrivateServices();
|
|
$code .= $this->addAliases();
|
|
|
|
$code .= <<<'EOF'
|
|
}
|
|
|
|
EOF;
|
|
|
|
return $code;
|
|
}
|
|
|
|
/**
|
|
* Adds the compile method for a compiled container.
|
|
*
|
|
* @return string
|
|
*/
|
|
private function addFrozenCompile()
|
|
{
|
|
return <<<EOF
|
|
|
|
/*{$this->docStar}
|
|
* {@inheritdoc}
|
|
*/
|
|
public function compile()
|
|
{
|
|
throw new LogicException('You cannot compile a dumped container that was already compiled.');
|
|
}
|
|
|
|
EOF;
|
|
}
|
|
|
|
/**
|
|
* Adds the isCompiled method for a compiled container.
|
|
*
|
|
* @return string
|
|
*/
|
|
private function addFrozenIsCompiled()
|
|
{
|
|
return <<<EOF
|
|
|
|
/*{$this->docStar}
|
|
* {@inheritdoc}
|
|
*/
|
|
public function isCompiled()
|
|
{
|
|
return true;
|
|
}
|
|
|
|
/*{$this->docStar}
|
|
* {@inheritdoc}
|
|
*/
|
|
public function isFrozen()
|
|
{
|
|
@trigger_error(sprintf('The %s() method is deprecated since version 3.3 and will be removed in 4.0. Use the isCompiled() method instead.', __METHOD__), E_USER_DEPRECATED);
|
|
|
|
return true;
|
|
}
|
|
|
|
EOF;
|
|
}
|
|
|
|
/**
|
|
* Adds the normalizedIds property definition.
|
|
*
|
|
* @return string
|
|
*/
|
|
private function addNormalizedIds()
|
|
{
|
|
$code = '';
|
|
$normalizedIds = $this->container->getNormalizedIds();
|
|
ksort($normalizedIds);
|
|
foreach ($normalizedIds as $id => $normalizedId) {
|
|
if ($this->container->has($normalizedId)) {
|
|
$code .= ' '.$this->export($id).' => '.$this->export($normalizedId).",\n";
|
|
}
|
|
}
|
|
|
|
return $code ? " \$this->normalizedIds = array(\n".$code." );\n" : '';
|
|
}
|
|
|
|
/**
|
|
* Adds the methodMap property definition.
|
|
*
|
|
* @return string
|
|
*/
|
|
private function addMethodMap()
|
|
{
|
|
$definitions = $this->container->getDefinitions();
|
|
if (!$definitions || !$definitions = array_filter($definitions, function ($def) { return !$def->isSynthetic(); })) {
|
|
return '';
|
|
}
|
|
|
|
$code = " \$this->methodMap = array(\n";
|
|
ksort($definitions);
|
|
foreach ($definitions as $id => $definition) {
|
|
$code .= ' '.$this->export($id).' => '.$this->export($this->generateMethodName($id)).",\n";
|
|
}
|
|
|
|
return $code." );\n";
|
|
}
|
|
|
|
/**
|
|
* Adds the privates property definition.
|
|
*
|
|
* @return string
|
|
*/
|
|
private function addPrivateServices()
|
|
{
|
|
if (!$definitions = $this->container->getDefinitions()) {
|
|
return '';
|
|
}
|
|
|
|
$code = '';
|
|
ksort($definitions);
|
|
foreach ($definitions as $id => $definition) {
|
|
if (!$definition->isPublic()) {
|
|
$code .= ' '.$this->export($id)." => true,\n";
|
|
}
|
|
}
|
|
|
|
if (empty($code)) {
|
|
return '';
|
|
}
|
|
|
|
$out = " \$this->privates = array(\n";
|
|
$out .= $code;
|
|
$out .= " );\n";
|
|
|
|
return $out;
|
|
}
|
|
|
|
/**
|
|
* Adds the aliases property definition.
|
|
*
|
|
* @return string
|
|
*/
|
|
private function addAliases()
|
|
{
|
|
if (!$aliases = $this->container->getAliases()) {
|
|
return $this->container->isCompiled() ? "\n \$this->aliases = array();\n" : '';
|
|
}
|
|
|
|
$code = " \$this->aliases = array(\n";
|
|
ksort($aliases);
|
|
foreach ($aliases as $alias => $id) {
|
|
$id = (string) $id;
|
|
while (isset($aliases[$id])) {
|
|
$id = (string) $aliases[$id];
|
|
}
|
|
$code .= ' '.$this->export($alias).' => '.$this->export($id).",\n";
|
|
}
|
|
|
|
return $code." );\n";
|
|
}
|
|
|
|
/**
|
|
* Adds default parameters method.
|
|
*
|
|
* @return string
|
|
*/
|
|
private function addDefaultParametersMethod()
|
|
{
|
|
if (!$this->container->getParameterBag()->all()) {
|
|
return '';
|
|
}
|
|
|
|
$php = array();
|
|
$dynamicPhp = array();
|
|
|
|
foreach ($this->container->getParameterBag()->all() as $key => $value) {
|
|
if ($key !== $resolvedKey = $this->container->resolveEnvPlaceholders($key)) {
|
|
throw new InvalidArgumentException(sprintf('Parameter name cannot use env parameters: %s.', $resolvedKey));
|
|
}
|
|
$export = $this->exportParameters(array($value));
|
|
$export = explode('0 => ', substr(rtrim($export, " )\n"), 7, -1), 2);
|
|
|
|
if (preg_match("/\\\$this->(?:getEnv\('\w++'\)|targetDirs\[\d++\])/", $export[1])) {
|
|
$dynamicPhp[$key] = sprintf('%scase %s: $value = %s; break;', $export[0], $this->export($key), $export[1]);
|
|
} else {
|
|
$php[] = sprintf('%s%s => %s,', $export[0], $this->export($key), $export[1]);
|
|
}
|
|
}
|
|
$parameters = sprintf("array(\n%s\n%s)", implode("\n", $php), str_repeat(' ', 8));
|
|
|
|
$code = '';
|
|
if ($this->container->isCompiled()) {
|
|
$code .= <<<'EOF'
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getParameter($name)
|
|
{
|
|
$name = strtolower($name);
|
|
|
|
if (!(isset($this->parameters[$name]) || array_key_exists($name, $this->parameters) || isset($this->loadedDynamicParameters[$name]))) {
|
|
throw new InvalidArgumentException(sprintf('The parameter "%s" must be defined.', $name));
|
|
}
|
|
if (isset($this->loadedDynamicParameters[$name])) {
|
|
return $this->loadedDynamicParameters[$name] ? $this->dynamicParameters[$name] : $this->getDynamicParameter($name);
|
|
}
|
|
|
|
return $this->parameters[$name];
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function hasParameter($name)
|
|
{
|
|
$name = strtolower($name);
|
|
|
|
return isset($this->parameters[$name]) || array_key_exists($name, $this->parameters) || isset($this->loadedDynamicParameters[$name]);
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function setParameter($name, $value)
|
|
{
|
|
throw new LogicException('Impossible to call set() on a frozen ParameterBag.');
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getParameterBag()
|
|
{
|
|
if (null === $this->parameterBag) {
|
|
$parameters = $this->parameters;
|
|
foreach ($this->loadedDynamicParameters as $name => $loaded) {
|
|
$parameters[$name] = $loaded ? $this->dynamicParameters[$name] : $this->getDynamicParameter($name);
|
|
}
|
|
$this->parameterBag = new FrozenParameterBag($parameters);
|
|
}
|
|
|
|
return $this->parameterBag;
|
|
}
|
|
|
|
EOF;
|
|
if ('' === $this->docStar) {
|
|
$code = str_replace('/**', '/*', $code);
|
|
}
|
|
|
|
if ($dynamicPhp) {
|
|
$loadedDynamicParameters = $this->exportParameters(array_combine(array_keys($dynamicPhp), array_fill(0, count($dynamicPhp), false)), '', 8);
|
|
$getDynamicParameter = <<<'EOF'
|
|
switch ($name) {
|
|
%s
|
|
default: throw new InvalidArgumentException(sprintf('The dynamic parameter "%%s" must be defined.', $name));
|
|
}
|
|
$this->loadedDynamicParameters[$name] = true;
|
|
|
|
return $this->dynamicParameters[$name] = $value;
|
|
EOF;
|
|
$getDynamicParameter = sprintf($getDynamicParameter, implode("\n", $dynamicPhp));
|
|
} else {
|
|
$loadedDynamicParameters = 'array()';
|
|
$getDynamicParameter = str_repeat(' ', 8).'throw new InvalidArgumentException(sprintf(\'The dynamic parameter "%s" must be defined.\', $name));';
|
|
}
|
|
|
|
$code .= <<<EOF
|
|
|
|
private \$loadedDynamicParameters = {$loadedDynamicParameters};
|
|
private \$dynamicParameters = array();
|
|
|
|
/*{$this->docStar}
|
|
* Computes a dynamic parameter.
|
|
*
|
|
* @param string The name of the dynamic parameter to load
|
|
*
|
|
* @return mixed The value of the dynamic parameter
|
|
*
|
|
* @throws InvalidArgumentException When the dynamic parameter does not exist
|
|
*/
|
|
private function getDynamicParameter(\$name)
|
|
{
|
|
{$getDynamicParameter}
|
|
}
|
|
|
|
EOF;
|
|
} elseif ($dynamicPhp) {
|
|
throw new RuntimeException('You cannot dump a not-frozen container with dynamic parameters.');
|
|
}
|
|
|
|
$code .= <<<EOF
|
|
|
|
/*{$this->docStar}
|
|
* Gets the default parameters.
|
|
*
|
|
* @return array An array of the default parameters
|
|
*/
|
|
protected function getDefaultParameters()
|
|
{
|
|
return $parameters;
|
|
}
|
|
|
|
EOF;
|
|
|
|
return $code;
|
|
}
|
|
|
|
/**
|
|
* Exports parameters.
|
|
*
|
|
* @param array $parameters
|
|
* @param string $path
|
|
* @param int $indent
|
|
*
|
|
* @return string
|
|
*
|
|
* @throws InvalidArgumentException
|
|
*/
|
|
private function exportParameters(array $parameters, $path = '', $indent = 12)
|
|
{
|
|
$php = array();
|
|
foreach ($parameters as $key => $value) {
|
|
if (is_array($value)) {
|
|
$value = $this->exportParameters($value, $path.'/'.$key, $indent + 4);
|
|
} elseif ($value instanceof ArgumentInterface) {
|
|
throw new InvalidArgumentException(sprintf('You cannot dump a container with parameters that contain special arguments. "%s" found in "%s".', get_class($value), $path.'/'.$key));
|
|
} elseif ($value instanceof Variable) {
|
|
throw new InvalidArgumentException(sprintf('You cannot dump a container with parameters that contain variable references. Variable "%s" found in "%s".', $value, $path.'/'.$key));
|
|
} elseif ($value instanceof Definition) {
|
|
throw new InvalidArgumentException(sprintf('You cannot dump a container with parameters that contain service definitions. Definition for "%s" found in "%s".', $value->getClass(), $path.'/'.$key));
|
|
} elseif ($value instanceof Reference) {
|
|
throw new InvalidArgumentException(sprintf('You cannot dump a container with parameters that contain references to other services (reference to service "%s" found in "%s").', $value, $path.'/'.$key));
|
|
} elseif ($value instanceof Expression) {
|
|
throw new InvalidArgumentException(sprintf('You cannot dump a container with parameters that contain expressions. Expression "%s" found in "%s".', $value, $path.'/'.$key));
|
|
} else {
|
|
$value = $this->export($value);
|
|
}
|
|
|
|
$php[] = sprintf('%s%s => %s,', str_repeat(' ', $indent), $this->export($key), $value);
|
|
}
|
|
|
|
return sprintf("array(\n%s\n%s)", implode("\n", $php), str_repeat(' ', $indent - 4));
|
|
}
|
|
|
|
/**
|
|
* Ends the class definition.
|
|
*
|
|
* @return string
|
|
*/
|
|
private function endClass()
|
|
{
|
|
return <<<'EOF'
|
|
}
|
|
|
|
EOF;
|
|
}
|
|
|
|
/**
|
|
* Wraps the service conditionals.
|
|
*
|
|
* @param string $value
|
|
* @param string $code
|
|
*
|
|
* @return string
|
|
*/
|
|
private function wrapServiceConditionals($value, $code)
|
|
{
|
|
if (!$condition = $this->getServiceConditionals($value)) {
|
|
return $code;
|
|
}
|
|
|
|
// re-indent the wrapped code
|
|
$code = implode("\n", array_map(function ($line) { return $line ? ' '.$line : $line; }, explode("\n", $code)));
|
|
|
|
return sprintf(" if (%s) {\n%s }\n", $condition, $code);
|
|
}
|
|
|
|
/**
|
|
* Get the conditions to execute for conditional services.
|
|
*
|
|
* @param string $value
|
|
*
|
|
* @return null|string
|
|
*/
|
|
private function getServiceConditionals($value)
|
|
{
|
|
if (!$services = ContainerBuilder::getServiceConditionals($value)) {
|
|
return null;
|
|
}
|
|
|
|
$conditions = array();
|
|
foreach ($services as $service) {
|
|
$conditions[] = sprintf("\$this->has('%s')", $service);
|
|
}
|
|
|
|
return implode(' && ', $conditions);
|
|
}
|
|
|
|
/**
|
|
* Builds service calls from arguments.
|
|
*
|
|
* @param array $arguments
|
|
* @param array &$calls By reference
|
|
* @param array &$behavior By reference
|
|
*/
|
|
private function getServiceCallsFromArguments(array $arguments, array &$calls, array &$behavior)
|
|
{
|
|
foreach ($arguments as $argument) {
|
|
if (is_array($argument)) {
|
|
$this->getServiceCallsFromArguments($argument, $calls, $behavior);
|
|
} elseif ($argument instanceof Reference) {
|
|
$id = (string) $argument;
|
|
|
|
if (!isset($calls[$id])) {
|
|
$calls[$id] = 0;
|
|
}
|
|
if (!isset($behavior[$id])) {
|
|
$behavior[$id] = $argument->getInvalidBehavior();
|
|
} elseif (ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE !== $behavior[$id]) {
|
|
$behavior[$id] = $argument->getInvalidBehavior();
|
|
}
|
|
|
|
++$calls[$id];
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the inline definition.
|
|
*
|
|
* @param Definition $definition
|
|
*
|
|
* @return array
|
|
*/
|
|
private function getInlinedDefinitions(Definition $definition)
|
|
{
|
|
if (false === $this->inlinedDefinitions->contains($definition)) {
|
|
$definitions = array_merge(
|
|
$this->getDefinitionsFromArguments($definition->getArguments()),
|
|
$this->getDefinitionsFromArguments($definition->getMethodCalls()),
|
|
$this->getDefinitionsFromArguments($definition->getProperties()),
|
|
$this->getDefinitionsFromArguments(array($definition->getConfigurator())),
|
|
$this->getDefinitionsFromArguments(array($definition->getFactory()))
|
|
);
|
|
|
|
$this->inlinedDefinitions->offsetSet($definition, $definitions);
|
|
|
|
return $definitions;
|
|
}
|
|
|
|
return $this->inlinedDefinitions->offsetGet($definition);
|
|
}
|
|
|
|
/**
|
|
* Gets the definition from arguments.
|
|
*
|
|
* @param array $arguments
|
|
*
|
|
* @return array
|
|
*/
|
|
private function getDefinitionsFromArguments(array $arguments)
|
|
{
|
|
$definitions = array();
|
|
foreach ($arguments as $argument) {
|
|
if (is_array($argument)) {
|
|
$definitions = array_merge($definitions, $this->getDefinitionsFromArguments($argument));
|
|
} elseif ($argument instanceof ArgumentInterface) {
|
|
$definitions = array_merge($definitions, $this->getDefinitionsFromArguments($argument->getValues()));
|
|
} elseif ($argument instanceof Definition) {
|
|
$definitions = array_merge(
|
|
$definitions,
|
|
$this->getInlinedDefinitions($argument),
|
|
array($argument)
|
|
);
|
|
}
|
|
}
|
|
|
|
return $definitions;
|
|
}
|
|
|
|
/**
|
|
* Checks if a service id has a reference.
|
|
*
|
|
* @param string $id
|
|
* @param array $arguments
|
|
* @param bool $deep
|
|
* @param array $visited
|
|
*
|
|
* @return bool
|
|
*/
|
|
private function hasReference($id, array $arguments, $deep = false, array &$visited = array())
|
|
{
|
|
foreach ($arguments as $argument) {
|
|
if (is_array($argument)) {
|
|
if ($this->hasReference($id, $argument, $deep, $visited)) {
|
|
return true;
|
|
}
|
|
} elseif ($argument instanceof Reference) {
|
|
$argumentId = (string) $argument;
|
|
if ($id === $argumentId) {
|
|
return true;
|
|
}
|
|
|
|
if ($deep && !isset($visited[$argumentId]) && 'service_container' !== $argumentId) {
|
|
$visited[$argumentId] = true;
|
|
|
|
$service = $this->container->getDefinition($argumentId);
|
|
|
|
// if the proxy manager is enabled, disable searching for references in lazy services,
|
|
// as these services will be instantiated lazily and don't have direct related references.
|
|
if ($service->isLazy() && !$this->getProxyDumper() instanceof NullDumper) {
|
|
continue;
|
|
}
|
|
|
|
$arguments = array_merge($service->getMethodCalls(), $service->getArguments(), $service->getProperties());
|
|
|
|
if ($this->hasReference($id, $arguments, $deep, $visited)) {
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Dumps values.
|
|
*
|
|
* @param mixed $value
|
|
* @param bool $interpolate
|
|
*
|
|
* @return string
|
|
*
|
|
* @throws RuntimeException
|
|
*/
|
|
private function dumpValue($value, $interpolate = true)
|
|
{
|
|
if (is_array($value)) {
|
|
$code = array();
|
|
foreach ($value as $k => $v) {
|
|
$code[] = sprintf('%s => %s', $this->dumpValue($k, $interpolate), $this->dumpValue($v, $interpolate));
|
|
}
|
|
|
|
return sprintf('array(%s)', implode(', ', $code));
|
|
} elseif ($value instanceof ServiceClosureArgument) {
|
|
$value = $value->getValues()[0];
|
|
$code = $this->dumpValue($value, $interpolate);
|
|
|
|
if ($value instanceof TypedReference) {
|
|
$code = sprintf('$f = function (\\%s $v%s) { return $v; }; return $f(%s);', $value->getType(), ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE !== $value->getInvalidBehavior() ? ' = null' : '', $code);
|
|
} else {
|
|
$code = sprintf('return %s;', $code);
|
|
}
|
|
|
|
return sprintf("function () {\n %s\n }", $code);
|
|
} elseif ($value instanceof IteratorArgument) {
|
|
$countCode = array();
|
|
$countCode[] = 'function () {';
|
|
$operands = array(0);
|
|
|
|
$code = array();
|
|
$code[] = 'new RewindableGenerator(function () {';
|
|
foreach ($value->getValues() as $k => $v) {
|
|
($c = $this->getServiceConditionals($v)) ? $operands[] = "(int) ($c)" : ++$operands[0];
|
|
$v = $this->wrapServiceConditionals($v, sprintf(" yield %s => %s;\n", $this->dumpValue($k, $interpolate), $this->dumpValue($v, $interpolate)));
|
|
foreach (explode("\n", $v) as $v) {
|
|
if ($v) {
|
|
$code[] = ' '.$v;
|
|
}
|
|
}
|
|
}
|
|
|
|
$countCode[] = sprintf(' return %s;', implode(' + ', $operands));
|
|
$countCode[] = ' }';
|
|
|
|
$code[] = sprintf(' }, %s)', count($operands) > 1 ? implode("\n", $countCode) : $operands[0]);
|
|
|
|
return implode("\n", $code);
|
|
} elseif ($value instanceof Definition) {
|
|
if (null !== $this->definitionVariables && $this->definitionVariables->contains($value)) {
|
|
return $this->dumpValue($this->definitionVariables->offsetGet($value), $interpolate);
|
|
}
|
|
if ($value->getMethodCalls()) {
|
|
throw new RuntimeException('Cannot dump definitions which have method calls.');
|
|
}
|
|
if (null !== $value->getConfigurator()) {
|
|
throw new RuntimeException('Cannot dump definitions which have a configurator.');
|
|
}
|
|
|
|
$arguments = array();
|
|
foreach ($value->getArguments() as $argument) {
|
|
$arguments[] = $this->dumpValue($argument);
|
|
}
|
|
|
|
if (null !== $value->getFactory()) {
|
|
$factory = $value->getFactory();
|
|
|
|
if (is_string($factory)) {
|
|
return sprintf('%s(%s)', $this->dumpLiteralClass($this->dumpValue($factory)), implode(', ', $arguments));
|
|
}
|
|
|
|
if (is_array($factory)) {
|
|
if (!preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/', $factory[1])) {
|
|
throw new RuntimeException(sprintf('Cannot dump definition because of invalid factory method (%s)', $factory[1] ?: 'n/a'));
|
|
}
|
|
|
|
if (is_string($factory[0])) {
|
|
return sprintf('%s::%s(%s)', $this->dumpLiteralClass($this->dumpValue($factory[0])), $factory[1], implode(', ', $arguments));
|
|
}
|
|
|
|
if ($factory[0] instanceof Definition) {
|
|
return sprintf("call_user_func(array(%s, '%s')%s)", $this->dumpValue($factory[0]), $factory[1], count($arguments) > 0 ? ', '.implode(', ', $arguments) : '');
|
|
}
|
|
|
|
if ($factory[0] instanceof Reference) {
|
|
return sprintf('%s->%s(%s)', $this->dumpValue($factory[0]), $factory[1], implode(', ', $arguments));
|
|
}
|
|
}
|
|
|
|
throw new RuntimeException('Cannot dump definition because of invalid factory');
|
|
}
|
|
|
|
$class = $value->getClass();
|
|
if (null === $class) {
|
|
throw new RuntimeException('Cannot dump definitions which have no class nor factory.');
|
|
}
|
|
|
|
return sprintf('new %s(%s)', $this->dumpLiteralClass($this->dumpValue($class)), implode(', ', $arguments));
|
|
} elseif ($value instanceof ClosureProxyArgument) {
|
|
list($reference, $method) = $value->getValues();
|
|
$method = substr($this->dumpLiteralClass($this->dumpValue($method)), 1);
|
|
|
|
if ('service_container' === (string) $reference) {
|
|
$class = $this->baseClass;
|
|
} elseif (!$this->container->hasDefinition((string) $reference) && ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE !== $reference->getInvalidBehavior()) {
|
|
return 'null';
|
|
} else {
|
|
$class = substr($this->dumpLiteralClass($this->dumpValue($this->container->findDefinition((string) $reference)->getClass())), 1);
|
|
}
|
|
if (false !== strpos($class, '$') || false !== strpos($method, '$')) {
|
|
throw new RuntimeException(sprintf('Cannot dump definition for service "%s": dynamic class names or methods, and closure-proxies are incompatible with each other.', $reference));
|
|
}
|
|
if (!method_exists($class, $method)) {
|
|
throw new InvalidArgumentException(sprintf('Cannot create closure-proxy for service "%s": method "%s::%s" does not exist.', $reference, $class, $method));
|
|
}
|
|
$r = $this->container->getReflectionClass($class)->getMethod($method);
|
|
if (!$r->isPublic()) {
|
|
throw new InvalidArgumentException(sprintf('Cannot create closure-proxy for service "%s": method "%s::%s" must be public.', $reference, $class, $method));
|
|
}
|
|
$signature = preg_replace('/^(&?)[^(]*/', '$1', ProxyHelper::getSignature($r, $call));
|
|
|
|
$return = 'void' !== ProxyHelper::getTypeHint($r);
|
|
|
|
return sprintf("/** @closure-proxy %s::%s */ function %s {\n %s%s->%s;\n }", $class, $method, $signature, $return ? 'return ' : '', $this->dumpValue($reference), $call);
|
|
} elseif ($value instanceof Variable) {
|
|
return '$'.$value;
|
|
} elseif ($value instanceof Reference) {
|
|
if (null !== $this->referenceVariables && isset($this->referenceVariables[$id = (string) $value])) {
|
|
return $this->dumpValue($this->referenceVariables[$id], $interpolate);
|
|
}
|
|
|
|
return $this->getServiceCall((string) $value, $value);
|
|
} elseif ($value instanceof Expression) {
|
|
return $this->getExpressionLanguage()->compile((string) $value, array('this' => 'container'));
|
|
} elseif ($value instanceof Parameter) {
|
|
return $this->dumpParameter($value);
|
|
} elseif (true === $interpolate && is_string($value)) {
|
|
if (preg_match('/^%([^%]+)%$/', $value, $match)) {
|
|
// we do this to deal with non string values (Boolean, integer, ...)
|
|
// the preg_replace_callback converts them to strings
|
|
return $this->dumpParameter(strtolower($match[1]));
|
|
} else {
|
|
$replaceParameters = function ($match) {
|
|
return "'.".$this->dumpParameter(strtolower($match[2])).".'";
|
|
};
|
|
|
|
$code = str_replace('%%', '%', preg_replace_callback('/(?<!%)(%)([^%]+)\1/', $replaceParameters, $this->export($value)));
|
|
|
|
return $code;
|
|
}
|
|
} elseif (is_object($value) || is_resource($value)) {
|
|
throw new RuntimeException('Unable to dump a service container if a parameter is an object or a resource.');
|
|
}
|
|
|
|
return $this->export($value);
|
|
}
|
|
|
|
/**
|
|
* Dumps a string to a literal (aka PHP Code) class value.
|
|
*
|
|
* @param string $class
|
|
*
|
|
* @return string
|
|
*
|
|
* @throws RuntimeException
|
|
*/
|
|
private function dumpLiteralClass($class)
|
|
{
|
|
if (false !== strpos($class, '$')) {
|
|
return sprintf('${($_ = %s) && false ?: "_"}', $class);
|
|
}
|
|
if (0 !== strpos($class, "'") || !preg_match('/^\'[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*(\\\{2}[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*)*\'$/', $class)) {
|
|
throw new RuntimeException(sprintf('Cannot dump definition because of invalid class name (%s)', $class ?: 'n/a'));
|
|
}
|
|
|
|
return '\\'.substr(str_replace('\\\\', '\\', $class), 1, -1);
|
|
}
|
|
|
|
/**
|
|
* Dumps a parameter.
|
|
*
|
|
* @param string $name
|
|
*
|
|
* @return string
|
|
*/
|
|
private function dumpParameter($name)
|
|
{
|
|
if ($this->container->isCompiled() && $this->container->hasParameter($name)) {
|
|
return $this->dumpValue($this->container->getParameter($name), false);
|
|
}
|
|
|
|
return sprintf("\$this->getParameter('%s')", strtolower($name));
|
|
}
|
|
|
|
/**
|
|
* Gets a service call.
|
|
*
|
|
* @param string $id
|
|
* @param Reference $reference
|
|
*
|
|
* @return string
|
|
*/
|
|
private function getServiceCall($id, Reference $reference = null)
|
|
{
|
|
if ('service_container' === $id) {
|
|
return '$this';
|
|
}
|
|
|
|
if ($this->container->hasDefinition($id) && !$this->container->getDefinition($id)->isPublic()) {
|
|
$code = sprintf('$this->%s()', $this->generateMethodName($id));
|
|
} elseif (null !== $reference && ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE !== $reference->getInvalidBehavior()) {
|
|
$code = sprintf('$this->get(\'%s\', ContainerInterface::NULL_ON_INVALID_REFERENCE)', $id);
|
|
} else {
|
|
if ($this->container->hasAlias($id)) {
|
|
$id = (string) $this->container->getAlias($id);
|
|
}
|
|
|
|
$code = sprintf('$this->get(\'%s\')', $id);
|
|
}
|
|
|
|
if ($this->container->hasDefinition($id) && (!$this->container->getDefinition($id)->isPublic() || $this->container->getDefinition($id)->isShared())) {
|
|
// The following is PHP 5.5 syntax for what could be written as "(\$this->services['$id'] ?? $code)" on PHP>=7.0
|
|
|
|
$code = "\${(\$_ = isset(\$this->services['$id']) ? \$this->services['$id'] : $code) && false ?: '_'}";
|
|
}
|
|
|
|
return $code;
|
|
}
|
|
|
|
/**
|
|
* Initializes the method names map to avoid conflicts with the Container methods.
|
|
*
|
|
* @param string $class the container base class
|
|
*/
|
|
private function initializeMethodNamesMap($class)
|
|
{
|
|
$this->serviceIdToMethodNameMap = array();
|
|
$this->usedMethodNames = array();
|
|
|
|
if ($reflectionClass = $this->container->getReflectionClass($class)) {
|
|
foreach ($reflectionClass->getMethods() as $method) {
|
|
$this->usedMethodNames[strtolower($method->getName())] = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Convert a service id to a valid PHP method name.
|
|
*
|
|
* @param string $id
|
|
*
|
|
* @return string
|
|
*
|
|
* @throws InvalidArgumentException
|
|
*/
|
|
private function generateMethodName($id)
|
|
{
|
|
if (isset($this->serviceIdToMethodNameMap[$id])) {
|
|
return $this->serviceIdToMethodNameMap[$id];
|
|
}
|
|
|
|
$name = Container::camelize($id);
|
|
$name = preg_replace('/[^a-zA-Z0-9_\x7f-\xff]/', '', $name);
|
|
$methodName = 'get'.$name.'Service';
|
|
$suffix = 1;
|
|
|
|
while (isset($this->usedMethodNames[strtolower($methodName)])) {
|
|
++$suffix;
|
|
$methodName = 'get'.$name.$suffix.'Service';
|
|
}
|
|
|
|
$this->serviceIdToMethodNameMap[$id] = $methodName;
|
|
$this->usedMethodNames[strtolower($methodName)] = true;
|
|
|
|
return $methodName;
|
|
}
|
|
|
|
/**
|
|
* Returns the next name to use.
|
|
*
|
|
* @return string
|
|
*/
|
|
private function getNextVariableName()
|
|
{
|
|
$firstChars = self::FIRST_CHARS;
|
|
$firstCharsLength = strlen($firstChars);
|
|
$nonFirstChars = self::NON_FIRST_CHARS;
|
|
$nonFirstCharsLength = strlen($nonFirstChars);
|
|
|
|
while (true) {
|
|
$name = '';
|
|
$i = $this->variableCount;
|
|
|
|
if ('' === $name) {
|
|
$name .= $firstChars[$i % $firstCharsLength];
|
|
$i = (int) ($i / $firstCharsLength);
|
|
}
|
|
|
|
while ($i > 0) {
|
|
--$i;
|
|
$name .= $nonFirstChars[$i % $nonFirstCharsLength];
|
|
$i = (int) ($i / $nonFirstCharsLength);
|
|
}
|
|
|
|
++$this->variableCount;
|
|
|
|
// check that the name is not reserved
|
|
if (in_array($name, $this->reservedVariables, true)) {
|
|
continue;
|
|
}
|
|
|
|
return $name;
|
|
}
|
|
}
|
|
|
|
private function getExpressionLanguage()
|
|
{
|
|
if (null === $this->expressionLanguage) {
|
|
if (!class_exists('Symfony\Component\ExpressionLanguage\ExpressionLanguage')) {
|
|
throw new RuntimeException('Unable to use expressions as the Symfony ExpressionLanguage component is not installed.');
|
|
}
|
|
$providers = $this->container->getExpressionLanguageProviders();
|
|
$this->expressionLanguage = new ExpressionLanguage(null, $providers);
|
|
|
|
if ($this->container->isTrackingResources()) {
|
|
foreach ($providers as $provider) {
|
|
$this->container->addObjectResource($provider);
|
|
}
|
|
}
|
|
}
|
|
|
|
return $this->expressionLanguage;
|
|
}
|
|
|
|
private function exportTargetDirs()
|
|
{
|
|
return null === $this->targetDirRegex ? '' : <<<EOF
|
|
|
|
\$dir = __DIR__;
|
|
for (\$i = 1; \$i <= {$this->targetDirMaxMatches}; ++\$i) {
|
|
\$this->targetDirs[\$i] = \$dir = dirname(\$dir);
|
|
}
|
|
EOF;
|
|
}
|
|
|
|
private function export($value)
|
|
{
|
|
if (null !== $this->targetDirRegex && is_string($value) && preg_match($this->targetDirRegex, $value, $matches, PREG_OFFSET_CAPTURE)) {
|
|
$prefix = $matches[0][1] ? $this->doExport(substr($value, 0, $matches[0][1])).'.' : '';
|
|
$suffix = $matches[0][1] + strlen($matches[0][0]);
|
|
$suffix = isset($value[$suffix]) ? '.'.$this->doExport(substr($value, $suffix)) : '';
|
|
$dirname = '__DIR__';
|
|
|
|
if (0 < $offset = 1 + $this->targetDirMaxMatches - count($matches)) {
|
|
$dirname = sprintf('$this->targetDirs[%d]', $offset);
|
|
}
|
|
|
|
if ($prefix || $suffix) {
|
|
return sprintf('(%s%s%s)', $prefix, $dirname, $suffix);
|
|
}
|
|
|
|
return $dirname;
|
|
}
|
|
|
|
return $this->doExport($value);
|
|
}
|
|
|
|
private function doExport($value)
|
|
{
|
|
$export = var_export($value, true);
|
|
|
|
if ("'" === $export[0] && $export !== $resolvedExport = $this->container->resolveEnvPlaceholders($export, "'.\$this->getEnv('%s').'")) {
|
|
$export = $resolvedExport;
|
|
if ("'" === $export[1]) {
|
|
$export = substr($export, 3);
|
|
}
|
|
if (".''" === substr($export, -3)) {
|
|
$export = substr($export, 0, -3);
|
|
}
|
|
}
|
|
|
|
return $export;
|
|
}
|
|
}
|