class ReplaceAliasByActualDefinitionPass in Service Container 7

Replaces aliases with actual service definitions, effectively removing these aliases.

@author Johannes M. Schmitt <[e-mail]>

Hierarchy

• class \Symfony\Component\DependencyInjection\Compiler\ReplaceAliasByActualDefinitionPass implements CompilerPassInterface

1 file declares its use of ReplaceAliasByActualDefinitionPass

ReplaceAliasByActualDefinitionPassTest.php in modules/providers/service_container_symfony/lib/Symfony/Component/DependencyInjection/Tests/Compiler/ReplaceAliasByActualDefinitionPassTest.php

File

modules/providers/service_container_symfony/lib/Symfony/Component/DependencyInjection/Compiler/ReplaceAliasByActualDefinitionPass.php, line 24

Namespace

Symfony\Component\DependencyInjection\Compiler

class ReplaceAliasByActualDefinitionPass implements CompilerPassInterface {
  private $compiler;
  private $formatter;
  private $sourceId;

  /**
   * Process the Container to replace aliases with service definitions.
   *
   * @param ContainerBuilder $container
   *
   * @throws InvalidArgumentException if the service definition does not exist
   */
  public function process(ContainerBuilder $container) {
    $this->compiler = $container
      ->getCompiler();
    $this->formatter = $this->compiler
      ->getLoggingFormatter();
    foreach ($container
      ->getAliases() as $id => $alias) {
      $aliasId = (string) $alias;
      try {
        $definition = $container
          ->getDefinition($aliasId);
      } catch (InvalidArgumentException $e) {
        throw new InvalidArgumentException(sprintf('Unable to replace alias "%s" with "%s".', $alias, $id), null, $e);
      }
      if ($definition
        ->isPublic()) {
        continue;
      }
      $definition
        ->setPublic(true);
      $container
        ->setDefinition($id, $definition);
      $container
        ->removeDefinition($aliasId);
      $this
        ->updateReferences($container, $aliasId, $id);

      // we have to restart the process due to concurrent modification of
      // the container
      $this
        ->process($container);
      break;
    }
  }

  /**
   * Updates references to remove aliases.
   *
   * @param ContainerBuilder $container The container
   * @param string           $currentId The alias identifier being replaced
   * @param string           $newId     The id of the service the alias points to
   */
  private function updateReferences($container, $currentId, $newId) {
    foreach ($container
      ->getAliases() as $id => $alias) {
      if ($currentId === (string) $alias) {
        $container
          ->setAlias($id, $newId);
      }
    }
    foreach ($container
      ->getDefinitions() as $id => $definition) {
      $this->sourceId = $id;
      $definition
        ->setArguments($this
        ->updateArgumentReferences($definition
        ->getArguments(), $currentId, $newId));
      $definition
        ->setMethodCalls($this
        ->updateArgumentReferences($definition
        ->getMethodCalls(), $currentId, $newId));
      $definition
        ->setProperties($this
        ->updateArgumentReferences($definition
        ->getProperties(), $currentId, $newId));
    }
  }

  /**
   * Updates argument references.
   *
   * @param array  $arguments An array of Arguments
   * @param string $currentId The alias identifier
   * @param string $newId     The identifier the alias points to
   *
   * @return array
   */
  private function updateArgumentReferences(array $arguments, $currentId, $newId) {
    foreach ($arguments as $k => $argument) {
      if (is_array($argument)) {
        $arguments[$k] = $this
          ->updateArgumentReferences($argument, $currentId, $newId);
      }
      elseif ($argument instanceof Reference) {
        if ($currentId === (string) $argument) {
          $arguments[$k] = new Reference($newId, $argument
            ->getInvalidBehavior());
          $this->compiler
            ->addLogMessage($this->formatter
            ->formatUpdateReference($this, $this->sourceId, $currentId, $newId));
        }
      }
    }
    return $arguments;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ReplaceAliasByActualDefinitionPass::$compiler	private	property
ReplaceAliasByActualDefinitionPass::$formatter	private	property
ReplaceAliasByActualDefinitionPass::$sourceId	private	property
ReplaceAliasByActualDefinitionPass::process	public	function	Process the Container to replace aliases with service definitions. Overrides CompilerPassInterface::process
ReplaceAliasByActualDefinitionPass::updateArgumentReferences	private	function	Updates argument references.
ReplaceAliasByActualDefinitionPass::updateReferences	private	function	Updates references to remove aliases.