2007-11-10 15:40:24 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2009-11-26 13:35:23 +00:00
< html > < head >
2010-01-25 16:38:36 +00:00
2011-04-28 17:42:47 +00:00
2011-10-16 12:11:01 +00:00
2012-01-04 19:08:19 +00:00
2012-01-04 20:51:34 +00:00
2012-01-21 21:21:46 +00:00
2012-02-08 18:51:48 +00:00
2012-02-25 18:39:52 +00:00
2012-03-25 13:49:22 +00:00
2012-04-07 16:40:34 +00:00
2010-01-25 16:38:36 +00:00
< meta http-equiv = "content-type" content = "text/html; charset=ISO-8859-15" > < title > Upgrade notes< / title >
2010-01-01 23:18:44 +00:00
2007-11-19 19:16:08 +00:00
2010-01-01 23:18:44 +00:00
< link rel = "stylesheet" type = "text/css" href = "style/layout.css" >
2007-12-09 10:48:44 +00:00
2010-01-01 23:18:44 +00:00
2010-01-25 16:38:36 +00:00
< link rel = "shortcut icon" type = "image/x-icon" href = "images/favicon.ico" > < / head > < body >
2010-01-01 23:18:44 +00:00
< h1 > Upgrade notes< / h1 >
2007-12-30 12:32:48 +00:00
2010-01-01 23:18:44 +00:00
This is a list of API changes for all LAM releases.
< br >
2008-03-23 14:33:15 +00:00
2010-01-01 23:18:44 +00:00
< br >
2008-12-09 18:29:58 +00:00
2012-04-07 16:40:34 +00:00
< h2 > 3.7 -> 3.8< br >
< / h2 > Type interface:< br >
< ul >
< li > < span style = "font-weight: bold;" > getTitleBarTitle()/getTitleBarSubtitle(): < / span > changed
parameter from attribute array to accountContainer object.
Additionally, the functions are now called on each page refresh.< br >
< / li >
< / ul >
< br >
< h2 > 3.6 -> 3.7< / h2 >
Module interface:< br >
2012-01-04 20:51:34 +00:00
< ul >
< li > < span style = "font-weight: bold;" > postModifyActions()< / span > : Must return an array containing any messages to display< / li >
2012-01-21 21:21:46 +00:00
< li > < span style = "font-weight: bold;" > preModifyActions():< / span > Changed return value from boolean to array of message arrays< / li >
< li > < span style = "font-weight: bold;" > passwordService interface:< / span >
new function supportsForcePasswordChange() and changed function
passwordChangeRequested() to support password change at next login < br >
2012-02-08 18:51:48 +00:00
< / li >
2012-02-25 18:39:52 +00:00
< li > < span style = "font-weight: bold;" > getSelfServiceOptions()/checkSelfServiceOptions():< / span > added parameter to specify if only password changes are allowed< / li >
2012-03-25 13:49:22 +00:00
< li > < span style = "font-weight: bold;" > handleAjaxRequest():< / span > This new function allows AJAX requests to be answered by modules< / li >
< li > < span style = "font-weight: bold;" > getSelfServiceSettings():< / span > New parameter $profile that contains the full self service profile object< br >
2012-01-04 20:51:34 +00:00
< / li >
2012-01-21 21:21:46 +00:00
2012-02-08 18:51:48 +00:00
2012-02-25 18:39:52 +00:00
2012-03-25 13:49:22 +00:00
2012-01-04 20:51:34 +00:00
< / ul >
2012-01-04 19:08:19 +00:00
< br >
< h2 > 3.5.0 -> 3.6< / h2 >
LAM now supports client-side validation (required + numeric fields). See htmlInputField::setValidationRule().< br >
2011-10-16 12:11:01 +00:00
< br >
< h2 > 3.4.0 -> 3.5.0< / h2 >
The old meta HTML code is no longer supported. Please use the new solution based on htmlElement (see lib/html.inc).< br >
2011-04-28 17:42:47 +00:00
< br >
2011-03-23 17:52:45 +00:00
< h2 > 3.3.0 -> 3.4.0< / h2 >
2011-04-28 17:42:47 +00:00
2011-03-23 17:52:45 +00:00
Module interface:< br >
2011-02-26 13:14:10 +00:00
< ul >
2011-03-23 17:52:45 +00:00
< li > < span style = "font-weight: bold;" > save_attributes():< / span > Can
now contain a return value 'info' => array() with values for
pre/postModify actions< / li >
< li > < span style = "font-weight: bold;" > checkSelfServiceOptions():< / span > Can now contain a return value 'info' => array() with values for
pre/postModify actions< / li >
< li > < span style = "font-weight: bold;" > getSelfServiceOptions():< / span > This function no longer supports the old meta HTML. Additionally, the module name must be specified for all help links.< br >
< / li >
2011-02-26 13:14:10 +00:00
< / ul >
2011-03-23 17:52:45 +00:00
2011-02-26 13:14:10 +00:00
< br >
2011-03-23 17:52:45 +00:00
2011-02-26 13:14:10 +00:00
< h2 > 3.2.0 -> 3.3.0< / h2 >
2011-03-23 17:52:45 +00:00
The cache class was removed. Please use local caching and the functions
searchLDAP... instead of get_cache().< br >
The return values for baseModule::pre/postDeleteActions() were changed
to an array of StatusMessage parameters.
2010-11-26 20:16:14 +00:00
< br >
2011-03-23 17:52:45 +00:00
CSS class TYPElist-sort removed without replacement.< br >
< br >
2010-11-26 20:16:14 +00:00
< h2 > 3.1.0 -> 3.2.0< / h2 >
2011-03-23 17:52:45 +00:00
< span style = "font-weight: bold;" > Account types: < / span > The CSS classes
have changed.
2010-07-07 15:22:07 +00:00
< ul >
2010-09-04 13:50:50 +00:00
2011-03-23 17:52:45 +00:00
< li > tr.TYPElist-over: removed without replacement< / li >
2010-09-04 13:50:50 +00:00
< li > tr.TYPElist-checked: removed without replacement< / li >
2011-03-23 17:52:45 +00:00
< li > tr.TYPElist: renamed to .TYPElist-bright< / li >
< li > tr.TYPElist-head: renamed to .TYPElist-dark< / li >
2010-09-04 13:50:50 +00:00
< li > th.TYPElist-sort: renamed to .TYPElist-sort< / li >
2011-03-23 17:52:45 +00:00
< li > td.TYPEnav-text: removed without replacement < / li >
2010-07-07 15:22:07 +00:00
< / ul >
2011-03-23 17:52:45 +00:00
2010-07-07 15:22:07 +00:00
< br >
2011-03-23 17:52:45 +00:00
< br >
< h2 > 3.0.0 -> 3.1.0< / h2 >
< span style = "font-weight: bold;" > Module interface:< / span > There is a
new object-oriented library to
2010-06-06 18:14:24 +00:00
generate HTML for the account modules (e.g. used for
display_html_attributes()). This will allow additional functionality
like client side validation. Please see lib/html.inc or package
metaHTML in the phpdoc documentation.< br >
2011-03-23 17:52:45 +00:00
< span style = "color: red; font-weight: bold;" > Attention: < / span > < span style = "color: red; font-weight: bold;" > The getSelfServiceOptions()
function no longer supports the old meta HTML. < / span > < span style = "color: red; font-weight: bold;" > The other functions will
support the old array-based meta HTML elements only until Q2/2011! < / span > < br >
2010-06-06 18:14:24 +00:00
< br >
2011-03-23 17:52:45 +00:00
2010-06-06 18:14:24 +00:00
The PDF editor now supports descriptive PDF
2010-04-05 10:13:37 +00:00
fields. You can use this by returning an associative array for the PDF
fields (e.g. array('macAddress' => _('MAC address'))) in < span style = "font-weight: bold;" > get_pdfFields()< / span > or the meta data.< br >
2011-03-23 17:52:45 +00:00
The old format is still supported. LAM will continue to show the field
name as label in this case.< br >
2010-04-05 10:13:37 +00:00
< br >
2011-03-23 17:52:45 +00:00
2010-04-05 10:13:37 +00:00
< br >
2009-03-03 18:36:24 +00:00
2011-03-23 17:52:45 +00:00
< h2 > 2.9.0 -> 3.0.0< / h2 >
2010-04-05 10:13:37 +00:00
2010-01-01 23:18:44 +00:00
You can now integrate JavaScript libraries by simply putting the files
into templates/lib. All files with the name *.js are automatically
included on all pages.< br >
2011-03-23 17:52:45 +00:00
2010-02-15 20:21:44 +00:00
There is a new log level LOG_DEBUG available for logNewMessage().
< br >
2011-03-23 17:52:45 +00:00
2010-02-15 20:21:44 +00:00
< h3 > Module interface:< / h3 >
2011-03-23 17:52:45 +00:00
2010-02-15 20:21:44 +00:00
The function
< span style = "font-weight: bold;" > build_uploadAccounts()< / span >
has a new parameter
2010-02-27 19:14:15 +00:00
< span style = "font-weight: bold;" > $selectedModules< / span > .< br >
2011-03-23 17:52:45 +00:00
2010-02-27 19:14:15 +00:00
< h3 > Type interface:< / h3 >
2011-03-23 17:52:45 +00:00
The new function < span style = "font-weight: bold;" > supportsFileUpload()< / span >
specifies if file uploads are supported (default true).< br >
2007-11-18 10:35:56 +00:00
2010-01-01 23:18:44 +00:00
< br >
2011-03-23 17:52:45 +00:00
2010-01-01 23:18:44 +00:00
< br >
2007-11-18 10:35:56 +00:00
2009-11-26 13:35:23 +00:00
< h2 > 2.8.0 -> 2.9.0< / h2 >
2010-01-01 23:18:44 +00:00
Several functions of the < span style = "font-weight: bold;" > cache< / span >
class were removed.< br >
2009-11-26 13:35:23 +00:00
< br >
2011-03-23 17:52:45 +00:00
2010-01-01 23:18:44 +00:00
< br >
2009-03-03 18:36:24 +00:00
< h2 > 2.5.0 -> 2.6.0< / h2 >
2010-01-01 23:18:44 +00:00
The class < span style = "font-weight: bold; font-style: italic;" > baseType< / span >
has two new member variables:< br >
2009-03-03 18:36:24 +00:00
< ul >
2010-01-01 23:18:44 +00:00
2009-03-03 18:36:24 +00:00
< li > $LABEL_CREATE_ANOTHER_ACCOUNT< / li >
< li > $LABEL_BACK_TO_ACCOUNT_LIST< / li >
< / ul >
2010-01-01 23:18:44 +00:00
2009-03-03 18:36:24 +00:00
They can be used to show a more specific text when the user is asked to
create another account or return back to the account list.< br >
2010-01-01 23:18:44 +00:00
2009-03-03 18:36:24 +00:00
< br >
2010-01-01 23:18:44 +00:00
2009-03-03 18:36:24 +00:00
The meta HTML code now supports image buttons.< br >
2010-01-01 23:18:44 +00:00
2009-03-03 18:36:24 +00:00
< br >
2010-01-01 23:18:44 +00:00
2009-03-03 18:36:24 +00:00
< br >
2010-01-01 23:18:44 +00:00
2008-12-09 18:29:58 +00:00
< h2 > 2.4.0 -> 2.5.0< / h2 >
2010-01-01 23:18:44 +00:00
2008-12-09 18:29:58 +00:00
< h3 > Self service< / h3 >
2010-01-01 23:18:44 +00:00
< span style = "font-weight: bold;" > $selfServiceSettings< / span > in class < span style = "font-style: italic;" > baseModule< / span > is now an object of the
class < span style = "font-style: italic;" > selfServiceProfile.< / span >
This way all profile settings can be read. To access the module
settings use < span style = "font-weight: bold;" > $this-> selfServiceSettings-> moduleSettings< / span > .< br >
2008-12-09 18:29:58 +00:00
< br >
2007-11-10 15:40:24 +00:00
2010-01-01 23:18:44 +00:00
< br >
2007-11-18 10:35:56 +00:00
2008-03-23 14:33:15 +00:00
< h2 > 2.2.0 -> 2.3.0< / h2 >
2010-01-01 23:18:44 +00:00
2008-03-23 14:33:15 +00:00
< h3 > Style changes< / h3 >
2010-01-01 23:18:44 +00:00
If you have defined your own account types then you need to update your
CSS files (style/type_< type> .css).< br >
2008-03-23 14:33:15 +00:00
Please change "table.< type> list input,select" to
"table.< type> list input,select,button" and
"fieldset.< type> edit input" to "fieldset.< type> edit
input,select,button". "fieldset.< type> edit select" may be deleted
afterwards.< br >
2010-01-01 23:18:44 +00:00
2008-03-23 14:33:15 +00:00
< br >
2010-01-01 23:18:44 +00:00
2008-03-23 14:33:15 +00:00
< br >
2010-01-01 23:18:44 +00:00
2007-11-10 15:40:24 +00:00
< h2 > 2.1.0 -> 2.2.0< / h2 >
2008-03-23 14:33:15 +00:00
2007-12-09 10:48:44 +00:00
< h3 > Account lists< / h3 >
2007-11-18 10:35:56 +00:00
2010-01-01 23:18:44 +00:00
Account lists now support to define tools. These are displayed as
linked images like the edit and delete links in the list.< br >
Overwrite < span style = "font-weight: bold;" > lamList::getAdditionalTools()< / span >
to use this feature.< br >
2007-11-18 10:35:56 +00:00
2007-11-10 15:40:24 +00:00
< br >
2007-11-18 10:35:56 +00:00
2010-01-01 23:18:44 +00:00
The definition of account list options changed. The function < span style = "font-weight: bold;" > lamList::getAdditionalTools()< / span > is no
longer available. Use these functions instead: < span style = "font-weight: bold;" > lamList::listGetAllConfigOptions()< / span >
and < span style = "font-weight: bold;" > lamList::listConfigurationChanged()< / span > .< br >
2007-11-18 10:35:56 +00:00
2007-11-11 14:01:16 +00:00
All options are now saved in cookies for one year.< br >
2007-11-18 10:35:56 +00:00
2007-11-10 15:40:24 +00:00
< br >
2007-12-09 10:48:44 +00:00
2010-01-01 23:18:44 +00:00
< h3 > Base module< / h3 >
2007-11-18 10:35:56 +00:00
2010-01-01 23:18:44 +00:00
The < span style = "font-weight: bold;" > baseModule< / span > class has a new
protected option: < span style = "font-weight: bold;" > $autoAddObjectClasses
< / span > You can set it to false if you do not want that your module's
object classes are added when creating or loading an account.< br >
2007-12-09 10:48:44 +00:00
2007-11-19 19:16:08 +00:00
< br >
2007-12-09 10:48:44 +00:00
2007-11-19 19:16:08 +00:00
Account modules can now have icons. See < span style = "font-weight: bold;" > baseModule-> getIcon()< / span > .< br >
2007-11-18 10:35:56 +00:00
< br >
2010-01-01 23:18:44 +00:00
2007-12-28 16:16:03 +00:00
< h3 > Constructors< / h3 >
2010-01-01 23:18:44 +00:00
2007-12-30 12:32:48 +00:00
LAM now uses the PHP5 syntax for constructors: < span style = "font-weight: bold;" > __construct()< br >
< br >
< / span >
< h3 > Extended security model< / h3 >
2010-01-01 23:18:44 +00:00
2007-12-30 12:32:48 +00:00
Each server profile now defines an access level.< br >
2010-01-01 23:18:44 +00:00
2007-12-30 12:32:48 +00:00
< br >
2010-01-01 23:18:44 +00:00
2007-12-30 12:32:48 +00:00
Currently these are:< br >
2010-01-01 23:18:44 +00:00
2007-12-30 12:32:48 +00:00
< ul >
2010-01-01 23:18:44 +00:00
2007-12-30 12:32:48 +00:00
< li > write access< / li >
< li > password changes< / li >
< li > read access< br >
< / li >
< / ul >
2010-01-01 23:18:44 +00:00
< span style = "font-weight: bold;" > < / span > Please check your code and
prohibit any actions which do not fit the current access level.< br >
There are two new functions in < span style = "font-style: italic;" > security.inc< / span > :
< span style = "font-weight: bold;" > checkIfWriteAccessIsAllowed()< / span >
and < span style = "font-weight: bold;" > checkIfPasswordChangeIsAllowed()< / span > < br >
2007-12-30 12:32:48 +00:00
Only LAM Pro allows to change the access level from < span style = "font-style: italic;" > write access< / span > to a smaller level.< br >
2010-01-01 23:18:44 +00:00
2007-12-28 16:16:03 +00:00
< br >
2010-01-01 23:18:44 +00:00
< br >
2007-11-18 10:35:56 +00:00
2007-11-10 15:40:24 +00:00
< h2 > 2.0.0 -> 2.1.0< / h2 >
2007-11-18 10:35:56 +00:00
2008-03-23 14:33:15 +00:00
< h3 > < span style = "font-weight: bold;" > Style changes< / span > < / h3 >
2007-11-10 15:40:24 +00:00
< ul >
2007-11-18 10:35:56 +00:00
2010-01-01 23:18:44 +00:00
< li > "fieldset.< type> edit fieldset" and
"fieldset.< type> edit fieldset fieldset" were removed.< / li >
< li > "table.< type> list input" changed to "table.< type> list
input,select"< / li >
2007-11-10 15:40:24 +00:00
< / ul >
2007-11-18 10:35:56 +00:00
2008-03-23 14:33:15 +00:00
< h3 > < span style = "font-weight: bold;" > baseModule< / span > < / h3 >
2010-01-01 23:18:44 +00:00
The class variable< span style = "font-style: italic;" > $base< / span >
is no longer visible in child classes. Please use < span style = "font-style: italic;" > $this-> getAccountContainer()< / span > to
access the accountContainer object.< br >
2007-11-18 10:35:56 +00:00
2007-11-10 15:40:24 +00:00
< br >
2007-11-18 10:35:56 +00:00
2010-01-01 23:18:44 +00:00
Several other class variables in accountContainer etc. are now private.
Use the new access methods.< br >
2007-11-18 10:35:56 +00:00
2007-11-10 15:40:24 +00:00
< br >
2007-11-18 10:35:56 +00:00
2007-11-10 15:40:24 +00:00
< br >
2007-11-18 10:35:56 +00:00
2007-11-10 15:40:24 +00:00
< h2 > 1.3.0 -> 2.0.0< / h2 >
2007-11-18 10:35:56 +00:00
2010-01-01 23:18:44 +00:00
LAM is now PHP5 only. Several variables are now private and need to be
accessed via functions.< br >
2007-11-18 10:35:56 +00:00
2007-11-10 15:40:24 +00:00
< br >
2007-11-18 10:35:56 +00:00
2007-11-10 15:40:24 +00:00
< br >
2007-11-18 10:35:56 +00:00
2007-11-10 15:40:24 +00:00
< h2 > 1.2.0 -> 1.3.0< / h2 >
2007-11-18 10:35:56 +00:00
2008-03-23 14:33:15 +00:00
< h3 > < span style = "font-weight: bold;" > New lamList functions< / span > < / h3 >
2007-11-10 15:40:24 +00:00
< ul >
2007-11-18 10:35:56 +00:00
2007-11-11 14:01:16 +00:00
< li > < span style = "font-weight: bold;" > listPrintTableCellContent():< / span >
This function allows you to control how the LDAP attributes are
displayed in the table. This can be used to display links or binary
data.< / li >
< li > < span style = "font-weight: bold;" > listPrintAdditionalOptions():< / span >
If you want to display additional conrols for a list please use this
function. The controls will be placed under the account table.< br >
2007-11-10 15:40:24 +00:00
< / li >
< / ul >
2007-11-18 10:35:56 +00:00
2010-01-01 23:18:44 +00:00
No more lamdaemon commands via delete_attributes() and
save_attributes() in account modules.< br >
2007-11-18 10:35:56 +00:00
2007-11-10 15:40:24 +00:00
Please use these new functions to call lamdaemon directly:< br >
2007-11-18 10:35:56 +00:00
2007-11-10 15:40:24 +00:00
< ul >
2007-11-18 10:35:56 +00:00
2007-11-10 15:40:24 +00:00
< li > preModifyActions()< / li >
< li > postModifyActions()< / li >
< li > preDeleteActions()< / li >
< li > postDeleteActions()< / li >
< / ul >
2007-11-18 10:35:56 +00:00
2007-11-10 15:40:24 +00:00
< br >
2007-11-18 10:35:56 +00:00
2007-11-10 15:40:24 +00:00
< h2 > 1.1.x -> 1.2.0< / h2 >
2007-11-18 10:35:56 +00:00
2008-03-23 14:33:15 +00:00
< h3 > < span style = "font-weight: bold;" > API changes< / span > < / h3 >
2007-11-10 15:40:24 +00:00
< ul >
2007-11-18 10:35:56 +00:00
2007-11-10 15:40:24 +00:00
< li > removed get_configDescription() from module interface< / li >
< / ul >
2007-11-18 10:35:56 +00:00
2007-11-10 15:40:24 +00:00
< br >
2007-11-18 10:35:56 +00:00
2007-11-10 15:40:24 +00:00
< h2 > 1.0.4 -> 1.1.0< / h2 >
2007-11-18 10:35:56 +00:00
2008-03-23 14:33:15 +00:00
< h3 > < span style = "font-weight: bold;" > API changes< / span > < / h3 >
2007-11-10 15:40:24 +00:00
< ul >
2007-11-18 10:35:56 +00:00
2010-01-01 23:18:44 +00:00
< li > removed $post parameters from module functions
(delete_attributes(), process_...(), display_html_...()). Use $_POST
instead.< / li >
2007-11-11 14:01:16 +00:00
< li > process_...()
functions: returned messages are no longer grouped (e.g. return:
array(array('INFO', 'headline', 'text'), array('INFO', 'headline2',
'text2')))< / li >
2007-11-10 15:40:24 +00:00
< / ul >
2007-11-18 10:35:56 +00:00
2007-11-10 15:40:24 +00:00
< br >
2007-11-18 10:35:56 +00:00
2007-11-10 15:40:24 +00:00
< h2 > 1.0.0 -> 1.0.2< / h2 >
2008-03-23 14:33:15 +00:00
< h3 > < span style = "font-weight: bold;" > New module functions< / span > < / h3 >
2007-11-10 15:40:24 +00:00
< ul >
2007-11-18 10:35:56 +00:00
2007-11-10 15:40:24 +00:00
< li > getRequiredExtensions: Allows to define required PHP extensions< / li >
2010-01-01 23:18:44 +00:00
< li > getManagedObjectClasses: Definition of managed object classes for
this module< / li >
2007-11-10 15:40:24 +00:00
< li > getLDAPAliases: list of LDAP alias names which are replaced by LAM< / li >
2010-01-01 23:18:44 +00:00
< li > getManagedAttributes: list of LDAP attributes which are managed
by this module< / li >
2007-11-10 15:40:24 +00:00
< / ul >
2007-11-18 10:35:56 +00:00
2007-11-10 15:40:24 +00:00
The LDAP attributes are no longer loaded by reading the LDAP schema. If
your module does not implement the load_attributes() function then you
have to use getManagedAttributes() or the meta data to specify them.< br >
2007-11-18 10:35:56 +00:00
2007-11-10 15:40:24 +00:00
< br >
2007-11-18 10:35:56 +00:00
2007-11-10 15:40:24 +00:00
The class variable "triggered_messages" in baseModule was removed.< br >
2007-11-18 10:35:56 +00:00
< br >
2010-01-01 23:18:44 +00:00
2007-11-10 15:40:24 +00:00
< / body > < / html >
