session_set_save_handlerSets user-level session storage functions
&reftitle.description;
boolsession_set_save_handlercallbackopencallbackclosecallbackreadcallbackwritecallbackdestroycallbackgcsession_set_save_handler sets the user-level
session storage functions which are used for storing and
retrieving data associated with a session. This is most useful
when a storage method other than those supplied by PHP sessions
is preferred. i.e. Storing the session data in a local database.
&reftitle.parameters;
open
Open function, this works like a constructor in classes and is
executed when the session is being opened. The open function
expects two parameters, where the first is the save path and
the second is the session name.
close
Close function, this works like a destructor in classes and is
executed when the session operation is done.
read
Read function must return string value always to make save handler
work as expected. Return empty string if there is no data to read.
Return values from other handlers are converted to boolean expression.
&true; for success, &false; for failure.
write
The "write" handler is not executed until after the output stream is
closed. Thus, output from debugging statements in the "write"
handler will never be seen in the browser. If debugging output is
necessary, it is suggested that the debug output be written to a
file instead.
destroy
The destroy handler, this is executed when a session is destroyed with
session_destroy and takes the session id as its
only parameter.
gc
The garbage collector, this is executed when the session garbage collector
is executed and takes the max session lifetime as its only parameter.
&reftitle.returnvalues;
&return.success;
&reftitle.examples;
session_set_save_handler example
The following example provides file based session storage similar to the
PHP sessions default save handler files. This
example could easily be extended to cover database storage using your
favorite PHP supported database engine.
]]>
&reftitle.notes;
As of PHP 5.0.5 the write and
close handlers are called after object
destruction and therefore cannot use objects or throw exceptions.
The object destructors can however use sessions.
It is possible to call session_write_close from the
destructor to solve this chicken and egg problem.
Current working directory is changed with some SAPIs if session is
closed in the script termination. It is possible to close the session
earlier with session_write_close.
&reftitle.seealso;
The session.save_handler
configuration directive