Commit 064585df authored by Benni Mack's avatar Benni Mack Committed by Georg Ringer
Browse files

[TASK] phpDoc: replace @access private with @internal

The phpDoc comment "@internal" is used in most places
during the development of TYPO3 v7, TYPO3 v8 and TYPO3 v9
and denotes that this specific method, class or property is not
part of the Public API, and does not even need any notice if it
is removed.

However, we still have/had various places in TYPO3 core
where "@access private" was used. This is now migrated to
"@internal". "@access public" is not needed and is removed.

Resolves: #86446
Releases: master
Change-Id: Iaef206b04aee13c280d62b107dd7eac04a38c700
Reviewed-on: https://review.typo3.org/58462

Reviewed-by: Susanne Moog's avatarSusanne Moog <susanne.moog@typo3.org>
Tested-by: Susanne Moog's avatarSusanne Moog <susanne.moog@typo3.org>
Reviewed-by: Georg Ringer's avatarGeorg Ringer <georg.ringer@gmail.com>
Tested-by: Georg Ringer's avatarGeorg Ringer <georg.ringer@gmail.com>
parent bacab187
......@@ -363,7 +363,7 @@ class Clipboard
/**
* Print the content on a pad. Called from ->printClipboard()
*
* @access private
* @internal
* @param string $pad Pad reference
* @return array Array with table rows for the clipboard.
*/
......@@ -798,7 +798,7 @@ class Clipboard
* Saves the clipboard, no questions asked.
* Use ->endClipboard normally (as it checks if changes has been done so saving is necessary)
*
* @access private
* @internal
*/
public function saveClipboard()
{
......
......@@ -407,7 +407,7 @@ class RecordHistory
* @param string $table Table name
* @param array $dataArray The data array
* @return array The modified data array
* @access private
* @internal
*/
protected function removeFilefields($table, $dataArray)
{
......
......@@ -245,7 +245,7 @@ class BaseScriptClass
* @param string $menuKey Menu key, eg. 'function' for the function menu.
* @param array $menuArr The part of a MOD_MENU array to work on.
* @return array Modified array part.
* @access private
* @internal
* @see \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::insertModuleFunction(), menuConfig()
*/
public function mergeExternalItems($modName, $menuKey, $menuArr)
......
......@@ -367,7 +367,7 @@ abstract class AbstractRecordList
* @param int $pointer Pointer
* @param string $table Table name
* @return string
* @access private
* @internal
* @deprecated since TYPO3 v9, will be removed in TYPO3 v10
*/
public function fwd_rwd_HTML($type, $pointer, $table = '')
......
......@@ -393,7 +393,7 @@ function jumpToUrl(URL) {
* @param string $gvList Is the list of GET variables to store (if any)
* @param string $setList Is the list of SET[] variables to store (if any) - SET[] variables a stored in $GLOBALS["SOBE"]->MOD_SETTINGS for backend modules
* @return string
* @access private
* @internal
* @see makeShortcutIcon()
*/
public function makeShortcutUrl($gvList, $setList)
......
......@@ -507,7 +507,7 @@ abstract class AbstractTreeView
* @param int $nextCount The number of sub-elements to the current element.
* @param bool $isOpen The element was expanded to render subelements if this flag is set.
* @return string Image tag with the plus/minus icon.
* @access private
* @internal
* @see \TYPO3\CMS\Backend\Tree\View\PageTreeView::PMicon()
*/
public function PMicon($row, $a, $c, $nextCount, $isOpen)
......@@ -528,7 +528,7 @@ abstract class AbstractTreeView
* @param string $bMark If set, the link will have an anchor point (=$bMark) and a name attribute (=$bMark)
* @param bool $isOpen
* @return string Link-wrapped input string
* @access private
* @internal
*/
public function PM_ATagWrap($icon, $cmd, $bMark = '', $isOpen = false)
{
......@@ -548,7 +548,7 @@ abstract class AbstractTreeView
* @param array $row Item record
* @param int $bank Bank pointer (which mount point number)
* @return string
* @access private
* @internal
*/
public function wrapTitle($title, $row, $bank = 0)
{
......@@ -562,7 +562,7 @@ abstract class AbstractTreeView
* @param string $icon The image tag for the icon
* @param array $row The row for the current element
* @return string The processed icon input value.
* @access private
* @internal
*/
public function wrapIcon($icon, $row)
{
......@@ -587,7 +587,7 @@ abstract class AbstractTreeView
* @param string $str Input string, like a page title for the tree
* @param array $row record row with "php_tree_stop" field
* @return string Modified string
* @access private
* @internal
*/
public function wrapStop($str, $row)
{
......@@ -609,7 +609,7 @@ abstract class AbstractTreeView
*
* @param int $id Record id/key
* @return bool
* @access private
* @internal
* @see \TYPO3\CMS\Backend\Tree\View\PageTreeView::expandNext()
*/
public function expandNext($id)
......@@ -620,7 +620,7 @@ abstract class AbstractTreeView
/**
* Get stored tree structure AND updating it if needed according to incoming PM GET var.
*
* @access private
* @internal
*/
public function initializePositionSaving()
{
......@@ -649,7 +649,7 @@ abstract class AbstractTreeView
* Saves the content of ->stored (keeps track of expanded positions in the tree)
* $this->treeName will be used as key for BE_USER->uc[] to store it in
*
* @access private
* @internal
*/
public function savePosition()
{
......@@ -842,7 +842,7 @@ abstract class AbstractTreeView
*
* @param int $uid Id to count subitems for
* @return int
* @access private
* @internal
*/
public function getCount($uid)
{
......@@ -908,7 +908,7 @@ abstract class AbstractTreeView
* @param int $parentId parent item id
*
* @return mixed Data handle (Tables: An sql-resource, arrays: A parentId integer. -1 is returned if there were NO subLevel.)
* @access private
* @internal
*/
public function getDataInit($parentId)
{
......@@ -950,7 +950,7 @@ abstract class AbstractTreeView
*
* @param mixed $res Data handle
* @return int number of items
* @access private
* @internal
* @see getDataInit()
*/
public function getDataCount(&$res)
......@@ -968,7 +968,7 @@ abstract class AbstractTreeView
* @param mixed $res Data handle
*
* @return array|bool item data array OR FALSE if end of elements.
* @access private
* @internal
* @see getDataInit()
*/
public function getDataNext(&$res)
......@@ -997,7 +997,7 @@ abstract class AbstractTreeView
* Getting the tree data: frees data handle
*
* @param mixed $res Data handle
* @access private
* @internal
*/
public function getDataFree(&$res)
{
......
......@@ -121,7 +121,7 @@ class BrowseTreeView extends AbstractTreeView
* @param string $icon The image tag for the icon
* @param array $row The row for the current element
* @return string The processed icon input value.
* @access private
* @internal
*/
public function wrapIcon($icon, $row)
{
......
......@@ -119,7 +119,7 @@ class ElementBrowserFolderTreeView extends FolderTreeView
* @param bool|string $bMark If set, the link will have an anchor point (=$bMark) and a name attribute (=$bMark)
* @param bool $isOpen check if the item has children
* @return string Link-wrapped input string
* @access private
* @internal
*/
public function PM_ATagWrap($icon, $cmd, $bMark = '', $isOpen = false)
{
......
......@@ -581,7 +581,7 @@ class FolderTreeView extends AbstractTreeView
/**
* Get stored tree structure AND updating it if needed according to incoming PM GET var.
*
* @access private
* @internal
*/
public function initializePositionSaving()
{
......
......@@ -94,7 +94,7 @@ class PageTreeView extends AbstractTreeView
* @param int $nextCount The number of sub-elements to the current element.
* @param bool $isExpand The element was expanded to render subelements if this flag is set.
* @return string Image tag with the plus/minus icon.
* @access private
* @internal
* @see AbstractTreeView::PMicon()
*/
public function PMicon($row, $a, $c, $nextCount, $isExpand)
......@@ -106,7 +106,7 @@ class PageTreeView extends AbstractTreeView
* Get stored tree structure AND updating it if needed according to incoming PM GET var.
* - Here we just set it to nothing since we want to just render the tree, nothing more.
*
* @access private
* @internal
*/
public function initializePositionSaving()
{
......
......@@ -4238,7 +4238,7 @@ class PageLayoutView implements LoggerAwareInterface
* @param int $pointer Pointer
* @param string $table Table name
* @return string
* @access private
* @internal
*/
public function fwd_rwd_HTML($type, $pointer, $table = '')
{
......
......@@ -95,7 +95,7 @@ class PageTreeView extends BrowseTreeView
* @param string $row Item record
* @param int $bank Bank pointer (which mount point number)
* @return string
* @access private
* @internal
*/
public function wrapTitle($title, $row, $bank = 0)
{
......@@ -225,7 +225,7 @@ class PageTreeView extends BrowseTreeView
* @param int $nextCount The number of sub-elements to the current element.
* @param bool $exp The element was expanded to render subelements if this flag is set.
* @return string Image tag with the plus/minus icon.
* @access private
* @internal
* @see \TYPO3\CMS\Backend\Tree\View\PageTreeView::PMicon()
*/
public function PMicon($row, $a, $c, $nextCount, $exp)
......@@ -245,7 +245,7 @@ class PageTreeView extends BrowseTreeView
* @param string $cmd Command for 'PM' get var
* @param bool $isExpand Link-wrapped input string
* @return string
* @access private
* @internal
*/
public function PMiconATagWrap($icon, $cmd, $isExpand = true)
{
......
......@@ -305,9 +305,9 @@ class AuthenticationService extends AbstractAuthenticationService
* @param string $grList Commalist of fe_groups uid numbers
* @param string $idList List of already processed fe_groups-uids so the function will not fall into an eternal recursion.
* @param array $groups
* @access private
* @internal
*/
public function getSubGroups($grList, $idList = '', &$groups)
public function getSubGroups($grList, $idList, &$groups)
{
// Fetching records of the groups in $grList (which are not blocked by lockedToDomain either):
$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable('fe_groups');
......
......@@ -1347,7 +1347,7 @@ class BackendUserAuthentication extends AbstractUserAuthentication
* if the backend user login has verified OK.
* Generally this is required initialization of a backend user.
*
* @access private
* @internal
* @see \TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser
*/
public function fetchGroupData()
......@@ -1490,7 +1490,7 @@ class BackendUserAuthentication extends AbstractUserAuthentication
*
* @param string $grList Commalist of be_groups uid numbers
* @param string $idList List of already processed be_groups-uids so the function will not fall into an eternal recursion.
* @access private
* @internal
*/
public function fetchGroups($grList, $idList = '')
{
......@@ -1591,7 +1591,7 @@ class BackendUserAuthentication extends AbstractUserAuthentication
* a representation of the exact groups/subgroups which the BE_USER has membership with.
*
* @param string $cList The newly compiled group-list which must be compared with the current list in the user record and possibly stored if a difference is detected.
* @access private
* @internal
*/
public function setCachedList($cList)
{
......@@ -2405,7 +2405,7 @@ class BackendUserAuthentication extends AbstractUserAuthentication
* @param string $email Email address
* @param int $secondsBack Number of sections back in time to check. This is a kind of limit for how many failures an hour for instance.
* @param int $max Max allowed failures before a warning mail is sent
* @access private
* @internal
*/
public function checkLogFailures($email, $secondsBack = 3600, $max = 3)
{
......@@ -2646,7 +2646,7 @@ This is a dump of the failures:
/**
* Sends an email notification to warning_email_address and/or the logged-in user's email address.
*
* @access private
* @internal
*/
private function emailAtLogin()
{
......
......@@ -97,7 +97,7 @@ class ConfigurationManager
* currently the path and filename.
*
* @return string
* @access private
* @internal
*/
public function getDefaultConfigurationFileLocation()
{
......@@ -109,7 +109,7 @@ class ConfigurationManager
* currently the path and filename.
*
* @return string
* @access private
* @internal
*/
public function getDefaultConfigurationDescriptionFileLocation()
{
......@@ -131,7 +131,7 @@ class ConfigurationManager
* currently the path and filename.
*
* @return string
* @access private
* @internal
*/
public function getLocalConfigurationFileLocation()
{
......@@ -155,7 +155,7 @@ class ConfigurationManager
* currently the path and filename.
*
* @return string
* @access private
* @internal
*/
public function getAdditionalConfigurationFileLocation()
{
......@@ -316,7 +316,7 @@ class ConfigurationManager
* Checks if the configuration can be written.
*
* @return bool
* @access private
* @internal
*/
public function canWriteConfiguration()
{
......@@ -327,7 +327,7 @@ class ConfigurationManager
/**
* Reads the configuration array and exports it to the global variable
*
* @access private
* @internal
* @throws \UnexpectedValueException
*/
public function exportConfiguration()
......@@ -356,7 +356,7 @@ class ConfigurationManager
* @param array $configuration The local configuration to be written
* @throws \RuntimeException
* @return bool TRUE on success
* @access private
* @internal
*/
public function writeLocalConfiguration(array $configuration)
{
......@@ -388,7 +388,7 @@ class ConfigurationManager
* @param array $additionalConfigurationLines The configuration lines to be written
* @throws \RuntimeException
* @return bool TRUE on success
* @access private
* @internal
*/
public function writeAdditionalConfiguration(array $additionalConfigurationLines)
{
......@@ -405,7 +405,7 @@ class ConfigurationManager
* by the install tool in an early step.
*
* @throws \RuntimeException
* @access private
* @internal
*/
public function createLocalConfigurationFromFactoryConfiguration()
{
......
......@@ -61,7 +61,7 @@ class Environment
* @param string $configPath
* @param string $currentScript
* @param string $os
* @private
* @internal
*/
public static function initialize(
ApplicationContext $context,
......
......@@ -860,7 +860,7 @@ class DataHandler implements LoggerAwareInterface
* @param array $outputArr $this->uploadedFileArray passed by reference
* @param array $inputArr Input array ($_FILES parts)
* @param string $keyToSet The current $_FILES array key to set on the outermost level.
* @access private
* @internal
* @see process_uploads()
*/
public function process_uploads_traverseArray(&$outputArr, $inputArr, $keyToSet)
......@@ -3987,7 +3987,7 @@ class DataHandler implements LoggerAwareInterface
* @param int $language Language ID (from sys_language table) used in the duplicated record
* @param array $workspaceOptions Options to be forwarded if actions happen on a workspace currently
* @return array|string
* @access private
* @internal
* @see copyRecord()
*/
public function copyRecord_procBasedOnFieldType($table, $uid, $field, $value, $row, $conf, $realDestPid, $language = 0, array $workspaceOptions = [])
......@@ -5487,7 +5487,7 @@ class DataHandler implements LoggerAwareInterface
*
* @param int $uid Page id
* @param bool $forceHardDelete If TRUE, the "deleted" flag is ignored if applicable for record and the record is deleted COMPLETELY!
* @access private
* @internal
* @see deletePages()
*/
public function deleteSpecificPage($uid, $forceHardDelete = false)
......@@ -6749,7 +6749,7 @@ class DataHandler implements LoggerAwareInterface
* @param int $perms Permission integer
* @param array $columns Columns to select
* @return bool|array
* @access private
* @internal
* @see doesRecordExist()
*/
protected function doesRecordExist_pageLookUp($id, $perms, $columns = ['uid'])
......@@ -7624,7 +7624,7 @@ class DataHandler implements LoggerAwareInterface
* @param string $sortColumn Column name used for sorting
* @param int $return_SortNumber_After_This_Uid Uid of record from $table in this $pid and for which the return value will be set to a free sorting number after that record. This is used to return a sortingValue if the list is resorted because of inserting records inside the list and not in the top
* @return int|null If $return_SortNumber_After_This_Uid is set, will contain usable sorting number after that record if found (otherwise 0)
* @access private
* @internal
* @see getSortNumber()
* @deprecated since core v9, will be removed with core v10
*/
......
......@@ -144,7 +144,7 @@ abstract class AbstractFormProtection
* Saves the session token so that it can be used by a later incarnation
* of this class.
*
* @access private
* @internal
*/
abstract public function persistSessionToken();
}
......@@ -124,7 +124,7 @@ class BackendFormProtection extends AbstractFormProtection
* Saves the tokens so that they can be used by a later incarnation of this
* class.
*
* @access private
* @internal
*/
public function persistSessionToken()
{
......@@ -135,7 +135,7 @@ class BackendFormProtection extends AbstractFormProtection
* Sets the session token for the user from the registry
* and returns it additionally.
*
* @access private
* @internal
* @return string
* @throws \UnexpectedValueException
*/
......@@ -152,7 +152,7 @@ class BackendFormProtection extends AbstractFormProtection
* Stores the session token in the registry to have it
* available during re-login of the user.
*
* @access private
* @internal
*/
public function storeSessionTokenInRegistry()
{
......@@ -162,7 +162,7 @@ class BackendFormProtection extends AbstractFormProtection
/**
* Removes the session token for the user from the registry.
*
* @access private
* @internal
*/
public function removeSessionTokenFromRegistry()
{
......
......@@ -201,7 +201,7 @@ class FormProtectionFactory
*
* Note: This function is intended for testing purposes only.
*
* @access private
* @internal
* @param string $classNameOrType
* @param AbstractFormProtection $instance
*/
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment