<?php
namespace WapplerSystems\Meilisearch\System\Configuration;
/*
* This file is part of the TYPO3 CMS project.
*
* It is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, either version 2
* of the License, or any later version.
*
* For the full copyright and license information, please read the
* LICENSE.txt file that was distributed with this source code.
*
* The TYPO3 project - inspiring people to share!
*/
use WapplerSystems\Meilisearch\IndexQueue\Indexer;
use WapplerSystems\Meilisearch\IndexQueue\Initializer\Record;
use WapplerSystems\Meilisearch\System\ContentObject\ContentObjectService;
use WapplerSystems\Meilisearch\System\Util\ArrayAccessor;
use InvalidArgumentException;
use TYPO3\CMS\Core\Utility\ArrayUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;
/**
* TypoScript configuration object, used to read all TypoScript configuration.
*
* The TypoScriptConfiguration was introduced in order to be able to replace the old,
* array based configuration with one configuration object.
*
* To read the configuration, you should use
*
* $configuration->getValueByPath
*
* or
*
* $configuration->isValidPath
*
* to check if an configuration path exists.
*
* To ensure Backwards compatibility the TypoScriptConfiguration object implements the
* ArrayAccess interface (offsetGet,offsetExists,offsetUnset and offsetSet)
*
* This was only introduced to be backwards compatible in logTerm only "getValueByPath", "isValidPath" or
* speaking methods for configuration settings should be used!
*
* @author Marc Bastian Heinrichs <mbh@mbh-software.de>
* @author Timo Schmidt <timo.schmidt@dkd.de>
* @copyright (c) 2016 Timo Schmidt <timo.schmidt@dkd.de>
*/
class TypoScriptConfiguration
{
/**
* @var \WapplerSystems\Meilisearch\System\Util\ArrayAccessor|null
*/
protected $configurationAccess = null;
/**
* Holds the pageId in which context the configuration was parsed
* (normally $GLOBALS['TSFE']->id)
*/
protected $contextPageId = 0;
/**
* @var ContentObjectService
*/
protected $contentObjectService = null;
/**
* @param array $configuration
* @param int $contextPageId
* @param ContentObjectService $contentObjectService
*/
public function __construct(array $configuration, $contextPageId = 0, ContentObjectService $contentObjectService = null)
{
$this->configurationAccess = new ArrayAccessor($configuration, '.', true);
$this->contextPageId = $contextPageId;
$this->contentObjectService = $contentObjectService;
}
/**
* Checks if a value is 1, '1', 'true'
* @param mixed $value
* @return bool
*/
protected function getBool($value)
{
return filter_var($value, FILTER_VALIDATE_BOOLEAN);
}
/**
* This method can be used to only retrieve array keys where the value is not an array.
*
* This can be very handy in the configuration when only keys should ne taken into account
* where the value is not a subconfiguration (typically an typoscript object path).
*
* @param $inputArray
* @return array
*/
protected function getOnlyArrayKeysWhereValueIsNotAnArray($inputArray)
{
$keysWithNonArrayValue = [];
foreach ($inputArray as $key => $value) {
if (is_array($value)) {
// configuration for a content object, skipping
continue;
}
$keysWithNonArrayValue[] = $key;
}
return $keysWithNonArrayValue;
}
/**
* Gets the value from a given TypoScript path.
*
* In the context of an frontend content element the path plugin.tx_meilisearch is
* merged recursive with overrule with the content element specific typoscript
* settings, like plugin.tx_meilisearch_PiResults_Results, and possible flex form settings
* (depends on the solr plugin).
*
* Example: plugin.tx_meilisearch.search.targetPage
* returns $GLOBALS['TSFE']->tmpl->setup['plugin.']['tx_meilisearch.']['search.']['targetPage']
*
* @param string $path TypoScript path
* @return mixed The TypoScript object defined by the given path
* @throws InvalidArgumentException
*/
public function getValueByPath($path)
{
if (!is_string($path)) {
throw new InvalidArgumentException('Parameter $path is not a string',
1325623321);
}
return $this->configurationAccess->get($path);
}
/**
* This method can be used to get a configuration value by path if it exists or return a
* default value when it does not exist.
*
* @param string $path
* @param mixed $defaultValue
* @return mixed
*/
public function getValueByPathOrDefaultValue($path, $defaultValue)
{
$value = $this->getValueByPath($path);
if (is_null($value)) {
return $defaultValue;
}
return $value;
}
/**
* Gets the parent TypoScript Object from a given TypoScript path.
*
* In the context of an frontend content element the path plugin.tx_meilisearch is
* merged recursive with overrule with the content element specific typoscript
* settings, like plugin.tx_meilisearch_PiResults_Results, and possible flex form settings
* (depends on the solr plugin).
*
* Example: plugin.tx_meilisearch.index.queue.tt_news.fields.content
* returns $GLOBALS['TSFE']->tmpl->setup['plugin.']['tx_meilisearch.']['index.']['queue.']['tt_news.']['fields.']['content.']
* which is a SOLR_CONTENT cObj.
*
* @param string $path TypoScript path
* @return array The TypoScript object defined by the given path
* @throws InvalidArgumentException
*/
public function getObjectByPath($path)
{
if (substr($path, -1) !== '.') {
$path = rtrim($path, '.');
$path = substr($path, 0, strrpos($path, '.') + 1);
}
if (!is_string($path)) {
throw new InvalidArgumentException('Parameter $path is not a string', 1325627243);
}
return $this->configurationAccess->get($path);
}
/**
* Gets the parent TypoScript Object from a given TypoScript path and if not present return
* the default value
*
* @see getObjectByPath
* @param string $path
* @param array $defaultValue
* @return array
*/
public function getObjectByPathOrDefault($path, array $defaultValue)
{
try {
$object = $this->getObjectByPath($path);
} catch (\InvalidArgumentException $e) {
return $defaultValue;
}
if (!is_array($object)) {
return $defaultValue;
}
return $object;
}
/**
* Checks whether a given TypoScript path is valid.
*
* @param string $path TypoScript path
* @return bool TRUE if the path resolves, FALSE otherwise
*/
public function isValidPath($path)
{
$isValidPath = false;
$pathValue = $this->getValueByPath($path);
if (!is_null($pathValue)) {
$isValidPath = true;
}
return $isValidPath;
}
/**
* Merges a configuration with another configuration a
*
* @param array $configurationToMerge
* @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.
* @param bool $includeEmptyValues If set, values from $overrule will overrule if they are empty or zero.
* @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.
* @return TypoScriptConfiguration
*/
public function mergeSolrConfiguration(array $configurationToMerge, $addKeys = true, $includeEmptyValues = true, $enableUnsetFeature = true)
{
$data = $this->configurationAccess->getData();
ArrayUtility::mergeRecursiveWithOverrule(
$data['plugin.']['tx_meilisearch.'],
$configurationToMerge,
$addKeys,
$includeEmptyValues,
$enableUnsetFeature
);
$this->configurationAccess->setData($data);
return $this;
}
/**
* Returns true when ext_solr is enabled
*
* @param boolean $defaultIfEmpty
* @return boolean
*/
public function getEnabled($defaultIfEmpty = false)
{
$path = 'plugin.tx_meilisearch.enabled';
$result = $this->getValueByPathOrDefaultValue($path, $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Returns the configured additionalFields configured for the indexing.
*
* plugin.tx_meilisearch.index.additionalFields.
*
* @param array $defaultIfEmpty
* @return array
*/
public function getIndexAdditionalFieldsConfiguration($defaultIfEmpty = [])
{
$result = $this->getObjectByPathOrDefault('plugin.tx_meilisearch.index.additionalFields.', $defaultIfEmpty);
return $result;
}
/**
* Returns all solr fields names where a mapping is configured in index.additionalFields
*
* Returns all keys from
* plugin.tx_meilisearch.index.additionalFields.
*
* @param array $defaultIfEmpty
* @return array
*/
public function getIndexMappedAdditionalFieldNames($defaultIfEmpty = [])
{
$mappingConfiguration = $this->getIndexAdditionalFieldsConfiguration();
$mappedFieldNames = $this->getOnlyArrayKeysWhereValueIsNotAnArray($mappingConfiguration);
return count($mappedFieldNames) == 0 ? $defaultIfEmpty : $mappedFieldNames;
}
/**
* Returns the fieldProcessingInstructions configuration array
*
* plugin.tx_meilisearch.index.fieldProcessingInstructions.
*
* @param array $defaultIfEmpty
* @return array
*/
public function getIndexFieldProcessingInstructionsConfiguration(array $defaultIfEmpty = [])
{
$result = $this->getObjectByPathOrDefault('plugin.tx_meilisearch.index.fieldProcessingInstructions.', $defaultIfEmpty);
return $result;
}
/**
* Retrieves the indexing configuration array for an indexing queue by configuration name.
*
* plugin.tx_meilisearch.index.queue.<configurationName>.
*
* @param string $configurationName
* @param array $defaultIfEmpty
* @return array
*/
public function getIndexQueueConfigurationByName($configurationName, array $defaultIfEmpty = [])
{
$path = 'plugin.tx_meilisearch.index.queue.' . $configurationName . '.';
$result = $this->getObjectByPathOrDefault($path, $defaultIfEmpty);
return $result;
}
/**
* Returns an array of all additionalPageIds by index configuration name.
*
* plugin.tx_meilisearch.index.queue.pages.additionalPageIds
*
* @param string $configurationName
* @param array $defaultIfEmpty
* @return array
*/
public function getIndexQueueAdditionalPageIdsByConfigurationName($configurationName = 'pages', $defaultIfEmpty = [])
{
$path = 'plugin.tx_meilisearch.index.queue.' . $configurationName . '.additionalPageIds';
$result = $this->getValueByPathOrDefaultValue($path, '');
if (trim($result) === '') {
return $defaultIfEmpty;
}
return GeneralUtility::trimExplode(',', $result);
}
/**
* Returns an array of all allowedPageTypes.
*
* plugin.tx_meilisearch.index.queue.pages.allowedPageTypes
*
* @param string $configurationName The configuration name of the queue to use.
* @param array $defaultIfEmpty
* @return array
*/
public function getIndexQueueAllowedPageTypesArrayByConfigurationName($configurationName = 'pages', $defaultIfEmpty = [])
{
$path = 'plugin.tx_meilisearch.index.queue.' . $configurationName . '.allowedPageTypes';
$result = $this->getValueByPathOrDefaultValue($path, '');
if (trim($result) === '') {
return $defaultIfEmpty;
}
return GeneralUtility::trimExplode(',', $result);
}
/**
* Returns the configured excludeContentByClass patterns as array.
*
* plugin.tx_meilisearch.index.queue.pages.excludeContentByClass
*
* @param array $defaultIfEmpty
* @return array
*/
public function getIndexQueuePagesExcludeContentByClassArray($defaultIfEmpty = [])
{
$path = 'plugin.tx_meilisearch.index.queue.pages.excludeContentByClass';
$result = $this->getValueByPathOrDefaultValue($path, '');
if (trim($result) === '') {
return $defaultIfEmpty;
}
return GeneralUtility::trimExplode(',', $result);
}
/**
* Returns the configured database table for an indexing queue configuration or
* the configurationName itself that is used by convention as tableName when no
* other tablename is present.
*
* plugin.tx_meilisearch.index.queue.<configurationName>.table or configurationName
*
* @param string $configurationName
* @return string
*/
public function getIndexQueueTableNameOrFallbackToConfigurationName($configurationName = '')
{
$path = 'plugin.tx_meilisearch.index.queue.' . $configurationName . '.table';
$result = $this->getValueByPathOrDefaultValue($path, $configurationName);
return $result;
}
/**
* Returns the field configuration for a specific index queue.
*
* plugin.tx_meilisearch.index.queue.<configurationName>.fields.
*
* @param string $configurationName
* @param array $defaultIfEmpty
* @return array
*/
public function getIndexQueueFieldsConfigurationByConfigurationName($configurationName = '', $defaultIfEmpty = [])
{
$path = 'plugin.tx_meilisearch.index.queue.' . $configurationName . '.fields.';
$result = $this->getObjectByPathOrDefault($path, $defaultIfEmpty);
return $result;
}
/**
* Gets an array of tables configured for indexing by the Index Queue. Since the
* record monitor must watch these tables for manipulation.
*
* @return array Array of table names to be watched by the record monitor.
*/
public function getIndexQueueMonitoredTables()
{
$monitoredTables = [];
$indexingConfigurations = $this->getEnabledIndexQueueConfigurationNames();
foreach ($indexingConfigurations as $indexingConfigurationName) {
$monitoredTable = $this->getIndexQueueTableNameOrFallbackToConfigurationName($indexingConfigurationName);
$monitoredTables[] = $monitoredTable;
}
return array_values(array_unique($monitoredTables));
}
/**
* This method can be used to check if a table is configured to be monitored by the record monitor.
*
* @param string $tableName
* @return bool
*/
public function getIndexQueueIsMonitoredTable($tableName)
{
return in_array($tableName, $this->getIndexQueueMonitoredTables(), true);
}
/**
* Returns the configured indexer class that should be used for a certain indexingConfiguration.
* By default "WapplerSystems\Meilisearch\IndexQueue\Indexer" will be returned.
*
* plugin.tx_meilisearch.index.queue.<configurationName>.indexer
*
* @param string $configurationName
* @param string $defaultIfEmpty
* @return string
*/
public function getIndexQueueIndexerByConfigurationName($configurationName, $defaultIfEmpty = Indexer::class)
{
$path = 'plugin.tx_meilisearch.index.queue.' . $configurationName . '.indexer';
$result = $this->getValueByPathOrDefaultValue($path, $defaultIfEmpty);
return $result;
}
/**
* Returns the configuration of an indexer for a special indexingConfiguration. By default an empty
* array is returned.
*
* plugin.tx_meilisearch.index.queue.<configurationName>.indexer.
*
* @param string $configurationName
* @param array $defaultIfEmpty
* @return array
*/
public function getIndexQueueIndexerConfigurationByConfigurationName($configurationName, $defaultIfEmpty = [])
{
$path = 'plugin.tx_meilisearch.index.queue.' . $configurationName . '.indexer.';
$result = $this->getObjectByPathOrDefault($path, $defaultIfEmpty);
return $result;
}
/**
* Returns all solr fields names where a mapping configuration is set for a certain index configuration
*
* Returns all keys from
* plugin.tx_meilisearch.index.queue.<configurationName>.fields.
*
* @param string $configurationName
* @param array $defaultIfEmpty
* @return array
*/
public function getIndexQueueMappedFieldsByConfigurationName($configurationName = '', $defaultIfEmpty = [])
{
$mappingConfiguration = $this->getIndexQueueFieldsConfigurationByConfigurationName($configurationName);
$mappedFieldNames = $this->getOnlyArrayKeysWhereValueIsNotAnArray($mappingConfiguration);
return count($mappedFieldNames) == 0 ? $defaultIfEmpty : $mappedFieldNames;
}
/**
* This method is used to check if an index queue configuration is enabled or not
*
* plugin.tx_meilisearch.index.queue.<configurationName> = 1
*
* @param string $configurationName
* @param bool $defaultIfEmpty
* @return bool
*/
public function getIndexQueueConfigurationIsEnabled($configurationName, $defaultIfEmpty = false)
{
$path = 'plugin.tx_meilisearch.index.queue.' . $configurationName;
$result = $this->getValueByPathOrDefaultValue($path, $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Retrieves an array of enabled index queue configurations.
*
* plugin.tx_meilisearch.index.queue.<configurationName>
*
* @param array $defaultIfEmpty
* @return array
*/
public function getEnabledIndexQueueConfigurationNames($defaultIfEmpty = [])
{
$tablesToIndex = [];
$path = 'plugin.tx_meilisearch.index.queue.';
$indexQueueConfiguration = $this->getObjectByPathOrDefault($path, []);
foreach ($indexQueueConfiguration as $configurationName => $indexingEnabled) {
if (substr($configurationName, -1) != '.' && $indexingEnabled) {
$tablesToIndex[] = $configurationName;
}
}
return count($tablesToIndex) == 0 ? $defaultIfEmpty : $tablesToIndex;
}
/**
* Retrieves an array of additional fields that will trigger an recursive update of pages
* when some of the fields on that page are modified.
*
* plugin.tx_meilisearch.index.queue.recursiveUpdateFields
*
* @param string $configurationName
* @param array $defaultIfEmpty
* @return array
*/
public function getIndexQueueConfigurationRecursiveUpdateFields($configurationName, $defaultIfEmpty = [])
{
$path = 'plugin.tx_meilisearch.index.queue.' . $configurationName . '.recursiveUpdateFields';
$recursiveUpdateFieldsString = $this->getValueByPathOrDefaultValue($path, '');
if (trim($recursiveUpdateFieldsString) === '') {
return $defaultIfEmpty;
}
$recursiveUpdateFields = GeneralUtility::trimExplode(',', $recursiveUpdateFieldsString);
// For easier check later on we return an array by combining $recursiveUpdateFields
return array_combine($recursiveUpdateFields, $recursiveUpdateFields);
}
/**
* Retrieves and initialPagesAdditionalWhereClause where clause when configured or an empty string.
*
* plugin.tx_meilisearch.index.queue.<configurationName>.initialPagesAdditionalWhereClause
*
* @param string $configurationName
* @return string
*/
public function getInitialPagesAdditionalWhereClause($configurationName)
{
$path = 'plugin.tx_meilisearch.index.queue.' . $configurationName . '.initialPagesAdditionalWhereClause';
$initialPagesAdditionalWhereClause = $this->getValueByPathOrDefaultValue($path, '');
if (trim($initialPagesAdditionalWhereClause) === '') {
return '';
}
return trim($initialPagesAdditionalWhereClause);
}
/**
* Retrieves and additional where clause when configured or an empty string.
*
* plugin.tx_meilisearch.index.queue.<configurationName>.additionalWhereClause
*
* @param string $configurationName
* @return string
*/
public function getIndexQueueAdditionalWhereClauseByConfigurationName($configurationName)
{
$path = 'plugin.tx_meilisearch.index.queue.' . $configurationName . '.additionalWhereClause';
$additionalWhere = $this->getValueByPathOrDefaultValue($path, '');
if (trim($additionalWhere) === '') {
return '';
}
return ' AND ' . $additionalWhere;
}
/**
* This method can be used to retrieve all index queue configuration names, where
* a certain table is used. It can be configured with the property "table" or is using the configuration
* key a fallback for the table name.
*
* plugin.tx_meilisearch.index.queue.<configurationName>.
*
* @param string $tableName
* @param array $defaultIfEmpty
* @return array
*/
public function getIndexQueueConfigurationNamesByTableName($tableName, $defaultIfEmpty = [])
{
$path = 'plugin.tx_meilisearch.index.queue.';
$configuration = $this->getObjectByPathOrDefault($path, []);
$possibleConfigurations = [];
foreach ($configuration as $configurationName => $indexingEnabled) {
$isObject = substr($configurationName, -1) === '.';
if ($isObject || !$indexingEnabled) {
continue;
}
// when the configuration name equals the tableName we have a fallback
$hasTableNameAsConfigurationName = $configurationName == $tableName;
$hasTableAssignedInQueueConfiguration = isset($configuration[$configurationName . '.']['table']) &&
$configuration[$configurationName . '.']['table'] == $tableName;
if ($hasTableNameAsConfigurationName || $hasTableAssignedInQueueConfiguration) {
$possibleConfigurations[] = $configurationName;
}
}
return count($possibleConfigurations) > 0 ? $possibleConfigurations : $defaultIfEmpty;
}
/**
* This method is used to retrieve the className of a queue initializer for a certain indexing configuration
* of returns the default initializer class, when noting is configured.
*
* plugin.tx_meilisearch.index.queue.<configurationName>.initialization
*
* @param string $configurationName
* @param string $defaultIfEmpty
* @return string
*/
public function getIndexQueueInitializerClassByConfigurationName($configurationName, $defaultIfEmpty = Record::class)
{
$path = 'plugin.tx_meilisearch.index.queue.' . $configurationName . '.initialization';
$className = $this->getValueByPathOrDefaultValue($path, $defaultIfEmpty);
return $className;
}
/**
* Returns the _LOCAL_LANG configuration from the TypoScript.
*
* plugin.tx_meilisearch._LOCAL_LANG.
*
* @param array $defaultIfEmpty
* @return array
*/
public function getLocalLangConfiguration(array $defaultIfEmpty = [])
{
$result = $this->getObjectByPathOrDefault('plugin.tx_meilisearch._LOCAL_LANG.', $defaultIfEmpty);
return $result;
}
/**
* When this is enabled the output of the devlog, will be printed as debug output.
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getLoggingDebugOutput($defaultIfEmpty = false)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.logging.debugOutput', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Returns if query filters should be written to the log.
*
* plugin.tx_meilisearch.logging.query.filters
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getLoggingQueryFilters($defaultIfEmpty = false)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.logging.query.filters', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Returns if the querystring should be logged or not.
*
* plugin.tx_meilisearch.logging.query.queryString
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getLoggingQueryQueryString($defaultIfEmpty = false)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.logging.query.queryString', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Returns if the searchWords should be logged or not.
*
* plugin.tx_meilisearch.logging.query.searchWords
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getLoggingQuerySearchWords($defaultIfEmpty = false)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.logging.query.searchWords', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Returns if the rawGet requests should be logged or not.
*
* plugin.tx_meilisearch.logging.query.rawGet
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getLoggingQueryRawGet($defaultIfEmpty = false)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.logging.query.rawGet', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Returns if the rawPost requests should be logged or not.
*
* plugin.tx_meilisearch.logging.query.rawPost
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getLoggingQueryRawPost($defaultIfEmpty = false)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.logging.query.rawPost', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Returns if the rawDelete requests should be logged or not.
*
* plugin.tx_meilisearch.logging.query.rawDelete
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getLoggingQueryRawDelete($defaultIfEmpty = false)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.logging.query.rawDelete', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Returns if exceptions should be logged or not.
*
* plugin.tx_meilisearch.logging.exceptions
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getLoggingExceptions($defaultIfEmpty = true)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.logging.exceptions', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Returns if indexing operations should be logged or not.
*
* plugin.tx_meilisearch.logging.indexing
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getLoggingIndexing($defaultIfEmpty = false)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.logging.indexing', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Returns if indexing queue operations should be logged or not.
*
* plugin.tx_meilisearch.logging.indexing.queue
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getLoggingIndexingQueue($defaultIfEmpty = false)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.logging.indexing.queue', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* This method can be used to check if the logging during indexing should be done.
* It takes the specific configuration by indexQueueConfiguration into account or is using the
* fallback when the logging is enabled on queue or indexing level.
*
* plugin.tx_meilisearch.logging.indexing.queue.<indexQueueConfiguration>
*
* @param string $indexQueueConfiguration
* @param bool $defaultIfEmpty
* @return bool
*/
public function getLoggingIndexingQueueOperationsByConfigurationNameWithFallBack($indexQueueConfiguration, $defaultIfEmpty = false)
{
// when logging is globally enabled we do not need to check the specific configuration
if ($this->getLoggingIndexing()) {
return true;
}
// when the logging for indexing is enabled on queue level we also do not need to check the specific configuration
if ($this->getLoggingIndexingQueue()) {
return true;
}
$path = 'plugin.tx_meilisearch.logging.indexing.queue.' . $indexQueueConfiguration;
$result = $this->getValueByPathOrDefaultValue($path, $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Returns if a log message should be written when a page was indexed.
*
* plugin.tx_meilisearch.logging.indexing.pageIndexed
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getLoggingIndexingPageIndexed($defaultIfEmpty = false)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.logging.indexing.pageIndexed', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Returns if a log message should be written when the TYPO3 search markers are missing in the page.
*
* plugin.tx_meilisearch.logging.indexing.missingTypo3SearchMarkers
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getLoggingIndexingMissingTypo3SearchMarkers($defaultIfEmpty = true)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.logging.indexing.missingTypo3SearchMarkers', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Returns if the initialization of an indexqueue should be logged.
*
* plugin.tx_meilisearch.logging.indexing.indexQueueInitialization
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getLoggingIndexingIndexQueueInitialization($defaultIfEmpty = false)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.logging.indexing.indexQueueInitialization', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Indicates if the debug mode is enabled or not.
*
* plugin.tx_meilisearch.enableDebugMode
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getEnabledDebugMode($defaultIfEmpty = false)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.enableDebugMode', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* @param $path
* @param $fallbackPath
* @param $defaultIfBothIsEmpty
* @return mixed
*/
public function getValueByPathWithFallbackOrDefaultValueAndApplyStdWrap($path, $fallbackPath, $defaultIfBothIsEmpty)
{
$result = (string)$this->getValueByPathOrDefaultValue($path, '');
if($result !== '') {
return $this->renderContentElementOfConfigured($path, $result);
}
$result = (string)$this->getValueByPathOrDefaultValue($fallbackPath, $defaultIfBothIsEmpty);
return $this->renderContentElementOfConfigured($fallbackPath, $result);
}
/**
* Retrieves the complete search configuration
*
* plugin.tx_meilisearch.search.
*
* @param array $defaultIfEmpty
* @return array
*/
public function getSearchConfiguration(array $defaultIfEmpty = [])
{
$result = $this->getObjectByPathOrDefault('plugin.tx_meilisearch.search.', $defaultIfEmpty);
return $result;
}
/**
* Indicates if elevation should be used or not
*
* plugin.tx_meilisearch.search.elevation
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getSearchElevation($defaultIfEmpty = false)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.elevation', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Indicates if elevated results should be marked
*
* plugin.tx_meilisearch.search.elevation.markElevatedResults
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getSearchElevationMarkElevatedResults($defaultIfEmpty = true)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.elevation.markElevatedResults', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Indicates if elevation should be forced
*
*plugin.tx_meilisearch.search.elevation.forceElevation
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getSearchElevationForceElevation($defaultIfEmpty = true)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.elevation.forceElevation', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Indicates if collapsing on a certain field should be used to build variants or not.
*
* plugin.tx_meilisearch.search.variants
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getSearchVariants($defaultIfEmpty = false)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.variants', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Indicates if collapsing on a certain field should be used or not
*
* plugin.tx_meilisearch.search.variants.variantField
*
* @param string $defaultIfEmpty
* @return string
*/
public function getSearchVariantsField($defaultIfEmpty = 'variantId')
{
return $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.variants.variantField', $defaultIfEmpty);
}
/**
* Indicates if expanding of collapsed items it activated.
*
* plugin.tx_meilisearch.search.variants.expand
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getSearchVariantsExpand($defaultIfEmpty = false)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.variants.expand', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Retrieves the number of elements that should be expanded.
*
* plugin.tx_meilisearch.search.variants.limit
*
* @param int $defaultIfEmpty
* @return int
*/
public function getSearchVariantsLimit($defaultIfEmpty = 10)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.variants.limit', $defaultIfEmpty);
return (int)$result;
}
/**
* Indicates if frequent searches should be show or not.
*
* plugin.tx_meilisearch.search.frequentSearches
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getSearchFrequentSearches($defaultIfEmpty = false)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.frequentSearches', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Returns the sub configuration of the frequentSearches
*
* plugin.tx_meilisearch.search.frequentSearches.
*
* @param array $defaultIfEmpty
* @return array
*/
public function getSearchFrequentSearchesConfiguration($defaultIfEmpty = [])
{
$result = $this->getObjectByPathOrDefault('plugin.tx_meilisearch.search.frequentSearches.', $defaultIfEmpty);
return $result;
}
/**
* Retrieves the minimum font size that should be used for the frequentSearches.
*
* plugin.tx_meilisearch.search.frequentSearches.minSize
*
* @param int $defaultIfEmpty
* @return int
*/
public function getSearchFrequentSearchesMinSize($defaultIfEmpty = 14): int
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.frequentSearches.minSize', $defaultIfEmpty);
return (int)$result;
}
/**
* Retrieves the maximum font size that should be used for the frequentSearches.
*
* plugin.tx_meilisearch.search.frequentSearches.minSize
*
* @param int $defaultIfEmpty
* @return int
*/
public function getSearchFrequentSearchesMaxSize($defaultIfEmpty = 32): int
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.frequentSearches.maxSize', $defaultIfEmpty);
return (int)$result;
}
/**
* Indicates if frequent searches should be show or not.
*
* plugin.tx_meilisearch.search.frequentSearches.useLowercaseKeywords
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getSearchFrequentSearchesUseLowercaseKeywords($defaultIfEmpty = false)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.frequentSearches.useLowercaseKeywords', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Returns the configuration if the search should be initialized with an empty query.
*
* plugin.tx_meilisearch.search.initializeWithEmptyQuery
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getSearchInitializeWithEmptyQuery($defaultIfEmpty = false)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.initializeWithEmptyQuery', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Returns the configured initial query
*
* plugin.tx_meilisearch.search.initializeWithQuery
*
* @param string $defaultIfEmpty
* @return string
*/
public function getSearchInitializeWithQuery($defaultIfEmpty = '')
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.initializeWithQuery', $defaultIfEmpty);
return (string)$result;
}
/**
* Returns if the last searches should be displayed or not.
*
* plugin.tx_meilisearch.search.lastSearches
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getSearchLastSearches($defaultIfEmpty = false)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.lastSearches', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Returns the lastSearch mode. "user" for user specific
*
* plugin.tx_meilisearch.search.lastSearches.mode
*
* @param string $defaultIfEmpty
* @return string
*/
public function getSearchLastSearchesMode($defaultIfEmpty = 'user')
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.lastSearches.mode', $defaultIfEmpty);
return (string)$result;
}
/**
* Returns the lastSearch limit
*
* plugin.tx_meilisearch.search.lastSearches.limit
*
* @param int $defaultIfEmpty
* @return int
*/
public function getSearchLastSearchesLimit($defaultIfEmpty = 10)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.lastSearches.limit', $defaultIfEmpty);
return (int)$result;
}
/**
* Indicates if the results of an initial empty query should be shown or not.
*
* plugin.tx_meilisearch.search.showResultsOfInitialEmptyQuery
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getSearchShowResultsOfInitialEmptyQuery($defaultIfEmpty = false)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.showResultsOfInitialEmptyQuery', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Indicates if the results of an initial search query should be shown.
*
* plugin.tx_meilisearch.search.showResultsOfInitialQuery
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getSearchShowResultsOfInitialQuery($defaultIfEmpty = false)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.showResultsOfInitialQuery', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Indicates if sorting was enabled or not.
*
* plugin.tx_meilisearch.search.sorting
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getSearchSorting($defaultIfEmpty = false)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.sorting', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Returns the sorting options configurations.
*
* plugin.tx_meilisearch.search.sorting.options.
*
* @param array $defaultIfEmpty
* @return array
*/
public function getSearchSortingOptionsConfiguration($defaultIfEmpty = [])
{
$result = $this->getObjectByPathOrDefault('plugin.tx_meilisearch.search.sorting.options.', $defaultIfEmpty);
return $result;
}
/**
* Retrieves the sorting default order for a sort option.
*
* plugin.tx_meilisearch.search.sorting.options.<sortOptionName>.defaultOrder
*
* or
*
* plugin.tx_meilisearch.search.sorting.defaultOrder
*
*
* @param string $sortOptionName
* @param string $defaultIfEmpty
* @return string
*/
public function getSearchSortingDefaultOrderBySortOptionName($sortOptionName = '', $defaultIfEmpty = 'asc')
{
$sortOrderSpecificPath = 'plugin.tx_meilisearch.search.sorting.options.' . $sortOptionName . '.defaultOrder';
$specificSortOrder = $this->getValueByPathOrDefaultValue($sortOrderSpecificPath, null);
// if we have a concrete setting, use it
if ($specificSortOrder !== null) {
return mb_strtolower($specificSortOrder);
}
// no specific setting, check common setting
$commonPath = 'plugin.tx_meilisearch.search.sorting.defaultOrder';
$commonATagParamOrDefaultValue = $this->getValueByPathOrDefaultValue($commonPath, $defaultIfEmpty);
return mb_strtolower($commonATagParamOrDefaultValue);
}
/**
* Returns the trusted fields configured for the search that do not need to be escaped.
*
* @param array $defaultIfEmpty
* @return array
*/
public function getSearchTrustedFieldsArray($defaultIfEmpty = ['url'])
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.trustedFields', '');
if (trim($result) === '') {
return $defaultIfEmpty;
}
return GeneralUtility::trimExplode(',', $result);
}
/**
* Indicates if the plugin arguments should be kept in the search form for a second submission.
*
* plugin.tx_meilisearch.search.keepExistingParametersForNewSearches
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getSearchKeepExistingParametersForNewSearches($defaultIfEmpty = false)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.keepExistingParametersForNewSearches', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Returns if an empty query is allowed on the query level.
*
* plugin.tx_meilisearch.search.query.allowEmptyQuery
*
* @param string $defaultIfEmpty
* @return bool
*/
public function getSearchQueryAllowEmptyQuery($defaultIfEmpty = '')
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.query.allowEmptyQuery', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Returns the filter configuration array
*
* plugin.tx_meilisearch.search.query.filter.
*
* @param array $defaultIfEmpty
* @return array
*/
public function getSearchQueryFilterConfiguration(array $defaultIfEmpty = [])
{
$result = $this->getObjectByPathOrDefault('plugin.tx_meilisearch.search.query.filter.', $defaultIfEmpty);
return $result;
}
/**
* Can be used to overwrite the filterConfiguration.
*
* plugin.tx_meilisearch.search.query.filter.
*
* @param array $configuration
*/
public function setSearchQueryFilterConfiguration(array $configuration)
{
$this->configurationAccess->set('plugin.tx_meilisearch.search.query.filter.', $configuration);
}
/**
* Removes the pageSections filter setting.
*
* @return void
*/
public function removeSearchQueryFilterForPageSections()
{
$this->configurationAccess->reset('plugin.tx_meilisearch.search.query.filter.__pageSections');
}
/**
* Returns the configured queryFields from TypoScript
*
* plugin.tx_meilisearch.search.query.queryFields
*
* @param string $defaultIfEmpty
* @return string
*/
public function getSearchQueryQueryFields($defaultIfEmpty = '')
{
return $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.query.queryFields', $defaultIfEmpty);
}
/**
* This method is used to check if a phrase search is enabled or not
*
* plugin.tx_meilisearch.search.query.phrase = 1
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getPhraseSearchIsEnabled(bool $defaultIfEmpty = false)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.query.phrase', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Returns the configured phrase fields from TypoScript
*
* plugin.tx_meilisearch.search.query.phrase.fields
*
* @param string $defaultIfEmpty
* @return string
*/
public function getSearchQueryPhraseFields(string $defaultIfEmpty = '')
{
return $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.query.phrase.fields', $defaultIfEmpty);
}
/**
* This method is used to check if a bigram phrase search is enabled or not
*
* plugin.tx_meilisearch.search.query.bigramPhrase = 1
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getBigramPhraseSearchIsEnabled(bool $defaultIfEmpty = false)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.query.bigramPhrase', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Returns the configured phrase fields from TypoScript
*
* plugin.tx_meilisearch.search.query.bigramPhrase.fields
*
* @param string $defaultIfEmpty
* @return string
*/
public function getSearchQueryBigramPhraseFields(string $defaultIfEmpty = '')
{
return $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.query.bigramPhrase.fields', $defaultIfEmpty);
}
/**
* This method is used to check if a trigram phrase search is enabled or not
*
* plugin.tx_meilisearch.search.query.trigramPhrase = 1
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getTrigramPhraseSearchIsEnabled(bool $defaultIfEmpty = false)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.query.trigramPhrase', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Returns the configured trigram phrase fields from TypoScript
*
* plugin.tx_meilisearch.search.query.trigramPhrase.fields
*
* @param string $defaultIfEmpty
* @return string
*/
public function getSearchQueryTrigramPhraseFields(string $defaultIfEmpty = '')
{
return $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.query.trigramPhrase.fields', $defaultIfEmpty);
}
/**
* Returns the configured returnFields as array.
*
* plugin.tx_meilisearch.search.query.returnFields
*
* @param array $defaultIfEmpty
* @return array
*/
public function getSearchQueryReturnFieldsAsArray($defaultIfEmpty = [])
{
$returnFields = $this->getValueByPath('plugin.tx_meilisearch.search.query.returnFields');
if (is_null($returnFields)) {
return $defaultIfEmpty;
}
return GeneralUtility::trimExplode(',', $returnFields);
}
/**
* Returns the configured target page for the search.
* By default the contextPageId will be used
*
* plugin.tx_meilisearch.search.targetPage
*
* @return int
*/
public function getSearchTargetPage()
{
$targetPage = (int)$this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.targetPage', 0);
if ($targetPage === 0) {
// when no specific page was configured we use the contextPageId (which is usual $GLOBALS['TSFE']->id)
$targetPage = $this->contextPageId;
}
return $targetPage;
}
/**
* Retrieves the targetPage configuration.
*
* plugin.tx_meilisearch.search.targetPage.
*
* @param array $defaultIfEmpty
* @return array
*/
public function getSearchTargetPageConfiguration(array $defaultIfEmpty = [])
{
$result = $this->getObjectByPathOrDefault('plugin.tx_meilisearch.search.targetPage.', $defaultIfEmpty);
return $result;
}
/**
* Method to check if the site highlighting is enabled. When the siteHighlighting is enabled the
* sword_list parameter is added to the results link.
*
* plugin.tx_meilisearch.searcb.results.siteHighlighting
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getSearchResultsSiteHighlighting($defaultIfEmpty = true)
{
$isSiteHightlightingEnabled = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.results.siteHighlighting', $defaultIfEmpty);
return $this->getBool($isSiteHightlightingEnabled);
}
/**
* Can be used to check if the highlighting is enabled
*
* plugin.tx_meilisearch.search.results.resultsHighlighting
*
* @param boolean $defaultIfEmpty
* @return boolean
*/
public function getSearchResultsHighlighting($defaultIfEmpty = false)
{
$isHighlightingEnabled = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.results.resultsHighlighting', $defaultIfEmpty);
return $this->getBool($isHighlightingEnabled);
}
/**
* Returns the result highlighting fields.
*
* plugin.tx_meilisearch.search.results.resultsHighlighting.highlightFields
*
* @param string $defaultIfEmpty
* @return string
*/
public function getSearchResultsHighlightingFields($defaultIfEmpty = '')
{
return $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.results.resultsHighlighting.highlightFields', $defaultIfEmpty);
}
/**
* Returns the result highlighting fields as array.
*
* plugin.tx_meilisearch.search.results.resultsHighlighting.highlightFields
*
* @param array $defaultIfEmpty
* @return array
*/
public function getSearchResultsHighlightingFieldsAsArray($defaultIfEmpty = [])
{
$highlightingFields = $this->getSearchResultsHighlightingFields('');
if ($highlightingFields === '') {
return $defaultIfEmpty;
}
return GeneralUtility::trimExplode(',', $highlightingFields, true);
}
/**
* Returns the fragmentSize for highlighted segments.
*
* plugin.tx_meilisearch.search.results.resultsHighlighting.fragmentSize
*
* @param int $defaultIfEmpty
* @return int
*/
public function getSearchResultsHighlightingFragmentSize($defaultIfEmpty = 200)
{
return (int)$this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.results.resultsHighlighting.fragmentSize', $defaultIfEmpty);
}
/**
* Returns the fragmentSeparator for highlighted segments.
*
* plugin.tx_meilisearch.search.results.resultsHighlighting.fragmentSeparator
*
* @param string $defaultIfEmpty
* @return string
*/
public function getSearchResultsHighlightingFragmentSeparator($defaultIfEmpty = '[...]')
{
return $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.results.resultsHighlighting.fragmentSeparator', $defaultIfEmpty);
}
/**
* Returns the number of results that should be shown per page.
*
* plugin.tx_meilisearch.search.results.resultsPerPage
*
* @param int $defaultIfEmpty
* @return int
*/
public function getSearchResultsPerPage($defaultIfEmpty = 10)
{
return (int)$this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.results.resultsPerPage', $defaultIfEmpty);
}
/**
* Returns the available options for the per page switch.
*
* plugin.tx_meilisearch.search.results.resultsPerPageSwitchOptions
*
* @param array $defaultIfEmpty
* @return array
*/
public function getSearchResultsPerPageSwitchOptionsAsArray($defaultIfEmpty = [])
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.results.resultsPerPageSwitchOptions', '');
if (trim($result) === '') {
return $defaultIfEmpty;
}
return GeneralUtility::intExplode(',', $result, true);
}
/**
* Returns the configured wrap for the resultHighlighting.
*
* plugin.tx_meilisearch.search.results.resultsHighlighting.wrap
*
* @param string $defaultIfEmpty
* @return string
*/
public function getSearchResultsHighlightingWrap($defaultIfEmpty = '')
{
return $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.results.resultsHighlighting.wrap', $defaultIfEmpty);
}
/**
* Indicates if spellchecking is enabled or not.
*
* plugin.tx_meilisearch.search.spellchecking
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getSearchSpellchecking($defaultIfEmpty = false)
{
$isFacetingEnabled = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.spellchecking', $defaultIfEmpty);
return $this->getBool($isFacetingEnabled);
}
/**
* Returns the numberOfSuggestionsToTry that should be used for the spellchecking.
*
* plugin.tx_meilisearch.search.spellchecking.numberOfSuggestionsToTry
*
* @param int $defaultIfEmpty
* @return int
*/
public function getSearchSpellcheckingNumberOfSuggestionsToTry($defaultIfEmpty = 1)
{
return (int)$this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.spellchecking.numberOfSuggestionsToTry', $defaultIfEmpty);
}
/**
* Indicates if a second search should be fired from the spellchecking suggestion if no results could be found.
*
* plugin.tx_meilisearch.search.spellchecking.searchUsingSpellCheckerSuggestion
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getSearchSpellcheckingSearchUsingSpellCheckerSuggestion($defaultIfEmpty = false)
{
$result = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.spellchecking.searchUsingSpellCheckerSuggestion', $defaultIfEmpty);
return $this->getBool($result);
}
/**
* Indicates if faceting is enabled or not.
*
* plugin.tx_meilisearch.search.faceting
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getSearchFaceting($defaultIfEmpty = false)
{
$isFacetingEnabled = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.faceting', $defaultIfEmpty);
return $this->getBool($isFacetingEnabled);
}
/**
* Retrieves the showEvenWhenEmpty for a facet by facet name. If nothing specific is configured
* the global showEmptyFacets with be returned.
*
* plugin.tx_meilisearch.search.faceting.facets.<facetName>.showEvenWhenEmpty
*
* or
*
* plugin.tx_meilisearch.search.faceting.showEmptyFacets
*
*
* @param string $facetName
* @param bool $defaultIfEmpty
* @return bool
*/
public function getSearchFacetingShowEmptyFacetsByName($facetName = '', $defaultIfEmpty = false)
{
$facetSpecificPath = 'plugin.tx_meilisearch.search.faceting.facets.' . $facetName . '.showEvenWhenEmpty';
$specificShowWhenEmpty = $this->getValueByPathOrDefaultValue($facetSpecificPath, null);
// if we have a concrete setting, use it
if ($specificShowWhenEmpty !== null) {
return $specificShowWhenEmpty;
}
// no specific setting, check common setting
$commonPath = 'plugin.tx_meilisearch.search.faceting.showEmptyFacets';
$commonIfEmptyOrDefaultValue = $this->getValueByPathOrDefaultValue($commonPath, $defaultIfEmpty);
return $commonIfEmptyOrDefaultValue;
}
/**
* Returns the wrap for the faceting show all link
*
* plugin.tx_meilisearch.search.faceting.showAllLink.wrap
*
* @param string $defaultIfEmpty
* @return string
*/
public function getSearchFacetingShowAllLinkWrap($defaultIfEmpty = '')
{
return (string)$this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.faceting.showAllLink.wrap', $defaultIfEmpty);
}
/**
* Returns the link url parameters that should be added to a facet.
*
* plugin.tx_meilisearch.search.faceting.facetLinkUrlParameters
*
* @param string $defaultIfEmpty
* @return string
*/
public function getSearchFacetingFacetLinkUrlParameters($defaultIfEmpty = '')
{
$linkUrlParameters = trim($this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.faceting.facetLinkUrlParameters', $defaultIfEmpty));
return $linkUrlParameters;
}
/**
* Returns if the facetLinkUrlsParameters should be included in the reset link.
*
* plugin.tx_meilisearch.search.faceting.facetLinkUrlParameters.useForFacetResetLinkUrl
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getSearchFacetingFacetLinkUrlParametersUseForFacetResetLinkUrl($defaultIfEmpty = true)
{
$useForFacetResetLinkUrl = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.faceting.facetLinkUrlParameters.useForFacetResetLinkUrl', $defaultIfEmpty);
return $this->getBool($useForFacetResetLinkUrl);
}
/**
* Returns the link url parameters that should be added to a facet as array.
*
* plugin.tx_meilisearch.search.faceting.facetLinkUrlParameters
*
* @param array $defaultIfEmpty
* @return array
*/
public function getSearchFacetingFacetLinkUrlParametersAsArray($defaultIfEmpty = [])
{
$linkUrlParameters = $this->getSearchFacetingFacetLinkUrlParameters();
if ($linkUrlParameters === '') {
return $defaultIfEmpty;
}
return GeneralUtility::explodeUrl2Array($linkUrlParameters);
}
/**
* Return the configured minimumCount value for facets.
*
* plugin.tx_meilisearch.search.faceting.minimumCount
*
* @param int $defaultIfEmpty
* @return int
*/
public function getSearchFacetingMinimumCount($defaultIfEmpty = 1)
{
return (int)$this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.faceting.minimumCount', $defaultIfEmpty);
}
/**
* Return the configured limit value for facets, used for displaying.
*
* plugin.tx_meilisearch.search.faceting.limit
*
* @param int $defaultIfEmpty
* @return int
*/
public function getSearchFacetingLimit($defaultIfEmpty = 10)
{
return (int)$this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.faceting.limit', $defaultIfEmpty);
}
/**
* Return the configured limit value for facets, used for the response.
*
* plugin.tx_meilisearch.search.faceting.facetLimit
*
* @param int $defaultIfEmpty
* @return int
*/
public function getSearchFacetingFacetLimit($defaultIfEmpty = 100)
{
return (int)$this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.faceting.facetLimit', $defaultIfEmpty);
}
/**
* Return the configured faceting sortBy value.
*
* plugin.tx_meilisearch.search.faceting.sortBy
*
* @param string $defaultIfEmpty
* @return string
*/
public function getSearchFacetingSortBy($defaultIfEmpty = '')
{
return $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.faceting.sortBy', $defaultIfEmpty);
}
/**
* Returns if a facets should be kept on selection. Global faceting setting
* can also be configured on facet level by using
* (plugin.tx_meilisearch.search.faceting.facets.<fieldName>.keepAllOptionsOnSelection)
*
* plugin.tx_meilisearch.search.faceting.keepAllFacetsOnSelection
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getSearchFacetingKeepAllFacetsOnSelection($defaultIfEmpty = false)
{
$keepAllOptionsOnSelection = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.faceting.keepAllFacetsOnSelection', $defaultIfEmpty);
return $this->getBool($keepAllOptionsOnSelection);
}
/**
* Returns if the facet count should be calculated based on the facet selection when
* plugin.tx_meilisearch.search.faceting.keepAllFacetsOnSelection has been enabled
*
* plugin.tx_meilisearch.search.faceting.countAllFacetsForSelection
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getSearchFacetingCountAllFacetsForSelection($defaultIfEmpty = false)
{
$countAllFacetsForSelection = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.faceting.countAllFacetsForSelection', $defaultIfEmpty);
return $this->getBool($countAllFacetsForSelection);
}
/**
* Returns the configured faceting configuration.
*
* plugin.tx_meilisearch.search.faceting.facets
*
* @param array $defaultIfEmpty
* @return array
*/
public function getSearchFacetingFacets(array $defaultIfEmpty = [])
{
return $this->getObjectByPathOrDefault('plugin.tx_meilisearch.search.faceting.facets.', $defaultIfEmpty);
}
/**
* Returns the configuration of a single facet by facet name.
*
* plugin.tx_meilisearch.search.faceting.facets.<facetName>
*
* @param string $facetName
* @param array $defaultIfEmpty
* @return array
*/
public function getSearchFacetingFacetByName($facetName, $defaultIfEmpty = [])
{
return $this->getObjectByPathOrDefault('plugin.tx_meilisearch.search.faceting.facets.' . $facetName . '.', $defaultIfEmpty);
}
/**
* Indicates if statistics is enabled or not.
*
* plugin.tx_meilisearch.statistics
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getStatistics($defaultIfEmpty = false)
{
$isStatisticsEnabled = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.statistics', $defaultIfEmpty);
return $this->getBool($isStatisticsEnabled);
}
/**
* Indicates to which length an ip should be anonymized in the statistics
*
* plugin.tx_meilisearch.statistics.anonymizeIP
*
* @param int $defaultIfEmpty
* @return int
*/
public function getStatisticsAnonymizeIP($defaultIfEmpty = 0)
{
$anonymizeToLength = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.statistics.anonymizeIP', $defaultIfEmpty);
return (int)$anonymizeToLength;
}
/**
* Indicates if additional debug Data should be added to the statistics
*
* plugin.tx_meilisearch.statistics.addDebugData
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getStatisticsAddDebugData($defaultIfEmpty = false)
{
$statisticsAddDebugDataEnabled = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.statistics.addDebugData', $defaultIfEmpty);
return $this->getBool($statisticsAddDebugDataEnabled);
}
/**
* Indicates if suggestion is enabled or not.
*
* plugin.tx_meilisearch.suggest
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getSuggest($defaultIfEmpty = false)
{
$isSuggestionEnabled = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.suggest', $defaultIfEmpty);
return $this->getBool($isSuggestionEnabled);
}
/**
* Indicates if https should be used for the suggest form.
*
* plugin.tx_meilisearch.suggest.forceHttps
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getSuggestForceHttps($defaultIfEmpty = false)
{
$isHttpsForced = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.suggest.forceHttps', $defaultIfEmpty);
return $this->getBool($isHttpsForced);
}
/**
* Returns the allowed number of suggestions.
*
* plugin.tx_meilisearch.suggest.numberOfSuggestions
*
* @param int $defaultIfEmpty
* @return int
*/
public function getSuggestNumberOfSuggestions($defaultIfEmpty = 10)
{
$numberOfSuggestions = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.suggest.numberOfSuggestions', $defaultIfEmpty);
return (int)$numberOfSuggestions;
}
/**
* Indicates if the topResults should be shown or not
*
* plugin.tx_meilisearch.suggest.showTopResults
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getSuggestShowTopResults($defaultIfEmpty = true)
{
$showTopResults = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.suggest.showTopResults', $defaultIfEmpty);
return $this->getBool($showTopResults);
}
/**
* Returns the configured number of top results to show
*
* plugin.tx_meilisearch.suggest.numberOfTopResults
*
* @param int $defaultIfEmpty
* @return int
*/
public function getSuggestNumberOfTopResults($defaultIfEmpty = 5)
{
$numberOfTopResults = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.suggest.numberOfTopResults', $defaultIfEmpty);
return (int)$numberOfTopResults;
}
/**
* Returns additional fields for the top results
*
* plugin.tx_meilisearch.suggest.additionalTopResultsFields
*
* @param array $defaultIfEmpty
* @return array
*/
public function getSuggestAdditionalTopResultsFields($defaultIfEmpty = [])
{
$additionalTopResultsFields = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.suggest.additionalTopResultsFields', '');
if ($additionalTopResultsFields === '') {
return $defaultIfEmpty;
}
return GeneralUtility::trimExplode(',', $additionalTopResultsFields, true);
}
/**
* Returns the configured template for a specific template fileKey.
*
* plugin.tx_meilisearch.view.templateFiles.<fileKey>
*
* @param string $fileKey
* @param string $defaultIfEmpty
* @return string
*/
public function getViewTemplateByFileKey($fileKey, $defaultIfEmpty = '')
{
$templateFileName = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.view.templateFiles.' . $fileKey, $defaultIfEmpty);
return (string)$templateFileName;
}
/**
* Returns the configured available template files for the flexform.
*
* plugin.tx_meilisearch.view.templateFiles.[fileKey].availableTemplates.
*
* @param string $fileKey
* @return array
*/
public function getAvailableTemplatesByFileKey($fileKey)
{
$path = 'plugin.tx_meilisearch.view.templateFiles.' . $fileKey . '.availableTemplates.';
return (array)$this->getObjectByPathOrDefault($path, []);
}
/**
* Returns the configuration of the crop view helper.
*
* plugin.tx_meilisearch.viewHelpers.crop.
*
* @param array $defaultIfEmpty
* @return array
*/
public function getViewHelpersCropConfiguration(array $defaultIfEmpty = [])
{
$cropViewHelperConfiguration = $this->getObjectByPathOrDefault('plugin.tx_meilisearch.viewHelpers.crop.', $defaultIfEmpty);
return $cropViewHelperConfiguration;
}
/**
* Returns the configuration of the sorting view helper.
*
* plugin.tx_meilisearch.viewHelpers.sortIndicator.
*
* @param array $defaultIfEmpty
* @return array
*/
public function getViewHelpersSortIndicatorConfiguration(array $defaultIfEmpty = [])
{
$sortingViewHelperConfiguration = $this->getObjectByPathOrDefault('plugin.tx_meilisearch.viewHelpers.sortIndicator.', $defaultIfEmpty);
return $sortingViewHelperConfiguration;
}
/**
* Controls whether ext-solr will send commits to solr.
* Beware: If you disable this, you need to ensure
* that some other mechanism will commit your changes
* otherwise they will never be searchable.
* A good way to achieve this is enabling the solr
* daemons autoCommit feature.
*
* plugin.tx_meilisearch.index.enableCommits
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getEnableCommits($defaultIfEmpty = true)
{
$enableCommits = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.index.enableCommits', $defaultIfEmpty);
return $this->getBool($enableCommits);
}
/**
* Returns the url namespace that is used for the arguments.
*
* plugin.tx_meilisearch.view.pluginNamespace
*
* @param string $defaultIfEmpty
* @return string
*/
public function getSearchPluginNamespace($defaultIfEmpty = 'tx_meilisearch')
{
return $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.view.pluginNamespace', $defaultIfEmpty);
}
/**
* Returns true if the global url parameter q, that indicates the query should be used.
*
* Should be set to false, when multiple instance on the same page should have their querystring.
*
* plugin.tx_meilisearch.search.ignoreGlobalQParameter
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getSearchIgnoreGlobalQParameter($defaultIfEmpty = false)
{
$enableQParameter = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.ignoreGlobalQParameter', $defaultIfEmpty);
return $this->getBool($enableQParameter);
}
/**
* Returns the argument names, that should be added to the persistent arguments, as array.
*
* plugin.tx_meilisearch.search.additionalPersistentArgumentNames
*
* @param array $defaultIfEmpty
* @return array
*/
public function getSearchAdditionalPersistentArgumentNames($defaultIfEmpty = [])
{
$additionalPersistentArgumentNames = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.additionalPersistentArgumentNames', '');
if ($additionalPersistentArgumentNames === '') {
return $defaultIfEmpty;
}
return GeneralUtility::trimExplode(',', $additionalPersistentArgumentNames, true);
}
/**
* Method to check if grouping was enabled with typoscript.
*
* plugin.tx_meilisearch.search.grouping
*
* @param bool $defaultIfEmpty
* @return bool
*/
public function getSearchGrouping($defaultIfEmpty = false)
{
$groupingEnabled = $this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.grouping', $defaultIfEmpty);
return $this->getBool($groupingEnabled);
}
/**
* Returns the configured numberOfGroups.
*
* plugin.tx_meilisearch.search.grouping.numberOfGroups
*
* @param int $defaultIfEmpty
* @return int
*/
public function getSearchGroupingNumberOfGroups($defaultIfEmpty = 5)
{
return (int)$this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.grouping.numberOfGroups', $defaultIfEmpty);
}
/**
* Returns the sortBy configuration for the grouping.
*
* plugin.tx_meilisearch.search.grouping.sortBy
*
* @param string $defaultIfEmpty
* @return string
*/
public function getSearchGroupingSortBy($defaultIfEmpty = '')
{
return (string)$this->getValueByPathOrDefaultValue('plugin.tx_meilisearch.search.grouping.sortBy', $defaultIfEmpty);
}
/**
* Returns the highestValue of the numberOfResultsPerGroup configuration that is globally configured and
* for each group.
*
* plugin.tx_meilisearch.search.grouping.
*
* @param int $defaultIfEmpty
* @return int
*/
public function getSearchGroupingHighestGroupResultsLimit($defaultIfEmpty = 1)
{
$groupingConfiguration = $this->getObjectByPathOrDefault('plugin.tx_meilisearch.search.grouping.', []);
$highestLimit = $defaultIfEmpty;
if (!empty($groupingConfiguration['numberOfResultsPerGroup'])) {
$highestLimit = $groupingConfiguration['numberOfResultsPerGroup'];
}
$configuredGroups = $groupingConfiguration['groups.'];
if (!is_array($configuredGroups)) {
return $highestLimit;
}
foreach ($configuredGroups as $groupName => $groupConfiguration) {
if (!empty($groupConfiguration['numberOfResultsPerGroup']) && $groupConfiguration['numberOfResultsPerGroup'] > $highestLimit) {
$highestLimit = $groupConfiguration['numberOfResultsPerGroup'];
}
}
return $highestLimit;
}
/**
* Returns the valid numberOfResultsPerGroup value for a group.
*
* Returns:
*
* plugin.tx_meilisearch.search.grouping.groups.<groupName>.numberOfResultsPerGroup if it is set otherwise
* plugin.tx_meilisearch.search.grouping.numberOfResultsPerGroup
*
* @param string $groupName
* @param int $defaultIfEmpty
* @return int
*/
public function getSearchGroupingResultLimit($groupName, $defaultIfEmpty = 1)
{
$specificPath = 'plugin.tx_meilisearch.search.grouping.groups.' . $groupName . 'numberOfResultsPerGroup';
$specificResultsPerGroup = $this->getValueByPathOrDefaultValue($specificPath, null);
if ($specificResultsPerGroup !== null) {
return (int) $specificResultsPerGroup;
}
$commonPath = 'plugin.tx_meilisearch.search.grouping.numberOfResultsPerGroup';
$commonValue = $this->getValueByPathOrDefaultValue($commonPath, null);
if ($commonValue !== null) {
return (int) $commonValue;
}
return $defaultIfEmpty;
}
/**
* Returns everything that is configured for the groups (plugin.tx_meilisearch.search.grouping.groups.)
*
* plugin.tx_meilisearch.search.grouping.groups.
*
* @param array $defaultIfEmpty
* @return array
*/
public function getSearchGroupingGroupsConfiguration($defaultIfEmpty = [])
{
return $this->getObjectByPathOrDefault('plugin.tx_meilisearch.search.grouping.groups.', $defaultIfEmpty);
}
/*
* Applies the stdWrap if it is configured for the path, otherwise the unprocessed value will be returned.
*
* @param string $valuePath
* @param mixed $value
* @return mixed
*/
protected function renderContentElementOfConfigured($valuePath, $value)
{
$configurationPath = $valuePath . '.';
$configuration = $this->getObjectByPath($configurationPath);
if ($configuration == null) {
return $value;
}
if ($this->contentObjectService === null) {
$this->contentObjectService = GeneralUtility::makeInstance(ContentObjectService::class);
}
return $this->contentObjectService->renderSingleContentObject($value, $configuration);
}
}