FolderBasedFileCollection.php

Go to the documentation of this file.

<?php
 
/*
 * 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\Collection;
 
use ‪TYPO3\CMS\Core\Resource\Folder;
use ‪TYPO3\CMS\Core\Resource\StorageRepository;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪FolderBasedFileCollection extends ‪AbstractFileCollection
{
    protected static ‪$storageTableName = 'sys_file_collection';
 
    protected static ‪$type = 'folder';
 
    protected static ‪$itemsCriteriaField = 'folder';
 
    protected ‪$folder;
 
    protected ‪$recursive;
 
    public function ‪loadContents()
    {
        if ($this->folder instanceof ‪Folder) {
            $entries = $this->folder->getFiles(0, 0, ‪Folder::FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS, $this->recursive);
            foreach ($entries as $entry) {
                $this->‪add($entry);
            }
        }
    }
 
    public function ‪getItemsCriteria()
    {
        return $this->folder->getCombinedIdentifier();
    }
 
    protected function ‪getPersistableDataArray()
    {
        return [
            'title' => $this->‪getTitle(),
            'type' => ‪self::$type,
            'description' => $this->‪getDescription(),
            'folder_identifier' => $this->folder->getCombinedIdentifier(),
        ];
    }
 
    public function ‪fromArray(array $array)
    {
        $this->uid = $array['uid'];
        $this->title = $array['title'];
        $this->‪description = $array['description'];
        $this->recursive = (bool)$array['recursive'];
        if (str_contains($array['folder_identifier'] ?? '', ':')) {
            $parts = ‪GeneralUtility::trimExplode(':', $array['folder_identifier']);
            $storageRepository = GeneralUtility::makeInstance(StorageRepository::class);
            ‪$storage = $storageRepository->findByUid((int)$parts[0]);
            if (‪$storage) {
                $this->folder = ‪$storage->getFolder($parts[1]);
            }
        }
    }
}