[BUGFIX] Fix several typos in php comments
[Packages/TYPO3.CMS.git] / typo3 / sysext / form / Classes / Domain / Model / Renderable / RenderableInterface.php
index f473dfa..2255251 100644 (file)
@@ -1,10 +1,12 @@
 <?php
-declare(strict_types=1);
+declare(strict_types = 1);
 namespace TYPO3\CMS\Form\Domain\Model\Renderable;
 
 /*
  * This file is part of the TYPO3 CMS project.
  *
+ * It originated from the Neos.Form package (www.neos.io)
+ *
  * 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.
@@ -28,7 +30,7 @@ interface RenderableInterface extends RootRenderableInterface
     /**
      * Return the parent renderable
      *
-     * @return null|CompositeRenderableInterface the parent renderable
+     * @return CompositeRenderableInterface|null the parent renderable
      * @internal
      */
     public function getParentRenderable();
@@ -40,7 +42,6 @@ interface RenderableInterface extends RootRenderableInterface
      * This method should also register itself at the parent form, if possible.
      *
      * @param CompositeRenderableInterface $renderable
-     * @return void
      * @internal
      */
     public function setParentRenderable(CompositeRenderableInterface $renderable);
@@ -49,7 +50,6 @@ interface RenderableInterface extends RootRenderableInterface
      * Set the index of this renderable inside the parent renderable
      *
      * @param int $index
-     * @return void
      * @internal
      */
     public function setIndex(int $index);
@@ -58,35 +58,37 @@ interface RenderableInterface extends RootRenderableInterface
      * Get the index inside the parent renderable
      *
      * @return int
-     * @api
      */
     public function getIndex(): int;
 
     /**
      * This function is called after a renderable has been removed from its parent
      * renderable. The function should make sure to clean up the internal state,
-     * like reseting $this->parentRenderable or deregistering the renderable
-     * at the form.
+     * like resetting $this->parentRenderable or deregistering the renderable
+     * of the form.
      *
-     * @return void
      * @internal
      */
     public function onRemoveFromParentRenderable();
 
     /**
-     * This is a callback that is invoked by the Form Factory after the whole form has been built.
-     * It can be used to add new form elements as children for complex form elements.
+     * Register this element at the parent form, if there is a connection to the parent form.
      *
-     * @return void
-     * @api
+     * @internal
      */
-    public function onBuildingFinished();
+    public function registerInFormIfPossible();
 
     /**
-     * Register this element at the parent form, if there is a connection to the parent form.
+     * Get the template name of the renderable
      *
-     * @return void
-     * @internal
+     * @return string
      */
-    public function registerInFormIfPossible();
+    public function getTemplateName(): string;
+
+    /**
+     * Returns whether this renderable is enabled
+     *
+     * @return bool
+     */
+    public function isEnabled(): bool;
 }