[TASK] Streamline phpdoc annotations in EXT:extbase 35/58535/2
authorBenni Mack <benni@typo3.org>
Mon, 1 Oct 2018 16:03:21 +0000 (18:03 +0200)
committerMarkus Klein <markus.klein@typo3.org>
Mon, 1 Oct 2018 17:20:58 +0000 (19:20 +0200)
commit65a5511149dbabeb58fc86d9c4f66188ea040d90
treed358545bf72ef05c26e8aa90b51592c0c4763877
parent35707440e96b6511ba567f99bd04faa9ba51e546
[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: TYPO3com <no-reply@typo3.com>
Reviewed-by: Wouter Wolters <typo3@wouterwolters.nl>
Tested-by: Wouter Wolters <typo3@wouterwolters.nl>
Reviewed-by: Markus Klein <markus.klein@typo3.org>
Tested-by: Markus Klein <markus.klein@typo3.org>
254 files changed:
typo3/sysext/extbase/Classes/Command/HelpCommandController.php
typo3/sysext/extbase/Classes/Configuration/AbstractConfigurationManager.php
typo3/sysext/extbase/Classes/Configuration/BackendConfigurationManager.php
typo3/sysext/extbase/Classes/Configuration/ConfigurationManager.php
typo3/sysext/extbase/Classes/Configuration/ConfigurationManagerInterface.php
typo3/sysext/extbase/Classes/Configuration/FrontendConfigurationManager.php
typo3/sysext/extbase/Classes/Core/Bootstrap.php
typo3/sysext/extbase/Classes/Core/BootstrapInterface.php
typo3/sysext/extbase/Classes/Domain/Model/AbstractFileCollection.php
typo3/sysext/extbase/Classes/Domain/Model/AbstractFileFolder.php
typo3/sysext/extbase/Classes/Domain/Model/BackendUser.php
typo3/sysext/extbase/Classes/Domain/Model/BackendUserGroup.php
typo3/sysext/extbase/Classes/Domain/Model/Category.php
typo3/sysext/extbase/Classes/Domain/Model/File.php
typo3/sysext/extbase/Classes/Domain/Model/FileMount.php
typo3/sysext/extbase/Classes/Domain/Model/FileReference.php
typo3/sysext/extbase/Classes/Domain/Model/Folder.php
typo3/sysext/extbase/Classes/Domain/Model/FolderBasedFileCollection.php
typo3/sysext/extbase/Classes/Domain/Model/FrontendUser.php
typo3/sysext/extbase/Classes/Domain/Model/FrontendUserGroup.php
typo3/sysext/extbase/Classes/Domain/Model/StaticFileCollection.php
typo3/sysext/extbase/Classes/Domain/Repository/BackendUserGroupRepository.php
typo3/sysext/extbase/Classes/Domain/Repository/BackendUserRepository.php
typo3/sysext/extbase/Classes/Domain/Repository/CategoryRepository.php
typo3/sysext/extbase/Classes/Domain/Repository/FileMountRepository.php
typo3/sysext/extbase/Classes/Domain/Repository/FrontendUserGroupRepository.php
typo3/sysext/extbase/Classes/Domain/Repository/FrontendUserRepository.php
typo3/sysext/extbase/Classes/DomainObject/AbstractDomainObject.php
typo3/sysext/extbase/Classes/DomainObject/AbstractValueObject.php
typo3/sysext/extbase/Classes/Error/Error.php
typo3/sysext/extbase/Classes/Error/Message.php
typo3/sysext/extbase/Classes/Error/Notice.php
typo3/sysext/extbase/Classes/Error/Result.php
typo3/sysext/extbase/Classes/Error/Warning.php
typo3/sysext/extbase/Classes/Hook/DataHandler/CheckFlexFormValue.php
typo3/sysext/extbase/Classes/Mvc/Cli/Command.php
typo3/sysext/extbase/Classes/Mvc/Cli/CommandArgumentDefinition.php
typo3/sysext/extbase/Classes/Mvc/Cli/CommandManager.php
typo3/sysext/extbase/Classes/Mvc/Cli/Request.php
typo3/sysext/extbase/Classes/Mvc/Cli/RequestBuilder.php
typo3/sysext/extbase/Classes/Mvc/Cli/RequestHandler.php
typo3/sysext/extbase/Classes/Mvc/Cli/Response.php
typo3/sysext/extbase/Classes/Mvc/Controller/AbstractController.php
typo3/sysext/extbase/Classes/Mvc/Controller/ActionController.php
typo3/sysext/extbase/Classes/Mvc/Controller/Argument.php
typo3/sysext/extbase/Classes/Mvc/Controller/Arguments.php
typo3/sysext/extbase/Classes/Mvc/Controller/CommandController.php
typo3/sysext/extbase/Classes/Mvc/Controller/CommandControllerInterface.php
typo3/sysext/extbase/Classes/Mvc/Controller/ControllerContext.php
typo3/sysext/extbase/Classes/Mvc/Controller/ControllerInterface.php
typo3/sysext/extbase/Classes/Mvc/Controller/MvcPropertyMappingConfiguration.php
typo3/sysext/extbase/Classes/Mvc/Controller/MvcPropertyMappingConfigurationService.php
typo3/sysext/extbase/Classes/Mvc/Dispatcher.php
typo3/sysext/extbase/Classes/Mvc/Exception/AmbiguousCommandIdentifierException.php
typo3/sysext/extbase/Classes/Mvc/Request.php
typo3/sysext/extbase/Classes/Mvc/RequestHandlerInterface.php
typo3/sysext/extbase/Classes/Mvc/RequestHandlerResolver.php
typo3/sysext/extbase/Classes/Mvc/RequestInterface.php
typo3/sysext/extbase/Classes/Mvc/Response.php
typo3/sysext/extbase/Classes/Mvc/ResponseInterface.php
typo3/sysext/extbase/Classes/Mvc/View/AbstractView.php
typo3/sysext/extbase/Classes/Mvc/View/EmptyView.php
typo3/sysext/extbase/Classes/Mvc/View/JsonView.php
typo3/sysext/extbase/Classes/Mvc/View/NotFoundView.php
typo3/sysext/extbase/Classes/Mvc/View/ViewInterface.php
typo3/sysext/extbase/Classes/Mvc/Web/AbstractRequestHandler.php
typo3/sysext/extbase/Classes/Mvc/Web/BackendRequestHandler.php
typo3/sysext/extbase/Classes/Mvc/Web/CacheHashEnforcer.php
typo3/sysext/extbase/Classes/Mvc/Web/FrontendRequestHandler.php
typo3/sysext/extbase/Classes/Mvc/Web/ReferringRequest.php
typo3/sysext/extbase/Classes/Mvc/Web/Request.php
typo3/sysext/extbase/Classes/Mvc/Web/RequestBuilder.php
typo3/sysext/extbase/Classes/Mvc/Web/Response.php
typo3/sysext/extbase/Classes/Mvc/Web/Routing/UriBuilder.php
typo3/sysext/extbase/Classes/Object/Container/Container.php
typo3/sysext/extbase/Classes/Object/ObjectManager.php
typo3/sysext/extbase/Classes/Object/ObjectManagerInterface.php
typo3/sysext/extbase/Classes/Persistence/Exception/InvalidQueryException.php
typo3/sysext/extbase/Classes/Persistence/Generic/Backend.php
typo3/sysext/extbase/Classes/Persistence/Generic/BackendInterface.php
typo3/sysext/extbase/Classes/Persistence/Generic/Exception/RepositoryException.php
typo3/sysext/extbase/Classes/Persistence/Generic/LazyLoadingProxy.php
typo3/sysext/extbase/Classes/Persistence/Generic/LazyObjectStorage.php
typo3/sysext/extbase/Classes/Persistence/Generic/Mapper/ColumnMap.php
typo3/sysext/extbase/Classes/Persistence/Generic/Mapper/DataMap.php
typo3/sysext/extbase/Classes/Persistence/Generic/Mapper/DataMapFactory.php
typo3/sysext/extbase/Classes/Persistence/Generic/Mapper/DataMapper.php
typo3/sysext/extbase/Classes/Persistence/Generic/PersistenceManager.php
typo3/sysext/extbase/Classes/Persistence/Generic/PropertyType.php
typo3/sysext/extbase/Classes/Persistence/Generic/Qom/BindVariableValue.php
typo3/sysext/extbase/Classes/Persistence/Generic/Qom/BindVariableValueInterface.php
typo3/sysext/extbase/Classes/Persistence/Generic/Qom/Comparison.php
typo3/sysext/extbase/Classes/Persistence/Generic/Qom/ComparisonInterface.php
typo3/sysext/extbase/Classes/Persistence/Generic/Qom/EquiJoinCondition.php
typo3/sysext/extbase/Classes/Persistence/Generic/Qom/Join.php
typo3/sysext/extbase/Classes/Persistence/Generic/Qom/LogicalAnd.php
typo3/sysext/extbase/Classes/Persistence/Generic/Qom/LogicalNot.php
typo3/sysext/extbase/Classes/Persistence/Generic/Qom/LogicalOr.php
typo3/sysext/extbase/Classes/Persistence/Generic/Qom/LowerCase.php
typo3/sysext/extbase/Classes/Persistence/Generic/Qom/Ordering.php
typo3/sysext/extbase/Classes/Persistence/Generic/Qom/PropertyValue.php
typo3/sysext/extbase/Classes/Persistence/Generic/Qom/QueryObjectModelFactory.php
typo3/sysext/extbase/Classes/Persistence/Generic/Qom/Selector.php
typo3/sysext/extbase/Classes/Persistence/Generic/Qom/Statement.php
typo3/sysext/extbase/Classes/Persistence/Generic/Qom/UpperCase.php
typo3/sysext/extbase/Classes/Persistence/Generic/Query.php
typo3/sysext/extbase/Classes/Persistence/Generic/QueryFactory.php
typo3/sysext/extbase/Classes/Persistence/Generic/QueryResult.php
typo3/sysext/extbase/Classes/Persistence/Generic/QuerySettingsInterface.php
typo3/sysext/extbase/Classes/Persistence/Generic/Session.php
typo3/sysext/extbase/Classes/Persistence/Generic/Storage/BackendInterface.php
typo3/sysext/extbase/Classes/Persistence/Generic/Storage/Typo3DbBackend.php
typo3/sysext/extbase/Classes/Persistence/Generic/Storage/Typo3DbQueryParser.php
typo3/sysext/extbase/Classes/Persistence/Generic/Typo3QuerySettings.php
typo3/sysext/extbase/Classes/Persistence/PersistenceManagerInterface.php
typo3/sysext/extbase/Classes/Persistence/QueryInterface.php
typo3/sysext/extbase/Classes/Persistence/QueryResultInterface.php
typo3/sysext/extbase/Classes/Persistence/Repository.php
typo3/sysext/extbase/Classes/Persistence/RepositoryInterface.php
typo3/sysext/extbase/Classes/Property/Exception/DuplicateObjectException.php
typo3/sysext/extbase/Classes/Property/Exception/DuplicateTypeConverterException.php
typo3/sysext/extbase/Classes/Property/Exception/InvalidDataTypeException.php
typo3/sysext/extbase/Classes/Property/Exception/InvalidPropertyMappingConfigurationException.php
typo3/sysext/extbase/Classes/Property/Exception/InvalidSourceException.php
typo3/sysext/extbase/Classes/Property/Exception/InvalidTargetException.php
typo3/sysext/extbase/Classes/Property/Exception/TargetNotFoundException.php
typo3/sysext/extbase/Classes/Property/Exception/TypeConverterException.php
typo3/sysext/extbase/Classes/Property/PropertyMapper.php
typo3/sysext/extbase/Classes/Property/PropertyMappingConfiguration.php
typo3/sysext/extbase/Classes/Property/PropertyMappingConfigurationBuilder.php
typo3/sysext/extbase/Classes/Property/PropertyMappingConfigurationInterface.php
typo3/sysext/extbase/Classes/Property/TypeConverter/AbstractFileCollectionConverter.php
typo3/sysext/extbase/Classes/Property/TypeConverter/AbstractFileFolderConverter.php
typo3/sysext/extbase/Classes/Property/TypeConverter/AbstractTypeConverter.php
typo3/sysext/extbase/Classes/Property/TypeConverter/ArrayConverter.php
typo3/sysext/extbase/Classes/Property/TypeConverter/BooleanConverter.php
typo3/sysext/extbase/Classes/Property/TypeConverter/CoreTypeConverter.php
typo3/sysext/extbase/Classes/Property/TypeConverter/DateTimeConverter.php
typo3/sysext/extbase/Classes/Property/TypeConverter/FileConverter.php
typo3/sysext/extbase/Classes/Property/TypeConverter/FileReferenceConverter.php
typo3/sysext/extbase/Classes/Property/TypeConverter/FloatConverter.php
typo3/sysext/extbase/Classes/Property/TypeConverter/FolderBasedFileCollectionConverter.php
typo3/sysext/extbase/Classes/Property/TypeConverter/FolderConverter.php
typo3/sysext/extbase/Classes/Property/TypeConverter/IntegerConverter.php
typo3/sysext/extbase/Classes/Property/TypeConverter/ObjectConverter.php
typo3/sysext/extbase/Classes/Property/TypeConverter/ObjectStorageConverter.php
typo3/sysext/extbase/Classes/Property/TypeConverter/PersistentObjectConverter.php
typo3/sysext/extbase/Classes/Property/TypeConverter/StaticFileCollectionConverter.php
typo3/sysext/extbase/Classes/Property/TypeConverter/StringConverter.php
typo3/sysext/extbase/Classes/Property/TypeConverterInterface.php
typo3/sysext/extbase/Classes/Reflection/ClassSchema.php
typo3/sysext/extbase/Classes/Reflection/DocCommentParser.php
typo3/sysext/extbase/Classes/Reflection/Exception/PropertyNotAccessibleException.php
typo3/sysext/extbase/Classes/Reflection/Exception/UnknownClassException.php
typo3/sysext/extbase/Classes/Reflection/ObjectAccess.php
typo3/sysext/extbase/Classes/Reflection/ReflectionService.php
typo3/sysext/extbase/Classes/Security/Cryptography/HashService.php
typo3/sysext/extbase/Classes/Security/Exception.php
typo3/sysext/extbase/Classes/Service/CacheService.php
typo3/sysext/extbase/Classes/Service/EnvironmentService.php
typo3/sysext/extbase/Classes/Service/ExtensionService.php
typo3/sysext/extbase/Classes/Service/ImageService.php
typo3/sysext/extbase/Classes/SignalSlot/Dispatcher.php
typo3/sysext/extbase/Classes/SignalSlot/Exception/InvalidSlotException.php
typo3/sysext/extbase/Classes/SignalSlot/Exception/InvalidSlotReturnException.php
typo3/sysext/extbase/Classes/Utility/DebuggerUtility.php
typo3/sysext/extbase/Classes/Utility/Exception/InvalidTypeException.php
typo3/sysext/extbase/Classes/Utility/ExtensionUtility.php
typo3/sysext/extbase/Classes/Utility/FrontendSimulatorUtility.php
typo3/sysext/extbase/Classes/Utility/LocalizationUtility.php
typo3/sysext/extbase/Classes/Utility/TypeHandlingUtility.php
typo3/sysext/extbase/Classes/Validation/Exception.php
typo3/sysext/extbase/Classes/Validation/Validator/AbstractCompositeValidator.php
typo3/sysext/extbase/Classes/Validation/Validator/AbstractValidator.php
typo3/sysext/extbase/Classes/Validation/Validator/AlphanumericValidator.php
typo3/sysext/extbase/Classes/Validation/Validator/CollectionValidator.php
typo3/sysext/extbase/Classes/Validation/Validator/ConjunctionValidator.php
typo3/sysext/extbase/Classes/Validation/Validator/DateTimeValidator.php
typo3/sysext/extbase/Classes/Validation/Validator/DisjunctionValidator.php
typo3/sysext/extbase/Classes/Validation/Validator/EmailAddressValidator.php
typo3/sysext/extbase/Classes/Validation/Validator/FloatValidator.php
typo3/sysext/extbase/Classes/Validation/Validator/GenericObjectValidator.php
typo3/sysext/extbase/Classes/Validation/Validator/IntegerValidator.php
typo3/sysext/extbase/Classes/Validation/Validator/NotEmptyValidator.php
typo3/sysext/extbase/Classes/Validation/Validator/NumberRangeValidator.php
typo3/sysext/extbase/Classes/Validation/Validator/NumberValidator.php
typo3/sysext/extbase/Classes/Validation/Validator/ObjectValidatorInterface.php
typo3/sysext/extbase/Classes/Validation/Validator/RawValidator.php
typo3/sysext/extbase/Classes/Validation/Validator/RegularExpressionValidator.php
typo3/sysext/extbase/Classes/Validation/Validator/StringLengthValidator.php
typo3/sysext/extbase/Classes/Validation/Validator/StringValidator.php
typo3/sysext/extbase/Classes/Validation/Validator/TextValidator.php
typo3/sysext/extbase/Classes/Validation/Validator/UrlValidator.php
typo3/sysext/extbase/Classes/Validation/Validator/ValidatorInterface.php
typo3/sysext/extbase/Classes/Validation/ValidatorResolver.php
typo3/sysext/extbase/Tests/Fixture/ClassWithGettersAndSetters.php
typo3/sysext/extbase/Tests/Fixture/ClassWithSetters.php
typo3/sysext/extbase/Tests/Fixture/ClassWithSettersAndConstructor.php
typo3/sysext/extbase/Tests/Fixture/DummyClass.php
typo3/sysext/extbase/Tests/Fixture/SecondDummyClass.php
typo3/sysext/extbase/Tests/Fixture/SlotFixture.php
typo3/sysext/extbase/Tests/Fixture/TxClassWithGettersAndSetters.php
typo3/sysext/extbase/Tests/Unit/Error/ErrorTest.php
typo3/sysext/extbase/Tests/Unit/Error/ResultTest.php
typo3/sysext/extbase/Tests/Unit/Mvc/Controller/ArgumentTest.php
typo3/sysext/extbase/Tests/Unit/Mvc/Controller/MvcPropertyMappingConfigurationServiceTest.php
typo3/sysext/extbase/Tests/Unit/Property/PropertyMapperTest.php
typo3/sysext/extbase/Tests/Unit/Property/PropertyMappingConfigurationBuilderTest.php
typo3/sysext/extbase/Tests/Unit/Property/PropertyMappingConfigurationTest.php
typo3/sysext/extbase/Tests/Unit/Property/TypeConverter/ArrayConverterTest.php
typo3/sysext/extbase/Tests/Unit/Property/TypeConverter/BooleanConverterTest.php
typo3/sysext/extbase/Tests/Unit/Property/TypeConverter/DateTimeConverterTest.php
typo3/sysext/extbase/Tests/Unit/Property/TypeConverter/FloatConverterTest.php
typo3/sysext/extbase/Tests/Unit/Property/TypeConverter/IntegerConverterTest.php
typo3/sysext/extbase/Tests/Unit/Property/TypeConverter/ObjectConverterTest.php
typo3/sysext/extbase/Tests/Unit/Property/TypeConverter/PersistentObjectConverterTest.php
typo3/sysext/extbase/Tests/Unit/Property/TypeConverter/StringConverterTest.php
typo3/sysext/extbase/Tests/Unit/Reflection/Fixture/ArrayAccessClass.php
typo3/sysext/extbase/Tests/Unit/Reflection/Fixture/DummyClassWithAllTypesOfMethods.php
typo3/sysext/extbase/Tests/Unit/Reflection/Fixture/DummyClassWithAllTypesOfProperties.php
typo3/sysext/extbase/Tests/Unit/Reflection/Fixture/DummyClassWithConstructorAndConstructorArguments.php
typo3/sysext/extbase/Tests/Unit/Reflection/Fixture/DummyClassWithConstructorAndConstructorArgumentsWithDependencies.php
typo3/sysext/extbase/Tests/Unit/Reflection/Fixture/DummyClassWithConstructorAndWithoutConstructorArguments.php
typo3/sysext/extbase/Tests/Unit/Reflection/Fixture/DummyClassWithGettersAndSetters.php
typo3/sysext/extbase/Tests/Unit/Reflection/Fixture/DummyClassWithoutConstructor.php
typo3/sysext/extbase/Tests/Unit/Validation/Validator/AbstractCompositeValidatorTest.php
typo3/sysext/extbase/Tests/Unit/Validation/Validator/AbstractValidatorTest.php
typo3/sysext/extbase/Tests/Unit/Validation/Validator/AbstractValidatorTestcase.php
typo3/sysext/extbase/Tests/Unit/Validation/Validator/AlphanumericValidatorTest.php
typo3/sysext/extbase/Tests/Unit/Validation/Validator/BooleanValidatorTest.php
typo3/sysext/extbase/Tests/Unit/Validation/Validator/CollectionValidatorTest.php
typo3/sysext/extbase/Tests/Unit/Validation/Validator/ConjunctionValidatorTest.php
typo3/sysext/extbase/Tests/Unit/Validation/Validator/DateTimeValidatorTest.php
typo3/sysext/extbase/Tests/Unit/Validation/Validator/DisjunctionValidatorTest.php
typo3/sysext/extbase/Tests/Unit/Validation/Validator/EmailAddressValidatorTest.php
typo3/sysext/extbase/Tests/Unit/Validation/Validator/Fixture/AbstractCompositeValidatorClass.php
typo3/sysext/extbase/Tests/Unit/Validation/Validator/Fixture/AbstractValidatorClass.php
typo3/sysext/extbase/Tests/Unit/Validation/Validator/FloatValidatorTest.php
typo3/sysext/extbase/Tests/Unit/Validation/Validator/GenericObjectValidatorTest.php
typo3/sysext/extbase/Tests/Unit/Validation/Validator/IntegerValidatorTest.php
typo3/sysext/extbase/Tests/Unit/Validation/Validator/NotEmptyValidatorTest.php
typo3/sysext/extbase/Tests/Unit/Validation/Validator/NumberRangeValidatorTest.php
typo3/sysext/extbase/Tests/Unit/Validation/Validator/NumberValidatorTest.php
typo3/sysext/extbase/Tests/Unit/Validation/Validator/RegularExpressionValidatorTest.php
typo3/sysext/extbase/Tests/Unit/Validation/Validator/StringLengthValidatorTest.php
typo3/sysext/extbase/Tests/Unit/Validation/Validator/StringValidatorTest.php
typo3/sysext/extbase/Tests/Unit/Validation/Validator/TextValidatorTest.php
typo3/sysext/extbase/Tests/UnitDeprecated/Mvc/Cli/CommandManagerTest.php
typo3/sysext/extbase/Tests/UnitDeprecated/Mvc/Cli/Fixture/Command/MockACommandController.php
typo3/sysext/extbase/Tests/UnitDeprecated/Mvc/Cli/RequestBuilderTest.php
typo3/sysext/extbase/Tests/UnitDeprecated/Mvc/Cli/RequestTest.php
typo3/sysext/extbase/Tests/UnitDeprecated/Reflection/Fixture/DummyClassWithAllTypesOfProperties.php
typo3/sysext/extbase/Tests/UnitDeprecated/Reflection/Fixture/DummyClassWithInjectProperty.php
typo3/sysext/extbase/Tests/UnitDeprecated/Validation/Validator/RawValidatorTest.php