misc changes
[phpeclipse.git] / net.sourceforge.phpeclipse / src / com / xaraya / wizard / XarayaModuleText.java
1 package com.xaraya.wizard;
2
3 public  final class XarayaModuleText {
4         final static StringBuffer xarinit = new StringBuffer(
5                 "<?php\n" +
6                 "/**\n" +
7                 " * File: $Id: XarayaModuleText.java,v 1.1 2003-02-04 22:23:09 choochter Exp $\n" +
8                 " * \n" +
9                 " * Initialise <modname> Module\n" +
10                 " *\n" +
11                 " * @package Xaraya eXtensible Management System\n" +
12                 " * @copyright (C) 2002 by the Xaraya Development Team.\n" +
13                 " * @license GPL <http://www.gnu.org/licenses/gpl.html>\n" +
14                 " * @link http://www.xaraya.org\n" +
15                 " *\n" +
16                 " * @subpackage <modname> Module\n" +
17                 " * @author <author name> <<author email>>\n" +
18                 " */\n" +
19                 "\n" +
20                 "/**\n" +
21                 " * initialise the <modname> module\n" +
22                 " *\n" +
23                 " * @access public\n" +
24                 " * @param none\n" +
25                 " * @returns bool\n" +
26                 " * @raise DATABASE_ERROR\n" +
27                 " */\n" +
28                 "function <modname>_init()\n" +
29                 "{\n" +
30                 "       return true;\n" +
31                 "}\n" +
32                 "\n" +
33                 "/** \n" +
34                 " * upgrade the <modname> module from an old version\n" +
35                 " *  \n" +
36                 " * @access public\n" +
37                 " * @param oldversion float \"Previous version upgrading from\"\n" +
38                 " * @returns bool\n" +
39                 " * @raise DATABASE_ERROR\n" +
40                 " */ \n" +
41                 "function <modname>_upgrade($oldversion)\n" +
42                 "{\n" +
43                 "       return true;\n" +
44                 "}\n" +
45                 "\n" +
46                 "/**\n" +
47                 " * remove the <modname> module\n" +
48                 " *\n" +
49                 " * @access public\n" +
50                 " * @param none\n" +
51                 " * @returns bool\n" +
52                 " * @raise DATABASE_ERROR\n" +
53                 " */\n" +
54                 "function <modname>_delete()\n" +
55                 "{\n" +
56                 "       return true;\n" +
57                 "}\n" +
58                 "?>");
59                 
60         final static StringBuffer xaradmin = new StringBuffer(
61                 "<?php\n" +
62                 "/**\n" +
63                 " * File: $Id: XarayaModuleText.java,v 1.1 2003-02-04 22:23:09 choochter Exp $\n" +
64                 " * \n" +
65                 " * <modname> Admin Interface\n" +
66                 " *\n" +
67                 " * @package Xaraya eXtensible Management System\n" +
68                 " * @copyright (C) 2002 by the Xaraya Development Team.\n" +
69                 " * @license GPL <http://www.gnu.org/licenses/gpl.html>\n" +
70                 " * @link http://www.xaraya.org\n" +
71                 " *\n" +
72                 " * @subpackage <modname> Module\n" +
73                 " * @author <author name> <<author email>>\n" +
74                 " */\n" +
75                 "\n" +
76                 "?>\n" 
77         );
78
79         final static StringBuffer xaradminapi = new StringBuffer(
80                 "<?php\n" +
81                 "/**\n" +
82                 " * File: $Id: XarayaModuleText.java,v 1.1 2003-02-04 22:23:09 choochter Exp $\n" +
83                 " * \n" +
84                 " * <modname> Admin API\n" +
85                 " *\n" +
86                 " * @package Xaraya eXtensible Management System\n" +
87                 " * @copyright (C) 2002 by the Xaraya Development Team.\n" +
88                 " * @license GPL <http://www.gnu.org/licenses/gpl.html>\n" +
89                 " * @link http://www.xaraya.org\n" +
90                 " *\n" +
91                 " * @subpackage <modname> Module\n" +
92                 " * @author <author name> <<author email>>\n" +
93                 " */\n" +
94                 "\n" +
95                 "?>\n"
96         );
97
98
99         final static StringBuffer xaruser = new StringBuffer(
100                 "<?php\n" +
101                 "/**\n" +
102                 " * File: $Id: XarayaModuleText.java,v 1.1 2003-02-04 22:23:09 choochter Exp $\n" +
103                 " * \n" +
104                 " * <modname> User Interface\n" +
105                 " *\n" +
106                 " * @package Xaraya eXtensible Management System\n" +
107                 " * @copyright (C) 2002 by the Xaraya Development Team.\n" +
108                 " * @license GPL <http://www.gnu.org/licenses/gpl.html>\n" +
109                 " * @link http://www.xaraya.org\n" +
110                 " *\n" +
111                 " * @subpackage <modname> Module\n" +
112                 " * @author <author name> <<author email>>\n" +
113                 " */\n" +
114                 "\n" +
115                 "?>\n"
116         );
117
118         final static StringBuffer xaruserapi = new StringBuffer(
119                 "<?php\n" +
120                 "/**\n" +
121                 " * File: $Id: XarayaModuleText.java,v 1.1 2003-02-04 22:23:09 choochter Exp $\n" +
122                 " * \n" +
123                 " * <modname> User API\n" +
124                 " *\n" +
125                 " * @package Xaraya eXtensible Management System\n" +
126                 " * @copyright (C) 2002 by the Xaraya Development Team.\n" +
127                 " * @license GPL <http://www.gnu.org/licenses/gpl.html>\n" +
128                 " * @link http://www.xaraya.org\n" +
129                 " *\n" +
130                 " * @subpackage <modname> Module\n" +
131                 " * @author <author name> <<author email>>\n" +
132                 " */\n" +
133                 "\n" +
134                 "?>\n"
135         );
136
137         final static StringBuffer xarversion = new StringBuffer(
138                 "<?php\n" +
139                 "$modversion['name'] = '<modname>';\n" +
140                 "$modversion['id'] = '<id number>';\n" +
141                 "$modversion['version'] = '<version>';\n" +
142                 "$modversion['description'] = '<description>';\n" +
143                 "$modversion['official'] = <official>;\n" +
144                 "$modversion['author'] = '<author name>';\n" +
145                 "$modversion['contact'] = '<author email>';\n" +
146                 "$modversion['admin'] = <admin>;\n" +
147                 "$modversion['user'] = <user>;\n" +
148                 "$modversion['securityschema'] = array('<modname>::' => '::');\n" +
149                 "$modversion['class'] = '<classification>';\n" +
150                 "$modversion['category'] = '<category>';\n" +
151                 "?>\n"
152         );
153 }