BaseConfigurator: %baseUrl% parameter

Author: mabar

CHANGELOG.md

@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 	- Description of the parameters
 - `BaseConfigurator`
 	- `%productionMode%` parameter (matches nette/bootstrap behavior)
+	- `%baseUrl%` parameter (matches nette/bootstrap behavior)
 
 ## [1.3.5](https://github.com/orisai/nette-di/compare/1.3.4...1.3.5) - 2025-01-18
 

docs/README.md

@@ -346,6 +346,10 @@ Configurator define some parameters you may need:
 	- defaults to `%rootDir%/vendor`
 - `%wwwDir%`
 	- public directory, should be the only one accessible via webserver - defaults to `%rootDir%/public`
+- `%baseUrl%`
+	- base url of your app
+	- e.g. `https//example.com`
+	- requires [nette/http](https://github.com/nette/http)
 - `%debugMode%`
 	- whether application is in debug mode
 - `%productionMode%`

src/Boot/BaseConfigurator.php

@@ -14,10 +14,12 @@
 use Nette\DI\Config\Loader;
 use Nette\DI\Container;
 use Nette\DI\ContainerLoader;
+use Nette\DI\Definitions\Statement;
 use Nette\DI\Extensions\ExtensionsExtension;
 use Nette\DI\Helpers as DIHelpers;
 use Nette\PhpGenerator\Literal;
 use Nette\Schema\Helpers as ConfigHelpers;
+use OriNette\DI\Boot\Parameters\BaseUrl;
 use Orisai\Utils\Dependencies\Dependencies;
 use Orisai\Utils\Dependencies\Exception\PackageRequired;
 use ReflectionClass;
@@ -26,6 +28,7 @@
 use Tracy\Debugger;
 use Traversable;
 use function array_keys;
+use function array_merge;
 use function assert;
 use function class_exists;
 use function filemtime;
@@ -87,6 +90,7 @@ protected function getDefaultParameters(): array
 			'tempDir' => $this->rootDir . '/var/cache',
 			'vendorDir' => $this->rootDir . '/vendor',
 			'wwwDir' => $this->rootDir . '/public',
+			'baseUrl' => new Statement('@' . BaseUrl::class . '::get'),
 			'debugMode' => false,
 			'productionMode' => true,
 			'consoleMode' => PHP_SAPI === 'cli',
@@ -181,22 +185,26 @@ private function generateContainer(Compiler $compiler, array $configFiles): void
 			$loader->addAdapter($extension, $adapter);
 		}
 
+		$compiler->loadConfig(__DIR__ . '/Parameters/wiring.neon');
 		foreach ($configFiles as $configFile) {
 			$compiler->loadConfig($configFile, $loader);
 		}
 
 		$now = new DateTimeImmutable();
 
-		$parameters = DIHelpers::escape($this->staticParameters) +
-			[
+		$parameters = DIHelpers::escape($this->staticParameters)
+			+ [
 				'container' => [
 					'compiledAtTimestamp' => (int) $now->format('U'),
 					'compiledAt' => $now->format(DATE_ATOM),
 					'className' => new Literal('static::class'),
 				],
 			];
 		$compiler->addConfig(['parameters' => $parameters]);
-		$compiler->setDynamicParameterNames(array_keys($this->dynamicParameters));
+		$compiler->setDynamicParameterNames(array_merge(
+			array_keys($this->dynamicParameters),
+			['baseUrl'],
+		),);
 
 		$builder = $compiler->getContainerBuilder();
 		$builder->addExcludedClasses($this->autowireExcludedClasses);

src/Boot/Parameters/BaseUrl.php

@@ -0,0 +1,28 @@
+<?php declare(strict_types = 1);
+
+namespace OriNette\DI\Boot\Parameters;
+
+use Nette\Http\IRequest;
+use function rtrim;
+
+/**
+ * @internal
+ */
+final class BaseUrl
+{
+
+	private ?IRequest $request;
+
+	public function __construct(?IRequest $request = null)
+	{
+		$this->request = $request;
+	}
+
+	public function get(): ?string
+	{
+		return $this->request === null
+			? null
+			: rtrim($this->request->getUrl()->getBaseUrl(), '/');
+	}
+
+}

src/Boot/Parameters/wiring.neon

@@ -0,0 +1,2 @@
+services:
+	orisai.di.boot.baseUrl: OriNette\DI\Boot\Parameters\BaseUrl

stubs/parameters.neon

@@ -10,6 +10,7 @@ parameters:
 	tempDir: %rootDir%/var/cache # Absolute path to temporary files
 	vendorDir: %rootDir%/vendor # Absolute path to Composer libraries
 	wwwDir: %rootDir%/public # Absolute path to public directory which shall be available through the webserver
+	baseUrl: 'https://127.0.0.1' # Absolute URL to project root (without ending slash)
 	debugMode: false # Is application in debug mode?
 	productionMode: true # Opposite of debugMode
 	consoleMode: false # Did request come from command line (CLI)?

tests/Unit/Boot/BaseConfiguratorTest.php

@@ -101,6 +101,7 @@ public function testParametersMatch(): void
 		self::assertSame($rootDir . '/var/cache', $parameters['tempDir']);
 		self::assertSame($rootDir . '/vendor', $parameters['vendorDir']);
 		self::assertSame($rootDir . '/public', $parameters['wwwDir']);
+		self::assertNull($parameters['baseUrl']);
 		self::assertTrue($parameters['debugMode']);
 		self::assertFalse($parameters['productionMode']);
 		self::assertTrue($parameters['consoleMode']);
@@ -112,8 +113,8 @@ public function testParametersMatch(): void
 		self::assertArrayHasKey('className', $parameters['container']);
 
 		// 10 default + 1 dynamic (container) + 2 from test
-		self::assertCount(11 + 1 + 2, $parameters);
-		self::assertCount(11, $configurator->getDefaultParameters());
+		self::assertCount(12 + 1 + 2, $parameters);
+		self::assertCount(12, $configurator->getDefaultParameters());
 	}
 
 	public function testParametersSpecificContainer(): void
@@ -343,4 +344,17 @@ public function testTracyOptional(): void
 		);
 	}
 
+	public function testBaseUrl(): void
+	{
+		$configurator = new ManualConfigurator($this->rootDir);
+		$configurator->setForceReloadContainer();
+
+		$configurator->addConfig(__DIR__ . '/config/baseUrl.neon');
+
+		$container = $configurator->createContainer();
+		$parameters = $container->getParameters();
+
+		self::assertSame('https://example.com', $parameters['baseUrl']);
+	}
+
 }

tests/Unit/Boot/Parameters/BaseUrlTest.php

@@ -0,0 +1,37 @@
+<?php declare(strict_types = 1);
+
+namespace Tests\OriNette\DI\Unit\Boot\Parameters;
+
+use Generator;
+use Nette\Http\Request;
+use Nette\Http\UrlScript;
+use OriNette\DI\Boot\Parameters\BaseUrl;
+use PHPUnit\Framework\TestCase;
+
+final class BaseUrlTest extends TestCase
+{
+
+	public function testNone(): void
+	{
+		$baseUrl = new BaseUrl();
+		self::assertNull($baseUrl->get());
+	}
+
+	/**
+	 * @dataProvider provide
+	 */
+	public function test(string $given, string $expected): void
+	{
+		$request = new Request(new UrlScript($given));
+		$baseUrl = new BaseUrl($request);
+		self::assertSame($expected, $baseUrl->get());
+	}
+
+	public function provide(): Generator
+	{
+		yield ['https://example.com', 'https://example.com'];
+		yield ['https://example.com/', 'https://example.com'];
+		yield ['https://example.com:8000/path', 'https://example.com:8000'];
+	}
+
+}

tests/Unit/Boot/config/baseUrl.neon

@@ -0,0 +1,4 @@
+services:
+	- Nette\Http\Request(
+		Nette\Http\UrlScript('https://example.com/')
+	)