<?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\Schema\Struct;

use TYPO3\CMS\Core\Schema\Field\FieldCollection;
use TYPO3\CMS\Core\Schema\Field\FieldTypeInterface;

/**
 * FlexForms are always separated in sheets, "sDEF" being the default sheet
 * if no sheets are defined.
 * Each sheet contains fields OR Section Containers (defined by <section>1</section>) which then could also
 * contain fields.
 */
final readonly class FlexSheet
{
    public function __construct(
        // @todo: incomplete or obsolete implementation, these properties are never read.
        private string $sheetIdentifier,
        private string $title,
        private string $description,
        private FieldCollection $fields,
        private array $sections,
    ) {}

    public function getFields(): FieldCollection
    {
        return $this->fields;
    }

    public function hasField(string $fieldName): bool
    {
        return isset($this->fields[$fieldName]);
    }

    public function getField(string $fieldName): FieldTypeInterface
    {
        return $this->fields[$fieldName];
    }

    public function getSections(): array
    {
        return $this->sections;
    }

    public static function __set_state(array $state): self
    {
        return new self(...$state);
    }
}
