<?php
/* $Id$ */
namespace MCMS\Interfaces;

(defined('MCMS') && (basename(__FILE__) != basename($_SERVER['PHP_SELF']))) or die('ACCESS DENIED');

/**
 * This interface has do be implemented by request processing classes.
 * It defines methods which are called one after one, while developers
 * can hook into the proccessing by extending a baseclass and
 * reimplement/extend the methods.
 *
 * the methods are called in the folloing order:
 * doLoadConfig		- load configuration files
 * doInit			- initalize all resources (eg database connetions)
 * doRoute			- analyze which content should be displayed
 * doBeforeRun		- general pre-content tasks
 * doRun			- generate the output
 * doAfterRun
 * doOutput
 * doCleanup
 *
 * In CLI mode, doRoute, doBeforeRun, doRun, doAfterRun and doOutput are ignored.
 * The method doRunCLI will be called instead.
 * 
 * @author Stefan Daurer <s.daurer@q-spot.org>
 * @package MCMS\System
 */
interface iRunner {
	
	/**
	 * Execute the request processing
	 * @param array $callorder
	 */
	public function run($callorder = false);

	public function doLoadConfig();

	public function doInit();

	public function doRoute();

	public function doBeforeRun();

	/**
	 * Executed on frontend web calles
	 */
	public function doRun();
	
	/**
	 * Executed on backend web calles
	 */
	public function doRunAdmin();

	public function doAfterRun();

	/**
	 * Send generated content to client (if not send already)
	 */
	public function doOutput();

	public function doCleanup();

	/**
	 * Executed on CLI calles
	 */
	public function doRunCLI();

	/**
	 * Called on unhandled exceptions
	 * @param \Exception $e
	 */
	public function onException(\Exception $e);
}