File Source for Interface.php

<?php
/**
* MediaSearch
*
* LICENSE
*
* "THE BEER-WARE LICENSE" (Revision 42):
* "Sven Strittmatter" <ausserirdisch@sven-space.de> wrote this file.
* As long as you retain this notice you can do whatever you want with
* this stuff. If we meet some day, and you think this stuff is worth it,
* you can buy me a beer in return.
*
* $Author$
* $Revision$
*
* @category MediaSearch
* @package MediaSearch_Config
* @copyright Copyright (c) 2009 Sven Strittmatter
*/
/**
* @todo Write apidoc.
*
* @category MediaSearch
* @package MediaSearch_Config
* @copyright Copyright (c) 2009 Sven Strittmatter
*/
interface MediaSearch_Config_Interface {
/**
* Specifies the file extions for text configurations.
*/
const TYPE_TEXT = 'txt';
/**
* Specifies the file extions for php configurations.
*/
const TYPE_PHP = 'php';
/**
* Specifies the file extions for json configurations.
*/
const TYPE_JSON = 'json';
/**
* Specifies the file extions for sql configurations.
*/
const TYPE_SQL = 'sql';
/**
* Returns the string from the loaded config file.
*
* @access public
*/
public function getRawData();
/**
* Parses the config string. Depending on the config type.
*
* @access public
*/
public function parseData();
/**
* Expects the full filepath to the config file you want to load.
*
* @access public
* @param string $fileName
*/
public function setFileName($fileName);
/**
* Returns the file name of the config file.
*
* @access public
*/
public function getFileName();
/**
* With this method you can add some parse options. These are objects
* which impplements MediaSearch_Config_ParseOptions_Interface. With
* this oarse options you can implement things like: You have a text file
* config and you want to load each line of the file as config value. To
* achieve this you can implement a parse option which explodes the given
* string by line break character.
*
* Parse options are called in the order you addded them. The first parse
* object receives the origin config string as input to process. The following
* parse options get the return value of the previous parse option.
*
* @access public
* @param MediaSearch_Config_ParseOptions_Interface $option
*/
public function addParseOption(MediaSearch_Config_ParseOptions_Interface $option);
/**
* Removes all parse options.
*
* @access public
*/
public function removeParseOptions();
/**
* Returns if the config file has parse options added.
*
* @access public
* @return bool
*/
public function hasParseOptions();
/**
* Returns a config value from the loaded and parsed configuration by its
* index. The index could be a string or integer. Thats depending on the
* implemention of the config file types and your parse options.
*
* @access public
* @param string $name Default is null.
* @return mixed
*/
public function get($name = null);
}

Source for file Interface.php