Bitrix API

UserSessionTable extends DataManager

Class UserSessionTable

DO NOT WRITE ANYTHING BELOW THIS

<<< ORMENTITYANNOTATION

Table of Contents

Constants

CONNECTION_NAME  = 'user_session'

Methods

createCollection()  : EO_UserSession_Collection
createObject()  : EO_UserSession
deleteOlderThan()  : void
Deletes old sessions
getById()  : EO_UserSession_Result
getByPrimary()  : EO_UserSession_Result
getConnectionName()  : string
Returns connection name for entity Have side affect, keep it in mind! Clone default database connection if connection {@link SessionTable::CONNECTION_NAME} doesn't exists
getEntity()  : EO_UserSession_Entity
getList()  : EO_UserSession_Result
getMap()  : array<string|int, mixed>
{@inheritdoc}
getTableName()  : string
{@inheritdoc}
lock()  : bool
Locks specified session id
query()  : EO_UserSession_Query
unlock()  : bool
Unlock specified session id
wakeUpCollection()  : EO_UserSession_Collection
wakeUpObject()  : EO_UserSession

Constants

CONNECTION_NAME

public string CONNECTION_NAME = 'user_session'

Connection name used for SQL queries

Methods

createCollection()

public static createCollection() : EO_UserSession_Collection
Return values
EO_UserSession_Collection

createObject()

public static createObject([mixed $setDefaultValues = = 'true' ]) : EO_UserSession
Parameters
$setDefaultValues : mixed = = 'true'
Return values
EO_UserSession

deleteOlderThan()

Deletes old sessions

public static deleteOlderThan(int $sec) : void
Parameters
$sec : int

Seconds.

getById()

public static getById(mixed $id) : EO_UserSession_Result
Parameters
$id : mixed
Return values
EO_UserSession_Result

getByPrimary()

public static getByPrimary(mixed $primary[, array<string|int, mixed> $parameters = = '[]' ]) : EO_UserSession_Result
Parameters
$primary : mixed
$parameters : array<string|int, mixed> = = '[]'
Return values
EO_UserSession_Result

getConnectionName()

Returns connection name for entity Have side affect, keep it in mind! Clone default database connection if connection {@link SessionTable::CONNECTION_NAME} doesn't exists

public static getConnectionName() : string
Return values
string

getEntity()

public static getEntity() : EO_UserSession_Entity
Return values
EO_UserSession_Entity

getList()

public static getList([array<string|int, mixed> $parameters = = '[]' ]) : EO_UserSession_Result
Parameters
$parameters : array<string|int, mixed> = = '[]'
Return values
EO_UserSession_Result

getMap()

{@inheritdoc}

public static getMap() : array<string|int, mixed>
Return values
array<string|int, mixed>

getTableName()

{@inheritdoc}

public static getTableName() : string
Return values
string

lock()

Locks specified session id

public static lock(string $id[, int $timeout = 60 ]) : bool
Parameters
$id : string

Session id.

$timeout : int = 60

Lock timeout.

Return values
bool —

Returns true if lock occurred.

query()

public static query() : EO_UserSession_Query
Return values
EO_UserSession_Query

unlock()

Unlock specified session id

public static unlock(string $id) : bool
Parameters
$id : string

Session id.

Return values
bool —

Returns true if lock released.

wakeUpCollection()

public static wakeUpCollection(mixed $rows) : EO_UserSession_Collection
Parameters
$rows : mixed
Return values
EO_UserSession_Collection

wakeUpObject()

public static wakeUpObject(mixed $row) : EO_UserSession
Parameters
$row : mixed
Return values
EO_UserSession 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results