Dynamically set the default value

contao · Jun 18, 2021 · 40c6b92 · 40c6b92
1 parent a56bfaf
commit 40c6b92
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 8 deletions.
diff --git a/core-bundle/src/DependencyInjection/Configuration.php b/core-bundle/src/DependencyInjection/Configuration.php
@@ -119,7 +119,7 @@ static function (string $v): int {
                 ->scalarNode('web_dir')
                     ->info('Absolute path to the web directory. Defaults to %kernel.project_dir%/public.')
                     ->cannotBeEmpty()
-                    ->defaultValue(Path::join($this->projectDir, 'public'))
+                    ->defaultValue($this->getDefaultWebDir())
                     ->validate()
                         ->always(
                             static function (string $value): string {
@@ -522,6 +522,17 @@ private function getLocales(): array
         return array_values(array_unique($languages));
     }
 
+    private function getDefaultWebDir(): string
+    {
+        $webDir = Path::join($this->projectDir, 'web');
+
+        if (file_exists($webDir)) {
+            return $webDir;
+        }
+
+        return Path::join($this->projectDir, 'public');
+    }
+
     /**
      * @return array<string>
      *

diff --git a/core-bundle/src/Resources/contao/library/Contao/Combiner.php b/core-bundle/src/Resources/contao/library/Contao/Combiner.php
@@ -130,7 +130,7 @@ public function add($strFile, $strVersion=null, $strMedia='all')
 		// Check the source file
 		if (!file_exists($this->strRootDir . '/' . $strFile))
 		{
-			// Handle public bundle resources in the document root
+			// Handle public bundle resources in the contao.web_dir folder
 			if (file_exists($this->strRootDir . '/' . $this->strWebDir . '/' . $strFile))
 			{
 				$strFile = $this->strWebDir . '/' . $strFile;
@@ -229,7 +229,7 @@ public function getFileUrls($strUrl=null)
 			{
 				$name = $arrFile['name'];
 
-				// Strip the public directory prefix (see #328)
+				// Strip the contao.web_dir directory prefix (see #328)
 				if (strncmp($name, $this->strWebDir . '/', \strlen($this->strWebDir) + 1) === 0)
 				{
 					$name = substr($name, \strlen($this->strWebDir) + 1);
@@ -447,7 +447,7 @@ protected function fixPaths($content, $arrFile)
 	{
 		$strName = $arrFile['name'];
 
-		// Strip the public directory prefix
+		// Strip the contao.web_dir directory prefix
 		if (strpos($strName, $this->strWebDir . '/') === 0)
 		{
 			$strName = substr($strName, \strlen($this->strWebDir) + 1);

diff --git a/core-bundle/src/Resources/contao/library/Contao/Image.php b/core-bundle/src/Resources/contao/library/Contao/Image.php
@@ -373,7 +373,7 @@ public function getResizedPath()
 		$path = $this->resizedPath;
 		$webDir = StringUtil::stripRootDir(System::getContainer()->getParameter('contao.web_dir'));
 
-		// Strip the public directory prefix (see #337)
+		// Strip the contao.web_dir directory prefix (see #337)
 		if (strncmp($path, $webDir . '/', \strlen($webDir) + 1) === 0)
 		{
 			$path = substr($path, \strlen($webDir) + 1);
@@ -708,7 +708,7 @@ public static function getHtml($src, $alt='', $attributes='')
 
 		$objFile = new File($src);
 
-		// Strip the public directory prefix (see #337)
+		// Strip the contao.web_dir directory prefix (see #337)
 		if (strncmp($src, $webDir . '/', \strlen($webDir) + 1) === 0)
 		{
 			$src = substr($src, \strlen($webDir) + 1);

diff --git a/core-bundle/src/Resources/contao/library/Contao/Template.php b/core-bundle/src/Resources/contao/library/Contao/Template.php
@@ -590,7 +590,7 @@ public static function generateStyleTag($href, $media=null, $mtime=false)
 			{
 				$webDir = StringUtil::stripRootDir($container->getParameter('contao.web_dir'));
 
-				// Handle public bundle resources in the document root
+				// Handle public bundle resources in the contao.web_dir folder
 				if (file_exists($projectDir . '/' . $webDir . '/' . $href))
 				{
 					$mtime = filemtime($projectDir . '/' . $webDir . '/' . $href);
@@ -646,7 +646,7 @@ public static function generateScriptTag($src, $async=false, $mtime=false, $hash
 			{
 				$webDir = StringUtil::stripRootDir($container->getParameter('contao.web_dir'));
 
-				// Handle public bundle resources in the document root
+				// Handle public bundle resources in the contao.web_dir folder
 				if (file_exists($projectDir . '/' . $webDir . '/' . $src))
 				{
 					$mtime = filemtime($projectDir . '/' . $webDir . '/' . $src);

diff --git a/core-bundle/tests/DependencyInjection/ConfigurationTest.php b/core-bundle/tests/DependencyInjection/ConfigurationTest.php
@@ -20,6 +20,7 @@
 use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
 use Symfony\Component\Config\Definition\Processor;
 use Symfony\Component\Config\Definition\PrototypedArrayNode;
+use Symfony\Component\Filesystem\Filesystem;
 
 class ConfigurationTest extends TestCase
 {
@@ -55,6 +56,19 @@ public function testAddsTheImagineService(): void
         $this->assertSame('my_super_service', $configuration['image']['imagine_service']);
     }
 
+    public function testAdjustsTheDefaultWebDir(): void
+    {
+        $configuration = (new Processor())->processConfiguration($this->configuration, []);
+
+        $this->assertSame('public', basename($configuration['web_dir']));
+
+        (new Filesystem())->mkdir($this->getTempDir().'/web');
+
+        $configuration = (new Processor())->processConfiguration($this->configuration, []);
+
+        $this->assertSame('web', basename($configuration['web_dir']));
+    }
+
     /**
      * @dataProvider getPaths
      */