annotate vendor/symfony/dependency-injection/LazyProxy/PhpDumper/DumperInterface.php @ 19:fa3358dc1485 tip

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