[TASK] Mark various parts with phpdoc internal - part 2 29/58529/2
authorBenni Mack <benni@typo3.org>
Mon, 1 Oct 2018 12:36:07 +0000 (14:36 +0200)
committerWouter Wolters <typo3@wouterwolters.nl>
Mon, 1 Oct 2018 13:44:42 +0000 (15:44 +0200)
All specific controllers for specific Backend actions, Backend-module related modules,
all hook implementations (where the core uses hooks by itself), and module-specific
ViewHelpers are now marked as @internal to ensure developers what is
part of the public TYPO3 Core API.

within
- EXT:seo
- EXT:setup
- EXT:rte_ckeditor
- EXT:workspaces
- EXT:viewpage
- EXT:tstemplate
- EXT:taskcenter
- EXT:t3editor
- EXT:sys_action
- EXT:sys_note

All leftover @api methods have been removed.

Resolves: #86509
Releases: master
Change-Id: I6e5ee2302055de9ea4c124ca913e4677d62721fe
Reviewed-on: https://review.typo3.org/58529
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Oliver Hader <oliver.hader@typo3.org>
Tested-by: Oliver Hader <oliver.hader@typo3.org>
Reviewed-by: Wouter Wolters <typo3@wouterwolters.nl>
Tested-by: Wouter Wolters <typo3@wouterwolters.nl>
48 files changed:
typo3/sysext/rte_ckeditor/Classes/Controller/BrowseLinksController.php
typo3/sysext/rte_ckeditor/Classes/Form/Element/RichTextElement.php
typo3/sysext/rte_ckeditor/Classes/Form/Resolver/RichTextNodeResolver.php
typo3/sysext/seo/Classes/Canonical/CanonicalGenerator.php
typo3/sysext/seo/Classes/MetaTag/OpenGraphMetaTagManager.php
typo3/sysext/seo/Classes/MetaTag/TwitterCardMetaTagManager.php
typo3/sysext/seo/Classes/PageTitle/SeoTitlePageTitleProvider.php
typo3/sysext/seo/Classes/XmlSitemap/PagesXmlSitemapDataProvider.php
typo3/sysext/seo/Classes/XmlSitemap/RecordsXmlSitemapDataProvider.php
typo3/sysext/seo/Classes/XmlSitemap/XmlSitemapRenderer.php
typo3/sysext/setup/Classes/Controller/SetupModuleController.php
typo3/sysext/sys_action/Classes/ActionList.php
typo3/sysext/sys_action/Classes/ActionTask.php
typo3/sysext/sys_action/Classes/Backend/ToolbarItems/ActionToolbarItem.php
typo3/sysext/sys_note/Classes/Hook/InfoModuleHook.php
typo3/sysext/sys_note/Classes/Hook/PageHook.php
typo3/sysext/sys_note/Classes/Hook/RecordListHook.php
typo3/sysext/t3editor/Classes/Addon.php
typo3/sysext/t3editor/Classes/Controller/CodeCompletionController.php
typo3/sysext/t3editor/Classes/Controller/TypoScriptReferenceController.php
typo3/sysext/t3editor/Classes/Exception/InvalidModeException.php
typo3/sysext/t3editor/Classes/Form/Element/T3editorElement.php
typo3/sysext/t3editor/Classes/Hook/FileEditHook.php
typo3/sysext/t3editor/Classes/Mode.php
typo3/sysext/t3editor/Classes/Registry/AddonRegistry.php
typo3/sysext/t3editor/Classes/Registry/ModeRegistry.php
typo3/sysext/t3editor/Classes/T3editor.php
typo3/sysext/taskcenter/Classes/Controller/TaskModuleController.php
typo3/sysext/taskcenter/Classes/Controller/TaskStatusController.php
typo3/sysext/tstemplate/Classes/Controller/TemplateAnalyzerModuleFunctionController.php
typo3/sysext/tstemplate/Classes/Controller/TypoScriptTemplateConstantEditorModuleFunctionController.php
typo3/sysext/tstemplate/Classes/Controller/TypoScriptTemplateInformationModuleFunctionController.php
typo3/sysext/tstemplate/Classes/Controller/TypoScriptTemplateModuleController.php
typo3/sysext/tstemplate/Classes/Controller/TypoScriptTemplateObjectBrowserModuleFunctionController.php
typo3/sysext/viewpage/Classes/Controller/ViewModuleController.php
typo3/sysext/workspaces/Classes/Authentication/PreviewUserAuthentication.php
typo3/sysext/workspaces/Classes/Backend/ToolbarItems/WorkspaceSelectorToolbarItem.php
typo3/sysext/workspaces/Classes/Controller/AjaxController.php
typo3/sysext/workspaces/Classes/Controller/AjaxDispatcher.php
typo3/sysext/workspaces/Classes/Controller/PreviewController.php
typo3/sysext/workspaces/Classes/Controller/Remote/ActionHandler.php
typo3/sysext/workspaces/Classes/Controller/Remote/MassActionHandler.php
typo3/sysext/workspaces/Classes/Controller/Remote/RemoteServer.php
typo3/sysext/workspaces/Classes/Controller/ReviewController.php
typo3/sysext/workspaces/Classes/Hook/BackendUtilityHook.php
typo3/sysext/workspaces/Classes/Hook/DataHandlerHook.php
typo3/sysext/workspaces/Classes/Middleware/WorkspacePreview.php
typo3/sysext/workspaces/Classes/Preview/PreviewUriBuilder.php

index 82581ec..2326368 100644 (file)
@@ -26,6 +26,7 @@ use TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController;
 
 /**
  * Extended controller for link browser
+ * @internal This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
  */
 class BrowseLinksController extends AbstractLinkBrowserController
 {
index 8e3bc6c..295f8a3 100644 (file)
@@ -24,6 +24,7 @@ use TYPO3\CMS\Core\Utility\PathUtility;
 
 /**
  * Render rich text editor in FormEngine
+ * @internal This is a specific Backend FormEngine implementation and is not considered part of the Public TYPO3 API.
  */
 class RichTextElement extends AbstractFormElement
 {
index 5e4bf6d..5529d27 100644 (file)
@@ -21,6 +21,7 @@ use TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement;
 
 /**
  * This resolver will return the RichTextElement render class if RTE is enabled for this field.
+ * @internal This is a specific Backend FormEngine implementation and is not considered part of the Public TYPO3 API.
  */
 class RichTextNodeResolver implements NodeResolverInterface
 {
index 540b9f4..22a276c 100644 (file)
@@ -24,7 +24,7 @@ use TYPO3\CMS\Frontend\Page\PageRepository;
 /**
  * Class to add the canonical tag to the page
  *
- * @internal
+ * @internal this class is not part of TYPO3's Core API.
  */
 class CanonicalGenerator
 {
index dcea320..14eb5bd 100644 (file)
@@ -18,6 +18,9 @@ namespace TYPO3\CMS\Seo\MetaTag;
 
 use TYPO3\CMS\Core\MetaTag\AbstractMetaTagManager;
 
+/**
+ * @internal this class is not part of TYPO3's Core API.
+ */
 class OpenGraphMetaTagManager extends AbstractMetaTagManager
 {
     /**
index 20ef817..5d85000 100644 (file)
@@ -18,6 +18,9 @@ namespace TYPO3\CMS\Seo\MetaTag;
 
 use TYPO3\CMS\Core\MetaTag\AbstractMetaTagManager;
 
+/**
+ * @internal this class is not part of TYPO3's Core API.
+ */
 class TwitterCardMetaTagManager extends AbstractMetaTagManager
 {
     /**
index 77e469e..acebad8 100644 (file)
@@ -20,6 +20,7 @@ use TYPO3\CMS\Core\PageTitle\AbstractPageTitleProvider;
 
 /**
  * This class will take care of the seo title that can be set in the backend
+ * @internal this class is not part of TYPO3's Core API.
  */
 class SeoTitlePageTitleProvider extends AbstractPageTitleProvider
 {
index 608b052..9d85ac6 100644 (file)
@@ -28,6 +28,7 @@ use TYPO3\CMS\Frontend\Page\PageRepository;
 
 /**
  * Class to generate a XML sitemap for pages
+ * @internal this class is not part of TYPO3's Core API.
  */
 class PagesXmlSitemapDataProvider extends AbstractXmlSitemapDataProvider
 {
index 055cf02..da3d9ff 100644 (file)
@@ -24,6 +24,7 @@ use TYPO3\CMS\Seo\XmlSitemap\Exception\MissingConfigurationException;
 
 /**
  * XmlSiteDataProvider will provide information for the XML sitemap for a specific database table
+ * @internal this class is not part of TYPO3's Core API.
  */
 class RecordsXmlSitemapDataProvider extends AbstractXmlSitemapDataProvider
 {
index 6067b7d..302925a 100644 (file)
@@ -27,6 +27,7 @@ use TYPO3\CMS\Seo\XmlSitemap\Exception\InvalidConfigurationException;
 
 /**
  * Class to render the XML Sitemap to be used as a UserFunction
+ * @internal this class is not part of TYPO3's Core API.
  */
 class XmlSitemapRenderer
 {
index 45c6f21..6ebf79d 100644 (file)
@@ -42,6 +42,8 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Script class for the Setup module
+ *
+ * @internal This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
  */
 class SetupModuleController
 {
index 2ebc090..f17b77b 100644 (file)
@@ -18,6 +18,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Class for the list rendering of Web>Task Center module
+ * @internal
  */
 class ActionList extends \TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList
 {
index 638ecd6..692cd95 100644 (file)
@@ -32,6 +32,7 @@ use TYPO3\CMS\Core\Utility\HttpUtility;
 
 /**
  * This class provides a task for the taskcenter
+ * @internal
  */
 class ActionTask implements \TYPO3\CMS\Taskcenter\TaskInterface
 {
index e7490d0..ea59c7e 100644 (file)
@@ -25,6 +25,7 @@ use TYPO3\CMS\SysAction\ActionTask;
 
 /**
  * Adds action links to the backend's toolbar
+ * @internal This is a specific hook implementation and is not considered part of the Public TYPO3 API.
  */
 class ActionToolbarItem implements ToolbarItemInterface
 {
index 9f5510f..3f94bfe 100644 (file)
@@ -20,6 +20,7 @@ use TYPO3\CMS\SysNote\Controller\NoteController;
 
 /**
  * Hook for the info module
+ * @internal This is a specific hook implementation and is not considered part of the Public TYPO3 API.
  */
 class InfoModuleHook
 {
index 050944e..393216a 100644 (file)
@@ -21,6 +21,7 @@ use TYPO3\CMS\SysNote\Domain\Repository\SysNoteRepository;
 
 /**
  * Hook for the page module
+ * @internal This is a specific hook implementation and is not considered part of the Public TYPO3 API.
  */
 class PageHook
 {
index d2e34e1..ac2e079 100644 (file)
@@ -22,6 +22,7 @@ use TYPO3\CMS\SysNote\Domain\Repository\SysNoteRepository;
 
 /**
  * Hook for the list module
+ * @internal This is a specific hook implementation and is not considered part of the Public TYPO3 API.
  */
 class RecordListHook
 {
index 38646d6..ca35f57 100644 (file)
@@ -17,6 +17,7 @@ namespace TYPO3\CMS\T3editor;
 
 /**
  * Represents an addon for CodeMirror
+ * @internal
  */
 class Addon
 {
index 7fa7711..2f8cd10 100644 (file)
@@ -24,6 +24,7 @@ use TYPO3\CMS\Core\Utility\RootlineUtility;
 
 /**
  * Code completion for t3editor
+ * @internal This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
  */
 class CodeCompletionController
 {
index 860e61c..8c60f3c 100644 (file)
@@ -20,6 +20,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Loads TSref information from a XML file an responds to an AJAX call.
+ * @internal This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
  */
 class TypoScriptReferenceController
 {
index e8cd3ac..e27d524 100644 (file)
@@ -19,6 +19,7 @@ use TYPO3\CMS\Core\Exception;
 
 /**
  * Exception thrown for invalid modes
+ * @internal
  */
 class InvalidModeException extends Exception
 {
index 8e78164..8f23804 100644 (file)
@@ -28,6 +28,7 @@ use TYPO3\CMS\T3editor\T3editor;
 
 /**
  * t3editor FormEngine widget
+ * @internal
  */
 class T3editorElement extends AbstractFormElement
 {
index 94faff5..2f92737 100644 (file)
@@ -24,6 +24,7 @@ use TYPO3\CMS\T3editor\T3editor;
 
 /**
  * File edit hook for t3editor
+ * @internal This is a specific hook implementation and is not considered part of the Public TYPO3 API.
  */
 class FileEditHook
 {
index 1d0d42c..1cccdfe 100644 (file)
@@ -17,6 +17,7 @@ namespace TYPO3\CMS\T3editor;
 
 /**
  * Represents a mode for CodeMirror
+ * @internal
  */
 class Mode
 {
index f56a933..f31f545 100644 (file)
@@ -21,6 +21,7 @@ use TYPO3\CMS\T3editor\Addon;
 
 /**
  * Registers and holds t3editor modes
+ * @internal
  */
 class AddonRegistry implements SingletonInterface
 {
index 265d156..b288752 100644 (file)
@@ -22,6 +22,7 @@ use TYPO3\CMS\T3editor\Mode;
 
 /**
  * Registers and holds t3editor modes
+ * @internal
  */
 class ModeRegistry implements SingletonInterface
 {
index b27c546..327f0d6 100644 (file)
@@ -26,6 +26,7 @@ use TYPO3\CMS\T3editor\Registry\ModeRegistry;
 
 /**
  * Provides necessary code to setup a t3editor instance in FormEngine
+ * @internal
  */
 class T3editor implements SingletonInterface
 {
index c84d788..e731eaf 100644 (file)
@@ -34,6 +34,7 @@ use TYPO3\CMS\Taskcenter\TaskInterface;
 
 /**
  * This class provides a task center for BE users
+ * @internal This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
  */
 class TaskModuleController
 {
index 85caf79..e0f9eb9 100644 (file)
@@ -20,6 +20,7 @@ use TYPO3\CMS\Core\Http\JsonResponse;
 
 /**
  * Status of tasks
+ * @internal This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
  */
 class TaskStatusController
 {
index 3d540bc..b7a70c0 100644 (file)
@@ -25,6 +25,7 @@ use TYPO3\CMS\Fluid\View\StandaloneView;
 
 /**
  * TypoScript template analyzer
+ * @internal This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
  */
 class TemplateAnalyzerModuleFunctionController
 {
index 2e08502..19d75ed 100644 (file)
@@ -27,6 +27,7 @@ use TYPO3\CMS\Fluid\View\StandaloneView;
 
 /**
  * TypoScript Constant editor
+ * @internal This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
  */
 class TypoScriptTemplateConstantEditorModuleFunctionController
 {
index ffbec32..42b2ca2 100644 (file)
@@ -25,6 +25,7 @@ use TYPO3\CMS\Fluid\View\StandaloneView;
 
 /**
  * This class displays the Info/Modify screen of the Web > Template module
+ * @internal This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
  */
 class TypoScriptTemplateInformationModuleFunctionController
 {
index fb61520..b4d6442 100644 (file)
@@ -44,6 +44,7 @@ use TYPO3\CMS\Fluid\ViewHelpers\Be\InfoboxViewHelper;
 
 /**
  * Module: TypoScript Tools
+ * @internal This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
  */
 class TypoScriptTemplateModuleController
 {
index 2bbc532..0644f92 100644 (file)
@@ -31,6 +31,7 @@ use TYPO3\CMS\Fluid\View\StandaloneView;
 
 /**
  * This class displays the submodule "TypoScript Object Browser" inside the Web > Template module
+ * @internal This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
  */
 class TypoScriptTemplateObjectBrowserModuleFunctionController
 {
index 0c6fa32..6cf7229 100644 (file)
@@ -39,6 +39,7 @@ use TYPO3\CMS\Frontend\Page\PageRepository;
 
 /**
  * Controller for viewing the frontend
+ * @internal This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
  */
 class ViewModuleController
 {
index 807a18e..c34bf9b 100644 (file)
@@ -37,6 +37,8 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  * This class explicitly does not derive from FrontendBackendUserAuthentication.
  * As this user is only meant for using against GET/cookie of "ADMCMD_prev" = clicked on a preview link
  * This user cannot use any admin panel / frontend editing capabilities.
+ *
+ * @internal
  */
 class PreviewUserAuthentication extends BackendUserAuthentication
 {
index 96df683..85ae173 100644 (file)
@@ -23,6 +23,8 @@ use TYPO3\CMS\Workspaces\Service\WorkspaceService;
 
 /**
  * Class to render the workspace selector
+ *
+ * @internal
  */
 class WorkspaceSelectorToolbarItem implements ToolbarItemInterface
 {
index fbb7f67..d4d29c7 100644 (file)
@@ -24,6 +24,7 @@ use TYPO3\CMS\Workspaces\Service\WorkspaceService;
 
 /**
  * Implements the AJAX functionality for the various asynchronous calls
+ * @internal This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
  */
 class AjaxController
 {
index 41eb963..fb50bf1 100644 (file)
@@ -24,6 +24,7 @@ use TYPO3\CMS\Workspaces\Controller\Remote\RemoteServer;
 
 /**
  * Implements the AJAX functionality for the various asynchronous calls
+ * @internal This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
  */
 class AjaxDispatcher
 {
index e2ea0e6..77e8ce6 100644 (file)
@@ -33,6 +33,7 @@ use TYPO3Fluid\Fluid\View\ViewInterface;
 
 /**
  * Implements the preview controller of the workspace module.
+ * @internal This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
  */
 class PreviewController
 {
index e145383..769e2a7 100644 (file)
@@ -30,7 +30,7 @@ use TYPO3\CMS\Workspaces\Service\StagesService;
 use TYPO3\CMS\Workspaces\Service\WorkspaceService;
 
 /**
- * Class ActionHandler
+ * @internal This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
  */
 class ActionHandler
 {
index 8147cca..eec1fa5 100644 (file)
@@ -23,6 +23,7 @@ use TYPO3\CMS\Workspaces\Service\WorkspaceService;
 
 /**
  * Class encapsulates all actions which are triggered for all elements within the current workspace.
+ * @internal This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
  */
 class MassActionHandler
 {
index e7a7047..d09d858 100644 (file)
@@ -37,6 +37,7 @@ use TYPO3\CMS\Workspaces\Service\WorkspaceService;
 
 /**
  * Class RemoteServer
+ * @internal This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
  */
 class RemoteServer
 {
index cdbdc3c..de8e3d8 100644 (file)
@@ -31,7 +31,7 @@ use TYPO3\CMS\Workspaces\Service\AdditionalResourceService;
 use TYPO3\CMS\Workspaces\Service\WorkspaceService;
 
 /**
- * Review controller.
+ * @internal This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
  */
 class ReviewController extends ActionController
 {
index bb13ab6..5f1bd30 100644 (file)
@@ -24,6 +24,7 @@ use TYPO3\CMS\Workspaces\Service\StagesService;
 
 /**
  * Befunc service
+ * @internal This is a specific hook implementation and is not considered part of the Public TYPO3 API.
  */
 class BackendUtilityHook
 {
index 1f1779d..d8a8e23 100644 (file)
@@ -40,6 +40,7 @@ use TYPO3\CMS\Workspaces\Service\WorkspaceService;
 /**
  * Contains some parts for staging, versioning and workspaces
  * to interact with the TYPO3 Core Engine
+ * @internal This is a specific hook implementation and is not considered part of the Public TYPO3 API.
  */
 class DataHandlerHook
 {
index 2e6d6cc..1092d06 100644 (file)
@@ -37,6 +37,8 @@ use TYPO3\CMS\Workspaces\Authentication\PreviewUserAuthentication;
  * - evaluate ADMCMD_prev as GET parameter or from a cookie
  * - initializes the PreviewUser as $GLOBALS['BE_USER']
  * - renders a message about a possible workspace previewing currently
+ *
+ * @internal
  */
 class WorkspacePreview implements MiddlewareInterface
 {
index 9473f7d..138f114 100644 (file)
@@ -31,6 +31,8 @@ use TYPO3\CMS\Workspaces\Service\WorkspaceService;
 
 /**
  * Create links to pages when in a workspace for previewing purposes
+ *
+ * @internal
  */
 class PreviewUriBuilder
 {