223 lines
7.4 KiB
PHP
223 lines
7.4 KiB
PHP
|
<?php
|
||
|
namespace WapplerSystems\Meilisearch\System\UserFunctions;
|
||
|
|
||
|
/*
|
||
|
* Copyright (C) 2016 Daniel Siepmann <coding@daniel-siepmann.de>
|
||
|
*
|
||
|
* This program is free software; you can redistribute it and/or
|
||
|
* modify it under the terms of the GNU General Public License
|
||
|
* as published by the Free Software Foundation; either version 2
|
||
|
* of the License, or (at your option) any later version.
|
||
|
*
|
||
|
* This program is distributed in the hope that it will be useful,
|
||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
|
* GNU General Public License for more details.
|
||
|
*
|
||
|
* You should have received a copy of the GNU General Public License
|
||
|
* along with this program; if not, write to the Free Software
|
||
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
||
|
* 02110-1301, USA.
|
||
|
*/
|
||
|
|
||
|
use WapplerSystems\Meilisearch\ConnectionManager;
|
||
|
use WapplerSystems\Meilisearch\FrontendEnvironment;
|
||
|
use TYPO3\CMS\Core\Utility\GeneralUtility;
|
||
|
use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
|
||
|
|
||
|
/**
|
||
|
* This class contains all user functions for flexforms.
|
||
|
*
|
||
|
* @author Daniel Siepmann <coding@daniel-siepmann.de>
|
||
|
*/
|
||
|
class FlexFormUserFunctions
|
||
|
{
|
||
|
|
||
|
/**
|
||
|
* @var FrontendEnvironment
|
||
|
*/
|
||
|
protected $frontendEnvironment = null;
|
||
|
|
||
|
public function __construct(FrontendEnvironment $frontendEnvironment = null)
|
||
|
{
|
||
|
$this->frontendEnvironment = $frontendEnvironment ?? GeneralUtility::makeInstance(FrontendEnvironment::class);
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Provides all facet fields for a flexform select, enabling the editor to select one of them.
|
||
|
*
|
||
|
* @param array $parentInformation
|
||
|
*
|
||
|
* @return void
|
||
|
*/
|
||
|
public function getFacetFieldsFromSchema(array &$parentInformation)
|
||
|
{
|
||
|
$pageRecord = $parentInformation['flexParentDatabaseRow'];
|
||
|
$configuredFacets = $this->getConfiguredFacetsForPage($pageRecord['pid']);
|
||
|
|
||
|
if (!is_array($pageRecord)) {
|
||
|
$parentInformation['items'] = [];
|
||
|
return;
|
||
|
}
|
||
|
|
||
|
$newItems = $this->getParsedSolrFieldsFromSchema($configuredFacets, $pageRecord);
|
||
|
$parentInformation['items'] = $newItems;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* This method parses the solr schema fields into the required format for the backend flexform.
|
||
|
*
|
||
|
* @param array $configuredFacets
|
||
|
* @param array $pageRecord
|
||
|
* @return mixed
|
||
|
*/
|
||
|
protected function getParsedSolrFieldsFromSchema($configuredFacets, $pageRecord)
|
||
|
{
|
||
|
$newItems = [];
|
||
|
|
||
|
array_map(function($fieldName) use (&$newItems, $configuredFacets) {
|
||
|
$value = $fieldName;
|
||
|
$label = $fieldName;
|
||
|
|
||
|
$facetNameFilter = function($facet) use ($fieldName) {
|
||
|
return ($facet['field'] === $fieldName);
|
||
|
};
|
||
|
$configuredFacets = array_filter($configuredFacets, $facetNameFilter);
|
||
|
if (!empty($configuredFacets)) {
|
||
|
$configuredFacet = array_values($configuredFacets);
|
||
|
$label = $configuredFacet[0]['label'];
|
||
|
// try to translate LLL: label or leave it unchanged
|
||
|
if (GeneralUtility::isFirstPartOfStr($label, 'LLL:') && $this->getTranslation($label) != '') {
|
||
|
$label = $this->getTranslation($label);
|
||
|
} elseif (!GeneralUtility::isFirstPartOfStr($label, 'LLL:') && $configuredFacet[0]['label.']) {
|
||
|
$label = sprintf('cObject[...faceting.facets.%slabel]', array_keys($configuredFacets)[0]);
|
||
|
}
|
||
|
$label = sprintf('%s (Facet Label: "%s")', $value, $label);
|
||
|
}
|
||
|
|
||
|
$newItems[$value] = [$label, $value];
|
||
|
}, $this->getFieldNamesFromSolrMetaDataForPage($pageRecord));
|
||
|
|
||
|
ksort($newItems, SORT_NATURAL);
|
||
|
return $newItems;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Retrieves the configured facets for a page.
|
||
|
*
|
||
|
* @param integer $pid
|
||
|
* @return array
|
||
|
*/
|
||
|
protected function getConfiguredFacetsForPage($pid)
|
||
|
{
|
||
|
$typoScriptConfiguration = $this->getConfigurationFromPageId($pid);
|
||
|
return $typoScriptConfiguration->getSearchFacetingFacets();
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Retrieves the translation with the LocalizationUtility.
|
||
|
*
|
||
|
* @param string $label
|
||
|
* @return null|string
|
||
|
*/
|
||
|
protected function getTranslation($label)
|
||
|
{
|
||
|
return LocalizationUtility::translate($label);
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Get solr connection.
|
||
|
*
|
||
|
* @param array $pageRecord
|
||
|
*
|
||
|
* @return \WapplerSystems\Meilisearch\System\Solr\SolrConnection
|
||
|
*/
|
||
|
protected function getConnection(array $pageRecord)
|
||
|
{
|
||
|
return GeneralUtility::makeInstance(ConnectionManager::class)->getConnectionByPageId($pageRecord['pid'], $pageRecord['sys_language_uid']);
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Retrieves all fieldnames that occure in the solr schema for one page.
|
||
|
*
|
||
|
* @param array $pageRecord
|
||
|
* @return array
|
||
|
*/
|
||
|
protected function getFieldNamesFromSolrMetaDataForPage(array $pageRecord)
|
||
|
{
|
||
|
return array_keys((array)$this->getConnection($pageRecord)->getAdminService()->getFieldsMetaData());
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* @param array $parentInformation
|
||
|
*/
|
||
|
public function getAvailableTemplates(array &$parentInformation)
|
||
|
{
|
||
|
$pageRecord = $parentInformation['flexParentDatabaseRow'];
|
||
|
if (!is_array($pageRecord) || !isset ($pageRecord['pid'])) {
|
||
|
$parentInformation['items'] = [];
|
||
|
return;
|
||
|
}
|
||
|
|
||
|
$pageId = $pageRecord['pid'];
|
||
|
|
||
|
$templateKey = $this->getTypoScriptTemplateKeyFromFieldName($parentInformation);
|
||
|
$availableTemplate = $this->getAvailableTemplateFromTypoScriptConfiguration($pageId, $templateKey);
|
||
|
$newItems = $this->buildSelectItemsFromAvailableTemplate($availableTemplate);
|
||
|
|
||
|
$parentInformation['items'] = $newItems;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* @param array $parentInformation
|
||
|
* @return string
|
||
|
*/
|
||
|
protected function getTypoScriptTemplateKeyFromFieldName(array &$parentInformation)
|
||
|
{
|
||
|
$field = $parentInformation['field'];
|
||
|
return str_replace('view.templateFiles.', '', $field);
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* @param $pid
|
||
|
* @return \WapplerSystems\Meilisearch\System\Configuration\TypoScriptConfiguration|array
|
||
|
*/
|
||
|
protected function getConfigurationFromPageId($pid)
|
||
|
{
|
||
|
$typoScriptConfiguration = $this->frontendEnvironment->getSolrConfigurationFromPageId($pid);
|
||
|
return $typoScriptConfiguration;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Retrieves the configured templates from TypoScript.
|
||
|
*
|
||
|
* @param integer $pageId
|
||
|
* @param string $templateKey
|
||
|
* @return array
|
||
|
*/
|
||
|
protected function getAvailableTemplateFromTypoScriptConfiguration($pageId, $templateKey)
|
||
|
{
|
||
|
$configuration = $this->getConfigurationFromPageId($pageId);
|
||
|
return $configuration->getAvailableTemplatesByFileKey($templateKey);
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Returns the available templates as needed for the flexform.
|
||
|
*
|
||
|
* @param array $availableTemplates
|
||
|
* @return array
|
||
|
*/
|
||
|
protected function buildSelectItemsFromAvailableTemplate($availableTemplates)
|
||
|
{
|
||
|
$newItems = [];
|
||
|
$newItems['Use Default'] = ['Use Default', null];
|
||
|
foreach ($availableTemplates as $availableTemplate) {
|
||
|
$label = isset($availableTemplate['label']) ? $availableTemplate['label'] : '';
|
||
|
$value = isset($availableTemplate['file']) ? $availableTemplate['file'] : '';
|
||
|
$newItems[$label] = [$label, $value];
|
||
|
}
|
||
|
|
||
|
return $newItems;
|
||
|
}
|
||
|
}
|