diff options
author | Roeland Jago Douma <rullzer@owncloud.com> | 2016-05-19 09:00:09 +0300 |
---|---|---|
committer | Roeland Jago Douma <rullzer@owncloud.com> | 2016-05-19 10:43:33 +0300 |
commit | d666725fa783c21235eec79fa6dbe8ba1881fec3 (patch) | |
tree | 98914481ca4218c9af2c04db17c6d8f281b0094d /lib/public/ISession.php | |
parent | 4a94203492e3b475ee26b65d5992796152c645bd (diff) |
Move \OCP to PSR-4
Diffstat (limited to 'lib/public/ISession.php')
-rw-r--r-- | lib/public/ISession.php | 107 |
1 files changed, 107 insertions, 0 deletions
diff --git a/lib/public/ISession.php b/lib/public/ISession.php new file mode 100644 index 00000000000..7bc8654a1b9 --- /dev/null +++ b/lib/public/ISession.php @@ -0,0 +1,107 @@ +<?php +/** + * @author Lukas Reschke <lukas@owncloud.com> + * @author Morris Jobke <hey@morrisjobke.de> + * @author Thomas Müller <thomas.mueller@tmit.eu> + * @author Thomas Tanghus <thomas@tanghus.net> + * + * @copyright Copyright (c) 2016, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License, version 3, + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License, version 3, + * along with this program. If not, see <http://www.gnu.org/licenses/> + * + */ + +/** + * Public interface of ownCloud for apps to use. + * Session interface + * + */ + +// use OCP namespace for all classes that are considered public. +// This means that they should be used by apps instead of the internal ownCloud classes +namespace OCP; + +/** + * Interface ISession + * + * wrap PHP's internal session handling into the ISession interface + * @since 6.0.0 + */ +interface ISession { + + /** + * Set a value in the session + * + * @param string $key + * @param mixed $value + * @since 6.0.0 + */ + public function set($key, $value); + + /** + * Get a value from the session + * + * @param string $key + * @return mixed should return null if $key does not exist + * @since 6.0.0 + */ + public function get($key); + + /** + * Check if a named key exists in the session + * + * @param string $key + * @return bool + * @since 6.0.0 + */ + public function exists($key); + + /** + * Remove a $key/$value pair from the session + * + * @param string $key + * @since 6.0.0 + */ + public function remove($key); + + /** + * Reset and recreate the session + * @since 6.0.0 + */ + public function clear(); + + /** + * Close the session and release the lock + * @since 7.0.0 + */ + public function close(); + + /** + * Wrapper around session_regenerate_id + * + * @param bool $deleteOldSession Whether to delete the old associated session file or not. + * @return void + * @since 9.0.0 + */ + public function regenerateId($deleteOldSession = true); + + /** + * Wrapper around session_id + * + * @return string + * @throws SessionNotAvailableException + * @since 9.1.0 + */ + public function getId(); +} |