Commit 7bdaa18b authored by Benni Mack's avatar Benni Mack Committed by Wouter Wolters
Browse files

[TASK] Mark various parts with phpdoc internal - part 4

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:core
- EXT:extensionmanager
- EXT:install

All @api annotations have been removed.

Resolves: #86517
Releases: master
Change-Id: I7869d8e3b6e8a4365529cc7c98b99cde7ca1495f
Reviewed-on: https://review.typo3.org/58532


Reviewed-by: Oliver Hader's avatarOliver Hader <oliver.hader@typo3.org>
Tested-by: Oliver Hader's avatarOliver Hader <oliver.hader@typo3.org>
Tested-by: default avatarTYPO3com <no-reply@typo3.com>
Reviewed-by: Wouter Wolters's avatarWouter Wolters <typo3@wouterwolters.nl>
Tested-by: Wouter Wolters's avatarWouter Wolters <typo3@wouterwolters.nl>
parent b1bad629
......@@ -1821,7 +1821,6 @@ class BackendUserAuthentication extends AbstractUserAuthentication
* Each filemount is represented with an array of a "name", "path" and "type".
* If no filemounts an empty array is returned.
*
* @api
* @return \TYPO3\CMS\Core\Resource\ResourceStorage[]
*/
public function getFileStorages()
......@@ -1879,7 +1878,6 @@ class BackendUserAuthentication extends AbstractUserAuthentication
* Please note that these permissions only apply, if the storage has the
* capabilities (browseable, writable), and if the driver allows for writing etc
*
* @api
* @return array
*/
public function getFilePermissions()
......@@ -1937,7 +1935,6 @@ class BackendUserAuthentication extends AbstractUserAuthentication
* storage with the default settings.
* Admin users will always get the default settings.
*
* @api
* @param \TYPO3\CMS\Core\Resource\ResourceStorage $storageObject
* @return array
*/
......
......@@ -19,8 +19,6 @@ use Psr\Log\LoggerAwareTrait;
/**
* An abstract caching backend
*
* @api
*/
abstract class AbstractBackend implements BackendInterface, LoggerAwareInterface
{
......@@ -63,7 +61,6 @@ abstract class AbstractBackend implements BackendInterface, LoggerAwareInterface
* @param string $context Unused, for backward compatibility only
* @param array $options Configuration options - depends on the actual backend
* @throws \InvalidArgumentException
* @api
*/
public function __construct($context, array $options = [])
{
......@@ -84,7 +81,6 @@ abstract class AbstractBackend implements BackendInterface, LoggerAwareInterface
* Sets a reference to the cache frontend which uses this backend
*
* @param \TYPO3\CMS\Core\Cache\Frontend\FrontendInterface $cache The frontend for this backend
* @api
*/
public function setCache(\TYPO3\CMS\Core\Cache\Frontend\FrontendInterface $cache)
{
......@@ -97,7 +93,6 @@ abstract class AbstractBackend implements BackendInterface, LoggerAwareInterface
*
* @param int $defaultLifetime Default lifetime of this cache backend in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited lifetime.
* @throws \InvalidArgumentException
* @api
*/
public function setDefaultLifetime($defaultLifetime)
{
......@@ -116,7 +111,6 @@ abstract class AbstractBackend implements BackendInterface, LoggerAwareInterface
* delegate to a less efficient linear flushing behavior.
*
* @param string[] $tags
* @api
*/
public function flushByTags(array $tags)
{
......
......@@ -39,8 +39,6 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
* - MD5 of path to TYPO3 project folder and user running TYPO3
* This prefix makes sure that keys from the different installations do not
* conflict.
*
* @api
*/
class ApcBackend extends AbstractBackend implements TaggableBackendInterface
{
......@@ -122,7 +120,6 @@ class ApcBackend extends AbstractBackend implements TaggableBackendInterface
* @param int $lifetime Lifetime of this cache entry in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited lifetime.
* @throws Exception if no cache frontend has been set.
* @throws InvalidDataException if $data is not a string
* @api
*/
public function set($entryIdentifier, $data, array $tags = [], $lifetime = null)
{
......@@ -148,7 +145,6 @@ class ApcBackend extends AbstractBackend implements TaggableBackendInterface
*
* @param string $entryIdentifier An identifier which describes the cache entry to load
* @return mixed The cache entry's content as a string or FALSE if the cache entry could not be loaded
* @api
*/
public function get($entryIdentifier)
{
......@@ -162,7 +158,6 @@ class ApcBackend extends AbstractBackend implements TaggableBackendInterface
*
* @param string $entryIdentifier An identifier specifying the cache entry
* @return bool TRUE if such an entry exists, FALSE if not
* @api
*/
public function has($entryIdentifier)
{
......@@ -178,7 +173,6 @@ class ApcBackend extends AbstractBackend implements TaggableBackendInterface
*
* @param string $entryIdentifier Specifies the cache entry to remove
* @return bool TRUE if (at least) an entry could be removed or FALSE if no entry was found
* @api
*/
public function remove($entryIdentifier)
{
......@@ -192,7 +186,6 @@ class ApcBackend extends AbstractBackend implements TaggableBackendInterface
*
* @param string $tag The tag to search for
* @return array An array with identifiers of all matching entries. An empty array if no entries matched
* @api
*/
public function findIdentifiersByTag($tag)
{
......@@ -222,7 +215,6 @@ class ApcBackend extends AbstractBackend implements TaggableBackendInterface
* Removes all cache entries of this cache.
*
* @throws Exception
* @api
*/
public function flush()
{
......@@ -236,7 +228,6 @@ class ApcBackend extends AbstractBackend implements TaggableBackendInterface
* Removes all cache entries of this cache which are tagged by the specified tag.
*
* @param string $tag The tag the entries must have
* @api
*/
public function flushByTag($tag)
{
......
......@@ -39,8 +39,6 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
* - MD5 of path to TYPO3 and user running TYPO3
* This prefix makes sure that keys from the different installations do not
* conflict.
*
* @api
*/
class ApcuBackend extends AbstractBackend implements TaggableBackendInterface
{
......@@ -122,7 +120,6 @@ class ApcuBackend extends AbstractBackend implements TaggableBackendInterface
* @param int $lifetime Lifetime of this cache entry in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited lifetime.
* @throws Exception if no cache frontend has been set.
* @throws InvalidDataException if $data is not a string
* @api
*/
public function set($entryIdentifier, $data, array $tags = [], $lifetime = null)
{
......@@ -148,7 +145,6 @@ class ApcuBackend extends AbstractBackend implements TaggableBackendInterface
*
* @param string $entryIdentifier An identifier which describes the cache entry to load
* @return mixed The cache entry's content as a string or FALSE if the cache entry could not be loaded
* @api
*/
public function get($entryIdentifier)
{
......@@ -162,7 +158,6 @@ class ApcuBackend extends AbstractBackend implements TaggableBackendInterface
*
* @param string $entryIdentifier An identifier specifying the cache entry
* @return bool TRUE if such an entry exists, FALSE if not
* @api
*/
public function has($entryIdentifier)
{
......@@ -178,7 +173,6 @@ class ApcuBackend extends AbstractBackend implements TaggableBackendInterface
*
* @param string $entryIdentifier Specifies the cache entry to remove
* @return bool TRUE if (at least) an entry could be removed or FALSE if no entry was found
* @api
*/
public function remove($entryIdentifier)
{
......@@ -192,7 +186,6 @@ class ApcuBackend extends AbstractBackend implements TaggableBackendInterface
*
* @param string $tag The tag to search for
* @return array An array with identifiers of all matching entries. An empty array if no entries matched
* @api
*/
public function findIdentifiersByTag($tag)
{
......@@ -222,7 +215,6 @@ class ApcuBackend extends AbstractBackend implements TaggableBackendInterface
* Removes all cache entries of this cache.
*
* @throws Exception
* @api
*/
public function flush()
{
......@@ -236,7 +228,6 @@ class ApcuBackend extends AbstractBackend implements TaggableBackendInterface
* Removes all cache entries of this cache which are tagged by the specified tag.
*
* @param string $tag The tag the entries must have
* @api
*/
public function flushByTag($tag)
{
......
......@@ -18,7 +18,6 @@ use TYPO3\CMS\Core\Cache;
/**
* A contract for a Cache Backend
* @api
*/
interface BackendInterface
{
......@@ -26,7 +25,6 @@ interface BackendInterface
* Sets a reference to the cache frontend which uses this backend
*
* @param Cache\Frontend\FrontendInterface $cache The frontend for this backend
* @api
*/
public function setCache(Cache\Frontend\FrontendInterface $cache);
......@@ -39,7 +37,6 @@ interface BackendInterface
* @param int $lifetime Lifetime of this cache entry in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited lifetime.
* @throws \TYPO3\CMS\Core\Cache\Exception if no cache frontend has been set.
* @throws \TYPO3\CMS\Core\Cache\Exception\InvalidDataException if the data is not a string
* @api
*/
public function set($entryIdentifier, $data, array $tags = [], $lifetime = null);
......@@ -48,7 +45,6 @@ interface BackendInterface
*
* @param string $entryIdentifier An identifier which describes the cache entry to load
* @return mixed The cache entry's content as a string or FALSE if the cache entry could not be loaded
* @api
*/
public function get($entryIdentifier);
......@@ -57,7 +53,6 @@ interface BackendInterface
*
* @param string $entryIdentifier An identifier specifying the cache entry
* @return bool TRUE if such an entry exists, FALSE if not
* @api
*/
public function has($entryIdentifier);
......@@ -68,21 +63,16 @@ interface BackendInterface
*
* @param string $entryIdentifier Specifies the cache entry to remove
* @return bool TRUE if (at least) an entry could be removed or FALSE if no entry was found
* @api
*/
public function remove($entryIdentifier);
/**
* Removes all cache entries of this cache.
*
* @api
*/
public function flush();
/**
* Does garbage collection
*
* @api
*/
public function collectGarbage();
}
......@@ -24,8 +24,6 @@ use TYPO3\CMS\Core\Utility\StringUtility;
/**
* A caching backend which stores cache entries in files
*
* @api
*/
class FileBackend extends SimpleFileBackend implements FreezableBackendInterface, TaggableBackendInterface
{
......@@ -123,7 +121,6 @@ class FileBackend extends SimpleFileBackend implements FreezableBackendInterface
* @throws InvalidDataException if the directory does not exist or is not writable or exceeds the maximum allowed path length, or if no cache frontend has been set.
* @throws Exception if the directory does not exist or is not writable or exceeds the maximum allowed path length, or if no cache frontend has been set.
* @throws \InvalidArgumentException
* @api
*/
public function set($entryIdentifier, $data, array $tags = [], $lifetime = null)
{
......@@ -168,7 +165,6 @@ class FileBackend extends SimpleFileBackend implements FreezableBackendInterface
* @param string $entryIdentifier An identifier which describes the cache entry to load
* @return mixed The cache entry's content as a string or FALSE if the cache entry could not be loaded
* @throws \InvalidArgumentException If identifier is invalid
* @api
*/
public function get($entryIdentifier)
{
......@@ -198,7 +194,6 @@ class FileBackend extends SimpleFileBackend implements FreezableBackendInterface
* @param string $entryIdentifier
* @return bool TRUE if such an entry exists, FALSE if not
* @throws \InvalidArgumentException
* @api
*/
public function has($entryIdentifier)
{
......@@ -219,7 +214,6 @@ class FileBackend extends SimpleFileBackend implements FreezableBackendInterface
* @return bool TRUE if (at least) an entry could be removed or FALSE if no entry was found
* @throws \RuntimeException
* @throws \InvalidArgumentException
* @api
*/
public function remove($entryIdentifier)
{
......@@ -248,7 +242,6 @@ class FileBackend extends SimpleFileBackend implements FreezableBackendInterface
*
* @param string $searchedTag The tag to search for
* @return array An array with identifiers of all matching entries. An empty array if no entries matched
* @api
*/
public function findIdentifiersByTag($searchedTag)
{
......@@ -285,8 +278,6 @@ class FileBackend extends SimpleFileBackend implements FreezableBackendInterface
/**
* Removes all cache entries of this cache and sets the frozen flag to FALSE.
*
* @api
*/
public function flush()
{
......@@ -300,7 +291,6 @@ class FileBackend extends SimpleFileBackend implements FreezableBackendInterface
* Removes all cache entries of this cache which are tagged by the specified tag.
*
* @param string $tag The tag the entries must have
* @api
*/
public function flushByTag($tag)
{
......@@ -319,7 +309,6 @@ class FileBackend extends SimpleFileBackend implements FreezableBackendInterface
*
* @param string $cacheEntryPathAndFilename
* @return bool
* @api
*/
protected function isCacheFileExpired($cacheEntryPathAndFilename)
{
......@@ -339,8 +328,6 @@ class FileBackend extends SimpleFileBackend implements FreezableBackendInterface
/**
* Does garbage collection
*
* @api
*/
public function collectGarbage()
{
......@@ -386,7 +373,6 @@ class FileBackend extends SimpleFileBackend implements FreezableBackendInterface
* @param string $entryIdentifier An identifier which describes the cache entry to load
* @throws \InvalidArgumentException
* @return mixed Potential return value from the include operation
* @api
*/
public function requireOnce($entryIdentifier)
{
......@@ -409,7 +395,6 @@ class FileBackend extends SimpleFileBackend implements FreezableBackendInterface
* @param string $entryIdentifier An identifier which describes the cache entry to load
* @throws \InvalidArgumentException
* @return mixed Potential return value from the include operation
* @api
*/
public function require(string $entryIdentifier)
{
......
......@@ -16,8 +16,6 @@ namespace TYPO3\CMS\Core\Cache\Backend;
/**
* A contract for a cache backend which can be frozen.
*
* @api
*/
interface FreezableBackendInterface extends BackendInterface
{
......
......@@ -40,8 +40,6 @@ use TYPO3\CMS\Core\Core\Environment;
*
* Note: When using the Memcached backend to store values of more than ~1 MB,
* the data will be split into chunks to make them fit into the memcached limits.
*
* @api
*/
class MemcachedBackend extends AbstractBackend implements TaggableBackendInterface, TransientBackendInterface
{
......@@ -117,7 +115,6 @@ class MemcachedBackend extends AbstractBackend implements TaggableBackendInterfa
* to be formatted like "<host>[:<port>]" or "unix://<path>"
*
* @param array $servers An array of servers to add.
* @api
*/
protected function setServers(array $servers)
{
......@@ -128,7 +125,6 @@ class MemcachedBackend extends AbstractBackend implements TaggableBackendInterfa
* Setter for compression flags bit
*
* @param bool $useCompression
* @api
*/
protected function setCompression($useCompression)
{
......@@ -144,7 +140,6 @@ class MemcachedBackend extends AbstractBackend implements TaggableBackendInterfa
* Getter for compression flag
*
* @return bool
* @api
*/
protected function getCompression()
{
......@@ -222,7 +217,6 @@ class MemcachedBackend extends AbstractBackend implements TaggableBackendInterfa
* @param int $lifetime Lifetime of this cache entry in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited lifetime.
* @throws Exception if no cache frontend has been set.
* @throws \InvalidArgumentException if the identifier is not valid or the final memcached key is longer than 250 characters
* @api
*/
public function set($entryIdentifier, $data, array $tags = [], $lifetime = null)
{
......@@ -285,7 +279,6 @@ class MemcachedBackend extends AbstractBackend implements TaggableBackendInterfa
*
* @param string $entryIdentifier An identifier which describes the cache entry to load
* @return mixed The cache entry's content as a string or FALSE if the cache entry could not be loaded
* @api
*/
public function get($entryIdentifier)
{
......@@ -305,7 +298,6 @@ class MemcachedBackend extends AbstractBackend implements TaggableBackendInterfa
*
* @param string $entryIdentifier An identifier specifying the cache entry
* @return bool TRUE if such an entry exists, FALSE if not
* @api
*/
public function has($entryIdentifier)
{
......@@ -325,7 +317,6 @@ class MemcachedBackend extends AbstractBackend implements TaggableBackendInterfa
*
* @param string $entryIdentifier Specifies the cache entry to remove
* @return bool TRUE if (at least) an entry could be removed or FALSE if no entry was found
* @api
*/
public function remove($entryIdentifier)
{
......@@ -339,7 +330,6 @@ class MemcachedBackend extends AbstractBackend implements TaggableBackendInterfa
*
* @param string $tag The tag to search for
* @return array An array of entries with all matching entries. An empty array if no entries matched
* @api
*/
public function findIdentifiersByTag($tag)
{
......@@ -354,7 +344,6 @@ class MemcachedBackend extends AbstractBackend implements TaggableBackendInterfa
* Removes all cache entries of this cache.
*
* @throws Exception
* @api
*/
public function flush()
{
......@@ -368,7 +357,6 @@ class MemcachedBackend extends AbstractBackend implements TaggableBackendInterfa
* Removes all cache entries of this cache which are tagged by the specified tag.
*
* @param string $tag The tag the entries must have
* @api
*/
public function flushByTag($tag)
{
......@@ -446,7 +434,6 @@ class MemcachedBackend extends AbstractBackend implements TaggableBackendInterfa
*
* @param string $identifier Identifier to find tags by
* @return array
* @api
*/
protected function findTagsByIdentifier($identifier)
{
......@@ -456,8 +443,6 @@ class MemcachedBackend extends AbstractBackend implements TaggableBackendInterfa
/**
* Does nothing, as memcached does GC itself
*
* @api
*/
public function collectGarbage()
{
......
......@@ -16,8 +16,6 @@ namespace TYPO3\CMS\Core\Cache\Backend;
/**
* A caching backend which forgets everything immediately
*
* @api
*/
class NullBackend extends AbstractBackend implements PhpCapableBackendInterface, TaggableBackendInterface
{
......@@ -28,7 +26,6 @@ class NullBackend extends AbstractBackend implements PhpCapableBackendInterface,
* @param string $data ignored
* @param array $tags ignored
* @param int $lifetime ignored
* @api
*/
public function set($entryIdentifier, $data, array $tags = [], $lifetime = null)
{
......@@ -48,7 +45,6 @@ class NullBackend extends AbstractBackend implements PhpCapableBackendInterface,
*
* @param string $entryIdentifier ignored
* @return bool FALSE
* @api
*/
public function get($entryIdentifier)
{
......@@ -60,7 +56,6 @@ class NullBackend extends AbstractBackend implements PhpCapableBackendInterface,
*
* @param string $entryIdentifier ignored
* @return bool FALSE
* @api
*/
public function has($entryIdentifier)
{
......@@ -72,7 +67,6 @@ class NullBackend extends AbstractBackend implements PhpCapableBackendInterface,
*
* @param string $entryIdentifier ignored
* @return bool FALSE
* @api
*/
public function remove($entryIdentifier)
{
......@@ -84,7 +78,6 @@ class NullBackend extends AbstractBackend implements PhpCapableBackendInterface,
*
* @param string $tag ignored
* @return array An empty array
* @api
*/
public function findIdentifiersByTag($tag)
{
......@@ -93,8 +86,6 @@ class NullBackend extends AbstractBackend implements PhpCapableBackendInterface,
/**
* Does nothing
*
* @api
*/
public function flush()
{
......@@ -104,7 +95,6 @@ class NullBackend extends AbstractBackend implements PhpCapableBackendInterface,
* Does nothing
*
* @param string $tag ignored
* @api
*/
public function flushByTag($tag)
{
......@@ -112,8 +102,6 @@ class NullBackend extends AbstractBackend implements PhpCapableBackendInterface,
/**
* Does nothing
*
* @api
*/
public function collectGarbage()
{
......@@ -123,7 +111,6 @@ class NullBackend extends AbstractBackend implements PhpCapableBackendInterface,
* Does nothing
*
* @param string $identifier An identifier which describes the cache entry to load
* @api
*/
public function requireOnce($identifier)
{
......@@ -133,7 +120,6 @@ class NullBackend extends AbstractBackend implements PhpCapableBackendInterface,
* Does nothing
*
* @param string $identifier An identifier which describes the cache entry to load
* @api
*/
public function require(string $identifier)
{
......
......@@ -22,7 +22,6 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
/**
* A PDO database cache backend
* @api
*/
class PdoBackend extends AbstractBackend implements TaggableBackendInterface
{
......@@ -55,7 +54,6 @@ class PdoBackend extends AbstractBackend implements TaggableBackendInterface
* Sets the DSN to use
*
* @param string $DSN The DSN to use for connecting to the DB
* @api
*/
public function setDataSourceName($DSN)
{
......@@ -66,7 +64,6 @@ class PdoBackend extends AbstractBackend implements TaggableBackendInterface
* Sets the username to use
*
* @param string $username The username to use for connecting to the DB
* @api
*/
public function setUsername($username)
{
......@@ -77,7 +74,6 @@ class PdoBackend extends AbstractBackend implements TaggableBackendInterface
* Sets the password to use
*
* @param string $password The password to use for connecting to the DB
* @api
*/
public function setPassword($password)
{
......@@ -102,7 +98,6 @@ class PdoBackend extends AbstractBackend implements TaggableBackendInterface
* @throws Exception if no cache frontend has been set.
* @throws \InvalidArgumentException if the identifier is not valid
* @throws InvalidDataException if $data is not a string
* @api
*/
public function set($entryIdentifier, $data, array $tags = [], $lifetime = null)
{
......@@ -133,7 +128,6 @@ class PdoBackend extends AbstractBackend implements TaggableBackendInterface
*
* @param string $entryIdentifier An identifier which describes the cache entry to load
* @return mixed The cache entry's content as a string or FALSE if the cache entry could not be loaded
* @api
*/
public function get($entryIdentifier)
{
......@@ -147,7 +141,6 @@ class PdoBackend extends AbstractBackend implements TaggableBackendInterface
*
* @param string $entryIdentifier An identifier specifying the cache entry
* @return bool TRUE if such an entry exists, FALSE if not
* @api
*/
public function has($entryIdentifier)
{
......@@ -163,7 +156,6 @@ class PdoBackend extends AbstractBackend implements TaggableBackendInterface
*
* @param string $entryIdentifier Specifies the cache entry to remove
* @return bool TRUE if (at least) an entry could be removed or FALSE if no entry was found
* @api
*/
public function remove($entryIdentifier)
{
......@@ -176,8 +168,6 @@ class PdoBackend extends AbstractBackend implements TaggableBackendInterface
/**
* Removes all cache entries of this cache.
*
* @api
*/
public function flush()
{
......@@ -191,7 +181,6 @@ class PdoBackend extends AbstractBackend implements TaggableBackendInterface
* Removes all cache entries of this cache which are tagged by the specified tag.
*
* @param string $tag The tag the entries must have
* @api
*/
public function flushByTag($tag)
{
......@@ -207,7 +196,6 @@ class PdoBackend extends AbstractBackend implements TaggableBackendInterface
*
* @param string $tag The tag to search for
* @return array An array with identifiers of all matching entries. An empty array if no entries matched
* @api
*/
public function findIdentifiersByTag($tag)
{
......@@ -218,8 +206,6 @@ class PdoBackend extends AbstractBackend implements TaggableBackendInterface
/**
* Does garbage collection
*
* @api