[TASK] Streamline phpdoc annotations in EXT:form 21/58521/2
authorBenni Mack <benni@typo3.org>
Mon, 1 Oct 2018 11:22:15 +0000 (13:22 +0200)
committerRalf Zimmermann <ralf.zimmermann@tritum.de>
Mon, 1 Oct 2018 12:43:26 +0000 (14:43 +0200)
EXT:form uses @api and @internal phpDoc annotations. Going with a cleaner
approach with marking code as just @internal, and everything not annotated
as @internal is public, is the way to go, also the way PSR-5 is heading.

For EXT:form: Every PHP class that had nothing marked, is now @internal,
everything that was @api is now implicitly part of TYPO3 Core API.

Other areas will follow so the API for TYPO3 v9 LTS is clearer than ever.

Resolves: #86502
Releases: master
Change-Id: I2c1efdd11f0fbaa992315a90049eb109e2620c76
Reviewed-on: https://review.typo3.org/58521
Reviewed-by: Wouter Wolters <typo3@wouterwolters.nl>
Tested-by: Wouter Wolters <typo3@wouterwolters.nl>
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Ralf Zimmermann <ralf.zimmermann@tritum.de>
Tested-by: Ralf Zimmermann <ralf.zimmermann@tritum.de>
78 files changed:
typo3/sysext/form/Classes/Controller/AbstractBackendController.php
typo3/sysext/form/Classes/Controller/FormEditorController.php
typo3/sysext/form/Classes/Controller/FormFrontendController.php
typo3/sysext/form/Classes/Controller/FormManagerController.php
typo3/sysext/form/Classes/Domain/Condition/ConditionProvider.php
typo3/sysext/form/Classes/Domain/Condition/Functions/FormConditionFunctionsProvider.php
typo3/sysext/form/Classes/Domain/Configuration/ArrayProcessing/ArrayProcessing.php
typo3/sysext/form/Classes/Domain/Configuration/ArrayProcessing/ArrayProcessor.php
typo3/sysext/form/Classes/Domain/Configuration/ConfigurationService.php
typo3/sysext/form/Classes/Domain/Configuration/Exception/PropertyException.php
typo3/sysext/form/Classes/Domain/Configuration/Exception/PrototypeNotFoundException.php
typo3/sysext/form/Classes/Domain/Configuration/FormDefinition/Validators/ValidationDto.php
typo3/sysext/form/Classes/Domain/Exception.php
typo3/sysext/form/Classes/Domain/Exception/IdentifierNotValidException.php
typo3/sysext/form/Classes/Domain/Exception/RenderingException.php
typo3/sysext/form/Classes/Domain/Exception/TypeDefinitionNotFoundException.php
typo3/sysext/form/Classes/Domain/Exception/TypeDefinitionNotValidException.php
typo3/sysext/form/Classes/Domain/Exception/UnknownCompositRenderableException.php
typo3/sysext/form/Classes/Domain/Factory/AbstractFormFactory.php
typo3/sysext/form/Classes/Domain/Factory/FormFactoryInterface.php
typo3/sysext/form/Classes/Domain/Finishers/AbstractFinisher.php
typo3/sysext/form/Classes/Domain/Finishers/Exception/FinisherException.php
typo3/sysext/form/Classes/Domain/Finishers/FinisherContext.php
typo3/sysext/form/Classes/Domain/Finishers/FinisherInterface.php
typo3/sysext/form/Classes/Domain/Finishers/FinisherVariableProvider.php
typo3/sysext/form/Classes/Domain/Model/Exception.php
typo3/sysext/form/Classes/Domain/Model/Exception/DuplicateFormElementException.php
typo3/sysext/form/Classes/Domain/Model/Exception/FinisherPresetNotFoundException.php
typo3/sysext/form/Classes/Domain/Model/Exception/FormDefinitionConsistencyException.php
typo3/sysext/form/Classes/Domain/Model/Exception/ValidatorPresetNotFoundException.php
typo3/sysext/form/Classes/Domain/Model/FormDefinition.php
typo3/sysext/form/Classes/Domain/Model/FormElements/AbstractFormElement.php
typo3/sysext/form/Classes/Domain/Model/FormElements/AbstractSection.php
typo3/sysext/form/Classes/Domain/Model/FormElements/FormElementInterface.php
typo3/sysext/form/Classes/Domain/Model/FormElements/GenericFormElement.php
typo3/sysext/form/Classes/Domain/Model/FormElements/GridContainer.php
typo3/sysext/form/Classes/Domain/Model/FormElements/GridRow.php
typo3/sysext/form/Classes/Domain/Model/FormElements/Page.php
typo3/sysext/form/Classes/Domain/Model/FormElements/Section.php
typo3/sysext/form/Classes/Domain/Model/FormElements/UnknownFormElement.php
typo3/sysext/form/Classes/Domain/Model/Renderable/AbstractRenderable.php
typo3/sysext/form/Classes/Domain/Model/Renderable/RenderableInterface.php
typo3/sysext/form/Classes/Domain/Model/Renderable/RootRenderableInterface.php
typo3/sysext/form/Classes/Domain/Model/Renderable/VariableRenderableInterface.php
typo3/sysext/form/Classes/Domain/Renderer/AbstractElementRenderer.php
typo3/sysext/form/Classes/Domain/Renderer/RendererInterface.php
typo3/sysext/form/Classes/Domain/Runtime/Exception/PropertyMappingException.php
typo3/sysext/form/Classes/Domain/Runtime/FormRuntime.php
typo3/sysext/form/Classes/Exception.php
typo3/sysext/form/Classes/Hooks/FileListEditIconsHook.php
typo3/sysext/form/Classes/Hooks/FormFileExtensionUpdate.php
typo3/sysext/form/Classes/Hooks/FormFileProvider.php
typo3/sysext/form/Classes/Hooks/FormPagePreviewRenderer.php
typo3/sysext/form/Classes/Mvc/Configuration/Exception/FileWriteException.php
typo3/sysext/form/Classes/Mvc/Configuration/Exception/NoSuchFileException.php
typo3/sysext/form/Classes/Mvc/Configuration/Exception/ParseErrorException.php
typo3/sysext/form/Classes/Mvc/Configuration/TypoScriptService.php
typo3/sysext/form/Classes/Mvc/Persistence/FormPersistenceManagerInterface.php
typo3/sysext/form/Classes/Mvc/Property/PropertyMappingConfiguration.php
typo3/sysext/form/Classes/Mvc/Validation/CountValidator.php
typo3/sysext/form/Classes/Mvc/Validation/DateRangeValidator.php
typo3/sysext/form/Classes/Mvc/Validation/EmptyValidator.php
typo3/sysext/form/Classes/Mvc/Validation/Exception/InvalidValidationOptionsException.php
typo3/sysext/form/Classes/Mvc/Validation/FileSizeValidator.php
typo3/sysext/form/Classes/Mvc/Validation/MimeTypeValidator.php
typo3/sysext/form/Classes/Service/TranslationService.php
typo3/sysext/form/Classes/Type/FormDefinitionArray.php
typo3/sysext/form/Classes/ViewHelpers/Form/DatePickerViewHelper.php
typo3/sysext/form/Classes/ViewHelpers/Form/TimePickerViewHelper.php
typo3/sysext/form/Classes/ViewHelpers/Form/UploadedResourceViewHelper.php
typo3/sysext/form/Classes/ViewHelpers/FormViewHelper.php
typo3/sysext/form/Classes/ViewHelpers/GridColumnClassAutoConfigurationViewHelper.php
typo3/sysext/form/Classes/ViewHelpers/RenderAllFormValuesViewHelper.php
typo3/sysext/form/Classes/ViewHelpers/RenderRenderableViewHelper.php
typo3/sysext/form/Classes/ViewHelpers/RenderViewHelper.php
typo3/sysext/form/Classes/ViewHelpers/TranslateElementErrorViewHelper.php
typo3/sysext/form/Classes/ViewHelpers/TranslateElementPropertyViewHelper.php
typo3/sysext/form/Tests/Unit/Mvc/Validation/Fixtures/TestValidator.php

index 2a755cb..b3b81da 100644 (file)
@@ -24,6 +24,7 @@ use TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManagerInterface;
  * The abstract form backend controller
  *
  * Scope: backend
+ * @internal
  */
 abstract class AbstractBackendController extends ActionController
 {
index 3b53a80..e82bbaa 100644 (file)
@@ -40,6 +40,7 @@ use TYPO3\CMS\Form\Type\FormDefinitionArray;
  * The form editor controller
  *
  * Scope: backend
+ * @internal
  */
 class FormEditorController extends AbstractBackendController
 {
index 3564ec2..eedc464 100644 (file)
@@ -24,6 +24,7 @@ use TYPO3\CMS\Form\Mvc\Configuration\TypoScriptService;
  * The frontend controller
  *
  * Scope: frontend
+ * @internal
  */
 class FormFrontendController extends ActionController
 {
index fffd498..0a65f92 100644 (file)
@@ -37,6 +37,7 @@ use TYPO3\CMS\Form\Service\TranslationService;
  * The form manager controller
  *
  * Scope: backend
+ * @internal
  */
 class FormManagerController extends AbstractBackendController
 {
index ae924ca..d3cdb3f 100644 (file)
@@ -23,7 +23,7 @@ use TYPO3\CMS\Form\Domain\Condition\Functions\FormConditionFunctionsProvider;
  * **This classis NOT meant to be sub classed by developers .**
  *
  * @internal
  */
+ */
 class ConditionProvider extends AbstractProvider
 {
     public function __construct()
index abc239c..a2f20fa 100644 (file)
@@ -3,9 +3,25 @@ declare(strict_types = 1);
 
 namespace TYPO3\CMS\Form\Domain\Condition\Functions;
 
+/*
+ * 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!
+ */
+
 use Symfony\Component\ExpressionLanguage\ExpressionFunction;
 use Symfony\Component\ExpressionLanguage\ExpressionFunctionProviderInterface;
 
+/**
+ * @internal
+ */
 class FormConditionFunctionsProvider implements ExpressionFunctionProviderInterface
 {
 
index b9daf34..6865d84 100644 (file)
@@ -19,6 +19,7 @@ namespace TYPO3\CMS\Form\Domain\Configuration\ArrayProcessing;
  * Helper for array processing
  *
  * Scope: frontend / backend
+ * @internal
  */
 class ArrayProcessing
 {
index f7c220e..3cab0eb 100644 (file)
@@ -22,6 +22,7 @@ use TYPO3\CMS\Form\Domain\Configuration\Exception\ArrayProcessorException;
  * Helper for array processing
  *
  * Scope: frontend / backend
+ * @internal
  */
 class ArrayProcessor
 {
index 7dc9379..3b32d2a 100644 (file)
@@ -77,7 +77,6 @@ class ConfigurationService implements SingletonInterface
      * @param string $prototypeName name of the prototype to get the configuration for
      * @return array the prototype configuration
      * @throws PrototypeNotFoundException if prototype with the name $prototypeName was not found
-     * @api
      */
     public function getPrototypeConfiguration(string $prototypeName): array
     {
index de8dd3c..f420b34 100644 (file)
@@ -19,8 +19,6 @@ use TYPO3\CMS\Form\Domain\Exception;
 
 /**
  * This exception is thrown if a form setup property was not found.
- *
- * @api
  */
 class PropertyException extends Exception
 {
index 62dca0f..087779c 100644 (file)
@@ -19,8 +19,6 @@ use TYPO3\CMS\Form\Domain\Exception;
 
 /**
  * This exception is thrown if a form prototype for a given name was not found.
- *
- * @api
  */
 class PrototypeNotFoundException extends Exception
 {
index ded2ec8..c3d71c9 100644 (file)
@@ -19,8 +19,6 @@ use TYPO3\CMS\Form\Exception as FormException;
 
 /**
  * A generic Form domain Exception
- *
- * @api
  */
 class Exception extends FormException
 {
index b7261c6..257ab28 100644 (file)
@@ -22,8 +22,6 @@ use TYPO3\CMS\Form\Domain\Exception;
 /**
  * This exception is thrown if the "identifier" for a Form, a Page or a Form Element
  * is invalid (i.e. empty or not a string)
- *
- * @api
  */
 class IdentifierNotValidException extends Exception
 {
index 3db546d..ab4f06b 100644 (file)
@@ -21,8 +21,6 @@ use TYPO3\CMS\Form\Domain\Exception;
 
 /**
  * This exception is thrown if a rendering error occurs
- *
- * @api
  */
 class RenderingException extends Exception
 {
index c5de794..479cd0f 100644 (file)
@@ -22,8 +22,6 @@ use TYPO3\CMS\Form\Domain\Exception;
 /**
  * This exception is thrown if a Type Definition for a form element was not found,
  * or if the implementationClassName was not set.
- *
- * @api
  */
 class TypeDefinitionNotFoundException extends Exception
 {
index 67a7edc..d6cefc9 100644 (file)
@@ -22,8 +22,6 @@ use TYPO3\CMS\Form\Domain\Exception;
 /**
  * This exception is thrown if a Type Definition for a form element was not valid,
  * i.e. it has properties which are not supported.
- *
- * @api
  */
 class TypeDefinitionNotValidException extends Exception
 {
index b6059f5..4f88ecd 100644 (file)
@@ -21,9 +21,7 @@ use TYPO3\CMS\Form\Domain\Exception;
 
 /**
  * This exception is thrown if the ArrayFormFactory want to create child
- * elements within a unknown composit renderable.
- *
- * @api
+ * elements within a unknown composite renderable.
  */
 class UnknownCompositRenderableException extends Exception
 {
index 600982d..f3f4cd3 100644 (file)
@@ -47,7 +47,6 @@ use TYPO3\CMS\Form\Domain\Model\FormDefinition;
  *
  * Scope: frontend / backend
  * **This class is meant to be sub classed by developers.**
- * @api
  */
 abstract class AbstractFormFactory implements FormFactoryInterface
 {
@@ -56,7 +55,6 @@ abstract class AbstractFormFactory implements FormFactoryInterface
      * hook on all form elements.
      *
      * @param FormDefinition $form
-     * @api
      */
     protected function triggerFormBuildingFinished(FormDefinition $form)
     {
index 7c0d6b8..ebcfd0e 100644 (file)
@@ -28,7 +28,6 @@ use TYPO3\CMS\Form\Domain\Model\FormDefinition;
  * it is done through an invocation of a Form Rendering ViewHelper.
  *
  * Scope: frontend / backend
- * @api
  */
 interface FormFactoryInterface
 {
@@ -42,7 +41,6 @@ interface FormFactoryInterface
      * @param array $configuration factory-specific configuration array
      * @param string $prototypeName The name of the "PrototypeName" to use; it is factory-specific to implement this.
      * @return FormDefinition a newly built form definition
-     * @api
      */
     public function build(array $configuration, string $prototypeName = null): FormDefinition;
 }
index 8077c8b..337ddab 100644 (file)
@@ -96,7 +96,6 @@ abstract class AbstractFinisher implements FinisherInterface
 
     /**
      * @param array $options configuration options in the format ['option1' => 'value1', 'option2' => 'value2', ...]
-     * @api
      */
     public function setOptions(array $options)
     {
@@ -108,7 +107,6 @@ abstract class AbstractFinisher implements FinisherInterface
      *
      * @param string $optionName name of the option to be set
      * @param mixed $optionValue value of the option
-     * @api
      */
     public function setOption(string $optionName, $optionValue)
     {
@@ -120,7 +118,6 @@ abstract class AbstractFinisher implements FinisherInterface
      *
      * @param FinisherContext $finisherContext The Finisher context that contains the current Form Runtime and Response
      * @return string|null
-     * @api
      */
     final public function execute(FinisherContext $finisherContext)
     {
@@ -139,7 +136,6 @@ abstract class AbstractFinisher implements FinisherInterface
      * Override and fill with your own implementation!
      *
      * @return string|null
-     * @api
      */
     abstract protected function executeInternal();
 
@@ -153,7 +149,6 @@ abstract class AbstractFinisher implements FinisherInterface
      *
      * @param string $optionName
      * @return string|array|null
-     * @api
      */
     protected function parseOption(string $optionName)
     {
index c552729..d23d876 100644 (file)
@@ -19,8 +19,6 @@ use TYPO3\CMS\Form\Domain\Exception;
 
 /**
  * This exception is thrown in Form Finishers
- *
- * @api
  */
 class FinisherException extends Exception
 {
index 893def9..c7b865d 100644 (file)
@@ -73,7 +73,7 @@ class FinisherContext
     }
 
     /**
-     * @api
+     * Sets up the FinisherVariableProvider
      */
     public function initializeObject()
     {
@@ -83,8 +83,6 @@ class FinisherContext
 
     /**
      * Cancels the finisher invocation after the current finisher
-     *
-     * @api
      */
     public function cancel()
     {
@@ -106,7 +104,6 @@ class FinisherContext
      * The Form Runtime that is associated with the current finisher
      *
      * @return FormRuntime
-     * @api
      */
     public function getFormRuntime(): FormRuntime
     {
@@ -117,7 +114,6 @@ class FinisherContext
      * The values of the submitted form (after validation and property mapping)
      *
      * @return array
-     * @api
      */
     public function getFormValues(): array
     {
@@ -126,7 +122,6 @@ class FinisherContext
 
     /**
      * @return ControllerContext
-     * @api
      */
     public function getControllerContext(): ControllerContext
     {
@@ -135,7 +130,6 @@ class FinisherContext
 
     /**
      * @return FinisherVariableProvider
-     * @api
      */
     public function getFinisherVariableProvider(): FinisherVariableProvider
     {
index 7471887..86771c6 100644 (file)
@@ -30,13 +30,11 @@ interface FinisherInterface
      *
      * @param FinisherContext $finisherContext The Finisher context that contains the current Form Runtime and Response
      * @return string|null
-     * @api
      */
     public function execute(FinisherContext $finisherContext);
 
     /**
      * @param array $options configuration options in the format ['option1' => 'value1', 'option2' => 'value2', ...]
-     * @api
      */
     public function setOptions(array $options);
 
@@ -45,7 +43,6 @@ interface FinisherInterface
      *
      * @param string $optionName name of the option to be set
      * @param mixed $optionValue value of the option
-     * @api
      */
     public function setOption(string $optionName, $optionValue);
 
@@ -53,7 +50,6 @@ interface FinisherInterface
      * Returns whether this finisher is enabled
      *
      * @return bool
-     * @api
      */
     public function isEnabled(): bool;
 }
index fdce692..ded6ee0 100644 (file)
@@ -42,7 +42,6 @@ final class FinisherVariableProvider implements \ArrayAccess, \IteratorAggregate
      * @param string $finisherIdentifier
      * @param string $key
      * @param mixed $value
-     * @api
      */
     public function add(string $finisherIdentifier, string $key, $value)
     {
@@ -77,7 +76,6 @@ final class FinisherVariableProvider implements \ArrayAccess, \IteratorAggregate
      * @param string $key
      * @param mixed $default
      * @return mixed
-     * @api
      */
     public function get(string $finisherIdentifier, string $key, $default = null)
     {
@@ -93,7 +91,6 @@ final class FinisherVariableProvider implements \ArrayAccess, \IteratorAggregate
      * @param string $finisherIdentifier
      * @param string $key
      * @return bool
-     * @api
      */
     public function exists($finisherIdentifier, $key): bool
     {
@@ -110,7 +107,6 @@ final class FinisherVariableProvider implements \ArrayAccess, \IteratorAggregate
      *
      * @param string $finisherIdentifier
      * @param string $key
-     * @api
      */
     public function remove(string $finisherIdentifier, string $key)
     {
index 6793846..85e77a7 100644 (file)
@@ -19,8 +19,6 @@ use TYPO3\CMS\Form\Domain\Exception as DomainException;
 
 /**
  * A generic Form model Exception
- *
- * @api
  */
 class Exception extends DomainException
 {
index ee2b634..6064031 100644 (file)
@@ -20,8 +20,6 @@ use TYPO3\CMS\Form\Domain\Model\Exception;
 /**
  * This exception is thrown if two Form Elements with the same Identifier are added
  * to a form.
- *
- * @api
  */
 class DuplicateFormElementException extends Exception
 {
index fcb53ea..beaccf2 100644 (file)
@@ -20,8 +20,6 @@ use TYPO3\CMS\Form\Domain\Model\Exception;
 /**
  * This exception is thrown if a Finisher Preset was not found,
  * or if the implementationClassName was not set.
- *
- * @api
  */
 class FinisherPresetNotFoundException extends Exception
 {
index 06f5a88..b8fa59d 100644 (file)
@@ -20,8 +20,6 @@ use TYPO3\CMS\Form\Domain\Model\Exception;
 /**
  * This exception is thrown if the form definition would get an inconsistent state, like
  * adding a page to two different forms
- *
- * @api
  */
 class FormDefinitionConsistencyException extends Exception
 {
index b7ce05e..35bde7a 100644 (file)
@@ -20,8 +20,6 @@ use TYPO3\CMS\Form\Domain\Model\Exception;
 /**
  * This exception is thrown if a Validator Preset was not found,
  * or if the implementationClassName was not set.
- *
- * @api
  */
 class ValidatorPresetNotFoundException extends Exception
 {
index a7b12bd..dee8ec2 100644 (file)
@@ -302,7 +302,6 @@ class FormDefinition extends AbstractCompositeRenderable implements VariableRend
      * @param string $type element type of this form
      * @param string $persistenceIdentifier the persistence identifier of the form
      * @throws IdentifierNotValidException if the identifier was not valid
-     * @api
      */
     public function __construct(
         string $identifier,
@@ -398,7 +397,6 @@ class FormDefinition extends AbstractCompositeRenderable implements VariableRend
      * @param string $typeName Type of the new page
      * @return Page the newly created page
      * @throws TypeDefinitionNotFoundException
-     * @api
      */
     public function createPage(string $identifier, string $typeName = 'Page'): Page
     {
@@ -441,7 +439,6 @@ class FormDefinition extends AbstractCompositeRenderable implements VariableRend
      * @param Page $page
      * @throws FormDefinitionConsistencyException if Page is already added to a FormDefinition
      * @see createPage
-     * @api
      */
     public function addPage(Page $page)
     {
@@ -452,7 +449,6 @@ class FormDefinition extends AbstractCompositeRenderable implements VariableRend
      * Get the Form's pages
      *
      * @return array<Page> The Form's pages in the correct order
-     * @api
      */
     public function getPages(): array
     {
@@ -464,7 +460,6 @@ class FormDefinition extends AbstractCompositeRenderable implements VariableRend
      *
      * @param int $index
      * @return bool TRUE if a page with the given $index exists, otherwise FALSE
-     * @api
      */
     public function hasPageWithIndex(int $index): bool
     {
@@ -479,7 +474,6 @@ class FormDefinition extends AbstractCompositeRenderable implements VariableRend
      * @param int $index
      * @return Page the page, or NULL if none found.
      * @throws FormException if the specified index does not exist
-     * @api
      */
     public function getPageByIndex(int $index)
     {
@@ -493,7 +487,6 @@ class FormDefinition extends AbstractCompositeRenderable implements VariableRend
      * Adds the specified finisher to this form
      *
      * @param FinisherInterface $finisher
-     * @api
      */
     public function addFinisher(FinisherInterface $finisher)
     {
@@ -505,7 +498,6 @@ class FormDefinition extends AbstractCompositeRenderable implements VariableRend
      * @param array $options options for this finisher in the format ['option1' => 'value1', 'option2' => 'value2', ...]
      * @return FinisherInterface
      * @throws FinisherPresetNotFoundException
-     * @api
      */
     public function createFinisher(string $finisherIdentifier, array $options = []): FinisherInterface
     {
@@ -526,7 +518,6 @@ class FormDefinition extends AbstractCompositeRenderable implements VariableRend
      * Gets all finishers of this form
      *
      * @return \TYPO3\CMS\Form\Domain\Finishers\FinisherInterface[]
-     * @api
      */
     public function getFinishers(): array
     {
@@ -570,7 +561,6 @@ class FormDefinition extends AbstractCompositeRenderable implements VariableRend
      *
      * @param string $elementIdentifier
      * @return FormElementInterface The element with the given $elementIdentifier or NULL if none found
-     * @api
      */
     public function getElementByIdentifier(string $elementIdentifier)
     {
@@ -612,7 +602,6 @@ class FormDefinition extends AbstractCompositeRenderable implements VariableRend
      *
      * @param Page $pageToMove
      * @param Page $referencePage
-     * @api
      */
     public function movePageBefore(Page $pageToMove, Page $referencePage)
     {
@@ -624,7 +613,6 @@ class FormDefinition extends AbstractCompositeRenderable implements VariableRend
      *
      * @param Page $pageToMove
      * @param Page $referencePage
-     * @api
      */
     public function movePageAfter(Page $pageToMove, Page $referencePage)
     {
@@ -635,7 +623,6 @@ class FormDefinition extends AbstractCompositeRenderable implements VariableRend
      * Remove $pageToRemove from form
      *
      * @param Page $pageToRemove
-     * @api
      */
     public function removePage(Page $pageToRemove)
     {
@@ -649,7 +636,6 @@ class FormDefinition extends AbstractCompositeRenderable implements VariableRend
      * @param Request $request
      * @param Response $response
      * @return FormRuntime
-     * @api
      */
     public function bind(Request $request, Response $response): FormRuntime
     {
@@ -659,7 +645,6 @@ class FormDefinition extends AbstractCompositeRenderable implements VariableRend
     /**
      * @param string $propertyPath
      * @return ProcessingRule
-     * @api
      */
     public function getProcessingRule(string $propertyPath): ProcessingRule
     {
@@ -722,7 +707,6 @@ class FormDefinition extends AbstractCompositeRenderable implements VariableRend
      * Set the renderer class name
      *
      * @param string $rendererClassName
-     * @api
      */
     public function setRendererClassName(string $rendererClassName)
     {
@@ -733,7 +717,6 @@ class FormDefinition extends AbstractCompositeRenderable implements VariableRend
      * Get the classname of the renderer
      *
      * @return string
-     * @api
      */
     public function getRendererClassName(): string
     {
index 7b475b9..8f35eae 100644 (file)
@@ -56,7 +56,6 @@ abstract class AbstractFormElement extends AbstractRenderable implements FormEle
      * @param string $identifier The FormElement's identifier
      * @param string $type The Form Element Type
      * @throws IdentifierNotValidException
-     * @api
      */
     public function __construct(string $identifier, string $type)
     {
@@ -69,8 +68,6 @@ abstract class AbstractFormElement extends AbstractRenderable implements FormEle
 
     /**
      * Override this method in your custom FormElements if needed
-     *
-     * @api
      */
     public function initializeFormElement()
     {
@@ -88,7 +85,6 @@ abstract class AbstractFormElement extends AbstractRenderable implements FormEle
      * Get the global unique identifier of the element
      *
      * @return string
-     * @api
      */
     public function getUniqueIdentifier(): string
     {
@@ -102,7 +98,6 @@ abstract class AbstractFormElement extends AbstractRenderable implements FormEle
      * Get the default value of the element
      *
      * @return mixed
-     * @api
      */
     public function getDefaultValue()
     {
@@ -114,7 +109,6 @@ abstract class AbstractFormElement extends AbstractRenderable implements FormEle
      * Set the default value of the element
      *
      * @param mixed $defaultValue
-     * @api
      */
     public function setDefaultValue($defaultValue)
     {
@@ -131,7 +125,6 @@ abstract class AbstractFormElement extends AbstractRenderable implements FormEle
      * Check if the element is required
      *
      * @return bool
-     * @api
      */
     public function isRequired(): bool
     {
@@ -148,7 +141,6 @@ abstract class AbstractFormElement extends AbstractRenderable implements FormEle
      *
      * @param string $key
      * @param mixed $value
-     * @api
      */
     public function setProperty(string $key, $value)
     {
@@ -166,7 +158,6 @@ abstract class AbstractFormElement extends AbstractRenderable implements FormEle
      * Get all properties
      *
      * @return array
-     * @api
      */
     public function getProperties(): array
     {
index f7e702a..616068b 100644 (file)
@@ -45,7 +45,6 @@ abstract class AbstractSection extends AbstractCompositeRenderable
      * @param string $identifier The Section identifier
      * @param string $type The Section type
      * @throws IdentifierNotValidException if the identifier was no non-empty string
-     * @api
      */
     public function __construct(string $identifier, string $type)
     {
@@ -61,7 +60,6 @@ abstract class AbstractSection extends AbstractCompositeRenderable
      * Get the child Form Elements
      *
      * @return FormElementInterface[] The Page's elements
-     * @api
      */
     public function getElements(): array
     {
@@ -72,7 +70,6 @@ abstract class AbstractSection extends AbstractCompositeRenderable
      * Get the child Form Elements
      *
      * @return FormElementInterface[] The Page's elements
-     * @api
      */
     public function getElementsRecursively(): array
     {
@@ -84,7 +81,6 @@ abstract class AbstractSection extends AbstractCompositeRenderable
      *
      * @param FormElementInterface $formElement The form element to add
      * @throws FormDefinitionConsistencyException if FormElement is already added to a section
-     * @api
      */
     public function addElement(FormElementInterface $formElement)
     {
@@ -105,7 +101,6 @@ abstract class AbstractSection extends AbstractCompositeRenderable
      * @return FormElementInterface the newly created form element
      * @throws TypeDefinitionNotFoundException
      * @throws TypeDefinitionNotValidException
-     * @api
      */
     public function createElement(string $identifier, string $typeName): FormElementInterface
     {
@@ -153,7 +148,6 @@ abstract class AbstractSection extends AbstractCompositeRenderable
      *
      * @param FormElementInterface $elementToMove
      * @param FormElementInterface $referenceElement
-     * @api
      */
     public function moveElementBefore(FormElementInterface $elementToMove, FormElementInterface $referenceElement)
     {
@@ -167,7 +161,6 @@ abstract class AbstractSection extends AbstractCompositeRenderable
      *
      * @param FormElementInterface $elementToMove
      * @param FormElementInterface $referenceElement
-     * @api
      */
     public function moveElementAfter(FormElementInterface $elementToMove, FormElementInterface $referenceElement)
     {
@@ -178,7 +171,6 @@ abstract class AbstractSection extends AbstractCompositeRenderable
      * Remove $elementToRemove from this Section/Page
      *
      * @param FormElementInterface $elementToRemove
-     * @api
      */
     public function removeElement(FormElementInterface $elementToRemove)
     {
index 65a3365..4d2ac59 100644 (file)
@@ -49,7 +49,6 @@ interface FormElementInterface extends RenderableInterface
      * this includes the identifier of the form itself, making it "globally" unique
      *
      * @return string the "globally" unique identifier of this element
-     * @api
      */
     public function getUniqueIdentifier(): string;
 
@@ -58,7 +57,6 @@ interface FormElementInterface extends RenderableInterface
      * during display.
      *
      * @return mixed the default value for this Form Element
-     * @api
      */
     public function getDefaultValue();
 
@@ -67,7 +65,6 @@ interface FormElementInterface extends RenderableInterface
      * during display.
      *
      * @param mixed $defaultValue the default value for this Form Element
-     * @api
      */
     public function setDefaultValue($defaultValue);
 
@@ -76,7 +73,6 @@ interface FormElementInterface extends RenderableInterface
      *
      * @param string $key
      * @param mixed $value
-     * @api
      */
     public function setProperty(string $key, $value);
 
@@ -84,7 +80,6 @@ interface FormElementInterface extends RenderableInterface
      * Get all element-specific configuration properties
      *
      * @return array
-     * @api
      */
     public function getProperties(): array;
 
@@ -93,7 +88,6 @@ interface FormElementInterface extends RenderableInterface
      *
      * @param string $key
      * @param mixed $value
-     * @api
      */
     public function setRenderingOption(string $key, $value);
 
@@ -109,7 +103,6 @@ interface FormElementInterface extends RenderableInterface
      * Registers a validator for this element
      *
      * @param ValidatorInterface $validator
-     * @api
      */
     public function addValidator(ValidatorInterface $validator);
 
@@ -117,7 +110,6 @@ interface FormElementInterface extends RenderableInterface
      * Set the target data type for this element
      *
      * @param string $dataType the target data type
-     * @api
      */
     public function setDataType(string $dataType);
 
@@ -125,7 +117,6 @@ interface FormElementInterface extends RenderableInterface
      * Whether or not this element is required
      *
      * @return bool
-     * @api
      */
     public function isRequired(): bool;
 }
index d64510a..da8f868 100644 (file)
@@ -21,7 +21,6 @@ namespace TYPO3\CMS\Form\Domain\Model\FormElements;
  * A generic form element
  *
  * Scope: frontend
- * @api
  */
 class GenericFormElement extends AbstractFormElement
 {
index 6cb9b25..3a5d1e1 100644 (file)
@@ -64,7 +64,6 @@ class GridContainer extends Section implements GridContainerInterface
      * Add a new row element at the end of the grid container
      *
      * @param FormElementInterface $formElement The form element to add
-     * @api
      */
     public function addElement(FormElementInterface $formElement)
     {
@@ -84,7 +83,6 @@ class GridContainer extends Section implements GridContainerInterface
      * @param string $typeName type of the new form element
      * @return FormElementInterface the newly created grid row
      * @throws TypeDefinitionNotValidException
-     * @api
      */
     public function createElement(string $identifier, string $typeName): FormElementInterface
     {
index d499483..6e909d0 100644 (file)
@@ -35,7 +35,6 @@ class GridRow extends Section implements GridRowInterface
      *
      * @param FormElementInterface $formElement The form element to add
      * @throws TypeDefinitionNotValidException if FormElement is already added to a section
-     * @api
      */
     public function addElement(FormElementInterface $formElement)
     {
@@ -56,7 +55,6 @@ class GridRow extends Section implements GridRowInterface
      * @param string $typeName type of the new form element
      * @return GridRowInterface the newly created frid row
      * @throws TypeDefinitionNotValidException
-     * @api
      */
     public function createElement(string $identifier, string $typeName): FormElementInterface
     {
index 9c76038..2b11a1d 100644 (file)
@@ -45,7 +45,6 @@ class Page extends AbstractSection
      * @param string $identifier The Page's identifier
      * @param string $type The Page's type
      * @throws \TYPO3\CMS\Form\Domain\Exception\IdentifierNotValidException if the identifier was no non-empty string
-     * @api
      */
     public function __construct(string $identifier, string $type = 'Page')
     {
@@ -57,7 +56,6 @@ class Page extends AbstractSection
      *
      * @param CompositeRenderableInterface $parentRenderable
      * @throws FormException
-     * @api
      */
     public function setParentRenderable(CompositeRenderableInterface $parentRenderable)
     {
index 81cc45a..606a7ef 100644 (file)
@@ -63,7 +63,6 @@ class Section extends AbstractSection implements FormElementInterface
      * this includes the identifier of the form itself, making it "globally" unique
      *
      * @return string the "globally" unique identifier of this element
-     * @api
      */
     public function getUniqueIdentifier(): string
     {
@@ -77,7 +76,6 @@ class Section extends AbstractSection implements FormElementInterface
      * Note: This is currently not used for section elements
      *
      * @return mixed the default value for this Form Element
-     * @api
      */
     public function getDefaultValue()
     {
@@ -90,7 +88,6 @@ class Section extends AbstractSection implements FormElementInterface
      * Note: This is currently ignored for section elements
      *
      * @param mixed $defaultValue the default value for this Form Element
-     * @api
      */
     public function setDefaultValue($defaultValue)
     {
@@ -100,7 +97,6 @@ class Section extends AbstractSection implements FormElementInterface
      * Get all element-specific configuration properties
      *
      * @return array
-     * @api
      */
     public function getProperties(): array
     {
@@ -112,7 +108,6 @@ class Section extends AbstractSection implements FormElementInterface
      *
      * @param string $key
      * @param mixed $value
-     * @api
      */
     public function setProperty(string $key, $value)
     {
@@ -130,7 +125,6 @@ class Section extends AbstractSection implements FormElementInterface
      * Whether or not this element is required
      *
      * @return bool
-     * @api
      */
     public function isRequired(): bool
     {
index c2d7a9e..e1b4a70 100644 (file)
@@ -35,7 +35,6 @@ class UnknownFormElement extends AbstractRenderable implements FormElementInterf
      * @param string $identifier The FormElement's identifier
      * @param string $type The Form Element Type
      * @throws IdentifierNotValidException
-     * @api
      */
     public function __construct(string $identifier, string $type)
     {
@@ -47,7 +46,7 @@ class UnknownFormElement extends AbstractRenderable implements FormElementInterf
     }
 
     /**
-     * @api
+     * Sets up the form element
      */
     public function initializeFormElement()
     {
@@ -67,7 +66,6 @@ class UnknownFormElement extends AbstractRenderable implements FormElementInterf
      * this includes the identifier of the form itself, making it "globally" unique
      *
      * @return string the "globally" unique identifier of this element
-     * @api
      */
     public function getUniqueIdentifier(): string
     {
@@ -81,7 +79,6 @@ class UnknownFormElement extends AbstractRenderable implements FormElementInterf
      * Get the template name of the renderable
      *
      * @return string
-     * @api
      */
     public function getTemplateName(): string
     {
index fcfdc88..cb16f10 100644 (file)
@@ -99,7 +99,6 @@ abstract class AbstractRenderable implements RenderableInterface, VariableRender
      * Get the type of the renderable
      *
      * @return string
-     * @api
      */
     public function getType(): string
     {
@@ -110,7 +109,6 @@ abstract class AbstractRenderable implements RenderableInterface, VariableRender
      * Get the identifier of the element
      *
      * @return string
-     * @api
      */
     public function getIdentifier(): string
     {
@@ -121,7 +119,6 @@ abstract class AbstractRenderable implements RenderableInterface, VariableRender
      * Set the identifier of the element
      *
      * @param string $identifier
-     * @api
      */
     public function setIdentifier(string $identifier)
     {
@@ -135,7 +132,6 @@ abstract class AbstractRenderable implements RenderableInterface, VariableRender
      *
      * @param array $options
      * @param bool $resetValidators
-     * @api
      */
     public function setOptions(array $options, bool $resetValidators = false)
     {
@@ -201,7 +197,6 @@ abstract class AbstractRenderable implements RenderableInterface, VariableRender
      * @param array $options
      * @return mixed
      * @throws ValidatorPresetNotFoundException
-     * @api
      */
     public function createValidator(string $validatorIdentifier, array $options = [])
     {
@@ -224,7 +219,6 @@ abstract class AbstractRenderable implements RenderableInterface, VariableRender
      * Add a validator to the element
      *
      * @param ValidatorInterface $validator
-     * @api
      */
     public function addValidator(ValidatorInterface $validator)
     {
@@ -248,7 +242,6 @@ abstract class AbstractRenderable implements RenderableInterface, VariableRender
      * Set the datatype
      *
      * @param string $dataType
-     * @api
      */
     public function setDataType(string $dataType)
     {
@@ -260,7 +253,6 @@ abstract class AbstractRenderable implements RenderableInterface, VariableRender
      * Get the classname of the renderer
      *
      * @return string
-     * @api
      */
     public function getRendererClassName(): string
     {
@@ -271,7 +263,6 @@ abstract class AbstractRenderable implements RenderableInterface, VariableRender
      * Get all rendering options
      *
      * @return array
-     * @api
      */
     public function getRenderingOptions(): array
     {
@@ -284,7 +275,6 @@ abstract class AbstractRenderable implements RenderableInterface, VariableRender
      * @param string $key
      * @param mixed $value
      * @return mixed
-     * @api
      */
     public function setRenderingOption(string $key, $value)
     {
@@ -302,7 +292,6 @@ abstract class AbstractRenderable implements RenderableInterface, VariableRender
      * Get the parent renderable
      *
      * @return CompositeRenderableInterface|null
-     * @api
      */
     public function getParentRenderable()
     {
@@ -313,7 +302,6 @@ abstract class AbstractRenderable implements RenderableInterface, VariableRender
      * Set the parent renderable
      *
      * @param CompositeRenderableInterface $parentRenderable
-     * @api
      */
     public function setParentRenderable(CompositeRenderableInterface $parentRenderable)
     {
@@ -326,7 +314,6 @@ abstract class AbstractRenderable implements RenderableInterface, VariableRender
      *
      * @return FormDefinition
      * @throws FormDefinitionConsistencyException
-     * @api
      */
     public function getRootForm(): FormDefinition
     {
@@ -405,7 +392,6 @@ abstract class AbstractRenderable implements RenderableInterface, VariableRender
      * Get the label of the renderable
      *
      * @return string
-     * @api
      */
     public function getLabel(): string
     {
@@ -416,7 +402,6 @@ abstract class AbstractRenderable implements RenderableInterface, VariableRender
      * Set the label which shall be displayed next to the form element
      *
      * @param string $label
-     * @api
      */
     public function setLabel(string $label)
     {
@@ -427,7 +412,6 @@ abstract class AbstractRenderable implements RenderableInterface, VariableRender
      * Get the templateName name of the renderable
      *
      * @return string
-     * @api
      */
     public function getTemplateName(): string
     {
@@ -450,7 +434,6 @@ abstract class AbstractRenderable implements RenderableInterface, VariableRender
      * Get all rendering variants
      *
      * @return RenderableVariantInterface[]
-     * @api
      */
     public function getVariants(): array
     {
@@ -460,7 +443,6 @@ abstract class AbstractRenderable implements RenderableInterface, VariableRender
     /**
      * @param array $options
      * @return RenderableVariantInterface
-     * @api
      */
     public function createVariant(array $options): RenderableVariantInterface
     {
@@ -478,7 +460,6 @@ abstract class AbstractRenderable implements RenderableInterface, VariableRender
      * Adds the specified variant to this form element
      *
      * @param RenderableVariantInterface $variant
-     * @api
      */
     public function addVariant(RenderableVariantInterface $variant)
     {
@@ -490,7 +471,6 @@ abstract class AbstractRenderable implements RenderableInterface, VariableRender
      * regardless of their conditions
      *
      * @param RenderableVariantInterface $variant
-     * @api
      */
     public function applyVariant(RenderableVariantInterface $variant)
     {
index b0c5a00..0055e43 100644 (file)
@@ -58,7 +58,6 @@ interface RenderableInterface extends RootRenderableInterface
      * Get the index inside the parent renderable
      *
      * @return int
-     * @api
      */
     public function getIndex(): int;
 
@@ -83,7 +82,6 @@ interface RenderableInterface extends RootRenderableInterface
      * Get the template name of the renderable
      *
      * @return string
-     * @api
      */
     public function getTemplateName(): string;
 
@@ -91,7 +89,6 @@ interface RenderableInterface extends RootRenderableInterface
      * Returns whether this renderable is enabled
      *
      * @return bool
-     * @api
      */
     public function isEnabled(): bool;
 }
index da97744..0c5e70e 100644 (file)
@@ -32,7 +32,6 @@ interface RootRenderableInterface
      * the particular element.
      *
      * @return string
-     * @api
      */
     public function getType(): string;
 
@@ -40,7 +39,6 @@ interface RootRenderableInterface
      * The identifier of this renderable
      *
      * @return string
-     * @api
      */
     public function getIdentifier(): string;
 
@@ -48,7 +46,6 @@ interface RootRenderableInterface
      * Get the label which shall be displayed next to the form element
      *
      * @return string
-     * @api
      */
     public function getLabel(): string;
 
@@ -57,7 +54,6 @@ interface RootRenderableInterface
      * must implement RendererInterface
      *
      * @return string the renderer class name
-     * @api
      */
     public function getRendererClassName(): string;
 
@@ -65,7 +61,6 @@ interface RootRenderableInterface
      * Get all rendering options
      *
      * @return array associative array of rendering options
-     * @api
      */
     public function getRenderingOptions(): array;
 }
index f01b99c..46f0e7f 100644 (file)
@@ -39,7 +39,6 @@ interface VariableRenderableInterface
      * Get all rendering variants
      *
      * @return RenderableVariantInterface[]
-     * @api
      */
     public function getVariants(): array;
 
@@ -47,7 +46,6 @@ interface VariableRenderableInterface
      * Adds the specified variant to this form element
      *
      * @param RenderableVariantInterface $variant
-     * @api
      */
     public function addVariant(RenderableVariantInterface $variant);
 }
index a9e5492..1db4e20 100644 (file)
@@ -24,7 +24,6 @@ use TYPO3\CMS\Form\Domain\Runtime\FormRuntime;
  *
  * Scope: frontend
  * **This class is meant to be sub classed by developers**.
- * @api
  */
 abstract class AbstractElementRenderer implements RendererInterface
 {
@@ -33,13 +32,11 @@ abstract class AbstractElementRenderer implements RendererInterface
      * The assigned controller context which might be needed by the renderer.
      *
      * @var \TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext
-     * @api
      */
     protected $controllerContext;
 
     /**
      * @var \TYPO3\CMS\Form\Domain\Runtime\FormRuntime
-     * @api
      */
     protected $formRuntime;
 
@@ -47,7 +44,6 @@ abstract class AbstractElementRenderer implements RendererInterface
      * Set the controller context which should be used
      *
      * @param \TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext
-     * @api
      */
     public function setControllerContext(\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext)
     {
@@ -56,7 +52,6 @@ abstract class AbstractElementRenderer implements RendererInterface
 
     /**
      * @param FormRuntime $formRuntime
-     * @api
      */
     public function setFormRuntime(FormRuntime $formRuntime)
     {
@@ -65,7 +60,6 @@ abstract class AbstractElementRenderer implements RendererInterface
 
     /**
      * @return FormRuntime
-     * @api
      */
     public function getFormRuntime(): FormRuntime
     {
index dab48a2..6066536 100644 (file)
@@ -34,7 +34,6 @@ interface RendererInterface
      * Set the controller context which should be used
      *
      * @param ControllerContext $controllerContext
-     * @api
      */
     public function setControllerContext(ControllerContext $controllerContext);
 
@@ -43,19 +42,16 @@ interface RendererInterface
      * on each $renderable
      *
      * @return string the rendered $formRuntime
-     * @api
      */
     public function render(): string;
 
     /**
      * @param FormRuntime $formRuntime
-     * @api
      */
     public function setFormRuntime(FormRuntime $formRuntime);
 
     /**
      * @return FormRuntime
-     * @api
      */
     public function getFormRuntime(): FormRuntime;
 }
index 69cb433..88cc63e 100644 (file)
@@ -21,8 +21,6 @@ use TYPO3\CMS\Form\Domain\Exception;
  * This Exception is thrown in the FormRuntime if the PropertyMapper throws
  * a \TYPO3\CMS\Extbase\Property\Exception. It adds some more Information to
  * better understand why the PropertyMapper failed to map the properties
- *
- * @api
  */
 class PropertyMappingException extends Exception
 {
index 32aba76..a4a0a36 100644 (file)
@@ -85,7 +85,6 @@ use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
  *
  * Scope: frontend
  * **This class is NOT meant to be sub classed by developers.**
- * @api
  */
 class FormRuntime implements RootRenderableInterface, \ArrayAccess
 {
@@ -177,7 +176,6 @@ class FormRuntime implements RootRenderableInterface, \ArrayAccess
      * @param FormDefinition $formDefinition
      * @param Request $request
      * @param Response $response
-     * @api
      */
     public function __construct(FormDefinition $formDefinition, Request $request, Response $response)
     {
@@ -580,7 +578,6 @@ class FormRuntime implements RootRenderableInterface, \ArrayAccess
      * some kind of "preview" of the form (e.g. form editor).
      *
      * @param int $pageIndex
-     * @api
      */
     public function overrideCurrentPage(int $pageIndex)
     {
@@ -592,7 +589,6 @@ class FormRuntime implements RootRenderableInterface, \ArrayAccess
      *
      * @return string|null rendered form
      * @throws RenderingException
-     * @api
      */
     public function render()
     {
@@ -658,7 +654,6 @@ class FormRuntime implements RootRenderableInterface, \ArrayAccess
 
     /**
      * @return string The identifier of underlying form
-     * @api
      */
     public function getIdentifier(): string
     {
@@ -672,7 +667,6 @@ class FormRuntime implements RootRenderableInterface, \ArrayAccess
      * the user to another page.
      *
      * @return Request the request this object is bound to
-     * @api
      */
     public function getRequest(): Request
     {
@@ -686,7 +680,6 @@ class FormRuntime implements RootRenderableInterface, \ArrayAccess
      * headers or output content.
      *
      * @return Response the response this object is bound to
-     * @api
      */
     public function getResponse(): Response
     {
@@ -697,7 +690,6 @@ class FormRuntime implements RootRenderableInterface, \ArrayAccess
      * Returns the currently selected page
      *
      * @return Page|null
-     * @api
      */
     public function getCurrentPage(): ?Page
     {
@@ -708,7 +700,6 @@ class FormRuntime implements RootRenderableInterface, \ArrayAccess
      * Returns the previous page of the currently selected one or NULL if there is no previous page
      *
      * @return Page|null
-     * @api
      */
     public function getPreviousPage(): ?Page
     {
@@ -723,7 +714,6 @@ class FormRuntime implements RootRenderableInterface, \ArrayAccess
      * Returns the next page of the currently selected one or NULL if there is no next page
      *
      * @return Page|null
-     * @api
      */
     public function getNextPage(): ?Page
     {
@@ -739,7 +729,6 @@ class FormRuntime implements RootRenderableInterface, \ArrayAccess
      * or NULL if there is no previous page
      *
      * @return Page|null
-     * @api
      */
     public function getPreviousEnabledPage(): ?Page
     {
@@ -769,7 +758,6 @@ class FormRuntime implements RootRenderableInterface, \ArrayAccess
      * NULL if there is no next page
      *
      * @return Page|null
-     * @api
      */
     public function getNextEnabledPage(): ?Page
     {
@@ -819,7 +807,6 @@ class FormRuntime implements RootRenderableInterface, \ArrayAccess
      * the particular element.
      *
      * @return string
-     * @api
      */
     public function getType(): string
     {
@@ -895,7 +882,6 @@ class FormRuntime implements RootRenderableInterface, \ArrayAccess
      *
      * @param string $identifier
      * @return mixed
-     * @api
      */
     public function getElementValue(string $identifier)
     {
@@ -908,7 +894,6 @@ class FormRuntime implements RootRenderableInterface, \ArrayAccess
 
     /**
      * @return array<Page> The Form's pages in the correct order
-     * @api
      */
     public function getPages(): array
     {
@@ -928,7 +913,6 @@ class FormRuntime implements RootRenderableInterface, \ArrayAccess
      * Get all rendering options
      *
      * @return array associative array of rendering options
-     * @api
      */
     public function getRenderingOptions(): array
     {
@@ -940,7 +924,6 @@ class FormRuntime implements RootRenderableInterface, \ArrayAccess
      * must implement RendererInterface
      *
      * @return string the renderer class name
-     * @api
      */
     public function getRendererClassName(): string
     {
@@ -951,7 +934,6 @@ class FormRuntime implements RootRenderableInterface, \ArrayAccess
      * Get the label which shall be displayed next to the form element
      *
      * @return string
-     * @api
      */
     public function getLabel(): string
     {
@@ -962,7 +944,6 @@ class FormRuntime implements RootRenderableInterface, \ArrayAccess
      * Get the template name of the renderable
      *
      * @return string
-     * @api
      */
     public function getTemplateName(): string
     {
@@ -973,7 +954,6 @@ class FormRuntime implements RootRenderableInterface, \ArrayAccess
      * Get the underlying form definition from the runtime
      *
      * @return FormDefinition
-     * @api
      */
     public function getFormDefinition(): FormDefinition
     {
@@ -984,7 +964,6 @@ class FormRuntime implements RootRenderableInterface, \ArrayAccess
      * Get the current site language configuration.
      *
      * @return SiteLanguage
-     * @api
      */
     public function getCurrentSiteLanguage(): ?SiteLanguage
     {
@@ -998,7 +977,6 @@ class FormRuntime implements RootRenderableInterface, \ArrayAccess
      * helpful when displaying some kind of "preview" of the form (e.g. form editor).
      *
      * @param SiteLanguage $currentSiteLanguage
-     * @api
      */
     public function setCurrentSiteLanguage(SiteLanguage $currentSiteLanguage): void
     {
@@ -1049,7 +1027,6 @@ class FormRuntime implements RootRenderableInterface, \ArrayAccess
      * Reference to the current running finisher
      *
      * @return FinisherInterface|null
-     * @api
      */
     public function getCurrentFinisher(): ?FinisherInterface
     {
index d06959e..61161af 100644 (file)
@@ -19,8 +19,6 @@ use TYPO3\CMS\Core\Error\Exception as CoreException;
 
 /**
  * A generic Form Exception
- *
- * @api
  */
 class Exception extends CoreException
 {
index 2bc5fa7..3e6b60e 100644 (file)
@@ -21,6 +21,7 @@ use TYPO3\CMS\Filelist\FileListEditIconHookInterface;
 use TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager;
 
 /**
+ * @internal
  */
 class FileListEditIconsHook implements FileListEditIconHookInterface
 {
index bf4dffe..7e689e7 100644 (file)
@@ -38,6 +38,7 @@ use TYPO3\CMS\Install\Updates\UpgradeWizardInterface;
 
 /**
  * Update wizard to migrate all forms currently in use to new ending
+ * @internal
  */
 class FormFileExtensionUpdate implements ChattyInterface, UpgradeWizardInterface
 {
index bd60609..a02effb 100644 (file)
@@ -21,6 +21,7 @@ use TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager;
 
 /**
  * Purges previously added form files from items for context menus.
+ * @internal
  */
 class FormFileProvider extends FileProvider
 {
index a324108..3a02634 100644 (file)
@@ -33,6 +33,7 @@ use TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManagerInterface;
 
 /**
  * Contains a preview rendering for the page module of CType="form_formframework"
+ * @internal
  */
 class FormPagePreviewRenderer implements PageLayoutViewDrawItemHookInterface
 {
index 60b33f4..1177827 100644 (file)
@@ -18,6 +18,7 @@ use TYPO3\CMS\Form\Mvc\Configuration\Exception;
 
 /**
  * Exception for file write errors
+ * @internal
  */
 class FileWriteException extends Exception
 {
index c616ce3..a49dd81 100644 (file)
@@ -18,6 +18,7 @@ use TYPO3\CMS\Form\Mvc\Configuration\Exception;
 
 /**
  * A No Such File exception
+ * @internal
  */
 class NoSuchFileException extends Exception
 {
index 4768265..c164b80 100644 (file)
@@ -18,6 +18,7 @@ use TYPO3\CMS\Form\Mvc\Configuration\Exception;
 
 /**
  * A Parse Error exception
+ * @internal
  */
 class ParseErrorException extends Exception
 {
index 3c46e90..aaa441e 100644 (file)
@@ -26,15 +26,15 @@ class TypoScriptService
 {
 
     /**
-     * @var \TYPO3\CMS\Extbase\Service\TypoScriptService
+     * @var \TYPO3\CMS\Core\TypoScript\TypoScriptService
      */
     protected $extbaseTypoScriptService;
 
     /**
-     * @param \TYPO3\CMS\Extbase\Service\TypoScriptService $typoScriptService
+     * @param \TYPO3\CMS\Core\TypoScript\TypoScriptService $typoScriptService
      * @internal
      */
-    public function injectTypoScriptService(\TYPO3\CMS\Extbase\Service\TypoScriptService $typoScriptService)
+    public function injectTypoScriptService(\TYPO3\CMS\Core\TypoScript\TypoScriptService $typoScriptService)
     {
         $this->extbaseTypoScriptService = $typoScriptService;
     }
index dab7333..bab4a51 100644 (file)
@@ -32,7 +32,6 @@ interface FormPersistenceManagerInterface
      *
      * @param string $persistenceIdentifier
      * @return array
-     * @api
      */
     public function load(string $persistenceIdentifier): array;
 
@@ -41,7 +40,6 @@ interface FormPersistenceManagerInterface
      *
      * @param string $persistenceIdentifier
      * @param array $formDefinition
-     * @api
      */
     public function save(string $persistenceIdentifier, array $formDefinition);
 
@@ -50,7 +48,6 @@ interface FormPersistenceManagerInterface
      *
      * @param string $persistenceIdentifier
      * @return bool TRUE if a form with the given $persistenceIdentifier can be loaded, otherwise FALSE
-     * @api
      */
     public function exists(string $persistenceIdentifier): bool;
 
@@ -58,7 +55,6 @@ interface FormPersistenceManagerInterface
      * Delete the form representation identified by $persistenceIdentifier
      *
      * @param string $persistenceIdentifier
-     * @api
      */
     public function delete(string $persistenceIdentifier);
 
@@ -70,7 +66,6 @@ interface FormPersistenceManagerInterface
      * 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'], [ .... ]]
-     * @api
      */
     public function listForms(): array;
 
@@ -78,7 +73,6 @@ interface FormPersistenceManagerInterface
      * Return a list of all accessible file mount points
      *
      * @return Folder[]
-     * @api
      */
     public function getAccessibleFormStorageFolders(): array;
 
@@ -86,7 +80,6 @@ interface FormPersistenceManagerInterface
      * Return a list of all accessible extension folders
      *
      * @return array
-     * @api
      */
     public function getAccessibleExtensionFolders(): array;
 
@@ -96,7 +89,6 @@ interface FormPersistenceManagerInterface
      * @param string $formIdentifier
      * @param string $savePath
      * @return string
-     * @api
      */
     public function getUniquePersistenceIdentifier(string $formIdentifier, string $savePath): string;
 
@@ -105,7 +97,6 @@ interface FormPersistenceManagerInterface
      *
      * @param string $identifier
      * @return bool
-     * @api
      */
     public function checkForDuplicateIdentifier(string $identifier): bool;
 }
index 2d4110d..fce12cf 100644 (file)
@@ -28,6 +28,7 @@ use TYPO3\CMS\Form\Mvc\Validation\MimeTypeValidator;
 
 /**
  * Scope: frontend
+ * @internal
  */
 class PropertyMappingConfiguration
 {
index f33a20b..b05b76f 100644 (file)
@@ -39,7 +39,6 @@ class CountValidator extends AbstractValidator
      * The given value is valid if it is an array or \Countable that contains the specified amount of elements.
      *
      * @param mixed $value
-     * @api
      */
     public function isValid($value)
     {
index 159fc34..14939e7 100644 (file)
@@ -22,7 +22,6 @@ use TYPO3\CMS\Form\Mvc\Validation\Exception\InvalidValidationOptionsException;
  * Validator for date ranges
  *
  * Scope: frontend
- * @api
  */
 class DateRangeValidator extends AbstractValidator
 {
@@ -37,7 +36,6 @@ class DateRangeValidator extends AbstractValidator
 
     /**
      * @param \DateTime $value The value that should be validated
-     * @api
      */
     public function isValid($value)
     {
index 23b02cf..bb117d6 100644 (file)
@@ -21,7 +21,6 @@ use TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator;
  * Validator for empty values.
  *
  * Scope: frontend
- * @api
  */
 class EmptyValidator extends AbstractValidator
 {
@@ -37,7 +36,6 @@ class EmptyValidator extends AbstractValidator
      * Checks if the given property ($propertyValue) is empty (NULL, empty string, empty array or empty object).
      *
      * @param mixed $value The value that should be validated
-     * @api
      */
     public function isValid($value)
     {
index 8db958c..dac31f3 100644 (file)
@@ -41,7 +41,6 @@ class FileSizeValidator extends AbstractValidator
      * The given value is valid
      *
      * @param FileReference|File $resource
-     * @api
      */
     public function isValid($resource)
     {
index 9b4ed87..c5a749a 100644 (file)
@@ -24,7 +24,6 @@ use TYPO3\CMS\Form\Mvc\Validation\Exception\InvalidValidationOptionsException;
  * Validator for mime types
  *
  * Scope: frontend
- * @api
  */
 class MimeTypeValidator extends AbstractValidator
 {
@@ -42,7 +41,6 @@ class MimeTypeValidator extends AbstractValidator
      * Note: a value of NULL or empty string ('') is considered valid
      *
      * @param FileReference|File $resource The resource that should be validated
-     * @api
      */
     public function isValid($resource)
     {
index 30ef444..40933b4 100644 (file)
@@ -218,7 +218,6 @@ class TranslationService implements SingletonInterface
      * @param array $renderingOptions
      * @return string
      * @throws \InvalidArgumentException
-     * @api
      */
     public function translateFinisherOption(
         FormRuntime $formRuntime,
index 35500c7..584fa12 100644 (file)
@@ -17,6 +17,7 @@ namespace TYPO3\CMS\Form\Type;
 
 /**
  * Wrapper for basic form definition arrays
+ * @internal
  */
 class FormDefinitionArray extends \ArrayObject
 {
index 2a9b3de..db00837 100644 (file)
@@ -28,7 +28,6 @@ use TYPO3\CMS\Form\ViewHelpers\RenderRenderableViewHelper;
  * Note: Requires jQuery UI to be included on the page.
  *
  * Scope: frontend
- * @api
  */
 class DatePickerViewHelper extends AbstractFormFieldViewHelper
 {
@@ -54,8 +53,6 @@ class DatePickerViewHelper extends AbstractFormFieldViewHelper
 
     /**
      * Initialize the arguments.
-     *
-     * @api
      */
     public function initializeArguments()
     {
@@ -74,7 +71,6 @@ class DatePickerViewHelper extends AbstractFormFieldViewHelper
      * Renders the text field, hidden field and required javascript
      *
      * @return string
-     * @api
      */
     public function render()
     {
index 3dcabd7..1dab97b 100644 (file)
@@ -18,13 +18,13 @@ namespace TYPO3\CMS\Form\ViewHelpers\Form;
  */
 
 use TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper;
+use TYPO3\CMS\Form\Domain\Runtime\FormRuntime;
 use TYPO3\CMS\Form\ViewHelpers\RenderRenderableViewHelper;
 
 /**
  * Displays two select-boxes for hour and minute selection.
  *
  * Scope: frontend
- * @api
  */
 class TimePickerViewHelper extends AbstractFormFieldViewHelper
 {
@@ -69,7 +69,6 @@ class TimePickerViewHelper extends AbstractFormFieldViewHelper
      * Renders the select fields for hour & minute
      *
      * @return string
-     * @api
      */
     public function render()
     {
index a3e284f..e5a3e7b 100644 (file)
@@ -26,7 +26,6 @@ use TYPO3\CMS\Fluid\ViewHelpers\Form\UploadViewHelper;
  * uploaded image will be correctly used.
  *
  * Scope: frontend
- * @api
  */
 class UploadedResourceViewHelper extends UploadViewHelper
 {
@@ -73,7 +72,6 @@ class UploadedResourceViewHelper extends UploadViewHelper
 
     /**
      * @return string
-     * @api
      */
     public function render()
     {
index b603b5e..411de75 100644 (file)
@@ -25,7 +25,6 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\TagBuilder;
  * Custom form ViewHelper that renders the form state instead of referrer fields
  *
  * Scope: frontend
- * @api
  */
 class FormViewHelper extends FluidFormViewHelper
 {
index 4ce9f83..cd08ae9 100644 (file)
@@ -23,7 +23,6 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 
 /**
  * Scope: frontend
- * @api
  */
 class GridColumnClassAutoConfigurationViewHelper extends AbstractViewHelper
 {
index 28c6731..60d4943 100644 (file)
@@ -31,7 +31,6 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * Renders the values of a form
  *
  * Scope: frontend
- * @api
  */
 class RenderAllFormValuesViewHelper extends AbstractViewHelper
 {
@@ -60,7 +59,6 @@ class RenderAllFormValuesViewHelper extends AbstractViewHelper
      * @param \Closure $renderChildrenClosure
      * @param RenderingContextInterface $renderingContext
      * @return string the rendered form values
-     * @api
      */
     public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
     {
@@ -128,6 +126,7 @@ class RenderAllFormValuesViewHelper extends AbstractViewHelper
      * @param \Closure $renderChildrenClosure
      * @param RenderingContextInterface $renderingContext
      * @return mixed
+     * @internal
      */
     public static function processElementValue(
         FormElementInterface $element,
@@ -160,6 +159,7 @@ class RenderAllFormValuesViewHelper extends AbstractViewHelper
      * @param array $value
      * @param array $options
      * @return array
+     * @internal
      */
     public static function mapValuesToOptions(array $value, array $options): array
     {
@@ -177,6 +177,7 @@ class RenderAllFormValuesViewHelper extends AbstractViewHelper
      * @param mixed $value
      * @param array $options
      * @return mixed
+     * @internal
      */
     public static function mapValueToOption($value, array $options)
     {
@@ -189,6 +190,7 @@ class RenderAllFormValuesViewHelper extends AbstractViewHelper
      * @param FormElementInterface $element
      * @param object $object
      * @return string
+     * @internal
      */
     public static function processObject(FormElementInterface $element, $object): string
     {
@@ -231,6 +233,7 @@ class RenderAllFormValuesViewHelper extends AbstractViewHelper
     /**
      * @param RenderableInterface $renderable
      * @return bool
+     * @internal
      */
     public static function hasDisabledParent(RenderableInterface $renderable): bool
     {
index 557d15c..feb8386 100644 (file)
@@ -32,7 +32,6 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * and return the rendered content.
  *
  * Scope: frontend
- * @api
  */
 class RenderRenderableViewHelper extends AbstractViewHelper
 {
@@ -58,6 +57,7 @@ class RenderRenderableViewHelper extends AbstractViewHelper
      * @param \Closure $renderChildrenClosure
      * @param RenderingContextInterface $renderingContext
      * @return string
+     * @internal
      */
     public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
     {
index 8ef2919..d570bf2 100644 (file)
@@ -41,7 +41,6 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * The factory class must implement {@link TYPO3\CMS\Form\Domain\Factory\FormFactoryInterface}.
  *
  * Scope: frontend
- * @api
  */
 class RenderViewHelper extends AbstractViewHelper
 {
index 37e3182..2f60c5b 100644 (file)
@@ -27,7 +27,6 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * Translate form element properites.
  *
  * Scope: frontend / backend
- * @api
  */
 class TranslateElementErrorViewHelper extends AbstractViewHelper
 {
@@ -54,7 +53,6 @@ class TranslateElementErrorViewHelper extends AbstractViewHelper
      * @param \Closure $renderChildrenClosure
      * @param RenderingContextInterface $renderingContext
      * @return string
-     * @api
      */
     public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
     {
@@ -71,7 +69,7 @@ class TranslateElementErrorViewHelper extends AbstractViewHelper
             $defaultValue = $error->__toString();
         } else {
             trigger_error(
-                'TranslateElementErrorViewHelper arguments "code", "arguments" and "defaultValue" has been deprecated in v8 and will be removed in TYPO3 v10.0. Use "error" instead.',
+                'TranslateElementErrorViewHelper arguments "code", "arguments" and "defaultValue" will be removed in TYPO3 v10.0. Use "error" instead.',
                 E_USER_DEPRECATED
             );
         }
index cb2a413..3c42e0b 100644 (file)
@@ -24,10 +24,9 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Exception;
 use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 
 /**
- * Translate form element properites.
+ * Translate form element properties.
  *
  * Scope: frontend / backend
- * @api
  */
 class TranslateElementPropertyViewHelper extends AbstractViewHelper
 {
@@ -52,7 +51,6 @@ class TranslateElementPropertyViewHelper extends AbstractViewHelper
      * @param \Closure $renderChildrenClosure
      * @param RenderingContextInterface $renderingContext
      * @return string|array
-     * @api
      */
     public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
     {
index f01ede7..7db8149 100644 (file)
@@ -17,9 +17,7 @@ namespace TYPO3\CMS\Form\Tests\Unit\Mvc\Validation\Fixtures;
 use TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator;
 
 /**
- * Validator for unit tetst
- *
- * @api
+ * Validator for unit test
  */
 class TestValidator extends AbstractValidator
 {