first commit

typo3/sysext/form/Documentation/ApiReference/AbstractRenderable/getRootForm.rst

@@ -0,0 +1,8 @@
+getRootForm()
+'''''''''''''
+
+Get the root form the element belongs to.
+
+Signature::
+
+   public function getRootForm(): FormDefinition

typo3/sysext/form/Documentation/ApiReference/AbstractRenderable/setIdentifier.rst

@@ -0,0 +1,8 @@
+setIdentifier()
+'''''''''''''''
+
+Set the identifier of the form element.
+
+Signature::
+
+   public function setIdentifier(string $identifier);

typo3/sysext/form/Documentation/ApiReference/AbstractRenderable/setLabel.rst

@@ -0,0 +1,8 @@
+setLabel()
+''''''''''
+
+Set the label of the form element.
+
+Signature::
+
+   public function setLabel(string $label);

typo3/sysext/form/Documentation/ApiReference/AbstractRenderable/setOptions.rst

@@ -0,0 +1,9 @@
+setOptions()
+''''''''''''
+
+Set multiple properties of this object at once.
+Every property which has a corresponding set* method can be set using the passed $options array.
+
+Signature::
+
+   public function setOptions(array $options);

typo3/sysext/form/Documentation/ApiReference/AbstractSection/addElement.rst

@@ -0,0 +1,9 @@
+addElement()
+''''''''''''
+
+Add a new form element at the end.
+Instead of this method, you should use ``createElement`` instead.
+
+Signature::
+
+   public function addElement(FormElementInterface $formElement);

typo3/sysext/form/Documentation/ApiReference/AbstractSection/getElements.rst

@@ -0,0 +1,8 @@
+getElements()
+'''''''''''''
+
+Get the child form elements.
+
+Signature::
+
+   public function getElements(): array;

typo3/sysext/form/Documentation/ApiReference/AbstractSection/getElementsRecursively.rst

@@ -0,0 +1,8 @@
+getElementsRecursively()
+''''''''''''''''''''''''
+
+Returns all RenderableInterface instances of this composite renderable recursively.
+
+Signature::
+
+   public function getElementsRecursively(): array;

typo3/sysext/form/Documentation/ApiReference/AbstractSection/moveElementAfter.rst

@@ -0,0 +1,9 @@
+moveElementAfter()
+''''''''''''''''''
+
+Move FormElement $elementToMove after $referenceElement.
+Both $elementToMove and $referenceElement must be direct descendants of this Section/Page.
+
+Signature::
+
+   public function moveElementAfter(FormElementInterface $elementToMove, FormElementInterface $referenceElement);

typo3/sysext/form/Documentation/ApiReference/AbstractSection/moveElementBefore.rst

@@ -0,0 +1,9 @@
+moveElementBefore()
+'''''''''''''''''''
+
+Move FormElement $elementToMove before $referenceElement.
+Both $elementToMove and $referenceElement must be direct descendants of this Section/Page.
+
+Signature::
+
+   public function moveElementBefore(FormElementInterface $elementToMove, FormElementInterface $referenceElement);

typo3/sysext/form/Documentation/ApiReference/AbstractSection/removeElement.rst

@@ -0,0 +1,8 @@
+removeElement()
+'''''''''''''''
+
+Remove $elementToRemove from this Section/Page.
+
+Signature::
+
+   public function removeElement(FormElementInterface $elementToRemove);

typo3/sysext/form/Documentation/ApiReference/FormElementInterface/addValidator.rst

@@ -0,0 +1,8 @@
+addValidator()
+''''''''''''''
+
+Registers a validator for the form element.
+
+Signature::
+
+   public function addValidator(ValidatorInterface $validator);

typo3/sysext/form/Documentation/ApiReference/FormElementInterface/createValidator.rst

@@ -0,0 +1,8 @@
+createValidator()
+'''''''''''''''''
+
+Create a validator for the element.
+
+Signature::
+
+   public function createValidator(string $validatorIdentifier, array $options = []);

typo3/sysext/form/Documentation/ApiReference/FormElementInterface/getDefaultValue.rst

@@ -0,0 +1,8 @@
+getDefaultValue()
+'''''''''''''''''
+
+Get the default value with which the form element should be initialized during display.
+
+Signature::
+
+   public function getDefaultValue();

typo3/sysext/form/Documentation/ApiReference/FormElementInterface/getProperties.rst

@@ -0,0 +1,8 @@
+getProperties()
+'''''''''''''''
+
+Get all element-specific configuration properties.
+
+Signature::
+
+   public function getProperties(): array;

typo3/sysext/form/Documentation/ApiReference/FormElementInterface/getUniqueIdentifier.rst

@@ -0,0 +1,37 @@
+getUniqueIdentifier()
+'''''''''''''''''''''
+
+Returns a unique identifier of the element. While element identifiers are only unique within one form,
+this identifier includes also the identifier of the form itself, and therefore making it "globally" unique.
+
+Signature::
+
+   public function getUniqueIdentifier(): string;
+
+Example:
+
+.. code-block:: yaml
+
+   identifier: exampleForm
+   label: 'Simple Contact Form'
+   prototype: standard
+   type: Form
+
+   renderables:
+     -
+       identifier: page-1
+       label: 'Contact Form'
+       type: Page
+
+       renderables:
+         -
+           identifier: name
+           label: 'Name'
+           type: Text
+           defaultValue: ''
+
+::
+
+   // $formElement->getIdentifier() == 'name'
+   $uniqueIdentifier = $formElement->getUniqueIdentifier();
+   // $uniqueIdentifier == 'exampleForm-name'

typo3/sysext/form/Documentation/ApiReference/FormElementInterface/initializeFormElement.rst

@@ -0,0 +1,8 @@
+initializeFormElement()
+'''''''''''''''''''''''
+
+Will be called as soon as the element is (tried to be) added to a form.
+
+Signature::
+
+   public function initializeFormElement();

typo3/sysext/form/Documentation/ApiReference/FormElementInterface/isRequired.rst

@@ -0,0 +1,9 @@
+isRequired()
+''''''''''''
+
+Whether or not the element is required.
+An element is required if the ``TYPO3\CMS\Extbase\Validation\Validator\NotEmptyValidator`` is attached to the element.
+
+Signature::
+
+   public function isRequired(): bool;

typo3/sysext/form/Documentation/ApiReference/FormElementInterface/setDataType.rst

@@ -0,0 +1,16 @@
+setDataType()
+'''''''''''''
+
+The target data type the data should be converted through the property mapper.
+
+Signature::
+
+   public function setDataType(string $dataType);
+
+Example::
+
+   public function initializeFormElement()
+   {
+       $this->setDataType('TYPO3\CMS\Extbase\Domain\Model\FileReference');
+       parent::initializeFormElement();
+   }

typo3/sysext/form/Documentation/ApiReference/FormElementInterface/setDefaultValue.rst

@@ -0,0 +1,8 @@
+setDefaultValue()
+'''''''''''''''''
+
+Set the default value with which the form element should be initialized during display.
+
+Signature::
+
+   public function setDefaultValue($defaultValue);

typo3/sysext/form/Documentation/ApiReference/FormElementInterface/setProperty.rst

@@ -0,0 +1,8 @@
+setProperty()
+'''''''''''''
+
+Set an element-specific configuration property.
+
+Signature::
+
+   public function setProperty(string $key, $value);

typo3/sysext/form/Documentation/ApiReference/FormElementInterface/setRenderingOption.rst

@@ -0,0 +1,8 @@
+setRenderingOption()
+''''''''''''''''''''
+
+Set a rendering option.
+
+Signature::
+
+   public function setRenderingOption(string $key, $value);

typo3/sysext/form/Documentation/ApiReference/RenderableInterface/getParentRenderable.rst

@@ -0,0 +1,8 @@
+getParentRenderable()
+'''''''''''''''''''''
+
+Return the parent form element.
+
+Signature::
+
+   public function getParentRenderable();

typo3/sysext/form/Documentation/ApiReference/RenderableInterface/getTemplateName.rst

@@ -0,0 +1,8 @@
+getTemplateName()
+'''''''''''''''''
+
+Get the template name of the form element.
+
+Signature::
+
+   public function getTemplateName(): string;

typo3/sysext/form/Documentation/ApiReference/RenderableInterface/setParentRenderable.rst

@@ -0,0 +1,9 @@
+setParentRenderable()
+'''''''''''''''''''''
+
+Set the new parent renderable. You should not call this directly.
+It is automatically called by addRenderable.
+
+Signature::
+
+   public function setParentRenderable(CompositeRenderableInterface $renderable);

typo3/sysext/form/Documentation/ApiReference/RootRenderableInterface/getIdentifier.rst

@@ -0,0 +1,8 @@
+getIdentifier()
+'''''''''''''''
+
+Returns the identifier of the form element.
+
+Signature::
+
+   public function getIdentifier(): string;

typo3/sysext/form/Documentation/ApiReference/RootRenderableInterface/getLabel.rst

@@ -0,0 +1,8 @@
+getLabel()
+''''''''''
+
+Get the label of the form element.
+
+Signature::
+
+   public function getLabel(): string;

typo3/sysext/form/Documentation/ApiReference/RootRenderableInterface/getRendererClassName.rst

@@ -0,0 +1,8 @@
+getRendererClassName()
+''''''''''''''''''''''
+
+Get the renderer class name.
+
+Signature::
+
+   public function getRendererClassName(): string;

typo3/sysext/form/Documentation/ApiReference/RootRenderableInterface/getRenderingOptions.rst

@@ -0,0 +1,8 @@
+getRenderingOptions()
+'''''''''''''''''''''
+
+Get all rendering options of the form element.
+
+Signature::
+
+   public function getRenderingOptions(): array;

typo3/sysext/form/Documentation/ApiReference/RootRenderableInterface/getType.rst

@@ -0,0 +1,9 @@
+getType()
+'''''''''
+
+Abstract "type" of the form element.
+For example, the type is used during the rendering process to determine the template file.
+
+Signature::
+
+   public function getType(): string;