Passed
Push — master ( 5901ba...ea12d0 )
by Timo
20:48
created

getSearchInitializeWithQuery()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 5
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 3
CRAP Score 1

Importance

Changes 0
Metric Value
dl 0
loc 5
ccs 3
cts 3
cp 1
rs 9.4285
c 0
b 0
f 0
cc 1
eloc 3
nc 1
nop 1
crap 1
1
<?php
2
namespace ApacheSolrForTypo3\Solr\System\Configuration;
3
4
/***************************************************************
5
 *  Copyright notice
6
 *
7
 *  (c) 2016 Timo Schmidt <[email protected]>
8
 *  All rights reserved
9
 *
10
 *  This script is part of the TYPO3 project. The TYPO3 project is
11
 *  free software; you can redistribute it and/or modify
12
 *  it under the terms of the GNU General Public License as published by
13
 *  the Free Software Foundation; either version 2 of the License, or
14
 *  (at your option) any later version.
15
 *
16
 *  The GNU General Public License can be found at
17
 *  http://www.gnu.org/copyleft/gpl.html.
18
 *  A copy is found in the textfile GPL.txt and important notices to the license
19
 *  from the author is found in LICENSE.txt distributed with these scripts.
20
 *
21
 *
22
 *  This script is distributed in the hope that it will be useful,
23
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
24
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25
 *  GNU General Public License for more details.
26
 *
27
 *  This copyright notice MUST APPEAR in all copies of the script!
28
 ***************************************************************/
29
30
use ApacheSolrForTypo3\Solr\IndexQueue\Indexer;
31
use ApacheSolrForTypo3\Solr\IndexQueue\Initializer\Record;
32
use ApacheSolrForTypo3\Solr\System\ContentObject\ContentObjectService;
33
use ApacheSolrForTypo3\Solr\System\Util\ArrayAccessor;
34
use InvalidArgumentException;
35
use TYPO3\CMS\Core\Utility\ArrayUtility;
36
use TYPO3\CMS\Core\Utility\GeneralUtility;
37
38
/**
39
 * TypoScript configuration object, used to read all TypoScript configuration.
40
 *
41
 * The TypoScriptConfiguration was introduced in order to be able to replace the old,
42
 * array based configuration with one configuration object.
43
 *
44
 * To read the configuration, you should use
45
 *
46
 * $configuration->getValueByPath
47
 *
48
 * or
49
 *
50
 * $configuration->isValidPath
51
 *
52
 * to check if an configuration path exists.
53
 *
54
 * To ensure Backwards compatibility the TypoScriptConfiguration object implements the
55
 * ArrayAccess interface (offsetGet,offsetExists,offsetUnset and offsetSet)
56
 *
57
 * This was only introduced to be backwards compatible in logTerm only "getValueByPath", "isValidPath" or
58
 * speaking methods for configuration settings should be used!
59
 *
60
 * @author Marc Bastian Heinrichs <[email protected]>
61
 * @author Timo Schmidt <[email protected]>
62
 */
63
class TypoScriptConfiguration
64
{
65
    /**
66
     * @var \ApacheSolrForTypo3\Solr\System\Util\ArrayAccessor|null
67
     */
68
    protected $configurationAccess = null;
69
70
    /**
71
     * Holds the pageId in which context the configuration was parsed
72
     * (normally $GLOBALS['TSFE']->id)
73
     */
74
    protected $contextPageId = 0;
75
76
    /**
77
     * @var ContentObjectService
78
     */
79
    protected $contentObjectService;
80
81
    /**
82
     * @param array $configuration
83
     * @param int $contextPageId
84
     * @param ContentObjectService $contentObjectService
85
     */
86 256
    public function __construct(array $configuration, $contextPageId = 0, ContentObjectService $contentObjectService = null)
87
    {
88 256
        $this->configurationAccess = new ArrayAccessor($configuration, '.', true);
89 256
        $this->contextPageId = $contextPageId;
90 256
        $this->contentObjectService = is_null($contentObjectService) ? GeneralUtility::makeInstance(ContentObjectService::class) : $contentObjectService;
91 256
    }
92
93
    /**
94
     * Checks if a value is 1, '1', 'true'
95
     * @param mixed $value
96
     * @return bool
97
     */
98 249
    protected function getBool($value)
99
    {
100 249
        return filter_var($value, FILTER_VALIDATE_BOOLEAN);
101
    }
102
103
    /**
104
     * This method can be used to only retrieve array keys where the value is not an array.
105
     *
106
     * This can be very handy in the configuration when only keys should ne taken into account
107
     * where the value is not a subconfiguration (typically an typoscript object path).
108
     *
109
     * @param $inputArray
110
     * @return array
111
     */
112 11
    protected function getOnlyArrayKeysWhereValueIsNotAnArray($inputArray)
113
    {
114 11
        $keysWithNonArrayValue = [];
115
116 11
        foreach ($inputArray as $key => $value) {
117 11
            if (is_array($value)) {
118
                // configuration for a content object, skipping
119 8
                continue;
120
            }
121
122 11
            $keysWithNonArrayValue[] = $key;
123
        }
124
125 11
        return $keysWithNonArrayValue;
126
    }
127
128
    /**
129
     * Gets the value from a given TypoScript path.
130
     *
131
     * In the context of an frontend content element the path plugin.tx_solr is
132
     * merged recursive with overrule with the content element specific typoscript
133
     * settings, like plugin.tx_solr_PiResults_Results, and possible flex form settings
134
     * (depends on the solr plugin).
135
     *
136
     * Example: plugin.tx_solr.search.targetPage
137
     * returns $GLOBALS['TSFE']->tmpl->setup['plugin.']['tx_solr.']['search.']['targetPage']
138
     *
139
     * @param string $path TypoScript path
140
     * @return mixed The TypoScript object defined by the given path
141
     * @throws InvalidArgumentException
142
     */
143 288
    public function getValueByPath($path)
144
    {
145 288
        if (!is_string($path)) {
146
            throw new InvalidArgumentException('Parameter $path is not a string',
147
                1325623321);
148
        }
149 288
        return $this->configurationAccess->get($path);
150
    }
151
152
    /**
153
     * This method can be used to get  a configuration value by path if it exists or return a
154
     * default value when it does not exist.
155
     *
156
     * @param string $path
157
     * @param mixed $defaultValue
158
     * @return mixed
159
     */
160 285
    public function getValueByPathOrDefaultValue($path, $defaultValue)
161
    {
162 285
        $value = $this->getValueByPath($path);
163 285
        if (is_null($value)) {
164 275
            return $defaultValue;
165
        }
166
167 163
        return $value;
168
    }
169
170
    /**
171
     * Gets the parent TypoScript Object from a given TypoScript path.
172
     *
173
     * In the context of an frontend content element the path plugin.tx_solr is
174
     * merged recursive with overrule with the content element specific typoscript
175
     * settings, like plugin.tx_solr_PiResults_Results, and possible flex form settings
176
     * (depends on the solr plugin).
177
     *
178
     * Example: plugin.tx_solr.index.queue.tt_news.fields.content
179
     * returns $GLOBALS['TSFE']->tmpl->setup['plugin.']['tx_solr.']['index.']['queue.']['tt_news.']['fields.']['content.']
180
     * which is a SOLR_CONTENT cObj.
181
     *
182
     * @param string $path TypoScript path
183
     * @return array The TypoScript object defined by the given path
184
     * @throws InvalidArgumentException
185
     */
186 177
    public function getObjectByPath($path)
187
    {
188 177
        if (substr($path, -1) !== '.') {
189 1
            $path = rtrim($path, '.');
190 1
            $path = substr($path, 0, strrpos($path, '.') + 1);
191
        }
192
193 177
        if (!is_string($path)) {
194
            throw new InvalidArgumentException('Parameter $path is not a string', 1325627243);
195
        }
196
197 177
        return $this->configurationAccess->get($path);
198
    }
199
200
    /**
201
     * Gets the parent TypoScript Object from a given TypoScript path and if not present return
202
     * the default value
203
     *
204
     * @see getObjectByPath
205
     * @param string $path
206
     * @param array $defaultValue
207
     * @return array
208
     */
209 172
    public function getObjectByPathOrDefault($path, array $defaultValue)
210
    {
211
        try {
212 172
            $object = $this->getObjectByPath($path);
213
        } catch (\InvalidArgumentException $e) {
214
            return $defaultValue;
215
        }
216
217 172
        if (!is_array($object)) {
218 45
            return $defaultValue;
219
        }
220
221 168
        return $object;
222
    }
223
224
    /**
225
     * Checks whether a given TypoScript path is valid.
226
     *
227
     * @param string $path TypoScript path
228
     * @return bool TRUE if the path resolves, FALSE otherwise
229
     */
230
    public function isValidPath($path)
231
    {
232
        $isValidPath = false;
233
234
        $pathValue = $this->getValueByPath($path);
235
        if (!is_null($pathValue)) {
236
            $isValidPath = true;
237
        }
238
239
        return $isValidPath;
240
    }
241
242
    /**
243
     * Merges a configuration with another configuration a
244
     *
245
     * @param array $configurationToMerge
246
     * @param bool $addKeys If set to FALSE, keys that are NOT found in $original will not be set. Thus only existing value can/will be overruled from overrule array.
247
     * @param bool $includeEmptyValues If set, values from $overrule will overrule if they are empty or zero.
248
     * @param bool $enableUnsetFeature If set, special values "__UNSET" can be used in the overrule array in order to unset array keys in the original array.
249
     * @return TypoScriptConfiguration
250
     */
251 16
    public function mergeSolrConfiguration(array $configurationToMerge, $addKeys = true, $includeEmptyValues = true, $enableUnsetFeature = true)
252
    {
253 16
        $data = $this->configurationAccess->getData();
254 16
        ArrayUtility::mergeRecursiveWithOverrule(
255 16
            $data['plugin.']['tx_solr.'],
256
            $configurationToMerge,
257
            $addKeys,
258
            $includeEmptyValues,
259
            $enableUnsetFeature
260
        );
261
262 16
        $this->configurationAccess->setData($data);
263
264 16
        return $this;
265
    }
266
267
    /**
268
     * Returns true when ext_solr is enabled
269
     *
270
     * @param boolean $defaultIfEmpty
271
     * @return boolean
272
     */
273 3
    public function getEnabled($defaultIfEmpty = false)
274
    {
275 3
        $path = 'plugin.tx_solr.enabled';
276 3
        $result = $this->getValueByPathOrDefaultValue($path, $defaultIfEmpty);
277 3
        return $this->getBool($result);
278
    }
279
280
    /**
281
     * Returns the configured additionalFields configured for the indexing.
282
     *
283
     * plugin.tx_solr.index.additionalFields.
284
     *
285
     * @param array $defaultIfEmpty
286
     * @return array
287
     */
288 3
    public function getIndexAdditionalFieldsConfiguration($defaultIfEmpty = [])
289
    {
290 3
        $result = $this->getObjectByPathOrDefault('plugin.tx_solr.index.additionalFields.', $defaultIfEmpty);
291 3
        return $result;
292
    }
293
294
    /**
295
     * Returns all solr fields names where a mapping is configured in index.additionalFields
296
     *
297
     * Returns all keys from
298
     * plugin.tx_solr.index.additionalFields.
299
     *
300
     * @param array $defaultIfEmpty
301
     * @return array
302
     */
303 2
    public function getIndexMappedAdditionalFieldNames($defaultIfEmpty = [])
304
    {
305 2
        $mappingConfiguration = $this->getIndexAdditionalFieldsConfiguration();
306 2
        $mappedFieldNames = $this->getOnlyArrayKeysWhereValueIsNotAnArray($mappingConfiguration);
307 2
        return count($mappedFieldNames) == 0 ? $defaultIfEmpty : $mappedFieldNames;
308
    }
309
310
    /**
311
     * Returns the fieldProcessingInstructions configuration array
312
     *
313
     * plugin.tx_solr.index.fieldProcessingInstructions.
314
     *
315
     * @param array $defaultIfEmpty
316
     * @return array
317
     */
318 69
    public function getIndexFieldProcessingInstructionsConfiguration(array $defaultIfEmpty = [])
319
    {
320 69
        $result = $this->getObjectByPathOrDefault('plugin.tx_solr.index.fieldProcessingInstructions.', $defaultIfEmpty);
321 69
        return $result;
322
    }
323
324
    /**
325
     * Retrieves the indexing configuration array for an indexing queue by configuration name.
326
     *
327
     * plugin.tx_solr.index.queue.<configurationName>.
328
     *
329
     * @param string $configurationName
330
     * @param array $defaultIfEmpty
331
     * @return array
332
     */
333 6
    public function getIndexQueueConfigurationByName($configurationName, array $defaultIfEmpty = [])
334
    {
335 6
        $path = 'plugin.tx_solr.index.queue.' . $configurationName . '.';
336 6
        $result = $this->getObjectByPathOrDefault($path, $defaultIfEmpty);
337 6
        return $result;
338
    }
339
340
    /**
341
     * Returns an array of all additionalPageIds by index configuration name.
342
     *
343
     * plugin.tx_solr.index.queue.pages.additionalPageIds
344
     *
345
     * @param string $configurationName
346
     * @param array $defaultIfEmpty
347
     * @return array
348
     */
349 39
    public function getIndexQueueAdditionalPageIdsByConfigurationName($configurationName = 'pages', $defaultIfEmpty = [])
350
    {
351 39
        $path = 'plugin.tx_solr.index.queue.' . $configurationName . '.additionalPageIds';
352 39
        $result = $this->getValueByPathOrDefaultValue($path, '');
353 39
        if (trim($result) == '') {
354 35
            return $defaultIfEmpty;
355
        }
356
357 4
        return GeneralUtility::trimExplode(',', $result);
358
    }
359
360
    /**
361
     * Returns an array of all allowedPageTypes.
362
     *
363
     * plugin.tx_solr.index.queue.pages.allowedPageTypes
364
     *
365
     * @param string $configurationName The configuration name of the queue to use.
366
     * @param array $defaultIfEmpty
367
     * @return array
368
     */
369 30
    public function getIndexQueueAllowedPageTypesArrayByConfigurationName($configurationName = 'pages', $defaultIfEmpty = [])
370
    {
371 30
        $path = 'plugin.tx_solr.index.queue.' . $configurationName . '.allowedPageTypes';
372 30
        $result = $this->getValueByPathOrDefaultValue($path, '');
373 30
        if (trim($result) == '') {
374
            return $defaultIfEmpty;
375
        }
376
377 30
        return GeneralUtility::trimExplode(',', $result);
378
    }
379
380
    /**
381
     * Returns the configured excludeContentByClass patterns as array.
382
     *
383
     * plugin.tx_solr.index.queue.pages.excludeContentByClass
384
     *
385
     * @param array $defaultIfEmpty
386
     * @return array
387
     */
388 44
    public function getIndexQueuePagesExcludeContentByClassArray($defaultIfEmpty = [])
389
    {
390 44
        $path = 'plugin.tx_solr.index.queue.pages.excludeContentByClass';
391 44
        $result = $this->getValueByPathOrDefaultValue($path, '');
392
393 44
        if (trim($result) == '') {
394 7
            return $defaultIfEmpty;
395
        }
396
397 37
        return GeneralUtility::trimExplode(',', $result);
398
    }
399
400
    /**
401
     * Returns the configured database table for an indexing queue configuration or
402
     * the configurationName itself that is used by convention as tableName when no
403
     * other tablename is present.
404
     *
405
     * plugin.tx_solr.index.queue.<configurationName>.table or configurationName
406
     *
407
     * @param string $configurationName
408
     * @return string
409
     */
410 68
    public function getIndexQueueTableNameOrFallbackToConfigurationName($configurationName = '')
411
    {
412 68
        $path = 'plugin.tx_solr.index.queue.' . $configurationName . '.table';
413 68
        $result = $this->getValueByPathOrDefaultValue($path, $configurationName);
414 68
        return $result;
415
    }
416
417
    /**
418
     * Returns the field configuration for a specific index queue.
419
     *
420
     * plugin.tx_solr.index.queue.<configurationName>.fields.
421
     *
422
     * @param string $configurationName
423
     * @param array $defaultIfEmpty
424
     * @return array
425
     */
426 27
    public function getIndexQueueFieldsConfigurationByConfigurationName($configurationName = '', $defaultIfEmpty = [])
427
    {
428 27
        $path = 'plugin.tx_solr.index.queue.' . $configurationName . '.fields.';
429 27
        $result = $this->getObjectByPathOrDefault($path, $defaultIfEmpty);
430 27
        return $result;
431
    }
432
433
    /**
434
     * Gets an array of tables configured for indexing by the Index Queue. Since the
435
     * record monitor must watch these tables for manipulation.
436
     *
437
     * @return array Array of table names to be watched by the record monitor.
438
     */
439 35
    public function getIndexQueueMonitoredTables()
440
    {
441 35
        $monitoredTables = [];
442
443 35
        $indexingConfigurations = $this->getEnabledIndexQueueConfigurationNames();
444 35
        foreach ($indexingConfigurations as $indexingConfigurationName) {
445 35
            $monitoredTable = $this->getIndexQueueTableNameOrFallbackToConfigurationName($indexingConfigurationName);
446 35
            $monitoredTables[] = $monitoredTable;
447 35
            if ($monitoredTable == 'pages') {
448
                // when monitoring pages, also monitor creation of translations
449 35
                $monitoredTables[] = 'pages_language_overlay';
450
            }
451
        }
452
453 35
        return array_values(array_unique($monitoredTables));
454
    }
455
456
    /**
457
     * This method can be used to check if a table is configured to be monitored by the record monitor.
458
     *
459
     * @param string $tableName
460
     * @return bool
461
     */
462 34
    public function getIndexQueueIsMonitoredTable($tableName)
463
    {
464 34
        return in_array($tableName, $this->getIndexQueueMonitoredTables(), true);
465
    }
466
467
    /**
468
     * Returns the configured indexer class that should be used for a certain indexingConfiguration.
469
     * By default "ApacheSolrForTypo3\Solr\IndexQueue\Indexer" will be returned.
470
     *
471
     * plugin.tx_solr.index.queue.<configurationName>.indexer
472
     *
473
     * @param string $configurationName
474
     * @param string $defaultIfEmpty
475
     * @return string
476
     */
477 6
    public function getIndexQueueIndexerByConfigurationName($configurationName, $defaultIfEmpty = Indexer::class)
478
    {
479 6
        $path = 'plugin.tx_solr.index.queue.' . $configurationName . '.indexer';
480 6
        $result = $this->getValueByPathOrDefaultValue($path, $defaultIfEmpty);
481 6
        return $result;
482
    }
483
484
    /**
485
     * Returns the configuration of an indexer for a special indexingConfiguration. By default an empty
486
     * array is returned.
487
     *
488
     * plugin.tx_solr.index.queue.<configurationName>.indexer.
489
     *
490
     * @param string $configurationName
491
     * @param array $defaultIfEmpty
492
     * @return array
493
     */
494 6
    public function getIndexQueueIndexerConfigurationByConfigurationName($configurationName, $defaultIfEmpty = [])
495
    {
496 6
        $path = 'plugin.tx_solr.index.queue.' . $configurationName . '.indexer.';
497 6
        $result = $this->getObjectByPathOrDefault($path, $defaultIfEmpty);
498 6
        return $result;
499
    }
500
501
    /**
502
     * Returns all solr fields names where a mapping configuration is set for a certain index configuration
503
     *
504
     * Returns all keys from
505
     * plugin.tx_solr.index.queue.<configurationName>.fields.
506
     *
507
     * @param string $configurationName
508
     * @param array $defaultIfEmpty
509
     * @return array
510
     */
511 10
    public function getIndexQueueMappedFieldsByConfigurationName($configurationName = '', $defaultIfEmpty = [])
512
    {
513 10
        $mappingConfiguration = $this->getIndexQueueFieldsConfigurationByConfigurationName($configurationName);
514 10
        $mappedFieldNames = $this->getOnlyArrayKeysWhereValueIsNotAnArray($mappingConfiguration);
515 10
        return count($mappedFieldNames) == 0 ? $defaultIfEmpty : $mappedFieldNames;
516
    }
517
518
    /**
519
     * This method is used to check if an index queue configuration is enabled or not
520
     *
521
     * plugin.tx_solr.index.queue.<configurationName> = 1
522
     *
523
     * @param string $configurationName
524
     * @param bool $defaultIfEmpty
525
     * @return bool
526
     */
527 63
    public function getIndexQueueConfigurationIsEnabled($configurationName, $defaultIfEmpty = false)
528
    {
529 63
        $path = 'plugin.tx_solr.index.queue.' . $configurationName;
530 63
        $result = $this->getValueByPathOrDefaultValue($path, $defaultIfEmpty);
531 63
        return $this->getBool($result);
532
    }
533
534
    /**
535
     * Retrieves an array of enabled index queue configurations.
536
     *
537
     * plugin.tx_solr.index.queue.<configurationName>
538
     *
539
     * @param array $defaultIfEmpty
540
     * @return array
541
     */
542 70
    public function getEnabledIndexQueueConfigurationNames($defaultIfEmpty = [])
543
    {
544 70
        $tablesToIndex = [];
545 70
        $path = 'plugin.tx_solr.index.queue.';
546 70
        $indexQueueConfiguration = $this->getObjectByPathOrDefault($path, []);
547 70
        foreach ($indexQueueConfiguration as $configurationName => $indexingEnabled) {
548 68
            if (substr($configurationName, -1) != '.' && $indexingEnabled) {
549 68
                $tablesToIndex[] = $configurationName;
550
            }
551
        }
552
553 70
        return count($tablesToIndex) == 0 ? $defaultIfEmpty : $tablesToIndex;
554
    }
555
556
    /**
557
     * Retrieves an array of additional fields that will trigger an recursive update of pages
558
     * when some of the fields on that page are modified.
559
     *
560
     * plugin.tx_solr.index.queue.recursiveUpdateFields
561
     *
562
     * @param string $configurationName
563
     * @param array $defaultIfEmpty
564
     * @return array
565
     */
566 26
    public function getIndexQueueConfigurationRecursiveUpdateFields($configurationName, $defaultIfEmpty = [])
567
    {
568 26
        $path = 'plugin.tx_solr.index.queue.' . $configurationName . '.recursiveUpdateFields';
569 26
        $recursiveUpdateFieldsString = $this->getValueByPathOrDefaultValue($path, '');
570 26
        if (trim($recursiveUpdateFieldsString) === '') {
571 20
            return $defaultIfEmpty;
572
        }
573 7
        $recursiveUpdateFields = GeneralUtility::trimExplode(',', $recursiveUpdateFieldsString);
574
        // For easier check later on we return an array by combining $recursiveUpdateFields
575 7
        return array_combine($recursiveUpdateFields, $recursiveUpdateFields);
576
    }
577
578
579
    /**
580
     * Retrieves and initialPagesAdditionalWhereClause where clause when configured or an empty string.
581
     *
582
     * plugin.tx_solr.index.queue.<configurationName>.initialPagesAdditionalWhereClause
583
     *
584
     * @param string $configurationName
585
     * @return string
586
     */
587 13
    public function getInitialPagesAdditionalWhereClause($configurationName)
588
    {
589 13
        $path = 'plugin.tx_solr.index.queue.' . $configurationName . '.initialPagesAdditionalWhereClause';
590 13
        $initialPagesAdditionalWhereClause = $this->getValueByPathOrDefaultValue($path, '');
591
592 13
        if (trim($initialPagesAdditionalWhereClause) === '') {
593 13
            return '';
594
        }
595
596 1
        return ' AND ' . $initialPagesAdditionalWhereClause;
597
    }
598
599
    /**
600
     * Retrieves and additional where clause when configured or an empty string.
601
     *
602
     * plugin.tx_solr.index.queue.<configurationName>.additionalWhereClause
603
     *
604
     * @param string $configurationName
605
     * @return string
606
     */
607 66
    public function getIndexQueueAdditionalWhereClauseByConfigurationName($configurationName)
608
    {
609 66
        $path = 'plugin.tx_solr.index.queue.' . $configurationName . '.additionalWhereClause';
610 66
        $additionalWhere = $this->getValueByPathOrDefaultValue($path, '');
611
612 66
        if (trim($additionalWhere) === '') {
613 21
            return '';
614
        }
615
616 46
        return ' AND ' . $additionalWhere;
617
    }
618
619
    /**
620
     * This method can be used to retrieve all index queue configuration names, where
621
     * a certain table is used. It can be configured with the property "table" or is using the configuration
622
     * key a fallback for the table name.
623
     *
624
     * plugin.tx_solr.index.queue.<configurationName>.
625
     *
626
     * @param string $tableName
627
     * @param array $defaultIfEmpty
628
     * @return array
629
     */
630 1
    public function getIndexQueueConfigurationNamesByTableName($tableName, $defaultIfEmpty = [])
631
    {
632 1
        $path = 'plugin.tx_solr.index.queue.';
633 1
        $configuration = $this->getObjectByPathOrDefault($path, []);
634 1
        $possibleConfigurations = [];
635
636 1
        foreach ($configuration as $configurationName => $indexingEnabled) {
637 1
            $isObject = substr($configurationName, -1) == '.';
638 1
            if ($isObject || !$indexingEnabled) {
639 1
                continue;
640
            }
641
642
            // when the configuration name equals the tableName we have a fallback
643 1
            $hasTableNameAsConfigurationName = $configurationName == $tableName;
644 1
            $hasTableAssignedInQueueConfiguration = isset($configuration[$configurationName . '.']['table']) &&
645 1
                                                    $configuration[$configurationName . '.']['table'] == $tableName;
646 1
            if ($hasTableNameAsConfigurationName || $hasTableAssignedInQueueConfiguration) {
647 1
                $possibleConfigurations[] = $configurationName;
648
            }
649
        }
650
651 1
        return count($possibleConfigurations) > 0 ? $possibleConfigurations : $defaultIfEmpty;
652
    }
653
654
    /**
655
     * This method is used to retrieve the className of a queue initializer for a certain indexing configuration
656
     * of returns the default initializer class, when noting is configured.
657
     *
658
     * plugin.tx_solr.index.queue.<configurationName>.initialization
659
     *
660
     * @param string $configurationName
661
     * @param string $defaultIfEmpty
662
     * @return string
663
     */
664 6
    public function getIndexQueueInitializerClassByConfigurationName($configurationName, $defaultIfEmpty = Record::class)
665
    {
666 6
        $path = 'plugin.tx_solr.index.queue.' . $configurationName . '.initialization';
667 6
        $className = $this->getValueByPathOrDefaultValue($path, $defaultIfEmpty);
668
669 6
        return $className;
670
    }
671
672
    /**
673
     * Returns the _LOCAL_LANG configuration from the TypoScript.
674
     *
675
     * plugin.tx_solr._LOCAL_LANG.
676
     *
677
     * @param array $defaultIfEmpty
678
     * @return array
679
     */
680
    public function getLocalLangConfiguration(array $defaultIfEmpty = [])
681
    {
682
        $result = $this->getObjectByPathOrDefault('plugin.tx_solr._LOCAL_LANG.', $defaultIfEmpty);
683
        return $result;
684
    }
685
686
    /**
687
     * When this is enabled the output of the devlog, will be printed as debug output.
688
     *
689
     * @param bool $defaultIfEmpty
690
     * @return bool
691
     */
692
    public function getLoggingDebugOutput($defaultIfEmpty = false)
693
    {
694
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.logging.debugOutput', $defaultIfEmpty);
695
        return $this->getBool($result);
696
    }
697
698
    /**
699
     * Returns if query filters should be written to the log.
700
     *
701
     * plugin.tx_solr.logging.query.filters
702
     *
703
     * @param bool $defaultIfEmpty
704
     * @return bool
705
     */
706
    public function getLoggingQueryFilters($defaultIfEmpty = false)
707
    {
708
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.logging.query.filters', $defaultIfEmpty);
709
        return $this->getBool($result);
710
    }
711
712
    /**
713
     * Returns if the querystring should be logged or not.
714
     *
715
     * plugin.tx_solr.logging.query.queryString
716
     *
717
     * @param bool $defaultIfEmpty
718
     * @return bool
719
     */
720 33
    public function getLoggingQueryQueryString($defaultIfEmpty = false)
721
    {
722 33
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.logging.query.queryString', $defaultIfEmpty);
723 33
        return $this->getBool($result);
724
    }
725
726
    /**
727
     * Returns if the searchWords should be logged or not.
728
     *
729
     * plugin.tx_solr.logging.query.searchWords
730
     *
731
     * @param bool $defaultIfEmpty
732
     * @return bool
733
     */
734 30
    public function getLoggingQuerySearchWords($defaultIfEmpty = false)
735
    {
736 30
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.logging.query.searchWords', $defaultIfEmpty);
737 30
        return $this->getBool($result);
738
    }
739
740
    /**
741
     * Returns if the rawGet requests should be logged or not.
742
     *
743
     * plugin.tx_solr.logging.query.rawGet
744
     *
745
     * @param bool $defaultIfEmpty
746
     * @return bool
747
     */
748 48
    public function getLoggingQueryRawGet($defaultIfEmpty = false)
749
    {
750 48
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.logging.query.rawGet', $defaultIfEmpty);
751 48
        return $this->getBool($result);
752
    }
753
754
    /**
755
     * Returns if the rawPost requests should be logged or not.
756
     *
757
     * plugin.tx_solr.logging.query.rawPost
758
     *
759
     * @param bool $defaultIfEmpty
760
     * @return bool
761
     */
762 78
    public function getLoggingQueryRawPost($defaultIfEmpty = false)
763
    {
764 78
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.logging.query.rawPost', $defaultIfEmpty);
765 78
        return $this->getBool($result);
766
    }
767
768
    /**
769
     * Returns if the rawDelete requests should be logged or not.
770
     *
771
     * plugin.tx_solr.logging.query.rawDelete
772
     *
773
     * @param bool $defaultIfEmpty
774
     * @return bool
775
     */
776 4
    public function getLoggingQueryRawDelete($defaultIfEmpty = false)
777
    {
778 4
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.logging.query.rawDelete', $defaultIfEmpty);
779 4
        return $this->getBool($result);
780
    }
781
782
    /**
783
     * Returns if exceptions should be logged or not.
784
     *
785
     * plugin.tx_solr.logging.exceptions
786
     *
787
     * @param bool $defaultIfEmpty
788
     * @return bool
789
     */
790 4
    public function getLoggingExceptions($defaultIfEmpty = true)
791
    {
792 4
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.logging.exceptions', $defaultIfEmpty);
793 4
        return $this->getBool($result);
794
    }
795
796
    /**
797
     * Returns if indexing operations should be logged or not.
798
     *
799
     * plugin.tx_solr.logging.indexing
800
     *
801
     * @param bool $defaultIfEmpty
802
     * @return bool
803
     */
804 19
    public function getLoggingIndexing($defaultIfEmpty = false)
805
    {
806 19
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.logging.indexing', $defaultIfEmpty);
807 19
        return $this->getBool($result);
808
    }
809
810
    /**
811
     * Returns if indexing queue operations should be logged or not.
812
     *
813
     * plugin.tx_solr.logging.indexing.queue
814
     *
815
     * @param bool $defaultIfEmpty
816
     * @return bool
817
     */
818 18
    public function getLoggingIndexingQueue($defaultIfEmpty = false)
819
    {
820 18
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.logging.indexing.queue', $defaultIfEmpty);
821 18
        return $this->getBool($result);
822
    }
823
824
    /**
825
     * This method can be used to check if the logging during indexing should be done.
826
     * It takes the specific configuration by indexQueueConfiguration into account or is using the
827
     * fallback when the logging is enabled on queue or indexing level.
828
     *
829
     * plugin.tx_solr.logging.indexing.queue.<indexQueueConfiguration>
830
     *
831
     * @param string $indexQueueConfiguration
832
     * @param bool $defaultIfEmpty
833
     * @return bool
834
     */
835 19
    public function getLoggingIndexingQueueOperationsByConfigurationNameWithFallBack($indexQueueConfiguration, $defaultIfEmpty = false)
836
    {
837
        // when logging is globally enabled we do not need to check the specific configuration
838 19
        if ($this->getLoggingIndexing()) {
839 1
            return true;
840
        }
841
842
        // when the logging for indexing is enabled on queue level we also do not need to check the specific configuration
843 18
        if ($this->getLoggingIndexingQueue()) {
844
            return true;
845
        }
846
847 18
        $path = 'plugin.tx_solr.logging.indexing.queue.' . $indexQueueConfiguration;
848 18
        $result = $this->getValueByPathOrDefaultValue($path, $defaultIfEmpty);
849 18
        return $this->getBool($result);
850
    }
851
852
    /**
853
     * Returns if a log message should be written when a page was indexed.
854
     *
855
     * plugin.tx_solr.logging.indexing.pageIndexed
856
     *
857
     * @param bool $defaultIfEmpty
858
     * @return bool
859
     */
860 9
    public function getLoggingIndexingPageIndexed($defaultIfEmpty = false)
861
    {
862 9
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.logging.indexing.pageIndexed', $defaultIfEmpty);
863 9
        return $this->getBool($result);
864
    }
865
866
    /**
867
     * Returns if a log message should be written when the TYPO3 search markers are missing in the page.
868
     *
869
     * plugin.tx_solr.logging.indexing.missingTypo3SearchMarkers
870
     *
871
     * @param bool $defaultIfEmpty
872
     * @return bool
873
     */
874 10
    public function getLoggingIndexingMissingTypo3SearchMarkers($defaultIfEmpty = true)
875
    {
876 10
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.logging.indexing.missingTypo3SearchMarkers', $defaultIfEmpty);
877 10
        return $this->getBool($result);
878
    }
879
880
    /**
881
     * Returns if the initialization of an indexqueue should be logged.
882
     *
883
     * plugin.tx_solr.logging.indexing.indexQueueInitialization
884
     *
885
     * @param bool $defaultIfEmpty
886
     * @return bool
887
     */
888 12
    public function getLoggingIndexingIndexQueueInitialization($defaultIfEmpty = false)
889
    {
890 12
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.logging.indexing.indexQueueInitialization', $defaultIfEmpty);
891 12
        return $this->getBool($result);
892
    }
893
894
    /**
895
     * Indicates if the debug mode is enabled or not.
896
     *
897
     * plugin.tx_solr.enableDebugMode
898
     *
899
     * @param bool $defaultIfEmpty
900
     * @return bool
901
     */
902 30
    public function getEnabledDebugMode($defaultIfEmpty = false)
903
    {
904 30
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.enableDebugMode', $defaultIfEmpty);
905 30
        return $this->getBool($result);
906
    }
907
908
    /**
909
     * Returns true or false if something is configured below plugin.tx_solr.solr.
910
     *
911
     * plugin.tx_solr.solr.
912
     *
913
     * @param boolean $defaultIfEmpty
914
     * @return boolean
915
     */
916 3
    public function getSolrHasConnectionConfiguration($defaultIfEmpty = false)
917
    {
918 3
        $configuration = $this->getObjectByPathOrDefault('plugin.tx_solr.solr.', []);
919 3
        return $configuration !== [] ? true : $defaultIfEmpty;
920
    }
921
922
    /**
923
     * Returns the defaultTimeout used for requests to the Solr server
924
     *
925
     * plugin.tx_solr.solr.timeout
926
     *
927
     * @param float $defaultIfEmpty
928
     * @return float
929
     */
930 102
    public function getSolrTimeout($defaultIfEmpty = 0.0)
931
    {
932 102
        return (float)$this->getValueByPathOrDefaultValue('plugin.tx_solr.solr.timeout', $defaultIfEmpty);
933
    }
934
935
    /**
936
     * Returns the scheme used for requests to the Solr server
937
     *
938
     * plugin.tx_solr.solr.scheme
939
     *
940
     * Applies stdWrap on the configured setting
941
     *
942
     * @param string $defaultIfEmpty
943
     * @return string
944
     */
945 4
    public function getSolrScheme($defaultIfEmpty = 'http')
946
    {
947 4
        $valuePath = 'plugin.tx_solr.solr.scheme';
948 4
        $value = (string)$this->getValueByPathOrDefaultValue($valuePath, $defaultIfEmpty);
949 4
        return $this->renderContentElementOfConfigured($valuePath, $value);
950
    }
951
952
    /**
953
     * Returns the hostname used for requests to the Solr server
954
     *
955
     * plugin.tx_solr.solr.host
956
     *
957
     * Applies stdWrap on the configured setting
958
     *
959
     * @param string $defaultIfEmpty
960
     * @return string
961
     */
962 7
    public function getSolrHost($defaultIfEmpty = 'localhost')
963
    {
964 7
        $valuePath = 'plugin.tx_solr.solr.host';
965 7
        $value = (string)$this->getValueByPathOrDefaultValue($valuePath, $defaultIfEmpty);
966 7
        return $this->renderContentElementOfConfigured($valuePath, $value);
967
    }
968
969
    /**
970
     * Returns the port used for requests to the Solr server
971
     *
972
     * plugin.tx_solr.solr.port
973
     *
974
     * Applies stdWrap on the configured setting
975
     *
976
     * @param int $defaultIfEmpty
977
     * @return int
978
     */
979 4
    public function getSolrPort($defaultIfEmpty = 8983)
980
    {
981 4
        $valuePath = 'plugin.tx_solr.solr.port';
982 4
        $value = (string)$this->getValueByPathOrDefaultValue($valuePath, $defaultIfEmpty);
983 4
        return $this->renderContentElementOfConfigured($valuePath, $value);
984
    }
985
986
    /**
987
     * Returns the path used for requests to the Solr server
988
     *
989
     * plugin.tx_solr.solr.path
990
     *
991
     * Applies stdWrap on the configured setting
992
     *
993
     * @param string $defaultIfEmpty
994
     * @return string
995
     */
996 7
    public function getSolrPath($defaultIfEmpty = '/solr/core_en/')
997
    {
998 7
        $valuePath = 'plugin.tx_solr.solr.path';
999 7
        $value = (string)$this->getValueByPathOrDefaultValue($valuePath, $defaultIfEmpty);
1000 7
        $solrPath = $this->renderContentElementOfConfigured($valuePath, $value);
1001
1002 7
        $solrPath = trim($solrPath, '/');
1003 7
        $solrPath = '/' . $solrPath . '/';
1004
1005 7
        return $solrPath;
1006
    }
1007
1008
    /**
1009
     * Returns the username used for requests to the Solr server
1010
     *
1011
     * plugin.tx_solr.solr.username
1012
     *
1013
     * Applies stdWrap on the configured setting
1014
     *
1015
     * @param string $defaultIfEmpty
1016
     * @return string
1017
     */
1018 4
    public function getSolrUsername($defaultIfEmpty = '')
1019
    {
1020 4
        $valuePath = 'plugin.tx_solr.solr.username';
1021 4
        $value = (string)$this->getValueByPathOrDefaultValue($valuePath, $defaultIfEmpty);
1022 4
        return $this->renderContentElementOfConfigured($valuePath, $value);
1023
    }
1024
1025
    /**
1026
     * Returns the password used for requests to the Solr server
1027
     *
1028
     * plugin.tx_solr.solr.password
1029
     *
1030
     * Applies stdWrap on the configured setting
1031
     *
1032
     * @param string $defaultIfEmpty
1033
     * @return string
1034
     */
1035 4
    public function getSolrPassword($defaultIfEmpty = '')
1036
    {
1037 4
        $valuePath = 'plugin.tx_solr.solr.password';
1038 4
        $value = (string)$this->getValueByPathOrDefaultValue($valuePath, $defaultIfEmpty);
1039 4
        return $this->renderContentElementOfConfigured($valuePath, $value);
1040
    }
1041
1042
    /**
1043
     * Retrieves the complete search configuration
1044
     *
1045
     * plugin.tx_solr.search.
1046
     *
1047
     * @param array $defaultIfEmpty
1048
     * @return array
1049
     */
1050 30
    public function getSearchConfiguration(array $defaultIfEmpty = [])
1051
    {
1052 30
        $result = $this->getObjectByPathOrDefault('plugin.tx_solr.search.', $defaultIfEmpty);
1053 30
        return $result;
1054
    }
1055
1056
    /**
1057
     * Indicates if elevation should be used or not
1058
     *
1059
     * plugin.tx_solr.search.elevation
1060
     *
1061
     * @param bool $defaultIfEmpty
1062
     * @return bool
1063
     */
1064 30
    public function getSearchElevation($defaultIfEmpty = false)
1065
    {
1066 30
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.elevation', $defaultIfEmpty);
1067 30
        return $this->getBool($result);
1068
    }
1069
1070
    /**
1071
     * Indicates if elevated results should be marked
1072
     *
1073
     * plugin.tx_solr.search.elevation.markElevatedResults
1074
     *
1075
     * @param bool $defaultIfEmpty
1076
     * @return bool
1077
     */
1078 30
    public function getSearchElevationMarkElevatedResults($defaultIfEmpty = true)
1079
    {
1080 30
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.elevation.markElevatedResults', $defaultIfEmpty);
1081 30
        return $this->getBool($result);
1082
    }
1083
1084
    /**
1085
     * Indicates if elevation should be forced
1086
     *
1087
     *plugin.tx_solr.search.elevation.forceElevation
1088
     *
1089
     * @param bool $defaultIfEmpty
1090
     * @return bool
1091
     */
1092 30
    public function getSearchElevationForceElevation($defaultIfEmpty = true)
1093
    {
1094 30
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.elevation.forceElevation', $defaultIfEmpty);
1095 30
        return $this->getBool($result);
1096
    }
1097
1098
    /**
1099
     * Indicates if collapsing on a certain field should be used to build variants or not.
1100
     *
1101
     * plugin.tx_solr.search.variants
1102
     *
1103
     * @param bool $defaultIfEmpty
1104
     * @return bool
1105
     */
1106 121
    public function getSearchVariants($defaultIfEmpty = false)
1107
    {
1108 121
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.variants', $defaultIfEmpty);
1109 121
        return $this->getBool($result);
1110
    }
1111
1112
    /**
1113
     * Indicates if collapsing on a certain field should be used or not
1114
     *
1115
     * plugin.tx_solr.search.variants.variantField
1116
     *
1117
     * @param string $defaultIfEmpty
1118
     * @return string
1119
     */
1120 3
    public function getSearchVariantsField($defaultIfEmpty = 'variantId')
1121
    {
1122 3
        return $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.variants.variantField', $defaultIfEmpty);
1123
    }
1124
1125
    /**
1126
     * Indicates if expanding of collapsed items it activated.
1127
     *
1128
     * plugin.tx_solr.search.variants.expand
1129
     *
1130
     * @param bool $defaultIfEmpty
1131
     * @return bool
1132
     */
1133 5
    public function getSearchVariantsExpand($defaultIfEmpty = false)
1134
    {
1135 5
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.variants.expand', $defaultIfEmpty);
1136 5
        return $this->getBool($result);
1137
    }
1138
1139
    /**
1140
     * Retrieves the number of elements that should be expanded.
1141
     *
1142
     * plugin.tx_solr.search.variants.limit
1143
     *
1144
     * @param int $defaultIfEmpty
1145
     * @return int
1146
     */
1147 2
    public function getSearchVariantsLimit($defaultIfEmpty = 10)
1148
    {
1149 2
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.variants.limit', $defaultIfEmpty);
1150 2
        return (int)$result;
1151
    }
1152
1153
    /**
1154
     * Indicates if frequent searches should be show or not.
1155
     *
1156
     * plugin.tx_solr.search.frequentSearches
1157
     *
1158
     * @param bool $defaultIfEmpty
1159
     * @return bool
1160
     */
1161 24
    public function getSearchFrequentSearches($defaultIfEmpty = false)
1162
    {
1163 24
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.frequentSearches', $defaultIfEmpty);
1164 24
        return $this->getBool($result);
1165
    }
1166
1167
    /**
1168
     * Returns the sub configuration of the frequentSearches
1169
     *
1170
     * plugin.tx_solr.search.frequentSearches.
1171
     *
1172
     * @param array $defaultIfEmpty
1173
     * @return array
1174
     */
1175 28
    public function getSearchFrequentSearchesConfiguration($defaultIfEmpty = [])
1176
    {
1177 28
        $result = $this->getObjectByPathOrDefault('plugin.tx_solr.search.frequentSearches.', $defaultIfEmpty);
1178 28
        return $result;
1179
    }
1180
1181
    /**
1182
     * Retrieves the minimum font size that should be used for the frequentSearches.
1183
     *
1184
     * plugin.tx_solr.search.frequentSearches.minSize
1185
     *
1186
     * @param int $defaultIfEmpty
1187
     * @return int
1188
     */
1189 28
    public function getSearchFrequentSearchesMinSize($defaultIfEmpty = 14)
1190
    {
1191 28
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.frequentSearches.minSize', $defaultIfEmpty);
1192 28
        return (int)$result;
1193
    }
1194
1195
    /**
1196
     * Retrieves the maximum font size that should be used for the frequentSearches.
1197
     *
1198
     * plugin.tx_solr.search.frequentSearches.minSize
1199
     *
1200
     * @param int $defaultIfEmpty
1201
     * @return int
1202
     */
1203 28
    public function getSearchFrequentSearchesMaxSize($defaultIfEmpty = 32)
1204
    {
1205 28
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.frequentSearches.maxSize', $defaultIfEmpty);
1206 28
        return (int)$result;
1207
    }
1208
1209
    /**
1210
     * Indicates if frequent searches should be show or not.
1211
     *
1212
     * plugin.tx_solr.search.frequentSearches.useLowercaseKeywords
1213
     *
1214
     * @param bool $defaultIfEmpty
1215
     * @return bool
1216
     */
1217 26
    public function getSearchFrequentSearchesUseLowercaseKeywords($defaultIfEmpty = false)
1218
    {
1219 26
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.frequentSearches.useLowercaseKeywords', $defaultIfEmpty);
1220 26
        return $this->getBool($result);
1221
    }
1222
1223
    /**
1224
     * Returns the configuration if the search should be initialized with an empty query.
1225
     *
1226
     * plugin.tx_solr.search.initializeWithEmptyQuery
1227
     *
1228
     * @param bool $defaultIfEmpty
1229
     * @return bool
1230
     */
1231 32
    public function getSearchInitializeWithEmptyQuery($defaultIfEmpty = false)
1232
    {
1233 32
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.initializeWithEmptyQuery', $defaultIfEmpty);
1234 32
        return $this->getBool($result);
1235
    }
1236
1237
    /**
1238
     * Returns the configured initial query
1239
     *
1240
     * plugin.tx_solr.search.initializeWithQuery
1241
     *
1242
     * @param string $defaultIfEmpty
1243
     * @return string
1244
     */
1245 32
    public function getSearchInitializeWithQuery($defaultIfEmpty = '')
1246
    {
1247 32
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.initializeWithQuery', $defaultIfEmpty);
1248 32
        return (string)$result;
1249
    }
1250
1251
    /**
1252
     * Returns if the last searches should be displayed or not.
1253
     *
1254
     * plugin.tx_solr.search.lastSearches
1255
     *
1256
     * @param bool $defaultIfEmpty
1257
     * @return bool
1258
     */
1259 24
    public function getSearchLastSearches($defaultIfEmpty = false)
1260
    {
1261 24
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.lastSearches', $defaultIfEmpty);
1262 24
        return $this->getBool($result);
1263
    }
1264
1265
    /**
1266
     * Returns the lastSearch mode. "user" for user specific
1267
     *
1268
     * plugin.tx_solr.search.lastSearches.mode
1269
     *
1270
     * @param string $defaultIfEmpty
1271
     * @return string
1272
     */
1273 28
    public function getSearchLastSearchesMode($defaultIfEmpty = 'user')
1274
    {
1275 28
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.lastSearches.mode', $defaultIfEmpty);
1276 28
        return (string)$result;
1277
    }
1278
1279
    /**
1280
     * Returns the lastSearch limit
1281
     *
1282
     * plugin.tx_solr.search.lastSearches.limit
1283
     *
1284
     * @param int $defaultIfEmpty
1285
     * @return int
1286
     */
1287 28
    public function getSearchLastSearchesLimit($defaultIfEmpty = 10)
1288
    {
1289 28
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.lastSearches.limit', $defaultIfEmpty);
1290 28
        return (int)$result;
1291
    }
1292
1293
    /**
1294
     * Indicates if the results of an initial empty query should be shown or not.
1295
     *
1296
     * plugin.tx_solr.search.showResultsOfInitialEmptyQuery
1297
     *
1298
     * @param bool $defaultIfEmpty
1299
     * @return bool
1300
     */
1301 7
    public function getSearchShowResultsOfInitialEmptyQuery($defaultIfEmpty = false)
1302
    {
1303 7
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.showResultsOfInitialEmptyQuery', $defaultIfEmpty);
1304 7
        return $this->getBool($result);
1305
    }
1306
1307
    /**
1308
     * Indicates if the results of an initial search query should be shown.
1309
     *
1310
     * plugin.tx_solr.search.showResultsOfInitialQuery
1311
     *
1312
     * @param bool $defaultIfEmpty
1313
     * @return bool
1314
     */
1315 5
    public function getSearchShowResultsOfInitialQuery($defaultIfEmpty = false)
1316
    {
1317 5
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.showResultsOfInitialQuery', $defaultIfEmpty);
1318 5
        return $this->getBool($result);
1319
    }
1320
1321
    /**
1322
     * Indicates if sorting was enabled or not.
1323
     *
1324
     * plugin.tx_solr.search.sorting
1325
     *
1326
     * @param bool $defaultIfEmpty
1327
     * @return bool
1328
     */
1329 57
    public function getSearchSorting($defaultIfEmpty = false)
1330
    {
1331 57
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.sorting', $defaultIfEmpty);
1332 57
        return $this->getBool($result);
1333
    }
1334
1335
    /**
1336
     * Returns the sorting options configurations.
1337
     *
1338
     * plugin.tx_solr.search.sorting.options.
1339
     *
1340
     * @param array $defaultIfEmpty
1341
     * @return array
1342
     */
1343 28
    public function getSearchSortingOptionsConfiguration($defaultIfEmpty = [])
1344
    {
1345 28
        $result = $this->getObjectByPathOrDefault('plugin.tx_solr.search.sorting.options.', $defaultIfEmpty);
1346 28
        return $result;
1347
    }
1348
1349
    /**
1350
     * Retrieves the sorting default order for a sort option.
1351
     *
1352
     * plugin.tx_solr.search.sorting.options.<sortOptionName>.defaultOrder
1353
     *
1354
     * or
1355
     *
1356
     * plugin.tx_solr.search.sorting.defaultOrder
1357
     *
1358
     *
1359
     * @param string $sortOptionName
1360
     * @param string $defaultIfEmpty
1361
     * @return string
1362
     */
1363 31
    public function getSearchSortingDefaultOrderBySortOptionName($sortOptionName = '', $defaultIfEmpty = 'asc')
1364
    {
1365 31
        $sortOrderSpecificPath = 'plugin.tx_solr.search.sorting.options.' . $sortOptionName . '.defaultOrder';
1366 31
        $specificSortOrder = $this->getValueByPathOrDefaultValue($sortOrderSpecificPath, null);
1367
1368
        // if we have a concrete setting, use it
1369 31
        if ($specificSortOrder !== null) {
1370 2
            return strtolower($specificSortOrder);
1371
        }
1372
1373
        // no specific setting, check common setting
1374 29
        $commonPath = 'plugin.tx_solr.search.sorting.defaultOrder';
1375 29
        $commonATagParamOrDefaultValue = $this->getValueByPathOrDefaultValue($commonPath, $defaultIfEmpty);
1376 29
        return strtolower($commonATagParamOrDefaultValue);
1377
    }
1378
1379
    /**
1380
     * Returns the configured fixedOrder, if nothing configured defaultIfEmpty will be returned.
1381
     *
1382
     * plugin.tx_solr.search.sorting.options.<sortOptionName>.fixedOrder
1383
     *
1384
     * @param string $sortOptionName
1385
     * @param string $defaultIfEmpty
1386
     * @return string
1387
     */
1388
    public function getSearchSortingFixedOrderBySortOptionName($sortOptionName = '', $defaultIfEmpty = '')
1389
    {
1390
        $fixedOrder = 'plugin.tx_solr.search.sorting.options.' . $sortOptionName . '.fixedOrder';
1391
        return strtolower($this->getValueByPathOrDefaultValue($fixedOrder, $defaultIfEmpty));
1392
    }
1393
1394
    /**
1395
     * Returns the trusted fields configured for the search that do not need to be escaped.
1396
     *
1397
     * @param array $defaultIfEmpty
1398
     * @return array
1399
     */
1400 3
    public function getSearchTrustedFieldsArray($defaultIfEmpty = ['url'])
1401
    {
1402 3
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.trustedFields', '');
1403
1404 3
        if (trim($result) === '') {
1405
            return $defaultIfEmpty;
1406
        }
1407
1408 3
        return GeneralUtility::trimExplode(',', $result);
1409
    }
1410
1411
    /**
1412
     * Indicates if the plugin arguments should be kept in the search form for a second submission.
1413
     *
1414
     * plugin.tx_solr.search.keepExistingParametersForNewSearches
1415
     *
1416
     * @param bool $defaultIfEmpty
1417
     * @return bool
1418
     */
1419
    public function getSearchKeepExistingParametersForNewSearches($defaultIfEmpty = false)
1420
    {
1421
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.keepExistingParametersForNewSearches', $defaultIfEmpty);
1422
        return $this->getBool($result);
1423
    }
1424
1425
    /**
1426
     * Returns if an empty query is allowed on the query level.
1427
     *
1428
     * plugin.tx_solr.search.query.allowEmptyQuery
1429
     *
1430
     * @param string $defaultIfEmpty
1431
     * @return bool
1432
     */
1433 27
    public function getSearchQueryAllowEmptyQuery($defaultIfEmpty = '')
1434
    {
1435 27
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.query.allowEmptyQuery', $defaultIfEmpty);
1436 27
        return $this->getBool($result);
1437
    }
1438
1439
    /**
1440
     * Returns the filter configuration array
1441
     *
1442
     * plugin.tx_solr.search.query.filter.
1443
     *
1444
     * @param array $defaultIfEmpty
1445
     * @return array
1446
     */
1447 39
    public function getSearchQueryFilterConfiguration(array $defaultIfEmpty = [])
1448
    {
1449 39
        $result = $this->getObjectByPathOrDefault('plugin.tx_solr.search.query.filter.', $defaultIfEmpty);
1450 39
        return $result;
1451
    }
1452
1453
    /**
1454
     * Can be used to overwrite the filterConfiguration.
1455
     *
1456
     * plugin.tx_solr.search.query.filter.
1457
     *
1458
     * @param array $configuration
1459
     */
1460 1
    public function setSearchQueryFilterConfiguration(array $configuration)
1461
    {
1462 1
        $this->configurationAccess->set('plugin.tx_solr.search.query.filter.', $configuration);
1463 1
    }
1464
1465
    /**
1466
     * Removes the pageSections filter setting.
1467
     *
1468
     * @return void
1469
     */
1470 2
    public function removeSearchQueryFilterForPageSections()
1471
    {
1472 2
        $this->configurationAccess->reset('plugin.tx_solr.search.query.filter.__pageSections');
1473 2
    }
1474
1475
    /**
1476
     * Returns the configured queryFields from TypoScript
1477
     *
1478
     * plugin.tx_solr.search.query.queryFields
1479
     *
1480
     * @param string $defaultIfEmpty
1481
     * @return string
1482
     */
1483 121
    public function getSearchQueryQueryFields($defaultIfEmpty = '')
1484
    {
1485 121
        return $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.query.queryFields', $defaultIfEmpty);
1486
    }
1487
1488
    /**
1489
     * Returns the configured returnFields as array.
1490
     *
1491
     * plugin.tx_solr.search.query.returnFields
1492
     *
1493
     * @param array $defaultIfEmpty
1494
     * @return array
1495
     */
1496 123
    public function getSearchQueryReturnFieldsAsArray($defaultIfEmpty = [])
1497
    {
1498 123
        $returnFields = $this->getValueByPath('plugin.tx_solr.search.query.returnFields');
1499 123
        if (is_null($returnFields)) {
1500 88
            return $defaultIfEmpty;
1501
        }
1502
1503 35
        return GeneralUtility::trimExplode(',', $returnFields);
1504
    }
1505
1506
    /**
1507
     * Returns the configured target page for the search.
1508
     * By default the contextPageId will be used
1509
     *
1510
     * plugin.tx_solr.search.targetPage
1511
     *
1512
     * @return int
1513
     */
1514 127
    public function getSearchTargetPage()
1515
    {
1516 127
        $targetPage = (int)$this->getValueByPathOrDefaultValue('plugin.tx_solr.search.targetPage', 0);
1517 127
        if ($targetPage === 0) {
1518
            // when no specific page was configured we use the contextPageId (which is usual $GLOBALS['TSFE']->id)
1519 126
            $targetPage = $this->contextPageId;
1520
        }
1521
1522 127
        return $targetPage;
1523
    }
1524
1525
    /**
1526
     * Retrieves the targetPage configuration.
1527
     *
1528
     * plugin.tx_solr.search.targetPage.
1529
     *
1530
     * @param array $defaultIfEmpty
1531
     * @return array
1532
     */
1533
    public function getSearchTargetPageConfiguration(array $defaultIfEmpty = [])
1534
    {
1535
        $result = $this->getObjectByPathOrDefault('plugin.tx_solr.search.targetPage.', $defaultIfEmpty);
1536
        return $result;
1537
    }
1538
1539
    /**
1540
     * Method to check if the site highlighting is enabled. When the siteHighlighting is enabled the
1541
     * sword_list parameter is added to the results link.
1542
     *
1543
     * plugin.tx_solr.searcb.results.siteHighlighting
1544
     *
1545
     * @param bool $defaultIfEmpty
1546
     * @return bool
1547
     */
1548 21
    public function getSearchResultsSiteHighlighting($defaultIfEmpty = true)
1549
    {
1550 21
        $isSiteHightlightingEnabled = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.results.siteHighlighting', $defaultIfEmpty);
1551 21
        return $this->getBool($isSiteHightlightingEnabled);
1552
    }
1553
1554
1555
    /**
1556
     * Can be used to check if the highlighting is enabled
1557
     *
1558
     * plugin.tx_solr.search.results.resultsHighlighting
1559
     *
1560
     * @param boolean $defaultIfEmpty
1561
     * @return string
1562
     */
1563 121
    public function getSearchResultsHighlighting($defaultIfEmpty = false)
1564
    {
1565 121
        $isHighlightingEnabled = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.results.resultsHighlighting', $defaultIfEmpty);
1566 121
        return $this->getBool($isHighlightingEnabled);
1567
    }
1568
1569
    /**
1570
     * Returns the result highlighting fields.
1571
     *
1572
     * plugin.tx_solr.search.results.resultsHighlighting.highlightFields
1573
     *
1574
     * @param string $defaultIfEmpty
1575
     * @return string
1576
     */
1577 36
    public function getSearchResultsHighlightingFields($defaultIfEmpty = '')
1578
    {
1579 36
        return $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.results.resultsHighlighting.highlightFields', $defaultIfEmpty);
1580
    }
1581
1582
    /**
1583
     * Returns the result highlighting fields as array.
1584
     *
1585
     * plugin.tx_solr.search.results.resultsHighlighting.highlightFields
1586
     *
1587
     * @param array $defaultIfEmpty
1588
     * @return array
1589
     */
1590
    public function getSearchResultsHighlightingFieldsAsArray($defaultIfEmpty = [])
1591
    {
1592
        $highlightingFields = $this->getSearchResultsHighlightingFields('');
1593
1594
        if ($highlightingFields === '') {
1595
            return $defaultIfEmpty;
1596
        }
1597
1598
        return GeneralUtility::trimExplode(',', $highlightingFields, true);
1599
    }
1600
1601
    /**
1602
     * Returns the fragmentSize for highlighted segments.
1603
     *
1604
     * plugin.tx_solr.search.results.resultsHighlighting.fragmentSize
1605
     *
1606
     * @param int $defaultIfEmpty
1607
     * @return int
1608
     */
1609 36
    public function getSearchResultsHighlightingFragmentSize($defaultIfEmpty = 200)
1610
    {
1611 36
        return (int)$this->getValueByPathOrDefaultValue('plugin.tx_solr.search.results.resultsHighlighting.fragmentSize', $defaultIfEmpty);
1612
    }
1613
1614
    /**
1615
     * Returns the fragmentSeparator for highlighted segments.
1616
     *
1617
     * plugin.tx_solr.search.results.resultsHighlighting.fragmentSeparator
1618
     *
1619
     * @param string $defaultIfEmpty
1620
     * @return string
1621
     */
1622 21
    public function getSearchResultsHighlightingFragmentSeparator($defaultIfEmpty = '[...]')
1623
    {
1624 21
        return $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.results.resultsHighlighting.fragmentSeparator', $defaultIfEmpty);
1625
    }
1626
1627
    /**
1628
     * Returns the number of results that should be shown per page.
1629
     *
1630
     * plugin.tx_solr.search.results.resultsPerPage
1631
     *
1632
     * @param int $defaultIfEmpty
1633
     * @return int
1634
     */
1635 30
    public function getSearchResultsPerPage($defaultIfEmpty = 10)
1636
    {
1637 30
        return (int)$this->getValueByPathOrDefaultValue('plugin.tx_solr.search.results.resultsPerPage', $defaultIfEmpty);
1638
    }
1639
1640
    /**
1641
     * Returns the available options for the per page switch.
1642
     *
1643
     * plugin.tx_solr.search.results.resultsPerPageSwitchOptions
1644
     *
1645
     * @param array $defaultIfEmpty
1646
     * @return array
1647
     */
1648 30
    public function getSearchResultsPerPageSwitchOptionsAsArray($defaultIfEmpty = [])
1649
    {
1650 30
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.results.resultsPerPageSwitchOptions', '');
1651
1652 30
        if (trim($result) === '') {
1653
            return $defaultIfEmpty;
1654
        }
1655
1656 30
        return GeneralUtility::intExplode(',', $result, true);
1657
    }
1658
1659
    /**
1660
     * Returns the configured wrap for the resultHighlighting.
1661
     *
1662
     * plugin.tx_solr.search.results.resultsHighlighting.wrap
1663
     *
1664
     * @param string $defaultIfEmpty
1665
     * @return string
1666
     */
1667 36
    public function getSearchResultsHighlightingWrap($defaultIfEmpty = '')
1668
    {
1669 36
        return $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.results.resultsHighlighting.wrap', $defaultIfEmpty);
1670
    }
1671
1672
    /**
1673
     * Indicates if spellchecking is enabled or not.
1674
     *
1675
     * plugin.tx_solr.search.spellchecking
1676
     *
1677
     * @param bool $defaultIfEmpty
1678
     * @return bool
1679
     */
1680
    public function getSearchSpellchecking($defaultIfEmpty = false)
1681
    {
1682
        $isFacetingEnabled = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.spellchecking', $defaultIfEmpty);
1683
        return $this->getBool($isFacetingEnabled);
1684
    }
1685
1686
    /**
1687
     * Returns the wrap that should be used for spellchecking
1688
     *
1689
     * plugin.tx_solr.search.spellchecking.wrap
1690
     *
1691
     * @param string $defaultIfEmpty
1692
     * @return string
1693
     */
1694
    public function getSearchSpellcheckingWrap($defaultIfEmpty = '')
1695
    {
1696
        return (string)$this->getValueByPathOrDefaultValue('plugin.tx_solr.search.spellchecking.wrap', $defaultIfEmpty);
1697
    }
1698
1699
    /**
1700
     * Returns the numberOfSuggestionsToTry that should be used for the spellchecking.
1701
     *
1702
     * plugin.tx_solr.search.spellchecking.numberOfSuggestionsToTry
1703
     *
1704
     * @param int $defaultIfEmpty
1705
     * @return int
1706
     */
1707 28
    public function getSearchSpellcheckingNumberOfSuggestionsToTry($defaultIfEmpty = 0)
1708
    {
1709 28
        return (int)$this->getValueByPathOrDefaultValue('plugin.tx_solr.search.spellchecking.numberOfSuggestionsToTry', $defaultIfEmpty);
1710
    }
1711
1712
    /**
1713
     * Indicates if a second search should be fired from the spellchecking suggestion if no results could be found.
1714
     *
1715
     * plugin.tx_solr.search.spellchecking.searchUsingSpellCheckerSuggestion
1716
     *
1717
     * @param bool $defaultIfEmpty
1718
     * @return bool
1719
     */
1720
    public function getSearchSpellcheckingSearchUsingSpellCheckerSuggestion($defaultIfEmpty = false)
1721
    {
1722
        $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.spellchecking.searchUsingSpellCheckerSuggestion', $defaultIfEmpty);
1723
        return $this->getBool($result);
1724
    }
1725
1726
    /**
1727
     * Indicates if faceting is enabled or not.
1728
     *
1729
     * plugin.tx_solr.search.faceting
1730
     *
1731
     * @param bool $defaultIfEmpty
1732
     * @return bool
1733
     */
1734 121
    public function getSearchFaceting($defaultIfEmpty = false)
1735
    {
1736 121
        $isFacetingEnabled = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.faceting', $defaultIfEmpty);
1737 121
        return $this->getBool($isFacetingEnabled);
1738
    }
1739
1740
    /**
1741
     * Retrieves the facetLinkATagParams for a facet by facet name. If nothing specific is configured
1742
     * the global facetLinkATagParams with be returned.
1743
     *
1744
     * plugin.tx_solr.search.faceting.facets.<facetName>.facetLinkATagParams
1745
     *
1746
     * or
1747
     *
1748
     * plugin.tx_solr.search.faceting.facetLinkATagParams
1749
     *
1750
     *
1751
     * @param string $facetName
1752
     * @param string $defaultIfEmpty
1753
     * @return string
1754
     */
1755 1
    public function getSearchFacetingFacetLinkATagParamsByName($facetName = '', $defaultIfEmpty = '')
1756
    {
1757 1
        $facetSpecificPath = 'plugin.tx_solr.search.faceting.facets.' . $facetName . '.facetLinkATagParams';
1758 1
        $specificATagParam = $this->getValueByPathOrDefaultValue($facetSpecificPath, null);
1759
1760
            // if we have a concrete setting, use it
1761 1
        if ($specificATagParam !== null) {
1762 1
            return $specificATagParam;
1763
        }
1764
1765
            // no specific setting, check common setting
1766 1
        $commonPath = 'plugin.tx_solr.search.faceting.facetLinkATagParams';
1767 1
        $commonATagParamOrDefaultValue = $this->getValueByPathOrDefaultValue($commonPath, $defaultIfEmpty);
1768 1
        return $commonATagParamOrDefaultValue;
1769
    }
1770
1771
    /**
1772
     * Returns the test that should be used to remove a faceting link
1773
     *
1774
     * plugin.tx_solr.search.faceting.removeFacetLinkText
1775
     *
1776
     * @param string $defaultIfEmpty
1777
     * @return string
1778
     */
1779
    public function getSearchFacetingRemoveFacetLinkText($defaultIfEmpty = '@facetLabel: @facetText')
1780
    {
1781
        return (string)$this->getValueByPathOrDefaultValue('plugin.tx_solr.search.faceting.removeFacetLinkText', $defaultIfEmpty);
1782
    }
1783
1784
    /**
1785
     * Retrieves the showEvenWhenEmpty for a facet by facet name. If nothing specific is configured
1786
     * the global showEmptyFacets with be returned.
1787
     *
1788
     * plugin.tx_solr.search.faceting.facets.<facetName>.showEvenWhenEmpty
1789
     *
1790
     * or
1791
     *
1792
     * plugin.tx_solr.search.faceting.showEmptyFacets
1793
     *
1794
     *
1795
     * @param string $facetName
1796
     * @param bool $defaultIfEmpty
1797
     * @return bool
1798
     */
1799 59
    public function getSearchFacetingShowEmptyFacetsByName($facetName = '', $defaultIfEmpty = false)
1800
    {
1801 59
        $facetSpecificPath = 'plugin.tx_solr.search.faceting.facets.' . $facetName . '.showEvenWhenEmpty';
1802 59
        $specificShowWhenEmpty = $this->getValueByPathOrDefaultValue($facetSpecificPath, null);
1803
1804
        // if we have a concrete setting, use it
1805 59
        if ($specificShowWhenEmpty !== null) {
1806 2
            return $specificShowWhenEmpty;
1807
        }
1808
1809
        // no specific setting, check common setting
1810 59
        $commonPath = 'plugin.tx_solr.search.faceting.showEmptyFacets';
1811 59
        $commonIfEmptyOrDefaultValue = $this->getValueByPathOrDefaultValue($commonPath, $defaultIfEmpty);
1812 59
        return $commonIfEmptyOrDefaultValue;
1813
    }
1814
1815
    /**
1816
     * Returns the wrap for the faceting show all link
1817
     *
1818
     * plugin.tx_solr.search.faceting.showAllLink.wrap
1819
     *
1820
     * @param string $defaultIfEmpty
1821
     * @return string
1822
     */
1823
    public function getSearchFacetingShowAllLinkWrap($defaultIfEmpty = '')
1824
    {
1825
        return (string)$this->getValueByPathOrDefaultValue('plugin.tx_solr.search.faceting.showAllLink.wrap', $defaultIfEmpty);
1826
    }
1827
1828
    /**
1829
     * Returns the link url parameters that should be added to a facet.
1830
     *
1831
     * plugin.tx_solr.search.faceting.facetLinkUrlParameters
1832
     *
1833
     * @param string $defaultIfEmpty
1834
     * @return string
1835
     */
1836 23
    public function getSearchFacetingFacetLinkUrlParameters($defaultIfEmpty = '')
1837
    {
1838 23
        $linkUrlParameters = trim($this->getValueByPathOrDefaultValue('plugin.tx_solr.search.faceting.facetLinkUrlParameters', $defaultIfEmpty));
1839
1840 23
        return $linkUrlParameters;
1841
    }
1842
1843
    /**
1844
     * Returns if the facetLinkUrlsParameters should be included in the reset link.
1845
     *
1846
     * plugin.tx_solr.search.faceting.facetLinkUrlParameters.useForFacetResetLinkUrl
1847
     *
1848
     * @param bool $defaultIfEmpty
1849
     * @return bool
1850
     */
1851 2
    public function getSearchFacetingFacetLinkUrlParametersUseForFacetResetLinkUrl($defaultIfEmpty = true)
1852
    {
1853 2
        $useForFacetResetLinkUrl = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.faceting.facetLinkUrlParameters.useForFacetResetLinkUrl', $defaultIfEmpty);
1854 2
        return $this->getBool($useForFacetResetLinkUrl);
1855
    }
1856
1857
    /**
1858
     * Returns the link url parameters that should be added to a facet as array.
1859
     *
1860
     * plugin.tx_solr.search.faceting.facetLinkUrlParameters
1861
     *
1862
     * @param array $defaultIfEmpty
1863
     * @return array
1864
     */
1865 23
    public function getSearchFacetingFacetLinkUrlParametersAsArray($defaultIfEmpty = [])
1866
    {
1867 23
        $linkUrlParameters = $this->getSearchFacetingFacetLinkUrlParameters();
1868 23
        if ($linkUrlParameters === '') {
1869
            return $defaultIfEmpty;
1870
        }
1871
1872 23
        return GeneralUtility::explodeUrl2Array($linkUrlParameters);
1873
    }
1874
1875
    /**
1876
     * Return the configured minimumCount value for facets.
1877
     *
1878
     * plugin.tx_solr.search.faceting.minimumCount
1879
     *
1880
     * @param int $defaultIfEmpty
1881
     * @return int
1882
     */
1883 36
    public function getSearchFacetingMinimumCount($defaultIfEmpty = 1)
1884
    {
1885 36
        return (int)$this->getValueByPathOrDefaultValue('plugin.tx_solr.search.faceting.minimumCount', $defaultIfEmpty);
1886
    }
1887
1888
    /**
1889
     * Return the configured limit value for facets, used for displaying.
1890
     *
1891
     * plugin.tx_solr.search.faceting.limit
1892
     *
1893
     * @param int $defaultIfEmpty
1894
     * @return int
1895
     */
1896
    public function getSearchFacetingLimit($defaultIfEmpty = 10)
1897
    {
1898
        return (int)$this->getValueByPathOrDefaultValue('plugin.tx_solr.search.faceting.limit', $defaultIfEmpty);
1899
    }
1900
1901
    /**
1902
     * Return the configured limit value for facets, used for the response.
1903
     *
1904
     * plugin.tx_solr.search.faceting.facetLimit
1905
     *
1906
     * @param int $defaultIfEmpty
1907
     * @return int
1908
     */
1909 36
    public function getSearchFacetingFacetLimit($defaultIfEmpty = 100)
1910
    {
1911 36
        return (int)$this->getValueByPathOrDefaultValue('plugin.tx_solr.search.faceting.facetLimit', $defaultIfEmpty);
1912
    }
1913
1914
    /**
1915
     * Returns if the singleFacetMode is active or not.
1916
     *
1917
     * plugin.tx_solr.search.faceting.singleFacetMode
1918
     *
1919
     * @param bool $defaultIfEmpty
1920
     * @return bool
1921
     */
1922
    public function getSearchFacetingSingleFacetMode($defaultIfEmpty = false)
1923
    {
1924
        $singleFacetMode = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.faceting.singleFacetMode', $defaultIfEmpty);
1925
        return $this->getBool($singleFacetMode);
1926
    }
1927
1928
    /**
1929
     * Return the configured faceting sortBy value.
1930
     *
1931
     * plugin.tx_solr.search.faceting.sortBy
1932
     *
1933
     * @param string $defaultIfEmpty
1934
     * @return string
1935
     */
1936 36
    public function getSearchFacetingSortBy($defaultIfEmpty = '')
1937
    {
1938 36
        return $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.faceting.sortBy', $defaultIfEmpty);
1939
    }
1940
1941
    /**
1942
     * Returns if a facets should be kept on selection. Global faceting setting
1943
     * can also be configured on facet level by using
1944
     * (plugin.tx_solr.search.faceting.facets.<fieldName>.keepAllOptionsOnSelection)
1945
     *
1946
     * plugin.tx_solr.search.faceting.keepAllFacetsOnSelection
1947
     *
1948
     * @param bool $defaultIfEmpty
1949
     * @return bool
1950
     */
1951 33
    public function getSearchFacetingKeepAllFacetsOnSelection($defaultIfEmpty = false)
1952
    {
1953 33
        $keepAllOptionsOnSelection = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.faceting.keepAllFacetsOnSelection', $defaultIfEmpty);
1954 33
        return $this->getBool($keepAllOptionsOnSelection);
1955
    }
1956
1957
    /**
1958
     * Returns the configured faceting configuration.
1959
     *
1960
     * plugin.tx_solr.search.faceting.facets
1961
     *
1962
     * @param array $defaultIfEmpty
1963
     * @return array
1964
     */
1965 60
    public function getSearchFacetingFacets(array $defaultIfEmpty = [])
1966
    {
1967 60
        return $this->getObjectByPathOrDefault('plugin.tx_solr.search.faceting.facets.', $defaultIfEmpty);
1968
    }
1969
1970
    /**
1971
     * Returns the configuration of a single facet by facet name.
1972
     *
1973
     * plugin.tx_solr.search.faceting.facets.<facetName>
1974
     *
1975
     * @param string $facetName
1976
     * @param array $defaultIfEmpty
1977
     * @return array
1978
     */
1979 33
    public function getSearchFacetingFacetByName($facetName, $defaultIfEmpty = [])
1980
    {
1981 33
        return $this->getObjectByPathOrDefault('plugin.tx_solr.search.faceting.facets.' . $facetName . '.', $defaultIfEmpty);
1982
    }
1983
1984
    /**
1985
     * Indicates if statistics is enabled or not.
1986
     *
1987
     * plugin.tx_solr.statistics
1988
     *
1989
     * @param bool $defaultIfEmpty
1990
     * @return bool
1991
     */
1992 31
    public function getStatistics($defaultIfEmpty = false)
1993
    {
1994 31
        $isStatisticsEnabled = $this->getValueByPathOrDefaultValue('plugin.tx_solr.statistics', $defaultIfEmpty);
1995 31
        return $this->getBool($isStatisticsEnabled);
1996
    }
1997
1998
    /**
1999
     * Indicates to which length an ip should be anonymized in the statistics
2000
     *
2001
     * plugin.tx_solr.statistics.anonymizeIP
2002
     *
2003
     * @param int $defaultIfEmpty
2004
     * @return int
2005
     */
2006 22
    public function getStatisticsAnonymizeIP($defaultIfEmpty = 0)
2007
    {
2008 22
        $anonymizeToLength = $this->getValueByPathOrDefaultValue('plugin.tx_solr.statistics.anonymizeIP', $defaultIfEmpty);
2009 22
        return (int)$anonymizeToLength;
2010
    }
2011
2012
    /**
2013
     * Indicates if additional debug Data should be added to the statistics
2014
     *
2015
     * plugin.tx_solr.statistics.addDebugData
2016
     *
2017
     * @param bool $defaultIfEmpty
2018
     * @return bool
2019
     */
2020 27
    public function getStatisticsAddDebugData($defaultIfEmpty = false)
2021
    {
2022 27
        $statisticsAddDebugDataEnabled = $this->getValueByPathOrDefaultValue('plugin.tx_solr.statistics.addDebugData', $defaultIfEmpty);
2023 27
        return $this->getBool($statisticsAddDebugDataEnabled);
2024
    }
2025
2026
    /**
2027
     * Indicates if suggestion is enabled or not.
2028
     *
2029
     * plugin.tx_solr.suggest
2030
     *
2031
     * @param bool $defaultIfEmpty
2032
     * @return bool
2033
     */
2034
    public function getSuggest($defaultIfEmpty = false)
2035
    {
2036
        $isSuggestionEnabled = $this->getValueByPathOrDefaultValue('plugin.tx_solr.suggest', $defaultIfEmpty);
2037
        return $this->getBool($isSuggestionEnabled);
2038
    }
2039
2040
    /**
2041
     * Indicates if https should be used for the suggest form.
2042
     *
2043
     * plugin.tx_solr.suggest.forceHttps
2044
     *
2045
     * @param bool $defaultIfEmpty
2046
     * @return bool
2047
     */
2048
    public function getSuggestForceHttps($defaultIfEmpty = false)
2049
    {
2050
        $isHttpsForced = $this->getValueByPathOrDefaultValue('plugin.tx_solr.suggest.forceHttps', $defaultIfEmpty);
2051
        return $this->getBool($isHttpsForced);
2052
    }
2053
2054
    /**
2055
     * Returns the configured template for a specific template fileKey.
2056
     *
2057
     * plugin.tx_solr.search.templateFiles.<fileKey>
2058
     *
2059
     * @param string $fileKey
2060
     * @param string $defaultIfEmpty
2061
     * @return string
2062
     */
2063 33
    public function getTemplateByFileKey($fileKey, $defaultIfEmpty = '')
2064
    {
2065 33
        $templateFileName = $this->getValueByPathOrDefaultValue('plugin.tx_solr.templateFiles.' . $fileKey, $defaultIfEmpty);
2066 33
        return (string)$templateFileName;
2067
    }
2068
2069
    /**
2070
     * Returns the configuration of the crop view helper.
2071
     *
2072
     * plugin.tx_solr.viewHelpers.crop.
2073
     *
2074
     * @param array $defaultIfEmpty
2075
     * @return array
2076
     */
2077
    public function getViewHelpersCropConfiguration(array $defaultIfEmpty = [])
2078
    {
2079
        $cropViewHelperConfiguration = $this->getObjectByPathOrDefault('plugin.tx_solr.viewHelpers.crop.', $defaultIfEmpty);
2080
        return $cropViewHelperConfiguration;
2081
    }
2082
2083
    /**
2084
     * Returns the configuration of the sorting view helper.
2085
     *
2086
     * plugin.tx_solr.viewHelpers.sortIndicator.
2087
     *
2088
     * @param array $defaultIfEmpty
2089
     * @return array
2090
     */
2091
    public function getViewHelpersSortIndicatorConfiguration(array $defaultIfEmpty = [])
2092
    {
2093
        $sortingViewHelperConfiguration = $this->getObjectByPathOrDefault('plugin.tx_solr.viewHelpers.sortIndicator.', $defaultIfEmpty);
2094
        return $sortingViewHelperConfiguration;
2095
    }
2096
2097
    /**
2098
     * Controls whether ext-solr will send commits to solr.
2099
     * Beware: If you disable this, you need to ensure
2100
     * that some other mechanism will commit your changes
2101
     * otherwise they will never be searchable.
2102
     * A good way to achieve this is enabling the solr
2103
     * daemons autoCommit feature.
2104
     *
2105
     * plugin.tx_solr.index.enableCommits
2106
     *
2107
     * @param bool $defaultIfEmpty
2108
     * @return bool
2109
     */
2110 16
    public function getEnableCommits($defaultIfEmpty = true)
2111
    {
2112 16
        $enableCommits = $this->getValueByPathOrDefaultValue('plugin.tx_solr.index.enableCommits', $defaultIfEmpty);
2113 16
        return $this->getBool($enableCommits);
2114
    }
2115
2116
    /**
2117
     * Returns the url namespace that is used for the arguments.
2118
     *
2119
     * plugin.tx_solr.view.pluginNamespace
2120
     *
2121
     * @param string $defaultIfEmpty
2122
     * @return string
2123
     */
2124 35
    public function getSearchPluginNamespace($defaultIfEmpty = 'tx_solr')
2125
    {
2126 35
        return $this->getValueByPathOrDefaultValue('plugin.tx_solr.view.pluginNamespace', $defaultIfEmpty);
2127
    }
2128
2129
    /**
2130
     * Returns true if the global url parameter q, that indicates the query should be used.
2131
     *
2132
     * Should be set to false, when multiple instance on the same page should have their querystring.
2133
     *
2134
     * plugin.tx_solr.search.ignoreGlobalQParameter
2135
     *
2136
     * @param bool $defaultIfEmpty
2137
     * @return bool
2138
     */
2139 22
    public function getSearchIgnoreGlobalQParameter($defaultIfEmpty = false)
2140
    {
2141 22
        $enableQParameter = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.ignoreGlobalQParameter', $defaultIfEmpty);
2142 22
        return $this->getBool($enableQParameter);
2143
2144
    }
2145
2146
    /**
2147
     * Method to check if grouping was enabled with typoscript.
2148
     *
2149
     * plugin.tx_solr.search.grouping
2150
     *
2151
     * @param bool $defaultIfEmpty
2152
     * @return bool
2153
     */
2154 123
    public function getSearchGrouping($defaultIfEmpty = false)
2155
    {
2156 123
        $groupingEnabled = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.grouping', $defaultIfEmpty);
2157 123
        return $this->getBool($groupingEnabled);
2158
    }
2159
2160
    /**
2161
     * Returns the configured numberOfGroups.
2162
     *
2163
     * plugin.tx_solr.search.grouping.numberOfGroups
2164
     *
2165
     * @param int $defaultIfEmpty
2166
     * @return int
2167
     */
2168
    public function getSearchGroupingNumberOfGroups($defaultIfEmpty = 5)
2169
    {
2170
        return (int)$this->getValueByPathOrDefaultValue('plugin.tx_solr.search.grouping.numberOfGroups', $defaultIfEmpty);
2171
    }
2172
2173
    /**
2174
     * Returns the highestValue of the numberOfResultsPerGroup configuration that is globally configured and
2175
     * for each group.
2176
     *
2177
     * plugin.tx_solr.search.grouping.
2178
     *
2179
     * @param int $defaultIfEmpty
2180
     * @return int
2181
     */
2182 2
    public function getSearchGroupingHighestGroupResultsLimit($defaultIfEmpty = 1)
2183
    {
2184 2
        $groupingConfiguration = $this->getObjectByPathOrDefault('plugin.tx_solr.search.grouping.', []);
2185 2
        $highestLimit = $defaultIfEmpty;
2186 2
        if (!empty($groupingConfiguration['numberOfResultsPerGroup'])) {
2187 2
            $highestLimit = $groupingConfiguration['numberOfResultsPerGroup'];
2188
        }
2189
2190 2
        $configuredGroups = $groupingConfiguration['groups.'];
2191 2
        if (!is_array($configuredGroups)) {
2192
            return $highestLimit;
2193
        }
2194
2195 2
        foreach ($configuredGroups as $groupName => $groupConfiguration) {
2196 2
            if (!empty($groupConfiguration['numberOfResultsPerGroup']) && $groupConfiguration['numberOfResultsPerGroup'] > $highestLimit) {
2197 2
                $highestLimit = $groupConfiguration['numberOfResultsPerGroup'];
2198
            }
2199
        }
2200
2201 2
        return $highestLimit;
2202
    }
2203
2204
    /**
2205
     * Returns everything that is configured for the groups (plugin.tx_solr.search.grouping.groups.)
2206
     *
2207
     * plugin.tx_solr.search.grouping.groups.
2208
     *
2209
     * @param array $defaultIfEmpty
2210
     * @return array
2211
     */
2212
    public function getSearchGroupingGroupsConfiguration($defaultIfEmpty = [])
2213
    {
2214
        return $this->getObjectByPathOrDefault('plugin.tx_solr.search.grouping.groups.', $defaultIfEmpty);
2215
    }
2216
2217
    /*
2218
     * Applies the stdWrap if it is configured for the path, otherwise the unprocessed value will be returned.
2219
     *
2220
     * @param string $valuePath
2221
     * @param mixed $value
2222
     * @return mixed
2223
     */
2224 7
    protected function renderContentElementOfConfigured($valuePath, $value)
2225
    {
2226 7
        $configurationPath = $valuePath . '.';
2227 7
        $configuration = $this->getObjectByPath($configurationPath);
2228
2229 7
        if ($configuration == null) {
2230 5
            return $value;
2231
        }
2232
2233 2
        return $this->contentObjectService->renderSingleContentObject($value, $configuration);
2234
    }
2235
}
2236