TSLISessionController
in
Interfase base para controladores que manejen requerimientos de session.
Table of Contents
| getUserCode() | Metodo hook que se usara para determinar el usuario conectado a la session debe retornar null si no hay ninguno conectado. | string |
|---|---|---|
| getUserId() | Retorna el id del usuario logeado , debe ser -1 si no existe ninguno. | int |
| isLoggedIn() | Retorna si el usuariop esta conectado al sistema. | bool |
| getSessionData() | Retorna el valor de un dato de sesion en base a una llave. | mixed |
| setUserCode() | Setea el codigo del usuario logeado , este valor tendra sentido ser seteado si isLoggedIn esta seteado. | void |
| setUserId() | Setea el id del usuario logeado , este valor tendra sentido ser seteado si isLoggedIn esta seteado. | void |
| setLoggedIn() | Setea si el usuario esta logeado o no al sistema. | void |
| setSessionData() | Guarda un valor en la sesion. | void |
| unsetSessionData() | Remueve un valor en la sesion. | void |
Methods
getUserCode()
Metodo hook que se usara para determinar el usuario conectado a la session debe retornar null si no hay ninguno conectado.
public
getUserCode(
)
: string
Return values
string —con el codigo del usuario conectado a la session o null de no existir ninguno.
getUserId()
Retorna el id del usuario logeado , debe ser -1 si no existe ninguno.
public
getUserId(
)
: int
Return values
int —con el id del usuario logeado o -1 de no haber alguno.
isLoggedIn()
Retorna si el usuariop esta conectado al sistema.
public
isLoggedIn(
)
: bool
Return values
bool —true si el usuario esta logeado al sistema.
getSessionData()
Retorna el valor de un dato de sesion en base a una llave.
public
getSessionData(
$name :
string
)
: mixed
Parameters
- $name : string
con el nombre llave del dato a buscar en la sesion.
Return values
mixed —retorna el datro guardado en la sesion
setUserCode()
Setea el codigo del usuario logeado , este valor tendra sentido ser seteado si isLoggedIn esta seteado.
public
setUserCode(
$userCode :
string
)
: void
Parameters
- $userCode : string
con el codigo del usuario a logearse.
setUserId()
Setea el id del usuario logeado , este valor tendra sentido ser seteado si isLoggedIn esta seteado.
public
setUserId(
$userId :
int
)
: void
Parameters
- $userId : int
con el id del usario logeado.
setLoggedIn()
Setea si el usuario esta logeado o no al sistema.
public
setLoggedIn(
$isLoggedIn :
bool
)
: void
Parameters
- $isLoggedIn : bool
true si el usuario esta logeado.
setSessionData()
Guarda un valor en la sesion.
public
setSessionData(
$name :
string
, $data :
mixed
)
: void
Parameters
- $name : string
con la llave del dato a agregar a la sesion.
- $data : mixed
el valor a guardar en la sesion
unsetSessionData()
Remueve un valor en la sesion.
public
unsetSessionData(
$name :
)
: void