EWW\Dpf\Plugins\RelatedListTool\RelatedListTool

Complexity

Total Complexity

14

Size/Duplication

Total Lines	143
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	main()	0	90	9
A	compareByOrderVolumeTitle()	0	5	1
A	getRelatedItems()	0	30	4

<?php

namespace EWW\Dpf\Plugins\RelatedListTool;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

/**
 * Plugin 'DPF: RElatedListTool' for the 'dlf / dpf' extension.
 *
 * @author    Sebastian Meyer <sebastian.meyer@slub-dresden.de>
 * @author    Alexander Bigga <alexander.bigga@slub-dresden.de>
 * @package    TYPO3
 * @subpackage    tx_dpf
 * @access    public
 */
class RelatedListTool extends \tx_dlf_plugin

The type tx_dlf_plugin was not found. Maybe you did not declare it correctly or list all dependencies?

{

    /**
     * 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);

        // get the tx_dpf.settings too
        // Flexform wins over TS
        $dpfTSconfig = $GLOBALS['TSFE']->tmpl->setup['plugin.']['tx_dpf.'];

        if (is_array($dpfTSconfig['settings.'])) {

            \TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule($dpfTSconfig['settings.'], $this->conf, true, false);

The type TYPO3\CMS\Core\Utility\ArrayUtility was not found. Maybe you did not declare it correctly or list all dependencies?

            $this->conf = $dpfTSconfig['settings.'];

The property conf does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        }

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

        if ($this->doc === null) {

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

        }

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

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

The property template does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        } else {

            $this->template = $this->cObj->getSubpart($this->cObj->fileResource('EXT:dpf/Classes/Plugins/RelatedListTool/template.tmpl'), '###TEMPLATE###');

        }

        $subpartArray['items'] = $this->cObj->getSubpart($this->template, '###ITEMS###');

$subpartArray was never initialized. Although not strictly required by PHP, it is generally a good practice to add $subpartArray = array(); before regardless.

        $relatedItems = $this->getRelatedItems();

        $content = '';

        if (!empty($relatedItems)) {
            foreach ($relatedItems as $key => $value) {
                // set link
                if ($value['type'] == 'local') {
                    $confApi = array(
                        'useCacheHash'     => 0,
                        'parameter'        => $this->conf['apiPid'],
                        'additionalParams' => '&tx_dpf[qid]=' . $value['docId'] . '&tx_dpf[action]=mets',
                        'forceAbsoluteUrl' => true,
                    );

                    $metsApiUrl = urlencode($this->cObj->typoLink_URL($confApi));

                    $conf = array(
                        'useCacheHash'     => 1,
                        'parameter'        => $GLOBALS['TSFE']->page['uid'],
                        'additionalParams' => '&tx_dlf[id]=' . $metsApiUrl,
                        'forceAbsoluteUrl' => true,
                    );

                } elseif ($value['type'] == 'urn') {
                    // use urn link
                    $conf = array(
                        'useCacheHash'     => 0,
                        'parameter'        => 'http://nbn-resolving.de/' . $value['docId'],
                        'forceAbsoluteUrl' => true,
                    );

                } else {

                    $conf = array(
                        'useCacheHash'     => 0,
                        'forceAbsoluteUrl' => true,
                    );

                }

                $title = $value['title'] ? $value['title'] : $value['docId'];

                // replace uid with URI to dpf API
                $markerArray['###ITEM###'] = $this->cObj->typoLink($title, $conf);

                $content .= $this->cObj->substituteMarkerArray($subpartArray['items'], $markerArray);

The variable $markerArray seems to be defined later in this foreach loop on line 123. Are you sure it is defined here?

            }
        }

        return $this->cObj->substituteSubpart($this->template, '###ITEMS###', $content, true);

    }

    private function compareByOrderVolumeTitle($a, $b)
    {
        $s1 = join(' ', array($a['order'], $a['volume'], $a['title']));
        $s2 = join(' ', array($b['order'], $b['volume'], $b['title']));
        return strnatcmp($s1, $s2);
    }

    public function getRelatedItems()
    {
        $xPath = '//mods:relatedItem[@type="constituent"]';

        $items = $this->doc->mets->xpath($xPath);

        $relatedItems = array();

        foreach ($items as $index => $relatedItemXmlElement) {
            $relatedItemXmlElement->registerXPathNamespace('mods', 'http://www.loc.gov/mods/v3');

            $type = (string) $relatedItemXmlElement->xpath('mods:identifier/@type')[0];
            $title = (string) $relatedItemXmlElement->xpath('mods:titleInfo/mods:title')[0];
            $docId = (string) $relatedItemXmlElement->xpath('mods:identifier[@type="' . $type . '"]')[0];
            $order = (string) $relatedItemXmlElement->xpath('mods:part/@order')[0];
            $volume = (string) $relatedItemXmlElement->xpath('mods:part[@type="volume" or @type="issue"]/mods:detail/mods:number')[0];

            $element = array();
            $element['type'] = $type;
            $element['title'] = $title;
            $element['docId'] = $docId;
            $element['order'] = (!empty($order)) ? $order : null;
            $element['volume'] = (!empty($volume)) ? $volume : null;

            $relatedItems[$index] = $element;
        }

        usort($relatedItems, array('EWW\Dpf\Plugins\RelatedListTool\RelatedListTool', 'compareByOrderVolumeTitle'));

        return $relatedItems;
    }

}