PHPXRef 0.7.1 : phpBB-3.2.11-deutsch : Detail view of SessionHandlerInterface.php

(no description)

File Size:	102 lines (3 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

SessionHandlerInterface:: (6 methods):
  open()
  close()
  read()
  write()
  destroy()
  gc()

Interface: SessionHandlerInterface - X-Ref

SessionHandlerInterface for PHP < 5.4.

The order in which these methods are invoked by PHP are:
1. open [session_start]
2. read
3. gc [optional depending on probability settings: gc_probability / gc_divisor]
4. destroy [optional when session_regenerate_id(true) is used]
5. write [session_write_close] or destroy [session_destroy]
6. close

Extensive documentation can be found at php.net, see links:

open($savePath, $sessionName) X-Ref

Re-initializes existing session, or creates a new one.

param: string $savePath Save path
param: string $sessionName Session name, see https://php.net/function.session-name.php
return: bool true on success, false on failure

close() X-Ref

Closes the current session.

return: bool true on success, false on failure

read($sessionId) X-Ref

Reads the session data.

param: string $sessionId Session ID, see https://php.net/function.session-id
return: string Same session data as passed in write() or empty string when non-existent or on failure

write($sessionId, $data) X-Ref

Writes the session data to the storage.

Care, the session ID passed to write() can be different from the one previously
received in read() when the session ID changed due to session_regenerate_id().

param: string $sessionId Session ID , see https://php.net/function.session-id
param: string $data Serialized session data to save
return: bool true on success, false on failure

destroy($sessionId) X-Ref

Destroys a session.

param: string $sessionId Session ID, see https://php.net/function.session-id
return: bool true on success, false on failure

gc($maxlifetime) X-Ref

Cleans up expired sessions (garbage collection).

param: string|int $maxlifetime Sessions that have not updated for the last maxlifetime seconds will be removed
return: bool true on success, false on failure

PHP Cross Reference of phpBB-3.2.11-deutsch

/vendor/symfony/polyfill-php54/Resources/stubs/ -> SessionHandlerInterface.php (summary)

Defines 1 class