Shorten air bundle alias

[airbundle] / DependencyInjection / Configuration.php

diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
index 13d24a7afe297048de5ecc4efc53840d280c0532..9500f466ee07beefcbf56ad216d04f3d290a4002 100644 (file)
--- a/DependencyInjection/Configuration.php
+++ b/DependencyInjection/Configuration.php
@@ -1,31 +1,115 @@
-<?php
+<?php declare(strict_types=1);
+
+/*
+ * This file is part of the Rapsys AirBundle 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\AirBundle\DependencyInjection;
 
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 
 
 namespace Rapsys\AirBundle\DependencyInjection;
 
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 

+use Rapsys\AirBundle\RapsysAirBundle;
+

 /**
  * 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 {
 /**
  * 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 = new TreeBuilder();
-
-        // Here you should define the parameters that are allowed to
-        // configure your bundle. See the documentation linked above for
-        // more information on that topic.
+       /**
+        * {@inheritdoc}
+        */
+       public function getConfigTreeBuilder(): TreeBuilder {
+               $treeBuilder = new TreeBuilder($alias = RapsysAirBundle::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 = [
                //Set defaults
                $defaults = [

-                       'logo' => 'bundles/rapsysair/png/logo.png',
-                       'title' => 'Open Air',
-                       'contact_name' => 'Raphaël Gertz',
-                       'contact_mail' => 'airlibre@rapsys.eu',
+                       'contact' => [
+                               'address' => 'contact@airlibre.eu',
+                               'name' => 'Libre Air'
+                       ],
+                       'copy' => [
+                               'by' => 'Rapsys',
+                               'link' => 'https://rapsys.eu',
+                               'long' => 'All rights reserved',
+                               'short' => 'Copyright 2019-2021',
+                               'title' => 'Rapsys'
+                       ],
+                       'donate' => 'https://paypal.me/milongaraphael',
+                       'facebook' => [
+                               'apps' => [3728770287223690],
+                               'height' => 630,
+                               'width' => 1200
+                       ],
+                       'icon' => [
+                               'ico' => '@RapsysAir/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 => '@RapsysAir/png/icon.256.png',
+
+                                       //For google
+                                       //Chrome for Android home screen icon
+                                       196 => '@RapsysAir/png/icon.196.png',
+                                       //Google Developer Web App Manifest Recommendation
+                                       192 => '@RapsysAir/png/icon.192.png',
+                                       //Chrome Web Store icon
+                                       128 => '@RapsysAir/png/icon.128.png',
+
+                                       //Fallback
+                                       32 => '@RapsysAir/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 => '@RapsysAir/png/icon.180.png',
+                                       //iPad Retina touch icon
+                                       167 => '@RapsysAir/png/icon.167.png',
+                                       //iPad touch icon
+                                       152 => '@RapsysAir/png/icon.152.png',
+                                       //iOS7
+                                       120 => '@RapsysAir/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 => '@RapsysAir/png/icon.310.png',
+                                       150 => '@RapsysAir/png/icon.150.png',
+                                       70 => '@RapsysAir/png/icon.70.png'
+                               ],
+                               'svg' => '@RapsysAir/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
+                       //TODO: copy to '%rapsysuser.languages%',
+                       'languages' => [
+                               'en_gb' => 'English'
+                       ],
+                       //TODO: copy to '%kernel.default_locale%'
+                       'locale' => 'en_gb',
+                       //TODO: copy to '%kernel.translator.fallbacks%'
+                       'locales' => [ 'en_gb' ],
+                       'logo' => [
+                               'alt' => 'Libre Air\'s booking system logo',
+                               'png' => '@RapsysAir/png/logo.png',
+                               'svg' => '@RapsysAir/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' => 'rapsysair',
+            'title' => 'Libre Air\'s booking system'

                ];
 
                //Here we define the parameters that are allowed to configure the bundle.
                ];
 
                //Here we define the parameters that are allowed to configure the bundle.


@@ -36,21 +120,76 @@ class Configuration implements ConfigurationInterface {
                //Here we define the parameters that are allowed to configure the bundle.
                $treeBuilder
                        //Parameters
                //Here we define the parameters that are allowed to configure the bundle.
                $treeBuilder
                        //Parameters

-                       ->root('parameters')
+                       ->getRootNode()

                                ->addDefaultsIfNotSet()
                                ->children()
                                ->addDefaultsIfNotSet()
                                ->children()

-                                       ->arrayNode('rapsys_air')
+                                       ->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()
+                                                       ->scalarNode('png')->defaultValue($defaults['icon']['png'])->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()
                                                ->addDefaultsIfNotSet()
                                                ->children()

-                                                       ->scalarNode('logo')->defaultValue($defaults['logo'])->treatNullLike($defaults['logo'])->isRequired()->end()
-                                                       ->scalarNode('title')->defaultValue($defaults['title'])->treatNullLike($defaults['title'])->isRequired()->end()
-                                                       ->scalarNode('contact_name')->defaultValue($defaults['contact_name'])->treatNullLike($defaults['contact_name'])->isRequired()->end()
-                                                       ->scalarNode('contact_mail')->defaultValue($defaults['contact_mail'])->treatNullLike($defaults['contact_mail'])->isRequired()->end()
+                                                       ->scalarNode('alt')->defaultValue($defaults['logo']['alt'])->end()
+                                                       ->scalarNode('png')->defaultValue($defaults['logo']['png'])->end()
+                                                       ->scalarNode('svg')->defaultValue($defaults['logo']['svg'])->end()

                                                ->end()
                                        ->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();
 
                                ->end()
                        ->end();
 

-        return $treeBuilder;
-    }
+               return $treeBuilder;
+       }

 }
 }