Commit 65a55111 authored by Benni Mack's avatar Benni Mack Committed by Markus Klein
Browse files

[TASK] Streamline phpdoc annotations in EXT:extbase

EXT:extbase uses @api and @internal phpDoc annotations. Going with a cleaner
approach with marking code as just @internal, and everything not annotated
as @internal is public, is the way to go, also the way PSR-5 is heading.

For EXT:extbase: Every PHP class that had nothing marked, is now @internal,
everything that was @api is now implicitly part of TYPO3 Core API.

On top, all license headers and @license annotations have been streamlined.

This means:
- TYPO3 Core's PHP classes area all public API by default
   unless marked as @internal or an extension class
- @api is not allowed anymore and will be restricted in
   the future from adding.
- @internal should be used for everything that should
   not be explicitly exposed as public API in the future.
- Everything under Tests/ is not part of TYPO3's Public API

Resolves: #86521
Releases: master
Change-Id: I83c5a27d9af001929142d2620600668ad0a84c92
Reviewed-on: https://review.typo3.org/58535


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>
Reviewed-by: Markus Klein's avatarMarkus Klein <markus.klein@typo3.org>
Tested-by: Markus Klein's avatarMarkus Klein <markus.klein@typo3.org>
parent 35707440
......@@ -17,7 +17,6 @@ namespace TYPO3\CMS\Extbase\Command;
/**
* A Command Controller which provides help for available commands
*
* @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
* @deprecated since TYPO3 v9, will be removed in TYPO3 v10.0.
*/
class HelpCommandController extends \TYPO3\CMS\Extbase\Mvc\Controller\CommandController
......
......@@ -16,6 +16,7 @@ namespace TYPO3\CMS\Extbase\Configuration;
/**
* Abstract base class for a general purpose configuration manager
* @internal only to be used within Extbase, not part of TYPO3 Core API.
*/
abstract class AbstractConfigurationManager implements \TYPO3\CMS\Core\SingletonInterface
{
......
......@@ -28,6 +28,7 @@ use TYPO3\CMS\Extbase\Mvc\Web\FrontendRequestHandler;
/**
* A general purpose configuration manager used in backend mode.
* @internal only to be used within Extbase, not part of TYPO3 Core API.
*/
class BackendConfigurationManager extends AbstractConfigurationManager
{
......
......@@ -19,6 +19,7 @@ namespace TYPO3\CMS\Extbase\Configuration;
* implementation of the configuration manager and provides an unified acccess point.
*
* Use the shutdown() method to drop the concrete implementation.
* @internal only to be used within Extbase, not part of TYPO3 Core API.
*/
class ConfigurationManager implements \TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface
{
......
......@@ -16,6 +16,7 @@ namespace TYPO3\CMS\Extbase\Configuration;
/**
* Class ConfigurationManagerInterface
* @internal only to be used within Extbase, not part of TYPO3 Core API.
*/
interface ConfigurationManagerInterface extends \TYPO3\CMS\Core\SingletonInterface
{
......@@ -32,7 +33,6 @@ interface ConfigurationManagerInterface extends \TYPO3\CMS\Core\SingletonInterfa
* Get the content object
*
* @return \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer
* @api (v4 only)
*/
public function getContentObject();
......
......@@ -21,6 +21,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
* A general purpose configuration manager used in frontend mode.
*
* Should NOT be singleton, as a new configuration manager is needed per plugin.
* @internal only to be used within Extbase, not part of TYPO3 Core API.
*/
class FrontendConfigurationManager extends \TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager
{
......
......@@ -60,7 +60,6 @@ class Bootstrap implements \TYPO3\CMS\Extbase\Core\BootstrapInterface
* @param array $configuration The TS configuration array
* @throws \RuntimeException
* @see run()
* @api
*/
public function initialize($configuration)
{
......@@ -96,6 +95,7 @@ class Bootstrap implements \TYPO3\CMS\Extbase\Core\BootstrapInterface
*
* @param array $configuration
* @see initialize()
* @internal
*/
public function initializeConfiguration($configuration)
{
......@@ -137,6 +137,7 @@ class Bootstrap implements \TYPO3\CMS\Extbase\Core\BootstrapInterface
* Initializes the persistence framework
*
* @see initialize()
* @internal
*/
public function initializePersistence()
{
......@@ -150,7 +151,6 @@ class Bootstrap implements \TYPO3\CMS\Extbase\Core\BootstrapInterface
* @param string $content The content. Not used
* @param array $configuration The TS configuration array
* @return string $content The processed content
* @api
*/
public function run($content, $configuration)
{
......
......@@ -16,6 +16,7 @@ namespace TYPO3\CMS\Extbase\Core;
/**
* Bootstrap Interface
* @internal only to be used within Extbase, not part of TYPO3 Core API.
*/
interface BootstrapInterface
{
......@@ -26,7 +27,6 @@ interface BootstrapInterface
* @param string $content The content. Not used
* @param array $configuration The TS configuration array
* @return string $content The processed content
* @api
*/
public function run($content, $configuration);
}
......@@ -17,7 +17,7 @@ namespace TYPO3\CMS\Extbase\Domain\Model;
/**
* A file object (File Abstraction Layer)
*
* @api experimental! This class is experimental and subject to change!
* @internal experimental! This class is experimental and subject to change!
*/
abstract class AbstractFileCollection extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
{
......
......@@ -17,7 +17,7 @@ namespace TYPO3\CMS\Extbase\Domain\Model;
/**
* A file object (File Abstraction Layer)
*
* @api experimental! This class is experimental and subject to change!
* @internal experimental! This class is experimental and subject to change!
*/
abstract class AbstractFileFolder extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
{
......
......@@ -18,8 +18,6 @@ use TYPO3\CMS\Extbase\Annotation as Extbase;
/**
* This model represents a back-end user.
*
* @api
*/
class BackendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
{
......
......@@ -18,8 +18,6 @@ use TYPO3\CMS\Extbase\Annotation as Extbase;
/**
* This model represents a backend usergroup.
*
* @api
*/
class BackendUserGroup extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
{
......
......@@ -18,8 +18,6 @@ use TYPO3\CMS\Extbase\Annotation as Extbase;
/**
* This model represents a category (for anything).
*
* @api
*/
class Category extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
{
......@@ -44,7 +42,6 @@ class Category extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Gets the title.
*
* @return string the title, might be empty
* @api
*/
public function getTitle()
{
......@@ -55,7 +52,6 @@ class Category extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Sets the title.
*
* @param string $title the title to set, may be empty
* @api
*/
public function setTitle($title)
{
......@@ -66,7 +62,6 @@ class Category extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Gets the description.
*
* @return string the description, might be empty
* @api
*/
public function getDescription()
{
......@@ -77,7 +72,6 @@ class Category extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Sets the description.
*
* @param string $description the description to set, may be empty
* @api
*/
public function setDescription($description)
{
......@@ -88,7 +82,6 @@ class Category extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Gets the parent category.
*
* @return \TYPO3\CMS\Extbase\Domain\Model\Category|null the parent category
* @api
*/
public function getParent()
{
......@@ -102,7 +95,6 @@ class Category extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Sets the parent category.
*
* @param \TYPO3\CMS\Extbase\Domain\Model\Category $parent the parent category
* @api
*/
public function setParent(\TYPO3\CMS\Extbase\Domain\Model\Category $parent)
{
......
......@@ -17,7 +17,7 @@ namespace TYPO3\CMS\Extbase\Domain\Model;
/**
* A file object (File Abstraction Layer)
*
* @api experimental! This class is experimental and subject to change!
* @internal experimental! This class is experimental and subject to change!
*/
class File extends \TYPO3\CMS\Extbase\Domain\Model\AbstractFileFolder
{
......
......@@ -18,8 +18,6 @@ use TYPO3\CMS\Extbase\Annotation as Extbase;
/**
* This model represents a file mount.
*
* @api
*/
class FileMount extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
{
......
......@@ -19,7 +19,7 @@ use TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
/**
* A file reference object (File Abstraction Layer)
*
* @api experimental! This class is experimental and subject to change!
* @internal experimental! This class is experimental and subject to change!
*/
class FileReference extends \TYPO3\CMS\Extbase\Domain\Model\AbstractFileFolder
{
......
......@@ -17,7 +17,7 @@ namespace TYPO3\CMS\Extbase\Domain\Model;
/**
* A folder object (File Abstraction Layer)
*
* @api experimental! This class is experimental and subject to change!
* @internal experimental! This class is experimental and subject to change!
*/
class Folder extends \TYPO3\CMS\Extbase\Domain\Model\AbstractFileFolder
{
......
......@@ -17,7 +17,7 @@ namespace TYPO3\CMS\Extbase\Domain\Model;
/**
* A file collection object (File Abstraction Layer)
*
* @api experimental! This class is experimental and subject to change!
* @internal experimental! This class is experimental and subject to change!
*/
class FolderBasedFileCollection extends \TYPO3\CMS\Extbase\Domain\Model\AbstractFileCollection
{
......
......@@ -16,8 +16,6 @@ namespace TYPO3\CMS\Extbase\Domain\Model;
/**
* A Frontend User
*
* @api
*/
class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
{
......@@ -126,7 +124,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
*
* @param string $username
* @param string $password
* @api
*/
public function __construct($username = '', $password = '')
{
......@@ -139,7 +136,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Sets the username value
*
* @param string $username
* @api
*/
public function setUsername($username)
{
......@@ -150,7 +146,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Returns the username value
*
* @return string
* @api
*/
public function getUsername()
{
......@@ -161,7 +156,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Sets the password value
*
* @param string $password
* @api
*/
public function setPassword($password)
{
......@@ -172,7 +166,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Returns the password value
*
* @return string
* @api
*/
public function getPassword()
{
......@@ -184,7 +177,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* although it can hold several usergroups.
*
* @param \TYPO3\CMS\Extbase\Persistence\ObjectStorage $usergroup
* @api
*/
public function setUsergroup(\TYPO3\CMS\Extbase\Persistence\ObjectStorage $usergroup)
{
......@@ -195,7 +187,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Adds a usergroup to the frontend user
*
* @param \TYPO3\CMS\Extbase\Domain\Model\FrontendUserGroup $usergroup
* @api
*/
public function addUsergroup(\TYPO3\CMS\Extbase\Domain\Model\FrontendUserGroup $usergroup)
{
......@@ -206,7 +197,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Removes a usergroup from the frontend user
*
* @param \TYPO3\CMS\Extbase\Domain\Model\FrontendUserGroup $usergroup
* @api
*/
public function removeUsergroup(\TYPO3\CMS\Extbase\Domain\Model\FrontendUserGroup $usergroup)
{
......@@ -218,7 +208,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* although it can hold several usergroups.
*
* @return \TYPO3\CMS\Extbase\Persistence\ObjectStorage An object storage containing the usergroup
* @api
*/
public function getUsergroup()
{
......@@ -229,7 +218,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Sets the name value
*
* @param string $name
* @api
*/
public function setName($name)
{
......@@ -240,7 +228,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Returns the name value
*
* @return string
* @api
*/
public function getName()
{
......@@ -251,7 +238,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Sets the firstName value
*
* @param string $firstName
* @api
*/
public function setFirstName($firstName)
{
......@@ -262,7 +248,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Returns the firstName value
*
* @return string
* @api
*/
public function getFirstName()
{
......@@ -273,7 +258,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Sets the middleName value
*
* @param string $middleName
* @api
*/
public function setMiddleName($middleName)
{
......@@ -284,7 +268,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Returns the middleName value
*
* @return string
* @api
*/
public function getMiddleName()
{
......@@ -295,7 +278,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Sets the lastName value
*
* @param string $lastName
* @api
*/
public function setLastName($lastName)
{
......@@ -306,7 +288,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Returns the lastName value
*
* @return string
* @api
*/
public function getLastName()
{
......@@ -317,7 +298,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Sets the address value
*
* @param string $address
* @api
*/
public function setAddress($address)
{
......@@ -328,7 +308,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Returns the address value
*
* @return string
* @api
*/
public function getAddress()
{
......@@ -339,7 +318,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Sets the telephone value
*
* @param string $telephone
* @api
*/
public function setTelephone($telephone)
{
......@@ -350,7 +328,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Returns the telephone value
*
* @return string
* @api
*/
public function getTelephone()
{
......@@ -361,7 +338,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Sets the fax value
*
* @param string $fax
* @api
*/
public function setFax($fax)
{
......@@ -372,7 +348,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Returns the fax value
*
* @return string
* @api
*/
public function getFax()
{
......@@ -383,7 +358,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Sets the email value
*
* @param string $email
* @api
*/
public function setEmail($email)
{
......@@ -394,7 +368,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Returns the email value
*
* @return string
* @api
*/
public function getEmail()
{
......@@ -405,7 +378,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Sets the lockToDomain value
*
* @param string $lockToDomain
* @api
*/
public function setLockToDomain($lockToDomain)
{
......@@ -416,7 +388,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Returns the lockToDomain value
*
* @return string
* @api
*/
public function getLockToDomain()
{
......@@ -427,7 +398,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Sets the title value
*
* @param string $title
* @api
*/
public function setTitle($title)
{
......@@ -438,7 +408,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Returns the title value
*
* @return string
* @api
*/
public function getTitle()
{
......@@ -449,7 +418,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Sets the zip value
*
* @param string $zip
* @api
*/
public function setZip($zip)
{
......@@ -460,7 +428,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Returns the zip value
*
* @return string
* @api
*/
public function getZip()
{
......@@ -471,7 +438,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Sets the city value
*
* @param string $city
* @api
*/
public function setCity($city)
{
......@@ -482,7 +448,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Returns the city value
*
* @return string
* @api
*/
public function getCity()
{
......@@ -493,7 +458,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Sets the country value
*
* @param string $country
* @api
*/
public function setCountry($country)
{
......@@ -504,7 +468,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Returns the country value
*
* @return string
* @api
*/
public function getCountry()
{
......@@ -515,7 +478,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Sets the www value
*
* @param string $www
* @api
*/
public function setWww($www)
{
......@@ -526,7 +488,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Returns the www value
*
* @return string
* @api
*/
public function getWww()
{
......@@ -537,7 +498,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Sets the company value
*
* @param string $company
* @api
*/
public function setCompany($company)
{
......@@ -548,7 +508,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Returns the company value
*
* @return string
* @api
*/
public function getCompany()
{
......@@ -558,7 +517,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
/**
* Sets the image value
*
* @api
* @param \TYPO3\CMS\Extbase\Persistence\ObjectStorage $image
*/
public function setImage(\TYPO3\CMS\Extbase\Persistence\ObjectStorage $image)
......@@ -569,7 +527,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
/**
* Gets the image value
*
* @api
* @return \TYPO3\CMS\Extbase\Persistence\ObjectStorage
*/
public function getImage()
......@@ -581,7 +538,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Sets the lastlogin value
*
* @param \DateTime $lastlogin
* @api
*/
public function setLastlogin(\DateTime $lastlogin)
{
......@@ -592,7 +548,6 @@ class FrontendUser extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Returns the lastlogin value
*
* @return \DateTime
* @api
*/
public function getLastlogin()
{
......
......@@ -16,8 +16,6 @@ namespace TYPO3\CMS\Extbase\Domain\Model;
/**
* A Frontend User Group
*
* @api
*/
class FrontendUserGroup extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
{
......@@ -56,7 +54,6 @@ class FrontendUserGroup extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Sets the title value
*
* @param string $title
* @api
*/
public function setTitle($title)
{
......@@ -67,7 +64,6 @@ class FrontendUserGroup extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Returns the title value
*
* @return string
* @api
*/
public function getTitle()
{
......@@ -78,7 +74,6 @@ class FrontendUserGroup extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Sets the lockToDomain value
*
* @param string $lockToDomain
* @api
*/
public function setLockToDomain($lockToDomain)
{
......@@ -89,7 +84,6 @@ class FrontendUserGroup extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Returns the lockToDomain value
*
* @return string
* @api
*/
public function getLockToDomain()
{
......@@ -100,7 +94,6 @@ class FrontendUserGroup extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
* Sets the description value
*
* @param string $description
* @api
*/
public function setDescription($description)
{
......@@ -111,7 +104,6 @@ class FrontendUserGroup extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntit