Classe: SessionHandler_pgsql - X-Ref
PostgreSQL Session Handler for PHP (native).
Copyright 2000-2006 Jon Parise <jon@csh.rit.edu>. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
Required parameters:<pre>
'database' The name of the database.
'password' The password associated with 'username'.
'protocol' The communication protocol ('tcp', 'unix').
'username' The username with which to connect to the database.
Required for some configurations (i.e. 'protocol' = 'tcp'):<pre>
'hostspec' The hostname of the database server.
'port' The port on which to connect to the database.</pre>
Optional parameters:<pre>
'persistent' Use persistent DB connections? (boolean)
Default: NO
'table' The name of the sessiondata table in 'database'.
Default: 'horde_sessionhandler'</pre>
The table structure for the SessionHandler can be found in
horde/scripts/sql/horde_sessionhandler.pgsql.sql.
Contributors:<pre>
Jason Carlson Return an empty string on failed reads
pat@pcprogrammer.com Perform update in a single transaction
Jonathan Crompton Lock row for life of session</pre>
$Horde: framework/SessionHandler/SessionHandler/pgsql.php,v 1.12.10.15 2006/03/23 18:00:17 jan Exp $
|
close()
X-Ref
|
Close the SessionHandler backend.
return: boolean True on success, false otherwise.
|
|
read($id)
X-Ref
|
Read the data for a particular session identifier from the
SessionHandler backend.
param: string $id The session identifier.
return: string The session data.
|
|
write($id, $session_data)
X-Ref
|
Write session data to the SessionHandler backend.
param: string $id The session identifier.
param: string $session_data The session data.
return: boolean True on success, false otherwise.
|
|
destroy($id)
X-Ref
|
Destroy the data for a particular session identifier in the
SessionHandler backend.
param: string $id The session identifier.
return: boolean True on success, false otherwise.
|
|
gc($maxlifetime = 300)
X-Ref
|
Garbage collect stale sessions from the SessionHandler backend.
param: integer $maxlifetime The maximum age of a session.
return: boolean True on success, false otherwise.
|
|
quote($value)
X-Ref
|
Escape a string for insertion into the database.
param: string $value The string to quote.
return: string The quoted string.
|
|
getSessionIDs()
X-Ref
|
Get a list of the valid session identifiers.
return: array A list of valid session identifiers.
|
|
_connect()
X-Ref
|
Attempts to open a connection to the SQL server.
return: boolean True on success; exits (Horde::fatal()) on error.
|