Raphaël G. Git Repositories - airbundle/blob - DependencyInjection/Configuration.php

   1 <?php
   2
   3 namespace Rapsys\AirBundle\DependencyInjection;
   4
   5 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
   6 use Symfony\Component\Config\Definition\ConfigurationInterface;
   7
   8 /**
   9  * This is the class that validates and merges configuration from your app/config files.
  10  *
  11  * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/configuration.html}
  12  */
  13 class Configuration implements ConfigurationInterface {
  14         /**
  15          * {@inheritdoc}
  16          */
  17         public function getConfigTreeBuilder() {
  18                 $treeBuilder = new TreeBuilder('rapsys_air');
  19
  20                 // Here you should define the parameters that are allowed to
  21                 // configure your bundle. See the documentation linked above for
  22                 // more information on that topic.
  23                 //Set defaults
  24                 $defaults = [
  25                         'site' => [
  26                                 'ico' => '@RapsysAir/ico/icon.ico',
  27                                 'logo' => '@RapsysAir/png/logo.png',
  28                                 //The png icon array
  29                                 //XXX: see https://www.emergeinteractive.com/insights/detail/the-essentials-of-favicons/
  30                                 //XXX: see https://caniuse.com/#feat=link-icon-svg
  31                                 'png' => [
  32                                         //Default
  33                                         256 => '@RapsysAir/png/icon.256.png',
  34
  35                                         //For google
  36                                         //Chrome for Android home screen icon
  37                                         196 => '@RapsysAir/png/icon.196.png',
  38                                         //Google Developer Web App Manifest Recommendation
  39                                         192 => '@RapsysAir/png/icon.192.png',
  40                                         //Chrome Web Store icon
  41                                         128 => '@RapsysAir/png/icon.128.png',
  42
  43                                         //Fallback
  44                                         32 => '@RapsysAir/png/icon.32.png',
  45
  46                                         //For apple
  47                                         //XXX: old obsolete format: [57, 72, 76, 114, 120, 144]
  48                                         //XXX: see https://webhint.io/docs/user-guide/hints/hint-apple-touch-icons/
  49                                         //XXX: see https://developer.apple.com/library/archive/documentation/AppleApplications/Reference/SafariWebContent/ConfiguringWebApplications/ConfiguringWebApplications.html
  50                                         //iPhone Retina
  51                                         180 => '@RapsysAir/png/icon.180.png',
  52                                         //iPad Retina touch icon
  53                                         167 => '@RapsysAir/png/icon.167.png',
  54                                         //iPad touch icon
  55                                         152 => '@RapsysAir/png/icon.152.png',
  56
  57                                         //For windows
  58                                         //XXX: see https://docs.microsoft.com/en-us/previous-versions/windows/internet-explorer/ie-developer/platform-apis/dn255024(v=vs.85)
  59                                         310 => '@RapsysAir/png/icon.310.png',
  60                                         150 => '@RapsysAir/png/icon.150.png',
  61                                         70 => '@RapsysAir/png/icon.70.png'
  62                                 ],
  63                                 'svg' => '@RapsysAir/svg/icon.svg',
  64                                 'title' => 'Libre Air',
  65                                 'url' => 'rapsys_air'
  66                         ],
  67                         'copy' => [
  68                                 'long' => 'All rights reserved',
  69                                 'short' => 'Copyright 2019'
  70                         ],
  71                         'contact' => [
  72                                 'name' => 'John Doe',
  73                                 'mail' => 'contact@example.com'
  74                         ],
  75                         'locale' => '%kernel.default_locale%',
  76                         'locales' => '%kernel.translator.fallbacks%',
  77                         'languages' => '%rapsys_user.languages%',
  78                 ];
  79
  80                 //Here we define the parameters that are allowed to configure the bundle.
  81                 //TODO: see https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php for default value and description
  82                 //TODO: see http://symfony.com/doc/current/components/config/definition.html
  83                 //XXX: use bin/console config:dump-reference to dump class infos
  84
  85                 //Here we define the parameters that are allowed to configure the bundle.
  86                 $treeBuilder
  87                         //Parameters
  88                         ->getRootNode()
  89                                 ->addDefaultsIfNotSet()
  90                                 ->children()
  91                                         ->arrayNode('site')
  92                                                 ->addDefaultsIfNotSet()
  93                                                 ->children()
  94                                                         ->scalarNode('ico')->cannotBeEmpty()->defaultValue($defaults['site']['ico'])->end()
  95                                                         ->scalarNode('logo')->cannotBeEmpty()->defaultValue($defaults['site']['logo'])->end()
  96                                                         ->arrayNode('png')
  97                                                                 ->treatNullLike([])
  98                                                                 ->defaultValue($defaults['site']['png'])
  99                                                                 ->scalarPrototype()->end()
 100                                                         ->end()
 101                                                         ->scalarNode('svg')->cannotBeEmpty()->defaultValue($defaults['site']['svg'])->end()
 102                                                         ->scalarNode('title')->cannotBeEmpty()->defaultValue($defaults['site']['title'])->end()
 103                                                         ->scalarNode('url')->cannotBeEmpty()->defaultValue($defaults['site']['url'])->end()
 104                                                 ->end()
 105                                         ->end()
 106                                         ->arrayNode('copy')
 107                                                 ->addDefaultsIfNotSet()
 108                                                 ->children()
 109                                                         ->scalarNode('long')->defaultValue($defaults['copy']['long'])->end()
 110                                                         ->scalarNode('short')->defaultValue($defaults['copy']['short'])->end()
 111                                                 ->end()
 112                                         ->end()
 113                                         ->arrayNode('contact')
 114                                                 ->addDefaultsIfNotSet()
 115                                                 ->children()
 116                                                         ->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['contact']['name'])->end()
 117                                                         ->scalarNode('mail')->cannotBeEmpty()->defaultValue($defaults['contact']['mail'])->end()
 118                                                 ->end()
 119                                         ->end()
 120                                         ->scalarNode('locale')->cannotBeEmpty()->defaultValue($defaults['locale'])->end()
 121                                         ->scalarNode('locales')->cannotBeEmpty()->defaultValue($defaults['locales'])->end()
 122                                         ->scalarNode('languages')->cannotBeEmpty()->defaultValue($defaults['languages'])->end()
 123                                 ->end()
 124                         ->end();
 125
 126                 return $treeBuilder;
 127         }
 128 }