class RemoveUnusedDefinitionsPass in Service Container 7.2

Removes unused service definitions from the container.

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

Hierarchy

• class \Symfony\Component\DependencyInjection\Compiler\RemoveUnusedDefinitionsPass implements RepeatablePassInterface

1 file declares its use of RemoveUnusedDefinitionsPass

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

File

modules/providers/service_container_symfony/lib/Symfony/Component/DependencyInjection/Compiler/RemoveUnusedDefinitionsPass.php, line 21

Namespace

Symfony\Component\DependencyInjection\Compiler

class RemoveUnusedDefinitionsPass implements RepeatablePassInterface {
  private $repeatedPass;

  /**
   * {@inheritdoc}
   */
  public function setRepeatedPass(RepeatedPass $repeatedPass) {
    $this->repeatedPass = $repeatedPass;
  }

  /**
   * Processes the ContainerBuilder to remove unused definitions.
   *
   * @param ContainerBuilder $container
   */
  public function process(ContainerBuilder $container) {
    $compiler = $container
      ->getCompiler();
    $formatter = $compiler
      ->getLoggingFormatter();
    $graph = $compiler
      ->getServiceReferenceGraph();
    $hasChanged = false;
    foreach ($container
      ->getDefinitions() as $id => $definition) {
      if ($definition
        ->isPublic()) {
        continue;
      }
      if ($graph
        ->hasNode($id)) {
        $edges = $graph
          ->getNode($id)
          ->getInEdges();
        $referencingAliases = array();
        $sourceIds = array();
        foreach ($edges as $edge) {
          $node = $edge
            ->getSourceNode();
          $sourceIds[] = $node
            ->getId();
          if ($node
            ->isAlias()) {
            $referencingAliases[] = $node
              ->getValue();
          }
        }
        $isReferenced = count(array_unique($sourceIds)) - count($referencingAliases) > 0;
      }
      else {
        $referencingAliases = array();
        $isReferenced = false;
      }
      if (1 === count($referencingAliases) && false === $isReferenced) {
        $container
          ->setDefinition((string) reset($referencingAliases), $definition);
        $definition
          ->setPublic(true);
        $container
          ->removeDefinition($id);
        $compiler
          ->addLogMessage($formatter
          ->formatRemoveService($this, $id, 'replaces alias ' . reset($referencingAliases)));
      }
      elseif (0 === count($referencingAliases) && false === $isReferenced) {
        $container
          ->removeDefinition($id);
        $compiler
          ->addLogMessage($formatter
          ->formatRemoveService($this, $id, 'unused'));
        $hasChanged = true;
      }
    }
    if ($hasChanged) {
      $this->repeatedPass
        ->setRepeat();
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
RemoveUnusedDefinitionsPass::$repeatedPass	private	property
RemoveUnusedDefinitionsPass::process	public	function	Processes the ContainerBuilder to remove unused definitions. Overrides CompilerPassInterface::process
RemoveUnusedDefinitionsPass::setRepeatedPass	public	function	Sets the RepeatedPass interface. Overrides RepeatablePassInterface::setRepeatedPass