vendor/presta/sitemap-bundle/DependencyInjection/Configuration.php line 31

Open in your IDE?
  1. <?php
  3. /**
  4.  * This file is part of the PrestaSitemapBundle package.
  5.  *
  6.  * (c) PrestaConcept <www.prestaconcept.net>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Presta\SitemapBundle\DependencyInjection;
  14. use Presta\SitemapBundle\Sitemap\Url\UrlConcrete;
  15. use Presta\SitemapBundle\Sitemap\XmlConstraint;
  16. use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
  17. use Symfony\Component\Config\Definition\Builder\TreeBuilder;
  18. use Symfony\Component\Config\Definition\ConfigurationInterface;
  19. use Symfony\Component\HttpKernel\Kernel;
  21. /**
  22.  * This is the class that validates and merges configuration from your app/config files
  23.  */
  24. class Configuration implements ConfigurationInterface
  25. {
  26.     const DEFAULT_FILENAME = 'sitemap';
  28.     /**
  29.      * @inheritDoc
  30.      */
  31.     public function getConfigTreeBuilder()
  32.     {
  33.         if (method_exists(TreeBuilder::class, 'getRootNode')) {
  34.             $treeBuilder = new TreeBuilder('presta_sitemap');
  35.             $rootNode = $treeBuilder->getRootNode();
  36.         } else {
  37.             $treeBuilder = new TreeBuilder();
  38.             $rootNode = $treeBuilder->root('presta_sitemap');
  39.         }
  41.         $rootNode
  42.             ->children()
  43.                 ->scalarNode('generator')->defaultValue('presta_sitemap.generator_default')->end()
  44.                 ->scalarNode('dumper')->defaultValue('presta_sitemap.dumper_default')->end()
  45.                 ->integerNode('timetolive')
  46.                     ->defaultValue(3600)
  47.                 ->end()
  48.                 ->scalarNode('sitemap_file_prefix')
  49.                     ->defaultValue(self::DEFAULT_FILENAME)
  50.                     ->info('Sets sitemap filename prefix defaults to "sitemap" -> sitemap.xml (for index); sitemap.<section>.xml(.gz) (for sitemaps)')
  51.                 ->end()
  52.                 ->integerNode('items_by_set')
  53.                     // Add one to the limit items value because it's an
  54.                     // index value (not a quantity)
  55.                     ->defaultValue(XmlConstraint::LIMIT_ITEMS + 1)
  56.                     ->info('The maximum number of items allowed in single sitemap.')
  57.                 ->end()
  58.                 ->scalarNode('route_annotation_listener')->defaultTrue()->end()
  59.                 ->scalarNode('dump_directory')
  60.                     ->info(
  61.                         'The directory to which the sitemap will be dumped. '.
  62.                         'It can be either absolute, or relative (to the place where the command will be triggered). '.
  63.                         'Default to Symfony\'s public dir.'
  64.                     )
  65.                     ->defaultValue(
  66.                         '%kernel.project_dir%/'.(version_compare(Kernel::VERSION, '4.0') >= 0 ? 'public' : 'web')
  67.                     )
  68.                 ->end()
  69.                 ->arrayNode('defaults')
  70.                     ->addDefaultsIfNotSet()
  71.                     ->children()
  72.                         ->scalarNode('priority')->defaultValue(0.5)->end()
  73.                         ->scalarNode('changefreq')->defaultValue(UrlConcrete::CHANGEFREQ_DAILY)->end()
  74.                         ->scalarNode('lastmod')->defaultValue('now')->end()
  75.                     ->end()
  76.                 ->end()
  77.                 ->scalarNode('default_section')
  78.                     ->defaultValue('default')
  79.                     ->info('The default section in which static routes are registered.')
  80.                 ->end()
  81.             ->end()
  82.         ;
  84.         $this->addAlternateSection($rootNode);
  86.         return $treeBuilder;
  87.     }
  89.     private function addAlternateSection(ArrayNodeDefinition $rootNode)
  90.     {
  91.         $rootNode
  92.             ->children()
  93.                 ->arrayNode('alternate')
  94.                     ->info(
  95.                         'Automatically generate alternate (hreflang) urls with static routes.' .
  96.                        ' Requires route_annotation_listener config to be enabled.'
  97.                     )
  98.                     ->canBeEnabled()
  99.                     ->children()
  100.                         ->scalarNode('default_locale')
  101.                             ->defaultValue('en')
  102.                             ->info('The default locale of your routes.')
  103.                         ->end()
  104.                         ->arrayNode('locales')
  105.                             ->defaultValue(['en'])
  106.                             ->beforeNormalization()
  107.                             ->ifString()
  108.                                 ->then(function ($v) { return preg_split('/\s*,\s*/', $v); })
  109.                             ->end()
  110.                             ->prototype('scalar')->end()
  111.                             ->info('List of supported locales of your routes.')
  112.                         ->end()
  113.                         ->enumNode('i18n')
  114.                             ->defaultValue('symfony')
  115.                             ->values(['symfony', 'jms'])
  116.                             ->info('Strategy used to create your i18n routes.')
  117.                         ->end()
  118.                     ->end()
  119.                 ->end()
  120.             ->end()
  121.         ;
  122.     }
  123. }