Edit the documentation of SessionProvider, AbstractAuthenticationProvider::init

The documentation of SessionProvider::init says that the method can be used in implementation tests.
Now all tests must use SessionProviderTestTrait::initProvider in order to initialize a SessionProvider.
So the entire description after @internal was rewritten. Also the
similar note was added to the documentation of
AbstractAuthenticationProvider::init.

Bug: T283931
Change-Id: I1cde6fd12666ef3a7c9b1e33a718592c11cf9e29
This commit is contained in:
vladshapik 2021-05-28 15:56:45 +03:00
parent e221991e86
commit 484fe84177
2 changed files with 5 additions and 2 deletions

View file

@ -56,7 +56,9 @@ abstract class AbstractAuthenticationProvider implements AuthenticationProvider
* Initialise with dependencies of an AuthenticationProvider
*
* @since 1.37
* @internal
* @internal In production code AuthManager will initialize the
* AbstractAuthenticationProvider, in tests
* AuthenticationProviderTestTrait must be used.
*
* @param LoggerInterface $logger
* @param AuthManager $manager

View file

@ -114,7 +114,8 @@ abstract class SessionProvider implements SessionProviderInterface {
* Initialise with dependencies of a SessionProvider
*
* @since 1.37
* @internal but can be called in implementation tests
* @internal In production code SessionManager will initialize the
* SessionProvider, in tests SessionProviderTestTrait must be used.
*
* @param LoggerInterface $logger
* @param Config $config