webgui/docs/migration.txt
2003-12-20 08:02:24 +00:00

86 lines
2.1 KiB
Text

WebGUI 6.x Plugin Migration Guide
---------------------------------
This document is provided by the WebGUI 6.x development team in order to help
you migrate your WebGUI 5.x plugins to the new API's.
CONTENTS
1. Wobject Migration
2. Macro Migration
3. Authentication Migration
4. Scheduler Migration
5. System Changes Affecting Migration
1. Wobject Migration
--------------------
1.1 Nothing Yet
There have currently been no changes to the Wobject API.
2. Macro Migration
-------------------
2.1 Nothing Yet
There have currently been no changes to the macro API.
3. Authentication Migration
-----------------------------
3.1 Nothing Yet
There have currently been no changes to the authentication API.
In 6.0 all Authentication modules will need to be rewritten as Auth modules according to the new
Auth API in WebGUI::Auth.
The following modules will no longer be needed:
WebGUI::Authentication::WebGUI
WebGUI::Authentication::LDAP
WebGUI::Authentication::SMB
WebGUI::Authentication
WebGUI::Operation::Account
Details to follow.
4. Scheduler Migration
-----------------------
4.1 Nothing Yet
There have currently been no changes to the scheduler API.
5. System Changes Affecting Migration
-------------------------------------
5.1 Set Date Format Changes
In 6.0 the "set date" format used by WebGUI::Form::date() and other methods
was changed from "MM/DD/YYYY" to "YYYY-MM-DD" and optionally "YYYY-MM-DD
HH:MM:SS". If you are using WebGUI::FormProcessor to handle processing of your
dates then you will notice no side effects from the format change. If you are
not, then you should convert your plugin to use WebGUI::FormProcessor.
In addition to the format change above, we also made one related API change.
WebGUI::Form::dateTime() and WebGUI::HTMLForm->dateTime() no longer have
"dateExtras" and "timeExtras", but rather just "extras" properties. This is
because there is only one field to represent both the date and the time,
unlike before.
5.2 Database Links
The database links API was changed in 6.0. The getHash function was removed and
replaced with a getList function that returns a hash reference.