MediaWiki  master
MediaWiki\Session\SessionProviderInterface Interface Reference

This exists to make IDEs happy, so they don't see the internal-but-required-to-be-public methods on SessionProvider. More...

Inheritance diagram for MediaWiki\Session\SessionProviderInterface:

Public Member Functions

 describe (Language $lang)
 Return an identifier for this session type. More...
 
 whyNoSession ()
 Return a Message for why sessions might not be being persisted. More...
 

Detailed Description

This exists to make IDEs happy, so they don't see the internal-but-required-to-be-public methods on SessionProvider.

Since
1.27

Definition at line 36 of file SessionProviderInterface.php.

Member Function Documentation

◆ describe()

MediaWiki\Session\SessionProviderInterface::describe ( Language  $lang)

Return an identifier for this session type.

Parameters
Language$langLanguage to use.
Returns
string

Implemented in MediaWiki\Session\SessionProvider.

◆ whyNoSession()

MediaWiki\Session\SessionProviderInterface::whyNoSession ( )

Return a Message for why sessions might not be being persisted.

For example, "check whether you're blocking our cookies".

Returns
Message|null

Implemented in MediaWiki\Session\SessionProvider, MediaWiki\Session\CookieSessionProvider, and MediaWiki\Session\ImmutableSessionProviderWithCookie.


The documentation for this interface was generated from the following file: