Tiqr_StateStorage_Abstract

Complexity

Total Complexity

2

Size/Duplication

Total Lines	52
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	2	1
A	__construct()	0	3	1

<?php
/**
 * This file is part of the tiqr project.
 * 
 * The tiqr project aims to provide an open implementation for 
 * authentication using mobile devices. It was initiated by 
 * SURFnet and developed by Egeniq.
 *
 * More information: http://www.tiqr.org
 *
 * @author Ivo Jansch <ivo@egeniq.com>
 * 
 * @package tiqr
 *
 * @license New BSD License - See LICENSE file for details.
 *
 * @copyright (C) 2010-2011 SURFnet BV
 */


/**
 * The Abstract base class for all StateStorage implementations
 * StateStorages are meant to store the information that is used in the
 * enrollment and authentication processes, or to keep track of whether
 * a user is logged in.
 * @author ivo
 *
 */
abstract class Tiqr_StateStorage_Abstract
{
    /**
     * The options for the storage. Derived classes can access this
     * to retrieve options configured for the state storage.
     * @var array
     */
    protected $_options = array();
    
    /**
     * Store a value with a certain key in the statestorage.
     * @param String $key The key identifying the data
     * @param mixed $value The data to store in state storage
     * @param int $expire The expiration (in seconds) of the data
     */
    public abstract function setValue($key, $value, $expire=0);
    
    /**
     * Remove a value from the state storage
     * @param String $key The key identifying the data to be removed.
     */
    public abstract function unsetValue($key);
    
    /**
     * Retrieve the data for a certain key.
     * @param String $key The key identifying the data to be retrieved.
     * @return mixed The data associated with the key
     */
    public abstract function getValue($key);
    
    /**
     * An initializer that will be called directly after instantiating
     * the storage. Derived classes can override this to perform 
     * initialization of the storage.
     * 
     * Note: this method is ont abstract since not every derived class
     * will want to implement this.
     */
    public function init()
    {
        
    }

    /**
     * The constructor to construct a state storage instance. Should not be
     * called directly, use the Tiqr_StateStorage factory to construct
     * a state storage instance of a certain type.
     * @param array $options An array of options for the state storage
     */
    public function __construct($options=array())
    {
        $this->_options = $options;        
    }
        
}