first commit
This commit is contained in:
Sven Wappler
@@ -0,0 +1,130 @@
|
||||
<?php
|
||||
namespace WapplerSystems\Meilisearch\Domain\Search\ResultSet\Facets\OptionBased\Hierarchy;
|
||||
|
||||
/*
|
||||
* 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\Domain\Search\ResultSet\Facets\AbstractFacet;
|
||||
use WapplerSystems\Meilisearch\Domain\Search\ResultSet\Facets\AbstractFacetItemCollection;
|
||||
use WapplerSystems\Meilisearch\Domain\Search\ResultSet\SearchResultSet;
|
||||
|
||||
/**
|
||||
* Value object that represent a options facet.
|
||||
*
|
||||
* @author Frans Saris <frans@beech.it>
|
||||
* @author Timo Hund <timo.hund@dkd.de>
|
||||
*/
|
||||
class HierarchyFacet extends AbstractFacet
|
||||
{
|
||||
const TYPE_HIERARCHY = 'hierarchy';
|
||||
|
||||
/**
|
||||
* String
|
||||
* @var string
|
||||
*/
|
||||
protected static $type = self::TYPE_HIERARCHY;
|
||||
|
||||
/**
|
||||
* @var NodeCollection
|
||||
*/
|
||||
protected $childNodes;
|
||||
|
||||
/**
|
||||
* @var NodeCollection
|
||||
*/
|
||||
protected $allNodes;
|
||||
|
||||
/**
|
||||
* @var array
|
||||
*/
|
||||
protected $nodesByKey = [];
|
||||
|
||||
/**
|
||||
* OptionsFacet constructor
|
||||
*
|
||||
* @param SearchResultSet $resultSet
|
||||
* @param string $name
|
||||
* @param string $field
|
||||
* @param string $label
|
||||
* @param array $configuration Facet configuration passed from typoscript
|
||||
*/
|
||||
public function __construct(SearchResultSet $resultSet, $name, $field, $label = '', array $configuration = [])
|
||||
{
|
||||
parent::__construct($resultSet, $name, $field, $label, $configuration);
|
||||
$this->childNodes = new NodeCollection();
|
||||
$this->allNodes = new NodeCollection();
|
||||
}
|
||||
|
||||
/**
|
||||
* @param Node $node
|
||||
*/
|
||||
public function addChildNode(Node $node)
|
||||
{
|
||||
$this->childNodes->add($node);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return NodeCollection
|
||||
*/
|
||||
public function getChildNodes()
|
||||
{
|
||||
return $this->childNodes;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new node on the right position with the right parent node.
|
||||
*
|
||||
* @param string $parentKey
|
||||
* @param string $key
|
||||
* @param string $label
|
||||
* @param string $value
|
||||
* @param integer $count
|
||||
* @param boolean $selected
|
||||
*/
|
||||
public function createNode($parentKey, $key, $label, $value, $count, $selected)
|
||||
{
|
||||
/** @var $parentNode Node|null */
|
||||
$parentNode = isset($this->nodesByKey[$parentKey]) ? $this->nodesByKey[$parentKey] : null;
|
||||
/** @var Node $node */
|
||||
$node = $this->objectManager->get(Node::class, $this, $parentNode, $key, $label, $value, $count, $selected);
|
||||
$this->nodesByKey[$key] = $node;
|
||||
|
||||
if ($parentNode === null) {
|
||||
$this->addChildNode($node);
|
||||
} else {
|
||||
$parentNode->addChildNode($node);
|
||||
}
|
||||
|
||||
$this->allNodes->add($node);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get facet partial name used for rendering the facet
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getPartialName()
|
||||
{
|
||||
return !empty($this->configuration['partialName']) ? $this->configuration['partialName'] : 'Hierarchy';
|
||||
}
|
||||
|
||||
/**
|
||||
* The implementation of this method should return a "flatten" collection of all items.
|
||||
*
|
||||
* @return AbstractFacetItemCollection
|
||||
*/
|
||||
public function getAllFacetItems()
|
||||
{
|
||||
return $this->allNodes;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,159 @@
|
||||
<?php
|
||||
namespace WapplerSystems\Meilisearch\Domain\Search\ResultSet\Facets\OptionBased\Hierarchy;
|
||||
|
||||
/*
|
||||
* 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\Domain\Search\ResultSet\Facets\AbstractFacetParser;
|
||||
use WapplerSystems\Meilisearch\Domain\Search\ResultSet\SearchResultSet;
|
||||
use WapplerSystems\Meilisearch\System\Solr\ParsingUtil;
|
||||
|
||||
/**
|
||||
* Class HierarchyFacetParser
|
||||
*/
|
||||
class HierarchyFacetParser extends AbstractFacetParser
|
||||
{
|
||||
/**
|
||||
* @param SearchResultSet $resultSet
|
||||
* @param string $facetName
|
||||
* @param array $facetConfiguration
|
||||
* @return HierarchyFacet|null
|
||||
*/
|
||||
public function parse(SearchResultSet $resultSet, $facetName, array $facetConfiguration)
|
||||
{
|
||||
$response = $resultSet->getResponse();
|
||||
$fieldName = $facetConfiguration['field'];
|
||||
$label = $this->getPlainLabelOrApplyCObject($facetConfiguration);
|
||||
$optionsFromSolrResponse = isset($response->facet_counts->facet_fields->{$fieldName}) ? ParsingUtil::getMapArrayFromFlatArray($response->facet_counts->facet_fields->{$fieldName}) : [];
|
||||
$optionsFromRequest = $this->getActiveFacetValuesFromRequest($resultSet, $facetName);
|
||||
$hasOptionsInResponse = !empty($optionsFromSolrResponse);
|
||||
$hasSelectedOptionsInRequest = count($optionsFromRequest) > 0;
|
||||
$hasNoOptionsToShow = !$hasOptionsInResponse && !$hasSelectedOptionsInRequest;
|
||||
$hideEmpty = !$resultSet->getUsedSearchRequest()->getContextTypoScriptConfiguration()->getSearchFacetingShowEmptyFacetsByName($facetName);
|
||||
|
||||
if ($hasNoOptionsToShow && $hideEmpty) {
|
||||
return null;
|
||||
}
|
||||
|
||||
/** @var $facet HierarchyFacet */
|
||||
$facet = $this->objectManager->get(HierarchyFacet::class, $resultSet, $facetName, $fieldName, $label, $facetConfiguration);
|
||||
|
||||
$hasActiveOptions = count($optionsFromRequest) > 0;
|
||||
$facet->setIsUsed($hasActiveOptions);
|
||||
|
||||
$facet->setIsAvailable($hasOptionsInResponse);
|
||||
|
||||
$nodesToCreate = $this->getMergedFacetValueFromSearchRequestAndSolrResponse($optionsFromSolrResponse, $optionsFromRequest);
|
||||
|
||||
if ($this->facetOptionsMustBeResorted($facetConfiguration)) {
|
||||
$nodesToCreate = $this->sortFacetOptionsInNaturalOrder($nodesToCreate);
|
||||
}
|
||||
|
||||
foreach ($nodesToCreate as $value => $count) {
|
||||
if ($this->getIsExcludedFacetValue($value, $facetConfiguration)) {
|
||||
continue;
|
||||
}
|
||||
$isActive = in_array($value, $optionsFromRequest);
|
||||
$delimiterPosition = strpos($value, '-');
|
||||
$path = substr($value, $delimiterPosition + 1);
|
||||
$pathArray = $this->getPathAsArray($path);
|
||||
$key = array_pop($pathArray);
|
||||
$parentKey = array_pop($pathArray);
|
||||
$value = '/' . $path;
|
||||
$label = $this->getLabelFromRenderingInstructions($key, $count, $facetName, $facetConfiguration);
|
||||
|
||||
$facet->createNode($parentKey, $key, $label, $value, $count, $isActive);
|
||||
}
|
||||
|
||||
return $facet;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sorts facet options in natural order.
|
||||
* Options must be sorted in natural order,
|
||||
* because lower nesting levels must be instantiated first, to serve as parents for higher nested levels.
|
||||
* See implementation of HierarchyFacet::createNode().
|
||||
*
|
||||
* @param array $flatOptionsListForFacet
|
||||
* @return void sorted list of facet options
|
||||
*/
|
||||
protected function sortFacetOptionsInNaturalOrder(array $flatOptionsListForHierarchyFacet)
|
||||
{
|
||||
uksort($flatOptionsListForHierarchyFacet, "strnatcmp");
|
||||
return $flatOptionsListForHierarchyFacet;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if options must be resorted.
|
||||
*
|
||||
* Apache Solr facet.sort can be set globally or per facet.
|
||||
* Relevant TypoScript paths:
|
||||
* plugin.tx_meilisearch.search.faceting.sortBy causes facet.sort Apache Solr parameter
|
||||
* plugin.tx_meilisearch.search.faceting.facets.[facetName].sortBy causes f.<fieldname>.facet.sort parameter
|
||||
*
|
||||
* see: https://lucene.apache.org/solr/guide/6_6/faceting.html#Faceting-Thefacet.sortParameter
|
||||
* see: https://wiki.apache.org/solr/SimpleFacetParameters#facet.sort : "This parameter can be specified on a per field basis."
|
||||
*
|
||||
* @param array $facetConfiguration
|
||||
* @return bool
|
||||
*/
|
||||
protected function facetOptionsMustBeResorted(array $facetConfiguration)
|
||||
{
|
||||
if (isset($facetConfiguration['sortBy']) && $facetConfiguration['sortBy'] === 'index') {
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* This method is used to get the path array from a hierarchical facet. It substitutes escaped slashes to keep them
|
||||
* when they are used inside a facetValue.
|
||||
*
|
||||
* @param string $path
|
||||
* @return array
|
||||
*/
|
||||
protected function getPathAsArray($path)
|
||||
{
|
||||
$path = str_replace('\/', '@@@', $path);
|
||||
$path = rtrim($path, "/");
|
||||
$segments = explode('/', $path);
|
||||
return array_map(function($item) {
|
||||
return str_replace('@@@', '/', $item);
|
||||
}, $segments);
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves the active facetValue for a facet from the search request.
|
||||
* @param SearchResultSet $resultSet
|
||||
* @param string $facetName
|
||||
* @return array
|
||||
*/
|
||||
protected function getActiveFacetValuesFromRequest(SearchResultSet $resultSet, $facetName)
|
||||
{
|
||||
$activeFacetValues = [];
|
||||
$values = $resultSet->getUsedSearchRequest()->getActiveFacetValuesByName($facetName);
|
||||
|
||||
foreach (is_array($values) ? $values : [] as $valueFromRequest) {
|
||||
// Attach the 'depth' param again to the value
|
||||
if (strpos($valueFromRequest, '-') === false) {
|
||||
$valueFromRequest = HierarchyTool::substituteSlashes($valueFromRequest);
|
||||
$valueFromRequest = trim($valueFromRequest, '/');
|
||||
$valueFromRequest = (count(explode('/', $valueFromRequest)) - 1) . '-' . $valueFromRequest . '/';
|
||||
$valueFromRequest = HierarchyTool::unSubstituteSlashes($valueFromRequest);
|
||||
}
|
||||
$activeFacetValues[] = $valueFromRequest;
|
||||
}
|
||||
return $activeFacetValues;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,37 @@
|
||||
<?php
|
||||
namespace WapplerSystems\Meilisearch\Domain\Search\ResultSet\Facets\OptionBased\Hierarchy;
|
||||
|
||||
/*
|
||||
* 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\Domain\Search\ResultSet\Facets\AbstractFacetPackage;
|
||||
|
||||
/**
|
||||
* Class HierarchyPackage
|
||||
*/
|
||||
class HierarchyPackage extends AbstractFacetPackage {
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function getParserClassName() {
|
||||
return (string)HierarchyFacetParser::class;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function getUrlDecoderClassName() {
|
||||
return (string)HierarchyUrlDecoder::class;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
<?php
|
||||
namespace WapplerSystems\Meilisearch\Domain\Search\ResultSet\Facets\OptionBased\Hierarchy;
|
||||
|
||||
/*
|
||||
* 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!
|
||||
*/
|
||||
|
||||
class HierarchyTool
|
||||
{
|
||||
/**
|
||||
* Replaces all escaped slashes in a hierarchy path with @@@slash@@@ to afterwards
|
||||
* only have slashes in the content that are real path separators.
|
||||
*
|
||||
* @param string $pathWithContentSlashes
|
||||
* @return string
|
||||
*/
|
||||
public static function substituteSlashes(string $pathWithContentSlashes): string
|
||||
{
|
||||
return (string)str_replace('\/', '@@@slash@@@', $pathWithContentSlashes);
|
||||
}
|
||||
|
||||
/**
|
||||
* Replaces @@@slash@@@ with \/ to have the path usable for solr again.
|
||||
*
|
||||
* @param string $pathWithReplacedContentSlashes
|
||||
* @return string
|
||||
*/
|
||||
public static function unSubstituteSlashes(string $pathWithReplacedContentSlashes): string
|
||||
{
|
||||
return (string)str_replace('@@@slash@@@', '\/', $pathWithReplacedContentSlashes);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,64 @@
|
||||
<?php
|
||||
namespace WapplerSystems\Meilisearch\Domain\Search\ResultSet\Facets\OptionBased\Hierarchy;
|
||||
|
||||
/***************************************************************
|
||||
* Copyright notice
|
||||
*
|
||||
* (c) 2012-2015 Ingo Renner <ingo@typo3.org>
|
||||
* All rights reserved
|
||||
*
|
||||
* This script is part of the TYPO3 project. The TYPO3 project 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 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* The GNU General Public License can be found at
|
||||
* http://www.gnu.org/copyleft/gpl.html.
|
||||
*
|
||||
* This script 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.
|
||||
*
|
||||
* This copyright notice MUST APPEAR in all copies of the script!
|
||||
***************************************************************/
|
||||
|
||||
use WapplerSystems\Meilisearch\Domain\Search\ResultSet\Facets\FacetUrlDecoderInterface;
|
||||
|
||||
/**
|
||||
* Filter encoder to build Solr hierarchy queries from tx_meilisearch[filter]
|
||||
*
|
||||
* @author Ingo Renner <ingo@typo3.org>
|
||||
*/
|
||||
class HierarchyUrlDecoder implements FacetUrlDecoderInterface
|
||||
{
|
||||
|
||||
/**
|
||||
* Delimiter for hierarchies in the URL.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
const DELIMITER = '/';
|
||||
|
||||
/**
|
||||
* Parses the given hierarchy filter and returns a Solr filter query.
|
||||
*
|
||||
* @param string $hierarchy The hierarchy filter query.
|
||||
* @param array $configuration Facet configuration
|
||||
* @return string Lucene query language filter to be used for querying Solr
|
||||
*/
|
||||
public function decode($hierarchy, array $configuration = [])
|
||||
{
|
||||
$escapedHierarchy = HierarchyTool::substituteSlashes($hierarchy);
|
||||
|
||||
$escapedHierarchy = substr($escapedHierarchy, 1);
|
||||
$escapedHierarchy = rtrim($escapedHierarchy, '/');
|
||||
$hierarchyItems = explode(self::DELIMITER, $escapedHierarchy);
|
||||
$filterContent = (count($hierarchyItems) - 1) . '-' . $escapedHierarchy . '/';
|
||||
|
||||
$filterContent = HierarchyTool::unSubstituteSlashes($filterContent);
|
||||
|
||||
return '"' . str_replace("\\", "\\\\", $filterContent) . '"';
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,119 @@
|
||||
<?php
|
||||
namespace WapplerSystems\Meilisearch\Domain\Search\ResultSet\Facets\OptionBased\Hierarchy;
|
||||
|
||||
/*
|
||||
* 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\Domain\Search\ResultSet\Facets\OptionBased\AbstractOptionFacetItem;
|
||||
|
||||
/**
|
||||
* Value object that represent an option of a options facet.
|
||||
*
|
||||
* @author Frans Saris <frans@beech.it>
|
||||
* @author Timo Hund <timo.hund@dkd.de>
|
||||
*/
|
||||
class Node extends AbstractOptionFacetItem
|
||||
{
|
||||
|
||||
/**
|
||||
* @var NodeCollection
|
||||
*/
|
||||
protected $childNodes;
|
||||
|
||||
/**
|
||||
* @var Node
|
||||
*/
|
||||
protected $parentNode;
|
||||
|
||||
/**
|
||||
* @var integer
|
||||
*/
|
||||
protected $depth;
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
protected $key;
|
||||
|
||||
/**
|
||||
* @param HierarchyFacet $facet
|
||||
* @param Node $parentNode
|
||||
* @param string $key
|
||||
* @param string $label
|
||||
* @param string $value
|
||||
* @param int $documentCount
|
||||
* @param bool $selected
|
||||
*/
|
||||
public function __construct(HierarchyFacet $facet, $parentNode = null, $key = '', $label = '', $value = '', $documentCount = 0, $selected = false)
|
||||
{
|
||||
parent::__construct($facet, $label, $value, $documentCount, $selected);
|
||||
$this->value = $value;
|
||||
$this->childNodes = new NodeCollection();
|
||||
$this->parentNode = $parentNode;
|
||||
$this->key = $key;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function getKey()
|
||||
{
|
||||
return $this->key;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param Node $node
|
||||
*/
|
||||
public function addChildNode(Node $node)
|
||||
{
|
||||
$this->childNodes->add($node);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return NodeCollection
|
||||
*/
|
||||
public function getChildNodes()
|
||||
{
|
||||
return $this->childNodes;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return Node|null
|
||||
*/
|
||||
public function getParentNode()
|
||||
{
|
||||
return $this->parentNode;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
*/
|
||||
public function getHasParentNode()
|
||||
{
|
||||
return $this->parentNode !== null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
*/
|
||||
public function getHasChildNodeSelected()
|
||||
{
|
||||
/** @var Node $childNode */
|
||||
foreach ($this->childNodes as $childNode) {
|
||||
if ($childNode->getSelected()) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,44 @@
|
||||
<?php
|
||||
namespace WapplerSystems\Meilisearch\Domain\Search\ResultSet\Facets\OptionBased\Hierarchy;
|
||||
|
||||
/*
|
||||
* 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\Domain\Search\ResultSet\Facets\AbstractFacetItemCollection;
|
||||
|
||||
/**
|
||||
* Collection for facet options.
|
||||
*
|
||||
* @author Frans Saris <frans@beech.it>
|
||||
* @author Timo Hund <timo.hund@dkd.de>
|
||||
*/
|
||||
class NodeCollection extends AbstractFacetItemCollection
|
||||
{
|
||||
|
||||
/**
|
||||
* @param Node $node
|
||||
* @return NodeCollection
|
||||
*/
|
||||
public function add($node)
|
||||
{
|
||||
return parent::add($node);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param int $position
|
||||
* @return Node
|
||||
*/
|
||||
public function getByPosition($position)
|
||||
{
|
||||
return parent::getByPosition($position);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user