class Compiler in Service Container 7

This class is used to remove circular dependencies between individual passes.

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

@api

Hierarchy

• class \Symfony\Component\DependencyInjection\Compiler\Compiler

2 files declare their use of Compiler

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

ContainerBuilder.php in modules/providers/service_container_symfony/lib/Symfony/Component/DependencyInjection/ContainerBuilder.php

File

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

Namespace

Symfony\Component\DependencyInjection\Compiler

class Compiler {
  private $passConfig;
  private $log = array();
  private $loggingFormatter;
  private $serviceReferenceGraph;

  /**
   * Constructor.
   */
  public function __construct() {
    $this->passConfig = new PassConfig();
    $this->serviceReferenceGraph = new ServiceReferenceGraph();
    $this->loggingFormatter = new LoggingFormatter();
  }

  /**
   * Returns the PassConfig.
   *
   * @return PassConfig The PassConfig instance
   *
   * @api
   */
  public function getPassConfig() {
    return $this->passConfig;
  }

  /**
   * Returns the ServiceReferenceGraph.
   *
   * @return ServiceReferenceGraph The ServiceReferenceGraph instance
   *
   * @api
   */
  public function getServiceReferenceGraph() {
    return $this->serviceReferenceGraph;
  }

  /**
   * Returns the logging formatter which can be used by compilation passes.
   *
   * @return LoggingFormatter
   */
  public function getLoggingFormatter() {
    return $this->loggingFormatter;
  }

  /**
   * Adds a pass to the PassConfig.
   *
   * @param CompilerPassInterface $pass A compiler pass
   * @param string                $type The type of the pass
   *
   * @api
   */
  public function addPass(CompilerPassInterface $pass, $type = PassConfig::TYPE_BEFORE_OPTIMIZATION) {
    $this->passConfig
      ->addPass($pass, $type);
  }

  /**
   * Adds a log message.
   *
   * @param string $string The log message
   */
  public function addLogMessage($string) {
    $this->log[] = $string;
  }

  /**
   * Returns the log.
   *
   * @return array Log array
   */
  public function getLog() {
    return $this->log;
  }

  /**
   * Run the Compiler and process all Passes.
   *
   * @param ContainerBuilder $container
   *
   * @api
   */
  public function compile(ContainerBuilder $container) {
    foreach ($this->passConfig
      ->getPasses() as $pass) {
      $pass
        ->process($container);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Compiler::$log	private	property
Compiler::$loggingFormatter	private	property
Compiler::$passConfig	private	property
Compiler::$serviceReferenceGraph	private	property
Compiler::addLogMessage	public	function	Adds a log message.
Compiler::addPass	public	function	Adds a pass to the PassConfig.
Compiler::compile	public	function	Run the Compiler and process all Passes.
Compiler::getLog	public	function	Returns the log.
Compiler::getLoggingFormatter	public	function	Returns the logging formatter which can be used by compilation passes.
Compiler::getPassConfig	public	function	Returns the PassConfig.
Compiler::getServiceReferenceGraph	public	function	Returns the ServiceReferenceGraph.
Compiler::__construct	public	function	Constructor.