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.
	safeAgainstCsrf ()
	Returns true if this provider is safe against csrf attacks, or false otherwise.
	whyNoSession ()
	Return a Message for why sessions might not be being persisted.

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

$lang

Language to use.

Returns

string

Implemented in MediaWiki\Session\SessionProvider.

safeAgainstCsrf()

MediaWiki\Session\SessionProviderInterface::safeAgainstCsrf

(

)

Returns true if this provider is safe against csrf attacks, or false otherwise.

Returns

bool

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\CookieSessionProvider, MediaWiki\Session\ImmutableSessionProviderWithCookie, and MediaWiki\Session\SessionProvider.

---

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

• includes/session/SessionProviderInterface.php