ApacheSolrForTypo3\Solr\Plugin\Results\SuggestFormModifier

Complexity

Total Complexity

12

Size/Duplication

Total Lines	125
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

74.58%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	setParentPlugin()	0	4	1
A	modifyForm()	0	19	2
A	addSuggestStylesheets()	0	9	3
A	addSuggestJavascript()	0	9	1
B	getSuggestEidUrl()	0	26	4

<?php
namespace ApacheSolrForTypo3\Solr\Plugin\Results;

/***************************************************************
 *  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\Plugin\CommandPluginAware;
use ApacheSolrForTypo3\Solr\Plugin\CommandPluginBase;
use ApacheSolrForTypo3\Solr\Plugin\FormModifier;
use ApacheSolrForTypo3\Solr\System\Configuration\TypoScriptConfiguration;
use ApacheSolrForTypo3\Solr\Template;
use ApacheSolrForTypo3\Solr\Util;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
 * Suggest form modifier, suggests queries through auto completion / AJAX.
 *
 * @author Ingo Renner <ingo@typo3.org>
 */
class SuggestFormModifier implements FormModifier, CommandPluginAware
{

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

    /**
     * The currently active plugin
     *
     * @var CommandPluginBase
     */
    protected $parentPlugin;

    /**
     * Constructor
     *
     */
    public function __construct()
    {
        $this->configuration = Util::getSolrConfiguration();
    }

    /**
     * Sets the currently active parent plugin.
     *
     * @param CommandPluginBase $parentPlugin Currently active parent plugin
     */
    public function setParentPlugin(CommandPluginBase $parentPlugin)
    {
        $this->parentPlugin = $parentPlugin;
    }

    /**
     * Modifies the search form by providing an additional marker providing the
     * suggest eID script URL and adding javascript to the page's header.
     *
     * @param array $markers An array of existing form markers
     * @param Template $template An instance of the template engine
     * @return array Array with additional markers for suggestions
     */
    public function modifyForm(array $markers, Template $template)
    {
        $suggestionsEnabled = $this->configuration->getSuggest();

        if ($suggestionsEnabled) {
            $this->addSuggestStylesheets();
            $this->addSuggestJavascript();
            $suggestEidUrl = $this->getSuggestEidUrl();

            $markers['suggest_url'] = '<script type="text/javascript">
				/*<![CDATA[*/
				var tx_solr_suggestUrl = \'' . $suggestEidUrl . '\';
				/*]]>*/
				</script>
			';
        }

        return $markers;
    }

    /**
     * Adds the stylesheets necessary for the suggestions
     *
     */
    protected function addSuggestStylesheets()
    {
        $uiCss = $this->configuration->getCssFileByFileKey('ui');
        if (trim($uiCss) !== '' && !$GLOBALS['TSFE']->additionalHeaderData['tx_solr-uiCss']) {
            $cssFile = GeneralUtility::createVersionNumberedFilename($GLOBALS['TSFE']->tmpl->getFileName($uiCss));
            $GLOBALS['TSFE']->additionalHeaderData['tx_solr-uiCss'] =
                '<link href="' . $cssFile . '" rel="stylesheet" type="text/css" media="all" />';
        }
    }

    /**
     * Adds the Javascript necessary for the suggestions
     *
     */
    protected function addSuggestJavascript()
    {
        $javascriptManager = $this->parentPlugin->getJavascriptManager();

        $javascriptManager->loadFile('library');
        $javascriptManager->loadFile('ui');
        $javascriptManager->loadFile('ui.autocomplete');
        $javascriptManager->loadFile('suggest');
    }

    /**
     * Returns the eID URL for the AJAX suggestion request.
     *
     * @author Mario Rimann <mario.rimann@internezzo.ch>
     * @return string the full URL to the eID script including the needed parameters
     */
    protected function getSuggestEidUrl()
    {
        $suggestUrl = GeneralUtility::getIndpEnv('TYPO3_SITE_URL');

        if ($this->configuration->getSuggestForceHttps()) {
            $suggestUrl = str_replace('http://', 'https://', $suggestUrl);
        }

        $suggestUrl .= '?eID=tx_solr_suggest&id=' . $GLOBALS['TSFE']->id;

        // add filters
        $additionalFilters = $this->parentPlugin->getSearchResultSetService()->getAdditionalFilters();
        if (!empty($additionalFilters)) {
            $additionalFilters = json_encode($additionalFilters);
            $additionalFilters = rawurlencode($additionalFilters);

            $suggestUrl .= '&filters=' . $additionalFilters;
        }

        // adds the language parameter to the suggest URL
        if ($GLOBALS['TSFE']->sys_language_uid > 0) {
            $suggestUrl .= '&L=' . $GLOBALS['TSFE']->sys_language_uid;
        }

        return $suggestUrl;
    }
}