ApacheSolrForTypo3\Solr\Facet\AbstractFacetRenderer

Complexity

Total Complexity

16

Size/Duplication

Total Lines	222
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

80.23%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
	renderFacetOptions()	0	1	?
A	__construct()	0	14	1
B	renderFacet()	0	32	3
B	getFacetProperties()	0	25	4
A	getFacetOptions()	0	4	1
A	getFacetOptionsCount()	0	4	1
A	setTemplate()	0	4	1
A	setLinkTargetPageId()	0	5	1
B	buildResetFacetUrl()	0	26	4

<?php
namespace ApacheSolrForTypo3\Solr\Facet;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2011-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\LinkBuilder;

This use statement conflicts with another class in this namespace, ApacheSolrForTypo3\Solr\Facet\LinkBuilder.

use ApacheSolrForTypo3\Solr\Search;
use ApacheSolrForTypo3\Solr\System\Configuration\TypoScriptConfiguration;
use ApacheSolrForTypo3\Solr\Template;
use ApacheSolrForTypo3\Solr\Util;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;

/**
 * Facet renderer.
 *
 * @author Ingo Renner <ingo@typo3.org>
 */
abstract class AbstractFacetRenderer implements FacetRenderer
{

    /**
     * @var Search
     */
    protected $search;

    /**
     * The name of the facet being rendered
     *
     * @var string
     */
    protected $facetName;

    /**
     * The facet to render.
     *
     * @var Facet
     */
    protected $facet;

    /**
     * @var array
     */
    protected $facetConfiguration;

    /**
     * Configuration
     *
     * @var TypoScriptConfiguration
     */
    protected $solrConfiguration;

    /**
     * Template
     *
     * @var Template
     */
    protected $template = null;

    /**
     * Link target page id.
     *
     * @var int
     */
    protected $linkTargetPageId = 0;

    /**
     * Query link builder
     *
     * @var LinkBuilder
     */
    protected $queryLinkBuilder;

    /**
     * Constructor.
     *
     * @param Facet $facet The facet to render.
     */
    public function __construct(Facet $facet)
    {
        $this->search = GeneralUtility::makeInstance(Search::class);

        $this->facet = $facet;
        $this->facetName = $facet->getName();

        $this->solrConfiguration = Util::getSolrConfiguration();
        $this->facetConfiguration = $this->solrConfiguration->getSearchFacetingFacetByName($this->facetName);

        $this->linkTargetPageId = $GLOBALS['TSFE']->id;

        $this->queryLinkBuilder = GeneralUtility::makeInstance(LinkBuilder::class, $this->search->getQuery());
    }

    /**
     * Renders the complete facet.
     *
     * @return string Facet markup.
     */
    public function renderFacet()
    {
        // TODO must check whether $this->template is set

        $facetContent = '';

        $showEmptyFacets = $this->solrConfiguration->getSearchFacetingShowEmptyFacetsByName($this->facetName);

        // if the facet doesn't provide any options, don't render it unless
        // it is configured to be rendered nevertheless
        if (!$this->facet->isEmpty() || $showEmptyFacets) {
            $facetTemplate = clone $this->template;
            $facetTemplate->workOnSubpart('single_facet');

            $facetOptions = $this->renderFacetOptions();
            $facetTemplate->addSubpart('single_facet_option', $facetOptions);

            $facet = $this->getFacetProperties();

            // remove properties irrelevant for rendering in the template engine
            unset(
                $facet['renderingInstruction'],
                $facet['renderingInstruction.'],
                $facet[$facet['type'] . '.']
            );

            $facetTemplate->addVariable('facet', $facet);
            $facetContent = $facetTemplate->render();
        }

        return $facetContent;
    }

    /**
     * Renders a numeric range facet by providing a slider
     *
     * @return string
     */
    abstract protected function renderFacetOptions();

    /**
     * (non-PHPdoc)
     * @see \ApacheSolrForTypo3\Solr\Facet\FacetRenderer::getFacetProperties()
     */
    public function getFacetProperties()
    {
        $facet = $this->facetConfiguration;

        // TODO move these properties into ApacheSolrForTypo3\Solr\Facet\Facet and provide them via ArrayAccess interface

        $facet['name'] = $this->facetName;
        $facet['count'] = $this->getFacetOptionsCount();
        $facet['active'] = $this->facet->isActive() ? '1' : '0';
        $facet['empty'] = $this->facet->isEmpty() ? '1' : '0';
        $facet['reset_url'] = $this->buildResetFacetUrl();

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

        $facet['type'] = 'default';
        if (!empty($this->facetConfiguration['type'])) {
            $facet['type'] = $this->facetConfiguration['type'];
        }

        return $facet;
    }

    /**
     * (non-PHPdoc)
     * @see \ApacheSolrForTypo3\Solr\Facet\FacetRenderer::getFacetOptions()
     */
    public function getFacetOptions()
    {
        return $this->facet->getOptionsRaw();
    }

    /**
     * (non-PHPdoc)
     * @see \ApacheSolrForTypo3\Solr\Facet\FacetRenderer::getFacetOptionsCount()
     */
    public function getFacetOptionsCount()
    {
        return $this->facet->getOptionsCount();
    }

    /**
     * (non-PHPdoc)
     * @see \ApacheSolrForTypo3\Solr\Facet\FacetRenderer::setTemplate()
     * @param Template $template
     */
    public function setTemplate(Template $template)
    {
        $this->template = $template;
    }

    /**
     * (non-PHPdoc)
     * @see \ApacheSolrForTypo3\Solr\Facet\FacetRenderer::setLinkTargetPageId()
     * @param int $linkTargetPageId
     */
    public function setLinkTargetPageId($linkTargetPageId)
    {
        $this->linkTargetPageId = intval($linkTargetPageId);
        $this->queryLinkBuilder->setLinkTargetPageId($this->linkTargetPageId);
    }

    /**
     * Builds the URL to reset all options of a facet - removing all its applied
     * filters from a result set.
     *
     * @return string  Url to remove a facet
     */
    protected function buildResetFacetUrl()
    {
        $resultParameters = GeneralUtility::_GPmerged('tx_solr');

        if (is_array($resultParameters['filter'])) {
            // urldecode the array to get the original representation
            $filterParameters = array_values((array)array_map('urldecode',
                $resultParameters['filter']));
            $filterParameters = array_unique($filterParameters);

            // find and remove all options for this facet
            foreach ($filterParameters as $key => $filter) {
                list($filterName, $filterValue) = explode(':', $filter);

The assignment to $filterValue is unused. Consider omitting it like so list($first,,$third).

                if ($filterName == $this->facetName) {
                    unset($filterParameters[$key]);
                }
            }
            $filterParameters = array_map('urlencode', $filterParameters);

            $resetFacetUrl = $this->queryLinkBuilder->getQueryUrl(['filter' => $filterParameters]);
        } else {
            $resetFacetUrl = $this->queryLinkBuilder->getQueryUrl();
        }

        return $resetFacetUrl;
    }
}