* @copyright Copyright (c) 2008, Net Perspective, LLC
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*
* @package VanishingPoint
*/
interface VP_Module
{
/**
* render() should return a string, modified as desired, exactly as it is to be displayed in the HTML as
* well as doing any nessesary operations on the file(s).
*/
public function render();
/**
* getFileName() should return the original, unaltered filename to be used by Vanishing Point, as a string.
*/
public function getFileName();
/**
* combine() should return a string to be echod on the page. This string should be the location of the combination file
* in whatever context is needed. (e.g. Javascript needs tags, an image would use an ![]()
tag.) Also
* combine() should created the combination file.
*
* @param Array $files is an array of the files in the current group to be combined.
* @param Array &$rendered is the array of "already rendered" files. The unaltered file name should be added to
* this array ($rendered[] = $unaltered) so as to not be repeated
*/
public static function combine(Array $files, Array &$rendered );
/**
* debug() should return as a string, the unaltered filename in whatever wrapper is needed for displaying.
*
* The {@link http://www.net-perspective.com/downloads/VP_JS VP_JS Javascript Plugin } returns:
*