Add support for creating a Xaraya module
[phpeclipse.git] / net.sourceforge.phpeclipse / src / com / xaraya / wizard / XarayaModuleText.java
diff --git a/net.sourceforge.phpeclipse/src/com/xaraya/wizard/XarayaModuleText.java b/net.sourceforge.phpeclipse/src/com/xaraya/wizard/XarayaModuleText.java
new file mode 100644 (file)
index 0000000..8664b8d
--- /dev/null
@@ -0,0 +1,153 @@
+package com.xaraya.wizard;
+
+public  final class XarayaModuleText {
+       final static StringBuffer xarinit = new StringBuffer(
+               "<?php\n" +
+               "/**\n" +
+               " * File: $Id: XarayaModuleText.java,v 1.1 2003-02-04 22:23:09 choochter Exp $\n" +
+               " * \n" +
+               " * Initialise <modname> Module\n" +
+               " *\n" +
+               " * @package Xaraya eXtensible Management System\n" +
+               " * @copyright (C) 2002 by the Xaraya Development Team.\n" +
+               " * @license GPL <http://www.gnu.org/licenses/gpl.html>\n" +
+               " * @link http://www.xaraya.org\n" +
+               " *\n" +
+               " * @subpackage <modname> Module\n" +
+               " * @author <author name> <<author email>>\n" +
+               " */\n" +
+               "\n" +
+               "/**\n" +
+               " * initialise the <modname> module\n" +
+               " *\n" +
+               " * @access public\n" +
+               " * @param none\n" +
+               " * @returns bool\n" +
+               " * @raise DATABASE_ERROR\n" +
+               " */\n" +
+               "function <modname>_init()\n" +
+               "{\n" +
+               "       return true;\n" +
+               "}\n" +
+               "\n" +
+               "/** \n" +
+               " * upgrade the <modname> module from an old version\n" +
+               " *  \n" +
+               " * @access public\n" +
+               " * @param oldversion float \"Previous version upgrading from\"\n" +
+               " * @returns bool\n" +
+               " * @raise DATABASE_ERROR\n" +
+               " */ \n" +
+               "function <modname>_upgrade($oldversion)\n" +
+               "{\n" +
+               "       return true;\n" +
+               "}\n" +
+               "\n" +
+               "/**\n" +
+               " * remove the <modname> module\n" +
+               " *\n" +
+               " * @access public\n" +
+               " * @param none\n" +
+               " * @returns bool\n" +
+               " * @raise DATABASE_ERROR\n" +
+               " */\n" +
+               "function <modname>_delete()\n" +
+               "{\n" +
+               "       return true;\n" +
+               "}\n" +
+               "?>");
+               
+       final static StringBuffer xaradmin = new StringBuffer(
+               "<?php\n" +
+               "/**\n" +
+               " * File: $Id: XarayaModuleText.java,v 1.1 2003-02-04 22:23:09 choochter Exp $\n" +
+               " * \n" +
+               " * <modname> Admin Interface\n" +
+               " *\n" +
+               " * @package Xaraya eXtensible Management System\n" +
+               " * @copyright (C) 2002 by the Xaraya Development Team.\n" +
+               " * @license GPL <http://www.gnu.org/licenses/gpl.html>\n" +
+               " * @link http://www.xaraya.org\n" +
+               " *\n" +
+               " * @subpackage <modname> Module\n" +
+               " * @author <author name> <<author email>>\n" +
+               " */\n" +
+               "\n" +
+               "?>\n" 
+       );
+
+       final static StringBuffer xaradminapi = new StringBuffer(
+               "<?php\n" +
+               "/**\n" +
+               " * File: $Id: XarayaModuleText.java,v 1.1 2003-02-04 22:23:09 choochter Exp $\n" +
+               " * \n" +
+               " * <modname> Admin API\n" +
+               " *\n" +
+               " * @package Xaraya eXtensible Management System\n" +
+               " * @copyright (C) 2002 by the Xaraya Development Team.\n" +
+               " * @license GPL <http://www.gnu.org/licenses/gpl.html>\n" +
+               " * @link http://www.xaraya.org\n" +
+               " *\n" +
+               " * @subpackage <modname> Module\n" +
+               " * @author <author name> <<author email>>\n" +
+               " */\n" +
+               "\n" +
+               "?>\n"
+       );
+
+
+       final static StringBuffer xaruser = new StringBuffer(
+               "<?php\n" +
+               "/**\n" +
+               " * File: $Id: XarayaModuleText.java,v 1.1 2003-02-04 22:23:09 choochter Exp $\n" +
+               " * \n" +
+               " * <modname> User Interface\n" +
+               " *\n" +
+               " * @package Xaraya eXtensible Management System\n" +
+               " * @copyright (C) 2002 by the Xaraya Development Team.\n" +
+               " * @license GPL <http://www.gnu.org/licenses/gpl.html>\n" +
+               " * @link http://www.xaraya.org\n" +
+               " *\n" +
+               " * @subpackage <modname> Module\n" +
+               " * @author <author name> <<author email>>\n" +
+               " */\n" +
+               "\n" +
+               "?>\n"
+       );
+
+       final static StringBuffer xaruserapi = new StringBuffer(
+               "<?php\n" +
+               "/**\n" +
+               " * File: $Id: XarayaModuleText.java,v 1.1 2003-02-04 22:23:09 choochter Exp $\n" +
+               " * \n" +
+               " * <modname> User API\n" +
+               " *\n" +
+               " * @package Xaraya eXtensible Management System\n" +
+               " * @copyright (C) 2002 by the Xaraya Development Team.\n" +
+               " * @license GPL <http://www.gnu.org/licenses/gpl.html>\n" +
+               " * @link http://www.xaraya.org\n" +
+               " *\n" +
+               " * @subpackage <modname> Module\n" +
+               " * @author <author name> <<author email>>\n" +
+               " */\n" +
+               "\n" +
+               "?>\n"
+       );
+
+       final static StringBuffer xarversion = new StringBuffer(
+               "<?php\n" +
+               "$modversion['name'] = '<modname>';\n" +
+               "$modversion['id'] = '<id number>';\n" +
+               "$modversion['version'] = '<version>';\n" +
+               "$modversion['description'] = '<description>';\n" +
+               "$modversion['official'] = <official>;\n" +
+               "$modversion['author'] = '<author name>';\n" +
+               "$modversion['contact'] = '<author email>';\n" +
+               "$modversion['admin'] = <admin>;\n" +
+               "$modversion['user'] = <user>;\n" +
+               "$modversion['securityschema'] = array('<modname>::' => '::');\n" +
+               "$modversion['class'] = '<classification>';\n" +
+               "$modversion['category'] = '<category>';\n" +
+               "?>\n"
+       );
+}