Public Member Functions | |
| open ($save_path, $name) | |
| Re-initialize existing session, or creates a new one. More... | |
| read ($session_id) | |
| Reads the session data from the session storage, and returns the results. More... | |
| write ($session_id, $session_data) | |
| Writes the session data to the session storage. More... | |
| close () | |
| Closes the current session. More... | |
| destroy ($session_id) | |
| Destroys a session. More... | |
| gc ($max_lifetime) | |
| Cleans up expired sessions. More... | |
Detailed Description
Definition at line 13 of file SessionHandler.php.
Member Function Documentation
◆ close()
| Elgg_Http_SessionHandler::close | ( | ) |
Closes the current session.
- Returns
- boolean
Implemented in Elgg_Http_MockSessionHandler, and Elgg_Http_DatabaseSessionHandler.
◆ destroy()
| Elgg_Http_SessionHandler::destroy | ( | $session_id | ) |
Destroys a session.
- Parameters
-
string $session_id The session id.
- Returns
- boolean
Implemented in Elgg_Http_MockSessionHandler, and Elgg_Http_DatabaseSessionHandler.
◆ gc()
| Elgg_Http_SessionHandler::gc | ( | $max_lifetime | ) |
Cleans up expired sessions.
- Parameters
-
int $max_lifetime Sessions not updated for max_lifetime seconds are removed.
- Returns
- boolean
Implemented in Elgg_Http_MockSessionHandler, and Elgg_Http_DatabaseSessionHandler.
◆ open()
| Elgg_Http_SessionHandler::open | ( | $save_path, | |
| $name | |||
| ) |
Re-initialize existing session, or creates a new one.
Called when a session starts or when session_start() is invoked.
- Parameters
-
string $save_path The path where to store/retrieve the session. string $name The session name.
- Returns
- boolean
Implemented in Elgg_Http_MockSessionHandler, and Elgg_Http_DatabaseSessionHandler.
◆ read()
| Elgg_Http_SessionHandler::read | ( | $session_id | ) |
Reads the session data from the session storage, and returns the results.
- Parameters
-
string $session_id The session id.
- Returns
- string Returns an encoded string of the read data
Implemented in Elgg_Http_MockSessionHandler, and Elgg_Http_DatabaseSessionHandler.
◆ write()
| Elgg_Http_SessionHandler::write | ( | $session_id, | |
| $session_data | |||
| ) |
Writes the session data to the session storage.
- Parameters
-
string $session_id The session id. string $session_data The encoded session data.
- Returns
- boolean
Implemented in Elgg_Http_MockSessionHandler, and Elgg_Http_DatabaseSessionHandler.
The documentation for this interface was generated from the following file:
- engine/classes/Elgg/Http/SessionHandler.php
