| [ Index ] |
PHP Cross Reference of phpBB-3.3.14-deutsch |
[Source view] [Print] [Project Stats]
(no description)
| File Size: | 918 lines (37 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
PdoSessionHandler:: (23 methods):
__construct()
createTable()
isSessionExpired()
open()
read()
gc()
doDestroy()
doWrite()
updateTimestamp()
close()
connect()
buildDsnFromUrl()
beginTransaction()
commit()
rollback()
doRead()
doAdvisoryLock()
convertStringToInt()
getSelectSql()
getInsertStatement()
getUpdateStatement()
getMergeStatement()
getConnection()
Class: PdoSessionHandler - X-Ref
Session handler using a PDO connection to read and write data.| __construct($pdoOrDsn = null, array $options = []) X-Ref |
| You can either pass an existing database connection as PDO instance or pass a DSN string that will be used to lazy-connect to the database when the session is actually used. Furthermore it's possible to pass null which will then use the session.save_path ini setting as PDO DSN parameter. List of available options: * db_table: The name of the table [default: sessions] * db_id_col: The column where to store the session id [default: sess_id] * db_data_col: The column where to store the session data [default: sess_data] * db_lifetime_col: The column where to store the lifetime [default: sess_lifetime] * db_time_col: The column where to store the timestamp [default: sess_time] * db_username: The username when lazy-connect [default: ''] * db_password: The password when lazy-connect [default: ''] * db_connection_options: An array of driver-specific connection options [default: []] * lock_mode: The strategy for locking, see constants [default: LOCK_TRANSACTIONAL] param: \PDO|string|null $pdoOrDsn A \PDO instance or DSN string or URL string or null param: array $options An associative array of options |
| createTable() X-Ref |
| Creates the table to store sessions which can be called once for setup. Session ID is saved in a column of maximum length 128 because that is enough even for a 512 bit configured session.hash_function like Whirlpool. Session data is saved in a BLOB. One could also use a shorter inlined varbinary column if one was sure the data fits into it. |
| isSessionExpired() X-Ref |
| Returns true when the current session exists but expired according to session.gc_maxlifetime. Can be used to distinguish between a new session and one that expired due to inactivity. return: bool Whether current session expired |
| open($savePath, $sessionName) X-Ref |
| {@inheritdoc} |
| read($sessionId) X-Ref |
| {@inheritdoc} |
| gc($maxlifetime) X-Ref |
return: bool |
| doDestroy($sessionId) X-Ref |
| {@inheritdoc} |
| doWrite($sessionId, $data) X-Ref |
| {@inheritdoc} |
| updateTimestamp($sessionId, $data) X-Ref |
| {@inheritdoc} |
| close() X-Ref |
| {@inheritdoc} |
| connect($dsn) X-Ref |
| Lazy-connects to the database. param: string $dsn DSN string |
| buildDsnFromUrl($dsnOrUrl) X-Ref |
| Builds a PDO DSN from a URL-like connection string. param: string $dsnOrUrl return: string |
| beginTransaction() X-Ref |
| Helper method to begin a transaction. Since SQLite does not support row level locks, we have to acquire a reserved lock on the database immediately. Because of https://bugs.php.net/42766 we have to create such a transaction manually which also means we cannot use PDO::commit or PDO::rollback or PDO::inTransaction for SQLite. Also MySQLs default isolation, REPEATABLE READ, causes deadlock for different sessions due to https://percona.com/blog/2013/12/12/one-more-innodb-gap-lock-to-avoid/ . So we change it to READ COMMITTED. |
| commit() X-Ref |
| Helper method to commit a transaction. |
| rollback() X-Ref |
| Helper method to rollback a transaction. |
| doRead($sessionId) X-Ref |
| Reads the session data in respect to the different locking strategies. We need to make sure we do not return session data that is already considered garbage according to the session.gc_maxlifetime setting because gc() is called after read() and only sometimes. param: string $sessionId Session ID return: string The session data |
| doAdvisoryLock($sessionId) X-Ref |
| Executes an application-level lock on the database. param: string $sessionId Session ID return: \PDOStatement The statement that needs to be executed later to release the lock |
| convertStringToInt($string) X-Ref |
| Encodes the first 4 (when PHP_INT_SIZE == 4) or 8 characters of the string as an integer. Keep in mind, PHP integers are signed. param: string $string return: int |
| getSelectSql() X-Ref |
| Return a locking or nonlocking SQL query to read session information. return: string The SQL string |
| getInsertStatement($sessionId, $sessionData, $maxlifetime) X-Ref |
| Returns an insert statement supported by the database for writing session data. param: string $sessionId Session ID param: string $sessionData Encoded session data param: int $maxlifetime session.gc_maxlifetime return: \PDOStatement The insert statement |
| getUpdateStatement($sessionId, $sessionData, $maxlifetime) X-Ref |
| Returns an update statement supported by the database for writing session data. param: string $sessionId Session ID param: string $sessionData Encoded session data param: int $maxlifetime session.gc_maxlifetime return: \PDOStatement The update statement |
| getMergeStatement($sessionId, $data, $maxlifetime) X-Ref |
| Returns a merge/upsert (i.e. insert or update) statement when supported by the database for writing session data. param: string $sessionId Session ID param: string $data Encoded session data param: int $maxlifetime session.gc_maxlifetime return: \PDOStatement|null The merge statement or null when not supported |
| getConnection() X-Ref |
| Return a PDO instance. return: \PDO |
| Generated: Mon Nov 25 19:05:08 2024 | Cross-referenced by PHPXref 0.7.1 |