PHP 클래스 Piwik\Plugins\Login\SessionInitializer

If a user is authenticated, a browser cookie is created so the user will be remembered until the cookie is destroyed. Plugins can override SessionInitializer behavior by extending this class and overriding methods. In order for these changes to have effect, however, an instance of the derived class must be used by the Login/Controller.
파일 보기 프로젝트 열기: piwik/piwik 1 사용 예제들

공개 메소드들

메소드 설명
__construct ( API | null $usersManagerAPI = null, string | null $authCookieName = null, integer | null $authCookieValidTime = null, string | null $authCookiePath = null ) Constructor.
getHashTokenAuth ( string $login, string $token_auth ) : string Accessor to compute the hashed authentication token.
initSession ( Piwik\Auth $auth, boolean $rememberMe ) Authenticates the user and, if successful, initializes an authenticated session.

보호된 메소드들

메소드 설명
doAuthenticateSession ( Piwik\Auth $auth ) : Piwik\AuthResult Authenticates the user.
getAuthCookie ( boolean $rememberMe ) : Piwik\Cookie Returns a Cookie instance that manages the browser cookie used to store session information.
processFailedSession ( boolean $rememberMe ) Executed when the session could not authenticate.
processSuccessfulSession ( Piwik\AuthResult $authResult, boolean $rememberMe ) Executed when the session was successfully authenticated.
regenerateSessionId ( )

메소드 상세

__construct() 공개 메소드

Constructor.
public __construct ( API | null $usersManagerAPI = null, string | null $authCookieName = null, integer | null $authCookieValidTime = null, string | null $authCookiePath = null )
$usersManagerAPI Piwik\Plugins\UsersManager\API | null
$authCookieName string | null
$authCookieValidTime integer | null
$authCookiePath string | null

doAuthenticateSession() 보호된 메소드

Derived classes can override this method to customize authentication logic or impose extra requirements on the user trying to login.
protected doAuthenticateSession ( Piwik\Auth $auth ) : Piwik\AuthResult
$auth Piwik\Auth The Auth implementation to use when authenticating.
리턴 Piwik\AuthResult

getAuthCookie() 보호된 메소드

Returns a Cookie instance that manages the browser cookie used to store session information.
protected getAuthCookie ( boolean $rememberMe ) : Piwik\Cookie
$rememberMe boolean Whether the authenticated session should be remembered after the browser is closed or not.
리턴 Piwik\Cookie

getHashTokenAuth() 공개 정적인 메소드

Accessor to compute the hashed authentication token.
public static getHashTokenAuth ( string $login, string $token_auth ) : string
$login string user login
$token_auth string authentication token
리턴 string hashed authentication token

initSession() 공개 메소드

Authenticates the user and, if successful, initializes an authenticated session.
public initSession ( Piwik\Auth $auth, boolean $rememberMe )
$auth Piwik\Auth The Auth implementation to use.
$rememberMe boolean Whether the authenticated session should be remembered after the browser is closed or not.

processFailedSession() 보호된 메소드

Executed when the session could not authenticate.
protected processFailedSession ( boolean $rememberMe )
$rememberMe boolean Whether the authenticated session should be remembered after the browser is closed or not.

processSuccessfulSession() 보호된 메소드

Executed when the session was successfully authenticated.
protected processSuccessfulSession ( Piwik\AuthResult $authResult, boolean $rememberMe )
$authResult Piwik\AuthResult The successful authentication result.
$rememberMe boolean Whether the authenticated session should be remembered after the browser is closed or not.

regenerateSessionId() 보호된 메소드

protected regenerateSessionId ( )