[TASK] Mark various obvious code as @internal 24/58524/2
authorBenni Mack <benni@typo3.org>
Mon, 1 Oct 2018 11:41:20 +0000 (13:41 +0200)
committerOliver Hader <oliver.hader@typo3.org>
Mon, 1 Oct 2018 13:04:24 +0000 (15:04 +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:backend (except ViewHelpers)
- EXT:beuser
- EXT:about
- EXT:belog

All @api methods have been removed.

Resolves: #86505
Releases: master
Change-Id: I1fd1e16f7885e81fb994999e5873a1a3a1aa6c3b
Reviewed-on: https://review.typo3.org/58524
Reviewed-by: Wouter Wolters <typo3@wouterwolters.nl>
Tested-by: Wouter Wolters <typo3@wouterwolters.nl>
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Oliver Hader <oliver.hader@typo3.org>
Tested-by: Oliver Hader <oliver.hader@typo3.org>
93 files changed:
typo3/sysext/about/Classes/Controller/AboutController.php
typo3/sysext/backend/Classes/Backend/Shortcut/ShortcutRepository.php
typo3/sysext/backend/Classes/Backend/ToolbarItems/ShortcutToolbarItem.php
typo3/sysext/backend/Classes/Backend/ToolbarItems/UserToolbarItem.php
typo3/sysext/backend/Classes/Clipboard/Clipboard.php
typo3/sysext/backend/Classes/Composer/InstallerScripts.php
typo3/sysext/backend/Classes/Configuration/SiteTcaConfiguration.php
typo3/sysext/backend/Classes/Controller/AjaxLoginController.php
typo3/sysext/backend/Classes/Controller/ContentElement/ElementHistoryController.php
typo3/sysext/backend/Classes/Controller/ContentElement/ElementInformationController.php
typo3/sysext/backend/Classes/Controller/ContentElement/MoveElementController.php
typo3/sysext/backend/Classes/Controller/ContentElement/NewContentElementController.php
typo3/sysext/backend/Classes/Controller/ContextHelpAjaxController.php
typo3/sysext/backend/Classes/Controller/ContextMenuController.php
typo3/sysext/backend/Classes/Controller/DummyController.php
typo3/sysext/backend/Classes/Controller/File/CreateFolderController.php
typo3/sysext/backend/Classes/Controller/File/EditFileController.php
typo3/sysext/backend/Classes/Controller/File/FileController.php
typo3/sysext/backend/Classes/Controller/File/FileUploadController.php
typo3/sysext/backend/Classes/Controller/File/RenameFileController.php
typo3/sysext/backend/Classes/Controller/File/ReplaceFileController.php
typo3/sysext/backend/Classes/Controller/File/ThumbnailController.php
typo3/sysext/backend/Classes/Controller/FileSystemNavigationFrameController.php
typo3/sysext/backend/Classes/Controller/FlashMessageController.php
typo3/sysext/backend/Classes/Controller/FormSlugAjaxController.php
typo3/sysext/backend/Classes/Controller/HelpController.php
typo3/sysext/backend/Classes/Controller/LiveSearchController.php
typo3/sysext/backend/Classes/Controller/LoginController.php
typo3/sysext/backend/Classes/Controller/LogoutController.php
typo3/sysext/backend/Classes/Controller/NewRecordController.php
typo3/sysext/backend/Classes/Controller/OnlineMediaController.php
typo3/sysext/backend/Classes/Controller/Page/LocalizationController.php
typo3/sysext/backend/Classes/Controller/Page/NewMultiplePagesController.php
typo3/sysext/backend/Classes/Controller/Page/SortSubPagesController.php
typo3/sysext/backend/Classes/Controller/Page/TreeController.php
typo3/sysext/backend/Classes/Controller/ShortcutController.php
typo3/sysext/backend/Classes/Controller/SiteConfigurationController.php
typo3/sysext/backend/Classes/Controller/SiteInlineAjaxController.php
typo3/sysext/backend/Classes/Controller/SystemInformationController.php
typo3/sysext/backend/Classes/Controller/UserSettingsController.php
typo3/sysext/backend/Classes/Controller/Wizard/AbstractWizardController.php
typo3/sysext/backend/Classes/Controller/Wizard/AddController.php
typo3/sysext/backend/Classes/Controller/Wizard/EditController.php
typo3/sysext/backend/Classes/Controller/Wizard/ImageManipulationController.php
typo3/sysext/backend/Classes/Controller/Wizard/ListController.php
typo3/sysext/backend/Classes/Controller/Wizard/SuggestWizardController.php
typo3/sysext/backend/Classes/Controller/Wizard/TableController.php
typo3/sysext/backend/Classes/Domain/Repository/TableManualRepository.php
typo3/sysext/backend/Classes/FrontendBackendUserAuthentication.php
typo3/sysext/backend/Classes/LoginProvider/UsernamePasswordLoginProvider.php
typo3/sysext/backend/Classes/Module/BaseScriptClass.php
typo3/sysext/backend/Classes/Search/LiveSearch/LiveSearch.php
typo3/sysext/backend/Classes/Search/LiveSearch/QueryParser.php
typo3/sysext/backend/Classes/Security/CategoryPermissionsAspect.php
typo3/sysext/backend/Classes/Tree/View/ContentCreationPagePositionMap.php
typo3/sysext/backend/Classes/Tree/View/ContentLayoutPagePositionMap.php
typo3/sysext/backend/Classes/Tree/View/ContentMovingPagePositionMap.php
typo3/sysext/backend/Classes/Tree/View/FolderTreeView.php
typo3/sysext/backend/Classes/Tree/View/NewRecordPageTreeView.php
typo3/sysext/backend/Classes/Tree/View/PageMovingPagePositionMap.php
typo3/sysext/backend/Classes/Tree/View/PagePositionMap.php
typo3/sysext/backend/Classes/View/BackendLayoutView.php
typo3/sysext/backend/Classes/View/BackendTemplateView.php
typo3/sysext/backend/Classes/View/PageLayoutView.php
typo3/sysext/backend/Classes/View/PageTreeView.php
typo3/sysext/backend/Classes/View/Wizard/Element/BackendLayoutWizardElement.php
typo3/sysext/belog/Classes/Controller/BackendLogController.php
typo3/sysext/belog/Classes/Controller/SystemInformationController.php
typo3/sysext/belog/Classes/Domain/Model/Constraint.php
typo3/sysext/belog/Classes/Domain/Model/LogEntry.php
typo3/sysext/belog/Classes/Domain/Model/Workspace.php
typo3/sysext/belog/Classes/Domain/Repository/LogEntryRepository.php
typo3/sysext/belog/Classes/Domain/Repository/WorkspaceRepository.php
typo3/sysext/belog/Classes/Module/BackendLogModuleBootstrap.php
typo3/sysext/belog/Classes/ViewHelpers/Form/TranslateLabelSelectViewHelper.php
typo3/sysext/beuser/Classes/ContextMenu/ItemProvider.php
typo3/sysext/beuser/Classes/Controller/BackendUserController.php
typo3/sysext/beuser/Classes/Controller/BackendUserGroupController.php
typo3/sysext/beuser/Classes/Controller/PermissionAjaxController.php
typo3/sysext/beuser/Classes/Controller/PermissionController.php
typo3/sysext/beuser/Classes/Domain/Model/BackendUser.php
typo3/sysext/beuser/Classes/Domain/Model/BackendUserGroup.php
typo3/sysext/beuser/Classes/Domain/Model/Demand.php
typo3/sysext/beuser/Classes/Domain/Model/ModuleData.php
typo3/sysext/beuser/Classes/Domain/Repository/BackendUserGroupRepository.php
typo3/sysext/beuser/Classes/Domain/Repository/BackendUserRepository.php
typo3/sysext/beuser/Classes/Domain/Repository/BackendUserSessionRepository.php
typo3/sysext/beuser/Classes/Exception.php
typo3/sysext/beuser/Classes/Hook/BackendControllerHook.php
typo3/sysext/beuser/Classes/Hook/SwitchBackUserHook.php
typo3/sysext/beuser/Classes/Service/ModuleDataStorageService.php
typo3/sysext/beuser/Classes/ViewHelpers/ArrayElementViewHelper.php
typo3/sysext/beuser/Classes/ViewHelpers/PermissionsViewHelper.php

index ace9b65..2745c68 100644 (file)
@@ -27,6 +27,8 @@ use TYPO3Fluid\Fluid\View\ViewInterface;
 /**
  * Module 'about' shows some standard information for TYPO3 CMS:
  * About-text, version number, available modules and so on.
+ *
+ * @internal This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
  */
 class AboutController
 {
index 4c01942..b54a281 100644 (file)
@@ -34,6 +34,8 @@ use TYPO3\CMS\Core\Utility\MathUtility;
 
 /**
  * Repository for backend shortcuts
+ *
+ * @internal This class is a specific Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class ShortcutRepository
 {
index 87f0edb..4d2d5c4 100644 (file)
@@ -22,6 +22,8 @@ use TYPO3\CMS\Fluid\View\StandaloneView;
 
 /**
  * Class to render the shortcut menu
+ *
+ * @internal This class is a specific Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class ShortcutToolbarItem implements ToolbarItemInterface
 {
index 5793ecd..46f75bc 100644 (file)
@@ -25,6 +25,8 @@ use TYPO3\CMS\Fluid\View\StandaloneView;
 
 /**
  * User toolbar item
+ *
+ * @internal This class is a specific Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class UserToolbarItem implements ToolbarItemInterface
 {
index c2b5644..5e5b06f 100644 (file)
@@ -30,6 +30,8 @@ use TYPO3\CMS\Fluid\View\StandaloneView;
 
 /**
  * TYPO3 clipboard for records and files
+ *
+ * @internal This class is a specific Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class Clipboard
 {
index 387de6e..373d467 100644 (file)
@@ -22,6 +22,8 @@ use TYPO3\CMS\Composer\Plugin\Core\ScriptDispatcher;
 
 /**
  * Hook into Composer build to generate TYPO3 backend entry script
+ *
+ * @internal this is used internally for TYPO3 core only
  */
 class InstallerScripts implements InstallerScriptsRegistration
 {
index 08f44e0..f3da594 100644 (file)
@@ -25,6 +25,8 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  *
  * Load Site configuration TCA from ext:*Configuration/SiteConfiguration
  * and ext:*Configuration/SiteConfiguration/Overrides
+ *
+ * @internal This class is a specific Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class SiteTcaConfiguration
 {
index 871547d..13a5b68 100644 (file)
@@ -23,6 +23,7 @@ use TYPO3\CMS\Core\Http\JsonResponse;
 
 /**
  * This is the ajax handler for backend login after timeout.
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class AjaxLoginController
 {
index e3cac97..7ecf454 100644 (file)
@@ -31,6 +31,7 @@ use TYPO3\CMS\Fluid\View\StandaloneView;
 /**
  * Controller for showing the history module of TYPO3s backend
  * @see \TYPO3\CMS\Backend\History\RecordHistory
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class ElementHistoryController
 {
index ee415d5..c203811 100644 (file)
@@ -36,6 +36,7 @@ use TYPO3\CMS\Fluid\View\StandaloneView;
 
 /**
  * Script Class for showing information about an item.
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class ElementInformationController
 {
index c6f0493..c0c6909 100644 (file)
@@ -32,6 +32,7 @@ use TYPO3\CMS\Fluid\View\StandaloneView;
 
 /**
  * Script Class for rendering the move-element wizard display
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class MoveElementController
 {
index 1a719d3..6d7ed6b 100644 (file)
@@ -36,6 +36,7 @@ use TYPO3\CMS\Fluid\View\StandaloneView;
 
 /**
  * Script Class for the New Content element wizard
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class NewContentElementController
 {
index 5114c7a..56ae129 100644 (file)
@@ -24,6 +24,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Class ContextHelpAjaxController
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class ContextHelpAjaxController
 {
index 15bd191..87279c0 100644 (file)
@@ -25,6 +25,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Script Class for the Context Sensitive Menu in TYPO3
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class ContextMenuController
 {
index c1d9c94..8f5f27e 100644 (file)
@@ -20,6 +20,7 @@ use TYPO3\CMS\Core\Http\HtmlResponse;
 
 /**
  * '/empty' routing target returns dummy content.
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class DummyController
 {
index e5f9441..620f5ce 100644 (file)
@@ -36,6 +36,7 @@ use TYPO3\CMS\Fluid\View\StandaloneView;
  * Script class for the create-new script
  *
  * Displays forms for creating folders (1 to 10), a media asset or a new file.
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class CreateFolderController
 {
index 1c1d4fc..7b9fb8a 100644 (file)
@@ -40,6 +40,7 @@ use TYPO3\CMS\Fluid\View\StandaloneView;
 
 /**
  * Script Class for rendering the file editing screen
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class EditFileController
 {
index 1d2a2fe..1f19c12 100644 (file)
@@ -40,6 +40,7 @@ use TYPO3\CMS\Core\Utility\HttpUtility;
  * Gateway for TCE (TYPO3 Core Engine) file-handling through POST forms.
  * This script serves as the file administration part of the TYPO3 Core Engine.
  * Basically it includes two libraries which are used to manipulate files on the server.
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class FileController
 {
index 92a2b82..e49ed79 100644 (file)
@@ -28,6 +28,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Script Class for display up to 10 upload fields
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class FileUploadController
 {
index 269f232..72c2c32 100644 (file)
@@ -33,6 +33,7 @@ use TYPO3\CMS\Fluid\View\StandaloneView;
 
 /**
  * Script Class for the rename-file form.
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class RenameFileController
 {
index b4f2f5f..ecd4c28 100644 (file)
@@ -30,7 +30,8 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Fluid\View\StandaloneView;
 
 /**
- * Script Class for the rename-file form
+ * Script Class for the replace-file form
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class ReplaceFileController
 {
index e38092c..ba7c4fe 100644 (file)
@@ -24,7 +24,7 @@ use TYPO3\CMS\Core\Utility\ArrayUtility;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
- * Class ThumbnailController
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class ThumbnailController
 {
index e3bb598..a21dea3 100644 (file)
@@ -34,6 +34,7 @@ use TYPO3\CMS\Recordlist\Tree\View\DummyLinkParameterProvider;
 
 /**
  * Main script class for rendering of the folder tree
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class FileSystemNavigationFrameController
 {
index 9bb2736..2fcc9fe 100644 (file)
@@ -22,6 +22,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Render FlashMessages
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class FlashMessageController
 {
index 2bdc8d5..435664e 100644 (file)
@@ -24,6 +24,8 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Handle FormEngine AJAX calls for Slug validation and sanitization
+ *
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class FormSlugAjaxController extends AbstractFormEngineAjaxController
 {
index 4e9d508..0d63337 100644 (file)
@@ -32,6 +32,7 @@ use TYPO3Fluid\Fluid\View\ViewInterface;
 
 /**
  * Main "CSH help" module controller
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class HelpController
 {
index b475f50..3a7b8e4 100644 (file)
@@ -23,6 +23,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Returns the results for any live searches, e.g. in the toolbar
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class LiveSearchController
 {
index 1320160..821fa86 100644 (file)
@@ -40,6 +40,7 @@ use TYPO3\CMS\Fluid\View\StandaloneView;
 
 /**
  * Script Class for rendering the login form
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class LoginController implements LoggerAwareInterface
 {
index 0c68e5f..c5b0f37 100644 (file)
@@ -25,6 +25,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 /**
  * Script Class for logging a user out.
  * Does not display any content, just calls the logout-function for the current user and then makes a redirect.
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class LogoutController
 {
index 14ea71f..3f3679a 100644 (file)
@@ -40,6 +40,7 @@ use TYPO3\CMS\Frontend\Page\PageRepository;
 
 /**
  * Script class for 'db_new'
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class NewRecordController
 {
index c8a00fa..24fee4b 100644 (file)
@@ -28,6 +28,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Class OnlineMediaController handles uploading online media
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class OnlineMediaController
 {
index 65e8437..32daae2 100644 (file)
@@ -33,7 +33,7 @@ use TYPO3\CMS\Core\Versioning\VersionState;
 /**
  * LocalizationController handles the AJAX requests for record localization
  *
- * @internal
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class LocalizationController
 {
index 688ed73..07ab16b 100644 (file)
@@ -34,6 +34,8 @@ use TYPO3\CMS\Fluid\View\StandaloneView;
 
 /**
  * "Create multiple pages" controller
+ *
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class NewMultiplePagesController
 {
index 5121c7b..5ad316a 100644 (file)
@@ -33,6 +33,7 @@ use TYPO3\CMS\Fluid\View\StandaloneView;
 
 /**
  * "Sort sub pages" controller - reachable from context menu "more" on page records
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class SortSubPagesController
 {
index da52643..f33d46f 100644 (file)
@@ -37,6 +37,7 @@ use TYPO3\CMS\Workspaces\Service\WorkspaceService;
 
 /**
  * Controller providing data to the page tree
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class TreeController
 {
index 93f4c5e..b309ef6 100644 (file)
@@ -29,6 +29,7 @@ use TYPO3\CMS\Fluid\View\StandaloneView;
 
 /**
  * Controller for shortcut processing
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class ShortcutController
 {
index 7c51df0..a262dbd 100644 (file)
@@ -50,6 +50,8 @@ use TYPO3Fluid\Fluid\View\ViewInterface;
  * Backend controller: The "Site management" -> "Sites" module
  *
  * List all site root pages, CRUD site configuration.
+ *
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class SiteConfigurationController
 {
index 6d8a46e..7078085 100644 (file)
@@ -32,6 +32,7 @@ use TYPO3\CMS\Core\Utility\MathUtility;
 /**
  * Site configuration FormEngine controller class. Receives inline "edit" and "new"
  * commands to expand / create site configuration inline records
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class SiteInlineAjaxController extends AbstractFormEngineAjaxController
 {
index 8efbd8f..8752e26 100644 (file)
@@ -22,6 +22,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Controller for system information processing
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class SystemInformationController
 {
index 3202933..bfc8542 100644 (file)
@@ -24,6 +24,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 /**
  * A wrapper class to call BE_USER->uc
  * used for AJAX and TYPO3.Storage JS object
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class UserSettingsController
 {
index 8f68bb0..4a2255a 100644 (file)
@@ -22,6 +22,7 @@ use TYPO3\CMS\Core\Type\Bitmask\Permission;
 
 /**
  * Class AbstractWizardController
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class AbstractWizardController
 {
index 302ff33..9c6d2f6 100644 (file)
@@ -32,6 +32,7 @@ use TYPO3\CMS\Core\Utility\MathUtility;
 /**
  * Script Class for adding new items to a group/select field. Performs proper redirection as needed.
  * Script is typically called after new child record was added and then adds the new child to select value of parent.
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class AddController extends AbstractWizardController
 {
index bf635f3..bb6172d 100644 (file)
@@ -28,6 +28,7 @@ use TYPO3\CMS\Core\Utility\MathUtility;
 
 /**
  * Script Class for redirecting a backend user to the editing form when an "Edit wizard" link was clicked in FormEngine somewhere
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class EditController extends AbstractWizardController
 {
index 6728719..3957977 100644 (file)
@@ -26,6 +26,7 @@ use TYPO3\CMS\Fluid\View\StandaloneView;
 
 /**
  * Wizard for rendering image manipulation view
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class ImageManipulationController
 {
index 42eb479..c020d17 100644 (file)
@@ -26,6 +26,7 @@ use TYPO3\CMS\Core\Utility\HttpUtility;
 
 /**
  * Script Class for redirecting the user to the Web > List module if a wizard-link has been clicked in FormEngine
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class ListController extends AbstractWizardController
 {
index 7d95e37..9b9e6f9 100644 (file)
@@ -26,6 +26,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Receives ajax request from FormEngine suggest wizard and creates suggest answer as json result
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class SuggestWizardController
 {
index 5c01b2e..3f1f830 100644 (file)
@@ -33,6 +33,7 @@ use TYPO3\CMS\Core\Utility\MathUtility;
 
 /**
  * Script Class for rendering the Table Wizard
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class TableController extends AbstractWizardController
 {
index e4441fe..05f0c2a 100644 (file)
@@ -23,6 +23,7 @@ use TYPO3\CMS\Core\Utility\PathUtility;
 
 /**
  * Table manual repository for csh manual handling
+ * @internal This class is a specific Backend repository implementation and is not considered part of the Public TYPO3 API.
  */
 class TableManualRepository
 {
index bdef4e7..dd267e3 100644 (file)
@@ -29,6 +29,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 /**
  * TYPO3 backend user authentication in the TSFE frontend.
  * This includes mainly functions related to the Admin Panel
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class FrontendBackendUserAuthentication extends BackendUserAuthentication
 {
index b3fcfc4..e649f2d 100644 (file)
@@ -23,6 +23,7 @@ use TYPO3\CMS\Fluid\View\StandaloneView;
 
 /**
  * Class UsernamePasswordLoginProvider
+ * @internal This class is a specific Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class UsernamePasswordLoginProvider implements LoginProviderInterface
 {
index 6a0eada..8e94182 100644 (file)
@@ -43,7 +43,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  * class PrototypeController extends \TYPO3\CMS\Backend\Module\BaseScriptClass {
  *     public function __construct() {
  *             $this->getLanguageService()->includeLLFile('EXT:prototype/Resources/Private/Language/locallang.xlf');
- *             $this->getBackendUser()->modAccess($GLOBALS['MCONF'], TRUE);
+ *             $this->getBackendUser()->modAccess($GLOBALS['MCONF']);
  *     }
  * }
  *
index 7fc1c1c..e4b2eed 100644 (file)
@@ -32,6 +32,7 @@ use TYPO3\CMS\Core\Utility\MathUtility;
 
 /**
  * Class for handling backend live search.
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class LiveSearch
 {
index c20520d..e89f98b 100644 (file)
@@ -17,6 +17,7 @@ namespace TYPO3\CMS\Backend\Search\LiveSearch;
 /**
  * Class for parsing query parameters in backend live search.
  * Detects searches for #pages:23 or #content:mycontent
+ * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
  */
 class QueryParser
 {
index e9ffa17..f02c2e3 100644 (file)
@@ -27,6 +27,8 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  * on data data object initialization.
  *
  * The aspect define category mount points according to BE User permissions.
+ *
+ * @internal This class is TYPO3-internal hook and is not considered part of the Public TYPO3 API.
  */
 class CategoryPermissionsAspect
 {
index 043cee2..34b983e 100644 (file)
@@ -19,6 +19,8 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Local position map class when creating new Content Elements
+ *
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class ContentCreationPagePositionMap extends PagePositionMap
 {
index 95b0ca8..ff63dfb 100644 (file)
@@ -20,6 +20,8 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Position map class for content elements within the page module
+ *
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class ContentLayoutPagePositionMap extends PagePositionMap
 {
index aa2c85d..30a4fa5 100644 (file)
@@ -15,8 +15,9 @@ namespace TYPO3\CMS\Backend\Tree\View;
  */
 
 /**
- * Position map class for moving content elements,
- * previously resided in typo3/move_el.php
+ * Position map class for moving content elements.
+ *
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class ContentMovingPagePositionMap extends PagePositionMap
 {
index 21ce55d..bc554fb 100644 (file)
@@ -29,6 +29,8 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 /**
  * Generate a folder tree,
  * specially made for browsing folders in the File module
+ *
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class FolderTreeView extends AbstractTreeView
 {
index 04a94bc..90b188b 100644 (file)
@@ -18,7 +18,7 @@ namespace TYPO3\CMS\Backend\Tree\View;
  * Extension for the tree class that generates the tree of pages in the page-wizard mode
  *
  * @see \TYPO3\CMS\Backend\Controller\NewRecordController
- * @internal
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class NewRecordPageTreeView extends PageTreeView
 {
index 93f12c6..341e6ba 100644 (file)
@@ -19,7 +19,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Position map class for moving pages,
- * previously resided in typo3/move_el.php
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class PageMovingPagePositionMap extends PagePositionMap
 {
index b4c084f..294c6c4 100644 (file)
@@ -31,6 +31,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 /**
  * Position map class - generating a page tree / content element list which links for inserting (copy/move) of records.
  * Used for pages / tt_content element wizards of various kinds.
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class PagePositionMap
 {
index 73f2876..a2abc67 100644 (file)
@@ -22,6 +22,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Backend layout for CMS
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class BackendLayoutView implements \TYPO3\CMS\Core\SingletonInterface
 {
index c715627..1b9757c 100644 (file)
@@ -22,8 +22,6 @@ use TYPO3\CMS\Fluid\View\TemplateView;
 /**
  * Decorates the main template view. Should be used as view if you want to use
  * Fluid templates in a backend module in order to have a consistent backend.
- *
- * @api
  */
 class BackendTemplateView implements ViewInterface
 {
@@ -69,7 +67,6 @@ class BackendTemplateView implements ViewInterface
      *
      * @param string $actionName If set, the view of the specified action will be rendered instead. Default is the action specified in the Request object
      * @return string Rendered Template
-     * @api
      */
     public function render($actionName = null)
     {
@@ -82,7 +79,6 @@ class BackendTemplateView implements ViewInterface
      * Sets the current controller context
      *
      * @param \TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext Controller context which is available inside the view
-     * @api
      */
     public function setControllerContext(\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext)
     {
@@ -95,7 +91,6 @@ class BackendTemplateView implements ViewInterface
      * @param string $key The key of a view variable to set
      * @param mixed $value The value of the view variable
      * @return \TYPO3\CMS\Fluid\View\AbstractTemplateView the instance of this view to allow chaining
-     * @api
      */
     public function assign($key, $value)
     {
@@ -109,7 +104,6 @@ class BackendTemplateView implements ViewInterface
      *
      * @param array $values Keys and values - only a value with key "value" is considered
      * @return \TYPO3\CMS\Fluid\View\AbstractTemplateView the instance of this view to allow chaining
-     * @api
      */
     public function assignMultiple(array $values)
     {
@@ -122,7 +116,6 @@ class BackendTemplateView implements ViewInterface
      *
      * @param ControllerContext $controllerContext Controller context which is available inside the view
      * @return bool
-     * @api
      */
     public function canRender(ControllerContext $controllerContext)
     {
@@ -141,7 +134,6 @@ class BackendTemplateView implements ViewInterface
      * Set the root path(s) to the templates.
      *
      * @param array $templateRootPaths Root path(s) to the templates.
-     * @api
      */
     public function setTemplateRootPaths(array $templateRootPaths)
     {
@@ -152,7 +144,6 @@ class BackendTemplateView implements ViewInterface
      * Set the root path(s) to the partials.
      *
      * @param array $partialRootPaths Root paths to the partials.
-     * @api
      */
     public function setPartialRootPaths(array $partialRootPaths)
     {
@@ -163,7 +154,6 @@ class BackendTemplateView implements ViewInterface
      * Set the root path(s) to the layouts.
      *
      * @param array $layoutRootPaths Root path to the layouts.
-     * @api
      */
     public function setLayoutRootPaths(array $layoutRootPaths)
     {
index 4c48ac6..9ae82ee 100644 (file)
@@ -55,6 +55,7 @@ use TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList;
 
 /**
  * Child class for the Web > Page module
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class PageLayoutView implements LoggerAwareInterface
 {
index 83f1682..bc901ce 100644 (file)
@@ -22,6 +22,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Browse pages in Web module
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class PageTreeView extends BrowseTreeView
 {
index aaf3ff2..012d508 100644 (file)
@@ -20,6 +20,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Backend layout element
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class BackendLayoutWizardElement extends AbstractFormElement
 {
index a2c8a3a..403fc74 100644 (file)
@@ -24,6 +24,7 @@ use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
 
 /**
  * Abstract class to show log entries from sys_log
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class BackendLogController extends ActionController
 {
index bff13d6..031580a 100644 (file)
@@ -25,6 +25,7 @@ use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
 
 /**
  * Count newest exceptions for the system information menu
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class SystemInformationController
 {
index 6feb38b..96a90a8 100644 (file)
@@ -16,6 +16,7 @@ namespace TYPO3\CMS\Belog\Domain\Model;
 
 /**
  * Constraints for log entries
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class Constraint
 {
index 2a2c942..faeda44 100644 (file)
@@ -19,6 +19,7 @@ namespace TYPO3\CMS\Belog\Domain\Model;
  * This model is 'complete': All current database properties are in there.
  *
  * @todo : This should be stuffed to some more central place
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class LogEntry extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
 {
index 4e60756..a26b1b3 100644 (file)
@@ -18,6 +18,7 @@ namespace TYPO3\CMS\Belog\Domain\Model;
  * Stub model for workspaces - only properties required for belog module are added currently
  *
  * @todo : This should be extended and put at some more central place
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class Workspace extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
 {
index cac11af..c7add3b 100644 (file)
@@ -20,6 +20,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Sys log entry repository
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class LogEntryRepository extends \TYPO3\CMS\Extbase\Persistence\Repository
 {
index 3e15aae..5f62e77 100644 (file)
@@ -17,6 +17,7 @@ namespace TYPO3\CMS\Belog\Domain\Repository;
 /**
  * Repository for workspaces
  * @todo This should be moved to EXT:workspaces if EXT:belog works no matter if workspaces are installed or not
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class WorkspaceRepository extends \TYPO3\CMS\Extbase\Persistence\Repository
 {
index 799cdea..8a5d2af 100644 (file)
@@ -24,6 +24,7 @@ use TYPO3\CMS\Extbase\Core\Bootstrap;
  *
  * Extbase currently provides no way to register a "TBE_MODULES_EXT" module directly,
  * therefore we need to bootstrap extbase on our own here to jump to the WebInfo controller.
+ * @internal This class is a experimental and is not considered part of the Public TYPO3 API.
  */
 class BackendLogModuleBootstrap
 {
index 1a9e60b..5cb5024 100644 (file)
@@ -28,8 +28,6 @@ class TranslateLabelSelectViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\S
 {
     /**
      * Initialize arguments.
-     *
-     * @api
      */
     public function initializeArguments()
     {
index 3cb3e1d..8e99486 100644 (file)
@@ -17,6 +17,9 @@ namespace TYPO3\CMS\Beuser\ContextMenu;
 
 use TYPO3\CMS\Backend\ContextMenu\ItemProviders\PageProvider;
 
+/**
+ * @internal This class is a TYPO3 core-internal hook implementation and is not considered part of the Public TYPO3 API.
+ */
 class ItemProvider extends PageProvider
 {
     /**
index bbaebc9..8d77fe5 100644 (file)
@@ -25,6 +25,7 @@ use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
 
 /**
  * Backend module user administration controller
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class BackendUserController extends ActionController
 {
index cc40b38..dd98adc 100644 (file)
@@ -18,6 +18,7 @@ use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;
 
 /**
  * Backend module user group administration controller
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class BackendUserGroupController extends ActionController
 {
index 55ec6d3..e09cf74 100644 (file)
@@ -29,6 +29,7 @@ use TYPO3\CMS\Fluid\View\StandaloneView;
  * This class extends the permissions module in the TYPO3 Backend to provide
  * convenient methods of editing of page permissions (including page ownership
  * (user and group)) via new AjaxRequestHandler facility
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class PermissionAjaxController
 {
index 4856da0..b098058 100644 (file)
@@ -28,6 +28,7 @@ use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
 
 /**
  * Backend module page permissions
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class PermissionController extends ActionController
 {
index 3700715..428905a 100644 (file)
@@ -16,6 +16,7 @@ namespace TYPO3\CMS\Beuser\Domain\Model;
 
 /**
  * Model for backend user
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class BackendUser extends \TYPO3\CMS\Extbase\Domain\Model\BackendUser
 {
index 41e9c58..0a09d74 100644 (file)
@@ -18,6 +18,7 @@ use TYPO3\CMS\Extbase\Annotation as Extbase;
 
 /**
  * Model for backend user group
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class BackendUserGroup extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
 {
index 24467ed..debf4ff 100644 (file)
@@ -16,6 +16,7 @@ namespace TYPO3\CMS\Beuser\Domain\Model;
 
 /**
  * Demand filter for listings
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class Demand extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
 {
index 553880b..4012b70 100644 (file)
@@ -16,6 +16,7 @@ namespace TYPO3\CMS\Beuser\Domain\Model;
 
 /**
  * Module data object
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class ModuleData
 {
index e5c8a4e..542f831 100644 (file)
@@ -16,6 +16,7 @@ namespace TYPO3\CMS\Beuser\Domain\Repository;
 
 /**
  * Repository for \TYPO3\CMS\Beuser\Domain\Model\BackendUserGroup
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class BackendUserGroupRepository extends \TYPO3\CMS\Extbase\Persistence\Repository
 {
index 3df0f01..c79ac3f 100644 (file)
@@ -26,6 +26,7 @@ use TYPO3\CMS\Extbase\Persistence\QueryInterface;
 
 /**
  * Repository for \TYPO3\CMS\Beuser\Domain\Model\BackendUser
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class BackendUserRepository extends BackendUserGroupRepository
 {
index faae0ea..f608698 100644 (file)
@@ -23,6 +23,7 @@ use TYPO3\CMS\Extbase\Persistence\Repository;
 
 /**
  * Repository for \TYPO3\CMS\Extbase\Domain\Model\BackendUser
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class BackendUserSessionRepository extends Repository
 {
index 9155c33..d861b69 100644 (file)
@@ -18,6 +18,7 @@ use TYPO3\CMS\Core\Exception as CoreException;
 
 /**
  * Generic Beuser exception
+ * @internal
  */
 class Exception extends CoreException
 {
index 69b1ccb..c6614d9 100644 (file)
@@ -19,7 +19,8 @@ use TYPO3\CMS\Core\Page\PageRenderer;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
- * This class adds import export related JavaScript to the backend
+ * This class adds Access-permission related JavaScript to the backend
+ * @internal This class is a TYPO3 core-internal hook implementation and is not considered part of the Public TYPO3 API.
  */
 class BackendControllerHook
 {
index fbb8274..bf4c999 100644 (file)
@@ -22,6 +22,7 @@ use TYPO3\CMS\Core\Utility\HttpUtility;
 /**
  * Backend user switchback, for logoff_pre_processing hook within
  * \TYPO3\CMS\Core\Authentication\AbstractUserAuthentication class
+ * @internal This class is a TYPO3 core-internal hook implementation and is not considered part of the Public TYPO3 API.
  */
 class SwitchBackUserHook
 {
index 1e1caf6..18346d8 100644 (file)
@@ -17,6 +17,7 @@ namespace TYPO3\CMS\Beuser\Service;
 /**
  * Module data storage service.
  * Used to store and retrieve module state (eg. checkboxes, selections).
+ * @internal This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
  */
 class ModuleDataStorageService implements \TYPO3\CMS\Core\SingletonInterface
 {
index 3245964..eedbfab 100644 (file)
@@ -21,6 +21,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 
 /**
  * Get a value from an array by given key.
+ * @internal
  */
 class ArrayElementViewHelper extends AbstractViewHelper
 {
index 5c39375..70c2ff8 100644 (file)
@@ -24,6 +24,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  *
  * Most of that could be done in fluid directly, but this view helper
  * is much better performance wise.
+ * @internal
  */
 class PermissionsViewHelper extends AbstractViewHelper
 {