MediaWiki  1.28.0
MediaWiki\Session\Session\BotPasswordSessionProvider Class Reference

Session provider for bot passwords. More...

Inheritance diagram for MediaWiki\Session\Session\BotPasswordSessionProvider:
Collaboration diagram for MediaWiki\Session\Session\BotPasswordSessionProvider:

Public Member Functions

 __construct (array $params=[])
 
 getAllowedUserRights (SessionBackend $backend)
 
 newSessionForRequest (User $user, BotPassword $bp, WebRequest $request)
 Create a new session for a request. More...
 
 newSessionInfo ($id=null)
 
 preventSessionsForUser ($username)
 
 provideSessionInfo (WebRequest $request)
 
 refreshSessionInfo (SessionInfo $info, WebRequest $request, &$metadata)
 
- Public Member Functions inherited from MediaWiki\Session\ImmutableSessionProviderWithCookie
 __construct ($params=[])
 
 canChangeUser ()
 
 getVaryCookies ()
 
 persistSession (SessionBackend $session, WebRequest $request)
 
 persistsSessionId ()
 
 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...
 

Additional Inherited Members

- Protected Member Functions inherited from MediaWiki\Session\ImmutableSessionProviderWithCookie
 getSessionIdFromCookie (WebRequest $request)
 Get the session ID from the cookie, if any. 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 inherited from MediaWiki\Session\ImmutableSessionProviderWithCookie
string null $sessionCookieName = null
 
 $sessionCookieOptions = []
 
- Protected Attributes inherited from MediaWiki\Session\SessionProvider
Config $config
 
LoggerInterface $logger
 
SessionManager $manager
 
int $priority
 Session priority. More...
 

Detailed Description

Session provider for bot passwords.

Since
1.27

Definition at line 34 of file BotPasswordSessionProvider.php.

Constructor & Destructor Documentation

MediaWiki\Session\Session\BotPasswordSessionProvider::__construct ( array  $params = [])
Parameters
array$paramsKeys include:
  • priority: (required) Set the priority
  • sessionCookieName: Session cookie name. Default is '_BPsession'.
  • sessionCookieOptions: Options to pass to WebResponse::setCookie().

Definition at line 42 of file BotPasswordSessionProvider.php.

References $params, MediaWiki\Session\SessionInfo\MAX_PRIORITY, and MediaWiki\Session\SessionInfo\MIN_PRIORITY.

Member Function Documentation

MediaWiki\Session\Session\BotPasswordSessionProvider::getAllowedUserRights ( SessionBackend  $backend)
MediaWiki\Session\Session\BotPasswordSessionProvider::newSessionInfo (   $id = null)

Definition at line 84 of file BotPasswordSessionProvider.php.

MediaWiki\Session\Session\BotPasswordSessionProvider::preventSessionsForUser (   $username)
MediaWiki\Session\Session\BotPasswordSessionProvider::provideSessionInfo ( WebRequest  $request)
MediaWiki\Session\Session\BotPasswordSessionProvider::refreshSessionInfo ( SessionInfo  $info,
WebRequest  $request,
$metadata 
)

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