<?php
/* $Id$ */
namespace MCMS\Plugin;

(defined('MCMS') && (basename(__FILE__) != basename($_SERVER['PHP_SELF']))) or die('ACCESS DENIED');


/**
 * Session plugin interface.
 *
 * This interface is used to add a layer between the mcms session handling and the PHP
 * session. This is needed in the case of session storage systems which are not supported
 * by PHP, like (NO-)SQL storages.
 *
 * @author Stefan Daurer <s.daurer@q-spot.org>
 * @package MCMS\System\Plugin
 * @since 1.0.0.0
 */
interface iPlugInSession extends iPlugIn {

	/**
	 * returns a uniqe identifier for the current session
	 */
	public function sessionId();

	public function getSessionLifetime();

	/**
	 * stores a value in the session
	 */
	public function put($page, $key, $value);

	/**
	 * receives a value from the sesseion
	 */
	public function get($page, $key, $default = NULL);

	/**
	 * removes a value from the session
	 */
	public function clear($page, $key);

	/**
	 * destroys the session, freeing all resources
	 */
	public function destroy();
}