FileRepository.php

Go to the documentation of this file.

<?php
namespace ‪TYPO3\CMS\Core\Resource;
 
/*
 * 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!
 */
 
use ‪TYPO3\CMS\Backend\Utility\BackendUtility;
use ‪TYPO3\CMS\Core\Database\ConnectionPool;
use ‪TYPO3\CMS\Core\Database\Query\Restriction\FrontendRestrictionContainer;
use ‪TYPO3\CMS\Core\Database\RelationHandler;
use ‪TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException;
use ‪TYPO3\CMS\Core\Resource\Index\FileIndexRepository;
use ‪TYPO3\CMS\Core\Resource\Search\FileSearchDemand;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\MathUtility;
 
class ‪FileRepository extends ‪AbstractRepository
{
    protected ‪$objectType = File::class;
 
    protected ‪$table = 'sys_file';
 
    protected function ‪createDomainObject(array $databaseRow)
    {
        return $this->factory->getFileObject($databaseRow['uid'], $databaseRow);
    }
 
    public function ‪findByRelation($tableName, $fieldName, $uid)
    {
        $itemList = [];
        if (!‪MathUtility::canBeInterpretedAsInteger($uid)) {
            throw new \InvalidArgumentException(
                'UID of related record has to be an integer. UID given: "' . $uid . '"',
                1316789798
            );
        }
        $referenceUids = [];
        if ($this->‪getEnvironmentMode() === 'FE') {
            $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
                ->getQueryBuilderForTable('sys_file_reference');
 
            $queryBuilder->setRestrictions(GeneralUtility::makeInstance(FrontendRestrictionContainer::class));
            $res = $queryBuilder
                ->select('uid')
                ->from('sys_file_reference')
                ->where(
                    $queryBuilder->expr()->eq(
                        'uid_foreign',
                        $queryBuilder->createNamedParameter($uid, \PDO::PARAM_INT)
                    ),
                    $queryBuilder->expr()->eq(
                        'tablenames',
                        $queryBuilder->createNamedParameter($tableName, \PDO::PARAM_STR)
                    ),
                    $queryBuilder->expr()->eq(
                        'fieldname',
                        $queryBuilder->createNamedParameter($fieldName, \PDO::PARAM_STR)
                    )
                )
                ->orderBy('sorting_foreign')
                ->execute();
 
            while ($row = $res->fetch()) {
                $referenceUids[] = $row['uid'];
            }
        } else {
            $relationHandler = GeneralUtility::makeInstance(RelationHandler::class);
            $relationHandler->start(
                '',
                'sys_file_reference',
                '',
                $uid,
                $tableName,
                ‪BackendUtility::getTcaFieldConfiguration($tableName, $fieldName)
            );
            if (!empty($relationHandler->tableArray['sys_file_reference'])) {
                $referenceUids = $relationHandler->tableArray['sys_file_reference'];
            }
        }
        if (!empty($referenceUids)) {
            foreach ($referenceUids as $referenceUid) {
                try {
                    // Just passing the reference uid, the factory is doing workspace
                    // overlays automatically depending on the current environment
                    $itemList[] = $this->factory->getFileReferenceObject($referenceUid);
                } catch (‪ResourceDoesNotExistException $exception) {
                    // No handling, just omit the invalid reference uid
                }
            }
            $itemList = $this->‪reapplySorting($itemList);
        }
 
        return $itemList;
    }
 
    public function ‪findFileReferenceByUid($uid)
    {
        if (!‪MathUtility::canBeInterpretedAsInteger($uid)) {
            throw new \InvalidArgumentException('The UID of record has to be an integer. UID given: "' . $uid . '"', 1316889798);
        }
        try {
            $fileReferenceObject = $this->factory->getFileReferenceObject($uid);
        } catch (\InvalidArgumentException $exception) {
            $fileReferenceObject = false;
        }
        return $fileReferenceObject;
    }
 
    protected function ‪reapplySorting(array $itemList): array
    {
        uasort(
            $itemList,
            function (‪FileReference $a, ‪FileReference $b) {
                $sortA = (int)$a->‪getReferenceProperty('sorting_foreign');
                $sortB = (int)$b->‪getReferenceProperty('sorting_foreign');
 
                if ($sortA === $sortB) {
                    return 0;
                }
 
                return ($sortA < $sortB) ? -1 : 1;
            }
        );
        return $itemList;
    }
 
    public function ‪searchByName(‪Folder $folder, $fileName)
    {
        trigger_error(__METHOD__ . ' is deprecated. Use ResourceStorage::searchFiles instead', \E_USER_DEPRECATED);
        $searchDemand = ‪FileSearchDemand::createForSearchTerm($fileName)
            ->addSearchField('sys_file', 'name');
 
        return iterator_to_array($folder->‪searchFiles($searchDemand));
    }
 
    protected function ‪getFileIndexRepository()
    {
        return ‪FileIndexRepository::getInstance();
    }
}