nextcloud/lib/session/session.php

80 lines
1.4 KiB
PHP
Raw Normal View History

2013-05-28 02:50:00 +04:00
<?php
/**
* Copyright (c) 2013 Robin Appelman <icewind@owncloud.com>
* This file is licensed under the Affero General Public License version 3 or
* later.
* See the COPYING-README file.
*/
namespace OC\Session;
abstract class Session implements \ArrayAccess, \OCP\ISession {
2013-05-28 02:50:00 +04:00
/**
* $name serves as a namespace for the session keys
*
* @param string $name
*/
2013-05-28 18:52:40 +04:00
abstract public function __construct($name);
2013-05-28 02:50:00 +04:00
/**
* @param string $key
* @param mixed $value
*/
2013-05-28 18:52:40 +04:00
abstract public function set($key, $value);
2013-05-28 02:50:00 +04:00
/**
* @param string $key
* @return mixed should return null if $key does not exist
*/
2013-05-28 18:52:40 +04:00
abstract public function get($key);
2013-05-28 02:50:00 +04:00
/**
* @param string $key
* @return bool
*/
2013-05-28 18:52:40 +04:00
abstract public function exists($key);
2013-05-28 02:50:00 +04:00
/**
* should not throw any errors if $key does not exist
*
* @param string $key
*/
2013-05-28 18:52:40 +04:00
abstract public function remove($key);
2013-05-28 02:50:00 +04:00
/**
* removes all entries within the cache namespace
*/
2013-05-28 18:52:40 +04:00
abstract public function clear();
/**
* @param mixed $offset
* @return bool
*/
public function offsetExists($offset) {
return $this->exists($offset);
}
/**
* @param mixed $offset
* @return mixed
*/
public function offsetGet($offset) {
return $this->get($offset);
}
/**
* @param mixed $offset
* @param mixed $value
*/
public function offsetSet($offset, $value) {
$this->set($offset, $value);
}
/**
* @param mixed $offset
*/
public function offsetUnset($offset) {
$this->remove($offset);
}
2013-05-28 02:50:00 +04:00
}