vendor/dachcom-digital/lucene-search/src/LuceneSearchBundle/DependencyInjection/Configuration.php line 13

Open in your IDE?
  1. <?php
  3. namespace LuceneSearchBundle\DependencyInjection;
  5. use Symfony\Component\Config\Definition\Builder\TreeBuilder;
  6. use Symfony\Component\Config\Definition\ConfigurationInterface;
  8. class Configuration implements ConfigurationInterface
  9. {
  10.     public function getConfigTreeBuilder()
  11.     {
  12.         $treeBuilder = new TreeBuilder();
  13.         $rootNode = $treeBuilder->root('lucene_search');
  15.         $rootNode
  16.             ->children()
  17.                 ->booleanNode('enabled')
  18.                     ->isRequired()
  19.                     ->info('Enable and configure the search frontend if you want to include a full text search on your website.')
  20.                 ->end()
  21.                 ->booleanNode('fuzzy_search_results')
  22.                     ->isRequired()
  23.                     ->info('Fuzzy search results: When enabled, a fuzzy search is performed. The search will automatically include related terms.')
  24.                 ->end()
  25.                 ->booleanNode('search_suggestion')
  26.                     ->isRequired()
  27.                     ->info('Search suggestions: When enabled, a fuzzy search for similar search terms is performed. If no results could be found for the search term entered by the user, similar search terms are presented as suggestions.')
  28.                 ->end()
  29.                 ->booleanNode('own_host_only')
  30.                     ->isRequired()
  31.                     ->info('Own Host only: Limit search (and crawling) results to results from the current seed (sub-)domain only.')
  32.                 ->end()
  33.                 ->booleanNode('allow_subdomains')
  34.                     ->isRequired()
  35.                     ->info('Allow Subdomains: Limit search (and crawling) results to allow / disallow subomdains of current seed.')
  36.                 ->end()
  37.                 ->arrayNode('seeds')
  38.                     ->isRequired()
  39.                     ->info('Start-Urls (Seeds): Specify start URLs for the crawler. Please enter with protocol! e.g. http://www.pimcore.org and enter a starting URL on your main domain first and any subdomains next, because the domain of the first URL will be used as the main domain for sitemap generation.')
  40.                 ->prototype('scalar')->end()
  41.                 ->end()
  42.                 ->scalarNode('categories')
  43.                     ->info('Categories: If search results should be displayed by categories, please enter all valid categories here. The crawler sorts a page into a category if it contains a html meta tag with the name cat.')
  44.                 ->end()
  45.                 ->arrayNode('filter')
  46.                     ->children()
  47.                         ->booleanNode('allow_query_in_url')
  48.                             ->defaultFalse()
  49.                             ->info('When true, LuceneSearch will crawl urls with query fragments.')
  50.                         ->end()
  51.                         ->booleanNode('allow_hash_in_url')
  52.                             ->defaultFalse()
  53.                             ->info('When true, LuceneSearch will crawl urls with hash fragments.')
  54.                         ->end()
  55.                         ->arrayNode('valid_links')
  56.                             ->info('Regex for valid Uris: Specify PREG regex with start and end delimiter to define allowed links. e.g. @^http://www\.pimcore\.org*@i')
  57.                             ->prototype('scalar')->end()
  58.                         ->end()
  59.                         ->arrayNode('user_invalid_links')
  60.                             ->info('Regex for forbidden Uris: Specify PREG regex for links which should be ignored by the crawler. The crawler does not even follow these links e.g. @^www\.pimcore\.org\/community*@i')
  61.                             ->prototype('scalar')->end()
  62.                         ->end()
  63.                             ->scalarNode('core_invalid_links')
  64.                             ->info('Invalid Links/Extensions defined by core. You can\'nt override this.')
  65.                             ->cannotBeOverwritten()
  66.                         ->end()
  67.                     ->end()
  68.                 ->end()
  69.                 ->arrayNode('allowed_mime_types')
  70.                     ->info('Allowed MIME-Types. (Supported: text/html, application/pdf')
  71.                     ->prototype('scalar')->end()
  72.                 ->end()
  73.                 ->arrayNode('allowed_schemes')
  74.                     ->prototype('scalar')->end()
  75.                     ->info('Allowed Schemes: Define which url Schemes are allowed. (eg. http and/or https). Default is http.')
  76.                 ->end()
  77.                 ->arrayNode('crawler')
  78.                     ->children()
  79.                         ->integerNode('max_link_depth')
  80.                             ->info('Maximum link depth: To avoid loops produced by relative links on a website, a maximum link depth needs to be set. Please choose the value suited to the website to crawl, the default value is 15.')
  81.                         ->end()
  82.                         ->integerNode('max_download_limit')
  83.                             ->info('Maximum links to crawl: Constrain crawler to a specific limit of crawled links. Defaults is 0 which means no limit.')
  84.                         ->end()
  85.                         ->floatNode('content_max_size')
  86.                             ->info('Maximum content size (in MB): crawler ignores resources if its size exceeds limit (mostly useful for asset indexing). Defaults is 0 which means no limit.')
  87.                         ->end()
  88.                         ->scalarNode('content_start_indicator')
  89.                             ->info('You can limit the page content relevant for searching by surrounding it with certain html comments. The crawler will still parse the entire page to find links, but only the specified area wihin your html comments is used when searching for a term. String specifying content start for search.')
  90.                         ->end()
  91.                         ->scalarNode('content_end_indicator')
  92.                             ->info('String specifying content end for search.')
  93.                         ->end()
  94.                         ->scalarNode('content_exclude_start_indicator')
  95.                             ->info('String specifying exclude content start for search.')
  96.                         ->end()
  97.                         ->scalarNode('content_exclude_end_indicator')
  98.                             ->info('String specifying exclude content end for search.')
  99.                         ->end()
  100.                     ->end()
  101.                 ->end()
  102.                 ->arrayNode('locale')
  103.                     ->children()
  104.                         ->booleanNode('ignore_language')
  105.                             ->info('Receive search results from all languages, set to false to limit search results to the current language only. The current language is retrieved from the registy, the language of any page in the search result index is extracted by the crawler (Content-Language Http header, html tag lang attribute or html meta tag content-language)')
  106.                             ->isRequired()
  107.                         ->end()
  108.                         ->booleanNode('ignore_country')
  109.                             ->isRequired()
  110.                             ->info('Receive search results from all countries, set to false to limit search results to country only. The current country is retrieved from the search result index. it is extracted by the crawler (html meta tag country)')
  111.                         ->end()
  112.                     ->end()
  113.                 ->end()
  114.                 ->arrayNode('restriction')
  115.                     ->children()
  116.                         ->booleanNode('enabled')
  117.                             ->isRequired()
  118.                             ->info('Document Restriction: Ignore Document restrictions. Set to true if you\'re using the Pimcore/MembersBundle')
  119.                         ->end()
  120.                     ->end()
  121.                 ->end()
  122.                 ->arrayNode('boost')
  123.                     ->children()
  124.                         ->integerNode('documents')
  125.                             ->info('Document Boost Factor')
  126.                         ->end()
  127.                         ->integerNode('assets')
  128.                             ->info('Asset Boost Factor')
  129.                         ->end()
  130.                     ->end()
  131.                 ->end()
  132.                 ->arrayNode('view')
  133.                     ->children()
  134.                         ->integerNode('max_per_page')
  135.                             ->info('Max Results per Page')
  136.                         ->end()
  137.                         ->integerNode('max_suggestions')
  138.                             ->info('Max Suggestions')
  139.                         ->end()
  140.                     ->end()
  141.                 ->end()
  142.             ->end()
  143.         ;
  145.         return $treeBuilder;
  146.     }
  147. }