cms-core/Classes/Domain/Record.php

<?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\Domain;

use TYPO3\CMS\Core\Domain\Exception\RecordPropertyException;
use TYPO3\CMS\Core\Domain\Exception\RecordPropertyNotFoundException;
use TYPO3\CMS\Core\Domain\Record\ComputedProperties;
use TYPO3\CMS\Core\Domain\Record\LanguageInfo;
use TYPO3\CMS\Core\Domain\Record\SystemProperties;
use TYPO3\CMS\Core\Domain\Record\VersionInfo;

/**
 * Represents a record with all properties valid for this record type.
 *
 * @internal not part of public API, as this needs to be streamlined and proven
 */
class Record implements RecordInterface
{
    public function __construct(
        protected readonly RawRecord $rawRecord,
        protected array $properties,
        protected readonly ?SystemProperties $systemProperties = null,
    ) {}

    public function getUid(): int
    {
        return $this->rawRecord->getUid();
    }

    public function getPid(): int
    {
        return $this->rawRecord->getPid();
    }

    public function getFullType(): string
    {
        return $this->rawRecord->getFullType();
    }

    public function getRecordType(): ?string
    {
        return $this->rawRecord->getRecordType();
    }

    public function getMainType(): string
    {
        return $this->rawRecord->getMainType();
    }

    public function toArray(bool $includeSystemProperties = false): array
    {
        $properties = ['uid' => $this->getUid(), 'pid' => $this->getPid()];
        foreach ($this->properties as $key => $property) {
            if ($property instanceof RecordPropertyClosure) {
                $this->properties[$key] = $property->instantiate();
            }
        }
        $properties += $this->properties;
        if ($includeSystemProperties) {
            $properties += ['_system' => $this->systemProperties?->toArray() ?? []];
        }
        return $properties;
    }

    public function has(string $id): bool
    {
        if (array_key_exists($id, $this->properties)) {
            return true;
        }

        if (in_array($id, ['uid', 'pid'], true)) {
            // Enable access of uid and pid via array access
            return true;
        }

        if ($this->getRecordType() === null && $this->rawRecord->has($id)) {
            // Only fall back to the raw record in case no record type is defined.
            // This allows to properly check for only record type specific fields.
            return true;
        }

        return false;
    }

    public function get(string $id): mixed
    {
        if (array_key_exists($id, $this->properties)) {
            $property = $this->properties[$id];
            if ($property instanceof RecordPropertyClosure) {
                try {
                    $property = $property->instantiate();
                } catch (\Exception $e) {
                    // Consumers of this method can rely on catching ContainerExceptionInterface
                    throw new RecordPropertyException(
                        'An exception occurred while instantiating record property "' . $id . '"',
                        1725892139,
                        $e
                    );
                }
                $this->properties[$id] = $property;
            }
            return $property;
        }

        if (in_array($id, ['uid', 'pid'], true)) {
            // Enable access of uid and pid via array access
            return $this->rawRecord->get($id);
        }

        if ($this->getRecordType() === null && $this->rawRecord->has($id)) {
            // Only fall back to the raw record in case no record type is defined.
            // This ensures that only record type specific fields are being returned.
            return $this->rawRecord->get($id);
        }

        throw new RecordPropertyNotFoundException('Record property "' . $id . '" is not available.', 1725892138);
    }

    public function getVersionInfo(): ?VersionInfo
    {
        return $this->systemProperties?->getVersion();
    }

    public function getLanguageInfo(): ?LanguageInfo
    {
        return $this->systemProperties?->getLanguage();
    }

    public function getLanguageId(): ?int
    {
        return $this->systemProperties?->getLanguage()?->getLanguageId();
    }

    public function getSystemProperties(): ?SystemProperties
    {
        return $this->systemProperties;
    }

    public function getComputedProperties(): ComputedProperties
    {
        return $this->rawRecord->getComputedProperties();
    }

    public function getRawRecord(): RawRecord
    {
        return $this->rawRecord;
    }

    public function getOverlaidUid(): int
    {
        $computedProperties = $this->getComputedProperties();
        if ($computedProperties->getLocalizedUid() !== null) {
            return $computedProperties->getLocalizedUid();
        }
        if ($computedProperties->getVersionedUid() !== null) {
            return $computedProperties->getVersionedUid();
        }
        return $this->getUid();
    }
}