ApacheSolrForTypo3\Solr\Facet\UsedFacetRenderer

Complexity

Total Complexity

8

Size/Duplication

Total Lines	138
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

46.25%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	getModifiedFacetTextFromHook()	0	29	5
A	__construct()	0	12	1
A	render()	0	57	2

<?php
namespace ApacheSolrForTypo3\Solr\Facet;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2010-2011 Markus Goldbach <markus.goldbach@dkd.de>
 *  (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 2 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 ApacheSolrForTypo3\Solr\Query;
use ApacheSolrForTypo3\Solr\Query\FilterEncoder\Hierarchy;
use ApacheSolrForTypo3\Solr\Template;
use ApacheSolrForTypo3\Solr\Util;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;

/**
 * Renderer for Used Facets.
 *
 * FIXME merge into default renderer as renderUsedFacetOption()
 *
 * @author Markus Goldbach <markus.goldbach@dkd.de>
 * @author Ingo Renner <ingo@typo3.org>
 */
class UsedFacetRenderer extends SimpleFacetOptionsRenderer
{

    /**
     * The name of the facet the filter is applied to.
     *
     * @var string
     */
    protected $filter;

    /**
     * The filter value that has been applied to a query.
     *
     * @var string
     */
    protected $filterValue;

    /**
     * Constructor
     *
     * @param string $facetName
     * @param array $filterValue
     * @param \ApacheSolrForTypo3\Solr\Template $filter
     * @param \ApacheSolrForTypo3\Solr\Template $template
     * @param \ApacheSolrForTypo3\Solr\Query $query
     */
    public function __construct(
        $facetName,
        $filterValue,
        $filter,
        Template $template,
        Query $query
    ) {
        parent::__construct($facetName, array(), $template, $query);

        $this->filter = $filter;

It seems like $filter of type object<ApacheSolrForTypo3\Solr\Template> is incompatible with the declared type string of property $filter.

        $this->filterValue = $filterValue;

It seems like $filterValue of type array is incompatible with the declared type string of property $filterValue.

    }

    /**
     * Renders the block of used / applied facets.
     *
     * @return string Rendered HTML representing the used facet.
     */
    public function render()
    {
        $solrConfiguration = Util::getSolrConfiguration();

        $facetOption = GeneralUtility::makeInstance(FacetOption::class,
            $this->facetName,
            $this->filterValue
        );

        $facetLinkBuilder = GeneralUtility::makeInstance(LinkBuilder::class,
            $this->query,
            $this->facetName,
            $facetOption
        );
        /* @var $facetLinkBuilder LinkBuilder */
        $facetLinkBuilder->setLinkTargetPageId($this->linkTargetPageId);

        if ($this->facetConfiguration['type'] == 'hierarchy') {
            // FIXME decouple this
            $filterEncoder = GeneralUtility::makeInstance(Hierarchy::class);
            $facet = GeneralUtility::makeInstance(Facet::class, $this->facetName);
            $facetRenderer = GeneralUtility::makeInstance(HierarchicalFacetRenderer::class, $facet);

            $facetText = $facetRenderer->getLastPathSegmentFromHierarchicalFacetOption($filterEncoder->decodeFilter($this->filterValue));
        } else {
            $facetText = $facetOption->render();
        }

        $facetText = $this->getModifiedFacetTextFromHook($facetText);

        $contentObject = GeneralUtility::makeInstance(ContentObjectRenderer::class);
        $facetConfiguration = $solrConfiguration->getSearchFacetingFacetByName($this->facetName);
        $facetLabel = $contentObject->stdWrap($facetConfiguration['label'], $facetConfiguration['label.']);

        $removeFacetText = strtr(
            $solrConfiguration->getSearchFacetingRemoveFacetLinkText(),
            array(
                '@facetValue' => $this->filterValue,
                '@facetName' => $this->facetName,
                '@facetLabel' => $facetLabel,
                '@facetText' => $facetText
            )
        );

        $removeFacetLink = $facetLinkBuilder->getRemoveFacetOptionLink($removeFacetText);
        $removeFacetUrl = $facetLinkBuilder->getRemoveFacetOptionUrl();

        $facetToRemove = array(
            'link' => $removeFacetLink,
            'url' => $removeFacetUrl,
            'text' => $removeFacetText,
            'value' => $this->filterValue,
            'facet_name' => $this->facetName
        );

        return $facetToRemove;
    }

    /**
     * Provides a hook to overwrite the facetText.
     *
     * @param string $facetText
     * @return mixed
     */
    protected function getModifiedFacetTextFromHook($facetText)
    {
        if (!is_array($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr']['processUsedFacetText'])) {
            return $facetText;
        }

        foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr']['processUsedFacetText'] as $classReference) {
            $usedFacetOptionsRenderer = GeneralUtility::getUserObj($classReference);
            $params = array(
                'facetName' => $this->facetName,
                'facetValue' => $this->filterValue,
                'facetConfiguration' => $this->facetConfiguration,
                'facetText' => $facetText
            );

            if (!$usedFacetOptionsRenderer instanceof UsedFacetOptionsRenderer) {
                $message = 'Invalid hook configured in processUsedFacetText. Hook needs to implement Interface UsedFacetOptionsRenderer!';
                throw new \InvalidArgumentException($message);
            }

            $newText = $usedFacetOptionsRenderer->getUsedFacetText($params, $this);

            if (!empty($newText)) {
                $facetText = $newText;
            }
        }

        return $facetText;
    }
}