MetaDataAspect.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\Index\MetaDataRepository;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪MetaDataAspect implements \ArrayAccess, \Countable, \Iterator
{
    private ‪$file;
 
    private ‪$metaData = [];
 
    private ‪$loaded = false;
 
    private ‪$indexPosition = 0;
 
    public function ‪__construct(‪File ‪$file)
    {
        $this->file = ‪$file;
    }
 
    public function ‪add(array ‪$metaData): self
    {
        $this->loaded = true;
        $this->metaData = array_merge($this->metaData, ‪$metaData);
 
        return $this;
    }
 
    public function get(): array
    {
        if (!$this->loaded) {
            $this->loaded = true;
            $this->metaData = $this->‪loadFromRepository();
        }
        return ‪$this->metaData;
    }
 
    public function ‪offsetExists($offset): bool
    {
        return array_key_exists($offset, $this->get());
    }
 
    public function ‪offsetGet($offset): mixed
    {
        return $this->get()[$offset] ?? null;
    }
 
    public function ‪offsetSet($offset, $value): void
    {
        $this->loaded = true;
        $this->metaData[$offset] = $value;
    }
 
    public function ‪offsetUnset($offset): void
    {
        $this->metaData[$offset] = null;
    }
 
    public function ‪count(): int
    {
        return ‪count($this->get());
    }
 
    public function ‪rewind(): void
    {
        $this->indexPosition = 0;
    }
 
    public function ‪current(): mixed
    {
        $key = array_keys($this->metaData)[‪$this->indexPosition];
        return $this->metaData[$key];
    }
 
    public function ‪key(): string
    {
        return array_keys($this->metaData)[‪$this->indexPosition];
    }
 
    public function ‪next(): void
    {
        ++‪$this->indexPosition;
    }
 
    public function ‪valid(): bool
    {
        $key = array_keys($this->metaData)[‪$this->indexPosition] ?? '';
        return array_key_exists($key, $this->metaData);
    }
 
    public function ‪save(): void
    {
        $metaDataInDatabase = $this->‪loadFromRepository();
        if ($metaDataInDatabase === []) {
            $this->metaData = $this->‪getMetaDataRepository()->createMetaDataRecord($this->file->getUid(), $this->metaData);
        } else {
            $this->metaData = $this->‪getMetaDataRepository()->update($this->file->getUid(), $this->metaData, $metaDataInDatabase);
        }
    }
 
    public function remove(): void
    {
        $this->‪getMetaDataRepository()->removeByFileUid($this->file->getUid());
        $this->metaData = [];
    }
 
    protected function ‪getMetaDataRepository(): ‪MetaDataRepository
    {
        return GeneralUtility::makeInstance(MetaDataRepository::class);
    }
 
    protected function ‪loadFromRepository(): array
    {
        return $this->‪getMetaDataRepository()->findByFileUid((int)$this->file->getUid());
    }
}