TYPO3 v15 dev-main snapshot ()

2026-08-10 22:31:24 +02:00
commit aad9daaefd
1506 changed files with 94005 additions and 0 deletions
@@ -0,0 +1,100 @@
+<?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!
+ */
+
+/*
+ * Inspired by and partially taken from the Neos.Form package (www.neos.io)
+ */
+
+namespace TYPO3\CMS\Form\Mvc\Persistence;
+
+use Psr\Http\Message\ServerRequestInterface;
+use TYPO3\CMS\Form\Domain\DTO\SearchCriteria;
+use TYPO3\CMS\Form\Domain\ValueObject\FormIdentifier;
+
+/**
+ * The form persistence manager interface
+ *
+ * Scope: frontend / backend
+ *
+ * @internal
+ */
+interface FormPersistenceManagerInterface
+{
+    public const FORM_DEFINITION_FILE_EXTENSION = '.form.yaml';
+
+    /**
+     * Load the array form representation identified by $persistenceIdentifier, and return it.
+     *
+     * @param ?array $typoScriptSettings FE TS "plugin.tx_form.settings" - Given when rendering a form
+     *        as plugin using FormFrontendController or formvh:render, empty array in all BE usages.
+     *        Intended to override details like labels of single forms.
+     */
+    public function load(string $persistenceIdentifier, ?array $typoScriptSettings = null, ?ServerRequestInterface $request = null): array;
+
+    /**
+     * Save the array form representation identified by $persistenceIdentifier
+     */
+    public function save(string $persistenceIdentifier, array $formDefinition, array $formSettings, ?string $storageLocation = null): FormIdentifier;
+
+    /**
+     * Delete the form representation identified by $persistenceIdentifier
+     */
+    public function delete(string $persistenceIdentifier, array $formSettings): void;
+
+    /**
+     * List all form definitions which can be loaded through this form persistence
+     * manager.
+     *
+     * Returns an associative array with each item containing the keys 'name' (the human-readable name of the form)
+     * and 'persistenceIdentifier' (the unique identifier for the Form Persistence Manager e.g. the path to the saved form definition).
+     *
+     * @return array in the format [['name' => 'Form 01', 'persistenceIdentifier' => 'path1'], [ .... ]]
+     */
+    public function listForms(array $formSettings, SearchCriteria $searchCriteria): array;
+
+    /**
+     * Check if any form definition is available
+     */
+    public function hasForms(array $formSettings): bool;
+
+    /**
+     * This takes a form identifier and returns a unique persistence identifier for it.
+     */
+    public function getUniquePersistenceIdentifier(string $storage, string $formIdentifier, ?string $savePath): string;
+
+    public function getUniqueIdentifier(string $identifier): string;
+
+    /**
+     * Check if a storage location (PID for database, folder path for files) is allowed
+     *
+     * @param string $storageLocation The storage location (e.g., "123" for PID, "1:/forms/" for file path)
+     * @return bool True if the storageLocation is allowed
+     */
+    public function isAllowedStorageLocation(string $storageLocation): bool;
+
+    /**
+     * Check if a persistence identifier (UID for database, full file path for files) is allowed
+     *
+     * @param string $persistenceIdentifier The persistence identifier (e.g., "456" for UID, "1:/forms/contact.form.yaml" for file)
+     * @return bool True if the persistence identifier is allowed
+     */
+    public function isAllowedPersistenceIdentifier(string $persistenceIdentifier): bool;
+
+    public function hasValidFileExtension(string $fileName): bool;
+
+    public function getAccessibleStorageAdapters(): array;
+}