ApacheSolrForTypo3\Solr\Domain\Search\Highlight\SiteHighlighterUrlModifier

Complexity

Total Complexity

3

Size/Duplication

Total Lines	31
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	modify()	0	22	3

<?php

/*
 * 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!
 */

namespace ApacheSolrForTypo3\Solr\Domain\Search\Highlight;

use ApacheSolrForTypo3\Solr\System\Url\UrlHelper;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
 * Class SiteHighlighterUrlModifier provides highlighting of the search words on the document's actual page by
 * adding parameters to a document's URL property.
 *
 * Initial code from ApacheSolrForTypo3\Solr\ResultDocumentModifier\SiteHighlighter
 *
 * @author Stefan Sprenger <stefan.sprenger@dkd.de>
 * @author Timo Hund <timo.hund@dkd.de>
 */
class SiteHighlighterUrlModifier
{
    /**
     * @param string $url
     * @param string $searchWords
     * @param bool $addNoCache
     * @param bool $keepCHash
     * @return string
     */
    public function modify(
        string $url,
        string $searchWords,
        bool $addNoCache = true,
        bool $keepCHash = false
    ): string {
        $searchWords = str_replace('&quot;', '', $searchWords);
        $searchWords = GeneralUtility::trimExplode(' ', $searchWords, true);

        /** @var UrlHelper $urlHelper */
        $urlHelper = GeneralUtility::makeInstance(UrlHelper::class, /** @scrutinizer ignore-type */ $url)
            ->withQueryParameter('sword_list', $searchWords);

        if ($addNoCache) {
            $urlHelper = $urlHelper->withQueryParameter('no_cache', '1');
        }

        if (!$keepCHash) {
            $urlHelper = $urlHelper->withoutQueryParameter('cHash');
        }

        return $urlHelper->__toString();
    }
}