Kitodo\Dlf\Common\Document\Model3D

Complexity

Total Complexity

20

Size/Duplication

Total Lines	192
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	getDownloadLocation()	0	2	1
A	_getPhysicalStructure()	0	2	1
A	loadLocation()	0	9	2
A	_getToplevelId()	0	2	1
A	getFileLocation()	0	2	1
A	prepareMetadataArray()	0	2	1
A	getDocument()	0	3	1
A	_getThumbnail()	0	2	1
A	establishRecordId()	0	2	1
A	_getSmLinks()	0	2	1
A	setPreloadedDocument()	0	2	1
A	getFileMimeType()	0	2	1
A	getParentDocumentUidForSaving()	0	2	1
A	getMetadata()	0	23	3
A	init()	0	8	2
A	getLogicalStructure()	0	2	1

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

namespace Kitodo\Dlf\Common\Document;

use Kitodo\Dlf\Format\Item;

The type Kitodo\Dlf\Format\Item was not found. Maybe you did not declare it correctly or list all dependencies?

use TYPO3\CMS\Core\Configuration\ExtensionConfiguration;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
 * Model3D class for the 'dlf' extension.
 *
 * @author Beatrycze Volk <beatrycze.volk@slub-dresden.de>
 * @package TYPO3
 * @subpackage dlf
 * @access public
 */
final class Model3D extends Document
{
    /**
     * The extension key
     *
     * @var string
     * @static
     * @access public
     */
    public static $extKey = 'dlf';

    /**
     * This holds the XML file's ITEM part as \SimpleXMLElement object
     *
     * @var \SimpleXMLElement
     * @access protected
     */
    protected $item;

    /**
     * {@inheritDoc}
     * @see Document::getDownloadLocation($id)
     */
    public function getDownloadLocation($id)
    {
        // Nothing to do here, at the moment
    }

    /**
     * {@inheritDoc}
     * @see Document::getFileLocation($id)
     */
    public function getFileLocation($id)
    {
        // Nothing to do here, at the moment
    }

    /**
     * {@inheritDoc}
     * @see Document::getFileMimeType($id)
     */
    public function getFileMimeType($id)
    {
        // Nothing to do here, at the moment
    }

    /**
     * {@inheritDoc}
     * @see Document::getFileLocation($id)
     */
    public function getLogicalStructure($id, $recursive = false)
    {
        // Nothing to do here, at the moment
    }

    /**
     * {@inheritDoc}
     * @see Document::getMetadata($id, $cPid = 0)
     */
    public function getMetadata($id, $cPid = 0)
    {
        // Get metadata from parsed metadata array if available.
        if (
            !empty($this->metadataArray[$id])
            && $this->metadataArray[0] == $cPid
        ) {
            return $this->metadataArray[$id];
        }
        // Initialize metadata array with empty values.
        $metadata = [
            'title' => [],
            'description' => [],
            'author' => [],
            'preview_image' => [],
            'upload' => [],
            'document_format' => ['ITEM']
        ];

        $item = GeneralUtility::makeInstance(Item::class);
        $item->extractMetadata($this->xml, $metadata);

        return $metadata;
    }

    /**
     * {@inheritDoc}
     * @see Document::establishRecordId($pid)
     */
    protected function establishRecordId($pid)
    {
        // Nothing to do here, at the moment
    }

    /**
     * {@inheritDoc}
     * @see Document::getDocument()
     */
    protected function getDocument()
    {
        return $this->item;
    }

    /**
     * {@inheritDoc}
     * @see Document::init()
     */
    protected function init()
    {
        // Get ITEM node from XML file.
        $item = $this->xml->xpath('/response/item[@key="0"]');
        if (!empty($item)) {
            $this->item = $item;

It seems like $item of type array<mixed,SimpleXMLElement> is incompatible with the declared type SimpleXMLElement of property $item.

        } else {
            $this->logger->error('No ITEM part found in document with UID ' . $this->uid);

The method error() does not exist on TYPO3\CMS\Core\Log\LogManager.

        }
    }

    /**
     * {@inheritDoc}
     * @see Document::loadLocation($location)
     */
    protected function loadLocation($location)
    {
        $xml = $this->loadXMLLocation($location);
        // Set some basic properties.
        if ($xml !== false) {
            $this->xml = $xml;

It seems like $xml of type string or true is incompatible with the declared type SimpleXMLElement of property $xml.

            return true;
        }
        return false;
    }

    /**
     * {@inheritDoc}
     * @see Document::getParentDocumentUidForSaving($pid, $core, $owner)
     */
    protected function getParentDocumentUidForSaving($pid, $core, $owner)
    {
        // Nothing to do here, at the moment
    }

    /**
     * {@inheritDoc}
     * @see Document::prepareMetadataArray($cPid)
     */
    protected function prepareMetadataArray($cPid)
    {
        // Nothing to do here, at the moment
    }

    /**
     * {@inheritDoc}
     * @see Document::setPreloadedDocument($preloadedDocument)
     */
    protected function setPreloadedDocument($preloadedDocument)
    {
        // Nothing to do here, at the moment
    }

    /**
     * {@inheritDoc}
     * @see Document::_getPhysicalStructure()
     */
    protected function _getPhysicalStructure()
    {
        // Nothing to do here, at the moment
    }

    /**
     * {@inheritDoc}
     * @see Document::_getSmLinks()
     */
    protected function _getSmLinks()
    {
        // Nothing to do here, at the moment
    }

    /**
     * {@inheritDoc}
     * @see Document::_getThumbnail($forceReload = false)
     */
    protected function _getThumbnail($forceReload = false)
    {
        // Nothing to do here, at the moment
    }

    /**
     * {@inheritDoc}
     * @see Document::_getToplevelId()
     */
    protected function _getToplevelId()
    {
        // Nothing to do here, at the moment
    }
}