PHP Класс Scalr_Session

Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод	Описание
__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 )

Защищенные методы

Метод	Описание
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.

Приватные методы

Метод	Описание
getReflectionClass ( ) : ReflectionClass	Gets a reflection class
startSession ( )	Starts session suppressing warnings and notices

Описание методов

__call() публичный Метод

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
Результат	string \| Scalr_Session

create() публичный статический Метод

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 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
Результат	string

createHash() защищенный статический Метод

protected static createHash ( $userId, $sault ) : string
$userId
$sault
Результат	string

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

public static destroy ( )

getAccountHash() защищенный статический Метод

Return account's hash. It's used for reseting keepSession on a whole account

protected static getAccountHash ( integer $userId ) : string
$userId	integer
Результат	string

getInstance() публичный статический Метод

public static getInstance ( boolean $isAutomaticRequest = false ) : Scalr_Session
$isAutomaticRequest	boolean
Результат	Scalr_Session

getRealUserId() публичный Метод

Gets real user identifier which is used to sign in to Scalr

public getRealUserId ( ) : integer
Результат	integer	Returns real user identifier which is used to sign in to Scalr

getUserHash() защищенный статический Метод

Return user's hash (id:email:password)

protected static getUserHash ( integer $userId ) : string
$userId	integer
Результат	string

getUserId() публичный Метод

Gets effective user identifier

public getUserId ( ) : integer
Результат	integer	Returns effective user identifier

isAuthenticated() публичный Метод

public isAuthenticated ( )

isCookieKeepSession() публичный статический Метод

Check if cookies is valid and isn't expired

public static isCookieKeepSession ( ) : boolean
Результат	boolean

isVirtual() публичный Метод

Checks whether the session is created by Scalr Admin

public isVirtual ( ) : boolean
Результат	boolean	Returns true if the session is created by Scalr Admin

keepSession() публичный статический Метод

Set special cookies. We could re-create session based on that cookies.

public static keepSession ( )

restore() защищенный статический Метод

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 sessionLog ( $log )