A CookieSessionProvider persists sessions using cookies. More...

Inheritance diagram for MediaWiki\Session\CookieSessionProvider:

Collaboration diagram for MediaWiki\Session\CookieSessionProvider:

Public Member Functions
	__construct ($params=[])

	canChangeUser ()

	getRememberUserDuration ()

	getVaryCookies ()

	persistSession (SessionBackend $session, WebRequest $request)

	persistsSessionId ()

	provideSessionInfo (WebRequest $request)

	setConfig (Config $config)

	suggestLoginUsername (WebRequest $request)

	unpersistSession (WebRequest $request)

	whyNoSession ()
	Return a Message for why sessions might not be being persisted. More...

Public Member Functions inherited from MediaWiki\Session\SessionProvider
	__construct ()

	__toString ()

	canChangeUser ()
	Indicate whether the user associated with the request can be changed. More...

	describe (Language $lang)
	Return an identifier for this session type. More...

	getAllowedUserRights (SessionBackend $backend)
	Fetch the rights allowed the user when the specified session is active. More...

	getManager ()
	Get the session manager. More...

	getRememberUserDuration ()
	Returns the duration (in seconds) for which users will be remembered when Session::setRememberUser() is set. More...

	getVaryCookies ()
	Return the list of cookies that need varying on. More...

	getVaryHeaders ()
	Return the HTTP headers that need varying on. More...

	invalidateSessionsForUser (User $user)
	Invalidate existing sessions for a user. More...

	mergeMetadata (array $savedMetadata, array $providedMetadata)
	Merge saved session provider metadata. More...

	newSessionInfo ($id=null)
	Provide session info for a new, empty session. More...

	persistSession (SessionBackend $session, WebRequest $request)
	Persist a session into a request/response. More...

	persistsSessionId ()
	Indicate whether self::persistSession() can save arbitrary session IDs. More...

	preventSessionsForUser ($username)
	Prevent future sessions for the user. More...

	provideSessionInfo (WebRequest $request)
	Provide session info for a request. More...

	refreshSessionInfo (SessionInfo $info, WebRequest $request, &$metadata)
	Validate a loaded SessionInfo and refresh provider metadata. More...

	sessionIdWasReset (SessionBackend $session, $oldId)
	Notification that the session ID was reset. More...

	setConfig (Config $config)
	Set configuration. More...

	setLogger (LoggerInterface $logger)

	setManager (SessionManager $manager)
	Set the session manager. More...

	suggestLoginUsername (WebRequest $request)
	Get a suggested username for the login form. More...

	unpersistSession (WebRequest $request)
	Remove any persisted session from a request/response. More...

	whyNoSession ()
	Return a Message for why sessions might not be being persisted. More...

Protected Member Functions
	cookieDataToExport ($user, $remember)
	Return the data to store in cookies. More...

	getCookie ($request, $key, $prefix, $default=null)
	Get a cookie. More...

	getLoginCookieExpiration ($cookieName)
	Returns the lifespan of the login cookies, in seconds. More...

	getUserInfoFromCookies ($request)
	Fetch the user identity from cookies. More...

	sessionDataToExport ($user)
	Return extra data to store in the session. More...

	setForceHTTPSCookie ($set, SessionBackend $backend=null, WebRequest $request)
	Set the "forceHTTPS" cookie. More...

	setLoggedOutCookie ($loggedOut, WebRequest $request)
	Set the "logged out" cookie. More...

Protected Member Functions inherited from MediaWiki\Session\SessionProvider
	describeMessage ()
	Return a Message identifying this session type. More...

	hashToSessionId ($data, $key=null)
	Hash data as a session ID. More...

Protected Attributes
	$cookieOptions = []

	$params = []

Protected Attributes inherited from MediaWiki\Session\SessionProvider
Config	$config

LoggerInterface	$logger

SessionManager	$manager

int	$priority
	Session priority. More...

Detailed Description

A CookieSessionProvider persists sessions using cookies.

Since: 1.27

Definition at line 36 of file CookieSessionProvider.php.

Constructor & Destructor Documentation

MediaWiki\Session\CookieSessionProvider::__construct ( $params = [] )

Parameters

array

$params

Keys include:

priority: (required) Priority of the returned sessions
callUserSetCookiesHook: Whether to call the deprecated hook
sessionName: Session cookie name. Doesn't honor 'prefix'. Defaults to $wgSessionName, or $wgCookiePrefix . '_session' if that is unset.
cookieOptions: Options to pass to WebRequest::setCookie():
- prefix: Cookie prefix, defaults to $wgCookiePrefix
- path: Cookie path, defaults to $wgCookiePath
- domain: Cookie domain, defaults to $wgCookieDomain
- secure: Cookie secure flag, defaults to $wgCookieSecure
- httpOnly: Cookie httpOnly flag, defaults to $wgCookieHttpOnly