tx_dlf_toolsSearchindocument

Complexity

Total Complexity

16

Size/Duplication

Total Lines	133
Duplicated Lines	0 %

Importance

Changes	3
Bugs	1	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	addSearchInDocumentJS()	0	3	1
A	getEncryptedCoreName()	0	8	2
C	main()	0	90	13

<?php
/**
 * (c) Kitodo. Key to digital objects e.V. <contact@kitodo.org>
 *
 * This file is part of the Kitodo and TYPO3 projects.
 *
 * @license GNU General Public License version 3 or later.
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 */

/**
 * SearchInDocument tool for the plugin 'Toolbox' of the 'dlf' extension
 *
 * @author	Alexander Bigga <alexander.bigga@slub-dresden.de>
 * @package	TYPO3
 * @subpackage	tx_dlf
 * @access	public
 */
class tx_dlf_toolsSearchindocument extends tx_dlf_plugin {

    public $scriptRelPath = 'plugins/toolbox/tools/searchindocument/class.tx_dlf_toolsSearchindocument.php';

    /**
     * The main method of the PlugIn
     *
     * @access	public
     *
     * @param	string		$content: The PlugIn content
     * @param	array		$conf: The PlugIn configuration
     *
     * @return	string		The content that is displayed on the website
     */
    public function main($content, $conf) {

        $this->init($conf);

        if (!empty($this->cObj->data['conf'])) {
            // Merge configuration with conf array of toolbox.
            $this->conf = tx_dlf_helper::array_merge_recursive_overrule($this->cObj->data['conf'], $this->conf);
        }

        $this->addSearchInDocumentJS();

        // Load current document.
        $this->loadDocument();

        if ($this->doc === NULL || $this->doc->numPages < 1 || empty($this->conf['fileGrpFulltext']) || empty($this->conf['solrcore'])) {

The property $numPages is declared protected in tx_dlf_document. Since you implement __get, consider adding a @property or @property-read.

            // Quit without doing anything if required variables are not set.
            return $content;

        } else {

            if (!empty($this->piVars['logicalPage'])) {

                $this->piVars['page'] = $this->doc->getPhysicalPage($this->piVars['logicalPage']);
                // The logical page parameter should not appear again
                unset($this->piVars['logicalPage']);

            }

            // Set default values if not set.
            // $this->piVars['page'] may be integer or string (physical structure @ID)
            if ((int) $this->piVars['page'] > 0 || empty($this->piVars['page'])) {

                $this->piVars['page'] = \TYPO3\CMS\Core\Utility\MathUtility::forceIntegerInRange((int) $this->piVars['page'], 1, $this->doc->numPages, 1);

            } else {

                $this->piVars['page'] = array_search($this->piVars['page'], $this->doc->physicalStructure);

The property $physicalStructure is declared protected in tx_dlf_document. Since you implement __get, consider adding a @property or @property-read.

            }

        }

        // Quit if no fulltext file is present
        $fullTextFile = $this->doc->physicalStructureInfo[$this->doc->physicalStructure[$this->piVars['page']]]['files'][$this->conf['fileGrpFulltext']];

The property $physicalStructureInfo is declared protected in tx_dlf_document. Since you implement __get, consider adding a @property or @property-read.

        if (empty($fullTextFile)) {

            return $content;

        }

        // Load template file.
        if (!empty($this->conf['toolTemplateFile'])) {

            $this->template = $this->cObj->getSubpart($this->cObj->fileResource($this->conf['toolTemplateFile']), '###TEMPLATE###');

        } else {

            $this->template = $this->cObj->getSubpart($this->cObj->fileResource('EXT:dlf/plugins/toolbox/tools/searchindocument/template.tmpl'), '###TEMPLATE###');

        }

        // Configure @action URL for form.
        $linkConf = array(
            'parameter' => $GLOBALS['TSFE']->id,
            'forceAbsoluteUrl' => 1
        );

        $encryptedSolr = $this->getEncryptedCoreName();

        // Fill markers.
        $markerArray = array(
            '###ACTION_URL###' => $this->cObj->typoLink_URL($linkConf),
            '###LABEL_QUERY###' => $this->pi_getLL('label.query'),
            '###LABEL_DELETE_SEARCH###' => $this->pi_getLL('label.delete_search'),
            '###LABEL_LOADING###' => $this->pi_getLL('label.loading'),
            '###LABEL_SUBMIT###' => $this->pi_getLL('label.submit'),
            '###LABEL_SEARCH_IN_DOCUMENT###' => $this->pi_getLL('label.searchInDocument'),
            '###LABEL_NEXT###' => $this->pi_getLL('label.next'),
            '###LABEL_PREVIOUS###' => $this->pi_getLL('label.previous'),
            '###LABEL_PAGE###' => $this->pi_getLL('label.logicalPage'),
            '###CURRENT_DOCUMENT###' => $this->doc->uid,

The property $uid is declared protected in tx_dlf_document. Since you implement __get, consider adding a @property or @property-read.

            '###SOLR_ENCRYPTED###' => isset($encryptedSolr['encrypted']) ? $encryptedSolr['encrypted'] : '',
            '###SOLR_HASH###' => isset($encryptedSolr['hash']) ? $encryptedSolr['hash'] : '',
        );

        $content .= $this->cObj->substituteMarkerArray($this->template, $markerArray);

        return $this->pi_wrapInBaseClass($content);
    }

    /**
     * Adds the JS files necessary for search in document
     *
     * @access protected
     *
     * @return void
     */
    protected function addSearchInDocumentJS() {
        $pageRenderer = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Core\Page\PageRenderer::class);
        $pageRenderer->addJsFooterFile(\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::siteRelPath($this->extKey).'plugins/toolbox/tools/searchindocument/tx_dlf_search_in_document.js');
    }

    /**
     * Get the encrypted Solr core name
     *
     * @access protected
     *
     * @return array with encrypted core name and hash
     */
    protected function getEncryptedCoreName() {
        // Get core name.
        $name = tx_dlf_helper::getIndexName($this->conf['solrcore'], 'tx_dlf_solrcores');
        // Encrypt core name.
        if (!empty($name)) {
            $name = tx_dlf_helper::encrypt($name);
        }
        return $name;
    }
}