Source for file RSDEngineControllerFileHeader.php

Documentation is available at RSDEngineControllerFileHeader.php


1 <?php
2 // RSDEngine: The Rapid and Secure Development Engine
3 // Copyright (C) 2003 Lukas Feiler
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
19 /**Contains just the class RSDEngineControllerFileHeader.
20 *
21 * @package RSDEngine
22 * @author Lukas Feiler <lukas.feiler@chello.at>
23 * @copyright Lukas Feiler 2003
24 * @filesource
25 */
26
27 /**RSDEngineControllerFileHeader extends RSDEngineFile.
28 */
29 require_once('RSDEngine/RSDEngineFile.php');
30
31 /**The generated file is included by the template file header.tpl (created by RSDEngineTemplateFileHeader).
32 *
33 * @author Lukas Feiler <lukas.feiler@chello.at>
34 * @version 0.1.9
35 * @copyright Lukas Feiler 2003
36 * @package RSDEngine
37 */
38 class RSDEngineControllerFileHeader extends RSDEngineControllerFile {
39
40 /**Whether to overwrite an existing file.
41 * @var boolean
42 */
43 var $overwriteExisting = false;
44
45 function getFilename()
46 {
47 return "header.php";
48 }
49
50 /**Returns the code for the file that is included by the template file header.tpl (created by RSDEngineTemplateFileHeader).
51 *
52 * @access private
53 * @return String The code for the file.
54 */
55 function getCode()
56 {
57 extract($this->config);
58 $authors = RSArrayUtil::toString(split("\n",$authors),"\n",'* @author %val');
59 $OPEN = $smartyLeftDelimiter;
60 $CLOSE = $smartyRightDelimiter;
61 $write = $this->config['writeHeaderFiles'];
62 $this->setWrite($write);
63
64 $data = <<<END
65 <?php
66 /**This file is included by the template file header.tpl.
67 *
68 * It should set all variables needed in header.tpl.
69 *
70 $authors
71 * @copyright $copyright
72 * @package $projectName
73 * @filesource
74 */
75
76 ?>
77 END;;; return $data;
78 }
79 }
80 ?>

Documentation generated on Mon, 8 Dec 2003 13:10:46 +0100 by phpDocumentor 1.2.3