| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733 |
- <?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\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\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.
- */
- const FIRST_CHARS = 'abcdefghijklmnopqrstuvwxyz';
- /**
- * Characters that might appear in the generated variable name as any but the first character.
- */
- 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;
- /**
- * @var ProxyDumper
- */
- private $proxyDumper;
- /**
- * {@inheritdoc}
- */
- public function __construct(ContainerBuilder $container)
- {
- if (!$container->isCompiled()) {
- @trigger_error('Dumping an uncompiled ContainerBuilder is deprecated since Symfony 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.
- */
- 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
- *
- * @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);
- if (0 !== strpos($baseClass = $options['base_class'], '\\') && 'Container' !== $baseClass) {
- $baseClass = sprintf('%s\%s', $options['namespace'] ? '\\'.$options['namespace'] : '', $baseClass);
- }
- $this->initializeMethodNamesMap('Container' === $baseClass ? Container::class : $baseClass);
- $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'], $baseClass, $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, null, 'Environment variables "%s" are never used. Please, check your container\'s configuration.');
- }
- 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 Definition $definition
- * @param array $inlinedDefinitions
- *
- * @return string
- */
- private function addServiceLocalTempVariables($cId, Definition $definition, array $inlinedDefinitions)
- {
- static $template = " \$%s = %s;\n";
- array_unshift($inlinedDefinitions, $definition);
- $calls = $behavior = array();
- foreach ($inlinedDefinitions 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.
- *
- * @return string
- */
- private function addServiceInclude(Definition $definition, array $inlinedDefinitions)
- {
- $template = " require_once %s;\n";
- $code = '';
- if (null !== $file = $definition->getFile()) {
- $code .= sprintf($template, $this->dumpValue($file));
- }
- foreach ($inlinedDefinitions 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 array $inlinedDefinitions
- *
- * @return string
- *
- * @throws RuntimeException When the factory definition is incomplete
- * @throws ServiceCircularReferenceException When a circular reference is detected
- */
- private function addServiceInlinedDefinitions($id, array $inlinedDefinitions)
- {
- $code = '';
- $variableMap = $this->definitionVariables;
- $nbOccurrences = new \SplObjectStorage();
- $processed = new \SplObjectStorage();
- 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($sDefinition, $name);
- $code .= $this->addServiceMethodCalls($sDefinition, $name);
- $code .= $this->addServiceConfigurator($sDefinition, $name);
- }
- $code .= "\n";
- }
- }
- return $code;
- }
- /**
- * Adds the service return statement.
- *
- * @param string $id
- * @param bool $isSimpleInstance
- *
- * @return string
- */
- private function addServiceReturn($id, $isSimpleInstance)
- {
- if ($isSimpleInstance) {
- return " }\n";
- }
- return "\n return \$instance;\n }\n";
- }
- /**
- * Generates the service instance.
- *
- * @param string $id
- * @param Definition $definition
- * @param bool $isSimpleInstance
- *
- * @return string
- *
- * @throws InvalidArgumentException
- * @throws RuntimeException
- */
- private function addServiceInstance($id, Definition $definition, $isSimpleInstance)
- {
- $class = $this->dumpValue($definition->getClass());
- if (0 === strpos($class, "'") && false === strpos($class, '$') && !preg_match('/^\'(?:\\\{2})?[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));
- }
- $isProxyCandidate = $this->getProxyDumper()->isProxyCandidate($definition);
- $instantiation = '';
- if (!$isProxyCandidate && $definition->isShared()) {
- $instantiation = "\$this->services['$id'] = ".($isSimpleInstance ? '' : '$instance');
- } elseif (!$isSimpleInstance) {
- $instantiation = '$instance';
- }
- $return = '';
- if ($isSimpleInstance) {
- $return = 'return ';
- } else {
- $instantiation .= ' = ';
- }
- $code = $this->addNewInstance($definition, $return, $instantiation, $id);
- if (!$isSimpleInstance) {
- $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, array $inlinedDefinitions)
- {
- foreach (array_merge(array($definition), $inlinedDefinitions) 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 Definition $definition
- * @param string $variableName
- *
- * @return string
- */
- private function addServiceMethodCalls(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(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 array $inlinedDefinitions
- * @param bool $isSimpleInstance
- *
- * @return string
- *
- * @throws ServiceCircularReferenceException when the container contains a circular reference
- */
- private function addServiceInlinedDefinitionsSetup($id, array $inlinedDefinitions, $isSimpleInstance)
- {
- $this->referenceVariables[$id] = new Variable('instance');
- $code = '';
- $processed = new \SplObjectStorage();
- foreach ($inlinedDefinitions 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 ($isSimpleInstance) {
- throw new ServiceCircularReferenceException($id, array($id));
- }
- $name = (string) $this->definitionVariables->offsetGet($iDefinition);
- $code .= $this->addServiceProperties($iDefinition, $name);
- $code .= $this->addServiceMethodCalls($iDefinition, $name);
- $code .= $this->addServiceConfigurator($iDefinition, $name);
- }
- if ('' !== $code) {
- $code .= "\n";
- }
- return $code;
- }
- /**
- * Adds configurator definition.
- *
- * @param Definition $definition
- * @param string $variableName
- *
- * @return string
- */
- private function addServiceConfigurator(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(0 === strpos($class, '%') ? '@return object A %1$s instance' : '@return \%s', 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);
- $shared = $definition->isShared() ? ' shared' : '';
- $public = $definition->isPublic() ? 'public' : 'private';
- $autowired = $definition->isAutowired() ? ' autowired' : '';
- if ($definition->isLazy()) {
- $lazyInitialization = '$lazyLoad = true';
- } else {
- $lazyInitialization = '';
- }
- // 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 $public '$id'$shared$autowired service.
- *
- * $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)));
- }
- $inlinedDefinitions = $this->getInlinedDefinitions($definition);
- $isSimpleInstance = $this->isSimpleInstance($id, $definition, $inlinedDefinitions);
- $code .=
- $this->addServiceInclude($definition, $inlinedDefinitions).
- $this->addServiceLocalTempVariables($id, $definition, $inlinedDefinitions).
- $this->addServiceInlinedDefinitions($id, $inlinedDefinitions).
- $this->addServiceInstance($id, $definition, $isSimpleInstance).
- $this->addServiceInlinedDefinitionsSetup($id, $inlinedDefinitions, $isSimpleInstance).
- $this->addServiceProperties($definition).
- $this->addServiceMethodCalls($definition).
- $this->addServiceConfigurator($definition).
- $this->addServiceReturn($id, $isSimpleInstance)
- ;
- $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());
- $return = ' '.$return.$instantiation;
- $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 $return.sprintf("%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 $return.sprintf("%s::%s(%s);\n", $this->dumpLiteralClass($class), $callable[1], $arguments ? implode(', ', $arguments) : '');
- }
- if (0 === strpos($class, 'new ')) {
- return $return.sprintf("(%s)->%s(%s);\n", $this->dumpValue($callable[0]), $callable[1], $arguments ? implode(', ', $arguments) : '');
- }
- return $return.sprintf("call_user_func(array(%s, '%s')%s);\n", $this->dumpValue($callable[0]), $callable[1], $arguments ? ', '.implode(', ', $arguments) : '');
- }
- return $return.sprintf("%s(%s);\n", $this->dumpLiteralClass($this->dumpValue($callable)), $arguments ? implode(', ', $arguments) : '');
- }
- if (false !== strpos($class, '$')) {
- return sprintf(" \$class = %s;\n\n%snew \$class(%s);\n", $class, $return, implode(', ', $arguments));
- }
- return $return.sprintf("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 ? "\nnamespace $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}
- * 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
- 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
- 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 Symfony 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->doExport($id).' => '.$this->doExport($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->doExport($id).' => '.$this->doExport($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->doExport($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->doExport($alias).' => '.$this->doExport($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) {
- if ($this->container->hasDefinition($service) && !$this->container->getDefinition($service)->isPublic()) {
- continue;
- }
- $conditions[] = sprintf("\$this->has('%s')", $service);
- }
- if (!$conditions) {
- return '';
- }
- return implode(' && ', $conditions);
- }
- /**
- * Builds service calls from arguments.
- */
- 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.
- *
- * @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.
- *
- * @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 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 ArgumentInterface) {
- $scope = array($this->definitionVariables, $this->referenceVariables, $this->variableCount);
- $this->definitionVariables = $this->referenceVariables = null;
- try {
- if ($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);
- }
- if ($value instanceof IteratorArgument) {
- $operands = array(0);
- $code = array();
- $code[] = 'new RewindableGenerator(function () {';
- if (!$values = $value->getValues()) {
- $code[] = ' return new \EmptyIterator();';
- } else {
- $countCode = array();
- $countCode[] = 'function () {';
- foreach ($values 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);
- }
- } finally {
- list($this->definitionVariables, $this->referenceVariables, $this->variableCount) = $scope;
- }
- } 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 ($value->getProperties()) {
- throw new RuntimeException('Cannot dump definitions which have properties.');
- }
- 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 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('/^\'(?:\\\{2})?[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'));
- }
- $class = substr(str_replace('\\\\', '\\', $class), 1, -1);
- return 0 === strpos($class, '\\') ? $class : '\\'.$class;
- }
- /**
- * 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)
- {
- while ($this->container->hasAlias($id)) {
- $id = (string) $this->container->getAlias($id);
- }
- 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 {
- $code = sprintf('$this->get(\'%s\')', $id);
- }
- // The following is PHP 5.5 syntax for what could be written as "(\$this->services['$id'] ?? $code)" on PHP>=7.0
- return "\${(\$_ = isset(\$this->services['$id']) ? \$this->services['$id'] : $code) && false ?: '_'}";
- }
- /**
- * 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, function ($arg) {
- $id = '""' === substr_replace($arg, '', 1, -1) ? stripcslashes(substr($arg, 1, -1)) : null;
- if (null !== $id && ($this->container->hasAlias($id) || $this->container->hasDefinition($id))) {
- return $this->getServiceCall($id);
- }
- return sprintf('$this->get(%s)', $arg);
- });
- 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]), true).'.' : '';
- $suffix = $matches[0][1] + strlen($matches[0][0]);
- $suffix = isset($value[$suffix]) ? '.'.$this->doExport(substr($value, $suffix), true) : '';
- $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, true);
- }
- private function doExport($value, $resolveEnv = false)
- {
- if (is_string($value) && false !== strpos($value, "\n")) {
- $cleanParts = explode("\n", $value);
- $cleanParts = array_map(function ($part) { return var_export($part, true); }, $cleanParts);
- $export = implode('."\n".', $cleanParts);
- } else {
- $export = var_export($value, true);
- }
- if ($resolveEnv && "'" === $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;
- }
- }
|