From: Raphaël Gertz <git@rapsys.eu>
Date: Sun, 13 Oct 2024 02:16:14 +0000 (+0200)
Subject: Add rapsys tree bundle configuration
X-Git-Tag: 0.0.3
X-Git-Url: https://git.rapsys.eu/treebundle/commitdiff_plain/1ccb85cd75086f5ce53735e293714bc2fcf155d4

Add rapsys tree bundle configuration
---

diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
new file mode 100644
index 0000000..a01863c
--- /dev/null
+++ b/DependencyInjection/Configuration.php
@@ -0,0 +1,198 @@
+<?php declare(strict_types=1);
+
+/*
+ * This file is part of the Rapsys TreeBundle package.
+ *
+ * (c) Raphaël Gertz <symfony@rapsys.eu>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Rapsys\TreeBundle\DependencyInjection;
+
+use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+use Symfony\Component\Config\Definition\ConfigurationInterface;
+
+use Rapsys\TreeBundle\RapsysTreeBundle;
+
+/**
+ * This is the class that validates and merges configuration from your app/config files.
+ *
+ * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/configuration.html}
+ */
+class Configuration implements ConfigurationInterface {
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getConfigTreeBuilder(): TreeBuilder {
+		$treeBuilder = new TreeBuilder($alias = RapsysTreeBundle::getAlias());
+
+		// Here you should define the parameters that are allowed to
+		// configure your bundle. See the documentation linked above for
+		// more information on that topic.
+		//Set defaults
+		$defaults = [
+			'contact' => [
+				'address' => 'contact@example.com',
+				'name' => 'John Doe'
+			],
+			'copy' => [
+				'by' => 'Rapsys',
+				'link' => 'https://rapsys.eu',
+				'long' => 'All rights reserved',
+				'short' => 'Copyright 2023-2024',
+				'title' => 'Rapsys'
+			],
+			'donate' => 'https://paypal.me/milongaraphael',
+			'facebook' => [
+				'apps' => [ 3728770287223690 ],
+				'height' => 630,
+				'width' => 1200
+			],
+			'icon' => [
+				'ico' => '@RapsysTree/ico/icon.ico',
+				//The png icon array
+				//XXX: see https://www.emergeinteractive.com/insights/detail/the-essentials-of-favicons/
+				//XXX: see https://caniuse.com/#feat=link-icon-svg
+				'png' => [
+					//Default
+					256 => '@RapsysTree/png/icon.256.png',
+
+					//For google
+					//Chrome for Android home screen icon
+					196 => '@RapsysTree/png/icon.196.png',
+					//Google Developer Web App Manifest Recommendation
+					192 => '@RapsysTree/png/icon.192.png',
+					//Chrome Web Store icon
+					128 => '@RapsysTree/png/icon.128.png',
+
+					//Fallback
+					32 => '@RapsysTree/png/icon.32.png',
+
+					//For apple
+					//XXX: old obsolete format: [57, 72, 76, 114, 120, 144]
+					//XXX: see https://webhint.io/docs/user-guide/hints/hint-apple-touch-icons/
+					//XXX: see https://developer.apple.com/library/archive/documentation/AppleApplications/Reference/SafariWebContent/ConfiguringWebApplications/ConfiguringWebApplications.html
+					//iPhone Retina
+					180 => '@RapsysTree/png/icon.180.png',
+					//iPad Retina touch icon
+					167 => '@RapsysTree/png/icon.167.png',
+					//iPad touch icon
+					152 => '@RapsysTree/png/icon.152.png',
+					//iOS7
+					120 => '@RapsysTree/png/icon.120.png',
+
+					//For windows
+					//XXX: see https://docs.microsoft.com/en-us/previous-versions/windows/internet-explorer/ie-developer/platform-apis/dn255024(v=vs.85)
+					310 => '@RapsysTree/png/icon.310.png',
+					150 => '@RapsysTree/png/icon.150.png',
+					70 => '@RapsysTree/png/icon.70.png'
+				],
+				'svg' => '@RapsysTree/svg/icon.svg'
+			],
+			//XXX: revert to underscore because of that shit:
+			//XXX: see https://symfony.com/doc/current/components/config/definition.html#normalization
+			//XXX: see https://github.com/symfony/symfony/issues/7405
+			'languages' => [
+				'en_gb' => 'English'
+			],
+			//TODO: copy to '%kernel.default_locale%'
+			'locale' => 'en_gb',
+			//TODO: copy to '%kernel.translator.fallbacks%'
+			'locales' => [ 'en_gb' ],
+			'logo' => [
+				'alt' => 'Veranda\'s gallery system logo',
+				'png' => '@RapsysTree/png/logo.png',
+				'svg' => '@RapsysTree/svg/logo.svg'
+			],
+			'path' => is_link(($prefix = is_dir('public') ? './public/' : './').($link = 'bundles/'.str_replace('_', '', $alias))) && is_dir(realpath($prefix.$link)) || is_dir($prefix.$link) ? $link : dirname(__DIR__).'/Resources/public',
+			'root' => 'rapsystree',
+            'title' => 'Veranda\'s gallery system'
+		];
+
+		//Here we define the parameters that are allowed to configure the bundle.
+		//TODO: see https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php for default value and description
+		//TODO: see http://symfony.com/doc/current/components/config/definition.html
+		//XXX: use bin/console config:dump-reference to dump class infos
+
+		//Here we define the parameters that are allowed to configure the bundle.
+		$treeBuilder
+			//Parameters
+			->getRootNode()
+				->addDefaultsIfNotSet()
+				->children()
+					->arrayNode('contact')
+						->addDefaultsIfNotSet()
+						->children()
+							->scalarNode('address')->cannotBeEmpty()->defaultValue($defaults['contact']['address'])->end()
+							->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['contact']['name'])->end()
+						->end()
+					->end()
+					->arrayNode('copy')
+						->addDefaultsIfNotSet()
+						->children()
+							->scalarNode('by')->defaultValue($defaults['copy']['by'])->end()
+							->scalarNode('link')->defaultValue($defaults['copy']['link'])->end()
+							->scalarNode('long')->defaultValue($defaults['copy']['long'])->end()
+							->scalarNode('short')->defaultValue($defaults['copy']['short'])->end()
+							->scalarNode('title')->defaultValue($defaults['copy']['title'])->end()
+						->end()
+					->end()
+					->scalarNode('donate')->cannotBeEmpty()->defaultValue($defaults['donate'])->end()
+					->arrayNode('facebook')
+						->addDefaultsIfNotSet()
+						->children()
+							->arrayNode('apps')
+								->treatNullLike([])
+								->defaultValue($defaults['facebook']['apps'])
+								->scalarPrototype()->end()
+							->end()
+							->integerNode('height')->min(0)->defaultValue($defaults['facebook']['height'])->end()
+							->integerNode('width')->min(0)->defaultValue($defaults['facebook']['width'])->end()
+						->end()
+					->end()
+					->arrayNode('icon')
+						->addDefaultsIfNotSet()
+						->children()
+							->scalarNode('ico')->defaultValue($defaults['icon']['ico'])->end()
+							->arrayNode('png')
+								->treatNullLike([])
+								->defaultValue($defaults['icon']['png'])
+								->scalarPrototype()->end()
+							->end()
+							->scalarNode('svg')->defaultValue($defaults['icon']['svg'])->end()
+						->end()
+					->end()
+					#TODO: see if we can't prevent key normalisation with ->normalizeKeys(false)
+					#->scalarNode('languages')->cannotBeEmpty()->defaultValue($defaults['languages'])->end()
+					->variableNode('languages')
+						->treatNullLike([])
+						->defaultValue($defaults['languages'])
+						#->scalarPrototype()->end()
+					->end()
+					->scalarNode('locale')->cannotBeEmpty()->defaultValue($defaults['locale'])->end()
+					#TODO: see if we can't prevent key normalisation with ->normalizeKeys(false)
+					#->scalarNode('locales')->cannotBeEmpty()->defaultValue($defaults['locales'])->end()
+					->variableNode('locales')
+						->treatNullLike([])
+						->defaultValue($defaults['locales'])
+						#->scalarPrototype()->end()
+					->end()
+					->arrayNode('logo')
+						->addDefaultsIfNotSet()
+						->children()
+							->scalarNode('alt')->defaultValue($defaults['logo']['alt'])->end()
+							->scalarNode('png')->defaultValue($defaults['logo']['png'])->end()
+							->scalarNode('svg')->defaultValue($defaults['logo']['svg'])->end()
+						->end()
+					->end()
+					->scalarNode('path')->defaultValue($defaults['path'])->end()
+					->scalarNode('root')->cannotBeEmpty()->defaultValue($defaults['root'])->end()
+					->scalarNode('title')->cannotBeEmpty()->defaultValue($defaults['title'])->end()
+				->end()
+			->end();
+
+		return $treeBuilder;
+	}
+}
diff --git a/DependencyInjection/RapsysTreeExtension.php b/DependencyInjection/RapsysTreeExtension.php
new file mode 100644
index 0000000..09fcb90
--- /dev/null
+++ b/DependencyInjection/RapsysTreeExtension.php
@@ -0,0 +1,112 @@
+<?php declare(strict_types=1);
+
+/*
+ * This file is part of the Rapsys TreeBundle package.
+ *
+ * (c) Raphaël Gertz <symfony@rapsys.eu>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Rapsys\TreeBundle\DependencyInjection;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Extension\Extension;
+use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
+use Symfony\Component\Translation\Loader\ArrayLoader;
+
+use Rapsys\TreeBundle\RapsysTreeBundle;
+
+/**
+ * This is the class that loads and manages your bundle configuration.
+ *
+ * @link http://symfony.com/doc/current/cookbook/bundles/extension.html
+ */
+class RapsysTreeExtension extends Extension implements PrependExtensionInterface {
+	/**
+	 * {@inheritdoc}
+	 *
+	 * Prepend the configuration
+	 *
+	 * Preload the configuration to allow sourcing as parameters
+	 */
+	public function prepend(ContainerBuilder $container): void {
+		//Process the configuration
+		$configs = $container->getExtensionConfig($alias = RapsysTreeBundle::getAlias());
+
+		//Load configuration
+		$configuration = $this->getConfiguration($configs, $container);
+
+		//Process the configuration to get merged config
+		$config = $this->processConfiguration($configuration, $configs);
+
+		//Detect when no user configuration is provided
+		if ($configs === [[]]) {
+			//Prepend default config
+			$container->prependExtensionConfig($alias, $config);
+		}
+
+		//Save configuration in parameters
+		$container->setParameter($alias, $config);
+
+		//Store flattened array in parameters
+		//XXX: don't flatten rapsystree.site.png key which is required to be an array
+		foreach($this->flatten($config, $alias, 10, '.', ['rapsystree.copy', 'rapsystree.icon', 'rapsystree.icon.png', 'rapsystree.logo', 'rapsystree.facebook.apps', 'rapsystree.locales', 'rapsystree.languages']) as $k => $v) {
+			$container->setParameter($k, $v);
+		}
+
+		//Set rapsystree.alias key
+		$container->setParameter($alias.'.alias', $alias);
+
+		//Set rapsystree.version key
+		$container->setParameter($alias.'.version', RapsysTreeBundle::getVersion());
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function load(array $configs, ContainerBuilder $container): void {
+	}
+
+	/**
+	 * The function that parses the array to flatten it into a one level depth array
+	 *
+	 * @param $array	The config values array
+	 * @param $path		The current key path
+	 * @param $depth	The maxmium depth
+	 * @param $sep		The separator string
+	 * @param $skip		The skipped paths array
+	 */
+	protected function flatten($array, $path = '', $depth = 10, $sep = '.', $skip = []) {
+		//Init res
+		$res = array();
+
+		//Detect numerical only array
+		//count(array_filter($array, function($k) { return !is_numeric($k); }, ARRAY_FILTER_USE_KEY)) == 0
+		//array_reduce(array_keys($array), function($c, $k) { return $c += !is_numeric($k); }, 0)
+
+		//Flatten hashed array until depth reach zero
+		if ($depth && is_array($array) && $array !== [] && !in_array($path, $skip)) {
+			foreach($array as $k => $v) {
+				$sub = $path ? $path.$sep.$k:$k;
+				$res += $this->flatten($v, $sub, $depth - 1, $sep, $skip);
+			}
+		//Pass scalar value directly
+		} else {
+			$res[$path] = $array;
+		}
+
+		//Return result
+		return $res;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 *
+	 * @xxx Required by kernel to load renamed alias configuration
+	 */
+	public function getAlias(): string {
+		return RapsysTreeBundle::getAlias();
+	}
+}