Source for file RequestHandler.interface.php

<?php
 
/**
 * @package harmoni.architecture.request
 * 
 * @copyright Copyright &copy; 2005, Middlebury College
 * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
 *
 * @version $Id: RequestHandler.interface.php,v 1.3 2007/09/04 20:25:31 adamfranco Exp $
 */ 
 
/**
 * The job of a RequestHandler is twofold:
 * 
 * 1) handle incoming request data -- could be from $_REQUEST-type arrays,
 * could be from session variables, etc.
 * 2) handle the production of URLs with given contextual data/query using an
 * associated URLWriter class.
 *
 * @package harmoni.architecture.request
 * 
 * @copyright Copyright &copy; 2005, Middlebury College
 * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
 *
 * @version $Id: RequestHandler.interface.php,v 1.3 2007/09/04 20:25:31 adamfranco Exp $
 */
 
class RequestHandler {
    
    /**
     * Returns an associative array of key=value pairs corresponding to the request
     * data from the browser. This could just be the data from $_REQUEST, in the
     * simplest case.
     *
     * @return array 
     * @access public
     */
    function getRequestVariables() {
        throwError(new Error("Method <b>".__FUNCTION__."()</b> declared in abstract class <b> ".__CLASS__."</b> has not been overloaded in a child class.","OutputHandler",true));
    }
    
    /**
     * Returns an associative array of file upload data. This will usually come from
     * the $_FILES superglobal.
     * 
     * @return array 
     * @access public
     */
    function getFileVariables() {
        throwError(new Error("Method <b>".__FUNCTION__."()</b> declared in abstract class <b> ".__CLASS__."</b> has not been overloaded in a child class.","OutputHandler",true));
    }
    
    /**
     * Returns a new {@link URLWriter} object corresponding to this RequestHandler.
     *
     * @return ref object URLWriter
     * @access public
     */
    function createURLWriter() {
        throwError(new Error("Method <b>".__FUNCTION__."()</b> declared in abstract class <b> ".__CLASS__."</b> has not been overloaded in a child class.","OutputHandler",true));
    }
    
    /**
     * Returns a dotted-pair string representing the module and action requested
     * by the end user ("module.action" format).
     * 
     * @return string 
     * @access public
     */
    function getRequestedModuleAction() {
        throwError(new Error("Method <b>".__FUNCTION__."()</b> declared in abstract class <b> ".__CLASS__."</b> has not been overloaded in a child class.","OutputHandler",true));
    }
    
}
 
?>