SessionHandlerInterface is an * interface which defines a * prototype for creating a custom session handler. In order to pass a custom * session handler to session_set_save_handler using its * OOP invocation, the class must implement this interface. * @link http://php.net/manual/en/class.sessionhandlerinterface.php */ interface SessionHandlerInterface { /** * (PHP 5 >= 5.4.0)
* Initialize session * @link http://php.net/manual/en/sessionhandlerinterface.open.php * @param string $save_path

* The path where to store/retrieve the session. *

* @param string $name

* The session name. *

* @return bool The return value (usually TRUE on success, FALSE on failure). Note this value is returned internally to PHP for processing. */ abstract public function open ($save_path, $name); /** * (PHP 5 >= 5.4.0)
* Close the session * @link http://php.net/manual/en/sessionhandlerinterface.close.php * @return bool The return value (usually TRUE on success, FALSE on failure). Note this value is returned internally to PHP for processing. */ abstract public function close (); /** * (PHP 5 >= 5.4.0)
* Read session data * @link http://php.net/manual/en/sessionhandlerinterface.read.php * @param string $session_id

* The session id. *

* @return string an encoded string of the read data. If nothing was read, it must return an empty string. Note this value is returned internally to PHP for processing. */ abstract public function read ($session_id); /** * (PHP 5 >= 5.4.0)
* Write session data * @link http://php.net/manual/en/sessionhandlerinterface.write.php * @param string $session_id

* The session id. *

* @param string $session_data

* The encoded session data. This data is the result of the PHP internally encoding the $_SESSION superglobal to a serialized * string and passing it as this parameter. Please note sessions use an alternative serialization method. *

* @return bool The return value (usually TRUE on success, FALSE on failure). Note this value is returned internally to PHP for processing. */ abstract public function write ($session_id, $session_data); /** * (PHP 5 >= 5.4.0)
* Destroy a session * @link http://php.net/manual/en/sessionhandlerinterface.destroy.php * @param string $session_id

* The session ID being destroyed. *

* @return bool The return value (usually TRUE on success, FALSE on failure). Note this value is returned internally to PHP for processing. */ abstract public function destroy ($session_id); /** * (PHP 5 >= 5.4.0)
* Cleanup old sessions * @link http://php.net/manual/en/sessionhandlerinterface.gc.php * @param string $maxlifetime

* Sessions that have not updated for the last maxlifetime seconds will be removed. *

* @return bool The return value (usually TRUE on success, FALSE on failure). Note this value is returned internally to PHP for processing. */ abstract public function gc ($maxlifetime); } /** * SessionHandler a special class that can be used to expose * the current internal PHP session save handler by inheritance. There are six methods which * wrap the six internal session save handler callbacks (open, close, * read, write, destroy and gc). * By default, this class will wrap whatever internal save handler is set as as defined by the * session.save_handler configuration directive which is usually * files by default. * Other internal session save handlers are provided by PHP extensions such as SQLite (as sqlite), * Memcache (as memcache), and Memcached (as memcached). * @link http://php.net/manual/en/class.sessionhandler.php */ class SessionHandler implements SessionHandlerInterface { /** * (PHP 5 >= 5.4.0)
* Initialize session * @link http://php.net/manual/en/sessionhandler.open.php * @param string $save_path

* The path where to store/retrieve the session. *

* @param string $session_id

* The session id. *

* @return bool The return value (usually TRUE on success, FALSE on failure). Note this value is returned internally to PHP for processing. */ public function open ($save_path, $session_id) {} /** * (PHP 5 >= 5.4.0)
* Close the session * @link http://php.net/manual/en/sessionhandler.close.php * @return bool The return value (usually TRUE on success, FALSE on failure). Note this value is returned internally to PHP for processing. */ public function close () {} /** * (PHP 5 >= 5.4.0)
* Read session data * @link http://php.net/manual/en/sessionhandler.read.php * @param string $session_id

* The session id to read data for. *

* @return string an encoded string of the read data. If nothing was read, it must return an empty string. Note this value is returned internally to PHP for processing. */ public function read ($session_id) {} /** * (PHP 5 >= 5.4.0)
* Write session data * @link http://php.net/manual/en/sessionhandler.write.php * @param string $session_id

* The session id. *

* @param string $session_data

* The encoded session data. This data is the result of the PHP internally encoding the $_SESSION superglobal to a serialized * string and passing it as this parameter. Please note sessions use an alternative serialization method. *

* @return bool The return value (usually TRUE on success, FALSE on failure). Note this value is returned internally to PHP for processing. */ public function write ($session_id, $session_data) {} /** * (PHP 5 >= 5.4.0)
* Destroy a session * @link http://php.net/manual/en/sessionhandler.destroy.php * @param string $session_id

* The session ID being destroyed. *

* @return bool The return value (usually TRUE on success, FALSE on failure). Note this value is returned internally to PHP for processing. */ public function destroy ($session_id) {} /** * (PHP 5 >= 5.4.0)
* Cleanup old sessions * @link http://php.net/manual/en/sessionhandler.gc.php * @param int $maxlifetime

* Sessions that have not updated for the last maxlifetime seconds will be removed. *

* @return bool The return value (usually TRUE on success, FALSE on failure). Note this value is returned internally to PHP for processing. */ public function gc ($maxlifetime) {} } /** * (PHP 4, PHP 5)
* Get and/or set the current session name * @link http://php.net/manual/en/function.session-name.php * @param string $name [optional]

* The session name references the name of the session, which is * used in cookies and URLs (e.g. PHPSESSID). It * should contain only alphanumeric characters; it should be short and * descriptive (i.e. for users with enabled cookie warnings). * If name is specified, the name of the current * session is changed to its value. *

*

*

* The session name can't consist of digits only, at least one letter * must be present. Otherwise a new session id is generated every time. *

*

* @return string the name of the current session. */ function session_name ($name = null) {} /** * (PHP 4, PHP 5)
* Get and/or set the current session module * @link http://php.net/manual/en/function.session-module-name.php * @param string $module [optional]

* If module is specified, that module will be * used instead. *

* @return string the name of the current session module. */ function session_module_name ($module = null) {} /** * (PHP 4, PHP 5)
* Get and/or set the current session save path * @link http://php.net/manual/en/function.session-save-path.php * @param string $path [optional]

* Session data path. If specified, the path to which data is saved will * be changed. session_save_path needs to be called * before session_start for that purpose. *

*

*

* On some operating systems, you may want to specify a path on a * filesystem that handles lots of small files efficiently. For example, * on Linux, reiserfs may provide better performance than ext2fs. *

*

* @return string the path of the current directory used for data storage. */ function session_save_path ($path = null) {} /** * (PHP 4, PHP 5)
* Get and/or set the current session id * @link http://php.net/manual/en/function.session-id.php * @param string $id [optional]

* If id is specified, it will replace the current * session id. session_id needs to be called before * session_start for that purpose. Depending on the * session handler, not all characters are allowed within the session id. * For example, the file session handler only allows characters in the * range a-z A-Z 0-9 , (comma) and - (minus)! *

* When using session cookies, specifying an id * for session_id will always send a new cookie * when session_start is called, regardless if the * current session id is identical to the one being set. * @return string session_id returns the session id for the current * session or the empty string ("") if there is no current * session (no current session id exists). */ function session_id ($id = null) {} /** * (PHP 4 >= 4.3.2, PHP 5)
* Update the current session id with a newly generated one * @link http://php.net/manual/en/function.session-regenerate-id.php * @param bool $delete_old_session [optional]

* Whether to delete the old associated session file or not. *

* @return bool TRUE on success or FALSE on failure. */ function session_regenerate_id ($delete_old_session = false) {} /** * (PHP 4, PHP 5)
* Decodes session data from a session encoded string * @link http://php.net/manual/en/function.session-decode.php * @param string $data

* The encoded data to be stored. *

* @return bool TRUE on success or FALSE on failure. */ function session_decode ($data) {} /** * (PHP 4, PHP 5)
* Encodes the current session data as a session encoded string * @link http://php.net/manual/en/function.session-encode.php * @return string the contents of the current session encoded. */ function session_encode () {} /** * (PHP 4, PHP 5)
* Start new or resume existing session * @link http://php.net/manual/en/function.session-start.php * @return bool This function returns TRUE if a session was successfully started, * otherwise FALSE. */ function session_start () {} /** * (PHP 4, PHP 5)
* Destroys all data registered to a session * @link http://php.net/manual/en/function.session-destroy.php * @return bool TRUE on success or FALSE on failure. */ function session_destroy () {} /** * (PHP 4, PHP 5)
* Free all session variables * @link http://php.net/manual/en/function.session-unset.php * @return void No value is returned. */ function session_unset () {} /** * (PHP 4, PHP 5)
* Sets user-level session storage functions * @link http://php.net/manual/en/function.session-set-save-handler.php * @param callable $open * @param callable $close * @param callable $read * @param callable $write * @param callable $destroy * @param callable $gc * @return bool TRUE on success or FALSE on failure. */ function session_set_save_handler (callable $open, callable $close, callable $read, callable $write, callable $destroy, callable $gc) {} /** * (PHP 4 >= 4.0.3, PHP 5)
* Get and/or set the current cache limiter * @link http://php.net/manual/en/function.session-cache-limiter.php * @param string $cache_limiter [optional]

* If cache_limiter is specified, the name of the * current cache limiter is changed to the new value. *

* * Possible values * * * * * * * * * * * * * * * * * * * * *
ValueHeaders sent
public * 
 * Expires: (sometime in the future, according session.cache_expire)
 * Cache-Control: public, max-age=(sometime in the future, according to session.cache_expire)
 * Last-Modified: (the timestamp of when the session was last saved)
 *
*
private_no_expire * 
 * Cache-Control: private, max-age=(session.cache_expire in the future), pre-check=(session.cache_expire in the future)
 * Last-Modified: (the timestamp of when the session was last saved)
 *
*
private * 
 * Expires: Thu, 19 Nov 1981 08:52:00 GMT
 * Cache-Control: private, max-age=(session.cache_expire in the future), pre-check=(session.cache_expire in the future)
 * Last-Modified: (the timestamp of when the session was last saved)
 *
*
nocache * 
 * Expires: Thu, 19 Nov 1981 08:52:00 GMT
 * Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
 * Pragma: no-cache
 *
*
* @return string the name of the current cache limiter. */ function session_cache_limiter ($cache_limiter = null) {} /** * (PHP 4 >= 4.2.0, PHP 5)
* Return current cache expire * @link http://php.net/manual/en/function.session-cache-expire.php * @param string $new_cache_expire [optional]

* If new_cache_expire is given, the current cache * expire is replaced with new_cache_expire. *

*

* Setting new_cache_expire is of value only, if * session.cache_limiter is set to a value * different from nocache. *

* @return int the current setting of session.cache_expire. * The value returned should be read in minutes, defaults to 180. */ function session_cache_expire ($new_cache_expire = null) {} /** * (PHP 4, PHP 5)
* Set the session cookie parameters * @link http://php.net/manual/en/function.session-set-cookie-params.php * @param int $lifetime

* Lifetime of the * session cookie, defined in seconds. *

* @param string $path [optional]

* Path on the domain where * the cookie will work. Use a single slash ('/') for all paths on the * domain. *

* @param string $domain [optional]

* Cookie domain, for * example 'www.php.net'. To make cookies visible on all subdomains then * the domain must be prefixed with a dot like '.php.net'. *

* @param bool $secure [optional]

* If TRUE cookie will only be sent over * secure connections. *

* @param bool $httponly [optional]

* If set to TRUE then PHP will attempt to send the * httponly * flag when setting the session cookie. *

* @return void No value is returned. */ function session_set_cookie_params ($lifetime, $path = null, $domain = null, $secure = false, $httponly = false) {} /** * (PHP 4, PHP 5)
* Get the session cookie parameters * @link http://php.net/manual/en/function.session-get-cookie-params.php * @return array an array with the current session cookie information, the array * contains the following items: * "lifetime" - The * lifetime of the cookie in seconds. * "path" - The path where * information is stored. * "domain" - The domain * of the cookie. * "secure" - The cookie * should only be sent over secure connections. * "httponly" - The * cookie can only be accessed through the HTTP protocol. */ function session_get_cookie_params () {} /** * (PHP 4 >= 4.0.4, PHP 5)
* Write session data and end session * @link http://php.net/manual/en/function.session-write-close.php * @return void No value is returned. */ function session_write_close () {} /** * (PHP >=5.4.0)
* Returns the current session status * @link http://php.net/manual/en/function.session-status.php * @return mixed PHP_SESSION_DISABLED if sessions are disabled. * PHP_SESSION_NONE if sessions are enabled, but none exists. * PHP_SESSION_ACTIVE if sessions are enabled, and one exists. */ function session_status () {} /** * (PHP >=5.4.0)
* Session shutdown function * @link http://php.net/manual/en/function.session-register-shutdown.php * @return void No value is returned. */ function session_register_shutdown () {} /** * (PHP 4 >= 4.4.0, PHP 5)
* Alias of session_write_close * @link http://php.net/manual/en/function.session-commit.php */ function session_commit () {} /** * Since PHP 5.4.0. Return value of session_status if sessions are disabled. * @link http://php.net/manual/en/session.constants.php */ define ('PHP_SESSION_DISABLED', 0); /** * Since PHP 5.4.0. Return value of session_status if sessions are enabled, * but no session exists. * @link http://php.net/manual/en/session.constants.php */ define ('PHP_SESSION_NONE', 1); /** * Since PHP 5.4.0. Return value of session_status if sessions are enabled, * and a session exists. * @link http://php.net/manual/en/session.constants.php */ define ('PHP_SESSION_ACTIVE', 2); // End of session v. ?>