AbstractPlugin::pi_linkTP() - Code Metrics - Inspection of "Merge pull request #506 from sebastian-meyer/allow..." - kitodo/kitodo-presentation - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c2a726...77fa83 )

by Sebastian

created 2020-04-24 15:17 UTC

AbstractPlugin::pi_linkTP() B

↳ Parent: AbstractPlugin

Complexity

Conditions	7
Paths	16

Size

Total Lines	12
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	8
c	0
b	0
f	0
dl	0
loc	12
rs	8.8333
cc	7
nc	16
nop	4

<?php

/**
 * (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.
 */

namespace Kitodo\Dlf\Common;

use TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Service\MarkerBasedTemplateService;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\HttpUtility;

/**
 * Abstract plugin class for the 'dlf' extension
 *
 * @author Sebastian Meyer <[email protected]>
 * @package TYPO3
 * @subpackage dlf
 * @access public
 * @abstract
 */
abstract class AbstractPlugin extends \TYPO3\CMS\Frontend\Plugin\AbstractPlugin
filter:
    dependency_paths: ["lib/*"]
{
    public $extKey = 'dlf';
    public $prefixId = 'tx_dlf';
    public $scriptRelPath = 'Classes/Common/AbstractPlugin.php';
    // Plugins are cached by default (@see setCache()).
    public $pi_USER_INT_obj = false;
    public $pi_checkCHash = true;

    /**
     * This holds the current document
     *
     * @var \Kitodo\Dlf\Common\Document
     * @access protected
     */
    protected $doc;

    /**
     * This holds the plugin's parsed template
     *
     * @var string
     * @access protected
     */
    protected $template = '';

    /**
     * This holds the plugin's service for template
     *
     * @var \TYPO3\CMS\Core\Service\MarkerBasedTemplateService
     * @access protected
     */
    protected $templateService;

    /**
     * Read and parse the template file
     *
     * @access protected
     *
     * @param string $part: Name of the subpart to load
     *
     * @return void
     */
    protected function getTemplate($part = '###TEMPLATE###')
    {
        $this->templateService = GeneralUtility::makeInstance(MarkerBasedTemplateService::class);
        if (!empty($this->conf['templateFile'])) {
            // Load template file from configuration.
            $templateFile = $this->conf['templateFile'];
        } else {
            // Load default template from extension.
            $templateFile = 'EXT:' . $this->extKey . '/Resources/Private/Templates/' . Helper::getUnqualifiedClassName(get_class($this)) . '.tmpl';
        }
        // Substitute strings like "EXT:" in given template file location.
        $fileResource = $GLOBALS['TSFE']->tmpl->getFileName($templateFile);
        $this->template = $this->templateService->getSubpart(file_get_contents($fileResource), $part);
    }

    /**
     * All the needed configuration values are stored in class variables
     * Priority: Flexforms > TS-Templates > Extension Configuration > ext_localconf.php
     *
     * @access protected
     *
     * @param array $conf: Configuration array from TS-Template
     *
     * @return void
     */
    protected function init(array $conf)
    {
        // Read FlexForm configuration.
        $flexFormConf = [];
        $this->cObj->readFlexformIntoConf($this->cObj->data['pi_flexform'], $flexFormConf);
        if (!empty($flexFormConf)) {
            $conf = Helper::mergeRecursiveWithOverrule($flexFormConf, $conf);
        }
        // Read plugin TS configuration.
        $pluginConf = $GLOBALS['TSFE']->tmpl->setup['plugin.']['tx_dlf_' . strtolower(Helper::getUnqualifiedClassName(get_class($this))) . '.'];
        if (is_array($pluginConf)) {
            $conf = Helper::mergeRecursiveWithOverrule($pluginConf, $conf);
        }
        // Read general TS configuration.
        $generalConf = $GLOBALS['TSFE']->tmpl->setup['plugin.'][$this->prefixId . '.'];
        if (is_array($generalConf)) {
            $conf = Helper::mergeRecursiveWithOverrule($generalConf, $conf);
        }
        // Read extension configuration.
        $extConf = unserialize($GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf'][$this->extKey]);
        if (is_array($extConf)) {
            $conf = Helper::mergeRecursiveWithOverrule($extConf, $conf);
        }
        // Read TYPO3_CONF_VARS configuration.
        $varsConf = $GLOBALS['TYPO3_CONF_VARS']['EXTCONF'][$this->extKey];
        if (is_array($varsConf)) {
            $conf = Helper::mergeRecursiveWithOverrule($varsConf, $conf);
        }
        $this->conf = $conf;

        // Set default plugin variables.
        $this->pi_setPiVarDefaults();
        // Load translation files.
        $this->pi_loadLL('EXT:' . $this->extKey . '/Resources/Private/Language/' . Helper::getUnqualifiedClassName(get_class($this)) . '.xml');
    }

    /**
     * Loads the current document into $this->doc
     *
     * @access protected
     *
     * @return void
     */
    protected function loadDocument()
    {
        // Check for required variable.
        if (
            !empty($this->piVars['id'])
            && !empty($this->conf['pages'])
        ) {
            // Should we exclude documents from other pages than $this->conf['pages']?
            $pid = (!empty($this->conf['excludeOther']) ? intval($this->conf['pages']) : 0);
            // Get instance of \Kitodo\Dlf\Common\Document.
            $this->doc = Document::getInstance($this->piVars['id'], $pid);
            if (!$this->doc->ready) {
                // Destroy the incomplete object.
                $this->doc = null;
                Helper::devLog('Failed to load document with UID ' . $this->piVars['id'], DEVLOG_SEVERITY_ERROR);
            } else {
                // Set configuration PID.
                $this->doc->cPid = $this->conf['pages'];
            }
        } elseif (!empty($this->piVars['recordId'])) {
            $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
                ->getQueryBuilderForTable('tx_dlf_documents');

            // Get UID of document with given record identifier.
            $result = $queryBuilder
                ->select('tx_dlf_documents.uid AS uid')
                ->from('tx_dlf_documents')
                ->where(
                    $queryBuilder->expr()->eq('tx_dlf_documents.record_id', $queryBuilder->expr()->literal($this->piVars['recordId'])),
                    Helper::whereExpression('tx_dlf_documents')
                )
                ->setMaxResults(1)
                ->execute();

            if ($resArray = $result->fetch()) {
                $this->piVars['id'] = $resArray['uid'];

                // Set superglobal $_GET array and unset variables to avoid infinite looping.
                $_GET[$this->prefixId]['id'] = $this->piVars['id'];
                unset($this->piVars['recordId'], $_GET[$this->prefixId]['recordId']);
                // Try to load document.
                $this->loadDocument();
            } else {
                Helper::devLog('Failed to load document with record ID "' . $this->piVars['recordId'] . '"', DEVLOG_SEVERITY_ERROR);
            }
        } else {
            Helper::devLog('Invalid UID ' . $this->piVars['id'] . ' or PID ' . $this->conf['pages'] . ' for document loading', DEVLOG_SEVERITY_ERROR);
        }
    }

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

    /**
     * Parses a string into a Typoscript array
     *
     * @access protected
     *
     * @param string $string: The string to parse
     *
     * @return array The resulting typoscript array
     */
    protected function parseTS($string = '')
    {
        $parser = GeneralUtility::makeInstance(\TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser::class);
        $parser->parse($string);
        return $parser->setup;
    }

    /**
     * Link string to the current page.
     * @see \TYPO3\CMS\Frontend\Plugin\AbstractPlugin->pi_linkTP()
     *
     * @access public
     *
     * @param string $str: The content string to wrap in <a> tags
     * @param array $urlParameters: Array with URL parameters as key/value pairs
     * @param bool $cache: Should the "no_cache" parameter be added?
     * @param int $altPageId: Alternative page ID for the link.
     *
     * @return string The input string wrapped in <a> tags
     */
    public function pi_linkTP($str, $urlParameters = [], $cache = false, $altPageId = 0)
    {
        $conf = [];
        if (!$cache) {
            $conf['no_cache'] = true;
        }
        $conf['parameter'] = $altPageId ?: ($this->pi_tmpPageId ?: 'current');
        $conf['additionalParams'] = $this->conf['parent.']['addParams'] . HttpUtility::buildQueryString($urlParameters, '&', true) . $this->pi_moreParams;
        // Add additional configuration for absolute URLs.
        $conf['forceAbsoluteUrl'] = !empty($this->conf['forceAbsoluteUrl']) ? 1 : 0;
        $conf['forceAbsoluteUrl.']['scheme'] = !empty($this->conf['forceAbsoluteUrl']) && !empty($this->conf['forceAbsoluteUrlHttps']) ? 'https' : 'http';
        return $this->cObj->typoLink($str, $conf);
    }

    /**
     * Wraps the input string in a <div> tag with the class attribute set to the class name
     * @see \TYPO3\CMS\Frontend\Plugin\AbstractPlugin->pi_wrapInBaseClass()
     *
     * @access public
     *
     * @param string $content: HTML content to wrap in the div-tags with the class of the plugin
     *
     * @return string HTML content wrapped, ready to return to the parent object.
     */
    public function pi_wrapInBaseClass($content)
    {
        if (!$this->frontendController->config['config']['disableWrapInBaseClass']) {
            // Use class name instead of $this->prefixId for content wrapping because $this->prefixId is the same for all plugins.
            $content = '<div class="tx-dlf-' . strtolower(Helper::getUnqualifiedClassName(get_class($this))) . '">' . $content . '</div>';
            if (!$this->frontendController->config['config']['disablePrefixComment']) {
                $content = "\n\n<!-- BEGIN: Content of extension '" . $this->extKey . "', plugin '" . Helper::getUnqualifiedClassName(get_class($this)) . "' -->\n\n" . $content . "\n\n<!-- END: Content of extension '" . $this->extKey . "', plugin '" . Helper::getUnqualifiedClassName(get_class($this)) . "' -->\n\n";
            }
        }
        return $content;
    }

    /**
     * Sets some configuration variables if the plugin is cached.
     *
     * @access protected
     *
     * @param bool $cache: Should the plugin be cached?
     *
     * @return void
     */
    protected function setCache($cache = true)
    {
        if ($cache) {
            // Set cObject type to "USER" (default).
            $this->pi_USER_INT_obj = false;
            $this->pi_checkCHash = true;
            if (count($this->piVars)) {
                // Check cHash or disable caching.
                $GLOBALS['TSFE']->reqCHash();
            }
        } else {
            // Set cObject type to "USER_INT".
            $this->pi_USER_INT_obj = true;
            $this->pi_checkCHash = false;
            // Plugins are of type "USER" by default, so convert it to "USER_INT".
            $this->cObj->convertToUserIntObject();
        }
    }
}


Scrutinizer GitHub App not installed

GitHub Access Token became invalid

Push — master ( c2a726...77fa83 )

AbstractPlugin::pi_linkTP() B

Complexity

Size

Duplication

Importance

1			<?php
2
3			/**
4			* (c) Kitodo. Key to digital objects e.V. <[email protected]>
5			*
6			* This file is part of the Kitodo and TYPO3 projects.
7			*
8			* @license GNU General Public License version 3 or later.
9			* For the full copyright and license information, please read the
10			* LICENSE.txt file that was distributed with this source code.
11			*/
12
13			namespace Kitodo\Dlf\Common;
14
15			use TYPO3\CMS\Core\Database\ConnectionPool;
16			use TYPO3\CMS\Core\Service\MarkerBasedTemplateService;
17			use TYPO3\CMS\Core\Utility\GeneralUtility;
18			use TYPO3\CMS\Core\Utility\HttpUtility;
19
20			/**
21			* Abstract plugin class for the 'dlf' extension
22			*
23			* @author Sebastian Meyer <[email protected]>
24			* @package TYPO3
25			* @subpackage dlf
26			* @access public
27			* @abstract
28			*/
29			abstract class AbstractPlugin extends \TYPO3\CMS\Frontend\Plugin\AbstractPlugin
			0 ignored issues – show Bug introduced 2017-12-20 10:07 UTC by Report Bug Copy Issue Report The type `TYPO3\CMS\Frontend\Plugin\AbstractPlugin` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
30			{
31			public $extKey = 'dlf';
32			public $prefixId = 'tx_dlf';
33			public $scriptRelPath = 'Classes/Common/AbstractPlugin.php';
34			// Plugins are cached by default (@see setCache()).
35			public $pi_USER_INT_obj = false;
36			public $pi_checkCHash = true;
37
38			/**
39			* This holds the current document
40			*
41			* @var \Kitodo\Dlf\Common\Document
42			* @access protected
43			*/
44			protected $doc;
45
46			/**
47			* This holds the plugin's parsed template
48			*
49			* @var string
50			* @access protected
51			*/
52			protected $template = '';
53
54			/**
55			* This holds the plugin's service for template
56			*
57			* @var \TYPO3\CMS\Core\Service\MarkerBasedTemplateService
58			* @access protected
59			*/
60			protected $templateService;
61
62			/**
63			* Read and parse the template file
64			*
65			* @access protected
66			*
67			* @param string $part: Name of the subpart to load
68			*
69			* @return void
70			*/
71			protected function getTemplate($part = '###TEMPLATE###')
72			{
73			$this->templateService = GeneralUtility::makeInstance(MarkerBasedTemplateService::class);
74			if (!empty($this->conf['templateFile'])) {
75			// Load template file from configuration.
76			$templateFile = $this->conf['templateFile'];
77			} else {
78			// Load default template from extension.
79			$templateFile = 'EXT:' . $this->extKey . '/Resources/Private/Templates/' . Helper::getUnqualifiedClassName(get_class($this)) . '.tmpl';
80			}
81			// Substitute strings like "EXT:" in given template file location.
82			$fileResource = $GLOBALS['TSFE']->tmpl->getFileName($templateFile);
83			$this->template = $this->templateService->getSubpart(file_get_contents($fileResource), $part);
84			}
85
86			/**
87			* All the needed configuration values are stored in class variables
88			* Priority: Flexforms > TS-Templates > Extension Configuration > ext_localconf.php
89			*
90			* @access protected
91			*
92			* @param array $conf: Configuration array from TS-Template
93			*
94			* @return void
95			*/
96			protected function init(array $conf)
97			{
98			// Read FlexForm configuration.
99			$flexFormConf = [];
100			$this->cObj->readFlexformIntoConf($this->cObj->data['pi_flexform'], $flexFormConf);
101			if (!empty($flexFormConf)) {
102			$conf = Helper::mergeRecursiveWithOverrule($flexFormConf, $conf);
103			}
104			// Read plugin TS configuration.
105			$pluginConf = $GLOBALS['TSFE']->tmpl->setup['plugin.']['tx_dlf_' . strtolower(Helper::getUnqualifiedClassName(get_class($this))) . '.'];
106			if (is_array($pluginConf)) {
107			$conf = Helper::mergeRecursiveWithOverrule($pluginConf, $conf);
108			}
109			// Read general TS configuration.
110			$generalConf = $GLOBALS['TSFE']->tmpl->setup['plugin.'][$this->prefixId . '.'];
111			if (is_array($generalConf)) {
112			$conf = Helper::mergeRecursiveWithOverrule($generalConf, $conf);
113			}
114			// Read extension configuration.
115			$extConf = unserialize($GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf'][$this->extKey]);
116			if (is_array($extConf)) {
117			$conf = Helper::mergeRecursiveWithOverrule($extConf, $conf);
118			}
119			// Read TYPO3_CONF_VARS configuration.
120			$varsConf = $GLOBALS['TYPO3_CONF_VARS']['EXTCONF'][$this->extKey];
121			if (is_array($varsConf)) {
122			$conf = Helper::mergeRecursiveWithOverrule($varsConf, $conf);
123			}
124			$this->conf = $conf;
			0 ignored issues – show Bug Best Practice introduced 2017-12-20 10:07 UTC by Report Bug Copy Issue Report The property `conf` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
125			// Set default plugin variables.
126			$this->pi_setPiVarDefaults();
127			// Load translation files.
128			$this->pi_loadLL('EXT:' . $this->extKey . '/Resources/Private/Language/' . Helper::getUnqualifiedClassName(get_class($this)) . '.xml');
129			}
130
131			/**
132			* Loads the current document into $this->doc
133			*
134			* @access protected
135			*
136			* @return void
137			*/
138			protected function loadDocument()
139			{
140			// Check for required variable.
141			if (
142			!empty($this->piVars['id'])
143			&& !empty($this->conf['pages'])
144			) {
145			// Should we exclude documents from other pages than $this->conf['pages']?
146			$pid = (!empty($this->conf['excludeOther']) ? intval($this->conf['pages']) : 0);
147			// Get instance of \Kitodo\Dlf\Common\Document.
148			$this->doc = Document::getInstance($this->piVars['id'], $pid);
149			if (!$this->doc->ready) {
150			// Destroy the incomplete object.
151			$this->doc = null;
152			Helper::devLog('Failed to load document with UID ' . $this->piVars['id'], DEVLOG_SEVERITY_ERROR);
153			} else {
154			// Set configuration PID.
155			$this->doc->cPid = $this->conf['pages'];
156			}
157			} elseif (!empty($this->piVars['recordId'])) {
158			$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
159			->getQueryBuilderForTable('tx_dlf_documents');
160
161			// Get UID of document with given record identifier.
162			$result = $queryBuilder
163			->select('tx_dlf_documents.uid AS uid')
164			->from('tx_dlf_documents')
165			->where(
166			$queryBuilder->expr()->eq('tx_dlf_documents.record_id', $queryBuilder->expr()->literal($this->piVars['recordId'])),
167			Helper::whereExpression('tx_dlf_documents')
168			)
169			->setMaxResults(1)
170			->execute();
171
172			if ($resArray = $result->fetch()) {
173			$this->piVars['id'] = $resArray['uid'];
			0 ignored issues – show Bug Best Practice introduced 2020-04-24 15:16 UTC by Report Bug Copy Issue Report The property `piVars` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
174			// Set superglobal $_GET array and unset variables to avoid infinite looping.
175			$_GET[$this->prefixId]['id'] = $this->piVars['id'];
176			unset($this->piVars['recordId'], $_GET[$this->prefixId]['recordId']);
177			// Try to load document.
178			$this->loadDocument();
179			} else {
180			Helper::devLog('Failed to load document with record ID "' . $this->piVars['recordId'] . '"', DEVLOG_SEVERITY_ERROR);
181			}
182			} else {
183			Helper::devLog('Invalid UID ' . $this->piVars['id'] . ' or PID ' . $this->conf['pages'] . ' for document loading', DEVLOG_SEVERITY_ERROR);
184			}
185			}
186
187			/**
188			* The main method of the PlugIn
189			*
190			* @access public
191			*
192			* @param string $content: The PlugIn content
193			* @param array $conf: The PlugIn configuration
194			*
195			* @abstract
196			*
197			* @return string The content that is displayed on the website
198			*/
199			abstract public function main($content, $conf);
200
201			/**
202			* Parses a string into a Typoscript array
203			*
204			* @access protected
205			*
206			* @param string $string: The string to parse
207			*
208			* @return array The resulting typoscript array
209			*/
210			protected function parseTS($string = '')
211			{
212			$parser = GeneralUtility::makeInstance(\TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser::class);
213			$parser->parse($string);
214			return $parser->setup;
215			}
216
217			/**
218			* Link string to the current page.
219			* @see \TYPO3\CMS\Frontend\Plugin\AbstractPlugin->pi_linkTP()
220			*
221			* @access public
222			*
223			* @param string $str: The content string to wrap in <a> tags
224			* @param array $urlParameters: Array with URL parameters as key/value pairs
225			* @param bool $cache: Should the "no_cache" parameter be added?
226			* @param int $altPageId: Alternative page ID for the link.
227			*
228			* @return string The input string wrapped in <a> tags
229			*/
230			public function pi_linkTP($str, $urlParameters = [], $cache = false, $altPageId = 0)
231			{
232			$conf = [];
233			if (!$cache) {
234			$conf['no_cache'] = true;
235			}
236			$conf['parameter'] = $altPageId ?: ($this->pi_tmpPageId ?: 'current');
237			$conf['additionalParams'] = $this->conf['parent.']['addParams'] . HttpUtility::buildQueryString($urlParameters, '&', true) . $this->pi_moreParams;
238			// Add additional configuration for absolute URLs.
239			$conf['forceAbsoluteUrl'] = !empty($this->conf['forceAbsoluteUrl']) ? 1 : 0;
240			$conf['forceAbsoluteUrl.']['scheme'] = !empty($this->conf['forceAbsoluteUrl']) && !empty($this->conf['forceAbsoluteUrlHttps']) ? 'https' : 'http';
241			return $this->cObj->typoLink($str, $conf);
242			}
243
244			/**
245			* Wraps the input string in a <div> tag with the class attribute set to the class name
246			* @see \TYPO3\CMS\Frontend\Plugin\AbstractPlugin->pi_wrapInBaseClass()
247			*
248			* @access public
249			*
250			* @param string $content: HTML content to wrap in the div-tags with the class of the plugin
251			*
252			* @return string HTML content wrapped, ready to return to the parent object.
253			*/
254			public function pi_wrapInBaseClass($content)
255			{
256			if (!$this->frontendController->config['config']['disableWrapInBaseClass']) {
257			// Use class name instead of $this->prefixId for content wrapping because $this->prefixId is the same for all plugins.
258			$content = '<div class="tx-dlf-' . strtolower(Helper::getUnqualifiedClassName(get_class($this))) . '">' . $content . '</div>';
259			if (!$this->frontendController->config['config']['disablePrefixComment']) {
260			$content = "\n\n<!-- BEGIN: Content of extension '" . $this->extKey . "', plugin '" . Helper::getUnqualifiedClassName(get_class($this)) . "' -->\n\n" . $content . "\n\n<!-- END: Content of extension '" . $this->extKey . "', plugin '" . Helper::getUnqualifiedClassName(get_class($this)) . "' -->\n\n";
261			}
262			}
263			return $content;
264			}
265
266			/**
267			* Sets some configuration variables if the plugin is cached.
268			*
269			* @access protected
270			*
271			* @param bool $cache: Should the plugin be cached?
272			*
273			* @return void
274			*/
275			protected function setCache($cache = true)
276			{
277			if ($cache) {
278			// Set cObject type to "USER" (default).
279			$this->pi_USER_INT_obj = false;
280			$this->pi_checkCHash = true;
281			if (count($this->piVars)) {
282			// Check cHash or disable caching.
283			$GLOBALS['TSFE']->reqCHash();
284			}
285			} else {
286			// Set cObject type to "USER_INT".
287			$this->pi_USER_INT_obj = true;
288			$this->pi_checkCHash = false;
289			// Plugins are of type "USER" by default, so convert it to "USER_INT".
290			$this->cObj->convertToUserIntObject();
291			}
292			}
293			}
294

kitodo / kitodo-presentation

Scrutinizer GitHub App not installed

GitHub Access Token became invalid

Push — master ( c2a726...77fa83 )

AbstractPlugin::pi_linkTP() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like