kitodo / kitodo-publication

Classes/Domain/Model/File.php

<?php
namespace EWW\Dpf\Domain\Model;

/*
 * 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!
 */

/**
 * File
 */
class File extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
{

    /**
     * title
     *
     * @var string
     */
    protected $title = '';

    /**
     * label
     *
     * @var string
     */
    protected $label = '';

    /**
     * download
     *
     * @var boolean
     */
    protected $download;

    /**
     * archive
     *
     * @var boolean
     */
    protected $archive;

    /**
     * fileGroupDeleted
     *
     * @var boolean
     */
    protected $fileGroupDeleted;

    /**
     * contentType
     *
     * @var string
     */
    protected $contentType = '';

    /**
     * link
     *
     * @var string
     */
    protected $link = '';

    /**
     * status
     *
     * @var string
     */
    protected $status;

    /**
     * primaryFile
     *
     * @var boolean
     */
    protected $primaryFile;


    /**
     * fileIdentifier
     *
     * @var string
     */
    protected $fileIdentifier = '';

    /**
     * datastreamIdentifier
     *
     * @var string
     */
    protected $datastreamIdentifier;

    /**
     * document
     *
     * @var \EWW\Dpf\Domain\Model\Document
     */
    protected $document = null;

    const STATUS_REMOTE  = "remote";
    const STATUS_DELETED = "deleted";
    const STATUS_CHANGED = "changed";
    const STATUS_ADDED   = "added";

    const PRIMARY_DATASTREAM_IDENTIFIER = 'ATT-0';
    const DATASTREAM_IDENTIFIER_PREFIX  = 'ATT-';

    /**
     * Returns the title
     *
     * @return string $title
     */
    public function getTitle()
    {
        return $this->title;
    }

    /**
     * Sets the title
     *
     * @param string $title
     * @return void
     */
    public function setTitle($title)
    {
        $this->title = $title;
    }

    /**
     * Returns the label
     *
     * @return string $label
     */
    public function getLabel()
    {
        return $this->label;
    }

    /**
     * Sets the label
     *
     * @param string $label
     * @return void
     */
    public function setLabel($label)
    {
        $this->label = $label;
    }

    /**
     * Returns the download
     *
     * @return boolean $download
     */
    public function getDownload()
    {
        return $this->download;
    }

    /**
     * Sets the download
     *
     * @param boolean $download
     * @return void
     */
    public function setDownload($download)
    {
        $this->download = boolval($download);
    }

    /**
     * Returns the arcive
     *
     * @return boolean $archive
     */
    public function getArchive()
    {
        return $this->archive;
    }

    /**
     * Sets the archive
     *
     * @param boolean $archive
     * @return void
     */
    public function setArchive($archive)
    {
        $this->archive = boolval($archive);
    }

    /**
     * Returns the fileGroupDeleted
     *
     * @return boolean $fileGroupDeleted
     */
    public function isFileGroupDeleted()
    {
        return $this->fileGroupDeleted;
    }

    /**
     * Sets the fileGroupDeleted
     *
     * @return boolean $fileGroupDeleted
     */
    public function setFileGroupDeleted($fileGroupDeleted)
    {
        $this->fileGroupDeleted = boolval($fileGroupDeleted);
    }

    /**
     * Returns the contentType
     *
     * @return string $contentType
     */
    public function getContentType()
    {
        return $this->contentType;
    }

    /**
     * Sets the contentType
     *
     * @param string $contentType
     * @return void
     */
    public function setContentType($contentType)
    {
        $this->contentType = $contentType;
    }

    /**
     * Returns the link
     *
     * @return string $link
     */
    public function getLink()
    {
        return $this->link;
    }

    /**
     * Sets the link
     *
     * @param string $link
     * @return void
     */
    public function setLink($link)
    {
        $this->link = $link;
    }

    /**
     * Returns the status
     *
     * @return string $status
     */
    public function getStatus()
    {
        return $this->status;
    }

    /**
     * Sets the status
     *
     * @param string $status
     * @return void
     */
    public function setStatus($status)
    {
        $this->status = $status;
    }

    /**
     * Returns the document
     *
     * @return \EWW\Dpf\Domain\Model\Document $document
     */
    public function getDocument()
    {
        return $this->document;
    }

    /**
     * Sets the document
     *
     * @param \EWW\Dpf\Domain\Model\Document $document
     * @return void
     */
    public function setDocument(\EWW\Dpf\Domain\Model\Document $document)
    {
        $this->document = $document;
    }

    /**
     * Returns the primaryFile
     *
     * @return boolean $primaryFile
     */
    public function getPrimaryFile()
    {
        return $this->primaryFile;
    }

    /**
     * Sets the primaryFile
     *
     * @param boolean $primaryFile
     * @return void
     */
    public function setPrimaryFile($primaryFile)
    {
        $this->primaryFile = boolval($primaryFile);
    }

    /**
     * Returns the boolean state of primaryFile
     *
     * @return boolean
     */
    public function isPrimaryFile()
    {
        return $this->primaryFile;
    }

    /**
     * Returns the datastreamIdentifier
     *
     * @return string $datastreamIdentifier
     */
    public function getDatastreamIdentifier()
    {
        return $this->datastreamIdentifier;
    }

    /**
     * Sets the datastreamIdentifier
     *
     * @param string $datastreamIdentifier
     * @return void
     */
    public function setDatastreamIdentifier($datastreamIdentifier)
    {
        $this->datastreamIdentifier = $datastreamIdentifier;
    }

    /**
     * Copies the data of the given file object into the current file object.
     *
     * @param File $fileToCopy
     * @return $this
     * @throws \TYPO3\CMS\Extbase\Reflection\Exception\PropertyNotAccessibleException
     */
    public function copy(File $fileToCopy) {
        $availableProperties = \TYPO3\CMS\Extbase\Reflection\ObjectAccess::getGettablePropertyNames($fileToCopy);
        $newFile = $this;

        foreach ($availableProperties as $propertyName) {
            if (\TYPO3\CMS\Extbase\Reflection\ObjectAccess::isPropertySettable($newFile, $propertyName)
                && !in_array($propertyName, array('uid','pid'))) {

                $propertyValue = \TYPO3\CMS\Extbase\Reflection\ObjectAccess::getProperty($fileToCopy, $propertyName);
                \TYPO3\CMS\Extbase\Reflection\ObjectAccess::setProperty($newFile, $propertyName, $propertyValue);
            }
        }

        return $this;
    }

    /**
     * Gets the full url of the file.
     *
     * @return string
     */
    public function getUrl()
    {
        $url = $this->getLink();

        // FIXME: Checking for "datastreams" in the URL is Fedora 3 specific, for Fedora 4 we need a better solution.
        if (strpos(strtolower($url), "datastreams") === false) {
            // File is a locally uploaded file, therefor we need to
            // determine the path
            $uploadFileUrl = new \EWW\Dpf\Helper\UploadFileUrl;
            $fileName = pathInfo($url, PATHINFO_BASENAME);
            $url = $uploadFileUrl->getUploadUrl() . "/" . $fileName;

Are you sure $fileName of type array|string can be used in concatenation?

        }

        return $url;
    }

    /**
     * @return string
     */
    public function getFileIdentifier(): string
    {
        return $this->fileIdentifier;
    }

    /**
     * @param string $fileIdentifier
     */
    public function setFileIdentifier(string $fileIdentifier): void
    {
        $this->fileIdentifier = $fileIdentifier;
    }

    /**
     * @return bool
     */
    public function isNewFileHref(): bool
    {
        return $this->getStatus() == \EWW\Dpf\Domain\Model\File::STATUS_ADDED ||
            $this->getStatus() == \EWW\Dpf\Domain\Model\File::STATUS_CHANGED;
    }

    /**
     * @return string
     */
    public function isDeleted(): string
    {
        return $this->getStatus() == \EWW\Dpf\Domain\Model\File::STATUS_DELETED;

The expression return $this->getStatus() == EWW\Dpf\Domain\Model\File::STATUS_DELETED returns the type boolean which is incompatible with the type-hinted return string.

    }
}