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

   1 <?php declare(strict_types=1);
   2
   3 /*
   4  * This file is part of the Rapsys BlogBundle package.
   5  *
   6  * (c) Raphaël Gertz <symfony@rapsys.eu>
   7  *
   8  * For the full copyright and license information, please view the LICENSE
   9  * file that was distributed with this source code.
  10  */
  11
  12 namespace Rapsys\BlogBundle\DependencyInjection;
  13
  14 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
  15 use Symfony\Component\Config\Definition\ConfigurationInterface;
  16
  17 use Rapsys\BlogBundle\RapsysBlogBundle;
  18
  19 /**
  20  * This is the class that validates and merges configuration from your app/config files.
  21  *
  22  * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/configuration.html}
  23  */
  24 class Configuration implements ConfigurationInterface {
  25         /**
  26          * {@inheritdoc}
  27          */
  28         public function getConfigTreeBuilder(): TreeBuilder {
  29                 $treeBuilder = new TreeBuilder($alias = RapsysBlogBundle::getAlias());
  30
  31                 // Here you should define the parameters that are allowed to
  32                 // configure your bundle. See the documentation linked above for
  33                 // more information on that topic.
  34                 //Set defaults
  35                 $defaults = [
  36                         'contact' => [
  37                                 'address' => 'john.doe@example.com',
  38                                 'name' => 'John Doe'
  39                         ],
  40                         'copy' => [
  41                                 'by' => 'Rapsys',
  42                                 'link' => 'https://example.com',
  43                                 'long' => 'All rights reserved',
  44                                 'short' => 'Copyright 2019-2023',
  45                                 'title' => 'By Raphaël'
  46                         ],
  47                         'donate' => '',
  48                         'facebook' => [
  49                                 'apps' => [],
  50                                 'height' => 630,
  51                                 'width' => 1200
  52                         ],
  53                         'icon' => [
  54                                 'ico' => '@RapsysBlog/ico/icon.ico',
  55                                 //The png icon array
  56                                 //XXX: see https://www.emergeinteractive.com/insights/detail/the-essentials-of-favicons/
  57                                 //XXX: see https://caniuse.com/#feat=link-icon-svg
  58                                 'png' => [
  59                                         //Default
  60                                         256 => '@RapsysBlog/png/icon.256.png',
  61
  62                                         //For google
  63                                         //Chrome for Android home screen icon
  64                                         196 => '@RapsysBlog/png/icon.196.png',
  65                                         //Google Developer Web App Manifest Recommendation
  66                                         192 => '@RapsysBlog/png/icon.192.png',
  67                                         //Chrome Web Store icon
  68                                         128 => '@RapsysBlog/png/icon.128.png',
  69
  70                                         //Fallback
  71                                         32 => '@RapsysBlog/png/icon.32.png',
  72
  73                                         //For apple
  74                                         //XXX: old obsolete format: [57, 72, 76, 114, 120, 144]
  75                                         //XXX: see https://webhint.io/docs/user-guide/hints/hint-apple-touch-icons/
  76                                         //XXX: see https://developer.apple.com/library/archive/documentation/AppleApplications/Reference/SafariWebContent/ConfiguringWebApplications/ConfiguringWebApplications.html
  77                                         //iPhone Retina
  78                                         180 => '@RapsysBlog/png/icon.180.png',
  79                                         //iPad Retina touch icon
  80                                         167 => '@RapsysBlog/png/icon.167.png',
  81                                         //iPad touch icon
  82                                         152 => '@RapsysBlog/png/icon.152.png',
  83                                         //iOS7
  84                                         120 => '@RapsysBlog/png/icon.120.png',
  85
  86                                         //For windows
  87                                         //XXX: see https://docs.microsoft.com/en-us/previous-versions/windows/internet-explorer/ie-developer/platform-apis/dn255024(v=vs.85)
  88                                         310 => '@RapsysBlog/png/icon.310.png',
  89                                         150 => '@RapsysBlog/png/icon.150.png',
  90                                         70 => '@RapsysBlog/png/icon.70.png'
  91                                 ],
  92                                 'svg' => '@RapsysBlog/svg/icon.svg'
  93                         ],
  94                         //XXX: revert to underscore because of that shit:
  95                         //XXX: see https://symfony.com/doc/current/components/config/definition.html#normalization
  96                         //XXX: see https://github.com/symfony/symfony/issues/7405
  97                         //TODO: copy to '%rapsys_user.languages%',
  98                         'languages' => [
  99                                 'en_gb' => 'English'
 100                         ],
 101                         //TODO: copy to '%kernel.default_locale%'
 102                         'locale' => 'en_gb',
 103                         //TODO: copy to '%kernel.translator.fallbacks%'
 104                         'locales' => [ 'en_gb' ],
 105                         'logo' => [
 106                                 'png' => '@RapsysBlog/png/logo.png',
 107                                 'svg' => '@RapsysBlog/svg/logo.svg',
 108                                 'alt' => 'John Doe\'s blog logo'
 109                         ],
 110                         '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',
 111                         'root' => 'rapsys_blog',
 112                         'title' => 'John Doe\'s blog',
 113                 ];
 114
 115                 //Here we define the parameters that are allowed to configure the bundle.
 116                 //TODO: see https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php for default value and description
 117                 //TODO: see http://symfony.com/doc/current/components/config/definition.html
 118                 //XXX: use bin/console config:dump-reference to dump class infos
 119
 120                 //Here we define the parameters that are allowed to configure the bundle.
 121                 $treeBuilder
 122                         //Parameters
 123                         ->getRootNode()
 124                                 ->addDefaultsIfNotSet()
 125                                 ->children()
 126                                         ->arrayNode('contact')
 127                                                 ->addDefaultsIfNotSet()
 128                                                 ->children()
 129                                                         ->scalarNode('address')->cannotBeEmpty()->defaultValue($defaults['contact']['address'])->end()
 130                                                         ->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['contact']['name'])->end()
 131                                                 ->end()
 132                                         ->end()
 133                                         ->arrayNode('copy')
 134                                                 ->addDefaultsIfNotSet()
 135                                                 ->children()
 136                                                         ->scalarNode('by')->defaultValue($defaults['copy']['by'])->end()
 137                                                         ->scalarNode('link')->defaultValue($defaults['copy']['link'])->end()
 138                                                         ->scalarNode('long')->defaultValue($defaults['copy']['long'])->end()
 139                                                         ->scalarNode('short')->defaultValue($defaults['copy']['short'])->end()
 140                                                         ->scalarNode('title')->defaultValue($defaults['copy']['title'])->end()
 141                                                 ->end()
 142                                         ->end()
 143                                         ->scalarNode('donate')->cannotBeEmpty()->defaultValue($defaults['donate'])->end()
 144                                         //XXX: facebook required ???
 145                                         //@see https://symfony.com/doc/current/components/config/definition.html
 146                                         //->beforeNormalization()->castToArray()->end()
 147                                         ->arrayNode('facebook')
 148                                                 ->addDefaultsIfNotSet()
 149                                                 ->children()
 150                                                         ->arrayNode('apps')
 151                                                                 ->treatNullLike([])
 152                                                                 ->defaultValue($defaults['facebook']['apps'])
 153                                                                 ->scalarPrototype()->end()
 154                                                         ->end()
 155                                                         ->integerNode('height')->min(0)->defaultValue($defaults['facebook']['height'])->end()
 156                                                         ->integerNode('width')->min(0)->defaultValue($defaults['facebook']['width'])->end()
 157                                                 ->end()
 158                                         ->end()
 159                                         ->arrayNode('icon')
 160                                                 ->addDefaultsIfNotSet()
 161                                                 ->children()
 162                                                         ->scalarNode('ico')->defaultValue($defaults['icon']['ico'])->end()
 163                                                         ->arrayNode('png')
 164                                                                 ->treatNullLike([])
 165                                                                 ->defaultValue($defaults['icon']['png'])
 166                                                                 ->scalarPrototype()->end()
 167                                                         ->end()
 168                                                         ->scalarNode('svg')->defaultValue($defaults['icon']['svg'])->end()
 169                                                 ->end()
 170                                         ->end()
 171                                         #TODO: see if we can't prevent key normalisation with ->normalizeKeys(false)
 172                                         ->variableNode('languages')
 173                                                 ->treatNullLike([])
 174                                                 ->defaultValue($defaults['languages'])
 175                                         ->end()
 176                                         ->scalarNode('locale')->cannotBeEmpty()->defaultValue($defaults['locale'])->end()
 177                                         #TODO: see if we can't prevent key normalisation with ->normalizeKeys(false)
 178                                         ->variableNode('locales')
 179                                                 ->treatNullLike([])
 180                                                 ->defaultValue($defaults['locales'])
 181                                         ->end()
 182                                         ->arrayNode('logo')
 183                                                 ->addDefaultsIfNotSet()
 184                                                 ->children()
 185                                                         ->scalarNode('png')->defaultValue($defaults['logo']['png'])->end()
 186                                                         ->scalarNode('svg')->defaultValue($defaults['logo']['svg'])->end()
 187                                                         ->scalarNode('alt')->defaultValue($defaults['logo']['alt'])->end()
 188                                                 ->end()
 189                                         ->end()
 190                                         ->scalarNode('path')->defaultValue($defaults['path'])->end()
 191                                         ->scalarNode('root')->cannotBeEmpty()->defaultValue($defaults['root'])->end()
 192                                         ->scalarNode('title')->cannotBeEmpty()->defaultValue($defaults['title'])->end()
 193                                 ->end()
 194                         ->end();
 195
 196                 return $treeBuilder;
 197         }
 198 }