WMDE
/
LDAPAccountManager
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

moved module specification

This commit is contained in:
Roland Gruber 2008-02-07 19:12:42 +00:00
parent af1cf37b5b
commit 5b96a6c363
5 changed files with 49 additions and 1575 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
lam/docs/devel/account_modules.htm
View File

@ -1,17 +1,14 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-15"
http-equiv="content-type">
<title>Account modules</title>
<html><head>
<meta content="text/html; charset=ISO-8859-15" http-equiv="content-type"><title>Account modules</title>
<link rel="stylesheet" type="text/css" href="style/layout.css">
<link rel="shortcut icon" type="image/x-icon" href="images/favicon.ico">
</head>
<body>
<link rel="shortcut icon" type="image/x-icon" href="images/favicon.ico"></head><body>
<h1 style="text-align: center;">Account modules<br>
</h1>
<div style="text-align: center;"><img alt="base module"
src="images/lam_baseModule.png" style="width: 531px; height: 207px;"><br>
<div style="text-align: center;"><img alt="base module" src="images/lam_baseModule.png" style="width: 531px; height: 207px;"><br>
</div>
<div style="text-align: center;"><br>
<div style="text-align: left;">The account modules control all the
@ -21,13 +18,11 @@ accounts, the profile editor sections and much more. They are the core
of LAM.<br>
<br>
All account modules are saved in <span style="font-weight: bold;">lib/modules/</span>.<br>
If your module needs any include files etc. please save it in <span
style="font-weight: bold;">lib/modules/&lt;name of your module&gt;.</span><br>
If your module needs any include files etc. please save it in <span style="font-weight: bold;">lib/modules/&lt;name of your module&gt;.</span><br>
<br>
Please take a look at the <a href="mod_index.htm">module HowTo</a> for
an example to write your own modules.<br>
The complete specification for the module interface can be found <a
href="modules-specification.htm">here</a>.<br>
The complete specification for the module interface can be found <a href="phpdoc/modules/baseModule.html">here</a>.<br>
<br>
<h2>Superclass</h2>
All <span style="font-weight: bold;">account modules</span> should be
@ -46,5 +41,4 @@ There is no extra configuration file.<br>
<br>
</div>
</div>
</body>
</html>
</body></html>

44
lam/docs/devel/base_module.htm
View File

@ -1,23 +1,19 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-15"
http-equiv="content-type">
<title>Base module</title>
<html><head>
<meta content="text/html; charset=ISO-8859-15" http-equiv="content-type"><title>Base module</title>
<link rel="stylesheet" type="text/css" href="style/layout.css">
<link rel="shortcut icon" type="image/x-icon" href="images/favicon.ico">
</head>
<body>
<link rel="shortcut icon" type="image/x-icon" href="images/favicon.ico"></head><body>
<h1 style="text-align: center;">Base module<br>
</h1>
<div style="text-align: center;"><img alt="base module"
src="images/lam_baseModule.png" style="width: 531px; height: 207px;"><br>
<div style="text-align: center;"><img alt="base module" src="images/lam_baseModule.png" style="width: 531px; height: 207px;"><br>
</div>
<div style="text-align: center;"><br>
<div style="text-align: left;">The <span style="font-weight: bold;">baseModule</span>
is the parent class of all account modules. <br>
It implements most functions of the <a
href="modules-specification.htm">module interface</a> and provides
It implements most functions of the <a href="phpdoc/modules/baseModule.html">module interface</a> and provides
the possibility to use <span style="font-style: italic;">meta data</span>
for the module functions.<br>
There are also some class variables which are useful for the child
@ -26,25 +22,20 @@ classes.<br>
<br>
<h2>Meta data</h2>
The <span style="font-weight: bold;">baseModule</span> allows you to
not implement the <a href="modules-specification.htm">module
not implement the <a href="phpdoc/modules/baseModule.html">module
interface</a> directly but to provide <span style="font-style: italic;">meta
data</span> which is interpreted by the <span
style="font-weight: bold;">baseModule</span>.<br>
If you do not use certain functions of the interface the <span
style="font-weight: bold;">baseModule</span> also provides dummy
data</span> which is interpreted by the <span style="font-weight: bold;">baseModule</span>.<br>
If you do not use certain functions of the interface the <span style="font-weight: bold;">baseModule</span> also provides dummy
functions. E.g. if your module needs no configuration option you can
just skip this function in your code and the <span
style="font-weight: bold;">baseModule</span> will tell the
just skip this function in your code and the <span style="font-weight: bold;">baseModule</span> will tell the
configuration part that there is no option.<br>
<br>
To <span style="font-style: italic;">define meta</span> data you have
to implement the function <span
style="font-weight: bold; font-style: italic;">get_metaData()</span>.
to implement the function <span style="font-weight: bold; font-style: italic;">get_metaData()</span>.
This function must return a hash array with the meta options as array
keys.<br>
Please refer to the <a href="modules-specification.htm">module
interface</a> for details about the format of <span
style="font-style: italic;">meta data</span>.<br>
Please refer to the <a href="phpdoc/modules/baseModule.html">module
interface</a> for details about the format of <span style="font-style: italic;">meta data</span>.<br>
<br>
<br>
<h2>Functions<br>
@ -53,7 +44,7 @@ interface</a> for details about the format of <span
returns the account type ("user", "group", ...) of the module.<br>
<br>
For a list of <span style="font-style: italic;">meta data</span>
functions please refer to the <a href="modules-specification.htm">module
functions please refer to the <a href="phpdoc/modules/baseModule.html">module
interface</a>.<br>
<br>
<br>
@ -71,5 +62,4 @@ parent <span style="font-style: italic;">accountContainer</span>
<br>
</div>
</div>
</body>
</html>
</body></html>

14
lam/docs/devel/index.htm
View File

@ -1,10 +1,8 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><title>LAM development documentation</title>
<link rel="stylesheet" type="text/css" href="style/layout.css"></head>
<link rel="shortcut icon" type="image/x-icon" href="images/favicon.ico">
<body>
<link rel="stylesheet" type="text/css" href="style/layout.css"><link rel="shortcut icon" type="image/x-icon" href="images/favicon.ico"></head><body>
<div style="text-align: center;">
<h1>LDAP Account Manager - Code overview</h1>
These documents are supposed to give developers who want to modify LAM
@ -95,7 +93,7 @@ browser</a><br>
<br>
<br>
<table width="100%">
<tr valign="top">
<tbody><tr valign="top">
<td width="25%">
<h2>Howtos</h2>
<ul>
@ -104,13 +102,13 @@ browser</a><br>
</li>
</ul>
</td>
<td width="25%" align="center">
<td align="center" width="25%">
<h2><a href="FAQ.htm">FAQ</a></h2>
</td>
<td width="25%">
<h2>Specifications</h2>
<ul>
<li><a href="modules-specification.htm">Module specification</a></li>
<li><a href="phpdoc/modules/baseModule.html">Module specification</a></li>
<li><a href="types-specification.htm">Type specification<br>
</a></li>
</ul>
@ -119,7 +117,7 @@ browser</a><br>
<h2><a href="upgrade.htm">Upgrade notes</a></h2>
</td>
</tr>
</table>
</tbody></table>
<br>
<br>

1495
lam/docs/devel/modules-specification.htm
View File

File diff suppressed because it is too large Load Diff

45
lam/docs/devel/profile_editor.htm
View File

@ -1,17 +1,14 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-15"
http-equiv="content-type">
<title>Profile editor</title>
<html><head>
<meta content="text/html; charset=ISO-8859-15" http-equiv="content-type"><title>Profile editor</title>
<link rel="stylesheet" type="text/css" href="style/layout.css">
<link rel="shortcut icon" type="image/x-icon" href="images/favicon.ico">
</head>
<body>
<link rel="shortcut icon" type="image/x-icon" href="images/favicon.ico"></head><body>
<h1 style="text-align: center;">Profile editor<br>
</h1>
<div style="text-align: center;"><img alt=""
src="images/lam_profedit.png" style="width: 354px; height: 236px;"><br>
<div style="text-align: center;"><img alt="" src="images/lam_profedit.png" style="width: 354px; height: 236px;"><br>
</div>
<div style="text-align: center;"><br>
<div style="text-align: left;">The <span style="font-style: italic;">profile
@ -24,9 +21,7 @@ This is the start page of the <span style="font-style: italic;">profile
editor</span>. The user can select to add/modify/remove selected
account profiles.<br>
<br>
The list of existing account profiles is returned by <span
style="font-weight: bold;">getAccountProfiles()</span> in <span
style="font-style: italic;">modules.inc</span>. It includes all
The list of existing account profiles is returned by <span style="font-weight: bold;">getAccountProfiles()</span> in <span style="font-style: italic;">modules.inc</span>. It includes all
profile names without file extensions.<br>
<br>
<h2>Profilepage.php<br>
@ -36,17 +31,15 @@ This script is used to display the account profile to the user. <br>
The profile options include the LDAP OU suffix and options provided by
the account modules.<br>
<br>
The values for the OU selection are read with <span
style="font-weight: bold;">search_units()</span>.<br>
The values for the OU selection are read with <span style="font-weight: bold;">search_units()</span>.<br>
<br>
The <span style="font-style: italic;">account modules</span> provide
all other profile options. The profile editor displays a separate
fieldset for each module containing its options.<br>
The function <span style="font-weight: bold;">print_option()</span>
manages the display of the different option types (checkbox, select,
...). The type of each option is saved in <span
style="font-weight: bold;">$_SESSION['profile_types']</span>.<br>
See the <a href="modules-specification.htm">modules specification</a>
...). The type of each option is saved in <span style="font-weight: bold;">$_SESSION['profile_types']</span>.<br>
See the <a href="phpdoc/modules/baseModule.html">modules specification</a>
for a complete list of supported types.<br>
<br>
The profiles have unique names under which they are saved. If a profile
@ -56,10 +49,8 @@ When the user selects to save the profile then
profilepage.php will check the input for correctness.<br>
First the values are converted to the correct type (checkbox -&gt;
Boolean) by checking <span style="font-weight: bold;">$_SESSION['profile_types']</span>.
Then LAM will replace all "\'" with&nbsp; "'" if <span
style="font-style: italic;">magic_quotes_gpc</span> is on. Now the
input data is checked for correctness by calling <span
style="font-weight: bold;">checkProfileOptions()</span>.<br>
Then LAM will replace all "\'" with&nbsp; "'" if <span style="font-style: italic;">magic_quotes_gpc</span> is on. Now the
input data is checked for correctness by calling <span style="font-weight: bold;">checkProfileOptions()</span>.<br>
The <span style="font-style: italic;">account modules</span> return a
list of
error messages if one or more options are incorrect. If there are
@ -67,19 +58,15 @@ errors they will be displayed, otherwise the profile is
saved by calling <span style="font-weight: bold;">saveAccountProfile()</span>.<br>
<br>
<h2>Profiledelete.php</h2>
When the user selected to delete a profile in <span
style="font-style: italic;">profilemain.php</span> he is redirected to
When the user selected to delete a profile in <span style="font-style: italic;">profilemain.php</span> he is redirected to
this page.<br>
<br>
LAM will ask once again if the user is sure to delete the profile. If
this is the case the profile will be deleted with <span
style="font-weight: bold;">delAccountProfile()</span> from <span
style="font-style: italic;">profiles.inc</span>.<br>
this is the case the profile will be deleted with <span style="font-weight: bold;">delAccountProfile()</span> from <span style="font-style: italic;">profiles.inc</span>.<br>
<br>
<br>
<br>
<br>
</div>
</div>
</body>
</html>
</body></html>