1. trait
  2. CNIC
  3. \
  4. CNR
  5. \
  6. SessionCapable

SessionCapable

trait SessionCapable (View source)

Provides session-based API communication methods.

Use this trait in SessionClient classes whose underlying API supports persistent sessions (login/logout lifecycle).

Methods

Response
login()

Perform API login to start session-based communication

Response
logout()

Perform API logout to close API session in use

SessionCapable
saveSession(array $session)

Apply session data to a PHP session object

SessionCapable
reuseSession(array $session)

Rebuild connection settings from a PHP session object

Details

at line 24
Response login()

Perform API login to start session-based communication

Return Value

Response

at line 39
Response logout()

Perform API logout to close API session in use

Return Value

Response

at line 55
SessionCapable saveSession(array $session)

Apply session data to a PHP session object

Parameters

array $session

php session instance ($_SESSION)

Return Value

SessionCapable

at line 70
SessionCapable reuseSession(array $session)

Rebuild connection settings from a PHP session object

Parameters

array $session

php session object ($_SESSION)

Return Value

SessionCapable