CompilerExtension: added $initialization as replacement for modifying initialize() method

Author: dg

src/DI/Compiler.php

@@ -279,11 +279,11 @@ public function generateCode(): string
 
 		$generator = new PhpGenerator($this->builder);
 		$class = $generator->generate($this->className);
-		$class->addMethod('initialize');
 		$this->dependencies->add($this->builder->getDependencies());
 
 		foreach ($this->extensions as $extension) {
 			$extension->afterCompile($class);
+			$generator->addInitialization($class, $extension);
 		}
 
 		return $this->sources . "\n" . $generator->toString($class);

src/DI/CompilerExtension.php

@@ -28,10 +28,14 @@ abstract class CompilerExtension
 	/** @var array|object */
 	protected $config = [];
 
+	/** @var Nette\PhpGenerator\Closure */
+	protected $initialization;
+
 
 	/** @return static */
 	public function setCompiler(Compiler $compiler, string $name)
 	{
+		$this->initialization = new Nette\PhpGenerator\Closure;
 		$this->compiler = $compiler;
 		$this->name = $name;
 		return $this;
@@ -132,6 +136,12 @@ protected function createLoader(): Config\Loader
 	}
 
 
+	public function getInitialization(): Nette\PhpGenerator\Closure
+	{
+		return $this->initialization;
+	}
+
+
 	/**
 	 * Prepend extension name to identifier or service name.
 	 */

src/DI/Extensions/ConstantsExtension.php

@@ -17,10 +17,10 @@
  */
 final class ConstantsExtension extends Nette\DI\CompilerExtension
 {
-	public function afterCompile(Nette\PhpGenerator\ClassType $class)
+	public function loadConfiguration()
 	{
 		foreach ($this->getConfig() as $name => $value) {
-			$class->getMethod('initialize')->addBody('define(?, ?);', [$name, $value]);
+			$this->initialization->addBody('define(?, ?);', [$name, $value]);
 		}
 	}
 }

src/DI/Extensions/DIExtension.php

@@ -82,10 +82,10 @@ public function afterCompile(Nette\PhpGenerator\ClassType $class)
 		$this->restrictTypes($class);
 
 		if ($this->debugMode && $this->config->debugger) {
-			$this->enableTracyIntegration($class);
+			$this->enableTracyIntegration();
 		}
 
-		$this->initializeTaggedServices($class);
+		$this->initializeTaggedServices();
 	}
 
 
@@ -115,19 +115,19 @@ private function restrictTypes(Nette\PhpGenerator\ClassType $class): void
 	}
 
 
-	private function initializeTaggedServices(Nette\PhpGenerator\ClassType $class): void
+	private function initializeTaggedServices(): void
 	{
 		foreach (array_filter($this->getContainerBuilder()->findByTag('run')) as $name => $on) {
 			trigger_error("Tag 'run' used in service '$name' definition is deprecated.", E_USER_DEPRECATED);
-			$class->getMethod('initialize')->addBody('$this->getService(?);', [$name]);
+			$this->initialization->addBody('$this->getService(?);', [$name]);
 		}
 	}
 
 
-	private function enableTracyIntegration(Nette\PhpGenerator\ClassType $class): void
+	private function enableTracyIntegration(): void
 	{
 		Nette\Bridges\DITracy\ContainerPanel::$compilationTime = $this->time;
-		$class->getMethod('initialize')->addBody($this->getContainerBuilder()->formatPhp('?;', [
+		$this->initialization->addBody($this->getContainerBuilder()->formatPhp('?;', [
 			new Nette\DI\Definitions\Statement('@Tracy\Bar::addPanel', [new Nette\DI\Definitions\Statement(Nette\Bridges\DITracy\ContainerPanel::class)]),
 		]));
 	}

src/DI/Extensions/PhpExtension.php

@@ -23,27 +23,26 @@ public function getConfigSchema(): Nette\Schema\Schema
 	}
 
 
-	public function afterCompile(Nette\PhpGenerator\ClassType $class)
+	public function loadConfiguration()
 	{
-		$initialize = $class->getMethod('initialize');
 		foreach ($this->getConfig() as $name => $value) {
 			if ($value === null) {
 				continue;
 
 			} elseif ($name === 'include_path') {
-				$initialize->addBody('set_include_path(?);', [str_replace(';', PATH_SEPARATOR, $value)]);
+				$this->initialization->addBody('set_include_path(?);', [str_replace(';', PATH_SEPARATOR, $value)]);
 
 			} elseif ($name === 'ignore_user_abort') {
-				$initialize->addBody('ignore_user_abort(?);', [$value]);
+				$this->initialization->addBody('ignore_user_abort(?);', [$value]);
 
 			} elseif ($name === 'max_execution_time') {
-				$initialize->addBody('set_time_limit(?);', [$value]);
+				$this->initialization->addBody('set_time_limit(?);', [$value]);
 
 			} elseif ($name === 'date.timezone') {
-				$initialize->addBody('date_default_timezone_set(?);', [$value]);
+				$this->initialization->addBody('date_default_timezone_set(?);', [$value]);
 
 			} elseif (function_exists('ini_set')) {
-				$initialize->addBody('ini_set(?, ?);', [$name, $value === false ? '0' : (string) $value]);
+				$this->initialization->addBody('ini_set(?, ?);', [$name, $value === false ? '0' : (string) $value]);
 
 			} elseif (ini_get($name) != $value) { // intentionally ==
 				throw new Nette\NotSupportedException('Required function ini_set() is disabled.');

src/DI/PhpGenerator.php

@@ -68,6 +68,8 @@ public function generate(string $className): Nette\PhpGenerator\ClassType
 			->setReturnType($className)
 			->setBody('return $this;');
 
+		$class->addMethod('initialize');
+
 		return $class;
 	}
 
@@ -82,6 +84,17 @@ public function toString(Nette\PhpGenerator\ClassType $class): string
 	}
 
 
+	public function addInitialization(Nette\PhpGenerator\ClassType $class, CompilerExtension $extension): void
+	{
+		$closure = $extension->getInitialization();
+		if ($closure->getBody()) {
+			$class->getMethod('initialize')
+				->addBody('// ' . $extension->prefix(''))
+				->addBody("($closure)();");
+		}
+	}
+
+
 	public function generateMethod(Definitions\Definition $def): Nette\PhpGenerator\Method
 	{
 		$name = $def->getName();