PdfDownloadTool::getWorkLink() - Code Metrics - Inspection of "Change namespaces to singular" - kitodo/kitodo-presentation - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 14584b...f60880 )

by Sebastian

created 2019-03-16 17:49 UTC

PdfDownloadTool::getWorkLink() A

↳ Parent: PdfDownloadTool

Complexity

Conditions	4
Paths	6

Size

Total Lines	18
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	12
nc	6
nop	0
dl	0
loc	18
rs	9.8666
c	0
b	0
f	0

<?php
namespace Kitodo\Dlf\Plugin\Tools;

/**
 * (c) Kitodo. Key to digital objects e.V. <[email protected]>
 *
 * 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.
 */

/**
 * PDF Download tool for the plugin 'Toolbox' of the 'dlf' extension
 *
 * @author Sebastian Meyer <[email protected]>
 * @author Alexander Bigga <[email protected]>
 * @package TYPO3
 * @subpackage dlf
 * @access public
 */
class PdfDownloadTool extends \Kitodo\Dlf\Common\AbstractPlugin {
    public $scriptRelPath = 'Classes/Plugin/Tools/PdfDownloadTool.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);
        // Merge configuration with conf array of toolbox.
        $this->conf = \TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule($this->cObj->data['conf'], $this->conf);
        $this->conf = \TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule($this->cObj->data['conf'], /** @scrutinizer ignore-type */ $this->conf);
        // Load current document.
        $this->loadDocument();
        if ($this->doc === NULL
            || $this->doc->numPages < 1

            || empty($this->conf['fileGrpDownload'])) {
            // 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);

            }
            $this->piVars['double'] = \TYPO3\CMS\Core\Utility\MathUtility::forceIntegerInRange($this->piVars['double'], 0, 1, 0);
        }
        // Load template file.
        $this->getTemplate();
        // Get single page downloads.
        $markerArray['###PAGE###'] = $this->getPageLink();

        // Get work download.
        $markerArray['###WORK###'] = $this->getWorkLink();
        $content .= $this->cObj->substituteMarkerArray($this->template, $markerArray);
        $content .= /** @scrutinizer ignore-deprecated */ $this->cObj->substituteMarkerArray($this->template, $markerArray);
        return $this->pi_wrapInBaseClass($content);
    }

    /**
     * Get page's download link
     *
     * @access protected
     *
     * @return string Link to downloadable page
     */
    protected function getPageLink() {
        $page1Link = '';
        $page2Link = '';
        $pageNumber = $this->piVars['page'];
        // Get image link.
        $details = $this->doc->physicalStructureInfo[$this->doc->physicalStructure[$pageNumber]];

        $file = $details['files'][$this->conf['fileGrpDownload']];
        if (!empty($file)) {
            $page1Link = $this->doc->getFileLocation($file);
        }
        // Get second page, too, if double page view is activated.
        if ($this->piVars['double']
            && $pageNumber < $this->doc->numPages) {

            $details = $this->doc->physicalStructureInfo[$this->doc->physicalStructure[$pageNumber + 1]];
            $file = $details['files'][$this->conf['fileGrpDownload']];
            if (!empty($file)) {
                $page2Link = $this->doc->getFileLocation($file);
            }
        }
        if (empty($page1Link)
            && empty($page2Link)) {
            Helper::devLog('File not found in fileGrp "'.$this->conf['fileGrpDownload'].'"', DEVLOG_SEVERITY_WARNING);
filter:
    dependency_paths: ["lib/*"]
        }
        // Wrap URLs with HTML.
        if (!empty($page1Link)) {
            if ($this->piVars['double']) {
                $page1Link = $this->cObj->typoLink($this->pi_getLL('leftPage', ''), ['parameter' => $page1Link, 'title' => $this->pi_getLL('leftPage', '')]);
            } else {
                $page1Link = $this->cObj->typoLink($this->pi_getLL('singlePage', ''), ['parameter' => $page1Link, 'title' => $this->pi_getLL('singlePage', '')]);
            }
        }
        if (!empty($page2Link)) {
            $page2Link = $this->cObj->typoLink($this->pi_getLL('rightPage', ''), ['parameter' => $page2Link, 'title' => $this->pi_getLL('rightPage', '')]);
        }
        return $page1Link.$page2Link;
    }

    /**
     * Get work's download link
     *
     * @access protected
     *
     * @return string Link to downloadable work
     */
    protected function getWorkLink() {
        $workLink = '';
        // Get work link.
        if (!empty($this->doc->physicalStructureInfo[$this->doc->physicalStructure[0]]['files'][$this->conf['fileGrpDownload']])) {

            $workLink = $this->doc->getFileLocation($this->doc->physicalStructureInfo[$this->doc->physicalStructure[0]]['files'][$this->conf['fileGrpDownload']]);
        } else {
            $details = $this->doc->getLogicalStructure($this->doc->toplevelId);

            if (!empty($details['files'][$this->conf['fileGrpDownload']])) {
                $workLink = $this->doc->getFileLocation($details['files'][$this->conf['fileGrpDownload']]);
            }
        }
        // Wrap URLs with HTML.
        if (!empty($workLink)) {
            $workLink = $this->cObj->typoLink($this->pi_getLL('work', ''), ['parameter' => $workLink, 'title' => $this->pi_getLL('work', '')]);
        } else {
            Helper::devLog('File not found in fileGrp "'.$this->conf['fileGrpDownload'].'"', DEVLOG_SEVERITY_WARNING);
        }
        return $workLink;
    }
}


Scrutinizer GitHub App not installed

GitHub Access Token became invalid

Push — master ( 14584b...f60880 )

PdfDownloadTool::getWorkLink() A

Complexity

Size

Duplication

Importance

kitodo / kitodo-presentation

Scrutinizer GitHub App not installed

GitHub Access Token became invalid

Push — master ( 14584b...f60880 )

PdfDownloadTool::getWorkLink() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like