[TASK] Streamline phpdoc annotations in EXT:fluid 25/58525/3
authorBenni Mack <benni@typo3.org>
Mon, 1 Oct 2018 11:59:15 +0000 (13:59 +0200)
committerOliver Hader <oliver.hader@typo3.org>
Mon, 1 Oct 2018 13:50:31 +0000 (15:50 +0200)
EXT:fluid 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:fluid: 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: #86507
Releases: master
Change-Id: I5deba0ba2b868743e7eda8f0e32cda40ef008046
Reviewed-on: https://review.typo3.org/58525
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Wouter Wolters <typo3@wouterwolters.nl>
Tested-by: Wouter Wolters <typo3@wouterwolters.nl>
Reviewed-by: Oliver Hader <oliver.hader@typo3.org>
Tested-by: Oliver Hader <oliver.hader@typo3.org>
60 files changed:
typo3/sysext/fluid/Classes/Core/Cache/FluidTemplateCache.php
typo3/sysext/fluid/Classes/Core/ViewHelper/ViewHelperResolver.php
typo3/sysext/fluid/Classes/Core/Widget/AbstractWidgetController.php
typo3/sysext/fluid/Classes/Core/Widget/AbstractWidgetViewHelper.php
typo3/sysext/fluid/Classes/Core/Widget/AjaxWidgetContextHolder.php
typo3/sysext/fluid/Classes/Core/Widget/Bootstrap.php
typo3/sysext/fluid/Classes/Core/Widget/Exception.php
typo3/sysext/fluid/Classes/Core/Widget/Exception/MissingControllerException.php
typo3/sysext/fluid/Classes/Core/Widget/Exception/RenderingContextNotFoundException.php
typo3/sysext/fluid/Classes/Core/Widget/Exception/WidgetContextNotFoundException.php
typo3/sysext/fluid/Classes/Core/Widget/Exception/WidgetRequestNotFoundException.php
typo3/sysext/fluid/Classes/Core/Widget/WidgetContext.php
typo3/sysext/fluid/Classes/Core/Widget/WidgetRequest.php
typo3/sysext/fluid/Classes/Core/Widget/WidgetRequestHandler.php
typo3/sysext/fluid/Classes/View/AbstractTemplateView.php
typo3/sysext/fluid/Classes/View/StandaloneView.php
typo3/sysext/fluid/Classes/View/TemplatePaths.php
typo3/sysext/fluid/Classes/View/TemplateView.php
typo3/sysext/fluid/Classes/ViewHelpers/BaseViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Be/Menus/ActionMenuItemGroupViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Be/Menus/ActionMenuViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Be/Security/IfAuthenticatedViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Be/Security/IfHasRoleViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Be/Widget/PaginateViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Debug/RenderViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/FlashMessagesViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/AbstractFormFieldViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/ButtonViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/CheckboxViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/HiddenViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/PasswordViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/RadioViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/Select/OptgroupViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/Select/OptionViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/SelectViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/SubmitViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/TextareaViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/TextfieldViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/UploadViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/ValidationResultsViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/BytesViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/CaseViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/CropViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/CurrencyViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/HtmlentitiesDecodeViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/HtmlentitiesViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/JsonViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/StripTagsViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Link/ExternalViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/RenderChildrenViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Security/IfAuthenticatedViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Security/IfHasRoleViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Uri/ActionViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Uri/EmailViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Uri/ExternalViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Uri/ResourceViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Widget/AutocompleteViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Widget/LinkViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Widget/PaginateViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Widget/UriViewHelper.php

index 0aa47f6..d7a98e0 100644 (file)
@@ -25,6 +25,8 @@ use TYPO3Fluid\Fluid\Core\Cache\StandardCacheWarmer;
  *
  * Connector class that enables the TYPO3 cache called "fluid_template" to be operated with the
  * interface appropriate for the Fluid engine.
+ *
+ * @internal
  */
 class FluidTemplateCache extends PhpFrontend implements FluidCacheInterface
 {
index 6afbfbc..a355f53 100644 (file)
@@ -45,6 +45,8 @@ use TYPO3\CMS\Extbase\Object\ObjectManagerInterface;
  * to automatically add or extend namespaces which then become
  * available in every Fluid template file without having to
  * register the namespace.
+ *
+ * @internal This is a helper class which is not considered part of TYPO3's Public API.
  */
 class ViewHelperResolver extends \TYPO3Fluid\Fluid\Core\ViewHelper\ViewHelperResolver
 {
index 3de5a80..5bbdb0e 100644 (file)
@@ -20,8 +20,6 @@ use TYPO3\CMS\Fluid\View\TemplatePaths;
  * This is the base class for all widget controllers.
  * It is basically an ActionController and additionally has $this->widgetConfiguration set to the
  * Configuration of the current Widget.
- *
- * @api
  */
 abstract class AbstractWidgetController extends \TYPO3\CMS\Extbase\Mvc\Controller\ActionController implements \TYPO3\CMS\Core\SingletonInterface
 {
@@ -34,7 +32,6 @@ abstract class AbstractWidgetController extends \TYPO3\CMS\Extbase\Mvc\Controlle
      * Configuration for this widget.
      *
      * @var array
-     * @api
      */
     protected $widgetConfiguration;
 
@@ -43,7 +40,6 @@ abstract class AbstractWidgetController extends \TYPO3\CMS\Extbase\Mvc\Controlle
      *
      * @param \TYPO3\CMS\Extbase\Mvc\RequestInterface $request The request object
      * @param \TYPO3\CMS\Extbase\Mvc\ResponseInterface $response The response, modified by this handler
-     * @api
      */
     public function processRequest(\TYPO3\CMS\Extbase\Mvc\RequestInterface $request, \TYPO3\CMS\Extbase\Mvc\ResponseInterface $response)
     {
index 9e369af..b7954cf 100644 (file)
@@ -19,7 +19,6 @@ use TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\ViewHelperNode;
 use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
 
 /**
- * @api
  */
 abstract class AbstractWidgetViewHelper extends AbstractViewHelper
 {
@@ -28,7 +27,6 @@ abstract class AbstractWidgetViewHelper extends AbstractViewHelper
      * This needs to be filled by the individual subclass by an inject method.
      *
      * @var \TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetController
-     * @api
      */
     protected $controller;
 
@@ -36,7 +34,6 @@ abstract class AbstractWidgetViewHelper extends AbstractViewHelper
      * If set to TRUE, it is an AJAX widget.
      *
      * @var bool
-     * @api
      */
     protected $ajaxWidget = false;
 
@@ -67,6 +64,7 @@ abstract class AbstractWidgetViewHelper extends AbstractViewHelper
 
     /**
      * @param \TYPO3\CMS\Fluid\Core\Widget\AjaxWidgetContextHolder $ajaxWidgetContextHolder
+     * @internal
      */
     public function injectAjaxWidgetContextHolder(\TYPO3\CMS\Fluid\Core\Widget\AjaxWidgetContextHolder $ajaxWidgetContextHolder)
     {
@@ -75,6 +73,7 @@ abstract class AbstractWidgetViewHelper extends AbstractViewHelper
 
     /**
      * @param \TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager
+     * @internal
      */
     public function injectObjectManager(\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
     {
@@ -84,6 +83,7 @@ abstract class AbstractWidgetViewHelper extends AbstractViewHelper
 
     /**
      * @param \TYPO3\CMS\Extbase\Service\ExtensionService $extensionService
+     * @internal
      */
     public function injectExtensionService(\TYPO3\CMS\Extbase\Service\ExtensionService $extensionService)
     {
@@ -92,6 +92,7 @@ abstract class AbstractWidgetViewHelper extends AbstractViewHelper
 
     /**
      * Initialize arguments.
+     * @internal
      */
     public function initializeArguments()
     {
@@ -108,6 +109,7 @@ abstract class AbstractWidgetViewHelper extends AbstractViewHelper
      * Initialize the arguments of the ViewHelper, and call the render() method of the ViewHelper.
      *
      * @return string the rendered ViewHelper.
+     * @internal
      */
     public function initializeArgumentsAndRender()
     {
@@ -142,6 +144,7 @@ abstract class AbstractWidgetViewHelper extends AbstractViewHelper
      * rendered with <f:widget.renderChildren> lateron.
      *
      * @param array $childNodes The SyntaxTree Child nodes of this ViewHelper.
+     * @internal
      */
     public function setChildNodes(array $childNodes)
     {
@@ -156,7 +159,6 @@ abstract class AbstractWidgetViewHelper extends AbstractViewHelper
      * Generate the configuration for this widget. Override to adjust.
      *
      * @return array
-     * @api
      */
     protected function getWidgetConfiguration()
     {
@@ -169,7 +171,6 @@ abstract class AbstractWidgetViewHelper extends AbstractViewHelper
      *
      * @return \TYPO3\CMS\Extbase\Mvc\ResponseInterface the response of this request.
      * @throws \TYPO3\CMS\Fluid\Core\Widget\Exception\MissingControllerException
-     * @api
      */
     protected function initiateSubRequest()
     {
index 2c4ed84..b97102e 100644 (file)
@@ -19,7 +19,7 @@ namespace TYPO3\CMS\Fluid\Core\Widget;
  * of the current user, to make sure the WidgetContext is available in
  * Widget AJAX requests.
  *
- * This class is only used internally by the widget framework.
+ * @internal This class is only used internally by the widget framework.
  */
 class AjaxWidgetContextHolder implements \TYPO3\CMS\Core\SingletonInterface
 {
index ee7053c..934ca1e 100644 (file)
@@ -16,6 +16,8 @@ namespace TYPO3\CMS\Fluid\Core\Widget;
 
 /**
  * This is the bootstrap for Ajax Widget responses
+ *
+ * @internal This class is only used internally by the widget framework.
  */
 class Bootstrap
 {
index 599fb46..b50757a 100644 (file)
@@ -16,8 +16,6 @@ namespace TYPO3\CMS\Fluid\Core\Widget;
 
 /**
  * A Fluid Widget exception.
- *
- * @api
  */
 class Exception extends \TYPO3Fluid\Fluid\Core\Exception
 {
index 179c324..29b0bc9 100644 (file)
@@ -16,6 +16,8 @@ namespace TYPO3\CMS\Fluid\Core\Widget\Exception;
 
 /**
  * An exception if the controller is missing.
+ *
+ * @internal
  */
 class MissingControllerException extends \TYPO3\CMS\Fluid\Core\Widget\Exception
 {
index 67df3bd..ce8143a 100644 (file)
@@ -16,6 +16,8 @@ namespace TYPO3\CMS\Fluid\Core\Widget\Exception;
 
 /**
  * An exception if no widget context could be found inside the AjaxWidgetContextHolder.
+ *
+ * @internal
  */
 class RenderingContextNotFoundException extends \TYPO3\CMS\Fluid\Core\Widget\Exception
 {
index 3fa1e56..436c61d 100644 (file)
@@ -16,6 +16,8 @@ namespace TYPO3\CMS\Fluid\Core\Widget\Exception;
 
 /**
  * An exception if no widget context could be found inside the AjaxWidgetContextHolder.
+ *
+ * @internal
  */
 class WidgetContextNotFoundException extends \TYPO3\CMS\Fluid\Core\Widget\Exception
 {
index bc3a1d0..dcc1ec2 100644 (file)
@@ -16,6 +16,8 @@ namespace TYPO3\CMS\Fluid\Core\Widget\Exception;
 
 /**
  * An exception if no widget Request could be found inside <f:renderChildren>.
+ *
+ * @internal
  */
 class WidgetRequestNotFoundException extends \TYPO3\CMS\Fluid\Core\Widget\Exception
 {
index 743c34c..3c9f47e 100644 (file)
@@ -23,7 +23,7 @@ namespace TYPO3\CMS\Fluid\Core\Widget;
  * by various ViewHelpers (like <f:widget.link>, <f:widget.uri>, <f:widget.renderChildren>),
  * to get knowledge over the current widget's configuration.
  *
- * It is a purely internal class which should not be used outside of Fluid.
+ * @internal It is a purely internal class which should not be used outside of Fluid.
  */
 class WidgetContext
 {
index 635d609..f90a1ca 100644 (file)
@@ -16,6 +16,7 @@ namespace TYPO3\CMS\Fluid\Core\Widget;
 
 /**
  * Represents a widget request.
+ * @internal It is a purely internal class which should not be used outside of Fluid.
  */
 class WidgetRequest extends \TYPO3\CMS\Extbase\Mvc\Web\Request
 {
index a9ee9e3..93cacf1 100644 (file)
@@ -19,6 +19,7 @@ namespace TYPO3\CMS\Fluid\Core\Widget;
  * f3-fluid-widget-id is found.
  *
  * This Request Handler gets the WidgetRequestBuilder injected.
+ * @internal It is a purely internal class which should not be used outside of Fluid.
  */
 class WidgetRequestHandler extends \TYPO3\CMS\Extbase\Mvc\Web\AbstractRequestHandler
 {
index 9cdc8b6..a02a9c9 100644 (file)
@@ -35,8 +35,6 @@ abstract class AbstractTemplateView extends TemplateView implements \TYPO3\CMS\E
 
     /**
      * Initializes this view.
-     *
-     * @api
      */
     public function initializeView()
     {
@@ -44,6 +42,7 @@ abstract class AbstractTemplateView extends TemplateView implements \TYPO3\CMS\E
 
     /**
      * @param RenderingContextInterface $context
+     * @internal
      */
     public function __construct(RenderingContextInterface $context = null)
     {
@@ -61,7 +60,6 @@ abstract class AbstractTemplateView extends TemplateView implements \TYPO3\CMS\E
      *
      * @param \TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext Controller context which is available inside the view
      * @return bool TRUE if the view has something useful to display, otherwise FALSE
-     * @api
      */
     public function canRender(\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext)
     {
@@ -72,6 +70,7 @@ abstract class AbstractTemplateView extends TemplateView implements \TYPO3\CMS\E
      * Sets the current controller context
      *
      * @param \TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext
+     * @internal
      */
     public function setControllerContext(\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext)
     {
@@ -86,6 +85,7 @@ abstract class AbstractTemplateView extends TemplateView implements \TYPO3\CMS\E
 
     /**
      * @param string $templateName
+     * @internal
      */
     public function setTemplate($templateName)
     {
@@ -97,7 +97,6 @@ abstract class AbstractTemplateView extends TemplateView implements \TYPO3\CMS\E
      * dynamic resolving of a template file.
      *
      * @param string $templatePathAndFilename Template file path
-     * @api
      */
     public function setTemplatePathAndFilename($templatePathAndFilename)
     {
@@ -109,7 +108,6 @@ abstract class AbstractTemplateView extends TemplateView implements \TYPO3\CMS\E
      * If set, overrides the one determined from $this->templateRootPathPattern
      *
      * @param string[] $templateRootPaths Root path(s) to the templates. If set, overrides the one determined from $this->templateRootPathPattern
-     * @api
      */
     public function setTemplateRootPaths(array $templateRootPaths)
     {
@@ -130,7 +128,6 @@ abstract class AbstractTemplateView extends TemplateView implements \TYPO3\CMS\E
      * If set, overrides the one determined from $this->partialRootPathPattern
      *
      * @param string[] $partialRootPaths Root paths to the partials. If set, overrides the one determined from $this->partialRootPathPattern
-     * @api
      */
     public function setPartialRootPaths(array $partialRootPaths)
     {
@@ -142,7 +139,6 @@ abstract class AbstractTemplateView extends TemplateView implements \TYPO3\CMS\E
      *
      * @return string[] Fluid partial root paths
      * @throws InvalidTemplateResourceException
-     * @api
      */
     public function getPartialRootPaths()
     {
@@ -154,7 +150,6 @@ abstract class AbstractTemplateView extends TemplateView implements \TYPO3\CMS\E
      *
      * @return string[] Fluid layout root paths
      * @throws InvalidTemplateResourceException
-     * @api
      */
     public function getLayoutRootPaths()
     {
@@ -166,7 +161,6 @@ abstract class AbstractTemplateView extends TemplateView implements \TYPO3\CMS\E
      * If set, overrides the one determined from $this->layoutRootPathPattern
      *
      * @param string[] $layoutRootPaths Root path to the layouts. If set, overrides the one determined from $this->layoutRootPathPattern
-     * @api
      */
     public function setLayoutRootPaths(array $layoutRootPaths)
     {
index 958a050..60c410b 100644 (file)
@@ -27,8 +27,6 @@ use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
 /**
  * A standalone template view.
  * Should be used as view if you want to use Fluid without Extbase extensions
- *
- * @api
  */
 class StandaloneView extends AbstractTemplateView
 {
@@ -77,7 +75,6 @@ class StandaloneView extends AbstractTemplateView
      *
      * @param string $format
      * @throws \RuntimeException
-     * @api
      */
     public function setFormat($format)
     {
@@ -94,7 +91,6 @@ class StandaloneView extends AbstractTemplateView
      *
      * @return string $format
      * @throws \RuntimeException
-     * @api
      */
     public function getFormat()
     {
@@ -109,6 +105,7 @@ class StandaloneView extends AbstractTemplateView
      *
      * @return WebRequest
      * @throws \RuntimeException
+     * @internal
      */
     public function getRequest()
     {
@@ -126,7 +123,6 @@ class StandaloneView extends AbstractTemplateView
      * and return that template path and filename directly, instead of attempting to resolve it.
      *
      * @return string Fluid template path
-     * @api
      */
     public function getTemplatePathAndFilename()
     {
@@ -143,7 +139,6 @@ class StandaloneView extends AbstractTemplateView
      * You can use setTemplatePathAndFilename() alternatively if you only want to specify the template path
      *
      * @param string $templateSource Fluid template source code
-     * @api
      */
     public function setTemplateSource($templateSource)
     {
@@ -154,7 +149,6 @@ class StandaloneView extends AbstractTemplateView
      * Checks whether a template can be resolved for the current request
      *
      * @return bool
-     * @api
      */
     public function hasTemplate()
     {
index 21d0ced..9124ffe 100644 (file)
@@ -27,6 +27,8 @@ use TYPO3\CMS\Extbase\Object\ObjectManager;
  * Custom implementation for template paths resolving, one which differs from the base
  * implementation in that it is capable of resolving template paths based on TypoScript
  * configuration when given a package name, and is aware of the Frontend/Backend contexts of TYPO3.
+ *
+ * @internal This is for internal Fluid use only.
  */
 class TemplatePaths extends \TYPO3Fluid\Fluid\View\TemplatePaths
 {
index aa9e75f..c7b7427 100644 (file)
@@ -19,8 +19,6 @@ use TYPO3Fluid\Fluid\View\Exception\InvalidTemplateResourceException;
 
 /**
  * The main template view. Should be used as view if you want Fluid Templating
- *
- * @api
  */
 class TemplateView extends AbstractTemplateView
 {
@@ -28,7 +26,6 @@ class TemplateView extends AbstractTemplateView
      * Sets the path and name of the layout file. Overrides the dynamic resolving of the layout file.
      *
      * @param string $layoutPathAndFilename Path and filename of the layout file
-     * @api
      */
     public function setLayoutPathAndFilename($layoutPathAndFilename)
     {
@@ -40,7 +37,6 @@ class TemplateView extends AbstractTemplateView
      *
      * @param ControllerContext $controllerContext Controller context which is available inside the view
      * @return bool
-     * @api
      */
     public function canRender(ControllerContext $controllerContext)
     {
index 26d7fcf..4ce3731 100644 (file)
@@ -32,8 +32,6 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * <base href="http://yourdomain.tld/" />
  * (depending on your domain)
  * </output>
- *
- * @api
  */
 class BaseViewHelper extends AbstractViewHelper
 {
@@ -57,7 +55,6 @@ class BaseViewHelper extends AbstractViewHelper
      * @param RenderingContextInterface $renderingContext
      *
      * @return string "base"-Tag.
-     * @api
      */
     public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
     {
index ef5d876..902dd17 100644 (file)
@@ -44,7 +44,6 @@ class ActionMenuItemGroupViewHelper extends ActionMenuViewHelper
     /**
      * Initialize arguments.
      *
-     * @api
      * @throws \TYPO3Fluid\Fluid\Core\ViewHelper\Exception
      */
     public function initializeArguments()
index 6752388..3bffaf9 100644 (file)
@@ -63,7 +63,6 @@ class ActionMenuViewHelper extends AbstractTagBasedViewHelper
     /**
      * Initialize arguments.
      *
-     * @api
      * @throws \TYPO3Fluid\Fluid\Core\ViewHelper\Exception
      */
     public function initializeArguments()
index 01bba6d..49e5bbb 100644 (file)
@@ -44,8 +44,6 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractConditionViewHelper;
  * Everything inside the "then" tag is displayed if you have access.
  * Otherwise, everything inside the "else"-tag is displayed.
  * </output>
- *
- * @api
  */
 class IfAuthenticatedViewHelper extends AbstractConditionViewHelper
 {
index f03b625..ff37b95 100644 (file)
@@ -53,8 +53,6 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractConditionViewHelper;
  * Everything inside the "then" tag is displayed if the logged in BE user belongs to the specified role.
  * Otherwise, everything inside the "else"-tag is displayed.
  * </output>
- *
- * @api
  */
 class IfHasRoleViewHelper extends AbstractConditionViewHelper
 {
index a40ee07..f80b07a 100644 (file)
@@ -43,8 +43,6 @@ use TYPO3\CMS\Extbase\Persistence\QueryResultInterface;
  * so the paginate ViewHelper will adjust the query sent to the database and receive
  * only the small subset of objects.
  * So, there is no negative performance overhead in using the Be Paginate Widget.
- *
- * @api
  */
 class PaginateViewHelper extends \TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper
 {
index 8abd175..1f964ad 100644 (file)
@@ -27,8 +27,6 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
  * (see ViewHelperResolver class). Also possible to use
  * explicitly by using `f:debug.render` instead of the
  * normal `f:render` statement.
- *
- * @api
  */
 class RenderViewHelper extends AbstractViewHelper
 {
@@ -57,7 +55,6 @@ class RenderViewHelper extends AbstractViewHelper
      * Renders the content.
      *
      * @return string
-     * @api
      */
     public function render()
     {
index 0b2a6a6..bb106a9 100644 (file)
@@ -76,8 +76,6 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * <code title="Using a specific queue">
  * <f:flashMessages queueIdentifier="myQueue" />
  * </code>
- *
- * @api
  */
 class FlashMessagesViewHelper extends AbstractViewHelper
 {
@@ -92,8 +90,6 @@ class FlashMessagesViewHelper extends AbstractViewHelper
 
     /**
      * Initialize arguments
-     *
-     * @api
      */
     public function initializeArguments()
     {
index b6c7f0b..6ddfa4b 100644 (file)
@@ -21,8 +21,6 @@ use TYPO3\CMS\Extbase\Reflection\ObjectAccess;
  *
  * If you set the "property" attribute to the name of the property to resolve from the object, this class will
  * automatically set the name and value of a form element.
- *
- * @api
  */
 abstract class AbstractFormFieldViewHelper extends AbstractFormViewHelper
 {
@@ -46,8 +44,6 @@ abstract class AbstractFormFieldViewHelper extends AbstractFormViewHelper
 
     /**
      * Initialize arguments.
-     *
-     * @api
      */
     public function initializeArguments()
     {
index f15139b..9159b1d 100644 (file)
@@ -32,8 +32,6 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  * <output>
  * <button disabled="disabled" formmethod="post" formnovalidate="formnovalidate" type="reset" name="myForm[buttonName]" value="buttonValue">Cancel</button>
  * </output>
- *
- * @api
  */
 class ButtonViewHelper extends AbstractFormFieldViewHelper
 {
@@ -46,7 +44,6 @@ class ButtonViewHelper extends AbstractFormFieldViewHelper
      * Initialize the arguments.
      *
      * @throws \TYPO3Fluid\Fluid\Core\ViewHelper\Exception
-     * @api
      */
     public function initializeArguments()
     {
@@ -95,7 +92,6 @@ class ButtonViewHelper extends AbstractFormFieldViewHelper
      * Renders the button.
      *
      * @return string
-     * @api
      */
     public function render()
     {
index 727b81b..6f9fd52 100644 (file)
@@ -41,8 +41,6 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  * <input type="checkbox" name="user[interests][]" value="TYPO3" checked="checked" />
  * (depending on property "interests")
  * </output>
- *
- * @api
  */
 class CheckboxViewHelper extends AbstractFormFieldViewHelper
 {
@@ -53,8 +51,6 @@ class CheckboxViewHelper extends AbstractFormFieldViewHelper
 
     /**
      * Initialize the arguments.
-     *
-     * @api
      */
     public function initializeArguments()
     {
@@ -82,7 +78,6 @@ class CheckboxViewHelper extends AbstractFormFieldViewHelper
      *
      * @throws \TYPO3\CMS\Fluid\Core\ViewHelper\Exception
      * @return string
-     * @api
      */
     public function render()
     {
index 3a20b8f..6a816b7 100644 (file)
@@ -28,8 +28,6 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  *
  * You can also use the "property" attribute if you have bound an object to the form.
  * See <f:form> for more documentation.
- *
- * @api
  */
 class HiddenViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
 {
@@ -40,8 +38,6 @@ class HiddenViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFie
 
     /**
      * Initialize the arguments.
-     *
-     * @api
      */
     public function initializeArguments()
     {
@@ -53,7 +49,6 @@ class HiddenViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFie
      * Renders the hidden field.
      *
      * @return string
-     * @api
      */
     public function render()
     {
index 9e0c1ea..9bbee52 100644 (file)
@@ -25,8 +25,6 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  * <output>
  * <input type="password" name="myPassword" value="default value" />
  * </output>
- *
- * @api
  */
 class PasswordViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
 {
@@ -37,8 +35,6 @@ class PasswordViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormF
 
     /**
      * Initialize the arguments.
-     *
-     * @api
      */
     public function initializeArguments()
     {
@@ -70,7 +66,6 @@ class PasswordViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormF
      * Renders the password input field.
      *
      * @return string
-     * @api
      */
     public function render()
     {
index 0eedcb8..eeab4d0 100644 (file)
@@ -43,8 +43,6 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  * <input type="radio" name="user[newsletter]" value="0" /> no
  * (depending on property "newsletter")
  * </output>
- *
- * @api
  */
 class RadioViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
 {
@@ -55,8 +53,6 @@ class RadioViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFiel
 
     /**
      * Initialize the arguments.
-     *
-     * @api
      */
     public function initializeArguments()
     {
@@ -82,7 +78,6 @@ class RadioViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFiel
      * Renders the checkbox.
      *
      * @return string
-     * @api
      */
     public function render()
     {
index 76880f3..266d0d8 100644 (file)
@@ -17,8 +17,6 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form\Select;
 /**
  * Adds custom `<optgroup>` tags inside an `<f:form.select>`,
  * supports further child `<f:form.select.option>` tags.
- *
- * @api
  */
 class OptgroupViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
 {
index 37a8527..77fd067 100644 (file)
@@ -17,8 +17,6 @@ use TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper;
 
 /**
  * Adds custom `<option>` tags inside an `<f:form.select>`
- *
- * @api
  */
 class OptionViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
 {
index 14d02c6..089dc68 100644 (file)
@@ -72,8 +72,6 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  * So, in the above example, the method $user->getId() is called to retrieve the key, and $user->getFirstName() to retrieve the displayed value of each entry.
  *
  * The "value" property now expects a domain object, and tests for object equivalence.
- *
- * @api
  */
 class SelectViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
 {
@@ -89,8 +87,6 @@ class SelectViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFie
 
     /**
      * Initialize arguments.
-     *
-     * @api
      */
     public function initializeArguments()
     {
@@ -115,7 +111,6 @@ class SelectViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFie
      * Render the tag.
      *
      * @return string rendered tag.
-     * @api
      */
     public function render()
     {
index 5ffe072..07386b5 100644 (file)
@@ -32,8 +32,6 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  * <output>
  * <input type="submit" name="mySubmit" value="Send Mail" />
  * </output>
- *
- * @api
  */
 class SubmitViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
 {
@@ -44,8 +42,6 @@ class SubmitViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFie
 
     /**
      * Initialize the arguments.
-     *
-     * @api
      */
     public function initializeArguments()
     {
@@ -62,7 +58,6 @@ class SubmitViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFie
      * Renders the submit button.
      *
      * @return string
-     * @api
      */
     public function render()
     {
index 03e0abb..57e3f90 100644 (file)
@@ -26,8 +26,6 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  * <output>
  * <textarea name="myTextArea">This is shown inside the textarea</textarea>
  * </output>
- *
- * @api
  */
 class TextareaViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
 {
@@ -38,8 +36,6 @@ class TextareaViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormF
 
     /**
      * Initialize the arguments.
-     *
-     * @api
      */
     public function initializeArguments()
     {
@@ -59,7 +55,6 @@ class TextareaViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormF
      * Renders the textarea.
      *
      * @return string
-     * @api
      */
     public function render()
     {
index 005664f..9a830ed 100644 (file)
@@ -25,8 +25,6 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  * <output>
  * <input type="text" name="myTextBox" value="default value" />
  * </output>
- *
- * @api
  */
 class TextfieldViewHelper extends AbstractFormFieldViewHelper
 {
@@ -39,7 +37,6 @@ class TextfieldViewHelper extends AbstractFormFieldViewHelper
      * Initialize the arguments.
      *
      * @throws \TYPO3Fluid\Fluid\Core\ViewHelper\Exception
-     * @api
      */
     public function initializeArguments()
     {
@@ -61,7 +58,6 @@ class TextfieldViewHelper extends AbstractFormFieldViewHelper
      * Renders the textfield.
      *
      * @return string
-     * @api
      */
     public function render()
     {
index 7516bd3..09ea8f8 100644 (file)
@@ -26,8 +26,6 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  * <output>
  * <input type="file" name="file" />
  * </output>
- *
- * @api
  */
 class UploadViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
 {
@@ -38,8 +36,6 @@ class UploadViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFie
 
     /**
      * Initialize the arguments.
-     *
-     * @api
      */
     public function initializeArguments()
     {
@@ -54,7 +50,6 @@ class UploadViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFie
      * Renders the upload field.
      *
      * @return string
-     * @api
      */
     public function render()
     {
index e3790cb..6922901 100644 (file)
@@ -62,8 +62,6 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  *   <li>1234567890: Some error message</li>
  * </ul>
  * </output>
- *
- * @api
  */
 class ValidationResultsViewHelper extends AbstractViewHelper
 {
@@ -78,8 +76,6 @@ class ValidationResultsViewHelper extends AbstractViewHelper
 
     /**
      * Initialize arguments
-     *
-     * @api
      */
     public function initializeArguments()
     {
index a65034a..56d6929 100644 (file)
@@ -49,8 +49,6 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderS
  * 123 KB
  * // depending on the value of {fileSize}
  * </output>
- *
- * @api
  */
 class BytesViewHelper extends AbstractViewHelper
 {
index 5ea70c7..1ad185e 100644 (file)
@@ -60,8 +60,6 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * <output>
  * SomeString
  * </output>
- *
- * @api
  */
 class CaseViewHelper extends AbstractViewHelper
 {
index 6791254..330edd2 100644 (file)
@@ -76,7 +76,6 @@ class CropViewHelper extends AbstractViewHelper
     /**
      * Initialize arguments.
      *
-     * @api
      * @throws \TYPO3Fluid\Fluid\Core\ViewHelper\Exception
      */
     public function initializeArguments()
index d8418fd..7861543 100644 (file)
@@ -51,8 +51,6 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * <output>
  * 123,-
  * </output>
- *
- * @api
  */
 class CurrencyViewHelper extends AbstractViewHelper
 {
index 9ed1a22..02b985a 100644 (file)
@@ -36,8 +36,6 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderS
  * <output>
  * Text with &amp; &quot; &lt; &gt; replaced by unescaped entities (html_entity_decode applied).
  * </output>
- *
- * @api
  */
 class HtmlentitiesDecodeViewHelper extends AbstractEncodingViewHelper
 {
index 0495f12..7778514 100644 (file)
@@ -36,8 +36,6 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderS
  * <output>
  * Text with & " ' < > * replaced by HTML entities (htmlentities applied).
  * </output>
- *
- * @api
  */
 class HtmlentitiesViewHelper extends AbstractEncodingViewHelper
 {
index 8e4ca6a..9927818 100644 (file)
@@ -46,8 +46,6 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderS
  * <output>
  * {"0":"bar","1":"baz"}
  * </output>
- *
- * @api
  */
 class JsonViewHelper extends AbstractViewHelper
 {
index 50c194d..51eaf59 100644 (file)
@@ -52,8 +52,6 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderS
  * <output>
  * Text with p, span, div and script Tags inside, all other tags are removed
  * </output>
- *
- * @api
  */
 class StripTagsViewHelper extends AbstractViewHelper
 {
index 734280e..0aaedbe 100644 (file)
@@ -34,8 +34,6 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  * <output>
  * <a href="ftp://typo3.org">external ftp link</a>
  * </output>
- *
- * @api
  */
 class ExternalViewHelper extends AbstractTagBasedViewHelper
 {
@@ -46,8 +44,6 @@ class ExternalViewHelper extends AbstractTagBasedViewHelper
 
     /**
      * Initialize arguments
-     *
-     * @api
      */
     public function initializeArguments()
     {
@@ -63,7 +59,6 @@ class ExternalViewHelper extends AbstractTagBasedViewHelper
 
     /**
      * @return string Rendered link
-     * @api
      */
     public function render()
     {
index b27f2cf..b7eb989 100644 (file)
@@ -24,8 +24,6 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  *
  * It renders everything inside the Widget ViewHelper, and you can pass additional
  * arguments.
- *
- * @api
  */
 class RenderChildrenViewHelper extends AbstractViewHelper
 {
index c8c8f66..5e8862d 100644 (file)
@@ -46,8 +46,6 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractConditionViewHelper;
  * Everything inside the "then" tag is displayed if you have access.
  * Otherwise, everything inside the "else"-tag is displayed.
  * </output>
- *
- * @api
  */
 class IfAuthenticatedViewHelper extends AbstractConditionViewHelper
 {
index 179920d..66332e6 100644 (file)
@@ -56,8 +56,6 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractConditionViewHelper;
  * Everything inside the "then" tag is displayed if the logged in FE user belongs to the specified role.
  * Otherwise, everything inside the "else"-tag is displayed.
  * </output>
- *
- * @api
  */
 class IfHasRoleViewHelper extends AbstractConditionViewHelper
 {
index 63c6d56..11f16cd 100644 (file)
@@ -37,8 +37,6 @@ class ActionViewHelper extends AbstractViewHelper
 
     /**
      * Initialize arguments
-     *
-     * @api
      */
     public function initializeArguments()
     {
index 7f6dc36..a02514f 100644 (file)
@@ -38,8 +38,6 @@ class EmailViewHelper extends AbstractViewHelper
 
     /**
      * Initialize arguments
-     *
-     * @api
      */
     public function initializeArguments()
     {
index ba56ce6..0f1e729 100644 (file)
@@ -37,8 +37,6 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * <output>
  * ftp://typo3.org
  * </output>
- *
- * @api
  */
 class ExternalViewHelper extends AbstractViewHelper
 {
index f7d451a..e3752c8 100644 (file)
@@ -39,8 +39,6 @@ class ResourceViewHelper extends AbstractViewHelper
 
     /**
      * Initialize arguments
-     *
-     * @api
      */
     public function initializeArguments()
     {
index e926384..f43bdbb 100644 (file)
@@ -34,8 +34,6 @@ use TYPO3\CMS\Extbase\Persistence\QueryResultInterface;
  * <input type="text" id="name" />
  * the input field and the required JavaScript for the Ajax communication (see Resources/Private/Templates/ViewHelpers/Widget/Autocomplete/Index.html
  * </output>
- *
- * @api
  */
 class AutocompleteViewHelper extends \TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper
 {
index 0d0dc0c..d3c2a95 100644 (file)
@@ -28,8 +28,6 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  * <a href="index.php?id=123&tx_myextension_plugin[widgetIdentifier][action]=show&tx_myextension_plugin[widgetIdentifier][controller]=Standard&cHash=xyz">link</a>
  * (depending on the current page, widget and your TS configuration)
  * </output>
- *
- * @api
  */
 class LinkViewHelper extends AbstractTagBasedViewHelper
 {
@@ -40,8 +38,6 @@ class LinkViewHelper extends AbstractTagBasedViewHelper
 
     /**
      * Initialize arguments
-     *
-     * @api
      */
     public function initializeArguments()
     {
@@ -64,7 +60,6 @@ class LinkViewHelper extends AbstractTagBasedViewHelper
      * Render the link.
      *
      * @return string The rendered link
-     * @api
      */
     public function render()
     {
index 36ebeb1..071565d 100644 (file)
@@ -44,8 +44,6 @@ use TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper;
  * so the paginate ViewHelper will adjust the query sent to the database and receive
  * only the small subset of objects.
  * So, there is no negative performance overhead in using the Paginate Widget.
- *
- * @api
  */
 class PaginateViewHelper extends AbstractWidgetViewHelper
 {
@@ -65,7 +63,6 @@ class PaginateViewHelper extends AbstractWidgetViewHelper
     /**
      * Initialize arguments.
      *
-     * @api
      * @throws \TYPO3Fluid\Fluid\Core\ViewHelper\Exception
      */
     public function initializeArguments()
index 57f2220..b7f342a 100644 (file)
@@ -30,8 +30,6 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * index.php?id=123&tx_myextension_plugin[widgetIdentifier][action]=show&tx_myextension_plugin[widgetIdentifier][controller]=Standard&cHash=xyz
  * (depending on the current page, widget and your TS configuration)
  * </output>
- *
- * @api
  */
 class UriViewHelper extends AbstractViewHelper
 {
@@ -39,8 +37,6 @@ class UriViewHelper extends AbstractViewHelper
 
     /**
      * Initialize arguments
-     *
-     * @api
      */
     public function initializeArguments()
     {