changes from phpgw to egw dev group

This commit is contained in:
reinerj 2004-01-27 20:49:25 +00:00
parent 6aea6258bb
commit 3f5c75878b
20 changed files with 58 additions and 58 deletions

View File

@ -1,7 +1,7 @@
<?php <?php
/**************************************************************************\ /**************************************************************************\
* phpGroupWare - Setup * * eGroupWare - Setup *
* http://www.phpgroupware.org * * http://www.egroupware.org *
* -------------------------------------------- * * -------------------------------------------- *
* This program is free software; you can redistribute it and/or modify it * * This program is free software; you can redistribute it and/or modify it *
* under the terms of the GNU General Public License as published by the * * under the terms of the GNU General Public License as published by the *

View File

@ -1,7 +1,7 @@
<?php <?php
/**************************************************************************\ /**************************************************************************\
* phpGroupWare - XML-RPC Test App * * eGroupWare - XML-RPC Test App *
* http://www.phpgroupware.org * * http://www.egroupware.org *
* -------------------------------------------- * * -------------------------------------------- *
* This program is free software; you can redistribute it and/or modify it * * This program is free software; you can redistribute it and/or modify it *
* under the terms of the GNU General Public License as published by the * * under the terms of the GNU General Public License as published by the *

View File

@ -1,6 +1,6 @@
<?php <?php
/**************************************************************************\ /**************************************************************************\
* phpGroupWare - Setup Check Installation * * eGroupWare - Setup Check Installation *
* http://www.eGroupWare.org * * http://www.eGroupWare.org *
* -------------------------------------------- * * -------------------------------------------- *
* This program is free software; you can redistribute it and/or modify it * * This program is free software; you can redistribute it and/or modify it *

View File

@ -1,7 +1,7 @@
<?php <?php
/**************************************************************************\ /**************************************************************************\
* phpGroupWare - Setup * * eGroupWare - Setup *
* http://www.phpgroupware.org * * http://www.egroupware.org *
* -------------------------------------------- * * -------------------------------------------- *
* This program is free software; you can redistribute it and/or modify it * * This program is free software; you can redistribute it and/or modify it *
* under the terms of the GNU General Public License as published by the * * under the terms of the GNU General Public License as published by the *

View File

@ -1,4 +1,4 @@
phpGroupWare setup March 2002 revised (5-2001) eGroupWare setup March 2002 revised (5-2001)
Note: All setup classes are now located in the phpgwapi module. Since setup Note: All setup classes are now located in the phpgwapi module. Since setup
cannot work without the api anyway, these classes were moved. cannot work without the api anyway, these classes were moved.

View File

@ -27,7 +27,7 @@
\layout Title \layout Title
\added_space_top vfill \added_space_bottom vfill \added_space_top vfill \added_space_bottom vfill
phpGroupWare Setup eGroupWare Setup
\layout Date \layout Date
June 18, 2001 June 18, 2001
@ -39,7 +39,7 @@ June 18, 2001
\layout Abstract \layout Abstract
A developer introduction to using the next generation setup application A developer introduction to using the next generation setup application
for phpgroupware. for egroupware.
\layout Section \layout Section
Introduction Introduction
@ -51,7 +51,7 @@ Welcome
\series medium \series medium
Thanks for taking the time to look over this document. Thanks for taking the time to look over this document.
If you are a developer who is new to phpgroupware, this document will be If you are a developer who is new to egroupware, this document will be
invaluable to your success during the life of your application. invaluable to your success during the life of your application.
This is in addition to the other fine documentation available in the phpgwapi/d This is in addition to the other fine documentation available in the phpgwapi/d
oc directory in your install. oc directory in your install.
@ -93,7 +93,7 @@ Setup3 adds multi-language support for the setup application, a long missed
\series medium \series medium
Setup3 gives each application developer control over their application install Setup3 gives each application developer control over their application install
and upgrade processes, while giving them access to work within a realm and upgrade processes, while giving them access to work within a realm
formerly owned by only the former core phpgroupware applications. formerly owned by only the former core egroupware applications.
Yes, this is extra work for the developer. Yes, this is extra work for the developer.
But it is hoped that setup3 is also viewed as a tool that can truly enhance But it is hoped that setup3 is also viewed as a tool that can truly enhance
the development process the development process
@ -155,7 +155,7 @@ $setup_info['addressbook']['enable'] = 1;
\series medium \series medium
'name' is used throughout phpgroupware, typically in $phpgw_info flags such 'name' is used throughout egroupware, typically in $phpgw_info flags such
as 'currentapp' or as the 'app_name' almost everywhere else. as 'currentapp' or as the 'app_name' almost everywhere else.
\layout Standard \layout Standard
@ -187,7 +187,7 @@ The 'version' string defines the version of the application and table code.
\series medium \series medium
The 'enable' string is used by the phpgroupware API to determine whether The 'enable' string is used by the egroupware API to determine whether
an application is disabled, enabled, or enabled but hidden from the navbar. an application is disabled, enabled, or enabled but hidden from the navbar.
Most applications will want this set to a value of 1 (enabled). Most applications will want this set to a value of 1 (enabled).
The notifywindow app sets this to 2, which keeps it off the navbar. The notifywindow app sets this to 2, which keeps it off the navbar.
@ -334,7 +334,7 @@ $setup_info['addressbook']['depends'][] = array(
\series medium \series medium
This is the standard dependency array for all phpgroupware applications. This is the standard dependency array for all egroupware applications.
It states that this application requires the phpgwapi, and lists the versions It states that this application requires the phpgwapi, and lists the versions
with which versions this app is compatible. with which versions this app is compatible.
This list would need to be appended upon each new API release, assuming This list would need to be appended upon each new API release, assuming
@ -515,7 +515,7 @@ Any application which requires an upgrade to a previous version's tables
This file will be the most complex of all setup-oriented files with which This file will be the most complex of all setup-oriented files with which
you will be working. you will be working.
It will contain all upgrade functions capable of upgrading any possible It will contain all upgrade functions capable of upgrading any possible
version of your phpgroupware app. version of your egroupware app.
These upgrade routines roughly match the old setup program's upgrade functions, These upgrade routines roughly match the old setup program's upgrade functions,
but the use of objects and the methods have changed dramatically. but the use of objects and the methods have changed dramatically.
The simplest version upgrade routine would look like: The simplest version upgrade routine would look like:

View File

@ -8,7 +8,7 @@
See http://www.lyx.org/ for more information --> See http://www.lyx.org/ for more information -->
<artheader> <artheader>
<title> <title>
phpGroupWare Setup eGroupWare Setup
</title> </title>
<date> <date>
June 18, 2001 June 18, 2001
@ -18,7 +18,7 @@
</author> </author>
<abstract> <abstract>
<para> <para>
A developer introduction to using the next generation setup application for phpgroupware. A developer introduction to using the next generation setup application for egroupware.
</para> </para>
</abstract> </abstract>
</artheader> </artheader>
@ -31,7 +31,7 @@
Welcome Welcome
</title> </title>
<para> <para>
Thanks for taking the time to look over this document. If you are a developer who is new to phpgroupware, this document will be invaluable to your success during the life of your application. This is in addition to the other fine documentation available in the phpgwapi/doc directory in your install. Even long-time phpgw developers should benefit this document. Herein, I will attempt to outline the critical steps required in order to get along with setup3, setup-TNG, or whatever we end up calling it (Hey, how about 'setup'?) Thanks for taking the time to look over this document. If you are a developer who is new to egroupware, this document will be invaluable to your success during the life of your application. This is in addition to the other fine documentation available in the phpgwapi/doc directory in your install. Even long-time phpgw developers should benefit this document. Herein, I will attempt to outline the critical steps required in order to get along with setup3, setup-TNG, or whatever we end up calling it (Hey, how about 'setup'?)
</para> </para>
</sect2> </sect2>
<sect2> <sect2>
@ -48,7 +48,7 @@
Setup3 adds multi-language support for the setup application, a long missed feature, I would imagine. Setup3 adds multi-language support for the setup application, a long missed feature, I would imagine.
</para> </para>
<para> <para>
Setup3 gives each application developer control over their application install and upgrade processes, while giving them access to work within a realm formerly owned by only the former core phpgroupware applications. Yes, this is extra work for the developer. But it is hoped that setup3 is also viewed as a tool that can truly enhance the development process. Setup3 gives each application developer control over their application install and upgrade processes, while giving them access to work within a realm formerly owned by only the former core egroupware applications. Yes, this is extra work for the developer. But it is hoped that setup3 is also viewed as a tool that can truly enhance the development process.
</para> </para>
<para> <para>
OK. Let's dive right in... OK. Let's dive right in...
@ -84,7 +84,7 @@
]]><![ CDATA [$setup_info['addressbook']['enable'] = 1; ]]><![ CDATA [$setup_info['addressbook']['enable'] = 1;
]]> </programlisting> ]]> </programlisting>
<para> <para>
'name' is used throughout phpgroupware, typically in &dollar;phpgw_info flags such as 'currentapp' or as the 'app_name' almost everywhere else. 'name' is used throughout egroupware, typically in &dollar;phpgw_info flags such as 'currentapp' or as the 'app_name' almost everywhere else.
</para> </para>
<para> <para>
'title' would be used in the navbar, admin, preferences, as well as in the application itself. 'title' would be used in the navbar, admin, preferences, as well as in the application itself.
@ -96,7 +96,7 @@
'app_order' determines the order of applications in the navbar. If the number you set here is the same as is set for another app, the app whose 'name' is first in the English alphabet would appear first. Smaller numbers show closer to the top or left end of the navbar, depending upon the layout. 'app_order' determines the order of applications in the navbar. If the number you set here is the same as is set for another app, the app whose 'name' is first in the English alphabet would appear first. Smaller numbers show closer to the top or left end of the navbar, depending upon the layout.
</para> </para>
<para> <para>
The 'enable' string is used by the phpgroupware API to determine whether an application is disabled, enabled, or enabled but hidden from the navbar. Most applications will want this set to a value of 1 (enabled). The notifywindow app sets this to 2, which keeps it off the navbar. An enable of 0 would disable the app by default. There is one other special case, 3, which is used primarily by the API itself. From the perspective of setup3, the API is an application just like any other application. By setting the 'enable' flag to 3, the API is still enabled, but will not be assignable to a user as a real application. It will thereby be hidden from the admin for application and user/group editing. The 'enable' string is used by the egroupware API to determine whether an application is disabled, enabled, or enabled but hidden from the navbar. Most applications will want this set to a value of 1 (enabled). The notifywindow app sets this to 2, which keeps it off the navbar. An enable of 0 would disable the app by default. There is one other special case, 3, which is used primarily by the API itself. From the perspective of setup3, the API is an application just like any other application. By setting the 'enable' flag to 3, the API is still enabled, but will not be assignable to a user as a real application. It will thereby be hidden from the admin for application and user/group editing.
</para> </para>
</sect3> </sect3>
<sect3> <sect3>
@ -164,7 +164,7 @@
]]><![ CDATA [); ]]><![ CDATA [);
]]> </programlisting> ]]> </programlisting>
<para> <para>
This is the standard dependency array for all phpgroupware applications. It states that this application requires the phpgwapi, and lists the versions with which versions this app is compatible. This list would need to be appended upon each new API release, assuming your application is compatible with this new API version. You may list other applications here, e.g. your app might depend upon 'email' in order to work properly. This is the standard dependency array for all egroupware applications. It states that this application requires the phpgwapi, and lists the versions with which versions this app is compatible. This list would need to be appended upon each new API release, assuming your application is compatible with this new API version. You may list other applications here, e.g. your app might depend upon 'email' in order to work properly.
</para> </para>
<para> <para>
Do NOT list applications here without considering this: If you do list an application here, and your app does not really require it, your application will not install unless that other application is already installed. This is handled normally within the install/upgrade process loops, which will install only applications whose dependencies are satisfied. Using a multipass function, the applications are installed in the correct order to ensure that dependencies are resolved. In all cases, the API would be installed first in every new install or upgrade, since all applications depend on the API. Do NOT list applications here without considering this: If you do list an application here, and your app does not really require it, your application will not install unless that other application is already installed. This is handled normally within the install/upgrade process loops, which will install only applications whose dependencies are satisfied. Using a multipass function, the applications are installed in the correct order to ensure that dependencies are resolved. In all cases, the API would be installed first in every new install or upgrade, since all applications depend on the API.
@ -231,7 +231,7 @@
Any application which requires an upgrade to a previous version's tables will need this file. Any application which requires an upgrade to a previous version's tables will need this file.
</title> </title>
<para> <para>
This file will be the most complex of all setup-oriented files with which you will be working. It will contain all upgrade functions capable of upgrading any possible version of your phpgroupware app. These upgrade routines roughly match the old setup program's upgrade functions, but the use of objects and the methods have changed dramatically. The simplest version upgrade routine would look like: This file will be the most complex of all setup-oriented files with which you will be working. It will contain all upgrade functions capable of upgrading any possible version of your egroupware app. These upgrade routines roughly match the old setup program's upgrade functions, but the use of objects and the methods have changed dramatically. The simplest version upgrade routine would look like:
</para> </para>
<programlisting> <programlisting>
<![ CDATA [$test[] = "0.9.3pre10"; <![ CDATA [$test[] = "0.9.3pre10";

View File

@ -1,6 +1,6 @@
phpGroupWare Setup eGroupWare Setup
June 18, 2001 June 18, 2001
Updated May 9, 2003 Updated May 9, 2003
@ -9,14 +9,14 @@ Updated May 9, 2003
Abstract Abstract
A developer introduction to using the next generation setup A developer introduction to using the next generation setup
application for phpgroupware. application for egroupware.
1 Introduction 1 Introduction
1.1 Welcome 1.1 Welcome
Thanks for taking the time to look over this document. If Thanks for taking the time to look over this document. If
you are a developer who is new to phpgroupware, this document you are a developer who is new to egroupware, this document
will be invaluable to your success during the life of your will be invaluable to your success during the life of your
application. This is in addition to the other fine documentation application. This is in addition to the other fine documentation
available in the phpgwapi/doc directory in your install. available in the phpgwapi/doc directory in your install.
@ -46,7 +46,7 @@ a long missed feature, I would imagine.
Setup3 gives each application developer control over their Setup3 gives each application developer control over their
application install and upgrade processes, while giving application install and upgrade processes, while giving
them access to work within a realm formerly owned by only them access to work within a realm formerly owned by only
the former core phpgroupware applications. Yes, this is the former core egroupware applications. Yes, this is
extra work for the developer. But it is hoped that setup3 extra work for the developer. But it is hoped that setup3
is also viewed as a tool that can truly enhance the development is also viewed as a tool that can truly enhance the development
process. process.
@ -79,7 +79,7 @@ $setup_info['addressbook']['app_order'] = 4;
$setup_info['addressbook']['enable'] = 1; $setup_info['addressbook']['enable'] = 1;
'name' is used throughout phpgroupware, typically in $phpgw_info 'name' is used throughout egroupware, typically in $phpgw_info
flags such as 'currentapp' or as the 'app_name' almost everywhere flags such as 'currentapp' or as the 'app_name' almost everywhere
else. else.
@ -101,7 +101,7 @@ app, the app whose 'name' is first in the English alphabet
would appear first. Smaller numbers show closer to the top would appear first. Smaller numbers show closer to the top
or left end of the navbar, depending upon the layout. or left end of the navbar, depending upon the layout.
The 'enable' string is used by the phpgroupware API to determine The 'enable' string is used by the egroupware API to determine
whether an application is disabled, enabled, or enabled whether an application is disabled, enabled, or enabled
but hidden from the navbar. Most applications will want but hidden from the navbar. Most applications will want
this set to a value of 1 (enabled). The notifywindow app this set to a value of 1 (enabled). The notifywindow app
@ -180,7 +180,7 @@ $setup_info['addressbook']['depends'][] = array(
); );
This is the standard dependency array for all phpgroupware This is the standard dependency array for all egroupware
applications. It states that this application requires the applications. It states that this application requires the
phpgwapi, and lists the versions with which versions this phpgwapi, and lists the versions with which versions this
app is compatible. This list would need to be appended upon app is compatible. This list would need to be appended upon
@ -290,7 +290,7 @@ then recreate the current file to match the new table definitions.
This file will be the most complex of all setup-oriented This file will be the most complex of all setup-oriented
files with which you will be working. It will contain all files with which you will be working. It will contain all
upgrade functions capable of upgrading any possible version upgrade functions capable of upgrading any possible version
of your phpgroupware app. These upgrade routines roughly of your egroupware app. These upgrade routines roughly
match the old setup program's upgrade functions, but the match the old setup program's upgrade functions, but the
use of objects and the methods have changed dramatically. use of objects and the methods have changed dramatically.
The simplest version upgrade routine would look like: The simplest version upgrade routine would look like:

View File

@ -1,10 +1,10 @@
<?php <?php
/**************************************************************************\ /**************************************************************************\
* phpGroupWare API - Template class * * eGroupWare API - Template class *
* (C) Copyright 1999-2000 NetUSE GmbH Kristian Koehntopp * * (C) Copyright 1999-2000 NetUSE GmbH Kristian Koehntopp *
* ------------------------------------------------------------------------ * * ------------------------------------------------------------------------ *
* This is not part of phpGroupWare, but is used by phpGroupWare. * * This is not part of phpGroupWare, but is used by eGroupWare. *
* http://www.phpgroupware.org/ * * http://www.egroupware.org/ *
* ------------------------------------------------------------------------ * * ------------------------------------------------------------------------ *
* This program is free software; you can redistribute it and/or modify it * * This program is free software; you can redistribute it and/or modify it *
* under the terms of the GNU Lesser General Public License as published * * under the terms of the GNU Lesser General Public License as published *

View File

@ -1,12 +1,12 @@
<?php <?php
/**************************************************************************\ /**************************************************************************\
* phpGroupWare - Setup * * eGroupWare - Setup *
* http://www.phpgroupware.org * * http://www.egroupware.org *
* -------------------------------------------- * * -------------------------------------------- *
* This file written by Joseph Engo<jengo@phpgroupware.org> * * This file written by Joseph Engo<jengo@phpgroupware.org> *
* and Dan Kuykendall<seek3r@phpgroupware.org> * * and Dan Kuykendall<seek3r@phpgroupware.org> *
* and Mark Peters<skeeter@phpgroupware.org> * * and Mark Peters<skeeter@phpgroupware.org> *
* and Miles Lott<milosch@phpgroupware.org> * * and Miles Lott<milosch@groupwhere.org> *
* -------------------------------------------- * * -------------------------------------------- *
* This program is free software; you can redistribute it and/or modify it * * This program is free software; you can redistribute it and/or modify it *
* under the terms of the GNU General Public License as published by the * * under the terms of the GNU General Public License as published by the *

View File

@ -1,7 +1,7 @@
<?php <?php
/**************************************************************************\ /**************************************************************************\
* phpGroupWare * * eGroupWare *
* http://www.phpgroupware.org * * http://www.egroupware.org *
* Written by Miles Lott <milos@groupwhere.org> * * Written by Miles Lott <milos@groupwhere.org> *
* ------------------------------------------------------------------------ * * ------------------------------------------------------------------------ *
* This program is free software; you can redistribute it and/or modify it * * This program is free software; you can redistribute it and/or modify it *

View File

@ -1,7 +1,7 @@
<?php <?php
/**************************************************************************\ /**************************************************************************\
* phpGroupWare * * eGroupWare *
* http://www.phpgroupware.org * * http://www.egroupware.org *
* -------------------------------------------- * * -------------------------------------------- *
* This program is free software; you can redistribute it and/or modify it * * This program is free software; you can redistribute it and/or modify it *
* under the terms of the GNU General Public License as published by the * * under the terms of the GNU General Public License as published by the *

View File

@ -1,7 +1,7 @@
<?php <?php
/**************************************************************************\ /**************************************************************************\
* phpGroupWare - Setup * * eGroupWare - Setup *
* http://www.phpgroupware.org * * http://www.egroupware.org *
* -------------------------------------------- * * -------------------------------------------- *
* This program is free software; you can redistribute it and/or modify it * * This program is free software; you can redistribute it and/or modify it *
* under the terms of the GNU General Public License as published by the * * under the terms of the GNU General Public License as published by the *

View File

@ -1,7 +1,7 @@
<?php <?php
/**************************************************************************\ /**************************************************************************\
* phpGroupWare - Setup * * eGroupWare - Setup *
* http://www.phpgroupware.org * * http://www.egroupware.org *
* -------------------------------------------- * * -------------------------------------------- *
* This program is free software; you can redistribute it and/or modify it * * This program is free software; you can redistribute it and/or modify it *
* under the terms of the GNU General Public License as published by the * * under the terms of the GNU General Public License as published by the *

View File

@ -1,7 +1,7 @@
<?php <?php
/**************************************************************************\ /**************************************************************************\
* phpGroupWare - Setup * * eGroupWare - Setup *
* http://www.phpgroupware.org * * http://www.egroupware.org *
* -------------------------------------------- * * -------------------------------------------- *
* This program is free software; you can redistribute it and/or modify it * * This program is free software; you can redistribute it and/or modify it *
* under the terms of the GNU General Public License as published by the * * under the terms of the GNU General Public License as published by the *

View File

@ -1,7 +1,7 @@
<?php <?php
/**************************************************************************\ /**************************************************************************\
* phpGroupWare - Setup * * eGroupWare - Setup *
* http://www.phpgroupware.org * * http://www.egroupware.org *
* -------------------------------------------- * * -------------------------------------------- *
* This program is free software; you can redistribute it and/or modify it * * This program is free software; you can redistribute it and/or modify it *
* under the terms of the GNU General Public License as published by the * * under the terms of the GNU General Public License as published by the *

View File

@ -1,7 +1,7 @@
<?php <?php
/**************************************************************************\ /**************************************************************************\
* phpGroupWare - Setup * * eGroupWare - Setup *
* http://www.phpgroupware.org * * http://www.egroupware.org *
* -------------------------------------------- * * -------------------------------------------- *
* This program is free software; you can redistribute it and/or modify it * * This program is free software; you can redistribute it and/or modify it *
* under the terms of the GNU General Public License as published by the * * under the terms of the GNU General Public License as published by the *

View File

@ -1,7 +1,7 @@
<?php <?php
/**************************************************************************\ /**************************************************************************\
* phpGroupWare * * eGroupWare *
* http://www.phpgroupware.org * * http://www.egroupware.org *
* -------------------------------------------- * * -------------------------------------------- *
* This program is free software; you can redistribute it and/or modify it * * This program is free software; you can redistribute it and/or modify it *
* under the terms of the GNU General Public License as published by the * * under the terms of the GNU General Public License as published by the *

View File

@ -1,7 +1,7 @@
<?php <?php
/**************************************************************************\ /**************************************************************************\
* phpGroupWare - Setup - Developer tools * * eGroupWare - Setup - Developer tools *
* http://www.phpgroupware.org * * http://www.egroupware.org *
* -------------------------------------------- * * -------------------------------------------- *
* This program is free software; you can redistribute it and/or modify it * * This program is free software; you can redistribute it and/or modify it *
* under the terms of the GNU General Public License as published by the * * under the terms of the GNU General Public License as published by the *

View File

@ -1,7 +1,7 @@
<?php <?php
/**************************************************************************\ /**************************************************************************\
* phpGroupWare * * eGroupWare *
* http://www.phpgroupware.org * * http://www.egroupware.org *
* -------------------------------------------- * * -------------------------------------------- *
* This program is free software; you can redistribute it and/or modify it * * This program is free software; you can redistribute it and/or modify it *
* under the terms of the GNU General Public License as published by the * * under the terms of the GNU General Public License as published by the *