www.aleph1.co.uk Git - yaffs-website/blob - vendor/symfony/dependency-injection/LazyProxy/PhpDumper/DumperInterface.php

   1 <?php
   2
   3 /*
   4  * This file is part of the Symfony package.
   5  *
   6  * (c) Fabien Potencier <fabien@symfony.com>
   7  *
   8  * For the full copyright and license information, please view the LICENSE
   9  * file that was distributed with this source code.
  10  */
  11
  12 namespace Symfony\Component\DependencyInjection\LazyProxy\PhpDumper;
  13
  14 use Symfony\Component\DependencyInjection\Definition;
  15
  16 /**
  17  * Lazy proxy dumper capable of generating the instantiation logic PHP code for proxied services.
  18  *
  19  * @author Marco Pivetta <ocramius@gmail.com>
  20  */
  21 interface DumperInterface
  22 {
  23     /**
  24      * Inspects whether the given definitions should produce proxy instantiation logic in the dumped container.
  25      *
  26      * @param Definition $definition
  27      *
  28      * @return bool
  29      */
  30     public function isProxyCandidate(Definition $definition);
  31
  32     /**
  33      * Generates the code to be used to instantiate a proxy in the dumped factory code.
  34      *
  35      * @param Definition $definition
  36      * @param string     $id         service identifier
  37      * @param string     $methodName the method name to get the service, will be added to the interface in 4.0
  38      *
  39      * @return string
  40      */
  41     public function getProxyFactoryCode(Definition $definition, $id/**, $methodName = null */);
  42
  43     /**
  44      * Generates the code for the lazy proxy.
  45      *
  46      * @param Definition $definition
  47      *
  48      * @return string
  49      */
  50     public function getProxyCode(Definition $definition);
  51 }