[github/shaarli/Shaarli.git] / application / config / ConfigIO.php

<?php

/**
 * Interface ConfigIO
 *
 * This describes how Config types should store their configuration.
 */
interface ConfigIO
{
    /**
     * Read configuration.
     *
     * @param string $filepath Config file absolute path.
     *
     * @return array All configuration in an array.
     */
    function read($filepath);

    /**
     * Write configuration.
     *
     * @param string $filepath Config file absolute path.
     * @param array  $conf   All configuration in an array.
     */
    function write($filepath, $conf);

    /**
     * Get config file extension according to config type.
     *
     * @return string Config file extension.
     */
    function getExtension();
}
Commit	Line	Data
	1	<?php
	2
	3	/**
	4	* Interface ConfigIO
	5	*
	6	* This describes how Config types should store their configuration.
	7	*/
	8	interface ConfigIO
	9	{
	10	/**
	11	* Read configuration.
	12	*
	13	* @param string $filepath Config file absolute path.
	14	*
	15	* @return array All configuration in an array.
	16	*/
	17	function read($filepath);
	18
	19	/**
	20	* Write configuration.
	21	*
	22	* @param string $filepath Config file absolute path.
	23	* @param array $conf All configuration in an array.
	24	*/
	25	function write($filepath, $conf);
	26
	27	/**
	28	* Get config file extension according to config type.
	29	*
	30	* @return string Config file extension.
	31	*/
	32	function getExtension();
	33	}