FileReference.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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!
 */
 
namespace ‪TYPO3\CMS\Core\Resource;
 
use ‪TYPO3\CMS\Core\Resource\Enum\DuplicationBehavior;
use ‪TYPO3\CMS\Core\Utility\ArrayUtility;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪FileReference implements ‪FileInterface
{
    protected ‪$propertiesOfFileReference;
 
    protected ‪$originalFile;
 
    protected ‪$mergedProperties = [];
 
    public function ‪__construct(array $fileReferenceData, $factory = null)
    {
        $this->propertiesOfFileReference = $fileReferenceData;
        if (!$fileReferenceData['uid_local']) {
            throw new \InvalidArgumentException('Incorrect reference to original file given for FileReference.', 1300098528);
        }
        $this->‪originalFile = $this->‪getFileObject((int)$fileReferenceData['uid_local'], $factory);
    }
 
    private function ‪getFileObject(int $uidLocal, ‪ResourceFactory $factory = null): ‪FileInterface
    {
        if ($factory === null) {
            $factory = GeneralUtility::makeInstance(ResourceFactory::class);
        }
        return $factory->getFileObject($uidLocal);
    }
 
    /*******************************
     * VARIOUS FILE PROPERTY GETTERS
     *******************************/
    public function ‪hasProperty(string $key): bool
    {
        return array_key_exists($key, $this->‪getProperties());
    }
 
    public function ‪getProperty(string $key): mixed
    {
        if (!$this->‪hasProperty($key)) {
            throw new \InvalidArgumentException('Property "' . $key . '" was not found in file reference or original file.', 1314226805);
        }
        $properties = $this->‪getProperties();
        return $properties[$key];
    }
 
    public function ‪getReferenceProperty($key)
    {
        if (!array_key_exists($key, $this->propertiesOfFileReference)) {
            throw new \InvalidArgumentException('Property "' . $key . '" of file reference was not found.', 1360684914);
        }
        return $this->propertiesOfFileReference[$key];
    }
 
    public function ‪getProperties()
    {
        if (empty($this->mergedProperties)) {
            $this->mergedProperties = ‪$this->propertiesOfFileReference;
            ArrayUtility::mergeRecursiveWithOverrule(
                $this->mergedProperties,
                $this->‪originalFile->‪getProperties(),
                true,
                true,
                false
            );
            array_walk($this->mergedProperties, [$this, 'restoreNonNullValuesCallback']);
        }
 
        return ‪$this->mergedProperties;
    }
 
    protected function ‪restoreNonNullValuesCallback(&$value, $key)
    {
        if (array_key_exists($key, $this->propertiesOfFileReference) && $this->propertiesOfFileReference[$key] !== null) {
            $value = $this->propertiesOfFileReference[$key];
        }
    }
 
    public function ‪getReferenceProperties()
    {
        return ‪$this->propertiesOfFileReference;
    }
 
    public function ‪getName(): string
    {
        return $this->‪originalFile->‪getName();
    }
 
    public function ‪getTitle()
    {
        return (string)$this->‪getProperty('title');
    }
 
    public function ‪getAlternative()
    {
        return (string)$this->‪getProperty('alternative');
    }
 
    public function ‪getDescription()
    {
        return (string)$this->‪getProperty('description');
    }
 
    public function ‪getLink()
    {
        return $this->propertiesOfFileReference['link'];
    }
 
    public function ‪getUid()
    {
        return (int)$this->propertiesOfFileReference['uid'];
    }
 
    public function ‪getSize(): int
    {
        return $this->‪originalFile->getSize();
    }
 
    public function ‪getSha1(): string
    {
        return $this->‪originalFile->‪getSha1();
    }
 
    public function ‪getExtension(): string
    {
        return $this->‪originalFile->‪getExtension();
    }
 
    public function ‪getNameWithoutExtension(): string
    {
        return $this->‪originalFile->‪getNameWithoutExtension();
    }
 
    public function ‪getMimeType(): string
    {
        return $this->‪originalFile->‪getMimeType();
    }
 
    public function ‪getModificationTime(): int
    {
        return (int)$this->‪originalFile->‪getModificationTime();
    }
 
    public function ‪getCreationTime(): int
    {
        return (int)$this->‪originalFile->‪getCreationTime();
    }
 
    public function ‪getType()
    {
        return (int)$this->‪originalFile->‪getType();
    }
 
    public function ‪isMissing()
    {
        return (bool)$this->‪originalFile->‪getProperty('missing');
    }
 
    /******************
     * CONTENTS RELATED
     ******************/
    public function ‪getContents(): string
    {
        return $this->‪originalFile->‪getContents();
    }
 
    public function ‪setContents(string $contents): self
    {
        $this->‪originalFile->‪setContents($contents);
        return $this;
    }
 
    /****************************************
     * STORAGE AND MANAGEMENT RELATED METHODS
     ****************************************/
    public function ‪getStorage(): ResourceStorage
    {
        return $this->‪originalFile->‪getStorage();
    }
 
    public function ‪getIdentifier(): string
    {
        return $this->‪originalFile->‪getIdentifier();
    }
 
    public function ‪getCombinedIdentifier()
    {
        return $this->‪originalFile->‪getCombinedIdentifier();
    }
 
    public function delete(): bool
    {
        // @todo Implement this function. This should only delete the
        // FileReference (sys_file_reference) record, not the file itself.
        throw new \BadMethodCallException('Function not implemented FileReference::delete().', 1333754461);
        //return $this->fileRepository->removeUsageRecord($this);
    }
 
    public function ‪rename(string $newName, $conflictMode = ‪DuplicationBehavior::RENAME): FileInterface
    {
        // @todo Implement this function. This should only rename the
        // FileReference (sys_file_reference) record, not the file itself.
        throw new \BadMethodCallException('Function not implemented FileReference::rename().', 1333754473);
        //return $this->fileRepository->renameUsageRecord($this, $newName);
    }
 
    /*****************
     * SPECIAL METHODS
     *****************/
    public function ‪getPublicUrl(): ?string
    {
        return $this->‪originalFile->‪getPublicUrl();
    }
 
    public function ‪isIndexed(): bool
    {
        return true;
    }
 
    public function ‪getForLocalProcessing(bool $writable = true): string
    {
        return $this->‪originalFile->‪getForLocalProcessing($writable);
    }
 
    public function toArray(): array
    {
        $array = array_merge($this->‪originalFile->toArray(), $this->propertiesOfFileReference);
        return $array;
    }
 
    public function getOriginalFile()
    {
        return ‪$this->originalFile;
    }
 
    public function ‪getHashedIdentifier(): string
    {
        return $this->‪getStorage()->hashFileIdentifier($this->‪getIdentifier());
    }
 
    public function ‪getParentFolder(): ‪FolderInterface
    {
        return $this->‪originalFile->‪getParentFolder();
    }
 
    public function ‪__sleep(): array
    {
        $keys = get_object_vars($this);
        unset($keys['originalFile'], $keys['mergedProperties']);
        return array_keys($keys);
    }
 
    public function ‪__wakeup(): void
    {
        $factory = GeneralUtility::makeInstance(ResourceFactory::class);
        $this->‪originalFile = $this->‪getFileObject(
            (int)$this->propertiesOfFileReference['uid_local'],
            $factory
        );
    }
}