MediaWiki REL1_28
SessionManagerInterface.php
Go to the documentation of this file.
1<?php
24namespace MediaWiki\Session;
25
26use Psr\Log\LoggerAwareInterface;
27use User;
28use WebRequest;
29
37interface SessionManagerInterface extends LoggerAwareInterface {
52 public function getSessionForRequest( WebRequest $request );
53
64 public function getSessionById( $id, $create = false, WebRequest $request = null );
65
76 public function getEmptySession( WebRequest $request = null );
77
87 public function invalidateSessionsForUser( User $user );
88
101 public function getVaryHeaders();
102
107 public function getVaryCookies();
108
109}
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition APACHE-LICENSE-2.0.txt:10
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:48
WebRequest
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping il...
Definition WebRequest.php:38
$request
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition hooks.txt:2685
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
MediaWiki\Session\SessionManagerInterface
This exists to make IDEs happy, so they don't see the internal-but-required-to-be-public methods on S...
Definition SessionManagerInterface.php:37
MediaWiki\Session\SessionManagerInterface\getSessionForRequest
getSessionForRequest(WebRequest $request)
Fetch the session for a request (or a new empty session if none is attached to it)
MediaWiki\Session\SessionManagerInterface\getVaryCookies
getVaryCookies()
Return the list of cookies that need varying on.
MediaWiki\Session\SessionManagerInterface\getVaryHeaders
getVaryHeaders()
Return the HTTP headers that need varying on.
MediaWiki\Session\SessionManagerInterface\getSessionById
getSessionById( $id, $create=false, WebRequest $request=null)
Fetch a session by ID.
MediaWiki\Session\SessionManagerInterface\getEmptySession
getEmptySession(WebRequest $request=null)
Create a new, empty session.
MediaWiki\Session\SessionManagerInterface\invalidateSessionsForUser
invalidateSessionsForUser(User $user)
Invalidate sessions for a user.