wibble : modify code comment
[diogenes.git] / include / Plugin / Render.php
1 <?php
2 /*
3 * Copyright (C) 2003-2004 Polytechnique.org
4 * http://opensource.polytechnique.org/
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 */
20
21 // dependency on PEAR
22 require_once 'Plugin/Skel.php';
23
24 /** This class describes a Diogenes rendering plugin.
25 */
26 class Diogenes_Plugin_Render extends Diogenes_Plugin_Skel
27 {
28 var $name = "Plugin_Render";
29 var $description = "Rendering plugin skeleton";
30 var $version = "0.1";
31
32 /* types : render, filter */
33 var $type = "render";
34
35
36 /** Render a given file and return the output.
37 *
38 * The default implementation simply dumps the contents of the file.
39 */
40 function render($file)
41 {
42 if (file_exists($file)) {
43 return file_get_contents($file);
44 }
45 }
46
47 }
48
49 ?>