X-Git-Url: http://www.aleph1.co.uk/gitweb/?p=yaffs-website;a=blobdiff_plain;f=vendor%2Fsymfony%2Fpolyfill-php54%2FResources%2Fstubs%2FSessionHandlerInterface.php;fp=vendor%2Fsymfony%2Fpolyfill-php54%2FResources%2Fstubs%2FSessionHandlerInterface.php;h=9baa7bc0f616848c9420dd110470e193477260a2;hp=0000000000000000000000000000000000000000;hb=a2bd1bf0c2c1f1a17d188f4dc0726a45494cefae;hpb=57c063afa3f66b07c4bbddc2d6129a96d90f0aad diff --git a/vendor/symfony/polyfill-php54/Resources/stubs/SessionHandlerInterface.php b/vendor/symfony/polyfill-php54/Resources/stubs/SessionHandlerInterface.php new file mode 100644 index 000000000..9baa7bc0f --- /dev/null +++ b/vendor/symfony/polyfill-php54/Resources/stubs/SessionHandlerInterface.php @@ -0,0 +1,102 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +/** + * 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: + * + * @see http://php.net/sessionhandlerinterface + * @see http://php.net/session.customhandler + * @see http://php.net/session-set-save-handler + * + * @author Drak + * @author Tobias Schultze + */ +interface SessionHandlerInterface +{ + /** + * Re-initializes existing session, or creates a new one. + * + * @see http://php.net/sessionhandlerinterface.open + * + * @param string $savePath Save path + * @param string $sessionName Session name, see http://php.net/function.session-name.php + * + * @return bool true on success, false on failure + */ + public function open($savePath, $sessionName); + + /** + * Closes the current session. + * + * @see http://php.net/sessionhandlerinterface.close + * + * @return bool true on success, false on failure + */ + public function close(); + + /** + * Reads the session data. + * + * @see http://php.net/sessionhandlerinterface.read + * + * @param string $sessionId Session ID, see http://php.net/function.session-id + * + * @return string Same session data as passed in write() or empty string when non-existent or on failure + */ + public function read($sessionId); + + /** + * 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(). + * + * @see http://php.net/sessionhandlerinterface.write + * + * @param string $sessionId Session ID , see http://php.net/function.session-id + * @param string $data Serialized session data to save + * + * @return bool true on success, false on failure + */ + public function write($sessionId, $data); + + /** + * Destroys a session. + * + * @see http://php.net/sessionhandlerinterface.destroy + * + * @param string $sessionId Session ID, see http://php.net/function.session-id + * + * @return bool true on success, false on failure + */ + public function destroy($sessionId); + + /** + * Cleans up expired sessions (garbage collection). + * + * @see http://php.net/sessionhandlerinterface.gc + * + * @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 + */ + public function gc($maxlifetime); +}