Session.php

<?php
/**
 * wCMF - wemove Content Management Framework
 * Copyright (C) 2005-2015 wemove digital solutions GmbH
 *
 * Licensed under the terms of the MIT License.
 *
 * See the LICENSE file distributed with this work for
 * additional information.
 */
namespace wcmf\lib\core;

use wcmf\lib\security\principal\User;

/**
 * Session is the interface for session implementations
 * and defines access to session variables.
 *
 * @author ingo herwig <ingo@wemove.com>
 */
interface Session {

  /**
   * Get the id of the session.
   * @return The id of the current session.
   */
  public function getID();

  /**
   * Returns the value of an session variable
   * @param $key The key (name) of the session vaiable.
   * @return The session var or null if it doesn't exist.
   */
  public function get($key);

  /**
   * Sets the value of an session variable.
   * @param $key The key (name) of the session vaiable.
   * @param $value The value of the session variable.
   */
  public function set($key, $value);

  /**
   * Remove a session variable.
   * @param $key The key (name) of the session variable.
   */
  public function remove($key);

  /**
   * Tests, if a certain session variable is defined.
   * @param $key The key (name) of the session variable.
   * @return Boolean whether the session variable is set or not.
   */
  public function exist($key);

  /**
   * Clear the session data.
   */
  public function clear();

  /**
   * Destroy the session.
   */
  public function destroy();

  /**
   * Set the authenticated user.
   * @param $authUser User instance.
   */
  public function setAuthUser(User $authUser);

  /**
   * Get the authenticated user.
   * @return User instance.
   */
  public function getAuthUser();

  /**
   * Add an error to the session data.
   * @param $key The identifier of the error
   * @param $error The error message
   */
  public function addError($key, $error);

  /**
   * Get an error stored in the session data.
   * @param $key The identifier of the error
   * @return The error message
   */
  public function getError($key);

  /**
   * Get all errors stored in the session data.
   * @return The error message
   */
  public function getErrors();

  /**
   * Clear the session error data.
   */
  public function clearErrors();
}