PHP Class Scalr_Session

ファイルを表示 Open project: scalr/scalr Class Usage Examples

Public Methods

Method Description
__call ( string $name, array $params ) : string | Scalr_Session This method is used to provide getters and setters for the session vars
create ( integer $userId, integer $ruid = null ) Creates a session
destroy ( ) Destroy session (including cookies). If session was created by admin, who logged into user (cookie auth is not equal to session auth), then destroy only session and re-create from cookie
getInstance ( boolean $isAutomaticRequest = false ) : Scalr_Session
getRealUserId ( ) : integer Gets real user identifier which is used to sign in to Scalr
getUserId ( ) : integer Gets effective user identifier
isAuthenticated ( )
isCookieKeepSession ( ) : boolean Check if cookies is valid and isn't expired
isVirtual ( ) : boolean Checks whether the session is created by Scalr Admin
keepSession ( ) Set special cookies. We could re-create session based on that cookies.
sessionLog ( $log )

Protected Methods

Method Description
createCookieHash ( integer $userId, integer $expire, string $sault, string $hash ) : string
createHash ( $userId, $sault ) : string
getAccountHash ( integer $userId ) : string Return account's hash. It's used for reseting keepSession on a whole account
getUserHash ( integer $userId ) : string Return user's hash (id:email:password)
restore ( boolean $checkKeepSessionCookie = true, boolean $isAutomaticRequest = false ) Check if session is valid and is not expired. If no valid session, check cookie keepSession.

Private Methods

Method Description
getReflectionClass ( ) : ReflectionClass Gets a reflection class
startSession ( ) Starts session suppressing warnings and notices

Method Details

__call() public method

This method is used to provide getters and setters for the session vars
public __call ( string $name, array $params ) : string | Scalr_Session
$name string
$params array
return string | Scalr_Session

create() public static method

Creates a session
public static create ( integer $userId, integer $ruid = null )
$userId integer The effective identifier of the user
$ruid integer optional Real user identifier which is used to sign in to Scalr (Admin UserId)

createCookieHash() protected static method

protected static createCookieHash ( integer $userId, integer $expire, string $sault, string $hash ) : string
$userId integer ID of user
$expire integer Timestamp when cookie will be expired
$sault string
$hash string
return string

createHash() protected static method

protected static createHash ( $userId, $sault ) : string
$userId
$sault
return string

destroy() public static method

Destroy session (including cookies). If session was created by admin, who logged into user (cookie auth is not equal to session auth), then destroy only session and re-create from cookie
public static destroy ( )

getAccountHash() protected static method

Return account's hash. It's used for reseting keepSession on a whole account
protected static getAccountHash ( integer $userId ) : string
$userId integer
return string

getInstance() public static method

public static getInstance ( boolean $isAutomaticRequest = false ) : Scalr_Session
$isAutomaticRequest boolean
return Scalr_Session

getRealUserId() public method

Gets real user identifier which is used to sign in to Scalr
public getRealUserId ( ) : integer
return integer Returns real user identifier which is used to sign in to Scalr

getUserHash() protected static method

Return user's hash (id:email:password)
protected static getUserHash ( integer $userId ) : string
$userId integer
return string

getUserId() public method

Gets effective user identifier
public getUserId ( ) : integer
return integer Returns effective user identifier

isAuthenticated() public method

public isAuthenticated ( )

isCookieKeepSession() public static method

Check if cookies is valid and isn't expired
public static isCookieKeepSession ( ) : boolean
return boolean

isVirtual() public method

Checks whether the session is created by Scalr Admin
public isVirtual ( ) : boolean
return boolean Returns true if the session is created by Scalr Admin

keepSession() public static method

Set special cookies. We could re-create session based on that cookies.
public static keepSession ( )

restore() protected static method

Check if session is valid and is not expired. If no valid session, check cookie keepSession.
protected static restore ( boolean $checkKeepSessionCookie = true, boolean $isAutomaticRequest = false )
$checkKeepSessionCookie boolean If true check cookie keepSession
$isAutomaticRequest boolean If true don't update sessionLastTime

sessionLog() public static method

public static sessionLog ( $log )