<?php
/**
 * Project:     web.framework: the PHP5 MVC framework
 * File:		ConfigurationParser.interface.php
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * You may contact the authors of web.framework by e-mail at:
 * hide@address.com
 *
 * The latest version of web.framework can be obtained from:
 * http://sourceforge.net/projects/webframework
 *
 * @link http://sourceforge.net/projects/webframework
 * @copyright 2005 Marcin Staniszczak
 * @author Marcin Staniszczak <hide@address.com>
 * @version 1.0.0
 */


/**
 * This interface must be implemented by any configuration's parser classes
 *
 * @name IConfigurationParser
 * @version 1.0.0
 * @package web.framework
 * @subpackage Configuration
 *
 * @author Marcin Staniszczak
 * @copyright 2005 Marcin Staniszczak
 */
interface IConfigurationParser {
	/**
	 * The class constructor
	 *
	 * @access public
	 * @param string patch to configuration file (with file name, but without file extension)
	 * @param string configuration file extension (with begin dot)
	 */
	public function __construct($strConfigFileName, $strConfigExtension='.xml');

	/**
	 * Parse configuration into PHP's array class
	 *
	 * @access public
	 * @param string patch to configuration file (with file name, but without file extension)
	 * @param string configuration file extension (with begin dot)
	 * @return array array with configuration
	 * @throws WF_ParseConfig_Exception
	 */
	public function &parse();

    /**
	 * Write new configuration array to XML-file
	 *
	 * @access public
	 * @param array with a new configuration
	 * @throws WF_Configuration_Exception
	 */
	public function update($arrNewConfiguration);
}

/**
 * Configuration file parse exception
 * @package web.framework
 * @subpackage exceptions
 */
class WF_ConfigurationParser_Exception extends Exception {}

?>