Kitodo\Dlf\Plugin\Metadata

Complexity

Total Complexity

58

Size/Duplication

Total Lines	228
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
D	main()	0	72	20
F	printMetadata()	0	124	38

<?php
namespace Kitodo\Dlf\Plugin;

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

use Kitodo\Dlf\Common\Document;
use Kitodo\Dlf\Common\Helper;

/**
 * Plugin 'Metadata' for the 'dlf' extension
 *
 * @author Sebastian Meyer <sebastian.meyer@slub-dresden.de>
 * @author Siegfried Schweizer <siegfried.schweizer@sbb.spk-berlin.de>
 * @package TYPO3
 * @subpackage dlf
 * @access public
 */
class Metadata extends \Kitodo\Dlf\Common\AbstractPlugin {
    public $scriptRelPath = 'Classes/Plugin/Metadata.php';

    /**
     * This holds the hook objects
     *
     * @var array
     * @access protected
     */
    protected $hookObjects = [];

    /**
     * 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);
        // Turn cache on.
        $this->setCache(TRUE);
        // Load current document.
        $this->loadDocument();
        if ($this->doc === NULL) {
            // Quit without doing anything if required variables are not set.
            return $content;
        } else {
            // Set default values if not set.
            if (!isset($this->conf['rootline'])) {
                $this->conf['rootline'] = 0;
            }
        }
        $metadata = [];
        if ($this->conf['rootline'] < 2) {
            // Get current structure's @ID.
            $ids = [];
            if (!empty($this->doc->physicalStructure[$this->piVars['page']]) && !empty($this->doc->smLinks['p2l'][$this->doc->physicalStructure[$this->piVars['page']]])) {

The property $smLinks is declared protected in Kitodo\Dlf\Common\Document. Since you implement __get, consider adding a @property or @property-read.

The property $physicalStructure is declared protected in Kitodo\Dlf\Common\Document. Since you implement __get, consider adding a @property or @property-read.

                foreach ($this->doc->smLinks['p2l'][$this->doc->physicalStructure[$this->piVars['page']]] as $logId) {
                    $count = count($this->doc->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="'.$logId.'"]/ancestor::*'));

The property $mets is declared protected in Kitodo\Dlf\Common\Document. Since you implement __get, consider adding a @property or @property-read.

                    $ids[$count][] = $logId;
                }
            }
            ksort($ids);
            reset($ids);
            // Check if we should display all metadata up to the root.
            if ($this->conf['rootline'] == 1) {
                foreach ($ids as $id) {
                    foreach ($id as $sid) {
                        $data = $this->doc->getMetadata($sid, $this->conf['pages']);
                        if (!empty($data)) {
                            $data['_id'] = $sid;
                            $metadata[] = $data;
                        }
                    }
                }
            } else {
                $id = array_pop($ids);
                if (is_array($id)) {
                    foreach ($id as $sid) {
                        $data = $this->doc->getMetadata($sid, $this->conf['pages']);
                        if (!empty($data)) {
                            $data['_id'] = $sid;
                            $metadata[] = $data;
                        }
                    }
                }
            }
        }
        // Get titledata?
        if (empty($metadata) || ($this->conf['rootline'] == 1 && $metadata[0]['_id'] != $this->doc->toplevelId)) {

The property $toplevelId is declared protected in Kitodo\Dlf\Common\Document. Since you implement __get, consider adding a @property or @property-read.

            $data = $this->doc->getTitleData($this->conf['pages']);
            $data['_id'] = $this->doc->toplevelId;
            array_unshift($metadata, $data);
        }
        if (empty($metadata)) {
            Helper::devLog('No metadata found for document with UID '.$this->doc->uid, DEVLOG_SEVERITY_WARNING);

The property $uid is declared protected in Kitodo\Dlf\Common\Document. Since you implement __get, consider adding a @property or @property-read.

            return $content;
        }
        ksort($metadata);
        // Get hook objects.
        $this->hookObjects = Helper::getHookObjects($this->scriptRelPath);
        // Hook for getting a customized title bar (requested by SBB).
        foreach ($this->hookObjects as $hookObj) {
            if (method_exists($hookObj, 'main_customizeTitleBarGetCustomTemplate')) {
                $hookObj->main_customizeTitleBarGetCustomTemplate($this, $metadata);
            }
        }
        $content .= $this->printMetadata($metadata);
        return $this->pi_wrapInBaseClass($content);
    }

    /**
     * Prepares the metadata array for output
     *
     * @access protected
     *
     * @param array $metadataArray: The metadata array
     *
     * @return string The metadata array ready for output
     */
    protected function printMetadata(array $metadataArray) {
        // Load template file.
        $this->getTemplate();
        $output = '';
        $subpart['block'] = $this->cObj->getSubpart($this->template, '###BLOCK###');

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

The function TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getSubpart() has been deprecated: since TYPO3 v8, will be removed in TYPO3 v9, please use the MarkerBasedTemplateService instead.

        // Get list of metadata to show.
        $metaList = [];
        $result = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
            'tx_dlf_metadata.index_name AS index_name,tx_dlf_metadata.is_listed AS is_listed,tx_dlf_metadata.wrap AS wrap,tx_dlf_metadata.sys_language_uid AS sys_language_uid',
            'tx_dlf_metadata',
            'tx_dlf_metadata.pid='.intval($this->conf['pages'])
                .' AND (sys_language_uid IN (-1,0) OR (sys_language_uid = '.$GLOBALS['TSFE']->sys_language_uid.' AND l18n_parent = 0))'
                .Helper::whereClause('tx_dlf_metadata'),
            '',
            'tx_dlf_metadata.sorting',
            ''
        );
        while ($resArray = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($result)) {
            if (is_array($resArray) && $resArray['sys_language_uid'] != $GLOBALS['TSFE']->sys_language_content && $GLOBALS['TSFE']->sys_language_contentOL) {
                $resArray = $GLOBALS['TSFE']->sys_page->getRecordOverlay('tx_dlf_metadata', $resArray, $GLOBALS['TSFE']->sys_language_content, $GLOBALS['TSFE']->sys_language_contentOL);
            }
            if ($resArray) {
                if ($this->conf['showFull'] || $resArray['is_listed']) {
                    $metaList[$resArray['index_name']] = [
                        'wrap' => $resArray['wrap'],
                        'label' => Helper::translate($resArray['index_name'], 'tx_dlf_metadata', $this->conf['pages'])
                    ];
                }
            }
        }
        // Get list of collections to show.
        $collList = [];
        $result = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
            'tx_dlf_collections.index_name AS index_name',
            'tx_dlf_collections',
            'tx_dlf_collections.pid='.intval($this->conf['pages'])
                .Helper::whereClause('tx_dlf_collections'),
            '',
            '',
            ''
        );
        while ($resArray = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($result)) {
            $collList[] = $resArray['index_name'];
        }
        // Save original data array.
        $cObjData = $this->cObj->data;
        // Parse the metadata arrays.
        foreach ($metadataArray as $metadata) {
            $markerArray['###METADATA###'] = '';
            // Reset content object's data array.
            $this->cObj->data = $cObjData;
            // Load all the metadata values into the content object's data array.
            foreach ($metadata as $index_name => $value) {
                if (is_array($value)) {
                    $this->cObj->data[$index_name] = implode($this->conf['separator'], $value);
                } else {
                    $this->cObj->data[$index_name] = $value;
                }
            }
            // Process each metadate.
            foreach ($metaList as $index_name => $metaConf) {
                if (!empty($metadata[$index_name])) {
                    $parsedValue = '';
                    $fieldwrap = $this->parseTS($metaConf['wrap']);
                    do {
                        $value = @array_shift($metadata[$index_name]);
                        if ($index_name == 'title') {
                            // Get title of parent document if needed.
                            if (empty($value) && $this->conf['getTitle'] && $this->doc->parentId) {

The property $parentId is declared protected in Kitodo\Dlf\Common\Document. Since you implement __get, consider adding a @property or @property-read.

                                $superiorTitle = Document::getTitle($this->doc->parentId, TRUE);
                                if (!empty($superiorTitle)) {
                                    $value = '['.$superiorTitle.']';
                                }
                            }
                            if (!empty($value)) {
                                $value = htmlspecialchars($value);
                                // Link title to pageview.
                                if ($this->conf['linkTitle'] && $metadata['_id']) {
                                    $details = $this->doc->getLogicalStructure($metadata['_id']);
                                    $value = $this->pi_linkTP($value, [$this->prefixId => ['id' => $this->doc->uid, 'page' => (!empty($details['points']) ? intval($details['points']) : 1)]], TRUE, $this->conf['targetPid']);

The property $uid is declared protected in Kitodo\Dlf\Common\Document. Since you implement __get, consider adding a @property or @property-read.

                                }
                            }
                        } elseif ($index_name == 'owner' && !empty($value)) {
                            // Translate name of holding library.
                            $value = htmlspecialchars(Helper::translate($value, 'tx_dlf_libraries', $this->conf['pages']));
                        } elseif ($index_name == 'type' && !empty($value)) {
                            // Translate document type.
                            $value = htmlspecialchars(Helper::translate($value, 'tx_dlf_structures', $this->conf['pages']));
                        } elseif ($index_name == 'collection' && !empty($value)) {
                            // Check if collections isn't hidden.
                            if (in_array($value, $collList)) {
                                // Translate collection.
                                $value = htmlspecialchars(Helper::translate($value, 'tx_dlf_collections', $this->conf['pages']));
                            } else {
                                $value = '';
                            }
                        } elseif ($index_name == 'language' && !empty($value)) {
                            // Translate ISO 639 language code.
                            $value = htmlspecialchars(Helper::getLanguageName($value));
                        } elseif (!empty($value)) {
                            // Sanitize value for output.
                            $value = htmlspecialchars($value);
                        }
                        // Hook for getting a customized value (requested by SBB).
                        foreach ($this->hookObjects as $hookObj) {
                            if (method_exists($hookObj, 'printMetadata_customizeMetadata')) {
                                $hookObj->printMetadata_customizeMetadata($value);
                            }
                        }
                        $value = $this->cObj->stdWrap($value, $fieldwrap['value.']);
                        if (!empty($value)) {
                            $parsedValue .= $value;
                        }
                    } while (count($metadata[$index_name]));
                    if (!empty($parsedValue)) {
                        $field = $this->cObj->stdWrap(htmlspecialchars($metaConf['label']), $fieldwrap['key.']);
                        $field .= $parsedValue;
                        $markerArray['###METADATA###'] .= $this->cObj->stdWrap($field, $fieldwrap['all.']);
                    }
                }
            }
            $output .= $this->cObj->substituteMarkerArray($subpart['block'], $markerArray);

The function TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::substituteMarkerArray() has been deprecated: since TYPO3 v8, will be removed in TYPO3 v9, please use the MarkerBasedTemplateService instead.

        }
        return $this->cObj->substituteSubpart($this->template, '###BLOCK###', $output, TRUE);

The function TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::substituteSubpart() has been deprecated: since TYPO3 v8, will be removed in TYPO3 v9, please use the MarkerBasedTemplateService instead.

    }
}