126 lines
3.9 KiB
PHP
126 lines
3.9 KiB
PHP
<?php
|
|
namespace WapplerSystems\Meilisearch\FieldProcessor;
|
|
|
|
/***************************************************************
|
|
* Copyright notice
|
|
*
|
|
* (c) 2011-2015 Michael Knoll <knoll@punkt.de>
|
|
* 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\Site\Site;
|
|
use TYPO3\CMS\Core\Utility\GeneralUtility;
|
|
use TYPO3\CMS\Core\Utility\RootlineUtility;
|
|
|
|
/**
|
|
* This Processor takes a PID, and resolves its rootline in meilisearch notation.
|
|
*
|
|
* Format of this field corresponds to http://wiki.apache.org/meilisearch/HierarchicalFaceting
|
|
*
|
|
* Let's say we have a record indexed on page 111 which is a sub page like shown in this page tree:
|
|
*
|
|
* 1
|
|
* |-10
|
|
* |-100
|
|
* |-111
|
|
*
|
|
* then we get a rootline 1/10/100/111
|
|
*
|
|
* In Meilisearch hierarchy notation, we get
|
|
*
|
|
* 0-1/
|
|
* 1-1/10/
|
|
* 2-1/10/100/
|
|
* 3-1/10/100/11/
|
|
*
|
|
* which is finally saved in a multi-value field.
|
|
*
|
|
* @author Michael Knoll <knoll@punkt.de>
|
|
*/
|
|
class PageUidToHierarchy extends AbstractHierarchyProcessor implements FieldProcessor
|
|
{
|
|
|
|
/**
|
|
* Expects a page ID of a page. Returns a Meilisearch hierarchy notation for the
|
|
* rootline of the page ID.
|
|
*
|
|
* @param array $values Array of values, an array because of multivalued fields
|
|
* @return array Modified array of values
|
|
*/
|
|
public function process(array $values)
|
|
{
|
|
$results = [];
|
|
|
|
foreach ($values as $value) {
|
|
list($rootPageUid, $mountPoint) = GeneralUtility::trimExplode(',',
|
|
$value, true, 2);
|
|
$results[] = $this->getMeilisearchRootlineForPageId($rootPageUid,
|
|
$mountPoint);
|
|
}
|
|
|
|
return $results;
|
|
}
|
|
|
|
/**
|
|
* Returns a Meilisearch hierarchy notation string for rootline of given PID.
|
|
*
|
|
* @param int $pageId Page ID to get a rootline as Meilisearch hierarchy for
|
|
* @param string $mountPoint The mount point parameter that will be used for building the rootline.
|
|
* @return array Rootline as Meilisearch hierarchy array
|
|
*/
|
|
protected function getMeilisearchRootlineForPageId($pageId, $mountPoint = '')
|
|
{
|
|
$pageIdRootline = $this->buildPageIdRootline($pageId, $mountPoint);
|
|
$meilisearchRootline = $this->buildMeilisearchHierarchyFromIdRootline($pageIdRootline);
|
|
|
|
return $meilisearchRootline;
|
|
}
|
|
|
|
/**
|
|
* Builds a page's rootline of parent page Ids
|
|
*
|
|
* @param int $pageId The page Id to build the rootline for
|
|
* @param string $mountPoint The mount point parameter that will be passed to getRootline().
|
|
* @return array Page Id rootline as array
|
|
*/
|
|
protected function buildPageIdRootline($pageId, $mountPoint = '')
|
|
{
|
|
$rootlinePageIds = [];
|
|
|
|
$rootlineUtility = GeneralUtility::makeInstance(RootlineUtility::class, $pageId, $mountPoint);
|
|
try {
|
|
$rootline = $rootlineUtility->get();
|
|
} catch (\RuntimeException $e) {
|
|
$rootline = [];
|
|
}
|
|
|
|
foreach ($rootline as $page) {
|
|
if (Site::isRootPage($page)) {
|
|
break;
|
|
}
|
|
|
|
array_unshift($rootlinePageIds, $page['pid']);
|
|
}
|
|
|
|
$rootlinePageIds[] = $pageId;
|
|
|
|
return $rootlinePageIds;
|
|
}
|
|
}
|