class ProxyDumper in Service Container 7

Dumps the proxy service into the dumped PHP container file.

Hierarchy

• class \Drupal\Component\ProxyBuilder\ProxyDumper implements DumperInterface

File

lib/Drupal/Component/ProxyBuilder/ProxyDumper.php, line 16

Contains \Drupal\Component\ProxyBuilder\ProxyDumper.

Namespace

Drupal\Component\ProxyBuilder

class ProxyDumper implements DumperInterface {

  /**
   * Keeps track of already existing proxy classes.
   *
   * @var array
   */
  protected $buildClasses = [];

  /**
   * The proxy builder.
   *
   * @var \Drupal\Component\ProxyBuilder\ProxyBuilder
   */
  protected $builder;
  public function __construct(ProxyBuilder $builder) {
    $this->builder = $builder;
  }

  /**
   * {@inheritdoc}
   */
  public function isProxyCandidate(Definition $definition) {
    return $definition
      ->isLazy() && ($class = $definition
      ->getClass()) && class_exists($class);
  }

  /**
   * {@inheritdoc}
   */
  public function getProxyFactoryCode(Definition $definition, $id) {

    // Note: the specific get method is called initially with $lazyLoad=TRUE;
    // When you want to retrieve the actual service, the code generated in
    // ProxyBuilder calls the method with lazy loading disabled.
    $output = <<<'EOS'
        if ($lazyLoad) {
            return $this->services['{{ id }}'] = new {{ class_name }}($this, '{{ id }}');
        }

EOS;
    $output = str_replace('{{ id }}', $id, $output);
    $output = str_replace('{{ class_name }}', $this->builder
      ->buildProxyClassName($definition
      ->getClass()), $output);
    return $output;
  }

  /**
   * {@inheritdoc}
   */
  public function getProxyCode(Definition $definition) {

    // Maybe the same class is used in different services, which are both marked
    // as lazy (just think about 2 database connections).
    // In those cases we should not generate proxy code the second time.
    if (!isset($this->buildClasses[$definition
      ->getClass()])) {
      $this->buildClasses[$definition
        ->getClass()] = TRUE;
      return $this->builder
        ->build($definition
        ->getClass());
    }
    else {
      return '';
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ProxyDumper::$buildClasses	protected	property	Keeps track of already existing proxy classes.
ProxyDumper::$builder	protected	property	The proxy builder.
ProxyDumper::getProxyCode	public	function	Generates the code for the lazy proxy. Overrides DumperInterface::getProxyCode
ProxyDumper::getProxyFactoryCode	public	function	Generates the code to be used to instantiate a proxy in the dumped factory code. Overrides DumperInterface::getProxyFactoryCode
ProxyDumper::isProxyCandidate	public	function	Inspects whether the given definitions should produce proxy instantiation logic in the dumped container. Overrides DumperInterface::isProxyCandidate
ProxyDumper::__construct	public	function