You are here

class CheckCircularReferencesPass in Service Container 7

Same name and namespace in other branches
  1. 7.2 modules/providers/service_container_symfony/lib/Symfony/Component/DependencyInjection/Compiler/CheckCircularReferencesPass.php \Symfony\Component\DependencyInjection\Compiler\CheckCircularReferencesPass

Checks your services for circular references.

References from method calls are ignored since we might be able to resolve these references depending on the order in which services are called.

Circular reference from method calls will only be detected at run-time.

@author Johannes M. Schmitt <schmittjoh@gmail.com>

Hierarchy

Expanded class hierarchy of CheckCircularReferencesPass

1 file declares its use of CheckCircularReferencesPass
CheckCircularReferencesPassTest.php in modules/providers/service_container_symfony/lib/Symfony/Component/DependencyInjection/Tests/Compiler/CheckCircularReferencesPassTest.php

File

modules/providers/service_container_symfony/lib/Symfony/Component/DependencyInjection/Compiler/CheckCircularReferencesPass.php, line 27

Namespace

Symfony\Component\DependencyInjection\Compiler
View source
class CheckCircularReferencesPass implements CompilerPassInterface {
  private $currentPath;
  private $checkedNodes;

  /**
   * Checks the ContainerBuilder object for circular references.
   *
   * @param ContainerBuilder $container The ContainerBuilder instances
   */
  public function process(ContainerBuilder $container) {
    $graph = $container
      ->getCompiler()
      ->getServiceReferenceGraph();
    $this->checkedNodes = array();
    foreach ($graph
      ->getNodes() as $id => $node) {
      $this->currentPath = array(
        $id,
      );
      $this
        ->checkOutEdges($node
        ->getOutEdges());
    }
  }

  /**
   * Checks for circular references.
   *
   * @param ServiceReferenceGraphEdge[] $edges An array of Edges
   *
   * @throws ServiceCircularReferenceException When a circular reference is found.
   */
  private function checkOutEdges(array $edges) {
    foreach ($edges as $edge) {
      $node = $edge
        ->getDestNode();
      $id = $node
        ->getId();
      if (empty($this->checkedNodes[$id])) {
        $searchKey = array_search($id, $this->currentPath);
        $this->currentPath[] = $id;
        if (false !== $searchKey) {
          throw new ServiceCircularReferenceException($id, array_slice($this->currentPath, $searchKey));
        }
        $this
          ->checkOutEdges($node
          ->getOutEdges());
        $this->checkedNodes[$id] = true;
        array_pop($this->currentPath);
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CheckCircularReferencesPass::$checkedNodes private property
CheckCircularReferencesPass::$currentPath private property
CheckCircularReferencesPass::checkOutEdges private function Checks for circular references.
CheckCircularReferencesPass::process public function Checks the ContainerBuilder object for circular references. Overrides CompilerPassInterface::process