AbstractFileCollection.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\Collection\AbstractRecordCollection;
use ‪TYPO3\CMS\Core\Collection\CollectionInterface;
use ‪TYPO3\CMS\Core\Resource\File;
use ‪TYPO3\CMS\Core\Resource\FileInterface;
 
abstract class ‪AbstractFileCollection extends ‪AbstractRecordCollection
{
    protected static ‪$storageTableName = 'sys_file_collection';
 
    protected static ‪$type;
 
    protected static ‪$itemsCriteriaField;
 
    protected ‪$itemsCriteria;
 
    protected ‪$itemTableName = 'sys_file';
 
    public function ‪setDescription(‪$description)
    {
        $this->‪description = ‪$description;
    }
 
    public function ‪key(): mixed
    {
        $currentRecord = $this->storage->current();
        return $currentRecord->getIdentifier();
    }
 
    protected function ‪getItemUidList($includeTableName = false)
    {
        $list = [];
        foreach ($this->storage as $entry) {
            $list[] = $this->‪getItemTableName() . '_' . $entry->getUid();
        }
        return implode(',', $list);
    }
 
    protected function ‪getPersistableDataArray()
    {
        return [
            'title' => $this->‪getTitle(),
            'type' => static::$type,
            'description' => $this->‪getDescription(),
            static::$itemsCriteriaField => $this->‪getItemsCriteria(),
        ];
    }
 
    public function ‪toArray()
    {
        $itemArray = [];
        foreach ($this->storage as $item) {
            $itemArray[] = $item->toArray();
        }
        return [
            'uid' => $this->‪getIdentifier(),
            'title' => $this->‪getTitle(),
            'description' => $this->‪getDescription(),
            'items' => $itemArray,
        ];
    }
 
    public function ‪getItems()
    {
        $itemArray = [];
        foreach ($this->storage as $item) {
            $itemArray[] = $item;
        }
        return $itemArray;
    }
 
    public function ‪fromArray(array $array)
    {
        $this->uid = $array['uid'];
        $this->title = $array['title'];
        $this->‪description = $array['description'];
        $this->itemsCriteria = $array[static::$itemsCriteriaField];
    }
 
    public function ‪getItemsCriteria()
    {
        return ‪$this->itemsCriteria;
    }
 
    public function ‪setItemsCriteria(‪$itemsCriteria)
    {
        $this->itemsCriteria = ‪$itemsCriteria;
    }
 
    public function ‪add(‪FileInterface $data)
    {
        $this->storage->push($data);
    }
 
    public function ‪addAll(‪CollectionInterface $other)
    {
        foreach ($other as $value) {
            $this->‪add($value);
        }
    }
 
    public function remove(‪File $file)
    {
        $offset = 0;
        foreach ($this->storage as $value) {
            if ($value === $file) {
                break;
            }
            $offset++;
        }
        $this->storage->offsetUnset($offset);
    }
 
    public function ‪removeAll()
    {
        $this->storage = new \SplDoublyLinkedList();
    }
}