diff --git a/lam-web/developers/phpdoc/Help/_help_help_inc.html b/lam-web/developers/phpdoc/Help/_help_help_inc.html new file mode 100644 index 00000000..4ecd5016 --- /dev/null +++ b/lam-web/developers/phpdoc/Help/_help_help_inc.html @@ -0,0 +1,90 @@ + + +Docs for page help.inc + + + + + + + + + + + + + +
Help
+ [ class tree: Help ] + [ index: Help ] + [ all elements ] +
+ + + + + + +
+
+

README

+

INSTALL

+
+ Packages:
+ configuration
+ Help
+ LDAP
+ lib
+ lists
+ main
+ modules
+ PDF
+ profiles
+ selfService
+ tests
+ tools
+ types
+

+ Files:
+
+ help.inc +
+ help.php +
+

+ + + 		+
+ +

Procedural File: help.inc

+Source Location: /help/help.inc

+ +
+
+ + +

Page Details:

+LDAP Account Manager help entries.



+

Tags:

+
+ + + + +
author:  Michael Duergner
+
+

+

+

+
+ +
+
+ Documentation generated on Wed, 15 Nov 2006 18:00:46 +0100 by phpDocumentor 1.2.3 +
+
+
+ + + \ No newline at end of file diff --git a/lam-web/developers/phpdoc/Help/_templates_help_php.html b/lam-web/developers/phpdoc/Help/_templates_help_php.html new file mode 100644 index 00000000..67bfe8d3 --- /dev/null +++ b/lam-web/developers/phpdoc/Help/_templates_help_php.html @@ -0,0 +1,159 @@ + + +Docs for page help.php + + + + + + + + + + + + + +
Help
+ [ class tree: Help ] + [ index: Help ] + [ all elements ] +
+ + + + + + +
+
+

README

+

INSTALL

+
+ Packages:
+ configuration
+ Help
+ LDAP
+ lib
+ lists
+ main
+ modules
+ PDF
+ profiles
+ selfService
+ tests
+ tools
+ types
+

+ Files:
+
+ help.inc +
+ help.php +
+

+ + + 		+
+ +

Procedural File: help.php

+Source Location: /templates/help.php

+ +
+
+ + +

Page Details:

+LDAP Account Manager help page.



+

Tags:

+
+ + + + +
author:  Michael Duergner
+
+

+

Includes:

+
+include_once("../lib/ldap.inc") [line 36]
+include_once("../lib/status.inc") [line 49]
+include_once("../lib/modules.inc") [line 131]
+include_once("../help/help.inc") [line 54]
+include_once("../lib/config.inc") [line 41]
+
+

+

+
+
+ +

displayHelp [line 90]

+
+
+
+ void displayHelp( +array $helpEntry, array $helpVariables) +
+

+ + Print help site for a specific help number.



+ + +

Parameters

+ + + + + + + + + + + +
array  $helpEntry  The help entry that is to be displayed.
array  $helpVariables  The help variables that are used to replace the spacer in the help text.
+
[ Top ]


+
+
+ +

echoHTMLFoot [line 76]

+
+
+
+ void echoHTMLFoot( +) +
+

+ + Print HTML footer of the help page.



+ + +
[ Top ]


+
+
+ +

echoHTMLHead [line 62]

+
+
+
+ void echoHTMLHead( +) +
+

+ + Print HTML header of the help page.



+ + +
[ Top ]


+
+ +
+
+ Documentation generated on Wed, 15 Nov 2006 18:00:46 +0100 by phpDocumentor 1.2.3 +
+
+
+ + + \ No newline at end of file diff --git a/lam-web/developers/phpdoc/LDAP/Ldap.html b/lam-web/developers/phpdoc/LDAP/Ldap.html new file mode 100644 index 00000000..1257fc89 --- /dev/null +++ b/lam-web/developers/phpdoc/LDAP/Ldap.html @@ -0,0 +1,737 @@ + + +Docs For Class Ldap + + + + + + + + + + + + + +
LDAP
+ [ class tree: LDAP ] + [ index: LDAP ] + [ all elements ] +
+ + + + + + +
+
+

README

+

INSTALL

+
+ Packages:
+ configuration
+ Help
+ LDAP
+ lib
+ lists
+ main
+ modules
+ PDF
+ profiles
+ selfService
+ tests
+ tools
+ types
+

+ Files:
+
+ ldap.inc +
+

+ + + Classes:
+
+ Ldap
+
+ 		+
+ +

Class: Ldap

+Source Location: /lib/ldap.inc

+ + + + + + + + + + + +
+ +

Class Overview

+


+
Ldap manages connection to LDAP and includes several helper functions.



+
+
+
+
+
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+

+

+
+
+
Class Details

+

+[line 52]

+Ldap manages connection to LDAP and includes several helper functions.




+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$attributes = 

+	
[line 68]

+  Array with all attribute strings from the LDAP server


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$conf = 

+	
[line 55]

+  Object of Config to access preferences


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$objectClasses = 

+	
[line 66]

+  Array with all objectClass strings from the LDAP server


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$password = 

+	
[line 63]

+  LDAP password used for bind


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$rand = 

+	
[line 75]

+  Random number (changes on every page request)


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$server = 

+	
[line 58]

+  Server handle


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$supports_unix_hosts =  false

+	
[line 72]

+  Host attribute in inetOrgPerson


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$username = 

+	
[line 61]

+  LDAP username used for bind


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor Ldap [line 80]

+	

+    

+    

+		Ldap Ldap(
+object
+$config)
+    

+    


+	
+		


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
object  $config  an object of class Config

+    


+        
[ Top ]

+  

+  

+	
+	
method close [line 142]

+	

+    

+    

+		void close(
+)
+    

+    


+	
+		Closes connection to server




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method cmp_array [line 428]

+	

+    

+    

+		integer cmp_array(
+string
+$a, string
+$b)
+    

+    


+	
+		Helper function to sort the unit DNs




+
Tags:

+

+
+  
+    
+  
+
return:  0 if equal, 1 if $a is greater, -1 if $b is greater

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
string  $a  first argument to compare
string  $b  second argument to compare

+    


+        
[ Top ]

+  

+  

+	
+	
method connect [line 96]

+	

+    

+    

+		mixed connect(
+string
+$user, string
+$passwd)
+    

+    


+	
+		Connects to the server using the given username and password




+
Tags:

+

+
+  
+    
+  
+
return:  if connect succeeds the server handle is returned, else false

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
string  $user  user name
string  $passwd  password

+    


+        
[ Top ]

+  

+  

+	
+	
method decrypt [line 371]

+	

+    

+    

+		string decrypt(
+object
+$data)
+    

+    


+	
+		Decrypts a string




+
Tags:

+

+
+  
+    
+  
+
return:  decrypted string

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
object  $data  string to decrypt

+    


+        
[ Top ]

+  

+  

+	
+	
method decrypt_login [line 405]

+	

+    

+    

+		array decrypt_login(
+)
+    

+    


+	
+		Decrypts username and password




+
Tags:

+

+
+  
+    
+  
+
return:  array(user name, password)

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method destroy [line 414]

+	

+    

+    

+		void destroy(
+)
+    

+    


+	
+		Closes connection to LDAP server and deletes encrypted username/password




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method encrypt [line 350]

+	

+    

+    

+		object encrypted encrypt(
+string
+$data)
+    

+    


+	
+		Encrypts a string




+
Tags:

+

+
+  
+    
+  
+
return:  string

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $data  string to encrypt

+    


+        
[ Top ]

+  

+  

+	
+	
method encrypt_login [line 394]

+	

+    

+    

+		void encrypt_login(
+string
+$username, string
+$password)
+    

+    


+	
+		Encrypts username and password




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
string  $username  LDAP user name
string  $password  LDAP password

+    


+        
[ Top ]

+  

+  

+	
+	
method new_rand [line 336]

+	

+    

+    

+		int new_rand(
+)
+    

+    


+	
+		Calculates a new value for rand




+
Tags:

+

+
+  
+    
+  
+
return:  New random value

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method search_units [line 152]

+	

+    

+    

+		array search_units(
+string
+$suffix)
+    

+    


+	
+		Returns an array with all organizational units under the given suffix




+
Tags:

+

+
+  
+    
+  
+
return:  DNs of organizational units

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $suffix  search suffix

+    


+        
[ Top ]

+  

+  

+	
+	
method server [line 295]

+	

+    

+    

+		object connection server(
+)
+    

+    


+	
+		Returns the LDAP connection handle




+
Tags:

+

+
+  
+    
+  
+
return:  handle

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method updateCapabilities [line 282]

+	

+    

+    

+		void updateCapabilities(
+)
+    

+    


+	
+		Updates the capabilities values (var $supports_*)




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method updateClasses [line 179]

+	

+    

+    

+		void updateClasses(
+)
+    

+    


+	
+		Reads the array of objectClasses from the LDAP server




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method __sleep [line 300]

+	

+    

+    

+		void __sleep(
+)
+    

+    


+	
+		Closes connection to LDAP server before serialization




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method __wakeup [line 308]

+	

+    

+    

+		void __wakeup(
+)
+    

+    


+	
+		Reconnects to LDAP server when deserialized




+
+	
+
+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:50 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/LDAP/_lib_ldap_inc.html b/lam-web/developers/phpdoc/LDAP/_lib_ldap_inc.html
new file mode 100644
index 00000000..16d72406
--- /dev/null
+++ b/lam-web/developers/phpdoc/LDAP/_lib_ldap_inc.html
@@ -0,0 +1,135 @@
+
+
+Docs for page ldap.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
LDAP

+  		  [ class tree: LDAP ]
+		  [ index: LDAP ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					ldap.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		Ldap

+	  

+                		
+      

+
+
Procedural File: ldap.inc

+Source Location: /lib/ldap.inc


+
+

+

+
+

+
Classes:

+
Ldap

+	
Ldap manages connection to LDAP and includes several helper functions.

+



+
+
Page Details:

+ldap.inc provides basic functions to connect to the OpenLDAP server.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once("config.inc") [line 32]

+Access to configuration data

include_once("schema.inc") [line 34]

+LDAP schema


+


+


+

+  

+	
+	
hex2bin [line 42]

+	

+    

+    

+		binary hex2bin(
+string $value)
+    

+    


+
+		Converts a HEX string to a binary value




+
Tags:

+

+
+  
+    
+  
+
return:  result binary

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $value  HEX string

+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:50 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/PDF/FPDF.html b/lam-web/developers/phpdoc/PDF/FPDF.html
new file mode 100644
index 00000000..fd6fa812
--- /dev/null
+++ b/lam-web/developers/phpdoc/PDF/FPDF.html
@@ -0,0 +1,2623 @@
+
+
+Docs For Class FPDF
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
PDF

+  		  [ class tree: PDF ]
+		  [ index: PDF ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					fpdf.php
+		

+					pdf.inc
+		

+					pdfdelete.php
+		

+					pdfmain.php
+		

+					pdfpage.php
+		

+					pdfstruct.inc
+		

+					ufpdf.php
+		

+					vera.php
+		

+					verab.php
+		

+					verabi.php
+		

+					verai.php
+		

+					xml_parser.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		FPDF

+	    		lamPDF

+	    		UFPDF

+	    		xmlParser

+	  

+                		
+      

+
+
Class: FPDF

+Source Location: /lib/fpdf.php


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+


+
Main FPDF class for creating PDF documents



+
+
+
+
+
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+

+
Child classes:

+

+

+
UFPDF

+	
Main UFPDF class for creating Unicode PDF documents

+

+

+

+

+
+
+
Class Details

+

+[line 28]

+Main FPDF class for creating PDF documents




+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$AliasNbPages = 

+	
[line 82]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$author = 

+	
[line 79]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$AutoPageBreak = 

+	
[line 72]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$bMargin = 

+	
[line 49]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$buffer = 

+	
[line 34]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$cMargin = 

+	
[line 50]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$ColorFlag = 

+	
[line 70]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$compress = 

+	
[line 37]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$CoreFonts = 

+	
[line 54]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$creator = 

+	
[line 81]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$CurOrientation = 

+	
[line 39]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$CurrentFont = 

+	
[line 64]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$DefOrientation = 

+	
[line 38]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$diffs = 

+	
[line 57]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$DrawColor = 

+	
[line 67]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$fh = 

+	
[line 43]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$fhPt = 

+	
[line 42]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$FillColor = 

+	
[line 68]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$FontFamily = 

+	
[line 61]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$FontFiles = 

+	
[line 56]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$fonts = 

+	
[line 55]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$FontSize = 

+	
[line 66]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$FontSizePt = 

+	
[line 65]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$FontStyle = 

+	
[line 62]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$fw = 

+	
[line 43]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$fwPt = 

+	
[line 42]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$h = 

+	
[line 45]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$hPt = 

+	
[line 44]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$images = 

+	
[line 58]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$InFooter = 

+	
[line 74]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$k = 

+	
[line 41]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$keywords = 

+	
[line 80]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$lasth = 

+	
[line 52]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$LayoutMode = 

+	
[line 76]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$LineWidth = 

+	
[line 53]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$links = 

+	
[line 60]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$lMargin = 

+	
[line 46]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$n = 

+	
[line 32]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$offsets = 

+	
[line 33]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$OrientationChanges = 

+	
[line 40]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$page = 

+	
[line 31]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$PageBreakTrigger = 

+	
[line 73]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$PageLinks = 

+	
[line 59]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$pages = 

+	
[line 35]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$PDFVersion = 

+	
[line 83]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$rMargin = 

+	
[line 48]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$state = 

+	
[line 36]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$subject = 

+	
[line 78]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$TextColor = 

+	
[line 69]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$title = 

+	
[line 77]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$tMargin = 

+	
[line 47]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$underline = 

+	
[line 63]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$w = 

+	
[line 45]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$wPt = 

+	
[line 44]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$ws = 

+	
[line 71]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$x = 

+	
[line 51]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$y = 

+	
[line 51]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$ZoomMode = 

+	
[line 75]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor FPDF [line 90]

+	

+    

+    

+		FPDF FPDF(
+[mixed
+$orientation = 'P'], [mixed
+$unit = 'mm'], [mixed
+$format = 'A4'])
+    

+    


+	
+		*****************************************************************************

*                                Public methods                                 *                                                                               * *****************************************************************************




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method AcceptPageBreak [line 628]

+	

+    

+    

+		void AcceptPageBreak(
+)
+    

+    


+	
+		


+
+	
Overridden in child classes as:

+		

+	
UFPDF::AcceptPageBreak()

+		

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method AddFont [line 474]

+	

+    

+    

+		void AddFont(
+mixed
+$family, [mixed
+$style = ''], [mixed
+$file = ''])
+    

+    


+	
+		


+
+	
Overridden in child classes as:

+		

+	
UFPDF::AddFont()

+		

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method AddLink [line 593]

+	

+    

+    

+		void AddLink(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method AddPage [line 320]

+	

+    

+    

+		void AddPage(
+[mixed
+$orientation = ''])
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method AliasNbPages [line 285]

+	

+    

+    

+		void AliasNbPages(
+[mixed
+$alias = '{nb}'])
+    

+    


+	
+		


+
+	
Overridden in child classes as:

+		

+	
UFPDF::AliasNbPages()

+		

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method Cell [line 634]

+	

+    

+    

+		void Cell(
+mixed
+$w, [mixed
+$h = 0], [mixed
+$txt = ''], [mixed
+$border = 0], [mixed
+$ln = 0], [mixed
+$align = ''], [mixed
+$fill = 0], [mixed
+$link = ''])
+    

+    


+	
+		


+
+	
Overridden in child classes as:

+		

+	
UFPDF::Cell()

+		

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method Close [line 303]

+	

+    

+    

+		void Close(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method Error [line 291]

+	

+    

+    

+		void Error(
+mixed
+$msg)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method Footer [line 392]

+	

+    

+    

+		void Footer(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method GetStringWidth [line 436]

+	

+    

+    

+		void GetStringWidth(
+mixed
+$s)
+    

+    


+	
+		


+
+	
Overridden in child classes as:

+		

+	
UFPDF::GetStringWidth()

+		

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method GetX [line 967]

+	

+    

+    

+		void GetX(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method GetY [line 982]

+	

+    

+    

+		void GetY(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method Header [line 387]

+	

+    

+    

+		void Header(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method Image [line 907]

+	

+    

+    

+		void Image(
+mixed
+$file, mixed
+$x, mixed
+$y, [mixed
+$w = 0], [mixed
+$h = 0], [mixed
+$type = ''], [mixed
+$link = ''])
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method Line [line 456]

+	

+    

+    

+		void Line(
+mixed
+$x1, mixed
+$y1, mixed
+$x2, mixed
+$y2)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method Link [line 611]

+	

+    

+    

+		void Link(
+mixed
+$x, mixed
+$y, mixed
+$w, mixed
+$h, mixed
+$link)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method Ln [line 957]

+	

+    

+    

+		void Ln(
+[mixed
+$h = ''])
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method MultiCell [line 713]

+	

+    

+    

+		void MultiCell(
+mixed
+$w, mixed
+$h, mixed
+$txt, [mixed
+$border = 0], [mixed
+$align = 'J'], [mixed
+$fill = 0])
+    

+    


+	
+		


+
+	
Overridden in child classes as:

+		

+	
UFPDF::MultiCell()

+		

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method Open [line 297]

+	

+    

+    

+		void Open(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method Output [line 1005]

+	

+    

+    

+		void Output(
+[mixed
+$name = ''], [mixed
+$dest = ''])
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method PageNo [line 397]

+	

+    

+    

+		void PageNo(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method Rect [line 462]

+	

+    

+    

+		void Rect(
+mixed
+$x, mixed
+$y, mixed
+$w, mixed
+$h, [mixed
+$style = ''])
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method SetAuthor [line 267]

+	

+    

+    

+		void SetAuthor(
+mixed
+$author)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method SetAutoPageBreak [line 225]

+	

+    

+    

+		void SetAutoPageBreak(
+mixed
+$auto, [mixed
+$margin = 0])
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method SetCompression [line 246]

+	

+    

+    

+		void SetCompression(
+mixed
+$compress)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method SetCreator [line 279]

+	

+    

+    

+		void SetCreator(
+mixed
+$creator)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method SetDisplayMode [line 233]

+	

+    

+    

+		void SetDisplayMode(
+mixed
+$zoom, [mixed
+$layout = 'continuous'])
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method SetDrawColor [line 403]

+	

+    

+    

+		void SetDrawColor(
+mixed
+$r, [mixed
+$g = -1], [mixed
+$b = -1])
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method SetFillColor [line 414]

+	

+    

+    

+		void SetFillColor(
+mixed
+$r, [mixed
+$g = -1], [mixed
+$b = -1])
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method SetFont [line 522]

+	

+    

+    

+		void SetFont(
+mixed
+$family, [mixed
+$style = ''], [mixed
+$size = 0])
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method SetFontSize [line 582]

+	

+    

+    

+		void SetFontSize(
+mixed
+$size)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method SetKeywords [line 273]

+	

+    

+    

+		void SetKeywords(
+mixed
+$keywords)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method SetLeftMargin [line 205]

+	

+    

+    

+		void SetLeftMargin(
+mixed
+$margin)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method SetLineWidth [line 448]

+	

+    

+    

+		void SetLineWidth(
+mixed
+$width)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method SetLink [line 601]

+	

+    

+    

+		void SetLink(
+mixed
+$link, [mixed
+$y = 0], [mixed
+$page = -1])
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method SetMargins [line 195]

+	

+    

+    

+		void SetMargins(
+mixed
+$left, mixed
+$top, [mixed
+$right = -1])
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method SetRightMargin [line 219]

+	

+    

+    

+		void SetRightMargin(
+mixed
+$margin)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method SetSubject [line 261]

+	

+    

+    

+		void SetSubject(
+mixed
+$subject)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method SetTextColor [line 426]

+	

+    

+    

+		void SetTextColor(
+mixed
+$r, [mixed
+$g = -1], [mixed
+$b = -1])
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method SetTitle [line 255]

+	

+    

+    

+		void SetTitle(
+mixed
+$title)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method SetTopMargin [line 213]

+	

+    

+    

+		void SetTopMargin(
+mixed
+$margin)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method SetX [line 973]

+	

+    

+    

+		void SetX(
+mixed
+$x)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method SetXY [line 998]

+	

+    

+    

+		void SetXY(
+mixed
+$x, mixed
+$y)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method SetY [line 988]

+	

+    

+    

+		void SetY(
+mixed
+$y)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method Text [line 617]

+	

+    

+    

+		void Text(
+mixed
+$x, mixed
+$y, mixed
+$txt)
+    

+    


+	
+		


+
+	
Overridden in child classes as:

+		

+	
UFPDF::Text()

+		

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method Write [line 826]

+	

+    

+    

+		void Write(
+mixed
+$h, mixed
+$txt, [mixed
+$link = ''])
+    

+    


+	
+		


+
+	
Overridden in child classes as:

+		

+	
UFPDF::Write()

+		

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method _beginpage [line 1445]

+	

+    

+    

+		void _beginpage(
+mixed
+$orientation)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method _dochecks [line 1078]

+	

+    

+    

+		void _dochecks(
+)
+    

+    


+	
+		*****************************************************************************

*                               Protected methods                               *                                                                               * *****************************************************************************




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method _dounderline [line 1498]

+	

+    

+    

+		void _dounderline(
+mixed
+$x, mixed
+$y, mixed
+$txt)
+    

+    


+	
+		


+
+	
Overridden in child classes as:

+		

+	
UFPDF::_dounderline()

+		

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method _enddoc [line 1410]

+	

+    

+    

+		void _enddoc(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method _endpage [line 1484]

+	

+    

+    

+		void _endpage(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method _escape [line 1627]

+	

+    

+    

+		void _escape(
+mixed
+$s)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method _freadint [line 1614]

+	

+    

+    

+		void _freadint(
+mixed
+$f)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method _getfontpath [line 1088]

+	

+    

+    

+		void _getfontpath(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method _newobj [line 1490]

+	

+    

+    

+		void _newobj(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method _out [line 1640]

+	

+    

+    

+		void _out(
+mixed
+$s)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method _parsejpg [line 1507]

+	

+    

+    

+		void _parsejpg(
+mixed
+$file)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method _parsepng [line 1531]

+	

+    

+    

+		void _parsepng(
+mixed
+$file)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method _putcatalog [line 1378]

+	

+    

+    

+		void _putcatalog(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method _putfonts [line 1166]

+	

+    

+    

+		void _putfonts(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method _putheader [line 1398]

+	

+    

+    

+		void _putheader(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method _putimages [line 1283]

+	

+    

+    

+		void _putimages(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method _putinfo [line 1362]

+	

+    

+    

+		void _putinfo(
+)
+    

+    


+	
+		


+
+	
Overridden in child classes as:

+		

+	
UFPDF::_putinfo()

+		

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method _putpages [line 1095]

+	

+    

+    

+		void _putpages(
+)
+    

+    


+	
+		


+
+	
Overridden in child classes as:

+		

+	
UFPDF::_putpages()

+		

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method _putresourcedict [line 1337]

+	

+    

+    

+		void _putresourcedict(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method _putresources [line 1349]

+	

+    

+    

+		void _putresources(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method _putstream [line 1633]

+	

+    

+    

+		void _putstream(
+mixed
+$s)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method _puttrailer [line 1403]

+	

+    

+    

+		void _puttrailer(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method _putxobjectdict [line 1331]

+	

+    

+    

+		void _putxobjectdict(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method _textstring [line 1621]

+	

+    

+    

+		void _textstring(
+mixed
+$s)
+    

+    


+	
+		


+
+	
Overridden in child classes as:

+		

+	
UFPDF::_textstring()

+		

+	

+	

+	
+
+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:45 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/PDF/UFPDF.html b/lam-web/developers/phpdoc/PDF/UFPDF.html
new file mode 100644
index 00000000..50252bb1
--- /dev/null
+++ b/lam-web/developers/phpdoc/PDF/UFPDF.html
@@ -0,0 +1,1517 @@
+
+
+Docs For Class UFPDF
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
PDF

+  		  [ class tree: PDF ]
+		  [ index: PDF ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					fpdf.php
+		

+					pdf.inc
+		

+					pdfdelete.php
+		

+					pdfmain.php
+		

+					pdfpage.php
+		

+					pdfstruct.inc
+		

+					ufpdf.php
+		

+					vera.php
+		

+					verab.php
+		

+					verabi.php
+		

+					verai.php
+		

+					xml_parser.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		FPDF

+	    		lamPDF

+	    		UFPDF

+	    		xmlParser

+	  

+                		
+      

+
+
Class: UFPDF

+Source Location: /lib/ufpdf.php


+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
FPDF
+   |
+   --UFPDF


+
Main UFPDF class for creating Unicode PDF documents



+
Author(s):

+
    
+        

+
+
+
+
+    
+
+        
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+
+

+
Child classes:

+

+

+
lamPDF

+	
Creates a LAM information page in PDF format.

+

+

+		
+
Inherited Variables

+

+
Class: FPDF

+

+

+  FPDF::$AliasNbPages
+  
+

+

+   
+

+

+  FPDF::$author
+  
+

+

+   
+

+

+  FPDF::$AutoPageBreak
+  
+

+

+   
+

+

+  FPDF::$bMargin
+  
+

+

+   
+

+

+  FPDF::$buffer
+  
+

+

+   
+

+

+  FPDF::$cMargin
+  
+

+

+   
+

+

+  FPDF::$ColorFlag
+  
+

+

+   
+

+

+  FPDF::$compress
+  
+

+

+   
+

+

+  FPDF::$CoreFonts
+  
+

+

+   
+

+

+  FPDF::$creator
+  
+

+

+   
+

+

+  FPDF::$CurOrientation
+  
+

+

+   
+

+

+  FPDF::$CurrentFont
+  
+

+

+   
+

+

+  FPDF::$DefOrientation
+  
+

+

+   
+

+

+  FPDF::$diffs
+  
+

+

+   
+

+

+  FPDF::$DrawColor
+  
+

+

+   
+

+

+  FPDF::$fh
+  
+

+

+   
+

+

+  FPDF::$fhPt
+  
+

+

+   
+

+

+  FPDF::$FillColor
+  
+

+

+   
+

+

+  FPDF::$FontFamily
+  
+

+

+   
+

+

+  FPDF::$FontFiles
+  
+

+

+   
+

+

+  FPDF::$fonts
+  
+

+

+   
+

+

+  FPDF::$FontSize
+  
+

+

+   
+

+

+  FPDF::$FontSizePt
+  
+

+

+   
+

+

+  FPDF::$FontStyle
+  
+

+

+   
+

+

+  FPDF::$fw
+  
+

+

+   
+

+

+  FPDF::$fwPt
+  
+

+

+   
+

+

+  FPDF::$h
+  
+

+

+   
+

+

+  FPDF::$hPt
+  
+

+

+   
+

+

+  FPDF::$images
+  
+

+

+   
+

+

+  FPDF::$InFooter
+  
+

+

+   
+

+

+  FPDF::$k
+  
+

+

+   
+

+

+  FPDF::$keywords
+  
+

+

+   
+

+

+  FPDF::$lasth
+  
+

+

+   
+

+

+  FPDF::$LayoutMode
+  
+

+

+   
+

+

+  FPDF::$LineWidth
+  
+

+

+   
+

+

+  FPDF::$links
+  
+

+

+   
+

+

+  FPDF::$lMargin
+  
+

+

+   
+

+

+  FPDF::$n
+  
+

+

+   
+

+

+  FPDF::$offsets
+  
+

+

+   
+

+

+  FPDF::$OrientationChanges
+  
+

+

+   
+

+

+  FPDF::$page
+  
+

+

+   
+

+

+  FPDF::$PageBreakTrigger
+  
+

+

+   
+

+

+  FPDF::$PageLinks
+  
+

+

+   
+

+

+  FPDF::$pages
+  
+

+

+   
+

+

+  FPDF::$PDFVersion
+  
+

+

+   
+

+

+  FPDF::$rMargin
+  
+

+

+   
+

+

+  FPDF::$state
+  
+

+

+   
+

+

+  FPDF::$subject
+  
+

+

+   
+

+

+  FPDF::$TextColor
+  
+

+

+   
+

+

+  FPDF::$title
+  
+

+

+   
+

+

+  FPDF::$tMargin
+  
+

+

+   
+

+

+  FPDF::$underline
+  
+

+

+   
+

+

+  FPDF::$w
+  
+

+

+   
+

+

+  FPDF::$wPt
+  
+

+

+   
+

+

+  FPDF::$ws
+  
+

+

+   
+

+

+  FPDF::$x
+  
+

+

+   
+

+

+  FPDF::$y
+  
+

+

+   
+

+

+  FPDF::$ZoomMode
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: FPDF

+

+    

+    FPDF::FPDF()
+
+  

+  

+    *****************************************************************************
+  

+    

+    FPDF::AcceptPageBreak()
+
+  

+  

+    
+  

+    

+    FPDF::AddFont()
+
+  

+  

+    
+  

+    

+    FPDF::AddLink()
+
+  

+  

+    
+  

+    

+    FPDF::AddPage()
+
+  

+  

+    
+  

+    

+    FPDF::AliasNbPages()
+
+  

+  

+    
+  

+    

+    FPDF::Cell()
+
+  

+  

+    
+  

+    

+    FPDF::Close()
+
+  

+  

+    
+  

+    

+    FPDF::Error()
+
+  

+  

+    
+  

+    

+    FPDF::Footer()
+
+  

+  

+    
+  

+    

+    FPDF::GetStringWidth()
+
+  

+  

+    
+  

+    

+    FPDF::GetX()
+
+  

+  

+    
+  

+    

+    FPDF::GetY()
+
+  

+  

+    
+  

+    

+    FPDF::Header()
+
+  

+  

+    
+  

+    

+    FPDF::Image()
+
+  

+  

+    
+  

+    

+    FPDF::Line()
+
+  

+  

+    
+  

+    

+    FPDF::Link()
+
+  

+  

+    
+  

+    

+    FPDF::Ln()
+
+  

+  

+    
+  

+    

+    FPDF::MultiCell()
+
+  

+  

+    
+  

+    

+    FPDF::Open()
+
+  

+  

+    
+  

+    

+    FPDF::Output()
+
+  

+  

+    
+  

+    

+    FPDF::PageNo()
+
+  

+  

+    
+  

+    

+    FPDF::Rect()
+
+  

+  

+    
+  

+    

+    FPDF::SetAuthor()
+
+  

+  

+    
+  

+    

+    FPDF::SetAutoPageBreak()
+
+  

+  

+    
+  

+    

+    FPDF::SetCompression()
+
+  

+  

+    
+  

+    

+    FPDF::SetCreator()
+
+  

+  

+    
+  

+    

+    FPDF::SetDisplayMode()
+
+  

+  

+    
+  

+    

+    FPDF::SetDrawColor()
+
+  

+  

+    
+  

+    

+    FPDF::SetFillColor()
+
+  

+  

+    
+  

+    

+    FPDF::SetFont()
+
+  

+  

+    
+  

+    

+    FPDF::SetFontSize()
+
+  

+  

+    
+  

+    

+    FPDF::SetKeywords()
+
+  

+  

+    
+  

+    

+    FPDF::SetLeftMargin()
+
+  

+  

+    
+  

+    

+    FPDF::SetLineWidth()
+
+  

+  

+    
+  

+    

+    FPDF::SetLink()
+
+  

+  

+    
+  

+    

+    FPDF::SetMargins()
+
+  

+  

+    
+  

+    

+    FPDF::SetRightMargin()
+
+  

+  

+    
+  

+    

+    FPDF::SetSubject()
+
+  

+  

+    
+  

+    

+    FPDF::SetTextColor()
+
+  

+  

+    
+  

+    

+    FPDF::SetTitle()
+
+  

+  

+    
+  

+    

+    FPDF::SetTopMargin()
+
+  

+  

+    
+  

+    

+    FPDF::SetX()
+
+  

+  

+    
+  

+    

+    FPDF::SetXY()
+
+  

+  

+    
+  

+    

+    FPDF::SetY()
+
+  

+  

+    
+  

+    

+    FPDF::Text()
+
+  

+  

+    
+  

+    

+    FPDF::Write()
+
+  

+  

+    
+  

+    

+    FPDF::_beginpage()
+
+  

+  

+    
+  

+    

+    FPDF::_dochecks()
+
+  

+  

+    *****************************************************************************
+  

+    

+    FPDF::_dounderline()
+
+  

+  

+    
+  

+    

+    FPDF::_enddoc()
+
+  

+  

+    
+  

+    

+    FPDF::_endpage()
+
+  

+  

+    
+  

+    

+    FPDF::_escape()
+
+  

+  

+    
+  

+    

+    FPDF::_freadint()
+
+  

+  

+    
+  

+    

+    FPDF::_getfontpath()
+
+  

+  

+    
+  

+    

+    FPDF::_newobj()
+
+  

+  

+    
+  

+    

+    FPDF::_out()
+
+  

+  

+    
+  

+    

+    FPDF::_parsejpg()
+
+  

+  

+    
+  

+    

+    FPDF::_parsepng()
+
+  

+  

+    
+  

+    

+    FPDF::_putcatalog()
+
+  

+  

+    
+  

+    

+    FPDF::_putfonts()
+
+  

+  

+    
+  

+    

+    FPDF::_putheader()
+
+  

+  

+    
+  

+    

+    FPDF::_putimages()
+
+  

+  

+    
+  

+    

+    FPDF::_putinfo()
+
+  

+  

+    
+  

+    

+    FPDF::_putpages()
+
+  

+  

+    
+  

+    

+    FPDF::_putresourcedict()
+
+  

+  

+    
+  

+    

+    FPDF::_putresources()
+
+  

+  

+    
+  

+    

+    FPDF::_putstream()
+
+  

+  

+    
+  

+    

+    FPDF::_puttrailer()
+
+  

+  

+    
+  

+    

+    FPDF::_putxobjectdict()
+
+  

+  

+    
+  

+    

+    FPDF::_textstring()
+
+  

+  

+    
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 37]

+Main UFPDF class for creating Unicode PDF documents




+
Tags:

+

+
+  
+    
+  
+
see:  FPDF::FPDF()

+

+



+
[ Top ]


+
+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor UFPDF [line 45]

+	

+    

+    

+		UFPDF UFPDF(
+[mixed
+$orientation = 'P'], [mixed
+$unit = 'mm'], [mixed
+$format = 'A4'])
+    

+    


+	
+		*****************************************************************************

*                                Public methods                                 *                                                                               * *****************************************************************************




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method AcceptPageBreak [line 113]

+	

+    

+    

+		void AcceptPageBreak(
+)
+    

+    


+	
+		


+
+	
+Overrides FPDF::AcceptPageBreak() (parent method not documented)


+
+        
[ Top ]

+  

+  

+	
+	
method AddFont [line 73]

+	

+    

+    

+		void AddFont(
+mixed
+$family, [mixed
+$style = ''], [mixed
+$file = ''])
+    

+    


+	
+		


+
+	
+Overrides FPDF::AddFont() (parent method not documented)


+
+        
[ Top ]

+  

+  

+	
+	
method AliasNbPages [line 407]

+	

+    

+    

+		void AliasNbPages(
+[mixed
+$alias = '{nb}'])
+    

+    


+	
+		


+
+	
+Overrides FPDF::AliasNbPages() (parent method not documented)


+
+        
[ Top ]

+  

+  

+	
+	
method Cell [line 119]

+	

+    

+    

+		void Cell(
+mixed
+$w, [mixed
+$h = 0], [mixed
+$txt = ''], [mixed
+$border = 0], [mixed
+$ln = 0], [mixed
+$align = 'J'], [mixed
+$fill = 0], [mixed
+$link = ''])
+    

+    


+	
+		


+
+	
+Overrides FPDF::Cell() (parent method not documented)


+
+        
[ Top ]

+  

+  

+	
+	
method code2utf [line 697]

+	

+    

+    

+		void code2utf(
+mixed
+$num)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method GetStringWidth [line 50]

+	

+    

+    

+		void GetStringWidth(
+mixed
+$s)
+    

+    


+	
+		


+
+	
+Overrides FPDF::GetStringWidth() (parent method not documented)


+
+        
[ Top ]

+  

+  

+	
+	
method MultiCell [line 199]

+	

+    

+    

+		void MultiCell(
+mixed
+$w, mixed
+$h, mixed
+$txt, [mixed
+$border = 0], [mixed
+$align = 'J'], [mixed
+$fill = 0])
+    

+    


+	
+		


+
+	
+Overrides FPDF::MultiCell() (parent method not documented)


+
+        
[ Top ]

+  

+  

+	
+	
method strlen [line 705]

+	

+    

+    

+		void strlen(
+mixed
+$s)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method Text [line 102]

+	

+    

+    

+		void Text(
+mixed
+$x, mixed
+$y, mixed
+$txt)
+    

+    


+	
+		


+
+	
+Overrides FPDF::Text() (parent method not documented)


+
+        
[ Top ]

+  

+  

+	
+	
method utf8_substr [line 709]

+	

+    

+    

+		void utf8_substr(
+mixed
+$str, mixed
+$start)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method utf8_to_codepoints [line 726]

+	

+    

+    

+		void utf8_to_codepoints(
+mixed
+$txt)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method utf8_to_utf16be [line 597]

+	

+    

+    

+		void utf8_to_utf16be(
+mixed
+&$txt, [mixed
+$bom = true])
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method Write [line 324]

+	

+    

+    

+		void Write(
+mixed
+$h, mixed
+$txt, [mixed
+$link = ''])
+    

+    


+	
+		


+
+	
+Overrides FPDF::Write() (parent method not documented)


+
+        
[ Top ]

+  

+  

+	
+	
method _dounderline [line 481]

+	

+    

+    

+		void _dounderline(
+mixed
+$x, mixed
+$y, mixed
+$width, mixed
+$txt)
+    

+    


+	
+		


+
+	
+Overrides FPDF::_dounderline() (parent method not documented)


+
+        
[ Top ]

+  

+  

+	
+	
method _escapetext [line 498]

+	

+    

+    

+		void _escapetext(
+mixed
+$s)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method _putinfo [line 506]

+	

+    

+    

+		void _putinfo(
+)
+    

+    


+	
+		


+
+	
+Overrides FPDF::_putinfo() (parent method not documented)


+
+        
[ Top ]

+  

+  

+	
+	
method _putpages [line 522]

+	

+    

+    

+		void _putpages(
+)
+    

+    


+	
+		


+
+	
+Overrides FPDF::_putpages() (parent method not documented)


+
+        
[ Top ]

+  

+  

+	
+	
method _puttruetypeunicode [line 419]

+	

+    

+    

+		void _puttruetypeunicode(
+mixed
+$font)
+    

+    


+	
+		*****************************************************************************

*                               Protected methods                               *                                                                               * *****************************************************************************




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method _textstring [line 490]

+	

+    

+    

+		void _textstring(
+mixed
+$s)
+    

+    


+	
+		


+
+	
+Overrides FPDF::_textstring() (parent method not documented)


+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:12 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/PDF/_lib_font_vera_php.html b/lam-web/developers/phpdoc/PDF/_lib_font_vera_php.html
new file mode 100644
index 00000000..e68399a9
--- /dev/null
+++ b/lam-web/developers/phpdoc/PDF/_lib_font_vera_php.html
@@ -0,0 +1,117 @@
+
+
+Docs for page vera.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
PDF

+  		  [ class tree: PDF ]
+		  [ index: PDF ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					fpdf.php
+		

+					pdf.inc
+		

+					pdfdelete.php
+		

+					pdfmain.php
+		

+					pdfpage.php
+		

+					pdfstruct.inc
+		

+					ufpdf.php
+		

+					vera.php
+		

+					verab.php
+		

+					verabi.php
+		

+					verai.php
+		

+					xml_parser.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		FPDF

+	    		lamPDF

+	    		UFPDF

+	    		xmlParser

+	  

+                		
+      

+
+
Procedural File: vera.php

+Source Location: /lib/font/vera.php


+
+

+

+
+
+
Page Details:

+This file includes information about the Bitstream Vera font.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:13 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/PDF/_lib_font_verab_php.html b/lam-web/developers/phpdoc/PDF/_lib_font_verab_php.html
new file mode 100644
index 00000000..410e09db
--- /dev/null
+++ b/lam-web/developers/phpdoc/PDF/_lib_font_verab_php.html
@@ -0,0 +1,117 @@
+
+
+Docs for page verab.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
PDF

+  		  [ class tree: PDF ]
+		  [ index: PDF ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					fpdf.php
+		

+					pdf.inc
+		

+					pdfdelete.php
+		

+					pdfmain.php
+		

+					pdfpage.php
+		

+					pdfstruct.inc
+		

+					ufpdf.php
+		

+					vera.php
+		

+					verab.php
+		

+					verabi.php
+		

+					verai.php
+		

+					xml_parser.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		FPDF

+	    		lamPDF

+	    		UFPDF

+	    		xmlParser

+	  

+                		
+      

+
+
Procedural File: verab.php

+Source Location: /lib/font/verab.php


+
+

+

+
+
+
Page Details:

+This file includes information about the Bitstream Vera font.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:13 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/PDF/_lib_font_verabi_php.html b/lam-web/developers/phpdoc/PDF/_lib_font_verabi_php.html
new file mode 100644
index 00000000..6ffc32cc
--- /dev/null
+++ b/lam-web/developers/phpdoc/PDF/_lib_font_verabi_php.html
@@ -0,0 +1,117 @@
+
+
+Docs for page verabi.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
PDF

+  		  [ class tree: PDF ]
+		  [ index: PDF ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					fpdf.php
+		

+					pdf.inc
+		

+					pdfdelete.php
+		

+					pdfmain.php
+		

+					pdfpage.php
+		

+					pdfstruct.inc
+		

+					ufpdf.php
+		

+					vera.php
+		

+					verab.php
+		

+					verabi.php
+		

+					verai.php
+		

+					xml_parser.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		FPDF

+	    		lamPDF

+	    		UFPDF

+	    		xmlParser

+	  

+                		
+      

+
+
Procedural File: verabi.php

+Source Location: /lib/font/verabi.php


+
+

+

+
+
+
Page Details:

+This file includes information about the Bitstream Vera font.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:13 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/PDF/_lib_font_verai_php.html b/lam-web/developers/phpdoc/PDF/_lib_font_verai_php.html
new file mode 100644
index 00000000..f6f2a763
--- /dev/null
+++ b/lam-web/developers/phpdoc/PDF/_lib_font_verai_php.html
@@ -0,0 +1,117 @@
+
+
+Docs for page verai.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
PDF

+  		  [ class tree: PDF ]
+		  [ index: PDF ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					fpdf.php
+		

+					pdf.inc
+		

+					pdfdelete.php
+		

+					pdfmain.php
+		

+					pdfpage.php
+		

+					pdfstruct.inc
+		

+					ufpdf.php
+		

+					vera.php
+		

+					verab.php
+		

+					verabi.php
+		

+					verai.php
+		

+					xml_parser.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		FPDF

+	    		lamPDF

+	    		UFPDF

+	    		xmlParser

+	  

+                		
+      

+
+
Procedural File: verai.php

+Source Location: /lib/font/verai.php


+
+

+

+
+
+
Page Details:

+This file includes information about the Bitstream Vera font.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:13 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/PDF/_lib_fpdf_php.html b/lam-web/developers/phpdoc/PDF/_lib_fpdf_php.html
new file mode 100644
index 00000000..f86f65ed
--- /dev/null
+++ b/lam-web/developers/phpdoc/PDF/_lib_fpdf_php.html
@@ -0,0 +1,136 @@
+
+
+Docs for page fpdf.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
PDF

+  		  [ class tree: PDF ]
+		  [ index: PDF ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					fpdf.php
+		

+					pdf.inc
+		

+					pdfdelete.php
+		

+					pdfmain.php
+		

+					pdfpage.php
+		

+					pdfstruct.inc
+		

+					ufpdf.php
+		

+					vera.php
+		

+					verab.php
+		

+					verabi.php
+		

+					verai.php
+		

+					xml_parser.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		FPDF

+	    		lamPDF

+	    		UFPDF

+	    		xmlParser

+	  

+                		
+      

+
+
Procedural File: fpdf.php

+Source Location: /lib/fpdf.php


+
+

+

+
+

+
Classes:

+
FPDF

+	
Main FPDF class for creating PDF documents

+



+
+
Page Details:

+This file includes the FPDF implementation which is used to generate PDF files.




+
Tags:

+

+
+  
+    
+  
+
author:  Olivier Plathey

+

+


+


+


+  

+	
+	
FPDF_VERSION [line 21]

+	

+    

+    

+		FPDF_VERSION = '1.53'
+    

+    

+
+    *****************************************************************************

Software: FPDF                                                               *  Version:  1.53                                                               *  Date:     2004-12-31                                                         *  Author:   Olivier PLATHEY                                                    *  License:  Freeware                                                           *                                                                               *  You may use, modify and redistribute this software as you wish.              * *****************************************************************************

    

+	
+	

+	
[ Top ]



+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:45 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/PDF/_lib_pdf_inc.html b/lam-web/developers/phpdoc/PDF/_lib_pdf_inc.html
new file mode 100644
index 00000000..eb8030aa
--- /dev/null
+++ b/lam-web/developers/phpdoc/PDF/_lib_pdf_inc.html
@@ -0,0 +1,319 @@
+
+
+Docs for page pdf.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
PDF

+  		  [ class tree: PDF ]
+		  [ index: PDF ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					fpdf.php
+		

+					pdf.inc
+		

+					pdfdelete.php
+		

+					pdfmain.php
+		

+					pdfpage.php
+		

+					pdfstruct.inc
+		

+					ufpdf.php
+		

+					vera.php
+		

+					verab.php
+		

+					verabi.php
+		

+					verai.php
+		

+					xml_parser.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		FPDF

+	    		lamPDF

+	    		UFPDF

+	    		xmlParser

+	  

+                		
+      

+
+
Procedural File: pdf.inc

+Source Location: /lib/pdf.inc


+
+

+

+
+

+
Classes:

+
lamPDF

+	
Creates a LAM information page in PDF format.

+



+
+
Page Details:

+LDAP Account Manager PDF printing library. It consists of lamPDF class,  the createModulePDF() function that may be called by other pages  and furthermore some helper functions.




+
Tags:

+

+
+  
+    
+  
+
author:  Michael Duergner

+

+


+
Includes:

+

+include_once("ufpdf.php") [line 39]

+Unicode support for FPDF

include_once('xml_parser.inc') [line 42]

+XML functions

include_once("fpdf.php") [line 36]

+PDF generator class

include_once('pdfstruct.inc') [line 45]

+access to PDF configuration files


+


+


+  

+	
+	
LAMPDF_LINEWIDTH [line 33]

+	

+    

+    

+		LAMPDF_LINEWIDTH = 190
+    

+    

+
+    PDF line width

    

+	
+	

+	
[ Top ]



+

+  

+	
+	
createModulePDF [line 62]

+	

+    

+    

+		void createModulePDF(
+array $accounts, [string $pdf_structure = "default"])
+    

+    


+
+		This function creates the PDF output of one or more accounts. At the moment  this function can create a PDF page for user, group and host accounts. But  this is not limited by the function itself but by the account types that are  allowed in LAM and the exsisting PDF structure definitions.

    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
array  $accounts  A numbered array containing all accounts the PDF page should  be created for. The entries of the array must be AccountContainer objects.
string  $pdf_structure  The filename of the structure definition that should be used  to create the PDF page. If not submitted the 'default.user' structure definition  for the appropriate account type.

+    	
[ Top ]



+	

+  

+	
+	
getSectionHeadline [line 197]

+	

+    

+    

+		string getSectionHeadline(
+string $line)
+    

+    


+
+		Creates a section headline.




+
Tags:

+

+
+  
+    
+  
+
return:  XML code for headline

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $line  section name

+    	
[ Top ]



+	

+  

+	
+	
processAttributes [line 325]

+	

+    

+    

+		array processAttributes(
+string $attrs, [array $return = array()])
+    

+    


+
+		Processes width, height and alignment attributes.




+
Tags:

+

+
+  
+    
+  
+
return:  XML code

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $attrs  attributes
array  $return  XML code

+    	
[ Top ]



+	

+  

+	
+	
processFormatTags [line 292]

+	

+    

+    

+		array processFormatTags(
+string $line, string $style)
+    

+    


+
+		Formats the XML code.




+
Tags:

+

+
+  
+    
+  
+
return:  XML code

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $line  XML code of PDF entry
string  $style  style commands

+    	
[ Top ]



+	

+  

+	
+	
processLine [line 216]

+	

+    

+    

+		array processLine(
+string $line, [boolean $first_td = true], mixed $fontName)
+    

+    


+
+		Creates the XML code for an PDF entry.




+
Tags:

+

+
+  
+    
+  
+
return:  XML codes

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $line  XML code of PDF entry
boolean  $first_td  True if this is the first column

+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:55 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/PDF/_lib_pdfstruct_inc.html b/lam-web/developers/phpdoc/PDF/_lib_pdfstruct_inc.html
new file mode 100644
index 00000000..9f276388
--- /dev/null
+++ b/lam-web/developers/phpdoc/PDF/_lib_pdfstruct_inc.html
@@ -0,0 +1,294 @@
+
+
+Docs for page pdfstruct.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
PDF

+  		  [ class tree: PDF ]
+		  [ index: PDF ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					fpdf.php
+		

+					pdf.inc
+		

+					pdfdelete.php
+		

+					pdfmain.php
+		

+					pdfpage.php
+		

+					pdfstruct.inc
+		

+					ufpdf.php
+		

+					vera.php
+		

+					verab.php
+		

+					verabi.php
+		

+					verai.php
+		

+					xml_parser.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		FPDF

+	    		lamPDF

+	    		UFPDF

+	    		xmlParser

+	  

+                		
+      

+
+
Procedural File: pdfstruct.inc

+Source Location: /lib/pdfstruct.inc


+
+

+

+
+
+
Page Details:

+Functions to manage the PDF structures.




+
Tags:

+

+
+  
+    
+  
+
author:  Michael Dürgner

+

+


+
Includes:

+

+include_once("ldap.inc") [line 34]

+LDAP object

include_once("config.inc") [line 31]

+LAM configuration


+


+


+

+  

+	
+	
deletePDFStructureDefinition [line 158]

+	

+    

+    

+		boolean deletePDFStructureDefinition(
+string $scope, string $definition)
+    

+    


+
+		Deletes XML file with PDF structure definitions.




+
Tags:

+

+
+  
+    
+  
+
return:  True if file was deleted or false if a problem occured.

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $scope  account type
string  $definition  Name of definition to delete

+    	
[ Top ]



+	

+  

+	
+	
getAvailableLogos [line 176]

+	

+    

+    

+		array getAvailableLogos(
+)
+    

+    


+
+		This function returns an array with all aviliable logo images.




+
Tags:

+

+
+  
+    
+  
+
return:  list of logo files

+

+    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
getPDFStructureDefinitions [line 47]

+	

+    

+    

+		array getPDFStructureDefinitions(
+[string $scope = "user"])
+    

+    


+
+		This function will return all available PDF structure definitions for the submitted  account scope.




+
Tags:

+

+
+  
+    
+  
+
return:  All available PDF structure definitions for the submitted account  scope. Each entry is a string being the filename that may be passed to the  createModulePDF() function as second argument.

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $scope  The account scope the PDF structure definitions should be  returned.

+    	
[ Top ]



+	

+  

+	
+	
loadPDFStructureDefinitions [line 72]

+	

+    

+    

+		array loadPDFStructureDefinitions(
+[string $scope = 'user'], [string $pdf_structure = 'default'])
+    

+    


+
+		This function is used to get pdf structure from xml file.

Used in createModulePDF.




+
Tags:

+

+
+  
+    
+  
+
return:  PDF structure

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $scope  The account scope for wich the PDF structure should be returned.
string  $pdf_structure  Structure name of selected scope wich should be returned.

+    	
[ Top ]



+	

+  

+	
+	
savePDFStructureDefinitions [line 100]

+	

+    

+    

+		string savePDFStructureDefinitions(
+string $scope, string $definition)
+    

+    


+
+		Saves PDF structure definitions to XML file in format: <name>.<scope>.xml




+
Tags:

+

+
+  
+    
+  
+
return:  "no perms" if access denied or "ok".

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $scope  account type
string  $definition  Name of definition

+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:56 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/PDF/_lib_ufpdf_php.html b/lam-web/developers/phpdoc/PDF/_lib_ufpdf_php.html
new file mode 100644
index 00000000..de5bd745
--- /dev/null
+++ b/lam-web/developers/phpdoc/PDF/_lib_ufpdf_php.html
@@ -0,0 +1,143 @@
+
+
+Docs for page ufpdf.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
PDF

+  		  [ class tree: PDF ]
+		  [ index: PDF ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					fpdf.php
+		

+					pdf.inc
+		

+					pdfdelete.php
+		

+					pdfmain.php
+		

+					pdfpage.php
+		

+					pdfstruct.inc
+		

+					ufpdf.php
+		

+					vera.php
+		

+					verab.php
+		

+					verabi.php
+		

+					verai.php
+		

+					xml_parser.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		FPDF

+	    		lamPDF

+	    		UFPDF

+	    		xmlParser

+	  

+                		
+      

+
+
Procedural File: ufpdf.php

+Source Location: /lib/ufpdf.php


+
+

+

+
+

+
Classes:

+
UFPDF

+	
Main UFPDF class for creating Unicode PDF documents

+



+
+
Page Details:

+This file includes UFPDF which adds Unicode support to FPDF.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Andrea Rossato
author:  Steven Wittens

+

+


+
Includes:

+

+include_once('fpdf.php') [line 29]

+

+


+


+  

+	
+	
UFPDF_VERSION [line 27]

+	

+    

+    

+		UFPDF_VERSION = '0.1'
+    

+    

+
+    *****************************************************************************

Software: UFPDF, Unicode Free PDF generator                                  *  Version:  0.1                                                                *            based on FPDF 1.52 by Olivier PLATHEY                              *  Date:     2004-09-01                                                         *  Author:   Steven Wittens <steven@acko.net>                                   *  License:  GPL                                                                *                                                                               *  UFPDF is a modification of FPDF to support Unicode through UTF-8.            *                                                                               *  This file includes modifications from Andrea Rossato which fix line breaking *  in Write()/MultiCell().                                                      *                                                                               * *****************************************************************************

    

+	
+	

+	
[ Top ]



+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:12 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/PDF/_lib_xml_parser_inc.html b/lam-web/developers/phpdoc/PDF/_lib_xml_parser_inc.html
new file mode 100644
index 00000000..7d048c5c
--- /dev/null
+++ b/lam-web/developers/phpdoc/PDF/_lib_xml_parser_inc.html
@@ -0,0 +1,122 @@
+
+
+Docs for page xml_parser.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
PDF

+  		  [ class tree: PDF ]
+		  [ index: PDF ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					fpdf.php
+		

+					pdf.inc
+		

+					pdfdelete.php
+		

+					pdfmain.php
+		

+					pdfpage.php
+		

+					pdfstruct.inc
+		

+					ufpdf.php
+		

+					vera.php
+		

+					verab.php
+		

+					verabi.php
+		

+					verai.php
+		

+					xml_parser.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		FPDF

+	    		lamPDF

+	    		UFPDF

+	    		xmlParser

+	  

+                		
+      

+
+
Procedural File: xml_parser.inc

+Source Location: /lib/xml_parser.inc


+
+

+

+
+

+
Classes:

+
xmlParser

+	

+



+
+
Page Details:

+LDAP Account Manager xmlParser class




+
Tags:

+

+
+  
+    
+  
+
author:  Michael Duergner

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:13 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/PDF/_templates_pdfedit_pdfdelete_php.html b/lam-web/developers/phpdoc/PDF/_templates_pdfedit_pdfdelete_php.html
new file mode 100644
index 00000000..d8865100
--- /dev/null
+++ b/lam-web/developers/phpdoc/PDF/_templates_pdfedit_pdfdelete_php.html
@@ -0,0 +1,122 @@
+
+
+Docs for page pdfdelete.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
PDF

+  		  [ class tree: PDF ]
+		  [ index: PDF ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					fpdf.php
+		

+					pdf.inc
+		

+					pdfdelete.php
+		

+					pdfmain.php
+		

+					pdfpage.php
+		

+					pdfstruct.inc
+		

+					ufpdf.php
+		

+					vera.php
+		

+					verab.php
+		

+					verabi.php
+		

+					verai.php
+		

+					xml_parser.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		FPDF

+	    		lamPDF

+	    		UFPDF

+	    		xmlParser

+	  

+                		
+      

+
+
Procedural File: pdfdelete.php

+Source Location: /templates/pdfedit/pdfdelete.php


+
+

+

+
+
+
Page Details:

+Manages deletion of pdf structures.




+
Tags:

+

+
+  
+    
+  
+
author:  Michael Dürgner

+

+


+
Includes:

+

+include_once("../../lib/security.inc") [line 32]

+security functions

include_once('../../lib/pdfstruct.inc') [line 34]

+helper functions for pdf


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:56 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/PDF/_templates_pdfedit_pdfmain_php.html b/lam-web/developers/phpdoc/PDF/_templates_pdfedit_pdfmain_php.html
new file mode 100644
index 00000000..8635aed8
--- /dev/null
+++ b/lam-web/developers/phpdoc/PDF/_templates_pdfedit_pdfmain_php.html
@@ -0,0 +1,125 @@
+
+
+Docs for page pdfmain.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
PDF

+  		  [ class tree: PDF ]
+		  [ index: PDF ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					fpdf.php
+		

+					pdf.inc
+		

+					pdfdelete.php
+		

+					pdfmain.php
+		

+					pdfpage.php
+		

+					pdfstruct.inc
+		

+					ufpdf.php
+		

+					vera.php
+		

+					verab.php
+		

+					verabi.php
+		

+					verai.php
+		

+					xml_parser.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		FPDF

+	    		lamPDF

+	    		UFPDF

+	    		xmlParser

+	  

+                		
+      

+
+
Procedural File: pdfmain.php

+Source Location: /templates/pdfedit/pdfmain.php


+
+

+

+
+
+
Page Details:

+This is the main window of the pdf structure editor.




+
Tags:

+

+
+  
+    
+  
+
author:  Michael Dürgner

+

+


+
Includes:

+

+include_once("../../lib/security.inc") [line 32]

+security functions

include_once("../../lib/pdfstruct.inc") [line 34]

+access to PDF configuration files

include_once("../../lib/ldap.inc") [line 36]

+LDAP object

include_once("../../lib/config.inc") [line 38]

+for language settings

include_once("../../lib/modules.inc") [line 40]

+module functions


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:56 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/PDF/_templates_pdfedit_pdfpage_php.html b/lam-web/developers/phpdoc/PDF/_templates_pdfedit_pdfpage_php.html
new file mode 100644
index 00000000..8e50ed0a
--- /dev/null
+++ b/lam-web/developers/phpdoc/PDF/_templates_pdfedit_pdfpage_php.html
@@ -0,0 +1,129 @@
+
+
+Docs for page pdfpage.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
PDF

+  		  [ class tree: PDF ]
+		  [ index: PDF ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					fpdf.php
+		

+					pdf.inc
+		

+					pdfdelete.php
+		

+					pdfmain.php
+		

+					pdfpage.php
+		

+					pdfstruct.inc
+		

+					ufpdf.php
+		

+					vera.php
+		

+					verab.php
+		

+					verabi.php
+		

+					verai.php
+		

+					xml_parser.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		FPDF

+	    		lamPDF

+	    		UFPDF

+	    		xmlParser

+	  

+                		
+      

+
+
Procedural File: pdfpage.php

+Source Location: /templates/pdfedit/pdfpage.php


+
+

+

+
+
+
Page Details:

+Displays the main page of the PDF editor where the user can select the displayed entries.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  Michael Dürgner

+

+


+
Includes:

+

+include_once('../../lib/pdfstruct.inc') [line 37]

+access to PDF configuration files

include_once("../../lib/security.inc") [line 35]

+security functions

include_once('../../lib/ldap.inc') [line 39]

+LDAP object

include_once('../../lib/config.inc') [line 41]

+LAM configuration

include_once('../../lib/xml_parser.inc') [line 45]

+XML functions

include_once('../../lib/modules.inc') [line 43]

+module functions


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:56 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/PDF/lamPDF.html b/lam-web/developers/phpdoc/PDF/lamPDF.html
new file mode 100644
index 00000000..25232370
--- /dev/null
+++ b/lam-web/developers/phpdoc/PDF/lamPDF.html
@@ -0,0 +1,1353 @@
+
+
+Docs For Class lamPDF
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
PDF

+  		  [ class tree: PDF ]
+		  [ index: PDF ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					fpdf.php
+		

+					pdf.inc
+		

+					pdfdelete.php
+		

+					pdfmain.php
+		

+					pdfpage.php
+		

+					pdfstruct.inc
+		

+					ufpdf.php
+		

+					vera.php
+		

+					verab.php
+		

+					verabi.php
+		

+					verai.php
+		

+					xml_parser.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		FPDF

+	    		lamPDF

+	    		UFPDF

+	    		xmlParser

+	  

+                		
+      

+
+
Class: lamPDF

+Source Location: /lib/pdf.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
FPDF
+   |
+   --UFPDF
+      |
+      --lamPDF


+
Creates a LAM information page in PDF format.



+
+
+
+
+
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: FPDF

+

+

+  FPDF::$AliasNbPages
+  
+

+

+   
+

+

+  FPDF::$author
+  
+

+

+   
+

+

+  FPDF::$AutoPageBreak
+  
+

+

+   
+

+

+  FPDF::$bMargin
+  
+

+

+   
+

+

+  FPDF::$buffer
+  
+

+

+   
+

+

+  FPDF::$cMargin
+  
+

+

+   
+

+

+  FPDF::$ColorFlag
+  
+

+

+   
+

+

+  FPDF::$compress
+  
+

+

+   
+

+

+  FPDF::$CoreFonts
+  
+

+

+   
+

+

+  FPDF::$creator
+  
+

+

+   
+

+

+  FPDF::$CurOrientation
+  
+

+

+   
+

+

+  FPDF::$CurrentFont
+  
+

+

+   
+

+

+  FPDF::$DefOrientation
+  
+

+

+   
+

+

+  FPDF::$diffs
+  
+

+

+   
+

+

+  FPDF::$DrawColor
+  
+

+

+   
+

+

+  FPDF::$fh
+  
+

+

+   
+

+

+  FPDF::$fhPt
+  
+

+

+   
+

+

+  FPDF::$FillColor
+  
+

+

+   
+

+

+  FPDF::$FontFamily
+  
+

+

+   
+

+

+  FPDF::$FontFiles
+  
+

+

+   
+

+

+  FPDF::$fonts
+  
+

+

+   
+

+

+  FPDF::$FontSize
+  
+

+

+   
+

+

+  FPDF::$FontSizePt
+  
+

+

+   
+

+

+  FPDF::$FontStyle
+  
+

+

+   
+

+

+  FPDF::$fw
+  
+

+

+   
+

+

+  FPDF::$fwPt
+  
+

+

+   
+

+

+  FPDF::$h
+  
+

+

+   
+

+

+  FPDF::$hPt
+  
+

+

+   
+

+

+  FPDF::$images
+  
+

+

+   
+

+

+  FPDF::$InFooter
+  
+

+

+   
+

+

+  FPDF::$k
+  
+

+

+   
+

+

+  FPDF::$keywords
+  
+

+

+   
+

+

+  FPDF::$lasth
+  
+

+

+   
+

+

+  FPDF::$LayoutMode
+  
+

+

+   
+

+

+  FPDF::$LineWidth
+  
+

+

+   
+

+

+  FPDF::$links
+  
+

+

+   
+

+

+  FPDF::$lMargin
+  
+

+

+   
+

+

+  FPDF::$n
+  
+

+

+   
+

+

+  FPDF::$offsets
+  
+

+

+   
+

+

+  FPDF::$OrientationChanges
+  
+

+

+   
+

+

+  FPDF::$page
+  
+

+

+   
+

+

+  FPDF::$PageBreakTrigger
+  
+

+

+   
+

+

+  FPDF::$PageLinks
+  
+

+

+   
+

+

+  FPDF::$pages
+  
+

+

+   
+

+

+  FPDF::$PDFVersion
+  
+

+

+   
+

+

+  FPDF::$rMargin
+  
+

+

+   
+

+

+  FPDF::$state
+  
+

+

+   
+

+

+  FPDF::$subject
+  
+

+

+   
+

+

+  FPDF::$TextColor
+  
+

+

+   
+

+

+  FPDF::$title
+  
+

+

+   
+

+

+  FPDF::$tMargin
+  
+

+

+   
+

+

+  FPDF::$underline
+  
+

+

+   
+

+

+  FPDF::$w
+  
+

+

+   
+

+

+  FPDF::$wPt
+  
+

+

+   
+

+

+  FPDF::$ws
+  
+

+

+   
+

+

+  FPDF::$x
+  
+

+

+   
+

+

+  FPDF::$y
+  
+

+

+   
+

+

+  FPDF::$ZoomMode
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: UFPDF

+

+    

+    UFPDF::UFPDF()
+
+  

+  

+    *****************************************************************************
+  

+    

+    UFPDF::AcceptPageBreak()
+
+  

+  

+    
+  

+    

+    UFPDF::AddFont()
+
+  

+  

+    
+  

+    

+    UFPDF::AliasNbPages()
+
+  

+  

+    
+  

+    

+    UFPDF::Cell()
+
+  

+  

+    
+  

+    

+    UFPDF::code2utf()
+
+  

+  

+    
+  

+    

+    UFPDF::GetStringWidth()
+
+  

+  

+    
+  

+    

+    UFPDF::MultiCell()
+
+  

+  

+    
+  

+    

+    UFPDF::strlen()
+
+  

+  

+    
+  

+    

+    UFPDF::Text()
+
+  

+  

+    
+  

+    

+    UFPDF::utf8_substr()
+
+  

+  

+    
+  

+    

+    UFPDF::utf8_to_codepoints()
+
+  

+  

+    
+  

+    

+    UFPDF::utf8_to_utf16be()
+
+  

+  

+    
+  

+    

+    UFPDF::Write()
+
+  

+  

+    
+  

+    

+    UFPDF::_dounderline()
+
+  

+  

+    
+  

+    

+    UFPDF::_escapetext()
+
+  

+  

+    
+  

+    

+    UFPDF::_putinfo()
+
+  

+  

+    
+  

+    

+    UFPDF::_putpages()
+
+  

+  

+    
+  

+    

+    UFPDF::_puttruetypeunicode()
+
+  

+  

+    *****************************************************************************
+  

+    

+    UFPDF::_textstring()
+
+  

+  

+    
+  

+  

+
Class: FPDF

+

+    

+    FPDF::FPDF()
+
+  

+  

+    *****************************************************************************
+  

+    

+    FPDF::AcceptPageBreak()
+
+  

+  

+    
+  

+    

+    FPDF::AddFont()
+
+  

+  

+    
+  

+    

+    FPDF::AddLink()
+
+  

+  

+    
+  

+    

+    FPDF::AddPage()
+
+  

+  

+    
+  

+    

+    FPDF::AliasNbPages()
+
+  

+  

+    
+  

+    

+    FPDF::Cell()
+
+  

+  

+    
+  

+    

+    FPDF::Close()
+
+  

+  

+    
+  

+    

+    FPDF::Error()
+
+  

+  

+    
+  

+    

+    FPDF::Footer()
+
+  

+  

+    
+  

+    

+    FPDF::GetStringWidth()
+
+  

+  

+    
+  

+    

+    FPDF::GetX()
+
+  

+  

+    
+  

+    

+    FPDF::GetY()
+
+  

+  

+    
+  

+    

+    FPDF::Header()
+
+  

+  

+    
+  

+    

+    FPDF::Image()
+
+  

+  

+    
+  

+    

+    FPDF::Line()
+
+  

+  

+    
+  

+    

+    FPDF::Link()
+
+  

+  

+    
+  

+    

+    FPDF::Ln()
+
+  

+  

+    
+  

+    

+    FPDF::MultiCell()
+
+  

+  

+    
+  

+    

+    FPDF::Open()
+
+  

+  

+    
+  

+    

+    FPDF::Output()
+
+  

+  

+    
+  

+    

+    FPDF::PageNo()
+
+  

+  

+    
+  

+    

+    FPDF::Rect()
+
+  

+  

+    
+  

+    

+    FPDF::SetAuthor()
+
+  

+  

+    
+  

+    

+    FPDF::SetAutoPageBreak()
+
+  

+  

+    
+  

+    

+    FPDF::SetCompression()
+
+  

+  

+    
+  

+    

+    FPDF::SetCreator()
+
+  

+  

+    
+  

+    

+    FPDF::SetDisplayMode()
+
+  

+  

+    
+  

+    

+    FPDF::SetDrawColor()
+
+  

+  

+    
+  

+    

+    FPDF::SetFillColor()
+
+  

+  

+    
+  

+    

+    FPDF::SetFont()
+
+  

+  

+    
+  

+    

+    FPDF::SetFontSize()
+
+  

+  

+    
+  

+    

+    FPDF::SetKeywords()
+
+  

+  

+    
+  

+    

+    FPDF::SetLeftMargin()
+
+  

+  

+    
+  

+    

+    FPDF::SetLineWidth()
+
+  

+  

+    
+  

+    

+    FPDF::SetLink()
+
+  

+  

+    
+  

+    

+    FPDF::SetMargins()
+
+  

+  

+    
+  

+    

+    FPDF::SetRightMargin()
+
+  

+  

+    
+  

+    

+    FPDF::SetSubject()
+
+  

+  

+    
+  

+    

+    FPDF::SetTextColor()
+
+  

+  

+    
+  

+    

+    FPDF::SetTitle()
+
+  

+  

+    
+  

+    

+    FPDF::SetTopMargin()
+
+  

+  

+    
+  

+    

+    FPDF::SetX()
+
+  

+  

+    
+  

+    

+    FPDF::SetXY()
+
+  

+  

+    
+  

+    

+    FPDF::SetY()
+
+  

+  

+    
+  

+    

+    FPDF::Text()
+
+  

+  

+    
+  

+    

+    FPDF::Write()
+
+  

+  

+    
+  

+    

+    FPDF::_beginpage()
+
+  

+  

+    
+  

+    

+    FPDF::_dochecks()
+
+  

+  

+    *****************************************************************************
+  

+    

+    FPDF::_dounderline()
+
+  

+  

+    
+  

+    

+    FPDF::_enddoc()
+
+  

+  

+    
+  

+    

+    FPDF::_endpage()
+
+  

+  

+    
+  

+    

+    FPDF::_escape()
+
+  

+  

+    
+  

+    

+    FPDF::_freadint()
+
+  

+  

+    
+  

+    

+    FPDF::_getfontpath()
+
+  

+  

+    
+  

+    

+    FPDF::_newobj()
+
+  

+  

+    
+  

+    

+    FPDF::_out()
+
+  

+  

+    
+  

+    

+    FPDF::_parsejpg()
+
+  

+  

+    
+  

+    

+    FPDF::_parsepng()
+
+  

+  

+    
+  

+    

+    FPDF::_putcatalog()
+
+  

+  

+    
+  

+    

+    FPDF::_putfonts()
+
+  

+  

+    
+  

+    

+    FPDF::_putheader()
+
+  

+  

+    
+  

+    

+    FPDF::_putimages()
+
+  

+  

+    
+  

+    

+    FPDF::_putinfo()
+
+  

+  

+    
+  

+    

+    FPDF::_putpages()
+
+  

+  

+    
+  

+    

+    FPDF::_putresourcedict()
+
+  

+  

+    
+  

+    

+    FPDF::_putresources()
+
+  

+  

+    
+  

+    

+    FPDF::_putstream()
+
+  

+  

+    
+  

+    

+    FPDF::_puttrailer()
+
+  

+  

+    
+  

+    

+    FPDF::_putxobjectdict()
+
+  

+  

+    
+  

+    

+    FPDF::_textstring()
+
+  

+  

+    
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 366]

+Creates a LAM information page in PDF format.




+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$fontList = array(

+      'BitstreamVeraSans-Roman' => array('vera.php', 'verab.php', 'verabi.php', 'verai.php'))

+	
[line 382]

+  list of supported fonts

format: <font name> => array(<file for default font style>, <file for bold>, <italic>, <bold italic>)


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$fontName = 

+	
[line 376]

+  current active font name


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$page_definitions = 

+	
[line 371]

+  format settings for page layout


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor lamPDF [line 392]

+	

+    

+    

+		lamPDF lamPDF(
+[string
+$account_type = "user"], [array
+$page_definitions = array()], mixed
+$fontName)
+    

+    


+	
+		


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
string  $account_type  
array  $page_definitions  

+    


+        
[ Top ]

+  

+  

+	
+	
method footer [line 448]

+	

+    

+    

+		void footer(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method header [line 416]

+	

+    

+    

+		void header(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:55 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/PDF/xmlParser.html b/lam-web/developers/phpdoc/PDF/xmlParser.html
new file mode 100644
index 00000000..2214398d
--- /dev/null
+++ b/lam-web/developers/phpdoc/PDF/xmlParser.html
@@ -0,0 +1,241 @@
+
+
+Docs For Class xmlParser
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
PDF

+  		  [ class tree: PDF ]
+		  [ index: PDF ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					fpdf.php
+		

+					pdf.inc
+		

+					pdfdelete.php
+		

+					pdfmain.php
+		

+					pdfpage.php
+		

+					pdfstruct.inc
+		

+					ufpdf.php
+		

+					vera.php
+		

+					verab.php
+		

+					verabi.php
+		

+					verai.php
+		

+					xml_parser.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		FPDF

+	    		lamPDF

+	    		UFPDF

+	    		xmlParser

+	  

+                		
+      

+
+
Class: xmlParser

+Source Location: /lib/xml_parser.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+


+



+
Author(s):

+
    
+          
  • Michael Duergner
    • 
+      

+
+
+
+
+    
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+

+

+
+
+
Class Details

+

+[line 36]

+


+
Tags:

+

+
+  
+    
+  
+
author:  Michael Duergner

+

+



+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$xmlParser = 

+	
[line 41]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor xmlParser [line 46]

+	

+    

+    

+		xmlParser xmlParser(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method parse [line 60]

+	

+    

+    

+		array parse(
+string
+$filename)
+    

+    


+	
+		


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $filename  

+    


+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:13 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/classtrees_Help.html b/lam-web/developers/phpdoc/classtrees_Help.html
new file mode 100644
index 00000000..5dd5c5e7
--- /dev/null
+++ b/lam-web/developers/phpdoc/classtrees_Help.html
@@ -0,0 +1,60 @@
+
+
+Class Trees for Package Help
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
Help

+  		  [ class tree: Help ]
+		  [ index: Help ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                		
+      

+
+
Class Trees for Package Help

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/classtrees_LDAP.html b/lam-web/developers/phpdoc/classtrees_LDAP.html
new file mode 100644
index 00000000..8b8870a6
--- /dev/null
+++ b/lam-web/developers/phpdoc/classtrees_LDAP.html
@@ -0,0 +1,65 @@
+
+
+Class Trees for Package LDAP
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
LDAP

+  		  [ class tree: LDAP ]
+		  [ index: LDAP ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                		
+      

+
+
Class Trees for Package LDAP

+

+
Root class Ldap


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/classtrees_PDF.html b/lam-web/developers/phpdoc/classtrees_PDF.html
new file mode 100644
index 00000000..8d207b85
--- /dev/null
+++ b/lam-web/developers/phpdoc/classtrees_PDF.html
@@ -0,0 +1,74 @@
+
+
+Class Trees for Package PDF
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
PDF

+  		  [ class tree: PDF ]
+		  [ index: PDF ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                		
+      

+
+
Class Trees for Package PDF

+

+
Root class FPDF


+
+
+

+
Root class xmlParser


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/classtrees_configuration.html b/lam-web/developers/phpdoc/classtrees_configuration.html
new file mode 100644
index 00000000..30555070
--- /dev/null
+++ b/lam-web/developers/phpdoc/classtrees_configuration.html
@@ -0,0 +1,70 @@
+
+
+Class Trees for Package configuration
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
configuration

+  		  [ class tree: configuration ]
+		  [ index: configuration ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                		
+      

+
+
Class Trees for Package configuration

+

+
Root class LAMCfgMain


+
+
+

+
Root class LAMConfig


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/classtrees_lib.html b/lam-web/developers/phpdoc/classtrees_lib.html
new file mode 100644
index 00000000..4ea537bb
--- /dev/null
+++ b/lam-web/developers/phpdoc/classtrees_lib.html
@@ -0,0 +1,77 @@
+
+
+Class Trees for Package lib
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lib

+  		  [ class tree: lib ]
+		  [ index: lib ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                		
+      

+
+
Class Trees for Package lib

+

+
Root class cache


+
+
+

+
Root class ObjectClassAttribute


+
+
+

+
Root class SchemaItem


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/classtrees_lists.html b/lam-web/developers/phpdoc/classtrees_lists.html
new file mode 100644
index 00000000..ac297878
--- /dev/null
+++ b/lam-web/developers/phpdoc/classtrees_lists.html
@@ -0,0 +1,67 @@
+
+
+Class Trees for Package lists
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                		
+      

+
+
Class Trees for Package lists

+

+
Root class lamList


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/classtrees_main.html b/lam-web/developers/phpdoc/classtrees_main.html
new file mode 100644
index 00000000..cc8fa8fe
--- /dev/null
+++ b/lam-web/developers/phpdoc/classtrees_main.html
@@ -0,0 +1,60 @@
+
+
+Class Trees for Package main
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
main

+  		  [ class tree: main ]
+		  [ index: main ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                		
+      

+
+
Class Trees for Package main

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/classtrees_modules.html b/lam-web/developers/phpdoc/classtrees_modules.html
new file mode 100644
index 00000000..61f09a6d
--- /dev/null
+++ b/lam-web/developers/phpdoc/classtrees_modules.html
@@ -0,0 +1,82 @@
+
+
+Class Trees for Package modules
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                		
+      

+
+
Class Trees for Package modules

+

+
Root class accountContainer


+
+
+

+
Root class baseModule


+
+
+

+
Root class samba3domain


+
+
+

+
Root class smbHash


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/classtrees_profiles.html b/lam-web/developers/phpdoc/classtrees_profiles.html
new file mode 100644
index 00000000..01b3c277
--- /dev/null
+++ b/lam-web/developers/phpdoc/classtrees_profiles.html
@@ -0,0 +1,60 @@
+
+
+Class Trees for Package profiles
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
profiles

+  		  [ class tree: profiles ]
+		  [ index: profiles ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                		
+      

+
+
Class Trees for Package profiles

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/classtrees_selfService.html b/lam-web/developers/phpdoc/classtrees_selfService.html
new file mode 100644
index 00000000..72e4e7bf
--- /dev/null
+++ b/lam-web/developers/phpdoc/classtrees_selfService.html
@@ -0,0 +1,65 @@
+
+
+Class Trees for Package selfService
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
selfService

+  		  [ class tree: selfService ]
+		  [ index: selfService ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                		
+      

+
+
Class Trees for Package selfService

+

+
Root class selfServiceProfile


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/classtrees_tests.html b/lam-web/developers/phpdoc/classtrees_tests.html
new file mode 100644
index 00000000..8d831d33
--- /dev/null
+++ b/lam-web/developers/phpdoc/classtrees_tests.html
@@ -0,0 +1,60 @@
+
+
+Class Trees for Package tests
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
tests

+  		  [ class tree: tests ]
+		  [ index: tests ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                		
+      

+
+
Class Trees for Package tests

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/classtrees_tools.html b/lam-web/developers/phpdoc/classtrees_tools.html
new file mode 100644
index 00000000..e08cb3b8
--- /dev/null
+++ b/lam-web/developers/phpdoc/classtrees_tools.html
@@ -0,0 +1,74 @@
+
+
+Class Trees for Package tools
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
tools

+  		  [ class tree: tools ]
+		  [ index: tools ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                		
+      

+
+
Class Trees for Package tools

+

+
Root class LdapExportInfo


+
+
+

+
Root class PlaAbstractExporter


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/classtrees_types.html b/lam-web/developers/phpdoc/classtrees_types.html
new file mode 100644
index 00000000..eddd9fd0
--- /dev/null
+++ b/lam-web/developers/phpdoc/classtrees_types.html
@@ -0,0 +1,67 @@
+
+
+Class Trees for Package types
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
types

+  		  [ class tree: types ]
+		  [ index: types ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                		
+      

+
+
Class Trees for Package types

+

+
Root class baseType


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/configuration/LAMConfig.html b/lam-web/developers/phpdoc/configuration/LAMConfig.html
new file mode 100644
index 00000000..7353f6d2
--- /dev/null
+++ b/lam-web/developers/phpdoc/configuration/LAMConfig.html
@@ -0,0 +1,1494 @@
+
+
+Docs For Class LAMConfig
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
configuration

+  		  [ class tree: configuration ]
+		  [ index: configuration ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					config.inc
+		

+					conflogin.php
+		

+					confmain.php
+		

+					confmodules.php
+		

+					conftypes.php
+		

+					index.php
+		

+					mainlogin.php
+		

+					mainmanage.php
+		

+					profmanage.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LAMCfgMain

+	    		LAMConfig

+	  

+                		
+      

+
+
Class: LAMConfig

+Source Location: /lib/config.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+


+
This class manages .conf files.



+
+
+
+
+
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+

+

+
+
+
Class Details

+

+[line 123]

+This class manages .conf files.




+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$activeTypes =  "user,group,host,smbDomain"

+	
[line 169]

+  Active account types


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$Admins = 

+	
[line 129]

+  Array of string: users with admin rights


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$cachetimeout = 

+	
[line 166]

+  LDAP cache timeout


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$defaultLanguage = 

+	
[line 141]

+  Default language


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$file = 

+	
[line 172]

+  Name of configuration file


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$maxlistentries = 

+	
[line 138]

+  Maximum number of rows shown in user/group/host lists


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$moduleSettings = array()

+	
[line 144]

+  module settings


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$Passwd = 

+	
[line 132]

+  Password to edit preferences


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$scriptPath = 

+	
[line 155]

+  Path to external lamdaemon script on server where it is executed

This is used for managing quota and home directories.  optional setting, may not be defined


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$scriptServer = 

+	
[line 163]

+  Server where lamdaemon script is executed

This is used for managing quota and home directories.  optional setting, may not be defined


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$ServerURL = 

+	
[line 126]

+  Server address (e.g. ldap://127.0.0.1:389)


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$settings = array("ServerURL", "Passwd", "Admins", "treesuffix", "maxlistentries",

+      "defaultLanguage", "scriptPath", "scriptServer", "cachetimeout",

+      "modules", "activeTypes", "types")

+	
[line 175]

+  List of all settings in config file


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$treesuffix = 

+	
[line 135]

+  LDAP suffix for tree view


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$typeSettings = array()

+	
[line 147]

+  type settings


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor LAMConfig [line 185]

+	

+    

+    

+		LAMConfig LAMConfig(
+[integer
+$file = 0])
+    

+    


+	
+		Loads preferences from config file




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
integer  $file  Index number in config file array

+    


+        
[ Top ]

+  

+  

+	
+	
method get_AccountModules [line 615]

+	

+    

+    

+		array get_AccountModules(
+string
+$scope)
+    

+    


+	
+		Returns an array of all selected account modules




+
Tags:

+

+
+  
+    
+  
+
return:  user modules

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $scope  account type

+    


+        
[ Top ]

+  

+  

+	
+	
method get_ActiveTypes [line 671]

+	

+    

+    

+		array get_ActiveTypes(
+)
+    

+    


+	
+		Returns a list of active account types.




+
Tags:

+

+
+  
+    
+  
+
return:  list of types

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_Admins [line 376]

+	

+    

+    

+		array get_Admins(
+)
+    

+    


+	
+		Returns an array of string with all admin names




+
Tags:

+

+
+  
+    
+  
+
return:  the admin names

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_Adminstring [line 385]

+	

+    

+    

+		string get_Adminstring(
+)
+    

+    


+	
+		Returns all admin users seperated by semicolons




+
Tags:

+

+
+  
+    
+  
+
return:  the admin string

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_cacheTimeout [line 581]

+	

+    

+    

+		integer get_cacheTimeout(
+)
+    

+    


+	
+		Returns the LDAP cache timeout in minutes




+
Tags:

+

+
+  
+    
+  
+
return:  cache time

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_cacheTimeoutSec [line 591]

+	

+    

+    

+		integer get_cacheTimeoutSec(
+)
+    

+    


+	
+		Returns the LDAP cache timeout in seconds




+
Tags:

+

+
+  
+    
+  
+
return:  cache time

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_defaultLanguage [line 514]

+	

+    

+    

+		string get_defaultLanguage(
+)
+    

+    


+	
+		Returns the default language string




+
Tags:

+

+
+  
+    
+  
+
return:  default language

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_listAttributes [line 467]

+	

+    

+    

+		string get_listAttributes(
+string
+$scope)
+    

+    


+	
+		Returns the list of attributes to show in user list




+
Tags:

+

+
+  
+    
+  
+
return:  the attribute list

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $scope  account type

+    


+        
[ Top ]

+  

+  

+	
+	
method get_MaxListEntries [line 493]

+	

+    

+    

+		integer get_MaxListEntries(
+)
+    

+    


+	
+		Returns the maximum number of rows in user/group/host lists




+
Tags:

+

+
+  
+    
+  
+
return:  maximum number

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_moduleSettings [line 662]

+	

+    

+    

+		array get_moduleSettings(
+)
+    

+    


+	
+		Returns a list of saved module settings




+
Tags:

+

+
+  
+    
+  
+
return:  list of settings: array(name => value)

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_Passwd [line 409]

+	

+    

+    

+		string get_Passwd(
+)
+    

+    


+	
+		Returns the password to access the preferences wizard




+
Tags:

+

+
+  
+    
+  
+
return:  the password

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_scriptPath [line 535]

+	

+    

+    

+		string get_scriptPath(
+)
+    

+    


+	
+		Returns the path to the external script




+
Tags:

+

+
+  
+    
+  
+
return:  script path

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_scriptServer [line 557]

+	

+    

+    

+		string get_scriptServer(
+)
+    

+    


+	
+		Returns the server of the external script




+
Tags:

+

+
+  
+    
+  
+
return:  script server

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_ServerURL [line 355]

+	

+    

+    

+		string get_ServerURL(
+)
+    

+    


+	
+		Returns the server address as string




+
Tags:

+

+
+  
+    
+  
+
return:  server address

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_Suffix [line 431]

+	

+    

+    

+		string get_Suffix(
+string
+$scope)
+    

+    


+	
+		Returns the LDAP suffix for the given account type




+
Tags:

+

+
+  
+    
+  
+
return:  the LDAP suffix

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $scope  account type

+    


+        
[ Top ]

+  

+  

+	
+	
method get_typeSettings [line 702]

+	

+    

+    

+		array get_typeSettings(
+)
+    

+    


+	
+		Returns a list of saved type settings




+
Tags:

+

+
+  
+    
+  
+
return:  list of settings: array(name => value)

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method reload [line 200]

+	

+    

+    

+		boolean reload(
+)
+    

+    


+	
+		Reloads preferences from config file




+
Tags:

+

+
+  
+    
+  
+
return:  true if file was readable

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method save [line 258]

+	

+    

+    

+		void save(
+)
+    

+    


+	
+		Saves preferences to config file




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method set_AccountModules [line 631]

+	

+    

+    

+		boolean set_AccountModules(
+array
+$modules, string
+$scope)
+    

+    


+	
+		Sets the selected account modules




+
Tags:

+

+
+  
+    
+  
+
return:  true if $modules has correct format

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $modules  array with module names (not aliases!)
string  $scope  account type

+    


+        
[ Top ]

+  

+  

+	
+	
method set_ActiveTypes [line 681]

+	

+    

+    

+		void set_ActiveTypes(
+array
+$types)
+    

+    


+	
+		Sets the list of active types.




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
array  $types  list of types

+    


+        
[ Top ]

+  

+  

+	
+	
method set_Adminstring [line 395]

+	

+    

+    

+		boolean set_Adminstring(
+string
+$value)
+    

+    


+	
+		Sets the admin string




+
Tags:

+

+
+  
+    
+  
+
return:  true if $value has correct format

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $value  new admin string that contains all admin users seperated by semicolons

+    


+        
[ Top ]

+  

+  

+	
+	
method set_cacheTimeout [line 601]

+	

+    

+    

+		boolean set_cacheTimeout(
+integer
+$value)
+    

+    


+	
+		Sets the LDAP cache timeout in minutes (0,1,2,5,10,15)




+
Tags:

+

+
+  
+    
+  
+
return:  true if $value has correct format

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
integer  $value  new cache timeout

+    


+        
[ Top ]

+  

+  

+	
+	
method set_defaultLanguage [line 524]

+	

+    

+    

+		boolean set_defaultLanguage(
+string
+$value)
+    

+    


+	
+		Sets the default language string




+
Tags:

+

+
+  
+    
+  
+
return:  true if $value has correct format

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $value  new default language

+    


+        
[ Top ]

+  

+  

+	
+	
method set_listAttributes [line 478]

+	

+    

+    

+		boolean set_listAttributes(
+string
+$value, string
+$scope)
+    

+    


+	
+		Sets the list of attributes to show in user list




+
Tags:

+

+
+  
+    
+  
+
return:  true if $value has correct format

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
string  $value  new attribute string
string  $scope  account type

+    


+        
[ Top ]

+  

+  

+	
+	
method set_MaxListEntries [line 503]

+	

+    

+    

+		boolean set_MaxListEntries(
+integer
+$value)
+    

+    


+	
+		Sets the maximum number of rows in user/group/host lists




+
Tags:

+

+
+  
+    
+  
+
return:  true if $value has correct format

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
integer  $value  new maximum value

+    


+        
[ Top ]

+  

+  

+	
+	
method set_moduleSettings [line 651]

+	

+    

+    

+		boolean set_moduleSettings(
+array
+$settings)
+    

+    


+	
+		Sets the settings for the account modules.




+
Tags:

+

+
+  
+    
+  
+
return:  true if $settings has correct format

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
array  $settings  list of module setting array(name => value)

+    


+        
[ Top ]

+  

+  

+	
+	
method set_Passwd [line 419]

+	

+    

+    

+		boolean set_Passwd(
+string
+$value)
+    

+    


+	
+		Sets the preferences wizard password




+
Tags:

+

+
+  
+    
+  
+
return:  true if $value has correct format

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $value  new password

+    


+        
[ Top ]

+  

+  

+	
+	
method set_scriptPath [line 545]

+	

+    

+    

+		boolean set_scriptPath(
+string
+$value)
+    

+    


+	
+		Sets the path to the external script




+
Tags:

+

+
+  
+    
+  
+
return:  true if $value has correct format

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $value  new script path

+    


+        
[ Top ]

+  

+  

+	
+	
method set_scriptServer [line 567]

+	

+    

+    

+		boolean set_scriptServer(
+string
+$value)
+    

+    


+	
+		Sets the server of the external script




+
Tags:

+

+
+  
+    
+  
+
return:  true if $value has correct format

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $value  new script server

+    


+        
[ Top ]

+  

+  

+	
+	
method set_ServerURL [line 365]

+	

+    

+    

+		boolean set_ServerURL(
+string
+$value)
+    

+    


+	
+		Sets the server address




+
Tags:

+

+
+  
+    
+  
+
return:  true if $value has correct format

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $value  new server address

+    


+        
[ Top ]

+  

+  

+	
+	
method set_Suffix [line 447]

+	

+    

+    

+		boolean set_Suffix(
+string
+$scope, string
+$value)
+    

+    


+	
+		Sets the LDAP suffix where accounts are saved




+
Tags:

+

+
+  
+    
+  
+
return:  true if $value has correct format

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
string  $scope  account type
string  $value  new LDAP suffix

+    


+        
[ Top ]

+  

+  

+	
+	
method set_typeSettings [line 691]

+	

+    

+    

+		boolean set_typeSettings(
+array
+$settings)
+    

+    


+	
+		Sets the settings for the account types.




+
Tags:

+

+
+  
+    
+  
+
return:  true if $settings has correct format

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
array  $settings  list of type setting array(name => value)

+    


+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:39 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/configuration/_lib_config_inc.html b/lam-web/developers/phpdoc/configuration/_lib_config_inc.html
new file mode 100644
index 00000000..cbb56287
--- /dev/null
+++ b/lam-web/developers/phpdoc/configuration/_lib_config_inc.html
@@ -0,0 +1,212 @@
+
+
+Docs for page config.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
configuration

+  		  [ class tree: configuration ]
+		  [ index: configuration ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					config.inc
+		

+					conflogin.php
+		

+					confmain.php
+		

+					confmodules.php
+		

+					conftypes.php
+		

+					index.php
+		

+					mainlogin.php
+		

+					mainmanage.php
+		

+					profmanage.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LAMCfgMain

+	    		LAMConfig

+	  

+                		
+      

+
+
Procedural File: config.inc

+Source Location: /lib/config.inc


+
+

+

+
+

+
Classes:

+
LAMConfig

+	
This class manages .conf files.

+
LAMCfgMain

+	
This class manages config.cfg.

+



+
+
Page Details:

+This file includes functions to manage the configuration files.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once("modules.inc") [line 35]

+Used to get module information.

include_once("status.inc") [line 33]

+Used to print messages.

include_once("types.inc") [line 37]

+Used to get type information.


+


+


+

+  

+	
+	
getConfigProfiles [line 61]

+	

+    

+    

+		array getConfigProfiles(
+)
+    

+    


+
+		Returns an array of string with all available configuration profiles (without .conf)




+
Tags:

+

+
+  
+    
+  
+
return:  profile names

+

+    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
LAMVersion [line 85]

+	

+    

+    

+		string LAMVersion(
+)
+    

+    


+
+		Returns the version number of this LAM installation.

Format: <major version>.<minor version>.<patch level>  
 Major/minor version are always numbers, patch level may contain letters for inofficial releases only (e.g. 0.5.alpha1).




+
Tags:

+

+
+  
+    
+  
+
return:  version number

+

+    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
metaRefresh [line 103]

+	

+    

+    

+		void metaRefresh(
+string $page)
+    

+    


+
+		Prints a meta refresh page

    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $page  the URL of the target page

+    	
[ Top ]



+	

+  

+	
+	
setlanguage [line 42]

+	

+    

+    

+		void setlanguage(
+)
+    

+    


+
+		Sets language settings for automatic translation

    


+	
+
+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:39 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/configuration/_templates_config_conflogin_php.html b/lam-web/developers/phpdoc/configuration/_templates_config_conflogin_php.html
new file mode 100644
index 00000000..a15221bf
--- /dev/null
+++ b/lam-web/developers/phpdoc/configuration/_templates_config_conflogin_php.html
@@ -0,0 +1,114 @@
+
+
+Docs for page conflogin.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
configuration

+  		  [ class tree: configuration ]
+		  [ index: configuration ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					config.inc
+		

+					conflogin.php
+		

+					confmain.php
+		

+					confmodules.php
+		

+					conftypes.php
+		

+					index.php
+		

+					mainlogin.php
+		

+					mainmanage.php
+		

+					profmanage.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LAMCfgMain

+	    		LAMConfig

+	  

+                		
+      

+
+
Procedural File: conflogin.php

+Source Location: /templates/config/conflogin.php


+
+

+

+
+
+
Page Details:

+Login page to change the preferences.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once('../../lib/config.inc') [line 34]

+Access to config functions

include_once('../../lib/status.inc') [line 36]

+Used to print status messages


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:40 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/configuration/_templates_config_confmain_php.html b/lam-web/developers/phpdoc/configuration/_templates_config_confmain_php.html
new file mode 100644
index 00000000..7fc87772
--- /dev/null
+++ b/lam-web/developers/phpdoc/configuration/_templates_config_confmain_php.html
@@ -0,0 +1,132 @@
+
+
+Docs for page confmain.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
configuration

+  		  [ class tree: configuration ]
+		  [ index: configuration ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					config.inc
+		

+					conflogin.php
+		

+					confmain.php
+		

+					confmodules.php
+		

+					conftypes.php
+		

+					index.php
+		

+					mainlogin.php
+		

+					mainmanage.php
+		

+					profmanage.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LAMCfgMain

+	    		LAMConfig

+	  

+                		
+      

+
+
Procedural File: confmain.php

+Source Location: /templates/config/confmain.php


+
+

+

+
+
+
Page Details:

+Main page of configuration




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once("../../lib/config.inc") [line 34]

+Access to config functions

include_once("../../lib/modules.inc") [line 37]

+access to module settings

require('conflogin.php') [line 72]

+go back to login if password is invalid

require('conflogin.php') [line 54]

+go back to login if password is empty


+


+


+

+  

+	
+	
saveSettings [line 411]

+	

+    

+    

+		void saveSettings(
+)
+    

+    


+
+		Saves the entered settings.

    


+	
+
+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:40 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/configuration/_templates_config_confmodules_php.html b/lam-web/developers/phpdoc/configuration/_templates_config_confmodules_php.html
new file mode 100644
index 00000000..8b301121
--- /dev/null
+++ b/lam-web/developers/phpdoc/configuration/_templates_config_confmodules_php.html
@@ -0,0 +1,153 @@
+
+
+Docs for page confmodules.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
configuration

+  		  [ class tree: configuration ]
+		  [ index: configuration ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					config.inc
+		

+					conflogin.php
+		

+					confmain.php
+		

+					confmodules.php
+		

+					conftypes.php
+		

+					index.php
+		

+					mainlogin.php
+		

+					mainmanage.php
+		

+					profmanage.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LAMCfgMain

+	    		LAMConfig

+	  

+                		
+      

+
+
Procedural File: confmodules.php

+Source Location: /templates/config/confmodules.php


+
+

+

+
+
+
Page Details:

+confmodules lets the user select the account modules




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once('../../lib/config.inc') [line 34]

+Access to config functions

include_once('../../lib/modules.inc') [line 36]

+Access to module lists

require('conflogin.php') [line 49]

+go back to login if password is invalid


+


+


+

+  

+	
+	
config_showAccountModules [line 138]

+	

+    

+    

+		boolean config_showAccountModules(
+string $scope, string $title)
+    

+    


+
+		Displays the module selection boxes and checks if dependencies are fulfilled.




+
Tags:

+

+
+  
+    
+  
+
return:  true if all dependencies are ok

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $scope  account type
string  $title  title for module selection (e.g. "User modules")

+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:40 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/configuration/_templates_config_conftypes_php.html b/lam-web/developers/phpdoc/configuration/_templates_config_conftypes_php.html
new file mode 100644
index 00000000..086d9e71
--- /dev/null
+++ b/lam-web/developers/phpdoc/configuration/_templates_config_conftypes_php.html
@@ -0,0 +1,115 @@
+
+
+Docs for page conftypes.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
configuration

+  		  [ class tree: configuration ]
+		  [ index: configuration ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					config.inc
+		

+					conflogin.php
+		

+					confmain.php
+		

+					confmodules.php
+		

+					conftypes.php
+		

+					index.php
+		

+					mainlogin.php
+		

+					mainmanage.php
+		

+					profmanage.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LAMCfgMain

+	    		LAMConfig

+	  

+                		
+      

+
+
Procedural File: conftypes.php

+Source Location: /templates/config/conftypes.php


+
+

+

+
+
+
Page Details:

+Here the user can select the account types.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once('../../lib/config.inc') [line 34]

+Access to config functions

include_once('../../lib/types.inc') [line 36]

+Access to account types

require('conflogin.php') [line 48]

+go back to login if password is invalid


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:40 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/configuration/_templates_config_index_php.html b/lam-web/developers/phpdoc/configuration/_templates_config_index_php.html
new file mode 100644
index 00000000..aaf69ee5
--- /dev/null
+++ b/lam-web/developers/phpdoc/configuration/_templates_config_index_php.html
@@ -0,0 +1,113 @@
+
+
+Docs for page index.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
configuration

+  		  [ class tree: configuration ]
+		  [ index: configuration ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					config.inc
+		

+					conflogin.php
+		

+					confmain.php
+		

+					confmodules.php
+		

+					conftypes.php
+		

+					index.php
+		

+					mainlogin.php
+		

+					mainmanage.php
+		

+					profmanage.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LAMCfgMain

+	    		LAMConfig

+	  

+                		
+      

+
+
Procedural File: index.php

+Source Location: /templates/config/index.php


+
+

+

+
+
+
Page Details:

+Displays links to all configuration pages.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once('../../lib/config.inc') [line 34]

+Access to config functions


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:47 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/configuration/_templates_config_mainlogin_php.html b/lam-web/developers/phpdoc/configuration/_templates_config_mainlogin_php.html
new file mode 100644
index 00000000..82824553
--- /dev/null
+++ b/lam-web/developers/phpdoc/configuration/_templates_config_mainlogin_php.html
@@ -0,0 +1,114 @@
+
+
+Docs for page mainlogin.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
configuration

+  		  [ class tree: configuration ]
+		  [ index: configuration ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					config.inc
+		

+					conflogin.php
+		

+					confmain.php
+		

+					confmodules.php
+		

+					conftypes.php
+		

+					index.php
+		

+					mainlogin.php
+		

+					mainmanage.php
+		

+					profmanage.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LAMCfgMain

+	    		LAMConfig

+	  

+                		
+      

+
+
Procedural File: mainlogin.php

+Source Location: /templates/config/mainlogin.php


+
+

+

+
+
+
Page Details:

+Login page to change the main preferences.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once('../../lib/config.inc') [line 34]

+Access to config functions

include_once('../../lib/status.inc') [line 36]

+Used to print status messages


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:53 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/configuration/_templates_config_mainmanage_php.html b/lam-web/developers/phpdoc/configuration/_templates_config_mainmanage_php.html
new file mode 100644
index 00000000..35fd990d
--- /dev/null
+++ b/lam-web/developers/phpdoc/configuration/_templates_config_mainmanage_php.html
@@ -0,0 +1,115 @@
+
+
+Docs for page mainmanage.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
configuration

+  		  [ class tree: configuration ]
+		  [ index: configuration ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					config.inc
+		

+					conflogin.php
+		

+					confmain.php
+		

+					confmodules.php
+		

+					conftypes.php
+		

+					index.php
+		

+					mainlogin.php
+		

+					mainmanage.php
+		

+					profmanage.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LAMCfgMain

+	    		LAMConfig

+	  

+                		
+      

+
+
Procedural File: mainmanage.php

+Source Location: /templates/config/mainmanage.php


+
+

+

+
+
+
Page Details:

+Manages the main configuration options.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once('../../lib/config.inc') [line 34]

+Access to config functions

include_once('../../lib/status.inc') [line 36]

+Used to print status messages

require('mainlogin.php') [line 48]

+

+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:53 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/configuration/_templates_config_profmanage_php.html b/lam-web/developers/phpdoc/configuration/_templates_config_profmanage_php.html
new file mode 100644
index 00000000..34215a20
--- /dev/null
+++ b/lam-web/developers/phpdoc/configuration/_templates_config_profmanage_php.html
@@ -0,0 +1,114 @@
+
+
+Docs for page profmanage.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
configuration

+  		  [ class tree: configuration ]
+		  [ index: configuration ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					config.inc
+		

+					conflogin.php
+		

+					confmain.php
+		

+					confmodules.php
+		

+					conftypes.php
+		

+					index.php
+		

+					mainlogin.php
+		

+					mainmanage.php
+		

+					profmanage.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LAMCfgMain

+	    		LAMConfig

+	  

+                		
+      

+
+
Procedural File: profmanage.php

+Source Location: /templates/config/profmanage.php


+
+

+

+
+
+
Page Details:

+Configuration profile management.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once('../../lib/config.inc') [line 34]

+Access to config functions

include_once('../../lib/status.inc') [line 36]

+Used to print status messages


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:00 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/elementindex.html b/lam-web/developers/phpdoc/elementindex.html
new file mode 100644
index 00000000..da589f86
--- /dev/null
+++ b/lam-web/developers/phpdoc/elementindex.html
@@ -0,0 +1,2504 @@
+
+
+Element Index
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
profiles

+  		  [ class tree: profiles ]
+		  [ index: profiles ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              PDF

+              lists

+              profiles

+              LDAP

+              types

+              lib

+              modules

+              selfService

+              configuration

+              tools

+              Help

+              tests

+              main

+            


+                		
+      

+
+
+
Index of all elements

+	[ a ]
+	[ b ]
+	[ c ]
+	[ d ]
+	[ e ]
+	[ f ]
+	[ g ]
+	[ h ]
+	[ i ]
+	[ k ]
+	[ l ]
+	[ m ]
+	[ n ]
+	[ o ]
+	[ p ]
+	[ q ]
+	[ r ]
+	[ s ]
+	[ t ]
+	[ u ]
+	[ v ]
+	[ w ]
+	[ x ]
+	[ y ]
+	[ z ]
+	[ _ ]
+
+  

+	
+	

+		
a

+		

+							
$activeTypes

+				
in file config.inc, variable LAMConfig::$activeTypes
    Active account types

+							
$Admins

+				
in file config.inc, variable LAMConfig::$Admins
    Array of string: users with admin rights

+							
$aliases

+				
in file schema.inc, variable AttributeType::$aliases
    An array of alias attribute names, strings

+							
$AliasNbPages

+				
in file fpdf.php, variable FPDF::$AliasNbPages

+							
$allowedHosts

+				
in file config.inc, variable LAMCfgMain::$allowedHosts
    list of hosts which may access LAM

+							
$attrArray

+				
in file lists.inc, variable lamList::$attrArray
    list of LDAP attributes

+							
$attributes

+				
in file cache.inc, variable cache::$attributes
    This variable contains a list and their scope of attributes which should be cached

+							
$attributes

+				
in file export.inc, variable PlaLdapExporter::$attributes

+							
$attributes

+				
in file baseModule.inc, variable baseModule::$attributes
    contains all ldap attributes which should be written

+							
$attributes

+				
in file ldap.inc, variable Ldap::$attributes
    Array with all attribute strings from the LDAP server

+							
$attributes

+				
in file modules.inc, variable accountContainer::$attributes
    Array of all used attributes

+							
$attributes_orig

+				
in file modules.inc, variable accountContainer::$attributes_orig
    original LDAP attributes when account was loaded from LDAP

+							
$author

+				
in file fpdf.php, variable FPDF::$author

+							
$AutoPageBreak

+				
in file fpdf.php, variable FPDF::$AutoPageBreak

+							
AcceptPageBreak

+				
in file fpdf.php, method FPDF::AcceptPageBreak()

+							
AcceptPageBreak

+				
in file ufpdf.php, method UFPDF::AcceptPageBreak()

+							
account

+				
in file account.inc, class account
    Manages the object class "account" for users and hosts.

+							
accountContainer

+				
in file modules.inc, method accountContainer::accountContainer()
    Constructor

+							
accountContainer

+				
in file modules.inc, class accountContainer
    This class includes all modules and attributes of an account.

+							
addAlias

+				
in file schema.inc, method AttributeType::addAlias()
    Adds an attribute name to the alias array.

+							
addChildObjectClass

+				
in file schema.inc, method ObjectClass::addChildObjectClass()
    Adds an objectClass to the list of objectClasses that inherit  from this objectClass.

+							
AddFont

+				
in file fpdf.php, method FPDF::AddFont()

+							
AddFont

+				
in file ufpdf.php, method UFPDF::AddFont()

+							
AddLink

+				
in file fpdf.php, method FPDF::AddLink()

+							
addMayAttrs

+				
in file schema.inc, method ObjectClass::addMayAttrs()
    Behaves identically to addMustAttrs, but it operates on the MAY  attributes of this objectClass.

+							
addMustAttrs

+				
in file schema.inc, method ObjectClass::addMustAttrs()
    Adds the specified array of attributes to this objectClass' list of  MUST attributes. The resulting array of must attributes will contain  unique members.

+							
AddPage

+				
in file fpdf.php, method FPDF::AddPage()

+							
addRequiredByObjectClass

+				
in file schema.inc, method AttributeType::addRequiredByObjectClass()
    Adds an objectClass name to this attribute's list of "required by" objectClasses,  that is the list of objectClasses which must have this attribute.

+							
addUsedByAttr

+				
in file schema.inc, method MatchingRule::addUsedByAttr()
    Adds an attribute name to the list of attributes who use this MatchingRule

+							
addUsedInObjectClass

+				
in file schema.inc, method AttributeType::addUsedInObjectClass()
    Adds an objectClass name to this attribute's list of "used in" objectClasses,  that is the list of objectClasses which provide this attribute.

+							
add_aliases_to_attrs

+				
in file schema.inc, function add_aliases_to_attrs()
    For each attribute that has multiple names, this function adds unique entries to  the attrs array for those names. Ie, attributeType has name 'gn' and 'givenName'.

+							
add_cache

+				
in file cache.inc, method cache::add_cache()
    This function adds attributes to the cache.

+							
add_sup_to_attrs

+				
in file schema.inc, function add_sup_to_attrs()
    Adds inherited values to each attributeType specified by the SUP directive.

+							
AliasNbPages

+				
in file ufpdf.php, method UFPDF::AliasNbPages()

+							
AliasNbPages

+				
in file fpdf.php, method FPDF::AliasNbPages()

+							
arrayLower

+				
in file tree.inc, function arrayLower()

+							
array_delete

+				
in file account.inc, function array_delete()
    This function will return all values from $array without values of $values.

+							
AttributeType

+				
in file schema.inc, class AttributeType
    Represents an LDAP AttributeType

+							
AttributeType

+				
in file schema.inc, method AttributeType::AttributeType()
    Creates a new AttributeType objcet from a raw LDAP AttributeType string.

+							
account.inc

+				
procedural page account.inc

+							
account.inc

+				
procedural page account.inc

+							
adminLogin.php

+				
procedural page adminLogin.php

+							
adminMain.php

+				
procedural page adminMain.php

+							
add_attr_form.php

+				
procedural page add_attr_form.php

+							
add_attr.php

+				
procedural page add_attr.php

+							
add_oclass_form.php

+				
procedural page add_oclass_form.php

+							
add_oclass.php

+				
procedural page add_oclass.php

+							
add_value_form.php

+				
procedural page add_value_form.php

+							
add_value.php

+				
procedural page add_value.php

+					

+	

+	top

+  

+	
+	

+		
b

+		

+							
$base

+				
in file baseModule.inc, variable baseModule::$base
    name of parent accountContainer ($_SESSION[$base])

+							
$base

+				
in file modules.inc, variable accountContainer::$base
    Name of accountContainer variable in session

+							
$base_dn

+				
in file export.inc, variable LdapExportInfo::$base_dn

+							
$bMargin

+				
in file fpdf.php, variable FPDF::$bMargin

+							
$br

+				
in file export.inc, variable PlaExporter::$br

+							
$buffer

+				
in file fpdf.php, variable FPDF::$buffer

+							
baseModule

+				
in file baseModule.inc, class baseModule
    Parent class of all account modules

+							
baseModule

+				
in file baseModule.inc, method baseModule::baseModule()
    Creates a new base module class

+							
baseType

+				
in file baseType.inc, class baseType
    This is the parent class of all account types.

+							
buildUploadAccounts

+				
in file modules.inc, function buildUploadAccounts()
    This function builds the LDAP accounts for the file upload.

+							
build_initial_tree_icons

+				
in file tree.inc, function build_initial_tree_icons()
    Builds the initial array that stores the icon-lookup for each server's DN in the tree browser. The returned

+							
build_uploadAccounts

+				
in file posixGroup.inc, method posixGroup::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file posixAccount.inc, method posixAccount::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file sambaAccount.inc, method sambaAccount::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file sambaGroupMapping.inc, method sambaGroupMapping::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file nisMailAlias.inc, method nisMailAlias::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file shadowAccount.inc, method shadowAccount::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file sambaSamAccount.inc, method sambaSamAccount::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file sambaDomain.inc, method sambaDomain::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file ieee802device.inc, method ieee802Device::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file baseModule.inc, method baseModule::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file ldapPublicKey.inc, method ldapPublicKey::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file account.inc, method account::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file kolabUser.inc, method kolabUser::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file inetOrgPerson.inc, method inetOrgPerson::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
baseModule.inc

+				
procedural page baseModule.inc

+							
baseType.inc

+				
procedural page baseType.inc

+					

+	

+	top

+  

+	
+	

+		
c

+		

+							
$cachetimeout

+				
in file config.inc, variable LAMConfig::$cachetimeout
    LDAP cache timeout

+							
$changegids

+				
in file posixGroup.inc, variable posixGroup::$changegids
    change GIDs of users and hosts?

+							
$children_objectclasses

+				
in file schema.inc, variable ObjectClass::$children_objectclasses
    array of objectClasses which inherit from this one (must be set at runtime explicitly by the caller)

+							
$clearTextPassword

+				
in file posixAccount.inc, variable posixAccount::$clearTextPassword

+							
$cMargin

+				
in file fpdf.php, variable FPDF::$cMargin

+							
$ColorFlag

+				
in file fpdf.php, variable FPDF::$ColorFlag

+							
$compress

+				
in file fpdf.php, variable FPDF::$compress

+							
$conf

+				
in file ldap.inc, variable Ldap::$conf
    Object of Config to access preferences

+							
$CoreFonts

+				
in file fpdf.php, variable FPDF::$CoreFonts

+							
$counter

+				
in file export.inc, variable PlaLdifExporter::$counter

+							
$counter

+				
in file export.inc, variable PlaDsmlExporter::$counter

+							
$createhomedir

+				
in file posixAccount.inc, variable posixAccount::$createhomedir

+							
$creator

+				
in file fpdf.php, variable FPDF::$creator

+							
$CurOrientation

+				
in file fpdf.php, variable FPDF::$CurOrientation

+							
$CurrentFont

+				
in file fpdf.php, variable FPDF::$CurrentFont

+							
$current_page

+				
in file modules.inc, variable accountContainer::$current_page
    This variable stores the name of the currently displayed page

+							
cache

+				
in file cache.inc, method cache::cache()
    Constructor.

+							
cache

+				
in file cache.inc, class cache
    This class contains all functions which are needed to manage the LDAP cache.

+							
cached_schema_available

+				
in file schema.inc, function cached_schema_available()
    Returns true if the schema for $schema_type has been cached and

+							
can_manage

+				
in file baseModule.inc, method baseModule::can_manage()
    Returns true if this module fits for the current scope.

+							
Cell

+				
in file ufpdf.php, method UFPDF::Cell()

+							
Cell

+				
in file fpdf.php, method FPDF::Cell()

+							
checkASCII

+				
in file posixAccount.inc, method posixAccount::checkASCII()
    Checks if an attribute contains only ASCII charaters and replaces invalid characters.

+							
checkClientIP

+				
in file security.inc, function checkClientIP()
    Checks if the client's IP address is on the list of allowed IPs.

+							
checkConfigOptions

+				
in file modules.inc, function checkConfigOptions()
    Checks if the configuration options are valid

+							
checkProfileOptions

+				
in file modules.inc, function checkProfileOptions()
    Checks if the profile options are valid

+							
checkSelfServiceOptions

+				
in file baseModule.inc, method baseModule::checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP commands which should be executed.

+							
checkSelfServiceOptions

+				
in file selfService.inc, function checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP commands which should be executed.

+							
checkSelfServiceOptions

+				
in file sambaSamAccount.inc, method sambaSamAccount::checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP commands which should be executed.

+							
checkSelfServiceOptions

+				
in file inetOrgPerson.inc, method inetOrgPerson::checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP commands which should be executed.

+							
checkSelfServiceOptions

+				
in file posixAccount.inc, method posixAccount::checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP commands which should be executed.

+							
check_configOptions

+				
in file baseModule.inc, method baseModule::check_configOptions()
    Checks input values of module settings.

+							
check_configOptions

+				
in file posixAccount.inc, method posixAccount::check_configOptions()
    Checks input values of module settings.

+							
check_module_conflicts

+				
in file modules.inc, function check_module_conflicts()
    Checks if there are conflicts between modules

+							
check_module_depends

+				
in file modules.inc, function check_module_depends()
    Checks if there are missing dependencies between modules.

+							
check_profileOptions

+				
in file baseModule.inc, method baseModule::check_profileOptions()
    Checks input values of account profiles.

+							
check_profileOptions

+				
in file quota.inc, method quota::check_profileOptions()
    Checks input values of account profiles.

+							
close

+				
in file ldap.inc, method Ldap::close()
    Closes connection to server

+							
Close

+				
in file fpdf.php, method FPDF::Close()

+							
cmp_array

+				
in file ldap.inc, method Ldap::cmp_array()
    Helper function to sort the unit DNs

+							
cmp_array

+				
in file lists.inc, method lamList::cmp_array()
    Compare function used for usort-method

+							
cmp_domain

+				
in file account.inc, function cmp_domain()
    Helper function to sort the domains

+							
code2utf

+				
in file ufpdf.php, method UFPDF::code2utf()

+							
config_showAccountModules

+				
in file confmodules.php, function config_showAccountModules()
    Displays the module selection boxes and checks if dependencies are fulfilled.

+							
connect

+				
in file ldap.inc, method Ldap::connect()
    Connects to the server using the given username and password

+							
continue_main

+				
in file modules.inc, method accountContainer::continue_main()
    This function is called when the user clicks on any button on the account pages.

+							
createModulePDF

+				
in file pdf.inc, function createModulePDF()
    This function creates the PDF output of one or more accounts. At the moment  this function can create a PDF page for user, group and host accounts. But  this is not limited by the function itself but by the account types that are  allowed in LAM and the exsisting PDF structure definitions.

+							
cache.inc

+				
procedural page cache.inc

+							
config.inc

+				
procedural page config.inc

+							
createntlm.inc

+				
procedural page createntlm.inc

+							
conflogin.php

+				
procedural page conflogin.php

+							
confmain.php

+				
procedural page confmain.php

+							
confmodules.php

+				
procedural page confmodules.php

+							
conftypes.php

+				
procedural page conftypes.php

+							
collapse.php

+				
procedural page collapse.php

+							
create_form.php

+				
procedural page create_form.php

+							
create.php

+				
procedural page create.php

+							
creation_template.php

+				
procedural page creation_template.php

+							
custom.php

+				
procedural page custom.php

+							
conf-main-test.php

+				
procedural page conf-main-test.php

+							
conf-test.php

+				
procedural page conf-test.php

+					

+	

+	top

+  

+	
+	

+		
d

+		

+							
$deactivated

+				
in file sambaAccount.inc, variable sambaAccount::$deactivated
    account deactivated?

+							
$deactivated

+				
in file sambaSamAccount.inc, variable sambaSamAccount::$deactivated
    account deactivated?

+							
$default

+				
in file config.inc, variable LAMCfgMain::$default
    Default profile

+							
$defaultLanguage

+				
in file config.inc, variable LAMConfig::$defaultLanguage
    Default language

+							
$DefOrientation

+				
in file fpdf.php, variable FPDF::$DefOrientation

+							
$deliveryAddress

+				
in file export.inc, variable PlaVcardExporter::$deliveryAddress

+							
$descArray

+				
in file lists.inc, variable lamList::$descArray
    list of attribute descriptions

+							
$description

+				
in file schema.inc, variable SchemaItem::$description
    The description of this schema item.

+							
$diffs

+				
in file fpdf.php, variable FPDF::$diffs

+							
$dn

+				
in file modules.inc, variable accountContainer::$dn
    DN suffix of the account

+							
$dn

+				
in file account.inc, variable samba3domain::$dn
    DN

+							
$dn_orig

+				
in file modules.inc, variable accountContainer::$dn_orig
    DN suffix of account when it was loaded

+							
$DrawColor

+				
in file fpdf.php, variable FPDF::$DrawColor

+							
decrypt

+				
in file ldap.inc, method Ldap::decrypt()
    Decrypts a string

+							
decrypt_login

+				
in file ldap.inc, method Ldap::decrypt_login()
    Decrypts username and password

+							
delAccountProfile

+				
in file profiles.inc, function delAccountProfile()
    Deletes an account profile

+							
deleteDN

+				
in file delete.php, function deleteDN()
    Deletes a DN and all child entries.

+							
deletePDFStructureDefinition

+				
in file pdfstruct.inc, function deletePDFStructureDefinition()
    Deletes XML file with PDF structure definitions.

+							
delete_attributes

+				
in file quota.inc, method quota::delete_attributes()

+							
delete_attributes

+				
in file posixGroup.inc, method posixGroup::delete_attributes()

+							
delete_attributes

+				
in file posixAccount.inc, method posixAccount::delete_attributes()
    Additional LDAP operations on delete.

+							
delete_attributes

+				
in file baseModule.inc, method baseModule::delete_attributes()
    Dummy function for modules which use no special options on account deletion.

+							
destroy

+				
in file ldap.inc, method Ldap::destroy()
    Closes connection to LDAP server and deletes encrypted username/password

+							
displayExportInfo

+				
in file export.inc, method PlaLdifExporter::displayExportInfo()

+							
displayHelp

+				
in file help.php, function displayHelp()
    Print help site for a specific help number.

+							
display_html_attributes

+				
in file quota.inc, method quota::display_html_attributes()

+							
display_html_attributes

+				
in file posixGroup.inc, method posixGroup::display_html_attributes()

+							
display_html_attributes

+				
in file posixAccount.inc, method posixAccount::display_html_attributes()

+							
display_html_attributes

+				
in file sambaAccount.inc, method sambaAccount::display_html_attributes()

+							
display_html_attributes

+				
in file nisMailAlias.inc, method nisMailAlias::display_html_attributes()
    This function will create the meta HTML code to show a page with all attributes.

+							
display_html_attributes

+				
in file account.inc, method account::display_html_attributes()

+							
display_html_attributes

+				
in file sambaDomain.inc, method sambaDomain::display_html_attributes()
    This function will create the meta HTML code to show a page with all attributes.

+							
display_html_attributes

+				
in file ieee802device.inc, method ieee802Device::display_html_attributes()
    This function will create the meta HTML code to show a page with all attributes.

+							
display_html_attributes

+				
in file sambaSamAccount.inc, method sambaSamAccount::display_html_attributes()

+							
display_html_attributes

+				
in file shadowAccount.inc, method shadowAccount::display_html_attributes()
    This function will create the meta HTML code to show a page with all attributes.

+							
display_html_attributes

+				
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::display_html_attributes()
    This function will create the meta HTML code to show a page with all attributes.

+							
display_html_attributes

+				
in file inetOrgPerson.inc, method inetOrgPerson::display_html_attributes()

+							
display_html_attributes

+				
in file sambaGroupMapping.inc, method sambaGroupMapping::display_html_attributes()

+							
display_html_attributes

+				
in file ldapPublicKey.inc, method ldapPublicKey::display_html_attributes()
    This function will create the meta HTML code to show a page with all attributes.

+							
display_html_attributes

+				
in file kolabUser.inc, method kolabUser::display_html_attributes()
    This function will create the meta HTML code to show a page with all attributes.

+							
display_html_delete

+				
in file baseModule.inc, method baseModule::display_html_delete()
    Dummy function for modules which do not print extra HTML code on account deletion.

+							
display_html_delete

+				
in file posixAccount.inc, method posixAccount::display_html_delete()

+							
display_html_deleteUser

+				
in file kolabUser.inc, method kolabUser::display_html_deleteUser()
    This function will create the meta HTML code to show a page to delete accounts.

+							
display_html_expire

+				
in file shadowAccount.inc, method shadowAccount::display_html_expire()
    This function will create the meta HTML code to show a page with the expiration date.

+							
display_html_group

+				
in file posixAccount.inc, method posixAccount::display_html_group()
    Displays the group selection.

+							
display_html_logonHours

+				
in file sambaSamAccount.inc, method sambaSamAccount::display_html_logonHours()
    This function will create the HTML page to edit logon hours.

+							
display_html_password

+				
in file posixAccount.inc, method posixAccount::display_html_password()
    Displays the password changing dialog.

+							
display_html_password

+				
in file posixGroup.inc, method posixGroup::display_html_password()
    Displays the password changing dialog.

+							
display_html_password

+				
in file inetOrgPerson.inc, method inetOrgPerson::display_html_password()
    Displays the password changing dialog.

+							
display_html_photo

+				
in file inetOrgPerson.inc, method inetOrgPerson::display_html_photo()
    Displays the photo upload page.

+							
display_html_sambaUserWorkstations

+				
in file sambaSamAccount.inc, method sambaSamAccount::display_html_sambaUserWorkstations()

+							
display_html_time

+				
in file sambaSamAccount.inc, method sambaSamAccount::display_html_time()
    This function will create the meta HTML code to show a page to change time values.

+							
display_html_user

+				
in file posixGroup.inc, method posixGroup::display_html_user()
    Displays selections to add or remove users from current group.

+							
display_html_userWorkstations

+				
in file sambaAccount.inc, method sambaAccount::display_html_userWorkstations()

+							
display_LoginPage

+				
in file login.php, function display_LoginPage()
    Displays the login window.

+							
display_main

+				
in file ou_edit.php, function display_main()

+							
dn_exists

+				
in file tree.inc, function dn_exists()
    Gets whether an entry exists based on its DN. If the entry exists,  returns true. Otherwise returns false.

+							
doHash

+				
in file createntlm.inc, method smbHash::doHash()

+							
doUploadPostActions

+				
in file quota.inc, method quota::doUploadPostActions()
    This function executes one post upload action.

+							
doUploadPostActions

+				
in file posixAccount.inc, method posixAccount::doUploadPostActions()
    This function executes one post upload action.

+							
doUploadPostActions

+				
in file baseModule.inc, method baseModule::doUploadPostActions()
    This function executes one post upload action.

+							
doUploadPostActions

+				
in file modules.inc, function doUploadPostActions()
    This function executes one post upload action.

+							
draw_create_link

+				
in file tree.php, function draw_create_link()

+							
draw_formatted_dn

+				
in file tree.inc, function draw_formatted_dn()
    Gets a DN string using the user-configured tree_display_format string to format it.

+							
draw_jpeg_photos

+				
in file tree.inc, function draw_jpeg_photos()
    Draw the jpegPhoto image(s) for an entry wrapped in HTML. Many options are available to  specify how the images are to be displayed.

+							
draw_server_tree

+				
in file tree.inc, function draw_server_tree()
    Prints the HTML of the tree view.

+							
draw_tree_html

+				
in file tree.php, function draw_tree_html()
    Recursively descend on the given dn and draw the tree in html

+							
delete.php

+				
procedural page delete.php

+							
delete_attr.php

+				
procedural page delete_attr.php

+							
delete_form.php

+				
procedural page delete_form.php

+							
delete.php

+				
procedural page delete.php

+							
download_binary_attr.php

+				
procedural page download_binary_attr.php

+					

+	

+	top

+  

+	
+	

+		
e

+		

+							
$entries

+				
in file lists.inc, variable lamList::$entries
    LDAP entries

+							
$entry_array

+				
in file export.inc, variable PlaLdapExporter::$entry_array

+							
$entry_id

+				
in file export.inc, variable PlaLdapExporter::$entry_id

+							
$equality

+				
in file schema.inc, variable AttributeType::$equality
    The equality rule used

+							
$escapeCode

+				
in file export.inc, variable PlaCSVExporter::$escapeCode

+							
$exporter

+				
in file export.inc, variable PlaExporter::$exporter

+							
echoHTMLFoot

+				
in file help.php, function echoHTMLFoot()
    Print HTML footer of the help page.

+							
echoHTMLHead

+				
in file help.php, function echoHTMLHead()
    Print HTML header of the help page.

+							
encrypt

+				
in file ldap.inc, method Ldap::encrypt()
    Encrypts a string

+							
encrypt_login

+				
in file ldap.inc, method Ldap::encrypt_login()
    Encrypts username and password

+							
Error

+				
in file fpdf.php, method FPDF::Error()

+							
export

+				
in file export.inc, method PlaVcardExporter::export()
    When doing an exporter, the method export need to be overriden.

+							
export

+				
in file export.inc, method PlaLdifExporter::export()
    Export entries to ldif format

+							
export

+				
in file export.inc, method PlaCSVExporter::export()

+							
export

+				
in file export.inc, method MyCustomExporter::export()
    When doing an exporter, the method export need to be overriden.

+							
export

+				
in file export.inc, method PlaDsmlExporter::export()
    Export the entries to DSML

+							
export

+				
in file export.inc, method PlaExporter::export()
    Abstract method use to export data.

+							
E_P16

+				
in file createntlm.inc, method smbHash::E_P16()

+							
export.inc

+				
procedural page export.inc

+							
edit.php

+				
procedural page edit.php

+							
edit.php

+				
procedural page edit.php

+							
expand.php

+				
procedural page expand.php

+							
export_form.php

+				
procedural page export_form.php

+							
export.php

+				
procedural page export.php

+					

+	

+	top

+  

+	
+	

+		
f

+		

+							
$fh

+				
in file fpdf.php, variable FPDF::$fh

+							
$fhPt

+				
in file fpdf.php, variable FPDF::$fhPt

+							
$file

+				
in file config.inc, variable LAMConfig::$file
    Name of configuration file

+							
$FillColor

+				
in file fpdf.php, variable FPDF::$FillColor

+							
$filterText

+				
in file lists.inc, variable lamList::$filterText
    filter string to include in URL

+							
$FontFamily

+				
in file fpdf.php, variable FPDF::$FontFamily

+							
$FontFiles

+				
in file fpdf.php, variable FPDF::$FontFiles

+							
$fontList

+				
in file pdf.inc, variable lamPDF::$fontList
    list of supported fonts

+							
$fontName

+				
in file pdf.inc, variable lamPDF::$fontName
    current active font name

+							
$fonts

+				
in file fpdf.php, variable FPDF::$fonts

+							
$FontSize

+				
in file fpdf.php, variable FPDF::$FontSize

+							
$FontSizePt

+				
in file fpdf.php, variable FPDF::$FontSizePt

+							
$FontStyle

+				
in file fpdf.php, variable FPDF::$FontStyle

+							
$fw

+				
in file fpdf.php, variable FPDF::$fw

+							
$fwPt

+				
in file fpdf.php, variable FPDF::$fwPt

+							
findgroups

+				
in file cache.inc, method cache::findgroups()
    This function returns an array with all group names which were found in the LDAP directory.

+							
fixLDAPAttributes

+				
in file modules.inc, method accountContainer::fixLDAPAttributes()
    Fixes spelling errors in the attribute names.

+							
footer

+				
in file pdf.inc, method lamPDF::footer()

+							
Footer

+				
in file fpdf.php, method FPDF::Footer()

+							
FPDF

+				
in file fpdf.php, method FPDF::FPDF()
    *****************************************************************************

+							
FPDF

+				
in file fpdf.php, class FPDF
    Main FPDF class for creating PDF documents

+							
FPDF_VERSION

+				
in file fpdf.php, constant FPDF_VERSION
    *****************************************************************************

+							
fpdf.php

+				
procedural page fpdf.php

+					

+	

+	top

+  

+	
+	

+		
g

+		

+							
$groups

+				
in file posixAccount.inc, variable posixAccount::$groups

+							
$groups_orig

+				
in file posixAccount.inc, variable posixAccount::$groups_orig

+							
genpasswd

+				
in file account.inc, function genpasswd()
    This function will return a password with max. 8 characters.

+							
getAccountProfiles

+				
in file profiles.inc, function getAccountProfiles()
    Returns an array of string with all available profiles for the given account type

+							
getAlias

+				
in file user.inc, method user::getAlias()
    Returns the alias name of this account type.

+							
getAlias

+				
in file smbDomain.inc, method smbDomain::getAlias()
    Returns the alias name of this account type.

+							
getAlias

+				
in file group.inc, method group::getAlias()
    Returns the alias name of this account type.

+							
getAlias

+				
in file host.inc, method host::getAlias()
    Returns the alias name of this account type.

+							
getAlias

+				
in file mailAlias.inc, method mailAlias::getAlias()
    Returns the alias name of this account type.

+							
getAlias

+				
in file baseType.inc, method baseType::getAlias()
    Returns the alias name of this account type.

+							
getAliases

+				
in file schema.inc, method AttributeType::getAliases()
    Gets the names of attributes that are an alias for this attribute (if any).

+							
getAvailableLogos

+				
in file pdfstruct.inc, function getAvailableLogos()
    This function returns an array with all aviliable logo images.

+							
getAvailableModules

+				
in file modules.inc, function getAvailableModules()
    Returns an array with all available user module names

+							
getAvailablePDFFields

+				
in file modules.inc, function getAvailablePDFFields()
    Returns a list of available PDF entries.

+							
getButtonStatus

+				
in file baseModule.inc, method baseModule::getButtonStatus()
    Controls if the module button the account page is visible and activated.

+							
getButtonStatus

+				
in file account.inc, method account::getButtonStatus()
    Controls if the module button the account page is visible and activated.

+							
getButtonStatus

+				
in file posixGroup.inc, method posixGroup::getButtonStatus()
    Controls if the module button the account page is visible and activated.

+							
getButtonStatus

+				
in file inetOrgPerson.inc, method inetOrgPerson::getButtonStatus()
    Controls if the module button the account page is visible and activated.

+							
getButtonStatus

+				
in file nisMailAlias.inc, method nisMailAlias::getButtonStatus()
    Controls if the module button the account page is visible and activated.

+							
getChildCount

+				
in file delete.php, function getChildCount()
    Returns the number of child entries of a DN.

+							
getChildObjectClasses

+				
in file schema.inc, method ObjectClass::getChildObjectClasses()
    Returns the array of objectClass names which inherit from this objectClass.

+							
getConfigOptions

+				
in file modules.inc, function getConfigOptions()
    Returns a hash array (module name => elements) of all module options for the configuration page.

+							
getConfigProfiles

+				
in file config.inc, function getConfigProfiles()
    Returns an array of string with all available configuration profiles (without .conf)

+							
getdays

+				
in file account.inc, function getdays()
    This function will return the days from 1.1.1970 until now.

+							
getDefaultListAttributes

+				
in file types.inc, function getDefaultListAttributes()
    Returns the default attribute list for an account type.

+							
getDefaultListAttributes

+				
in file baseType.inc, method baseType::getDefaultListAttributes()
    Returns the default attribute list for this account type.

+							
getDefaultListAttributes

+				
in file host.inc, method host::getDefaultListAttributes()
    Returns the default attribute list for this account type.

+							
getDefaultListAttributes

+				
in file smbDomain.inc, method smbDomain::getDefaultListAttributes()
    Returns the default attribute list for this account type.

+							
getDefaultListAttributes

+				
in file group.inc, method group::getDefaultListAttributes()
    Returns the default attribute list for this account type.

+							
getDefaultListAttributes

+				
in file user.inc, method user::getDefaultListAttributes()
    Returns the default attribute list for this account type.

+							
getDefaultListAttributes

+				
in file mailAlias.inc, method mailAlias::getDefaultListAttributes()
    Returns the default attribute list for this account type.

+							
getDescription

+				
in file smbDomain.inc, method smbDomain::getDescription()
    Returns the description of this account type.

+							
getDescription

+				
in file mailAlias.inc, method mailAlias::getDescription()
    Returns the description of this account type.

+							
getDescription

+				
in file schema.inc, method SchemaItem::getDescription()

+							
getDescription

+				
in file baseType.inc, method baseType::getDescription()
    Returns the description of this account type.

+							
getDescription

+				
in file group.inc, method group::getDescription()
    Returns the description of this account type.

+							
getDescription

+				
in file user.inc, method user::getDescription()
    Returns the description of this account type.

+							
getDescription

+				
in file host.inc, method host::getDescription()
    Returns the description of this account type.

+							
getEquality

+				
in file schema.inc, method AttributeType::getEquality()
    Gets this attribute's equality string

+							
getgid

+				
in file cache.inc, method cache::getgid()
    This function will return the GID number to an existing group name (using the cache).

+							
getgrnam

+				
in file cache.inc, method cache::getgrnam()
    This function returns the group name to an existing gidNumber.

+							
getHelp

+				
in file modules.inc, function getHelp()
    Returns a help entry from an account module.

+							
getIsCollective

+				
in file schema.inc, method AttributeType::getIsCollective()
    Gets whether this attribute is collective.

+							
getIsNoUserModification

+				
in file schema.inc, method AttributeType::getIsNoUserModification()
    Gets whether this attribute is not modifiable by users.

+							
getIsObsolete

+				
in file schema.inc, method ObjectClass::getIsObsolete()
    Gets whether this objectClass is flagged as obsolete by the LDAP server.

+							
getIsObsolete

+				
in file schema.inc, method MatchingRule::getIsObsolete()
    Gets whether this MatchingRule is flagged as obsolete by the LDAP server.

+							
getIsObsolete

+				
in file schema.inc, method AttributeType::getIsObsolete()
    Gets whether this attribute has been flagged as obsolete by the LDAP server

+							
getIsSingleValue

+				
in file schema.inc, method AttributeType::getIsSingleValue()
    Gets whether this attribute is single-valued. If this attribute only supports single values, true  is returned. If this attribute supports multiple values, false is returned.

+							
getLDAPAliases

+				
in file baseModule.inc, method baseModule::getLDAPAliases()
    Returns a list of aliases for LDAP attributes.

+							
getListAttributeDescriptions

+				
in file smbDomain.inc, method smbDomain::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.

+							
getListAttributeDescriptions

+				
in file group.inc, method group::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.

+							
getListAttributeDescriptions

+				
in file user.inc, method user::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.

+							
getListAttributeDescriptions

+				
in file baseType.inc, method baseType::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.

+							
getListAttributeDescriptions

+				
in file host.inc, method host::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.

+							
getListAttributeDescriptions

+				
in file types.inc, function getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.

+							
getListAttributeDescriptions

+				
in file mailAlias.inc, method mailAlias::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.

+							
getListClassName

+				
in file mailAlias.inc, method mailAlias::getListClassName()
    Returns the class name for the list object.

+							
getListClassName

+				
in file group.inc, method group::getListClassName()
    Returns the class name for the list object.

+							
getListClassName

+				
in file host.inc, method host::getListClassName()
    Returns the class name for the list object.

+							
getListClassName

+				
in file types.inc, function getListClassName()
    Returns the class name for the list object.

+							
getListClassName

+				
in file smbDomain.inc, method smbDomain::getListClassName()
    Returns the class name for the list object.

+							
getListClassName

+				
in file baseType.inc, method baseType::getListClassName()
    Returns the class name for the list object.

+							
getListClassName

+				
in file user.inc, method user::getListClassName()
    Returns the class name for the list object.

+							
getManagedAttributes

+				
in file baseModule.inc, method baseModule::getManagedAttributes()
    Returns a list of LDAP attributes which are managed by this module.

+							
getManagedObjectClasses

+				
in file baseModule.inc, method baseModule::getManagedObjectClasses()
    Returns a list of managed object classes for this module.

+							
getMaxLength

+				
in file schema.inc, method AttributeType::getMaxLength()
    Gets this attribute's the maximum length. If no maximum is defined by the LDAP server, null is returned.

+							
getMayAttrNames

+				
in file schema.inc, method ObjectClass::getMayAttrNames()
    Gets an array of attribute names (strings) that entries of this ObjectClass must define.

+							
getMayAttrs

+				
in file schema.inc, method ObjectClass::getMayAttrs()
    Gets an array of AttributeType objects that entries of this ObjectClass may define.

+							
getModuleAlias

+				
in file modules.inc, function getModuleAlias()
    Returns the alias name of a module

+							
getModulesDependencies

+				
in file modules.inc, function getModulesDependencies()
    Returns a hash array (module name => dependencies) of all module dependencies

+							
getMustAttrNames

+				
in file schema.inc, method ObjectClass::getMustAttrNames()
    Gets an array of attribute names (strings) that entries of this ObjectClass must define.

+							
getMustAttrs

+				
in file schema.inc, method ObjectClass::getMustAttrs()
    Gets an array of AttributeType objects that entries of this ObjectClass must define.

+							
getName

+				
in file schema.inc, method AttributeType::getName()
    Gets this attribute's name

+							
getName

+				
in file schema.inc, method MatchingRule::getName()
    Gets this MatchingRule's name.

+							
getName

+				
in file schema.inc, method ObjectClass::getName()
    Gets the name of this objectClass (ie, "inetOrgPerson")

+							
getName

+				
in file schema.inc, method ObjectClassAttribute::getName()
    Gets this attribute's name

+							
getName

+				
in file schema.inc, method MatchingRuleUse::getName()
    Gets this MatchingRuleUse's name

+							
getNextGIDs

+				
in file posixGroup.inc, method posixGroup::getNextGIDs()
    Returns one or more free GID numbers.

+							
getNextUIDs

+				
in file posixAccount.inc, method posixAccount::getNextUIDs()
    Returns one or more free UID numbers.

+							
getOID

+				
in file schema.inc, method SchemaItem::getOID()

+							
getOrdering

+				
in file schema.inc, method AttributeType::getOrdering()
    Gets this attribute's ordering specification.

+							
getPDFStructureDefinitions

+				
in file pdfstruct.inc, function getPDFStructureDefinitions()
    This function will return all available PDF structure definitions for the submitted  account scope.

+							
getProfileOptions

+				
in file modules.inc, function getProfileOptions()
    Returns the elements for the profile page.

+							
getRDNAttributes

+				
in file modules.inc, function getRDNAttributes()
    Returns a list of LDAP attributes which can be used to form the RDN.

+							
getRequiredByObjectClasses

+				
in file schema.inc, method AttributeType::getRequiredByObjectClasses()
    Gets the list of "required by" objectClasses, that is the list of objectClasses  which provide must have attribute.

+							
getRequiredExtensions

+				
in file baseModule.inc, method baseModule::getRequiredExtensions()
    Returns a list of required PHP extensions.

+							
getRequiredExtensions

+				
in file modules.inc, function getRequiredExtensions()
    Returns true if the module is a base module

+							
getSectionHeadline

+				
in file pdf.inc, function getSectionHeadline()
    Creates a section headline.

+							
getSelfServiceFields

+				
in file baseModule.inc, method baseModule::getSelfServiceFields()
    Returns a list of possible input fields and their descriptions  Format: array(<field identifier> => <field description>)

+							
getSelfServiceFieldSettings

+				
in file selfService.inc, function getSelfServiceFieldSettings()
    Returns the field settings for the self service.

+							
getSelfServiceOptions

+				
in file selfService.inc, function getSelfServiceOptions()
    Returns meta HTML code for each self service field.

+							
getSelfServiceOptions

+				
in file baseModule.inc, method baseModule::getSelfServiceOptions()
    Returns the meta HTML code for each input field.

+							
getSelfServiceOptions

+				
in file posixAccount.inc, method posixAccount::getSelfServiceOptions()
    Returns the meta HTML code for each input field.

+							
getSelfServiceOptions

+				
in file inetOrgPerson.inc, method inetOrgPerson::getSelfServiceOptions()
    Returns the meta HTML code for each input field.

+							
getSelfServiceProfiles

+				
in file selfService.inc, function getSelfServiceProfiles()
    Returns a list of all available self service profiles (without .conf)

+							
getSelfServiceSearchAttributes

+				
in file baseModule.inc, method baseModule::getSelfServiceSearchAttributes()
    Returns a list of possible search attributes for the self service.

+							
getSelfServiceSearchAttributes

+				
in file selfService.inc, function getSelfServiceSearchAttributes()
    Returns a list of possible search attributes for the self service.

+							
getshells

+				
in file account.inc, function getshells()
    Returns a list of shells listed in config/shells.

+							
getSource

+				
in file schema.inc, method ObjectClassAttribute::getSource()
    Gets the name of the ObjectClass which originally specified this attribute.

+							
GetStringWidth

+				
in file ufpdf.php, method UFPDF::GetStringWidth()

+							
GetStringWidth

+				
in file fpdf.php, method FPDF::GetStringWidth()

+							
getSubstr

+				
in file schema.inc, method AttributeType::getSubstr()
    Gets this attribute's substring matching specification

+							
getSupAttribute

+				
in file schema.inc, method AttributeType::getSupAttribute()
    Gets this attribute's parent attribute (if any). If this attribute does not  inherit from another attribute, null is returned.

+							
getSupClasses

+				
in file schema.inc, method ObjectClass::getSupClasses()
    Gets the objectClass names from which this objectClass inherits.

+							
getSyntaxOID

+				
in file schema.inc, method AttributeType::getSyntaxOID()
    Gets this attribute's syntax OID. Differs from getSyntaxString() in that this  function only returns the actual OID with any length specification removed.

+							
getSyntaxString

+				
in file schema.inc, method AttributeType::getSyntaxString()
    Gets this attribute's raw syntax string (ie: "1.2.3.4{16}").

+							
getType

+				
in file schema.inc, method AttributeType::getType()
    Gets this attribute's type

+							
getType

+				
in file schema.inc, method ObjectClass::getType()
    Gets the type of this objectClass: STRUCTURAL, ABSTRACT, or AUXILIARY.

+							
getTypeAlias

+				
in file types.inc, function getTypeAlias()
    Returns the alias name of an account type.

+							
getTypeDescription

+				
in file types.inc, function getTypeDescription()
    Returns the description of an account type.

+							
getTypes

+				
in file types.inc, function getTypes()
    Returns a list of available account types.

+							
getUploadColumns

+				
in file modules.inc, function getUploadColumns()
    Returns an array containing all input columns for the file upload.

+							
getUsage

+				
in file schema.inc, method AttributeType::getUsage()
    Gets this attribute's usage string as defined by the LDAP server

+							
getUsedByAttrs

+				
in file schema.inc, method MatchingRuleUse::getUsedByAttrs()
    Gets an array of attribute names (strings) which use this MatchingRuleUse object.

+							
getUsedByAttrs

+				
in file schema.inc, method MatchingRule::getUsedByAttrs()
    Gets an array of attribute names (strings) which use this MatchingRule

+							
getUsedInObjectClasses

+				
in file schema.inc, method AttributeType::getUsedInObjectClasses()
    Gets the list of "used in" objectClasses, that is the list of objectClasses  which provide this attribute.

+							
GetX

+				
in file fpdf.php, method FPDF::GetX()

+							
GetY

+				
in file fpdf.php, method FPDF::GetY()

+							
get_AccountModules

+				
in file config.inc, method LAMConfig::get_AccountModules()
    Returns an array of all selected account modules

+							
get_ActiveTypes

+				
in file config.inc, method LAMConfig::get_ActiveTypes()
    Returns a list of active account types.

+							
get_Admins

+				
in file config.inc, method LAMConfig::get_Admins()
    Returns an array of string with all admin names

+							
get_Adminstring

+				
in file config.inc, method LAMConfig::get_Adminstring()
    Returns all admin users seperated by semicolons

+							
get_alias

+				
in file baseModule.inc, method baseModule::get_alias()
    Returns an alias name for the module.

+							
get_attr_select_html

+				
in file custom.php, function get_attr_select_html()
    Returns option values.

+							
get_binary_attr_select_html

+				
in file custom.php, function get_binary_attr_select_html()
    Returns option values.

+							
get_cache

+				
in file cache.inc, method cache::get_cache()
    Queries the cache for a list of LDAP entries and their attributes.

+							
get_cached_schema

+				
in file schema.inc, function get_cached_schema()
    Returns the cached array of schemaitem objects for the specified

+							
get_cacheTimeout

+				
in file config.inc, method LAMConfig::get_cacheTimeout()
    Returns the LDAP cache timeout in minutes

+							
get_cacheTimeoutSec

+				
in file config.inc, method LAMConfig::get_cacheTimeoutSec()
    Returns the LDAP cache timeout in seconds

+							
get_configOptions

+				
in file posixGroup.inc, method posixGroup::get_configOptions()
    Returns a list of elements for the configuration.

+							
get_configOptions

+				
in file baseModule.inc, method baseModule::get_configOptions()
    Returns a list of elements for the configuration.

+							
get_container

+				
in file tree.inc, function get_container()
    Given a DN string, this returns the parent container portion of the string.

+							
get_container_contents

+				
in file tree.inc, function get_container_contents()
    Gets a list of child entries for an entry. Given a DN, this function fetches the list of DNs of  child entries one level beneath the parent. For example, for the following tree:

+							
get_defaultLanguage

+				
in file config.inc, method LAMConfig::get_defaultLanguage()
    Returns the default language string

+							
get_dependencies

+				
in file baseModule.inc, method baseModule::get_dependencies()
    This function returns a list with all depending and conflicting modules.

+							
get_enc_type

+				
in file tree.inc, function get_enc_type()

+							
get_entry_system_attrs

+				
in file tree.inc, function get_entry_system_attrs()
    Gets the operational attributes for an entry. Given a DN, this function fetches that entry's

+							
get_help

+				
in file baseModule.inc, method baseModule::get_help()
    This function return the help entry array for a specific help id. Normally this->meta can be used.

+							
get_icon

+				
in file tree.inc, function get_icon()
    Given a DN and server ID, this function reads the DN's objectClasses and

+							
get_ldap_filter

+				
in file modules.inc, function get_ldap_filter()
    Returns the LDAP filter used by the account lists

+							
get_ldap_filter

+				
in file baseModule.inc, method baseModule::get_ldap_filter()
    returns an LDAP filter for the account lists

+							
get_line_end_format

+				
in file export_form.php, function get_line_end_format()
    Helper functoin for fetching the line end format.

+							
get_listAttributes

+				
in file config.inc, method LAMConfig::get_listAttributes()
    Returns the list of attributes to show in user list

+							
get_MaxListEntries

+				
in file config.inc, method LAMConfig::get_MaxListEntries()
    Returns the maximum number of rows in user/group/host lists

+							
get_metaData

+				
in file shadowAccount.inc, method shadowAccount::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file nisMailAlias.inc, method nisMailAlias::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file posixAccount.inc, method posixAccount::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file posixGroup.inc, method posixGroup::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file quota.inc, method quota::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file sambaAccount.inc, method sambaAccount::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file ldapPublicKey.inc, method ldapPublicKey::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file inetOrgPerson.inc, method inetOrgPerson::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file account.inc, method account::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file baseModule.inc, method baseModule::get_metaData()
    Dummy function, meta data is provided by sub classes.

+							
get_metaData

+				
in file ieee802device.inc, method ieee802Device::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file sambaDomain.inc, method sambaDomain::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file kolabUser.inc, method kolabUser::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file sambaGroupMapping.inc, method sambaGroupMapping::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file sambaSamAccount.inc, method sambaSamAccount::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_moduleSettings

+				
in file config.inc, method LAMConfig::get_moduleSettings()
    Returns a list of saved module settings

+							
get_object_attr

+				
in file tree.inc, function get_object_attr()
    Much like get_object_attrs(), but only returns the values for  one attribute of an object. Example calls:

+							
get_object_attrs

+				
in file tree.inc, function get_object_attrs()
    Gets the attributes/values of an entry. Returns an associative array whose

+							
get_Passwd

+				
in file config.inc, method LAMConfig::get_Passwd()
    Returns the password to access the preferences wizard

+							
get_pdfEntries

+				
in file inetOrgPerson.inc, method inetOrgPerson::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfEntries

+				
in file kolabUser.inc, method kolabUser::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfEntries

+				
in file ldapPublicKey.inc, method ldapPublicKey::get_pdfEntries()
    Returns a list of PDF entries

+							
get_pdfEntries

+				
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfEntries

+				
in file account.inc, method account::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfEntries

+				
in file sambaDomain.inc, method sambaDomain::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfEntries

+				
in file ieee802device.inc, method ieee802Device::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfEntries

+				
in file modules.inc, method accountContainer::get_pdfEntries()
    Returns a list of possible PDF entries for this account.

+							
get_pdfEntries

+				
in file shadowAccount.inc, method shadowAccount::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfEntries

+				
in file posixGroup.inc, method posixGroup::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfEntries

+				
in file sambaAccount.inc, method sambaAccount::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfEntries

+				
in file sambaGroupMapping.inc, method sambaGroupMapping::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfEntries

+				
in file posixAccount.inc, method posixAccount::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfEntries

+				
in file nisMailAlias.inc, method nisMailAlias::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfEntries

+				
in file sambaSamAccount.inc, method sambaSamAccount::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfEntries

+				
in file quota.inc, method quota::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfFields

+				
in file baseModule.inc, method baseModule::get_pdfFields()
    Returns an array with all fields available for this account type on the PDF  output. This method may be overwritten by subclasses or it may be used  by using entries in the $this->meta['PDF_fields'] array of the specific sub-  class.

+							
get_pdf_entries

+				
in file baseModule.inc, method baseModule::get_pdf_entries()
    Returns a hastable with all entries that may be printed out in the PDF. The

+							
get_preg

+				
in file account.inc, function get_preg()
    Checks if a given value matches the selected regular expression.

+							
get_profileOptions

+				
in file baseModule.inc, method baseModule::get_profileOptions()
    Returns a list of elements for the account profiles.

+							
get_profileOptions

+				
in file sambaGroupMapping.inc, method sambaGroupMapping::get_profileOptions()
    Returns a list of elements for the account profiles.

+							
get_profileOptions

+				
in file sambaSamAccount.inc, method sambaSamAccount::get_profileOptions()
    Returns a list of elements for the account profiles.

+							
get_profileOptions

+				
in file posixAccount.inc, method posixAccount::get_profileOptions()
    Returns a list of elements for the account profiles.

+							
get_profileOptions

+				
in file quota.inc, method quota::get_profileOptions()
    Returns a list of elements for the account profiles.

+							
get_rdn

+				
in file tree.inc, function get_rdn()
    Given a DN string, this returns the 'RDN' portion of the string.

+							
get_RDNAttributes

+				
in file baseModule.inc, method baseModule::get_RDNAttributes()
    Returns a list of possible LDAP attributes which can be used to form the RDN.

+							
get_schema_attribute

+				
in file schema.inc, function get_schema_attribute()
    Gets a single AttributeType object specified by name.

+							
get_schema_attributes

+				
in file schema.inc, function get_schema_attributes()
    Gets an associative array of AttributeType objects for the specified  server. Each array entry's key is the name of the attributeType  in lower-case and the value is an AttributeType object.

+							
get_schema_matching_rules

+				
in file schema.inc, function get_schema_matching_rules()
    Returns an array of MatchingRule objects for the specified server.

+							
get_schema_objectclass

+				
in file schema.inc, function get_schema_objectclass()
    Gets a single ObjectClass object specified by name.

+							
get_schema_objectclasses

+				
in file schema.inc, function get_schema_objectclasses()
    Gets an associative array of ObjectClass objects for the specified  server. Each array entry's key is the name of the objectClass  in lower-case and the value is an ObjectClass object.

+							
get_schema_syntaxes

+				
in file schema.inc, function get_schema_syntaxes()
    Returns an array of Syntax objects that this LDAP server uses mapped to  their descriptions. The key of each entry is the OID of the Syntax.

+							
get_scope

+				
in file baseModule.inc, method baseModule::get_scope()
    Returns the account type of this module (user, group, host)

+							
get_scriptPath

+				
in file config.inc, method LAMConfig::get_scriptPath()
    Returns the path to the external script

+							
get_scriptServer

+				
in file config.inc, method LAMConfig::get_scriptServer()
    Returns the server of the external script

+							
get_ServerURL

+				
in file config.inc, method LAMConfig::get_ServerURL()
    Returns the server address as string

+							
get_Suffix

+				
in file config.inc, method LAMConfig::get_Suffix()
    Returns the LDAP suffix for the given account type

+							
get_type

+				
in file modules.inc, method accountContainer::get_type()
    Returns the accout type of this object (e.g. user, group, host).

+							
get_typeSettings

+				
in file config.inc, method LAMConfig::get_typeSettings()
    Returns a list of saved type settings

+							
get_uploadColumns

+				
in file baseModule.inc, method baseModule::get_uploadColumns()
    Returns an array containing all input columns for the file upload.

+							
get_uploadColumns

+				
in file quota.inc, method quota::get_uploadColumns()
    Returns an array containing all input columns for the file upload.

+							
get_uploadPreDepends

+				
in file baseModule.inc, method baseModule::get_uploadPreDepends()
    Returns a list of module names which must be processed in building the account befor this module.

+							
get_user_agent_string

+				
in file export.inc, function get_user_agent_string()
    Gets the USER_AGENT string from the $_SERVER array, all in lower case in  an E_NOTICE safe manner.

+							
group

+				
in file group.inc, class group
    The account type for group accounts (e.g. Unix and Samba).

+							
group.inc

+				
procedural page group.inc

+					

+	

+	top

+  

+	
+	

+		
h

+		

+							
$h

+				
in file fpdf.php, variable FPDF::$h

+							
$hasNext

+				
in file export.inc, variable PlaLdapExporter::$hasNext

+							
$hex2bitstring

+				
in file sambaSamAccount.inc, variable sambaSamAccount::$hex2bitstring
    HEX to binary conversion table

+							
$hPt

+				
in file fpdf.php, variable FPDF::$hPt

+							
header

+				
in file pdf.inc, method lamPDF::header()

+							
Header

+				
in file fpdf.php, method FPDF::Header()

+							
help.inc

+				
procedural page help.inc

+							
hex2bin

+				
in file ldap.inc, function hex2bin()
    Converts a HEX string to a binary value

+							
host

+				
in file host.inc, class host
    The account type for host accounts (e.g. Samba).

+							
host.inc

+				
procedural page host.inc

+							
help.php

+				
procedural page help.php

+					

+	

+	top

+  

+	
+	

+		
i

+		

+							
$images

+				
in file fpdf.php, variable FPDF::$images

+							
$indent_step

+				
in file export.inc, variable PlaDsmlExporter::$indent_step

+							
$InFooter

+				
in file fpdf.php, variable FPDF::$InFooter

+							
$inputFields

+				
in file selfService.inc, variable selfServiceProfile::$inputFields
    input fields

+							
$invitationPolicies

+				
in file kolabUser.inc, variable kolabUser::$invitationPolicies
    list of invitation policies

+							
$isNewAccount

+				
in file modules.inc, variable accountContainer::$isNewAccount
    True if this is a newly created account

+							
$is_collective

+				
in file schema.inc, variable AttributeType::$is_collective
    boolean: is collective?

+							
$is_no_user_modification

+				
in file schema.inc, variable AttributeType::$is_no_user_modification
    boolean: can use modify?

+							
$is_obsolete

+				
in file schema.inc, variable AttributeType::$is_obsolete
    string: the description

+							
$is_obsolete

+				
in file schema.inc, variable MatchingRule::$is_obsolete
    Boolean value indicating whether this MatchingRule is obsolete

+							
$is_obsolete

+				
in file schema.inc, variable ObjectClass::$is_obsolete
    boolean value indicating whether this objectClass is obsolete

+							
$is_single_value

+				
in file schema.inc, variable AttributeType::$is_single_value
    boolean: is single valued only?

+							
ieee802Device

+				
in file ieee802device.inc, class ieee802Device
    Provides MAC addresses for hosts.

+							
Image

+				
in file fpdf.php, method FPDF::Image()

+							
inetLocalMailRecipient

+				
in file inetLocalMailRecipient.inc, class inetLocalMailRecipient
    Provides mail routing for users.

+							
inetOrgPerson

+				
in file inetOrgPerson.inc, class inetOrgPerson
    This class contains all account LDAP attributes  and funtioncs required to deal with inetOrgPerson.

+							
init

+				
in file sambaAccount.inc, method sambaAccount::init()
    Initializes the module after it became part of an accountContainer

+							
init

+				
in file posixAccount.inc, method posixAccount::init()

+							
init

+				
in file baseModule.inc, method baseModule::init()
    Initializes the module after it became part of an accountContainer

+							
init

+				
in file sambaSamAccount.inc, method sambaSamAccount::init()
    Initializes the module after it became part of an accountContainer

+							
init

+				
in file quota.inc, method quota::init()

+							
init

+				
in file sambaGroupMapping.inc, method sambaGroupMapping::init()
    Initializes the module after it became part of an accountContainer

+							
init

+				
in file posixGroup.inc, method posixGroup::init()
    This functin will be called when the module will be loaded *

+							
initialize_session_tree

+				
in file tree.inc, function initialize_session_tree()
    Checks and fixes an initial session's tree cache if needed.

+							
initVars

+				
in file schema.inc, method SchemaItem::initVars()
    Initialize class members to default values.

+							
initVars

+				
in file schema.inc, method Syntax::initVars()
    Initializes the class' member variables

+							
initVars

+				
in file schema.inc, method MatchingRule::initVars()
    Initialize the class' member variables

+							
initVars

+				
in file schema.inc, method MatchingRuleUse::initVars()
    Initialize the class' member variables

+							
initVars

+				
in file schema.inc, method ObjectClass::initVars()
    Initialize the class' member variables

+							
initVars

+				
in file schema.inc, method AttributeType::initVars()
    Initialize the class' member variables

+							
in_array_ignore_case

+				
in file account.inc, function in_array_ignore_case()
    Checks if a string exists in an array, ignoring case.

+							
in_cache

+				
in file cache.inc, method cache::in_cache()
    This function returns the DN if an LDAP entry with $attribute=$value is found.

+							
isAliasFor

+				
in file schema.inc, method AttributeType::isAliasFor()
    Returns whether the specified attribute is an alias for this one (based on this attribute's alias list).

+							
isLAMProVersion

+				
in file selfService.inc, function isLAMProVersion()
    Returns if this is a LAM Pro installation.

+							
is_attr_binary

+				
in file tree.inc, function is_attr_binary()
    Given an attribute name and server ID number, this function returns  whether the attrbiute may contain binary data. This is useful for  developers who wish to display the contents of an arbitrary attribute  but don't want to dump binary data on the page.

+							
is_attr_boolean

+				
in file tree.inc, function is_attr_boolean()
    Given an attribute name and server ID number, this function returns  whether the attrbiute contains boolean data. This is useful for  developers who wish to display the contents of a boolean attribute  with a drop-down.

+							
is_base_module

+				
in file modules.inc, function is_base_module()
    Returns true if the module is a base module

+							
is_base_module

+				
in file baseModule.inc, method baseModule::is_base_module()
    Returns true if this module is enough to provide a sensible account.

+							
is_binary_option_required

+				
in file add_attr.php, function is_binary_option_required()

+							
is_browser_os_mac

+				
in file export.inc, function is_browser_os_mac()
    Determines whether the browser's operating system is Macintosh.

+							
is_browser_os_unix

+				
in file export.inc, function is_browser_os_unix()
    Determines whether the browser's operating system is UNIX (or something like UNIX).

+							
is_browser_os_windows

+				
in file export.inc, function is_browser_os_windows()
    Determines whether the browser's operating system is Windows.

+							
is_dn_attr

+				
in file tree.inc, function is_dn_attr()
    Returns true if the attribute specified is required to take as input a DN.

+							
is_jpeg_photo

+				
in file tree.inc, function is_jpeg_photo()
    Used to determine if the specified attribute is indeed a jpegPhoto. If the  specified attribute is one that houses jpeg data, true is returned. Otherwise  this function returns false.

+							
is_mail_string

+				
in file tree.inc, function is_mail_string()
    Get whether a string looks like an email address (user@example.com).

+							
is_multi_line_attr

+				
in file tree.inc, function is_multi_line_attr()
    Determines if an attribute's value can contain multiple lines. Attributes that fall  in this multi-line category may be configured in config.php. Hence, this function  accesses the global variable $multi_line_attributes;

+							
is_safe_ascii

+				
in file export.inc, method PlaExporter::is_safe_ascii()
    Helper method to check if the attribute value should be base 64 encoded.

+							
is_url_string

+				
in file tree.inc, function is_url_string()
    Get whether a string looks like a web URL (http://www.example.com/)

+							
ieee802device.inc

+				
procedural page ieee802device.inc

+							
inetLocalMailRecipient.inc

+				
procedural page inetLocalMailRecipient.inc

+							
inetOrgPerson.inc

+				
procedural page inetOrgPerson.inc

+							
index.php

+				
procedural page index.php

+							
initsuff.php

+				
procedural page initsuff.php

+							
index.php

+				
procedural page index.php

+					

+	

+	top

+  

+	
+	

+		
k

+		

+							
$k

+				
in file fpdf.php, variable FPDF::$k

+							
$keywords

+				
in file fpdf.php, variable FPDF::$keywords

+							
kolabUser

+				
in file kolabUser.inc, class kolabUser
    Manages Kolab user accounts.

+							
kolabUser

+				
in file kolabUser.inc, method kolabUser::kolabUser()
    Creates a new kolabUser object.

+							
kolabUser.inc

+				
procedural page kolabUser.inc

+					

+	

+	top

+  

+	
+	

+		
l

+		

+							
$labels

+				
in file lists.inc, variable lamList::$labels
    list of account specific labels

+							
$lasth

+				
in file fpdf.php, variable FPDF::$lasth

+							
$LayoutMode

+				
in file fpdf.php, variable FPDF::$LayoutMode

+							
$ldapcache

+				
in file cache.inc, variable cache::$ldapcache
    This variable contains the cache

+							
$LDAPPassword

+				
in file selfService.inc, variable selfServiceProfile::$LDAPPassword
    LDAP password

+							
$LDAPSuffix

+				
in file selfService.inc, variable selfServiceProfile::$LDAPSuffix
    LDAP suffix

+							
$LDAPUser

+				
in file selfService.inc, variable selfServiceProfile::$LDAPUser
    LDAP user DN

+							
$ldap_info

+				
in file export.inc, variable PlaLdapExporter::$ldap_info

+							
$LineWidth

+				
in file fpdf.php, variable FPDF::$LineWidth

+							
$links

+				
in file fpdf.php, variable FPDF::$links

+							
$lMargin

+				
in file fpdf.php, variable FPDF::$lMargin

+							
$logDestination

+				
in file config.inc, variable LAMCfgMain::$logDestination
    log destination ("SYSLOG":syslog, "/...":file, "NONE":none)

+							
$loginAttributeText

+				
in file selfService.inc, variable selfServiceProfile::$loginAttributeText
    describing text for search attribute

+							
$loginCaption

+				
in file selfService.inc, variable selfServiceProfile::$loginCaption
    describing text for user login

+							
$logLevel

+				
in file config.inc, variable LAMCfgMain::$logLevel
    log level

+							
LAMCfgMain

+				
in file config.inc, class LAMCfgMain
    This class manages config.cfg.

+							
LAMCfgMain

+				
in file config.inc, method LAMCfgMain::LAMCfgMain()
    Loads preferences from config file

+							
LAMConfig

+				
in file config.inc, class LAMConfig
    This class manages .conf files.

+							
LAMConfig

+				
in file config.inc, method LAMConfig::LAMConfig()
    Loads preferences from config file

+							
lamdaemon

+				
in file lamdaemon.inc, function lamdaemon()
    Sends commands to lamdaemon script.

+							
lamdaemonSSH

+				
in file lamdaemon.inc, function lamdaemonSSH()
    Sends commands to lamdaemon script via PHP SSH functions.

+							
lamGroupList

+				
in file group.inc, method lamGroupList::lamGroupList()
    Constructor

+							
lamGroupList

+				
in file group.inc, class lamGroupList
    Generates the list view.

+							
lamHostList

+				
in file host.inc, method lamHostList::lamHostList()
    Constructor

+							
lamHostList

+				
in file host.inc, class lamHostList
    Generates the list view.

+							
lamList

+				
in file lists.inc, method lamList::lamList()
    Constructor

+							
lamList

+				
in file lists.inc, class lamList
    Generates the list view.

+							
lamMailAliasList

+				
in file mailAlias.inc, method lamMailAliasList::lamMailAliasList()
    Constructor

+							
lamMailAliasList

+				
in file mailAlias.inc, class lamMailAliasList
    Generates the list view.

+							
lamPDF

+				
in file pdf.inc, class lamPDF
    Creates a LAM information page in PDF format.

+							
lamPDF

+				
in file pdf.inc, method lamPDF::lamPDF()

+							
LAMPDF_LINEWIDTH

+				
in file pdf.inc, constant LAMPDF_LINEWIDTH
    PDF line width

+							
lamSmbDomainList

+				
in file smbDomain.inc, class lamSmbDomainList
    Generates the list view.

+							
lamSmbDomainList

+				
in file smbDomain.inc, method lamSmbDomainList::lamSmbDomainList()
    Constructor

+							
lamTestLamdaemon

+				
in file lamdaemonTest.php, function lamTestLamdaemon()
    Runs a test case of lamdaemon.

+							
lamUserList

+				
in file user.inc, method lamUserList::lamUserList()
    Constructor

+							
lamUserList

+				
in file user.inc, class lamUserList
    Generates the list view.

+							
LAMVersion

+				
in file config.inc, function LAMVersion()
    Returns the version number of this LAM installation.

+							
Ldap

+				
in file ldap.inc, method Ldap::Ldap()

+							
Ldap

+				
in file ldap.inc, class Ldap
    Ldap manages connection to LDAP and includes several helper functions.

+							
LdapEscape

+				
in file export.inc, method PlaCSVExporter::LdapEscape()

+							
LdapExportInfo

+				
in file export.inc, class LdapExportInfo
    This class encapsulate informations about the ldap server  from which the export is done.

+							
LdapExportInfo

+				
in file export.inc, method LdapExportInfo::LdapExportInfo()
    Create a new LdapExportInfo object

+							
ldapPublicKey

+				
in file ldapPublicKey.inc, class ldapPublicKey
    Manages SSH public keys.

+							
lamdaemon.inc

+				
procedural page lamdaemon.inc

+							
ldap.inc

+				
procedural page ldap.inc

+							
lists.inc

+				
procedural page lists.inc

+							
ldapPublicKey.inc

+				
procedural page ldapPublicKey.inc

+							
Line

+				
in file fpdf.php, method FPDF::Line()

+							
Link

+				
in file fpdf.php, method FPDF::Link()

+							
listBuildFilter

+				
in file lists.inc, method lamList::listBuildFilter()
    Builds the regular expressions from the filter values.

+							
listDoPost

+				
in file user.inc, method lamUserList::listDoPost()
    Manages all POST actions (e.g. button pressed) for the account lists.

+							
listDoPost

+				
in file lists.inc, method lamList::listDoPost()
    Manages all POST actions (e.g. button pressed) for the account lists.

+							
listDrawNavigationBar

+				
in file lists.inc, method lamList::listDrawNavigationBar()
    Draws a navigation bar to switch between pages

+							
listFilterAccounts

+				
in file lists.inc, method lamList::listFilterAccounts()
    Removes all entries which do not fit to the filter.

+							
listGetAttributeDescriptionList

+				
in file lists.inc, method lamList::listGetAttributeDescriptionList()
    Returns an hash array containing with all attributes to be shown and their descriptions.

+							
listGetParams

+				
in file lists.inc, method lamList::listGetParams()
    Sets some internal parameters.

+							
listPrintButtons

+				
in file user.inc, method lamUserList::listPrintButtons()
    Prints the create, delete and PDF buttons.

+							
listPrintButtons

+				
in file lists.inc, method lamList::listPrintButtons()
    Prints the create, delete and PDF buttons.

+							
listPrintHeader

+				
in file lists.inc, method lamList::listPrintHeader()
    Prints the HTML head.

+							
listPrintJavaScript

+				
in file lists.inc, method lamList::listPrintJavaScript()
    Prints JavaScript code needed for mouse-over effects.

+							
listPrintTableBody

+				
in file user.inc, method lamUserList::listPrintTableBody()
    Prints the entry list

+							
listPrintTableBody

+				
in file lists.inc, method lamList::listPrintTableBody()
    Prints the entry list

+							
listPrintTableBody

+				
in file group.inc, method lamGroupList::listPrintTableBody()
    Prints the entry list

+							
listPrintTableHeader

+				
in file lists.inc, method lamList::listPrintTableHeader()
    Prints the attribute and filter row at the account table head

+							
listRefreshData

+				
in file lists.inc, method lamList::listRefreshData()
    Rereads the entries from LDAP.

+							
listShowOUSelection

+				
in file lists.inc, method lamList::listShowOUSelection()
    Prints a combobox with possible sub-DNs.

+							
listSort

+				
in file lists.inc, method lamList::listSort()
    Sorts an account list by a given attribute

+							
lmhash

+				
in file createntlm.inc, method smbHash::lmhash()
    Calculates the LM hash of a given password.

+							
lmPassword

+				
in file account.inc, function lmPassword()
    Generates the LM hash of a password.

+							
Ln

+				
in file fpdf.php, method FPDF::Ln()

+							
loadAccountProfile

+				
in file profiles.inc, function loadAccountProfile()
    Loads an profile of the given account type

+							
loadPDFStructureDefinitions

+				
in file pdfstruct.inc, function loadPDFStructureDefinitions()
    This function is used to get pdf structure from xml file.

+							
loadSelfServiceProfile

+				
in file selfService.inc, function loadSelfServiceProfile()
    Loads all settings of a self service profile.

+							
load_account

+				
in file modules.inc, method accountContainer::load_account()
    Loads an LDAP account with the given DN.

+							
load_attributes

+				
in file sambaAccount.inc, method sambaAccount::load_attributes()

+							
load_attributes

+				
in file quota.inc, method quota::load_attributes()

+							
load_attributes

+				
in file posixAccount.inc, method posixAccount::load_attributes()
    This function loads all needed LDAP attributes.

+							
load_attributes

+				
in file baseModule.inc, method baseModule::load_attributes()
    This function loads the LDAP attributes for this module.

+							
load_attributes

+				
in file sambaSamAccount.inc, method sambaSamAccount::load_attributes()

+							
load_Messages

+				
in file sambaSamAccount.inc, method sambaSamAccount::load_Messages()
    this functin fills the error message array with messages

+							
load_Messages

+				
in file baseModule.inc, method baseModule::load_Messages()
    This function fills the $messages variable with output messages from this module.

+							
load_Messages

+				
in file sambaGroupMapping.inc, method sambaGroupMapping::load_Messages()
    this functin fills the error message array with messages

+							
load_Messages

+				
in file shadowAccount.inc, method shadowAccount::load_Messages()
    This function builds up the message array.

+							
load_Messages

+				
in file ieee802device.inc, method ieee802Device::load_Messages()
    This function fills the error message array with messages

+							
load_Messages

+				
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::load_Messages()
    This function fills the error message array with messages

+							
load_Messages

+				
in file quota.inc, method quota::load_Messages()
    this functin fills the error message array with messages

+							
load_Messages

+				
in file inetOrgPerson.inc, method inetOrgPerson::load_Messages()
    This function fills the message array.

+							
load_Messages

+				
in file sambaDomain.inc, method sambaDomain::load_Messages()
    This function fills the error message array with messages

+							
load_Messages

+				
in file kolabUser.inc, method kolabUser::load_Messages()
    This function fills the error message array with messages

+							
load_Messages

+				
in file nisMailAlias.inc, method nisMailAlias::load_Messages()
    This function fills the error message array with messages

+							
load_Messages

+				
in file account.inc, method account::load_Messages()
    This function fills the message array.

+							
load_Messages

+				
in file posixGroup.inc, method posixGroup::load_Messages()
    This function fills the $messages variable with output messages from this module.

+							
load_Messages

+				
in file posixAccount.inc, method posixAccount::load_Messages()
    This function fills the error message array with messages.

+							
load_Messages

+				
in file sambaAccount.inc, method sambaAccount::load_Messages()
    this functin fills the error message array with messages

+							
load_profile

+				
in file quota.inc, method quota::load_profile()
    Loads the values of an account profile into internal variables.

+							
load_profile

+				
in file baseModule.inc, method baseModule::load_profile()
    Loads the values of an account profile into internal variables.

+							
load_profile

+				
in file sambaAccount.inc, method sambaAccount::load_profile()
    Loads the values of an account profile into internal variables.

+							
load_profile

+				
in file sambaGroupMapping.inc, method sambaGroupMapping::load_profile()
    Loads the values of an account profile into internal variables.

+							
load_profile

+				
in file shadowAccount.inc, method shadowAccount::load_profile()
    Loads the values of an account profile into internal variables.

+							
load_profile

+				
in file sambaSamAccount.inc, method sambaSamAccount::load_profile()
    Loads the values of an account profile into internal variables.

+							
load_profile

+				
in file posixAccount.inc, method posixAccount::load_profile()
    Loads the values of an account profile into internal variables.

+							
logNewMessage

+				
in file security.inc, function logNewMessage()
    Puts a new message in the log file.

+							
logoffAndBackToLoginPage

+				
in file security.inc, function logoffAndBackToLoginPage()
    Logs off the user and displays the login page.

+							
lshift

+				
in file createntlm.inc, method smbHash::lshift()

+							
list.php

+				
procedural page list.php

+							
login.php

+				
procedural page login.php

+							
logout.php

+				
procedural page logout.php

+							
lamdaemonTest.php

+				
procedural page lamdaemonTest.php

+					

+	

+	top

+  

+	
+	

+		
m

+		

+							
$mainPageText

+				
in file selfService.inc, variable selfServiceProfile::$mainPageText
    describing text for self service main page

+							
$maxlistentries

+				
in file config.inc, variable LAMConfig::$maxlistentries
    Maximum number of rows shown in user/group/host lists

+							
$maxPageEntries

+				
in file lists.inc, variable lamList::$maxPageEntries
    maximum count of entries per page

+							
$MAX_LDIF_LINE_LENGTH

+				
in file export.inc, variable PlaLdifExporter::$MAX_LDIF_LINE_LENGTH

+							
$max_length

+				
in file schema.inc, variable AttributeType::$max_length
    The max number of characters this attribute can be

+							
$may_attrs

+				
in file schema.inc, variable ObjectClass::$may_attrs
    arrays of attribute names that this objectClass allows, but does not require

+							
$messages

+				
in file baseModule.inc, variable baseModule::$messages
    contains all error messages of a module

+							
$meta

+				
in file baseModule.inc, variable baseModule::$meta
    includes all meta data provided by the sub class

+							
$module

+				
in file modules.inc, variable accountContainer::$module
    This is an array with all module objects

+							
$moduleSettings

+				
in file baseModule.inc, variable baseModule::$moduleSettings
    configuration settings of all modules

+							
$moduleSettings

+				
in file config.inc, variable LAMConfig::$moduleSettings
    module settings

+							
$multivalue_separator

+				
in file export.inc, variable PlaCSVExporter::$multivalue_separator

+							
$must_attrs

+				
in file schema.inc, variable ObjectClass::$must_attrs
    arrays of attribute names that this objectClass requires

+							
modules.inc

+				
procedural page modules.inc

+							
mailAlias.inc

+				
procedural page mailAlias.inc

+							
mailAlias

+				
in file mailAlias.inc, class mailAlias
    The account type for mail aliases.

+							
MatchingRule

+				
in file schema.inc, method MatchingRule::MatchingRule()
    Creates a new MatchingRule object from a raw LDAP MatchingRule string.

+							
MatchingRule

+				
in file schema.inc, class MatchingRule
    Represents an LDAP MatchingRule

+							
MatchingRuleUse

+				
in file schema.inc, method MatchingRuleUse::MatchingRuleUse()

+							
MatchingRuleUse

+				
in file schema.inc, class MatchingRuleUse
    Represents an LDAP schema matchingRuleUse entry

+							
metaRefresh

+				
in file config.inc, function metaRefresh()
    Prints a meta refresh page

+							
module_complete

+				
in file sambaAccount.inc, method sambaAccount::module_complete()
    This functions returns true if all needed settings are done

+							
module_complete

+				
in file quota.inc, method quota::module_complete()

+							
module_complete

+				
in file posixGroup.inc, method posixGroup::module_complete()
    This functions is used to check if all settings for this module have been made.

+							
module_complete

+				
in file posixAccount.inc, method posixAccount::module_complete()
    This functions is used to check if all settings for this module have been made.

+							
module_complete

+				
in file kolabUser.inc, method kolabUser::module_complete()
    This function returns true if all needed settings are done.

+							
module_complete

+				
in file account.inc, method account::module_complete()
    This functions returns true if all needed settings are done.

+							
module_complete

+				
in file baseModule.inc, method baseModule::module_complete()
    This functions is used to check if all settings for this module have been made.

+							
module_complete

+				
in file sambaGroupMapping.inc, method sambaGroupMapping::module_complete()

+							
module_complete

+				
in file inetOrgPerson.inc, method inetOrgPerson::module_complete()
    This functions return true if all needed settings are done.

+							
module_complete

+				
in file sambaSamAccount.inc, method sambaSamAccount::module_complete()
    This functions is used to check if all settings for this module have been made.

+							
module_ready

+				
in file sambaAccount.inc, method sambaAccount::module_ready()

+							
module_ready

+				
in file sambaGroupMapping.inc, method sambaGroupMapping::module_ready()

+							
module_ready

+				
in file baseModule.inc, method baseModule::module_ready()
    This function is used to check if this module page can be displayed.

+							
module_ready

+				
in file sambaSamAccount.inc, method sambaSamAccount::module_ready()
    This function is used to check if this module page can be displayed.

+							
module_ready

+				
in file quota.inc, method quota::module_ready()

+							
MultiCell

+				
in file ufpdf.php, method UFPDF::MultiCell()

+							
MultiCell

+				
in file fpdf.php, method FPDF::MultiCell()

+							
multi_lines_display

+				
in file export.inc, method PlaLdifExporter::multi_lines_display()
    Helper method to wrap ldif lines

+							
mxor

+				
in file createntlm.inc, method smbHash::mxor()

+							
MyCustomExporter

+				
in file export.inc, class MyCustomExporter

+							
MyCutsomExporter

+				
in file export.inc, method MyCustomExporter::MyCutsomExporter()

+							
mainlogin.php

+				
procedural page mainlogin.php

+							
mainmanage.php

+				
procedural page mainmanage.php

+							
main_header.php

+				
procedural page main_header.php

+							
main.php

+				
procedural page main.php

+							
massBuildAccounts.php

+				
procedural page massBuildAccounts.php

+							
masscreate.php

+				
procedural page masscreate.php

+							
massDoUpload.php

+				
procedural page massDoUpload.php

+					

+	

+	top

+  

+	
+	

+		
n

+		

+							
$n

+				
in file fpdf.php, variable FPDF::$n

+							
$name

+				
in file schema.inc, variable MatchingRule::$name
    This rule's name

+							
$name

+				
in file schema.inc, variable ObjectClassAttribute::$name
    This Attribute's name

+							
$name

+				
in file schema.inc, variable AttributeType::$name
    The name of this attributeType

+							
$name

+				
in file schema.inc, variable ObjectClass::$name
    This objectClass' name, ie "inetOrgPerson"

+							
$name

+				
in file schema.inc, variable MatchingRuleUse::$name
    The name of the MathingRule this applies to

+							
$name

+				
in file account.inc, variable samba3domain::$name
    Domain name

+							
$nextGroupRID

+				
in file account.inc, variable samba3domain::$nextGroupRID
    Next group RID

+							
$nextRID

+				
in file account.inc, variable samba3domain::$nextRID
    Next RID

+							
$nextUserRID

+				
in file account.inc, variable samba3domain::$nextUserRID
    Next user RID

+							
$noexpire

+				
in file sambaAccount.inc, variable sambaAccount::$noexpire
    password does not expire?

+							
$noexpire

+				
in file sambaSamAccount.inc, variable sambaSamAccount::$noexpire
    password does not expire?

+							
$nopwd

+				
in file sambaSamAccount.inc, variable sambaSamAccount::$nopwd
    use no password?

+							
$nopwd

+				
in file sambaAccount.inc, variable sambaAccount::$nopwd
    use no password?

+							
$num_entries

+				
in file export.inc, variable PlaLdapExporter::$num_entries

+							
nisMailAlias.inc

+				
procedural page nisMailAlias.inc

+							
new_account

+				
in file modules.inc, method accountContainer::new_account()
    This function will prepare the object for a new account.

+							
new_rand

+				
in file ldap.inc, method Ldap::new_rand()
    Calculates a new value for rand

+							
nisMailAlias

+				
in file nisMailAlias.inc, class nisMailAlias
    Provides NIS mail alias management.

+							
not_an_attr

+				
in file add_attr_form.php, function not_an_attr()
    Given an attribute $x, this returns true if it is NOT already specified  in the current entry, returns false otherwise.

+							
nthash

+				
in file createntlm.inc, method smbHash::nthash()
    Calculates the NT hash of a given password.

+							
ntPassword

+				
in file account.inc, function ntPassword()
    Generates the NT hash of a password.

+							
new_ou_template.php

+				
procedural page new_ou_template.php

+					

+	

+	top

+  

+	
+	

+		
o

+		

+							
$objectClasses

+				
in file ldap.inc, variable Ldap::$objectClasses
    Array with all objectClass strings from the LDAP server

+							
$offsets

+				
in file fpdf.php, variable FPDF::$offsets

+							
$oid

+				
in file schema.inc, variable SchemaItem::$oid
    The OID of this schema item.

+							
$order

+				
in file modules.inc, variable accountContainer::$order
    Module order

+							
$ordering

+				
in file schema.inc, variable AttributeType::$ordering
    The ordering of the attributeType

+							
$OrientationChanges

+				
in file fpdf.php, variable FPDF::$OrientationChanges

+							
$orig

+				
in file baseModule.inc, variable baseModule::$orig
    contains all ldap attributes which are loaded from ldap

+							
ObjectClass

+				
in file schema.inc, method ObjectClass::ObjectClass()
    Creates a new ObjectClass object given a raw LDAP objectClass string.

+							
ObjectClass

+				
in file schema.inc, class ObjectClass
    Represents an LDAP objectClass

+							
ObjectClassAttribute

+				
in file schema.inc, method ObjectClassAttribute::ObjectClassAttribute()
    Creates a new ObjectClassAttribute with specified name and source objectClass.

+							
ObjectClassAttribute

+				
in file schema.inc, class ObjectClassAttribute
    A simple class for representing AttributeTypes used only by the ObjectClass class.

+							
Open

+				
in file fpdf.php, method FPDF::Open()

+							
Output

+				
in file fpdf.php, method FPDF::Output()

+							
ou_edit.php

+				
procedural page ou_edit.php

+					

+	

+	top

+  

+	
+	

+		
p

+		

+							
$page

+				
in file fpdf.php, variable FPDF::$page

+							
$page

+				
in file lists.inc, variable lamList::$page
    current page number

+							
$PageBreakTrigger

+				
in file fpdf.php, variable FPDF::$PageBreakTrigger

+							
$PageLinks

+				
in file fpdf.php, variable FPDF::$PageLinks

+							
$pages

+				
in file fpdf.php, variable FPDF::$pages

+							
$page_definitions

+				
in file pdf.inc, variable lamPDF::$page_definitions
    format settings for page layout

+							
$Passwd

+				
in file config.inc, variable LAMConfig::$Passwd
    Password to edit preferences

+							
$password

+				
in file config.inc, variable LAMCfgMain::$password
    Password to change config.cfg

+							
$password

+				
in file ldap.inc, variable Ldap::$password
    LDAP password used for bind

+							
$PDFVersion

+				
in file fpdf.php, variable FPDF::$PDFVersion

+							
$perm1

+				
in file createntlm.inc, variable smbHash::$perm1

+							
$perm2

+				
in file createntlm.inc, variable smbHash::$perm2

+							
$perm3

+				
in file createntlm.inc, variable smbHash::$perm3

+							
$perm4

+				
in file createntlm.inc, variable smbHash::$perm4

+							
$perm5

+				
in file createntlm.inc, variable smbHash::$perm5

+							
$perm6

+				
in file createntlm.inc, variable smbHash::$perm6

+							
$possibleSuffixes

+				
in file lists.inc, variable lamList::$possibleSuffixes
    list of possible LDAP suffixes(organizational units)

+							
posixAccount.inc

+				
procedural page posixAccount.inc

+							
posixGroup.inc

+				
procedural page posixGroup.inc

+							
pdfstruct.inc

+				
procedural page pdfstruct.inc

+							
pdf.inc

+				
procedural page pdf.inc

+							
profiles.inc

+				
procedural page profiles.inc

+							
PageNo

+				
in file fpdf.php, method FPDF::PageNo()

+							
parse

+				
in file xml_parser.inc, method xmlParser::parse()

+							
parseHtml

+				
in file modules.inc, function parseHtml()
    Takes a list of meta-HTML elements and prints the equivalent HTML output.

+							
permute

+				
in file createntlm.inc, method smbHash::permute()

+							
PlaAbstractExporter

+				
in file export.inc, class PlaAbstractExporter
    This class represents the base class of all exporters

+							
PlaCSVExporter

+				
in file export.inc, class PlaCSVExporter
    Export to cvs format

+							
PlaCSVExporter

+				
in file export.inc, method PlaCSVExporter::PlaCSVExporter()

+							
PlaDsmlExporter

+				
in file export.inc, class PlaDsmlExporter
    Export entries to DSML v.1

+							
PlaDsmlExporter

+				
in file export.inc, method PlaDsmlExporter::PlaDsmlExporter()
    Create a PlaDsmlExporter object

+							
PlaExporter

+				
in file export.inc, class PlaExporter
    PlaExporter acts a wrapper around another exporter.

+							
PlaExporter

+				
in file export.inc, method PlaExporter::PlaExporter()
    Constructor

+							
PlaLdapExporter

+				
in file export.inc, class PlaLdapExporter
    Export data from a ldap server

+							
PlaLdapExporter

+				
in file export.inc, method PlaLdapExporter::PlaLdapExporter()
    Create a PlaLdapExporter object.

+							
PlaLdifExporter

+				
in file export.inc, class PlaLdifExporter
    Export entries to ldif format

+							
PlaLdifExporter

+				
in file export.inc, method PlaLdifExporter::PlaLdifExporter()
    Create a PlaLdifExporter object

+							
PlaVcardExporter

+				
in file export.inc, class PlaVcardExporter

+							
PlaVcardExporter

+				
in file export.inc, method PlaVcardExporter::PlaVcardExporter()

+							
pla_compare_dns

+				
in file tree.inc, function pla_compare_dns()
    Compares 2 DNs. If they are equivelant, returns 0, otherwise,  returns their sorting order (similar to strcmp()):       Returns < 0 if dn1 is less than dn2.

+							
pla_explode_dn

+				
in file tree.inc, function pla_explode_dn()
    Explode a DN into an array of its RDN parts. This function is UTF-8 safe  and replaces the buggy PHP ldap_explode_dn() which does not properly  handle UTF-8 DNs and also causes segmentation faults with some inputs.

+							
pla_fetch_entry_array

+				
in file export.inc, method PlaLdapExporter::pla_fetch_entry_array()
    Return the entry as an array

+							
pla_fetch_entry_array

+				
in file export.inc, method PlaAbstractExporter::pla_fetch_entry_array()
    Return the entry as an array

+							
pla_fetch_entry_array

+				
in file export.inc, method PlaExporter::pla_fetch_entry_array()
    Return the entry as an array

+							
pla_fetch_entry_object

+				
in file export.inc, method PlaExporter::pla_fetch_entry_object()
    Return the entry as an Entry object

+							
pla_fetch_entry_object

+				
in file export.inc, method PlaAbstractExporter::pla_fetch_entry_object()
    Return the entry as an Entry object

+							
pla_fetch_entry_object

+				
in file export.inc, method PlaLdapExporter::pla_fetch_entry_object()
    Return the entry as an Entry object

+							
pla_get_ldap_info

+				
in file export.inc, method PlaAbstractExporter::pla_get_ldap_info()
    Return a PlaLdapInfo Object

+							
pla_get_ldap_info

+				
in file export.inc, method PlaExporter::pla_get_ldap_info()
    Return a PlaLdapInfo Object

+							
pla_get_ldap_info

+				
in file export.inc, method PlaLdapExporter::pla_get_ldap_info()
    Return a PlaLdapInfo Object

+							
pla_has_entry

+				
in file export.inc, method PlaExporter::pla_has_entry()
    Return true if there is some more entries to be processed

+							
pla_has_entry

+				
in file export.inc, method PlaLdapExporter::pla_has_entry()
    Return true if there is some more entries to be processed

+							
pla_has_entry

+				
in file export.inc, method PlaAbstractExporter::pla_has_entry()
    Return true if there is some more entries to be processed

+							
pla_ldap_search

+				
in file tree.inc, function pla_ldap_search()
    A handy ldap searching function very similar to PHP's ldap_search() with the  following exceptions: Callers may specify a search scope and the return value  is an array containing the search results rather than an LDAP result resource.

+							
pla_num_entries

+				
in file export.inc, method PlaLdapExporter::pla_num_entries()
    Return the number of entries

+							
pla_num_entries

+				
in file export.inc, method PlaAbstractExporter::pla_num_entries()
    Return the number of entries

+							
pla_num_entries

+				
in file export.inc, method PlaExporter::pla_num_entries()
    Return the number of entries

+							
pla_rdelete

+				
in file rdelete.php, function pla_rdelete()

+							
pla_reverse_dn

+				
in file tree.inc, function pla_reverse_dn()
    Reverses a DN such that the top-level RDN is first and the bottom-level RDN is last

+							
posixAccount

+				
in file posixAccount.inc, class posixAccount
    Manages the object class "posixAccount" for users and hosts.

+							
posixGroup

+				
in file posixGroup.inc, class posixGroup
    Manages the object class "posixGroup" for groups.

+							
pretty_print_dn

+				
in file tree.inc, function pretty_print_dn()
    Returns an HTML-beautified version of a DN.

+							
processAttributes

+				
in file pdf.inc, function processAttributes()
    Processes width, height and alignment attributes.

+							
processFormatTags

+				
in file pdf.inc, function processFormatTags()
    Formats the XML code.

+							
processLine

+				
in file pdf.inc, function processLine()
    Creates the XML code for an PDF entry.

+							
process_attributes

+				
in file posixAccount.inc, method posixAccount::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file sambaSamAccount.inc, method sambaSamAccount::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file sambaAccount.inc, method sambaAccount::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file sambaDomain.inc, method sambaDomain::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file sambaGroupMapping.inc, method sambaGroupMapping::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file posixGroup.inc, method posixGroup::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file quota.inc, method quota::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file ldapPublicKey.inc, method ldapPublicKey::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file kolabUser.inc, method kolabUser::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file account.inc, method account::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file nisMailAlias.inc, method nisMailAlias::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file ieee802device.inc, method ieee802Device::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file inetOrgPerson.inc, method inetOrgPerson::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file shadowAccount.inc, method shadowAccount::process_attributes()
    Processes user input of the primary module page.

+							
process_deleteUser

+				
in file kolabUser.inc, method kolabUser::process_deleteUser()
    Write variables into object and do some regex checks

+							
process_expire

+				
in file shadowAccount.inc, method shadowAccount::process_expire()
    Processes user input of the expiration page.

+							
process_group

+				
in file posixAccount.inc, method posixAccount::process_group()
    Processes user input of the group selection page.

+							
process_logonHours

+				
in file sambaSamAccount.inc, method sambaSamAccount::process_logonHours()
    Processes user input of the logon hours page.

+							
process_password

+				
in file inetOrgPerson.inc, method inetOrgPerson::process_password()
    Sets a new password.

+							
process_password

+				
in file posixGroup.inc, method posixGroup::process_password()
    Processes user input of the password page.

+							
process_password

+				
in file posixAccount.inc, method posixAccount::process_password()
    Processes user input of the password page.

+							
process_photo

+				
in file inetOrgPerson.inc, method inetOrgPerson::process_photo()
    Sets a new photo.

+							
process_sambaUserWorkstations

+				
in file sambaSamAccount.inc, method sambaSamAccount::process_sambaUserWorkstations()
    Processes user input of the primary module page.

+							
process_time

+				
in file sambaSamAccount.inc, method sambaSamAccount::process_time()
    Processes user input of the time selection page.

+							
process_user

+				
in file posixGroup.inc, method posixGroup::process_user()
    Processes user input of the user selection page.

+							
process_userWorkstations

+				
in file sambaAccount.inc, method sambaAccount::process_userWorkstations()
    Processes user input of the workstation selection page.

+							
pwd_disable

+				
in file account.inc, function pwd_disable()
    Marks an password hash as disabled and returns the new hash string

+							
pwd_enable

+				
in file account.inc, function pwd_enable()
    Marks an password hash as enabled and returns the new hash string

+							
pwd_hash

+				
in file account.inc, function pwd_hash()
    Returns the hash value of a plain text password  the hash algorithm depends on the configuration file

+							
pwd_is_enabled

+				
in file account.inc, function pwd_is_enabled()
    Checks if a password hash is enabled/disabled

+							
profmanage.php

+				
procedural page profmanage.php

+							
pdfdelete.php

+				
procedural page pdfdelete.php

+							
pdfmain.php

+				
procedural page pdfmain.php

+							
pdfpage.php

+				
procedural page pdfpage.php

+							
profiledelete.php

+				
procedural page profiledelete.php

+							
profilemain.php

+				
procedural page profilemain.php

+							
profilepage.php

+				
procedural page profilepage.php

+							
profManage.php

+				
procedural page profManage.php

+					

+	

+	top

+  

+	
+	

+		
q

+		

+							
$qualifier

+				
in file export.inc, variable PlaCSVExporter::$qualifier

+							
$queryFilter

+				
in file export.inc, variable PlaLdapExporter::$queryFilter

+							
$query_filter

+				
in file export.inc, variable LdapExportInfo::$query_filter

+							
$quota

+				
in file quota.inc, variable quota::$quota

+							
quota.inc

+				
procedural page quota.inc

+							
quota

+				
in file quota.inc, class quota
    Manages quotas for users and groups.

+					

+	

+	top

+  

+	
+	

+		
r

+		

+							
$rand

+				
in file ldap.inc, variable Ldap::$rand
    Random number (changes on every page request)

+							
$rdn

+				
in file modules.inc, variable accountContainer::$rdn
    RDN attribute of this account

+							
$refresh

+				
in file lists.inc, variable lamList::$refresh
    refresh page switch

+							
$required_by_object_classes

+				
in file schema.inc, variable AttributeType::$required_by_object_classes
    A list of object class names that require this attribute type.

+							
$results

+				
in file export.inc, variable PlaLdapExporter::$results

+							
$RIDbase

+				
in file account.inc, variable samba3domain::$RIDbase
    RID base to calculate RIDs, default 1000

+							
$rids

+				
in file sambaGroupMapping.inc, variable sambaGroupMapping::$rids
    Array of well known RIDs

+							
$rids

+				
in file sambaSamAccount.inc, variable sambaSamAccount::$rids
    array of well known rids

+							
$rids

+				
in file sambaAccount.inc, variable sambaAccount::$rids
    Array of well known rids

+							
$rMargin

+				
in file fpdf.php, variable FPDF::$rMargin

+							
real_attr_name

+				
in file tree.inc, function real_attr_name()
    Prunes off anything after the ";" in an attr name. This is useful for  attributes that may have ";binary" appended to their names. With  real_attr_name(), you can more easily fetch these attributes' schema  with their "real" attribute name.

+							
Rect

+				
in file fpdf.php, method FPDF::Rect()

+							
refresh_cache

+				
in file cache.inc, method cache::refresh_cache()
    This function refreshes the cache.

+							
reload

+				
in file config.inc, method LAMCfgMain::reload()
    Reloads preferences from config file config.cfg

+							
reload

+				
in file config.inc, method LAMConfig::reload()
    Reloads preferences from config file

+							
removeAlias

+				
in file schema.inc, method AttributeType::removeAlias()
    Removes an attribute name from this attribute's alias array.

+							
remove_aliases

+				
in file custom.php, function remove_aliases()
    Removes attributes from the array that are aliases for eachother

+							
RndInt

+				
in file account.inc, function RndInt()
    THIS FUNCTION GENERATES A RANDOM NUMBER THAT WILL BE USED TO  RANDOMLY SELECT CHARACTERS.

+							
rdelete.php

+				
procedural page rdelete.php

+							
refresh.php

+				
procedural page refresh.php

+					

+	

+	top

+  

+	
+	

+		
s

+		

+							
$sambaGroupTypes

+				
in file sambaGroupMapping.inc, variable sambaGroupMapping::$sambaGroupTypes
    Array of sambaGroupTypes

+							
$sbox

+				
in file createntlm.inc, variable smbHash::$sbox

+							
$sc

+				
in file createntlm.inc, variable smbHash::$sc

+							
$scope

+				
in file baseModule.inc, variable baseModule::$scope
    the account type of this module (user, group, host)

+							
$scope

+				
in file export.inc, variable LdapExportInfo::$scope

+							
$scope

+				
in file export.inc, variable PlaLdapExporter::$scope

+							
$scriptPath

+				
in file config.inc, variable LAMConfig::$scriptPath
    Path to external lamdaemon script on server where it is executed

+							
$scriptServer

+				
in file config.inc, variable LAMConfig::$scriptServer
    Server where lamdaemon script is executed

+							
$searchAttribute

+				
in file selfService.inc, variable selfServiceProfile::$searchAttribute
    LDAP search attribute

+							
$separator

+				
in file export.inc, variable PlaCSVExporter::$separator
    When doing an exporter, the method export need to be overriden.

+							
$server

+				
in file ldap.inc, variable Ldap::$server
    Server handle

+							
$ServerURL

+				
in file config.inc, variable LAMConfig::$ServerURL
    Server address (e.g. ldap://127.0.0.1:389)

+							
$serverURL

+				
in file selfService.inc, variable selfServiceProfile::$serverURL
    server address

+							
$sessionTimeout

+				
in file config.inc, variable LAMCfgMain::$sessionTimeout
    Time of inactivity before session times out (minutes)

+							
$settings

+				
in file config.inc, variable LAMConfig::$settings
    List of all settings in config file

+							
$settings

+				
in file config.inc, variable LAMCfgMain::$settings
    list of data fields to save in config file

+							
$SID

+				
in file account.inc, variable samba3domain::$SID
    Domain SID

+							
$sortColumn

+				
in file lists.inc, variable lamList::$sortColumn
    sort column name

+							
$source

+				
in file schema.inc, variable ObjectClassAttribute::$source
    This Attribute's root

+							
$state

+				
in file fpdf.php, variable FPDF::$state

+							
$subject

+				
in file fpdf.php, variable FPDF::$subject

+							
$subpage

+				
in file modules.inc, variable accountContainer::$subpage
    This variable is set to the pagename of a subpage if it should be displayed

+							
$sub_str

+				
in file schema.inc, variable AttributeType::$sub_str
    Boolean: supports substring matching?

+							
$suffix

+				
in file lists.inc, variable lamList::$suffix
    LDAP suffix

+							
$supports_unix_hosts

+				
in file ldap.inc, variable Ldap::$supports_unix_hosts
    Host attribute in inetOrgPerson

+							
$sup_attribute

+				
in file schema.inc, variable AttributeType::$sup_attribute
    The attribute from which this attribute inherits (if any)

+							
$sup_classes

+				
in file schema.inc, variable ObjectClass::$sup_classes
    array of objectClass names from which this objectClass inherits

+							
$syntax

+				
in file schema.inc, variable AttributeType::$syntax
    The full syntax string, ie 1.2.3.4{16}

+							
$syntax

+				
in file schema.inc, variable MatchingRule::$syntax
    This rule's syntax OID

+							
sambaAccount.inc

+				
procedural page sambaAccount.inc

+							
sambaDomain.inc

+				
procedural page sambaDomain.inc

+							
sambaGroupMapping.inc

+				
procedural page sambaGroupMapping.inc

+							
sambaSamAccount.inc

+				
procedural page sambaSamAccount.inc

+							
shadowAccount.inc

+				
procedural page shadowAccount.inc

+							
schema.inc

+				
procedural page schema.inc

+							
security.inc

+				
procedural page security.inc

+							
selfService.inc

+				
procedural page selfService.inc

+							
status.inc

+				
procedural page status.inc

+							
smbDomain.inc

+				
procedural page smbDomain.inc

+							
samba3domain

+				
in file account.inc, class samba3domain
    Represents a Samba 3 domain entry

+							
sambaAccount

+				
in file sambaAccount.inc, method sambaAccount::sambaAccount()
    Creates a new sambaAccount object.

+							
sambaAccount

+				
in file sambaAccount.inc, class sambaAccount
    Manages the object class "sambaAccount" for users and hosts.

+							
sambaDomain

+				
in file sambaDomain.inc, class sambaDomain
    Manages Samba 3 domain entries.

+							
sambaGroupMapping

+				
in file sambaGroupMapping.inc, method sambaGroupMapping::sambaGroupMapping()
    Creates a new module for Samba 3 groups.

+							
sambaGroupMapping

+				
in file sambaGroupMapping.inc, class sambaGroupMapping
    Manages the object class "sambaGroupMapping" for groups.

+							
sambaSamAccount

+				
in file sambaSamAccount.inc, method sambaSamAccount::sambaSamAccount()
    Creates a new sambaSamAccount object.

+							
sambaSamAccount

+				
in file sambaSamAccount.inc, class sambaSamAccount
    Manages the object class "sambaSamAccount" for users and hosts.

+							
save

+				
in file config.inc, method LAMConfig::save()
    Saves preferences to config file

+							
save

+				
in file config.inc, method LAMCfgMain::save()
    Saves preferences to config file config.cfg

+							
saveAccountProfile

+				
in file profiles.inc, function saveAccountProfile()
    Saves an hash array (attribute => value) to an account profile

+							
savePDFStructureDefinitions

+				
in file pdfstruct.inc, function savePDFStructureDefinitions()
    Saves PDF structure definitions to XML file in format: <name>.<scope>.xml

+							
saveSelfServiceProfile

+				
in file selfService.inc, function saveSelfServiceProfile()
    Saves a self service profile.

+							
saveSettings

+				
in file confmain.php, function saveSettings()
    Saves the entered settings.

+							
save_account

+				
in file modules.inc, method accountContainer::save_account()
    This function will save an account to the LDAP database.

+							
save_attributes

+				
in file nisMailAlias.inc, method nisMailAlias::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.

+							
save_attributes

+				
in file inetOrgPerson.inc, method inetOrgPerson::save_attributes()

+							
save_attributes

+				
in file kolabUser.inc, method kolabUser::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.

+							
save_attributes

+				
in file account.inc, method account::save_attributes()

+							
save_attributes

+				
in file posixAccount.inc, method posixAccount::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.

+							
save_attributes

+				
in file baseModule.inc, method baseModule::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.

+							
save_attributes

+				
in file sambaSamAccount.inc, method sambaSamAccount::save_attributes()

+							
save_attributes

+				
in file sambaAccount.inc, method sambaAccount::save_attributes()

+							
save_attributes

+				
in file shadowAccount.inc, method shadowAccount::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.

+							
save_attributes

+				
in file posixGroup.inc, method posixGroup::save_attributes()

+							
save_attributes

+				
in file quota.inc, method quota::save_attributes()

+							
save_attributes

+				
in file sambaGroupMapping.inc, method sambaGroupMapping::save_attributes()

+							
save_module_attributes

+				
in file modules.inc, method accountContainer::save_module_attributes()
    This function checks which LDAP attributes have changed while the account was edited.

+							
SchemaItem

+				
in file schema.inc, class SchemaItem
    Generic parent class for all schema items. A schema item is  an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.

+							
SchemaItem

+				
in file schema.inc, method SchemaItem::SchemaItem()
    Default constructor.

+							
SCHEMA_SESSION_CACHE_ENABLED

+				
in file schema.inc, constant SCHEMA_SESSION_CACHE_ENABLED
    To enable/disable session-based schema caching (1: enabled, 0: disabled).

+							
search_domains

+				
in file account.inc, function search_domains()
    Returns an array with all Samba 3 domain entries under the given suffix

+							
search_units

+				
in file ldap.inc, method Ldap::search_units()
    Returns an array with all organizational units under the given suffix

+							
search_username

+				
in file userlink.php, function search_username()
    Searches LDAP for a specific user name (uid attribute) and returns its DN entry

+							
selfServiceProfile

+				
in file selfService.inc, class selfServiceProfile
    Includes all settings of a self service profile.

+							
selfServiceProfile

+				
in file selfService.inc, method selfServiceProfile::selfServiceProfile()
    Constructor

+							
server

+				
in file ldap.inc, method Ldap::server()
    Returns the LDAP connection handle

+							
setAliases

+				
in file schema.inc, method AttributeType::setAliases()
    Sets this attribute's list of aliases.

+							
SetAuthor

+				
in file fpdf.php, method FPDF::SetAuthor()

+							
SetAutoPageBreak

+				
in file fpdf.php, method FPDF::SetAutoPageBreak()

+							
SetCompression

+				
in file fpdf.php, method FPDF::SetCompression()

+							
SetCreator

+				
in file fpdf.php, method FPDF::SetCreator()

+							
setDescription

+				
in file schema.inc, method SchemaItem::setDescription()

+							
SetDisplayMode

+				
in file fpdf.php, method FPDF::SetDisplayMode()

+							
SetDrawColor

+				
in file fpdf.php, method FPDF::SetDrawColor()

+							
SetFillColor

+				
in file fpdf.php, method FPDF::SetFillColor()

+							
SetFont

+				
in file fpdf.php, method FPDF::SetFont()

+							
SetFontSize

+				
in file fpdf.php, method FPDF::SetFontSize()

+							
setIsSingleValue

+				
in file schema.inc, method AttributeType::setIsSingleValue()
    Sets whether this attribute is single-valued.

+							
SetKeywords

+				
in file fpdf.php, method FPDF::SetKeywords()

+							
setlanguage

+				
in file config.inc, function setlanguage()
    Sets language settings for automatic translation

+							
SetLeftMargin

+				
in file fpdf.php, method FPDF::SetLeftMargin()

+							
SetLineWidth

+				
in file fpdf.php, method FPDF::SetLineWidth()

+							
SetLink

+				
in file fpdf.php, method FPDF::SetLink()

+							
SetMargins

+				
in file fpdf.php, method FPDF::SetMargins()

+							
setName

+				
in file schema.inc, method AttributeType::setName()
    Sets this attriute's name.

+							
setOID

+				
in file schema.inc, method SchemaItem::setOID()

+							
setOutputFormat

+				
in file export.inc, method PlaExporter::setOutputFormat()
    Set the carriage return /linefeed for the export

+							
SetRightMargin

+				
in file fpdf.php, method FPDF::SetRightMargin()

+							
SetSubject

+				
in file fpdf.php, method FPDF::SetSubject()

+							
setSupAttribute

+				
in file schema.inc, method AttributeType::setSupAttribute()
    Sets this attriute's SUP attribute (ie, the attribute from which this attribute inherits).

+							
SetTextColor

+				
in file fpdf.php, method FPDF::SetTextColor()

+							
SetTitle

+				
in file fpdf.php, method FPDF::SetTitle()

+							
SetTopMargin

+				
in file fpdf.php, method FPDF::SetTopMargin()

+							
setType

+				
in file schema.inc, method AttributeType::setType()
    Sets this attribute's type.

+							
setUsedByAttrs

+				
in file schema.inc, method MatchingRule::setUsedByAttrs()
    Sets the list of used_by_attrs to the array specified by $attrs;

+							
SetX

+				
in file fpdf.php, method FPDF::SetX()

+							
SetXY

+				
in file fpdf.php, method FPDF::SetXY()

+							
SetY

+				
in file fpdf.php, method FPDF::SetY()

+							
set_AccountModules

+				
in file config.inc, method LAMConfig::set_AccountModules()
    Sets the selected account modules

+							
set_ActiveTypes

+				
in file config.inc, method LAMConfig::set_ActiveTypes()
    Sets the list of active types.

+							
set_Adminstring

+				
in file config.inc, method LAMConfig::set_Adminstring()
    Sets the admin string

+							
set_cached_schema

+				
in file schema.inc, function set_cached_schema()
    Caches the specified $schema_type.

+							
set_cacheTimeout

+				
in file config.inc, method LAMConfig::set_cacheTimeout()
    Sets the LDAP cache timeout in minutes (0,1,2,5,10,15)

+							
set_defaultLanguage

+				
in file config.inc, method LAMConfig::set_defaultLanguage()
    Sets the default language string

+							
set_listAttributes

+				
in file config.inc, method LAMConfig::set_listAttributes()
    Sets the list of attributes to show in user list

+							
set_MaxListEntries

+				
in file config.inc, method LAMConfig::set_MaxListEntries()
    Sets the maximum number of rows in user/group/host lists

+							
set_moduleSettings

+				
in file config.inc, method LAMConfig::set_moduleSettings()
    Sets the settings for the account modules.

+							
set_Passwd

+				
in file config.inc, method LAMConfig::set_Passwd()
    Sets the preferences wizard password

+							
set_schema_cache_unavailable

+				
in file schema.inc, function set_schema_cache_unavailable()
    Sets the schema entry for the server_id to be "unavailable" so that we realize  that we tried to get the schema but could not, so quit trying next time to  fetch it from the server.

+							
set_scriptPath

+				
in file config.inc, method LAMConfig::set_scriptPath()
    Sets the path to the external script

+							
set_scriptServer

+				
in file config.inc, method LAMConfig::set_scriptServer()
    Sets the server of the external script

+							
set_ServerURL

+				
in file config.inc, method LAMConfig::set_ServerURL()
    Sets the server address

+							
set_Suffix

+				
in file config.inc, method LAMConfig::set_Suffix()
    Sets the LDAP suffix where accounts are saved

+							
set_typeSettings

+				
in file config.inc, method LAMConfig::set_typeSettings()
    Sets the settings for the account types.

+							
shadowAccount

+				
in file shadowAccount.inc, class shadowAccount
    Manages the object class "shadowAccount" for users.

+							
showColumnData

+				
in file masscreate.php, function showColumnData()
    Prints the properties of one input field.

+							
showMainPage

+				
in file masscreate.php, function showMainPage()
    Displays the acount type specific main page of the upload.

+							
showPage

+				
in file lists.inc, method lamList::showPage()
    Prints the HTML code to display the list view.

+							
smbDomain

+				
in file smbDomain.inc, class smbDomain
    The account type for Samba domains.

+							
smbflag

+				
in file account.inc, function smbflag()
    Takes a list of Samba flags and creates the corresponding flag string.

+							
smbHash

+				
in file createntlm.inc, class smbHash
    Calculates NT and LM hashes.

+							
smb_hash

+				
in file createntlm.inc, method smbHash::smb_hash()

+							
sortAttrs

+				
in file tree.inc, function sortAttrs()

+							
sortModules

+				
in file modules.inc, method accountContainer::sortModules()
    Sorts the module buttons for the account page.

+							
startSecureSession

+				
in file security.inc, function startSecureSession()
    Starts a session and checks the environment.

+							
StatusMessage

+				
in file status.inc, function StatusMessage()
    This function prints a short status message. It can be used to print INFO,  WARN and ERROR messages at the moment.

+							
strlen

+				
in file ufpdf.php, method UFPDF::strlen()

+							
str_to_key

+				
in file createntlm.inc, method smbHash::str_to_key()

+							
Syntax

+				
in file schema.inc, class Syntax
    Represents an LDAP Syntax

+							
Syntax

+				
in file schema.inc, method Syntax::Syntax()
    Creates a new Syntax object from a raw LDAP syntax string.

+							
schema.php

+				
procedural page schema.php

+							
selfServiceLogin.php

+				
procedural page selfServiceLogin.php

+							
selfServiceMain.php

+				
procedural page selfServiceMain.php

+							
status-test.php

+				
procedural page status-test.php

+					

+	

+	top

+  

+	
+	

+		
t

+		

+							
$TextColor

+				
in file fpdf.php, variable FPDF::$TextColor

+							
$time

+				
in file cache.inc, variable cache::$time
    This is the last timestamp on which the LDAP cache has been refreshed

+							
$title

+				
in file fpdf.php, variable FPDF::$title

+							
$tMargin

+				
in file fpdf.php, variable FPDF::$tMargin

+							
$trans_primary

+				
in file user.inc, variable lamUserList::$trans_primary
    Controls if GID number is translated to group name

+							
$trans_primary_hash

+				
in file user.inc, variable lamUserList::$trans_primary_hash
    translates GID to group name

+							
$treesuffix

+				
in file config.inc, variable LAMConfig::$treesuffix
    LDAP suffix for tree view

+							
$type

+				
in file schema.inc, variable ObjectClass::$type
    one of STRUCTURAL, ABSTRACT, or AUXILIARY

+							
$type

+				
in file schema.inc, variable AttributeType::$type
    A string description of the syntax type (taken from the LDAPSyntaxes)

+							
$type

+				
in file lists.inc, variable lamList::$type
    Account type

+							
$type

+				
in file modules.inc, variable accountContainer::$type
    This variale stores the account type.

+							
$typeSettings

+				
in file config.inc, variable LAMConfig::$typeSettings
    type settings

+							
tree.inc

+				
procedural page tree.inc

+							
types.inc

+				
procedural page types.inc

+							
tools.php

+				
procedural page tools.php

+							
templates.inc

+				
procedural page templates.inc

+							
tree.php

+				
procedural page tree.php

+							
tree_view.php

+				
procedural page tree_view.php

+							
Text

+				
in file fpdf.php, method FPDF::Text()

+							
Text

+				
in file ufpdf.php, method UFPDF::Text()

+					

+	

+	top

+  

+	
+	

+		
u

+		

+							
$underline

+				
in file fpdf.php, variable FPDF::$underline

+							
$usage

+				
in file schema.inc, variable AttributeType::$usage
    The usage string set by the LDAP schema

+							
$used_by_attrs

+				
in file schema.inc, variable MatchingRule::$used_by_attrs
    An array of attribute names who use this MatchingRule

+							
$used_by_attrs

+				
in file schema.inc, variable MatchingRuleUse::$used_by_attrs
    An array of attributeType names who make use of the mathingRule

+							
$used_in_object_classes

+				
in file schema.inc, variable AttributeType::$used_in_object_classes
    An array of objectClasses which use this attributeType (must be set by caller)

+							
$username

+				
in file ldap.inc, variable Ldap::$username
    LDAP username used for bind

+							
$useunixpwd

+				
in file sambaSamAccount.inc, variable sambaSamAccount::$useunixpwd
    use Unix password as samba password?

+							
$useunixpwd

+				
in file sambaAccount.inc, variable sambaAccount::$useunixpwd
    use Unix password as samba password?

+							
user.inc

+				
procedural page user.inc

+							
ufpdf.php

+				
procedural page ufpdf.php

+							
userlink.php

+				
procedural page userlink.php

+							
update_confirm.php

+				
procedural page update_confirm.php

+							
update.php

+				
procedural page update.php

+							
UFPDF

+				
in file ufpdf.php, method UFPDF::UFPDF()
    *****************************************************************************

+							
UFPDF

+				
in file ufpdf.php, class UFPDF
    Main UFPDF class for creating Unicode PDF documents

+							
UFPDF_VERSION

+				
in file ufpdf.php, constant UFPDF_VERSION
    *****************************************************************************

+							
unsigned_shift_r

+				
in file createntlm.inc, method smbHash::unsigned_shift_r()
    Unsigned shift operation for 32bit values.

+							
updateCapabilities

+				
in file ldap.inc, method Ldap::updateCapabilities()
    Updates the capabilities values (var $supports_*)

+							
updateClasses

+				
in file ldap.inc, method Ldap::updateClasses()
    Reads the array of objectClasses from the LDAP server

+							
user

+				
in file user.inc, class user
    The account type for user accounts (e.g. Unix, Samba and Kolab).

+							
utf8_substr

+				
in file ufpdf.php, method UFPDF::utf8_substr()

+							
utf8_to_codepoints

+				
in file ufpdf.php, method UFPDF::utf8_to_codepoints()

+							
utf8_to_utf16be

+				
in file ufpdf.php, method UFPDF::utf8_to_utf16be()

+					

+	

+	top

+  

+	
+	

+		
v

+		

+							
$vcardMapping

+				
in file export.inc, variable PlaVcardExporter::$vcardMapping

+							
verabi.php

+				
procedural page verabi.php

+							
verab.php

+				
procedural page verab.php

+							
verai.php

+				
procedural page verai.php

+							
vera.php

+				
procedural page vera.php

+					

+	

+	top

+  

+	
+	

+		
w

+		

+							
$w

+				
in file fpdf.php, variable FPDF::$w

+							
$wPt

+				
in file fpdf.php, variable FPDF::$wPt

+							
$ws

+				
in file fpdf.php, variable FPDF::$ws

+							
Write

+				
in file ufpdf.php, method UFPDF::Write()

+							
Write

+				
in file fpdf.php, method FPDF::Write()

+					

+	

+	top

+  

+	
+	

+		
x

+		

+							
$x

+				
in file fpdf.php, variable FPDF::$x

+							
$xmlParser

+				
in file xml_parser.inc, variable xmlParser::$xmlParser

+							
xml_parser.inc

+				
procedural page xml_parser.inc

+							
x

+				
in file createntlm.inc, method smbHash::x()
    Fixes too large numbers

+							
xmlParser

+				
in file xml_parser.inc, method xmlParser::xmlParser()

+							
xmlParser

+				
in file xml_parser.inc, class xmlParser

+					

+	

+	top

+  

+	
+	

+		
y

+		

+							
$y

+				
in file fpdf.php, variable FPDF::$y

+					

+	

+	top

+  

+	
+	

+		
z

+		

+							
$ZoomMode

+				
in file fpdf.php, variable FPDF::$ZoomMode

+					

+	

+	top

+  

+	
+	

+		
_

+		

+							
_beginpage

+				
in file fpdf.php, method FPDF::_beginpage()

+							
_dochecks

+				
in file fpdf.php, method FPDF::_dochecks()
    *****************************************************************************

+							
_dounderline

+				
in file ufpdf.php, method UFPDF::_dounderline()

+							
_dounderline

+				
in file fpdf.php, method FPDF::_dounderline()

+							
_enddoc

+				
in file fpdf.php, method FPDF::_enddoc()

+							
_endpage

+				
in file fpdf.php, method FPDF::_endpage()

+							
_escape

+				
in file fpdf.php, method FPDF::_escape()

+							
_escapetext

+				
in file ufpdf.php, method UFPDF::_escapetext()

+							
_freadint

+				
in file fpdf.php, method FPDF::_freadint()

+							
_getfontpath

+				
in file fpdf.php, method FPDF::_getfontpath()

+							
_get_raw_schema

+				
in file schema.inc, function _get_raw_schema()
    Fetches the raw schema array for the subschemaSubentry of the server. Note,  this function has grown many hairs to accomodate more LDAP servers. It is  needfully complicated as it now supports many popular LDAP servers that  don't necessarily expose their schema "the right way".

+							
_get_schema_dn

+				
in file schema.inc, function _get_schema_dn()
    Helper for _get_raw_schema() which fetches the DN of the schema object

+							
_newobj

+				
in file fpdf.php, method FPDF::_newobj()

+							
_out

+				
in file fpdf.php, method FPDF::_out()

+							
_parsejpg

+				
in file fpdf.php, method FPDF::_parsejpg()

+							
_parsepng

+				
in file fpdf.php, method FPDF::_parsepng()

+							
_putcatalog

+				
in file fpdf.php, method FPDF::_putcatalog()

+							
_putfonts

+				
in file fpdf.php, method FPDF::_putfonts()

+							
_putheader

+				
in file fpdf.php, method FPDF::_putheader()

+							
_putimages

+				
in file fpdf.php, method FPDF::_putimages()

+							
_putinfo

+				
in file ufpdf.php, method UFPDF::_putinfo()

+							
_putinfo

+				
in file fpdf.php, method FPDF::_putinfo()

+							
_putpages

+				
in file ufpdf.php, method UFPDF::_putpages()

+							
_putpages

+				
in file fpdf.php, method FPDF::_putpages()

+							
_putresourcedict

+				
in file fpdf.php, method FPDF::_putresourcedict()

+							
_putresources

+				
in file fpdf.php, method FPDF::_putresources()

+							
_putstream

+				
in file fpdf.php, method FPDF::_putstream()

+							
_puttrailer

+				
in file fpdf.php, method FPDF::_puttrailer()

+							
_puttruetypeunicode

+				
in file ufpdf.php, method UFPDF::_puttruetypeunicode()
    *****************************************************************************

+							
_putxobjectdict

+				
in file fpdf.php, method FPDF::_putxobjectdict()

+							
_textstring

+				
in file ufpdf.php, method UFPDF::_textstring()

+							
_textstring

+				
in file fpdf.php, method FPDF::_textstring()

+							
__sleep

+				
in file cache.inc, method cache::__sleep()
    Encrypts LDAP cache before saving to session file.

+							
__sleep

+				
in file modules.inc, method accountContainer::__sleep()
    Encrypts sensitive data before storing in session.

+							
__sleep

+				
in file ldap.inc, method Ldap::__sleep()
    Closes connection to LDAP server before serialization

+							
__wakeup

+				
in file modules.inc, method accountContainer::__wakeup()
    Decrypts sensitive data after accountContainer was loaded from session.

+							
__wakeup

+				
in file ldap.inc, method Ldap::__wakeup()
    Reconnects to LDAP server when deserialized

+							
__wakeup

+				
in file cache.inc, method cache::__wakeup()
    Decrypts LDAP cache after loading from session file.

+					

+	

+	top

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/elementindex_Help.html b/lam-web/developers/phpdoc/elementindex_Help.html
new file mode 100644
index 00000000..20ef430d
--- /dev/null
+++ b/lam-web/developers/phpdoc/elementindex_Help.html
@@ -0,0 +1,117 @@
+
+
+Package Help Element Index
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
Help

+  		  [ class tree: Help ]
+		  [ index: Help ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              PDF

+              lists

+              profiles

+              LDAP

+              types

+              lib

+              modules

+              selfService

+              configuration

+              tools

+              Help

+              tests

+              main

+            


+                        Files:

+      	  

+					help.inc
+		

+					help.php
+		

+	  


+      
+      
+                		
+      

+
+
+
Element index for package Help

+	[ d ]
+	[ e ]
+	[ h ]
+	[ i ]
+
+  

+	
+	

+		
d

+		

+							
displayHelp

+				
in file help.php, function displayHelp()
    Print help site for a specific help number.

+					

+	

+	top

+  

+	
+	

+		
e

+		

+							
echoHTMLFoot

+				
in file help.php, function echoHTMLFoot()
    Print HTML footer of the help page.

+							
echoHTMLHead

+				
in file help.php, function echoHTMLHead()
    Print HTML header of the help page.

+					

+	

+	top

+  

+	
+	

+		
h

+		

+							
help.inc

+				
procedural page help.inc

+							
help.php

+				
procedural page help.php

+					

+	

+	top

+  

+	
+	

+		
i

+		

+					

+	

+	top

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/elementindex_LDAP.html b/lam-web/developers/phpdoc/elementindex_LDAP.html
new file mode 100644
index 00000000..aaf1bb71
--- /dev/null
+++ b/lam-web/developers/phpdoc/elementindex_LDAP.html
@@ -0,0 +1,253 @@
+
+
+Package LDAP Element Index
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
LDAP

+  		  [ class tree: LDAP ]
+		  [ index: LDAP ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              PDF

+              lists

+              profiles

+              LDAP

+              types

+              lib

+              modules

+              selfService

+              configuration

+              tools

+              Help

+              tests

+              main

+            


+                        Files:

+      	  

+					ldap.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		Ldap

+	  

+                		
+      

+
+
+
Element index for package LDAP

+	[ a ]
+	[ c ]
+	[ d ]
+	[ e ]
+	[ h ]
+	[ i ]
+	[ l ]
+	[ n ]
+	[ o ]
+	[ p ]
+	[ r ]
+	[ s ]
+	[ u ]
+	[ _ ]
+
+  

+	
+	

+		
_

+		

+							
__sleep

+				
in file ldap.inc, method Ldap::__sleep()
    Closes connection to LDAP server before serialization

+							
__wakeup

+				
in file ldap.inc, method Ldap::__wakeup()
    Reconnects to LDAP server when deserialized

+					

+	

+	top

+  

+	
+	

+		
a

+		

+							
$attributes

+				
in file ldap.inc, variable Ldap::$attributes
    Array with all attribute strings from the LDAP server

+					

+	

+	top

+  

+	
+	

+		
c

+		

+							
$conf

+				
in file ldap.inc, variable Ldap::$conf
    Object of Config to access preferences

+							
close

+				
in file ldap.inc, method Ldap::close()
    Closes connection to server

+							
cmp_array

+				
in file ldap.inc, method Ldap::cmp_array()
    Helper function to sort the unit DNs

+							
connect

+				
in file ldap.inc, method Ldap::connect()
    Connects to the server using the given username and password

+					

+	

+	top

+  

+	
+	

+		
d

+		

+							
decrypt

+				
in file ldap.inc, method Ldap::decrypt()
    Decrypts a string

+							
decrypt_login

+				
in file ldap.inc, method Ldap::decrypt_login()
    Decrypts username and password

+							
destroy

+				
in file ldap.inc, method Ldap::destroy()
    Closes connection to LDAP server and deletes encrypted username/password

+					

+	

+	top

+  

+	
+	

+		
e

+		

+							
encrypt

+				
in file ldap.inc, method Ldap::encrypt()
    Encrypts a string

+							
encrypt_login

+				
in file ldap.inc, method Ldap::encrypt_login()
    Encrypts username and password

+					

+	

+	top

+  

+	
+	

+		
h

+		

+							
hex2bin

+				
in file ldap.inc, function hex2bin()
    Converts a HEX string to a binary value

+					

+	

+	top

+  

+	
+	

+		
i

+		

+					

+	

+	top

+  

+	
+	

+		
l

+		

+							
Ldap

+				
in file ldap.inc, method Ldap::Ldap()

+							
Ldap

+				
in file ldap.inc, class Ldap
    Ldap manages connection to LDAP and includes several helper functions.

+							
ldap.inc

+				
procedural page ldap.inc

+					

+	

+	top

+  

+	
+	

+		
n

+		

+							
new_rand

+				
in file ldap.inc, method Ldap::new_rand()
    Calculates a new value for rand

+					

+	

+	top

+  

+	
+	

+		
o

+		

+							
$objectClasses

+				
in file ldap.inc, variable Ldap::$objectClasses
    Array with all objectClass strings from the LDAP server

+					

+	

+	top

+  

+	
+	

+		
p

+		

+							
$password

+				
in file ldap.inc, variable Ldap::$password
    LDAP password used for bind

+					

+	

+	top

+  

+	
+	

+		
r

+		

+							
$rand

+				
in file ldap.inc, variable Ldap::$rand
    Random number (changes on every page request)

+					

+	

+	top

+  

+	
+	

+		
s

+		

+							
$server

+				
in file ldap.inc, variable Ldap::$server
    Server handle

+							
$supports_unix_hosts

+				
in file ldap.inc, variable Ldap::$supports_unix_hosts
    Host attribute in inetOrgPerson

+							
search_units

+				
in file ldap.inc, method Ldap::search_units()
    Returns an array with all organizational units under the given suffix

+							
server

+				
in file ldap.inc, method Ldap::server()
    Returns the LDAP connection handle

+					

+	

+	top

+  

+	
+	

+		
u

+		

+							
$username

+				
in file ldap.inc, variable Ldap::$username
    LDAP username used for bind

+							
updateCapabilities

+				
in file ldap.inc, method Ldap::updateCapabilities()
    Updates the capabilities values (var $supports_*)

+							
updateClasses

+				
in file ldap.inc, method Ldap::updateClasses()
    Reads the array of objectClasses from the LDAP server

+					

+	

+	top

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/elementindex_PDF.html b/lam-web/developers/phpdoc/elementindex_PDF.html
new file mode 100644
index 00000000..5b57824f
--- /dev/null
+++ b/lam-web/developers/phpdoc/elementindex_PDF.html
@@ -0,0 +1,697 @@
+
+
+Package PDF Element Index
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
PDF

+  		  [ class tree: PDF ]
+		  [ index: PDF ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              PDF

+              lists

+              profiles

+              LDAP

+              types

+              lib

+              modules

+              selfService

+              configuration

+              tools

+              Help

+              tests

+              main

+            


+                        Files:

+      	  

+					fpdf.php
+		

+					pdf.inc
+		

+					pdfdelete.php
+		

+					pdfmain.php
+		

+					pdfpage.php
+		

+					pdfstruct.inc
+		

+					ufpdf.php
+		

+					vera.php
+		

+					verab.php
+		

+					verabi.php
+		

+					verai.php
+		

+					xml_parser.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		FPDF

+	    		lamPDF

+	    		UFPDF

+	    		xmlParser

+	  

+                		
+      

+
+
+
Element index for package PDF

+	[ a ]
+	[ b ]
+	[ c ]
+	[ d ]
+	[ e ]
+	[ f ]
+	[ g ]
+	[ h ]
+	[ i ]
+	[ k ]
+	[ l ]
+	[ m ]
+	[ n ]
+	[ o ]
+	[ p ]
+	[ r ]
+	[ s ]
+	[ t ]
+	[ u ]
+	[ v ]
+	[ w ]
+	[ x ]
+	[ y ]
+	[ z ]
+	[ _ ]
+
+  

+	
+	

+		
_

+		

+							
_beginpage

+				
in file fpdf.php, method FPDF::_beginpage()

+							
_dochecks

+				
in file fpdf.php, method FPDF::_dochecks()
    *****************************************************************************

+							
_dounderline

+				
in file fpdf.php, method FPDF::_dounderline()

+							
_dounderline

+				
in file ufpdf.php, method UFPDF::_dounderline()

+							
_enddoc

+				
in file fpdf.php, method FPDF::_enddoc()

+							
_endpage

+				
in file fpdf.php, method FPDF::_endpage()

+							
_escape

+				
in file fpdf.php, method FPDF::_escape()

+							
_escapetext

+				
in file ufpdf.php, method UFPDF::_escapetext()

+							
_freadint

+				
in file fpdf.php, method FPDF::_freadint()

+							
_getfontpath

+				
in file fpdf.php, method FPDF::_getfontpath()

+							
_newobj

+				
in file fpdf.php, method FPDF::_newobj()

+							
_out

+				
in file fpdf.php, method FPDF::_out()

+							
_parsejpg

+				
in file fpdf.php, method FPDF::_parsejpg()

+							
_parsepng

+				
in file fpdf.php, method FPDF::_parsepng()

+							
_putcatalog

+				
in file fpdf.php, method FPDF::_putcatalog()

+							
_putfonts

+				
in file fpdf.php, method FPDF::_putfonts()

+							
_putheader

+				
in file fpdf.php, method FPDF::_putheader()

+							
_putimages

+				
in file fpdf.php, method FPDF::_putimages()

+							
_putinfo

+				
in file ufpdf.php, method UFPDF::_putinfo()

+							
_putinfo

+				
in file fpdf.php, method FPDF::_putinfo()

+							
_putpages

+				
in file fpdf.php, method FPDF::_putpages()

+							
_putpages

+				
in file ufpdf.php, method UFPDF::_putpages()

+							
_putresourcedict

+				
in file fpdf.php, method FPDF::_putresourcedict()

+							
_putresources

+				
in file fpdf.php, method FPDF::_putresources()

+							
_putstream

+				
in file fpdf.php, method FPDF::_putstream()

+							
_puttrailer

+				
in file fpdf.php, method FPDF::_puttrailer()

+							
_puttruetypeunicode

+				
in file ufpdf.php, method UFPDF::_puttruetypeunicode()
    *****************************************************************************

+							
_putxobjectdict

+				
in file fpdf.php, method FPDF::_putxobjectdict()

+							
_textstring

+				
in file ufpdf.php, method UFPDF::_textstring()

+							
_textstring

+				
in file fpdf.php, method FPDF::_textstring()

+					

+	

+	top

+  

+	
+	

+		
a

+		

+							
$AliasNbPages

+				
in file fpdf.php, variable FPDF::$AliasNbPages

+							
$author

+				
in file fpdf.php, variable FPDF::$author

+							
$AutoPageBreak

+				
in file fpdf.php, variable FPDF::$AutoPageBreak

+							
AcceptPageBreak

+				
in file fpdf.php, method FPDF::AcceptPageBreak()

+							
AcceptPageBreak

+				
in file ufpdf.php, method UFPDF::AcceptPageBreak()

+							
AddFont

+				
in file ufpdf.php, method UFPDF::AddFont()

+							
AddFont

+				
in file fpdf.php, method FPDF::AddFont()

+							
AddLink

+				
in file fpdf.php, method FPDF::AddLink()

+							
AddPage

+				
in file fpdf.php, method FPDF::AddPage()

+							
AliasNbPages

+				
in file ufpdf.php, method UFPDF::AliasNbPages()

+							
AliasNbPages

+				
in file fpdf.php, method FPDF::AliasNbPages()

+					

+	

+	top

+  

+	
+	

+		
b

+		

+							
$bMargin

+				
in file fpdf.php, variable FPDF::$bMargin

+							
$buffer

+				
in file fpdf.php, variable FPDF::$buffer

+					

+	

+	top

+  

+	
+	

+		
c

+		

+							
$cMargin

+				
in file fpdf.php, variable FPDF::$cMargin

+							
$ColorFlag

+				
in file fpdf.php, variable FPDF::$ColorFlag

+							
$compress

+				
in file fpdf.php, variable FPDF::$compress

+							
$CoreFonts

+				
in file fpdf.php, variable FPDF::$CoreFonts

+							
$creator

+				
in file fpdf.php, variable FPDF::$creator

+							
$CurOrientation

+				
in file fpdf.php, variable FPDF::$CurOrientation

+							
$CurrentFont

+				
in file fpdf.php, variable FPDF::$CurrentFont

+							
Cell

+				
in file fpdf.php, method FPDF::Cell()

+							
Cell

+				
in file ufpdf.php, method UFPDF::Cell()

+							
Close

+				
in file fpdf.php, method FPDF::Close()

+							
code2utf

+				
in file ufpdf.php, method UFPDF::code2utf()

+							
createModulePDF

+				
in file pdf.inc, function createModulePDF()
    This function creates the PDF output of one or more accounts. At the moment  this function can create a PDF page for user, group and host accounts. But  this is not limited by the function itself but by the account types that are  allowed in LAM and the exsisting PDF structure definitions.

+					

+	

+	top

+  

+	
+	

+		
d

+		

+							
$DefOrientation

+				
in file fpdf.php, variable FPDF::$DefOrientation

+							
$diffs

+				
in file fpdf.php, variable FPDF::$diffs

+							
$DrawColor

+				
in file fpdf.php, variable FPDF::$DrawColor

+							
deletePDFStructureDefinition

+				
in file pdfstruct.inc, function deletePDFStructureDefinition()
    Deletes XML file with PDF structure definitions.

+					

+	

+	top

+  

+	
+	

+		
e

+		

+							
Error

+				
in file fpdf.php, method FPDF::Error()

+					

+	

+	top

+  

+	
+	

+		
f

+		

+							
$fh

+				
in file fpdf.php, variable FPDF::$fh

+							
$fhPt

+				
in file fpdf.php, variable FPDF::$fhPt

+							
$FillColor

+				
in file fpdf.php, variable FPDF::$FillColor

+							
$FontFamily

+				
in file fpdf.php, variable FPDF::$FontFamily

+							
$FontFiles

+				
in file fpdf.php, variable FPDF::$FontFiles

+							
$fontList

+				
in file pdf.inc, variable lamPDF::$fontList
    list of supported fonts

+							
$fontName

+				
in file pdf.inc, variable lamPDF::$fontName
    current active font name

+							
$fonts

+				
in file fpdf.php, variable FPDF::$fonts

+							
$FontSize

+				
in file fpdf.php, variable FPDF::$FontSize

+							
$FontSizePt

+				
in file fpdf.php, variable FPDF::$FontSizePt

+							
$FontStyle

+				
in file fpdf.php, variable FPDF::$FontStyle

+							
$fw

+				
in file fpdf.php, variable FPDF::$fw

+							
$fwPt

+				
in file fpdf.php, variable FPDF::$fwPt

+							
footer

+				
in file pdf.inc, method lamPDF::footer()

+							
Footer

+				
in file fpdf.php, method FPDF::Footer()

+							
FPDF

+				
in file fpdf.php, method FPDF::FPDF()
    *****************************************************************************

+							
FPDF

+				
in file fpdf.php, class FPDF
    Main FPDF class for creating PDF documents

+							
FPDF_VERSION

+				
in file fpdf.php, constant FPDF_VERSION
    *****************************************************************************

+							
fpdf.php

+				
procedural page fpdf.php

+					

+	

+	top

+  

+	
+	

+		
g

+		

+							
getAvailableLogos

+				
in file pdfstruct.inc, function getAvailableLogos()
    This function returns an array with all aviliable logo images.

+							
getPDFStructureDefinitions

+				
in file pdfstruct.inc, function getPDFStructureDefinitions()
    This function will return all available PDF structure definitions for the submitted  account scope.

+							
getSectionHeadline

+				
in file pdf.inc, function getSectionHeadline()
    Creates a section headline.

+							
GetStringWidth

+				
in file ufpdf.php, method UFPDF::GetStringWidth()

+							
GetStringWidth

+				
in file fpdf.php, method FPDF::GetStringWidth()

+							
GetX

+				
in file fpdf.php, method FPDF::GetX()

+							
GetY

+				
in file fpdf.php, method FPDF::GetY()

+					

+	

+	top

+  

+	
+	

+		
h

+		

+							
$h

+				
in file fpdf.php, variable FPDF::$h

+							
$hPt

+				
in file fpdf.php, variable FPDF::$hPt

+							
header

+				
in file pdf.inc, method lamPDF::header()

+							
Header

+				
in file fpdf.php, method FPDF::Header()

+					

+	

+	top

+  

+	
+	

+		
i

+		

+							
$images

+				
in file fpdf.php, variable FPDF::$images

+							
$InFooter

+				
in file fpdf.php, variable FPDF::$InFooter

+							
Image

+				
in file fpdf.php, method FPDF::Image()

+					

+	

+	top

+  

+	
+	

+		
k

+		

+							
$k

+				
in file fpdf.php, variable FPDF::$k

+							
$keywords

+				
in file fpdf.php, variable FPDF::$keywords

+					

+	

+	top

+  

+	
+	

+		
l

+		

+							
$lasth

+				
in file fpdf.php, variable FPDF::$lasth

+							
$LayoutMode

+				
in file fpdf.php, variable FPDF::$LayoutMode

+							
$LineWidth

+				
in file fpdf.php, variable FPDF::$LineWidth

+							
$links

+				
in file fpdf.php, variable FPDF::$links

+							
$lMargin

+				
in file fpdf.php, variable FPDF::$lMargin

+							
lamPDF

+				
in file pdf.inc, method lamPDF::lamPDF()

+							
lamPDF

+				
in file pdf.inc, class lamPDF
    Creates a LAM information page in PDF format.

+							
LAMPDF_LINEWIDTH

+				
in file pdf.inc, constant LAMPDF_LINEWIDTH
    PDF line width

+							
Line

+				
in file fpdf.php, method FPDF::Line()

+							
Link

+				
in file fpdf.php, method FPDF::Link()

+							
Ln

+				
in file fpdf.php, method FPDF::Ln()

+							
loadPDFStructureDefinitions

+				
in file pdfstruct.inc, function loadPDFStructureDefinitions()
    This function is used to get pdf structure from xml file.

+					

+	

+	top

+  

+	
+	

+		
m

+		

+							
MultiCell

+				
in file ufpdf.php, method UFPDF::MultiCell()

+							
MultiCell

+				
in file fpdf.php, method FPDF::MultiCell()

+					

+	

+	top

+  

+	
+	

+		
n

+		

+							
$n

+				
in file fpdf.php, variable FPDF::$n

+					

+	

+	top

+  

+	
+	

+		
o

+		

+							
$offsets

+				
in file fpdf.php, variable FPDF::$offsets

+							
$OrientationChanges

+				
in file fpdf.php, variable FPDF::$OrientationChanges

+							
Open

+				
in file fpdf.php, method FPDF::Open()

+							
Output

+				
in file fpdf.php, method FPDF::Output()

+					

+	

+	top

+  

+	
+	

+		
p

+		

+							
$page

+				
in file fpdf.php, variable FPDF::$page

+							
$PageBreakTrigger

+				
in file fpdf.php, variable FPDF::$PageBreakTrigger

+							
$PageLinks

+				
in file fpdf.php, variable FPDF::$PageLinks

+							
$pages

+				
in file fpdf.php, variable FPDF::$pages

+							
$page_definitions

+				
in file pdf.inc, variable lamPDF::$page_definitions
    format settings for page layout

+							
$PDFVersion

+				
in file fpdf.php, variable FPDF::$PDFVersion

+							
pdfstruct.inc

+				
procedural page pdfstruct.inc

+							
pdf.inc

+				
procedural page pdf.inc

+							
PageNo

+				
in file fpdf.php, method FPDF::PageNo()

+							
parse

+				
in file xml_parser.inc, method xmlParser::parse()

+							
processAttributes

+				
in file pdf.inc, function processAttributes()
    Processes width, height and alignment attributes.

+							
processFormatTags

+				
in file pdf.inc, function processFormatTags()
    Formats the XML code.

+							
processLine

+				
in file pdf.inc, function processLine()
    Creates the XML code for an PDF entry.

+							
pdfdelete.php

+				
procedural page pdfdelete.php

+							
pdfmain.php

+				
procedural page pdfmain.php

+							
pdfpage.php

+				
procedural page pdfpage.php

+					

+	

+	top

+  

+	
+	

+		
r

+		

+							
$rMargin

+				
in file fpdf.php, variable FPDF::$rMargin

+							
Rect

+				
in file fpdf.php, method FPDF::Rect()

+					

+	

+	top

+  

+	
+	

+		
s

+		

+							
$state

+				
in file fpdf.php, variable FPDF::$state

+							
$subject

+				
in file fpdf.php, variable FPDF::$subject

+							
savePDFStructureDefinitions

+				
in file pdfstruct.inc, function savePDFStructureDefinitions()
    Saves PDF structure definitions to XML file in format: <name>.<scope>.xml

+							
SetAuthor

+				
in file fpdf.php, method FPDF::SetAuthor()

+							
SetAutoPageBreak

+				
in file fpdf.php, method FPDF::SetAutoPageBreak()

+							
SetCompression

+				
in file fpdf.php, method FPDF::SetCompression()

+							
SetCreator

+				
in file fpdf.php, method FPDF::SetCreator()

+							
SetDisplayMode

+				
in file fpdf.php, method FPDF::SetDisplayMode()

+							
SetDrawColor

+				
in file fpdf.php, method FPDF::SetDrawColor()

+							
SetFillColor

+				
in file fpdf.php, method FPDF::SetFillColor()

+							
SetFont

+				
in file fpdf.php, method FPDF::SetFont()

+							
SetFontSize

+				
in file fpdf.php, method FPDF::SetFontSize()

+							
SetKeywords

+				
in file fpdf.php, method FPDF::SetKeywords()

+							
SetLeftMargin

+				
in file fpdf.php, method FPDF::SetLeftMargin()

+							
SetLineWidth

+				
in file fpdf.php, method FPDF::SetLineWidth()

+							
SetLink

+				
in file fpdf.php, method FPDF::SetLink()

+							
SetMargins

+				
in file fpdf.php, method FPDF::SetMargins()

+							
SetRightMargin

+				
in file fpdf.php, method FPDF::SetRightMargin()

+							
SetSubject

+				
in file fpdf.php, method FPDF::SetSubject()

+							
SetTextColor

+				
in file fpdf.php, method FPDF::SetTextColor()

+							
SetTitle

+				
in file fpdf.php, method FPDF::SetTitle()

+							
SetTopMargin

+				
in file fpdf.php, method FPDF::SetTopMargin()

+							
SetX

+				
in file fpdf.php, method FPDF::SetX()

+							
SetXY

+				
in file fpdf.php, method FPDF::SetXY()

+							
SetY

+				
in file fpdf.php, method FPDF::SetY()

+							
strlen

+				
in file ufpdf.php, method UFPDF::strlen()

+					

+	

+	top

+  

+	
+	

+		
t

+		

+							
$TextColor

+				
in file fpdf.php, variable FPDF::$TextColor

+							
$title

+				
in file fpdf.php, variable FPDF::$title

+							
$tMargin

+				
in file fpdf.php, variable FPDF::$tMargin

+							
Text

+				
in file ufpdf.php, method UFPDF::Text()

+							
Text

+				
in file fpdf.php, method FPDF::Text()

+					

+	

+	top

+  

+	
+	

+		
u

+		

+							
$underline

+				
in file fpdf.php, variable FPDF::$underline

+							
ufpdf.php

+				
procedural page ufpdf.php

+							
UFPDF

+				
in file ufpdf.php, method UFPDF::UFPDF()
    *****************************************************************************

+							
UFPDF

+				
in file ufpdf.php, class UFPDF
    Main UFPDF class for creating Unicode PDF documents

+							
UFPDF_VERSION

+				
in file ufpdf.php, constant UFPDF_VERSION
    *****************************************************************************

+							
utf8_substr

+				
in file ufpdf.php, method UFPDF::utf8_substr()

+							
utf8_to_codepoints

+				
in file ufpdf.php, method UFPDF::utf8_to_codepoints()

+							
utf8_to_utf16be

+				
in file ufpdf.php, method UFPDF::utf8_to_utf16be()

+					

+	

+	top

+  

+	
+	

+		
v

+		

+							
verabi.php

+				
procedural page verabi.php

+							
verab.php

+				
procedural page verab.php

+							
verai.php

+				
procedural page verai.php

+							
vera.php

+				
procedural page vera.php

+					

+	

+	top

+  

+	
+	

+		
w

+		

+							
$w

+				
in file fpdf.php, variable FPDF::$w

+							
$wPt

+				
in file fpdf.php, variable FPDF::$wPt

+							
$ws

+				
in file fpdf.php, variable FPDF::$ws

+							
Write

+				
in file ufpdf.php, method UFPDF::Write()

+							
Write

+				
in file fpdf.php, method FPDF::Write()

+					

+	

+	top

+  

+	
+	

+		
x

+		

+							
$x

+				
in file fpdf.php, variable FPDF::$x

+							
$xmlParser

+				
in file xml_parser.inc, variable xmlParser::$xmlParser

+							
xml_parser.inc

+				
procedural page xml_parser.inc

+							
xmlParser

+				
in file xml_parser.inc, method xmlParser::xmlParser()

+							
xmlParser

+				
in file xml_parser.inc, class xmlParser

+					

+	

+	top

+  

+	
+	

+		
y

+		

+							
$y

+				
in file fpdf.php, variable FPDF::$y

+					

+	

+	top

+  

+	
+	

+		
z

+		

+							
$ZoomMode

+				
in file fpdf.php, variable FPDF::$ZoomMode

+					

+	

+	top

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/elementindex_configuration.html b/lam-web/developers/phpdoc/elementindex_configuration.html
new file mode 100644
index 00000000..42f7851b
--- /dev/null
+++ b/lam-web/developers/phpdoc/elementindex_configuration.html
@@ -0,0 +1,346 @@
+
+
+Package configuration Element Index
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
configuration

+  		  [ class tree: configuration ]
+		  [ index: configuration ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              PDF

+              lists

+              profiles

+              LDAP

+              types

+              lib

+              modules

+              selfService

+              configuration

+              tools

+              Help

+              tests

+              main

+            


+                        Files:

+      	  

+					config.inc
+		

+					conflogin.php
+		

+					confmain.php
+		

+					confmodules.php
+		

+					conftypes.php
+		

+					index.php
+		

+					mainlogin.php
+		

+					mainmanage.php
+		

+					profmanage.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LAMCfgMain

+	    		LAMConfig

+	  

+                		
+      

+
+
+
Element index for package configuration

+	[ a ]
+	[ c ]
+	[ d ]
+	[ f ]
+	[ g ]
+	[ i ]
+	[ l ]
+	[ m ]
+	[ p ]
+	[ r ]
+	[ s ]
+	[ t ]
+
+  

+	
+	

+		
a

+		

+							
$activeTypes

+				
in file config.inc, variable LAMConfig::$activeTypes
    Active account types

+							
$Admins

+				
in file config.inc, variable LAMConfig::$Admins
    Array of string: users with admin rights

+							
$allowedHosts

+				
in file config.inc, variable LAMCfgMain::$allowedHosts
    list of hosts which may access LAM

+					

+	

+	top

+  

+	
+	

+		
c

+		

+							
$cachetimeout

+				
in file config.inc, variable LAMConfig::$cachetimeout
    LDAP cache timeout

+							
config_showAccountModules

+				
in file confmodules.php, function config_showAccountModules()
    Displays the module selection boxes and checks if dependencies are fulfilled.

+							
config.inc

+				
procedural page config.inc

+							
conflogin.php

+				
procedural page conflogin.php

+							
confmain.php

+				
procedural page confmain.php

+							
confmodules.php

+				
procedural page confmodules.php

+							
conftypes.php

+				
procedural page conftypes.php

+					

+	

+	top

+  

+	
+	

+		
d

+		

+							
$default

+				
in file config.inc, variable LAMCfgMain::$default
    Default profile

+							
$defaultLanguage

+				
in file config.inc, variable LAMConfig::$defaultLanguage
    Default language

+					

+	

+	top

+  

+	
+	

+		
f

+		

+							
$file

+				
in file config.inc, variable LAMConfig::$file
    Name of configuration file

+					

+	

+	top

+  

+	
+	

+		
g

+		

+							
getConfigProfiles

+				
in file config.inc, function getConfigProfiles()
    Returns an array of string with all available configuration profiles (without .conf)

+							
get_AccountModules

+				
in file config.inc, method LAMConfig::get_AccountModules()
    Returns an array of all selected account modules

+							
get_ActiveTypes

+				
in file config.inc, method LAMConfig::get_ActiveTypes()
    Returns a list of active account types.

+							
get_Admins

+				
in file config.inc, method LAMConfig::get_Admins()
    Returns an array of string with all admin names

+							
get_Adminstring

+				
in file config.inc, method LAMConfig::get_Adminstring()
    Returns all admin users seperated by semicolons

+							
get_cacheTimeout

+				
in file config.inc, method LAMConfig::get_cacheTimeout()
    Returns the LDAP cache timeout in minutes

+							
get_cacheTimeoutSec

+				
in file config.inc, method LAMConfig::get_cacheTimeoutSec()
    Returns the LDAP cache timeout in seconds

+							
get_defaultLanguage

+				
in file config.inc, method LAMConfig::get_defaultLanguage()
    Returns the default language string

+							
get_listAttributes

+				
in file config.inc, method LAMConfig::get_listAttributes()
    Returns the list of attributes to show in user list

+							
get_MaxListEntries

+				
in file config.inc, method LAMConfig::get_MaxListEntries()
    Returns the maximum number of rows in user/group/host lists

+							
get_moduleSettings

+				
in file config.inc, method LAMConfig::get_moduleSettings()
    Returns a list of saved module settings

+							
get_Passwd

+				
in file config.inc, method LAMConfig::get_Passwd()
    Returns the password to access the preferences wizard

+							
get_scriptPath

+				
in file config.inc, method LAMConfig::get_scriptPath()
    Returns the path to the external script

+							
get_scriptServer

+				
in file config.inc, method LAMConfig::get_scriptServer()
    Returns the server of the external script

+							
get_ServerURL

+				
in file config.inc, method LAMConfig::get_ServerURL()
    Returns the server address as string

+							
get_Suffix

+				
in file config.inc, method LAMConfig::get_Suffix()
    Returns the LDAP suffix for the given account type

+							
get_typeSettings

+				
in file config.inc, method LAMConfig::get_typeSettings()
    Returns a list of saved type settings

+					

+	

+	top

+  

+	
+	

+		
i

+		

+							
index.php

+				
procedural page index.php

+					

+	

+	top

+  

+	
+	

+		
l

+		

+							
$logDestination

+				
in file config.inc, variable LAMCfgMain::$logDestination
    log destination ("SYSLOG":syslog, "/...":file, "NONE":none)

+							
$logLevel

+				
in file config.inc, variable LAMCfgMain::$logLevel
    log level

+							
LAMCfgMain

+				
in file config.inc, class LAMCfgMain
    This class manages config.cfg.

+							
LAMCfgMain

+				
in file config.inc, method LAMCfgMain::LAMCfgMain()
    Loads preferences from config file

+							
LAMConfig

+				
in file config.inc, method LAMConfig::LAMConfig()
    Loads preferences from config file

+							
LAMConfig

+				
in file config.inc, class LAMConfig
    This class manages .conf files.

+							
LAMVersion

+				
in file config.inc, function LAMVersion()
    Returns the version number of this LAM installation.

+					

+	

+	top

+  

+	
+	

+		
m

+		

+							
$maxlistentries

+				
in file config.inc, variable LAMConfig::$maxlistentries
    Maximum number of rows shown in user/group/host lists

+							
$moduleSettings

+				
in file config.inc, variable LAMConfig::$moduleSettings
    module settings

+							
metaRefresh

+				
in file config.inc, function metaRefresh()
    Prints a meta refresh page

+							
mainlogin.php

+				
procedural page mainlogin.php

+							
mainmanage.php

+				
procedural page mainmanage.php

+					

+	

+	top

+  

+	
+	

+		
p

+		

+							
$Passwd

+				
in file config.inc, variable LAMConfig::$Passwd
    Password to edit preferences

+							
$password

+				
in file config.inc, variable LAMCfgMain::$password
    Password to change config.cfg

+							
profmanage.php

+				
procedural page profmanage.php

+					

+	

+	top

+  

+	
+	

+		
r

+		

+							
reload

+				
in file config.inc, method LAMCfgMain::reload()
    Reloads preferences from config file config.cfg

+							
reload

+				
in file config.inc, method LAMConfig::reload()
    Reloads preferences from config file

+					

+	

+	top

+  

+	
+	

+		
s

+		

+							
$scriptPath

+				
in file config.inc, variable LAMConfig::$scriptPath
    Path to external lamdaemon script on server where it is executed

+							
$scriptServer

+				
in file config.inc, variable LAMConfig::$scriptServer
    Server where lamdaemon script is executed

+							
$ServerURL

+				
in file config.inc, variable LAMConfig::$ServerURL
    Server address (e.g. ldap://127.0.0.1:389)

+							
$sessionTimeout

+				
in file config.inc, variable LAMCfgMain::$sessionTimeout
    Time of inactivity before session times out (minutes)

+							
$settings

+				
in file config.inc, variable LAMCfgMain::$settings
    list of data fields to save in config file

+							
$settings

+				
in file config.inc, variable LAMConfig::$settings
    List of all settings in config file

+							
save

+				
in file config.inc, method LAMCfgMain::save()
    Saves preferences to config file config.cfg

+							
save

+				
in file config.inc, method LAMConfig::save()
    Saves preferences to config file

+							
saveSettings

+				
in file confmain.php, function saveSettings()
    Saves the entered settings.

+							
setlanguage

+				
in file config.inc, function setlanguage()
    Sets language settings for automatic translation

+							
set_AccountModules

+				
in file config.inc, method LAMConfig::set_AccountModules()
    Sets the selected account modules

+							
set_ActiveTypes

+				
in file config.inc, method LAMConfig::set_ActiveTypes()
    Sets the list of active types.

+							
set_Adminstring

+				
in file config.inc, method LAMConfig::set_Adminstring()
    Sets the admin string

+							
set_cacheTimeout

+				
in file config.inc, method LAMConfig::set_cacheTimeout()
    Sets the LDAP cache timeout in minutes (0,1,2,5,10,15)

+							
set_defaultLanguage

+				
in file config.inc, method LAMConfig::set_defaultLanguage()
    Sets the default language string

+							
set_listAttributes

+				
in file config.inc, method LAMConfig::set_listAttributes()
    Sets the list of attributes to show in user list

+							
set_MaxListEntries

+				
in file config.inc, method LAMConfig::set_MaxListEntries()
    Sets the maximum number of rows in user/group/host lists

+							
set_moduleSettings

+				
in file config.inc, method LAMConfig::set_moduleSettings()
    Sets the settings for the account modules.

+							
set_Passwd

+				
in file config.inc, method LAMConfig::set_Passwd()
    Sets the preferences wizard password

+							
set_scriptPath

+				
in file config.inc, method LAMConfig::set_scriptPath()
    Sets the path to the external script

+							
set_scriptServer

+				
in file config.inc, method LAMConfig::set_scriptServer()
    Sets the server of the external script

+							
set_ServerURL

+				
in file config.inc, method LAMConfig::set_ServerURL()
    Sets the server address

+							
set_Suffix

+				
in file config.inc, method LAMConfig::set_Suffix()
    Sets the LDAP suffix where accounts are saved

+							
set_typeSettings

+				
in file config.inc, method LAMConfig::set_typeSettings()
    Sets the settings for the account types.

+					

+	

+	top

+  

+	
+	

+		
t

+		

+							
$treesuffix

+				
in file config.inc, variable LAMConfig::$treesuffix
    LDAP suffix for tree view

+							
$typeSettings

+				
in file config.inc, variable LAMConfig::$typeSettings
    type settings

+					

+	

+	top

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/elementindex_lib.html b/lam-web/developers/phpdoc/elementindex_lib.html
new file mode 100644
index 00000000..5567740a
--- /dev/null
+++ b/lam-web/developers/phpdoc/elementindex_lib.html
@@ -0,0 +1,561 @@
+
+
+Package lib Element Index
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lib

+  		  [ class tree: lib ]
+		  [ index: lib ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              PDF

+              lists

+              profiles

+              LDAP

+              types

+              lib

+              modules

+              selfService

+              configuration

+              tools

+              Help

+              tests

+              main

+            


+                        Files:

+      	  

+					account.inc
+		

+					cache.inc
+		

+					schema.inc
+		

+					security.inc
+		

+					status.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		AttributeType

+	    		cache

+	    		MatchingRule

+	    		MatchingRuleUse

+	    		ObjectClass

+	    		ObjectClassAttribute

+	    		SchemaItem

+	    		Syntax

+	  

+                		
+      

+
+
+
Element index for package lib

+	[ a ]
+	[ c ]
+	[ d ]
+	[ e ]
+	[ f ]
+	[ g ]
+	[ i ]
+	[ l ]
+	[ m ]
+	[ n ]
+	[ o ]
+	[ p ]
+	[ r ]
+	[ s ]
+	[ t ]
+	[ u ]
+	[ _ ]
+
+  

+	
+	

+		
_

+		

+							
_get_raw_schema

+				
in file schema.inc, function _get_raw_schema()
    Fetches the raw schema array for the subschemaSubentry of the server. Note,  this function has grown many hairs to accomodate more LDAP servers. It is  needfully complicated as it now supports many popular LDAP servers that  don't necessarily expose their schema "the right way".

+							
_get_schema_dn

+				
in file schema.inc, function _get_schema_dn()
    Helper for _get_raw_schema() which fetches the DN of the schema object

+							
__sleep

+				
in file cache.inc, method cache::__sleep()
    Encrypts LDAP cache before saving to session file.

+							
__wakeup

+				
in file cache.inc, method cache::__wakeup()
    Decrypts LDAP cache after loading from session file.

+					

+	

+	top

+  

+	
+	

+		
a

+		

+							
$aliases

+				
in file schema.inc, variable AttributeType::$aliases
    An array of alias attribute names, strings

+							
$attributes

+				
in file cache.inc, variable cache::$attributes
    This variable contains a list and their scope of attributes which should be cached

+							
addAlias

+				
in file schema.inc, method AttributeType::addAlias()
    Adds an attribute name to the alias array.

+							
addChildObjectClass

+				
in file schema.inc, method ObjectClass::addChildObjectClass()
    Adds an objectClass to the list of objectClasses that inherit  from this objectClass.

+							
addMayAttrs

+				
in file schema.inc, method ObjectClass::addMayAttrs()
    Behaves identically to addMustAttrs, but it operates on the MAY  attributes of this objectClass.

+							
addMustAttrs

+				
in file schema.inc, method ObjectClass::addMustAttrs()
    Adds the specified array of attributes to this objectClass' list of  MUST attributes. The resulting array of must attributes will contain  unique members.

+							
addRequiredByObjectClass

+				
in file schema.inc, method AttributeType::addRequiredByObjectClass()
    Adds an objectClass name to this attribute's list of "required by" objectClasses,  that is the list of objectClasses which must have this attribute.

+							
addUsedByAttr

+				
in file schema.inc, method MatchingRule::addUsedByAttr()
    Adds an attribute name to the list of attributes who use this MatchingRule

+							
addUsedInObjectClass

+				
in file schema.inc, method AttributeType::addUsedInObjectClass()
    Adds an objectClass name to this attribute's list of "used in" objectClasses,  that is the list of objectClasses which provide this attribute.

+							
add_aliases_to_attrs

+				
in file schema.inc, function add_aliases_to_attrs()
    For each attribute that has multiple names, this function adds unique entries to  the attrs array for those names. Ie, attributeType has name 'gn' and 'givenName'.

+							
add_cache

+				
in file cache.inc, method cache::add_cache()
    This function adds attributes to the cache.

+							
add_sup_to_attrs

+				
in file schema.inc, function add_sup_to_attrs()
    Adds inherited values to each attributeType specified by the SUP directive.

+							
array_delete

+				
in file account.inc, function array_delete()
    This function will return all values from $array without values of $values.

+							
AttributeType

+				
in file schema.inc, method AttributeType::AttributeType()
    Creates a new AttributeType objcet from a raw LDAP AttributeType string.

+							
AttributeType

+				
in file schema.inc, class AttributeType
    Represents an LDAP AttributeType

+							
account.inc

+				
procedural page account.inc

+					

+	

+	top

+  

+	
+	

+		
c

+		

+							
$children_objectclasses

+				
in file schema.inc, variable ObjectClass::$children_objectclasses
    array of objectClasses which inherit from this one (must be set at runtime explicitly by the caller)

+							
cache

+				
in file cache.inc, class cache
    This class contains all functions which are needed to manage the LDAP cache.

+							
cache

+				
in file cache.inc, method cache::cache()
    Constructor.

+							
cached_schema_available

+				
in file schema.inc, function cached_schema_available()
    Returns true if the schema for $schema_type has been cached and

+							
checkClientIP

+				
in file security.inc, function checkClientIP()
    Checks if the client's IP address is on the list of allowed IPs.

+							
cmp_domain

+				
in file account.inc, function cmp_domain()
    Helper function to sort the domains

+							
cache.inc

+				
procedural page cache.inc

+					

+	

+	top

+  

+	
+	

+		
d

+		

+							
$description

+				
in file schema.inc, variable SchemaItem::$description
    The description of this schema item.

+					

+	

+	top

+  

+	
+	

+		
e

+		

+							
$equality

+				
in file schema.inc, variable AttributeType::$equality
    The equality rule used

+					

+	

+	top

+  

+	
+	

+		
f

+		

+							
findgroups

+				
in file cache.inc, method cache::findgroups()
    This function returns an array with all group names which were found in the LDAP directory.

+					

+	

+	top

+  

+	
+	

+		
g

+		

+							
genpasswd

+				
in file account.inc, function genpasswd()
    This function will return a password with max. 8 characters.

+							
getAliases

+				
in file schema.inc, method AttributeType::getAliases()
    Gets the names of attributes that are an alias for this attribute (if any).

+							
getChildObjectClasses

+				
in file schema.inc, method ObjectClass::getChildObjectClasses()
    Returns the array of objectClass names which inherit from this objectClass.

+							
getdays

+				
in file account.inc, function getdays()
    This function will return the days from 1.1.1970 until now.

+							
getDescription

+				
in file schema.inc, method SchemaItem::getDescription()

+							
getEquality

+				
in file schema.inc, method AttributeType::getEquality()
    Gets this attribute's equality string

+							
getgid

+				
in file cache.inc, method cache::getgid()
    This function will return the GID number to an existing group name (using the cache).

+							
getgrnam

+				
in file cache.inc, method cache::getgrnam()
    This function returns the group name to an existing gidNumber.

+							
getIsCollective

+				
in file schema.inc, method AttributeType::getIsCollective()
    Gets whether this attribute is collective.

+							
getIsNoUserModification

+				
in file schema.inc, method AttributeType::getIsNoUserModification()
    Gets whether this attribute is not modifiable by users.

+							
getIsObsolete

+				
in file schema.inc, method AttributeType::getIsObsolete()
    Gets whether this attribute has been flagged as obsolete by the LDAP server

+							
getIsObsolete

+				
in file schema.inc, method ObjectClass::getIsObsolete()
    Gets whether this objectClass is flagged as obsolete by the LDAP server.

+							
getIsObsolete

+				
in file schema.inc, method MatchingRule::getIsObsolete()
    Gets whether this MatchingRule is flagged as obsolete by the LDAP server.

+							
getIsSingleValue

+				
in file schema.inc, method AttributeType::getIsSingleValue()
    Gets whether this attribute is single-valued. If this attribute only supports single values, true  is returned. If this attribute supports multiple values, false is returned.

+							
getMaxLength

+				
in file schema.inc, method AttributeType::getMaxLength()
    Gets this attribute's the maximum length. If no maximum is defined by the LDAP server, null is returned.

+							
getMayAttrNames

+				
in file schema.inc, method ObjectClass::getMayAttrNames()
    Gets an array of attribute names (strings) that entries of this ObjectClass must define.

+							
getMayAttrs

+				
in file schema.inc, method ObjectClass::getMayAttrs()
    Gets an array of AttributeType objects that entries of this ObjectClass may define.

+							
getMustAttrNames

+				
in file schema.inc, method ObjectClass::getMustAttrNames()
    Gets an array of attribute names (strings) that entries of this ObjectClass must define.

+							
getMustAttrs

+				
in file schema.inc, method ObjectClass::getMustAttrs()
    Gets an array of AttributeType objects that entries of this ObjectClass must define.

+							
getName

+				
in file schema.inc, method MatchingRule::getName()
    Gets this MatchingRule's name.

+							
getName

+				
in file schema.inc, method MatchingRuleUse::getName()
    Gets this MatchingRuleUse's name

+							
getName

+				
in file schema.inc, method AttributeType::getName()
    Gets this attribute's name

+							
getName

+				
in file schema.inc, method ObjectClass::getName()
    Gets the name of this objectClass (ie, "inetOrgPerson")

+							
getName

+				
in file schema.inc, method ObjectClassAttribute::getName()
    Gets this attribute's name

+							
getOID

+				
in file schema.inc, method SchemaItem::getOID()

+							
getOrdering

+				
in file schema.inc, method AttributeType::getOrdering()
    Gets this attribute's ordering specification.

+							
getRequiredByObjectClasses

+				
in file schema.inc, method AttributeType::getRequiredByObjectClasses()
    Gets the list of "required by" objectClasses, that is the list of objectClasses  which provide must have attribute.

+							
getshells

+				
in file account.inc, function getshells()
    Returns a list of shells listed in config/shells.

+							
getSource

+				
in file schema.inc, method ObjectClassAttribute::getSource()
    Gets the name of the ObjectClass which originally specified this attribute.

+							
getSubstr

+				
in file schema.inc, method AttributeType::getSubstr()
    Gets this attribute's substring matching specification

+							
getSupAttribute

+				
in file schema.inc, method AttributeType::getSupAttribute()
    Gets this attribute's parent attribute (if any). If this attribute does not  inherit from another attribute, null is returned.

+							
getSupClasses

+				
in file schema.inc, method ObjectClass::getSupClasses()
    Gets the objectClass names from which this objectClass inherits.

+							
getSyntaxOID

+				
in file schema.inc, method AttributeType::getSyntaxOID()
    Gets this attribute's syntax OID. Differs from getSyntaxString() in that this  function only returns the actual OID with any length specification removed.

+							
getSyntaxString

+				
in file schema.inc, method AttributeType::getSyntaxString()
    Gets this attribute's raw syntax string (ie: "1.2.3.4{16}").

+							
getType

+				
in file schema.inc, method ObjectClass::getType()
    Gets the type of this objectClass: STRUCTURAL, ABSTRACT, or AUXILIARY.

+							
getType

+				
in file schema.inc, method AttributeType::getType()
    Gets this attribute's type

+							
getUsage

+				
in file schema.inc, method AttributeType::getUsage()
    Gets this attribute's usage string as defined by the LDAP server

+							
getUsedByAttrs

+				
in file schema.inc, method MatchingRuleUse::getUsedByAttrs()
    Gets an array of attribute names (strings) which use this MatchingRuleUse object.

+							
getUsedByAttrs

+				
in file schema.inc, method MatchingRule::getUsedByAttrs()
    Gets an array of attribute names (strings) which use this MatchingRule

+							
getUsedInObjectClasses

+				
in file schema.inc, method AttributeType::getUsedInObjectClasses()
    Gets the list of "used in" objectClasses, that is the list of objectClasses  which provide this attribute.

+							
get_cache

+				
in file cache.inc, method cache::get_cache()
    Queries the cache for a list of LDAP entries and their attributes.

+							
get_cached_schema

+				
in file schema.inc, function get_cached_schema()
    Returns the cached array of schemaitem objects for the specified

+							
get_preg

+				
in file account.inc, function get_preg()
    Checks if a given value matches the selected regular expression.

+							
get_schema_attribute

+				
in file schema.inc, function get_schema_attribute()
    Gets a single AttributeType object specified by name.

+							
get_schema_attributes

+				
in file schema.inc, function get_schema_attributes()
    Gets an associative array of AttributeType objects for the specified  server. Each array entry's key is the name of the attributeType  in lower-case and the value is an AttributeType object.

+							
get_schema_matching_rules

+				
in file schema.inc, function get_schema_matching_rules()
    Returns an array of MatchingRule objects for the specified server.

+							
get_schema_objectclass

+				
in file schema.inc, function get_schema_objectclass()
    Gets a single ObjectClass object specified by name.

+							
get_schema_objectclasses

+				
in file schema.inc, function get_schema_objectclasses()
    Gets an associative array of ObjectClass objects for the specified  server. Each array entry's key is the name of the objectClass  in lower-case and the value is an ObjectClass object.

+							
get_schema_syntaxes

+				
in file schema.inc, function get_schema_syntaxes()
    Returns an array of Syntax objects that this LDAP server uses mapped to  their descriptions. The key of each entry is the OID of the Syntax.

+					

+	

+	top

+  

+	
+	

+		
i

+		

+							
$is_collective

+				
in file schema.inc, variable AttributeType::$is_collective
    boolean: is collective?

+							
$is_no_user_modification

+				
in file schema.inc, variable AttributeType::$is_no_user_modification
    boolean: can use modify?

+							
$is_obsolete

+				
in file schema.inc, variable MatchingRule::$is_obsolete
    Boolean value indicating whether this MatchingRule is obsolete

+							
$is_obsolete

+				
in file schema.inc, variable ObjectClass::$is_obsolete
    boolean value indicating whether this objectClass is obsolete

+							
$is_obsolete

+				
in file schema.inc, variable AttributeType::$is_obsolete
    string: the description

+							
$is_single_value

+				
in file schema.inc, variable AttributeType::$is_single_value
    boolean: is single valued only?

+							
initVars

+				
in file schema.inc, method ObjectClass::initVars()
    Initialize the class' member variables

+							
initVars

+				
in file schema.inc, method SchemaItem::initVars()
    Initialize class members to default values.

+							
initVars

+				
in file schema.inc, method Syntax::initVars()
    Initializes the class' member variables

+							
initVars

+				
in file schema.inc, method AttributeType::initVars()
    Initialize the class' member variables

+							
initVars

+				
in file schema.inc, method MatchingRuleUse::initVars()
    Initialize the class' member variables

+							
initVars

+				
in file schema.inc, method MatchingRule::initVars()
    Initialize the class' member variables

+							
in_array_ignore_case

+				
in file account.inc, function in_array_ignore_case()
    Checks if a string exists in an array, ignoring case.

+							
in_cache

+				
in file cache.inc, method cache::in_cache()
    This function returns the DN if an LDAP entry with $attribute=$value is found.

+							
isAliasFor

+				
in file schema.inc, method AttributeType::isAliasFor()
    Returns whether the specified attribute is an alias for this one (based on this attribute's alias list).

+					

+	

+	top

+  

+	
+	

+		
l

+		

+							
$ldapcache

+				
in file cache.inc, variable cache::$ldapcache
    This variable contains the cache

+							
lmPassword

+				
in file account.inc, function lmPassword()
    Generates the LM hash of a password.

+							
logNewMessage

+				
in file security.inc, function logNewMessage()
    Puts a new message in the log file.

+							
logoffAndBackToLoginPage

+				
in file security.inc, function logoffAndBackToLoginPage()
    Logs off the user and displays the login page.

+					

+	

+	top

+  

+	
+	

+		
m

+		

+							
$max_length

+				
in file schema.inc, variable AttributeType::$max_length
    The max number of characters this attribute can be

+							
$may_attrs

+				
in file schema.inc, variable ObjectClass::$may_attrs
    arrays of attribute names that this objectClass allows, but does not require

+							
$must_attrs

+				
in file schema.inc, variable ObjectClass::$must_attrs
    arrays of attribute names that this objectClass requires

+							
MatchingRule

+				
in file schema.inc, method MatchingRule::MatchingRule()
    Creates a new MatchingRule object from a raw LDAP MatchingRule string.

+							
MatchingRule

+				
in file schema.inc, class MatchingRule
    Represents an LDAP MatchingRule

+							
MatchingRuleUse

+				
in file schema.inc, class MatchingRuleUse
    Represents an LDAP schema matchingRuleUse entry

+							
MatchingRuleUse

+				
in file schema.inc, method MatchingRuleUse::MatchingRuleUse()

+					

+	

+	top

+  

+	
+	

+		
n

+		

+							
$name

+				
in file schema.inc, variable ObjectClass::$name
    This objectClass' name, ie "inetOrgPerson"

+							
$name

+				
in file schema.inc, variable ObjectClassAttribute::$name
    This Attribute's name

+							
$name

+				
in file schema.inc, variable MatchingRuleUse::$name
    The name of the MathingRule this applies to

+							
$name

+				
in file schema.inc, variable MatchingRule::$name
    This rule's name

+							
$name

+				
in file schema.inc, variable AttributeType::$name
    The name of this attributeType

+							
ntPassword

+				
in file account.inc, function ntPassword()
    Generates the NT hash of a password.

+					

+	

+	top

+  

+	
+	

+		
o

+		

+							
$oid

+				
in file schema.inc, variable SchemaItem::$oid
    The OID of this schema item.

+							
$ordering

+				
in file schema.inc, variable AttributeType::$ordering
    The ordering of the attributeType

+							
ObjectClass

+				
in file schema.inc, method ObjectClass::ObjectClass()
    Creates a new ObjectClass object given a raw LDAP objectClass string.

+							
ObjectClass

+				
in file schema.inc, class ObjectClass
    Represents an LDAP objectClass

+							
ObjectClassAttribute

+				
in file schema.inc, method ObjectClassAttribute::ObjectClassAttribute()
    Creates a new ObjectClassAttribute with specified name and source objectClass.

+							
ObjectClassAttribute

+				
in file schema.inc, class ObjectClassAttribute
    A simple class for representing AttributeTypes used only by the ObjectClass class.

+					

+	

+	top

+  

+	
+	

+		
p

+		

+							
pwd_disable

+				
in file account.inc, function pwd_disable()
    Marks an password hash as disabled and returns the new hash string

+							
pwd_enable

+				
in file account.inc, function pwd_enable()
    Marks an password hash as enabled and returns the new hash string

+							
pwd_hash

+				
in file account.inc, function pwd_hash()
    Returns the hash value of a plain text password  the hash algorithm depends on the configuration file

+							
pwd_is_enabled

+				
in file account.inc, function pwd_is_enabled()
    Checks if a password hash is enabled/disabled

+					

+	

+	top

+  

+	
+	

+		
r

+		

+							
$required_by_object_classes

+				
in file schema.inc, variable AttributeType::$required_by_object_classes
    A list of object class names that require this attribute type.

+							
refresh_cache

+				
in file cache.inc, method cache::refresh_cache()
    This function refreshes the cache.

+							
removeAlias

+				
in file schema.inc, method AttributeType::removeAlias()
    Removes an attribute name from this attribute's alias array.

+							
RndInt

+				
in file account.inc, function RndInt()
    THIS FUNCTION GENERATES A RANDOM NUMBER THAT WILL BE USED TO  RANDOMLY SELECT CHARACTERS.

+					

+	

+	top

+  

+	
+	

+		
s

+		

+							
$source

+				
in file schema.inc, variable ObjectClassAttribute::$source
    This Attribute's root

+							
$sub_str

+				
in file schema.inc, variable AttributeType::$sub_str
    Boolean: supports substring matching?

+							
$sup_attribute

+				
in file schema.inc, variable AttributeType::$sup_attribute
    The attribute from which this attribute inherits (if any)

+							
$sup_classes

+				
in file schema.inc, variable ObjectClass::$sup_classes
    array of objectClass names from which this objectClass inherits

+							
$syntax

+				
in file schema.inc, variable MatchingRule::$syntax
    This rule's syntax OID

+							
$syntax

+				
in file schema.inc, variable AttributeType::$syntax
    The full syntax string, ie 1.2.3.4{16}

+							
schema.inc

+				
procedural page schema.inc

+							
security.inc

+				
procedural page security.inc

+							
status.inc

+				
procedural page status.inc

+							
SchemaItem

+				
in file schema.inc, class SchemaItem
    Generic parent class for all schema items. A schema item is  an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.

+							
SchemaItem

+				
in file schema.inc, method SchemaItem::SchemaItem()
    Default constructor.

+							
SCHEMA_SESSION_CACHE_ENABLED

+				
in file schema.inc, constant SCHEMA_SESSION_CACHE_ENABLED
    To enable/disable session-based schema caching (1: enabled, 0: disabled).

+							
search_domains

+				
in file account.inc, function search_domains()
    Returns an array with all Samba 3 domain entries under the given suffix

+							
setAliases

+				
in file schema.inc, method AttributeType::setAliases()
    Sets this attribute's list of aliases.

+							
setDescription

+				
in file schema.inc, method SchemaItem::setDescription()

+							
setIsSingleValue

+				
in file schema.inc, method AttributeType::setIsSingleValue()
    Sets whether this attribute is single-valued.

+							
setName

+				
in file schema.inc, method AttributeType::setName()
    Sets this attriute's name.

+							
setOID

+				
in file schema.inc, method SchemaItem::setOID()

+							
setSupAttribute

+				
in file schema.inc, method AttributeType::setSupAttribute()
    Sets this attriute's SUP attribute (ie, the attribute from which this attribute inherits).

+							
setType

+				
in file schema.inc, method AttributeType::setType()
    Sets this attribute's type.

+							
setUsedByAttrs

+				
in file schema.inc, method MatchingRule::setUsedByAttrs()
    Sets the list of used_by_attrs to the array specified by $attrs;

+							
set_cached_schema

+				
in file schema.inc, function set_cached_schema()
    Caches the specified $schema_type.

+							
set_schema_cache_unavailable

+				
in file schema.inc, function set_schema_cache_unavailable()
    Sets the schema entry for the server_id to be "unavailable" so that we realize  that we tried to get the schema but could not, so quit trying next time to  fetch it from the server.

+							
smbflag

+				
in file account.inc, function smbflag()
    Takes a list of Samba flags and creates the corresponding flag string.

+							
startSecureSession

+				
in file security.inc, function startSecureSession()
    Starts a session and checks the environment.

+							
StatusMessage

+				
in file status.inc, function StatusMessage()
    This function prints a short status message. It can be used to print INFO,  WARN and ERROR messages at the moment.

+							
Syntax

+				
in file schema.inc, method Syntax::Syntax()
    Creates a new Syntax object from a raw LDAP syntax string.

+							
Syntax

+				
in file schema.inc, class Syntax
    Represents an LDAP Syntax

+					

+	

+	top

+  

+	
+	

+		
t

+		

+							
$time

+				
in file cache.inc, variable cache::$time
    This is the last timestamp on which the LDAP cache has been refreshed

+							
$type

+				
in file schema.inc, variable ObjectClass::$type
    one of STRUCTURAL, ABSTRACT, or AUXILIARY

+							
$type

+				
in file schema.inc, variable AttributeType::$type
    A string description of the syntax type (taken from the LDAPSyntaxes)

+					

+	

+	top

+  

+	
+	

+		
u

+		

+							
$usage

+				
in file schema.inc, variable AttributeType::$usage
    The usage string set by the LDAP schema

+							
$used_by_attrs

+				
in file schema.inc, variable MatchingRule::$used_by_attrs
    An array of attribute names who use this MatchingRule

+							
$used_by_attrs

+				
in file schema.inc, variable MatchingRuleUse::$used_by_attrs
    An array of attributeType names who make use of the mathingRule

+							
$used_in_object_classes

+				
in file schema.inc, variable AttributeType::$used_in_object_classes
    An array of objectClasses which use this attributeType (must be set by caller)

+					

+	

+	top

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/elementindex_lists.html b/lam-web/developers/phpdoc/elementindex_lists.html
new file mode 100644
index 00000000..481757cf
--- /dev/null
+++ b/lam-web/developers/phpdoc/elementindex_lists.html
@@ -0,0 +1,516 @@
+
+
+Package lists Element Index
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              PDF

+              lists

+              profiles

+              LDAP

+              types

+              lib

+              modules

+              selfService

+              configuration

+              tools

+              Help

+              tests

+              main

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
+
Element index for package lists

+	[ a ]
+	[ b ]
+	[ c ]
+	[ d ]
+	[ e ]
+	[ f ]
+	[ g ]
+	[ i ]
+	[ l ]
+	[ m ]
+	[ n ]
+	[ p ]
+	[ r ]
+	[ s ]
+	[ t ]
+	[ u ]
+
+  

+	
+	

+		
a

+		

+							
$attrArray

+				
in file lists.inc, variable lamList::$attrArray
    list of LDAP attributes

+							
arrayLower

+				
in file tree.inc, function arrayLower() (subpackage: tree)

+							
add_attr_form.php

+				
procedural page add_attr_form.php (subpackage: tree)

+							
add_attr.php

+				
procedural page add_attr.php (subpackage: tree)

+							
add_oclass_form.php

+				
procedural page add_oclass_form.php (subpackage: tree)

+							
add_oclass.php

+				
procedural page add_oclass.php (subpackage: tree)

+							
add_value_form.php

+				
procedural page add_value_form.php (subpackage: tree)

+							
add_value.php

+				
procedural page add_value.php (subpackage: tree)

+					

+	

+	top

+  

+	
+	

+		
b

+		

+							
build_initial_tree_icons

+				
in file tree.inc, function build_initial_tree_icons() (subpackage: tree)
    Builds the initial array that stores the icon-lookup for each server's DN in the tree browser. The returned

+					

+	

+	top

+  

+	
+	

+		
c

+		

+							
cmp_array

+				
in file lists.inc, method lamList::cmp_array()
    Compare function used for usort-method

+							
collapse.php

+				
procedural page collapse.php (subpackage: tree)

+							
create_form.php

+				
procedural page create_form.php (subpackage: tree)

+							
create.php

+				
procedural page create.php (subpackage: tree)

+							
creation_template.php

+				
procedural page creation_template.php (subpackage: tree)

+							
custom.php

+				
procedural page custom.php (subpackage: tree)

+					

+	

+	top

+  

+	
+	

+		
d

+		

+							
$descArray

+				
in file lists.inc, variable lamList::$descArray
    list of attribute descriptions

+							
dn_exists

+				
in file tree.inc, function dn_exists() (subpackage: tree)
    Gets whether an entry exists based on its DN. If the entry exists,  returns true. Otherwise returns false.

+							
draw_create_link

+				
in file tree.php, function draw_create_link() (subpackage: tree)

+							
draw_formatted_dn

+				
in file tree.inc, function draw_formatted_dn() (subpackage: tree)
    Gets a DN string using the user-configured tree_display_format string to format it.

+							
draw_jpeg_photos

+				
in file tree.inc, function draw_jpeg_photos() (subpackage: tree)
    Draw the jpegPhoto image(s) for an entry wrapped in HTML. Many options are available to  specify how the images are to be displayed.

+							
draw_server_tree

+				
in file tree.inc, function draw_server_tree() (subpackage: tree)
    Prints the HTML of the tree view.

+							
draw_tree_html

+				
in file tree.php, function draw_tree_html() (subpackage: tree)
    Recursively descend on the given dn and draw the tree in html

+							
delete_attr.php

+				
procedural page delete_attr.php (subpackage: tree)

+							
delete_form.php

+				
procedural page delete_form.php (subpackage: tree)

+							
delete.php

+				
procedural page delete.php (subpackage: tree)

+							
download_binary_attr.php

+				
procedural page download_binary_attr.php (subpackage: tree)

+					

+	

+	top

+  

+	
+	

+		
e

+		

+							
$entries

+				
in file lists.inc, variable lamList::$entries
    LDAP entries

+							
edit.php

+				
procedural page edit.php (subpackage: tree)

+							
expand.php

+				
procedural page expand.php (subpackage: tree)

+							
export_form.php

+				
procedural page export_form.php (subpackage: tree)

+							
export.php

+				
procedural page export.php (subpackage: tree)

+					

+	

+	top

+  

+	
+	

+		
f

+		

+							
$filterText

+				
in file lists.inc, variable lamList::$filterText
    filter string to include in URL

+					

+	

+	top

+  

+	
+	

+		
g

+		

+							
get_attr_select_html

+				
in file custom.php, function get_attr_select_html() (subpackage: tree)
    Returns option values.

+							
get_binary_attr_select_html

+				
in file custom.php, function get_binary_attr_select_html() (subpackage: tree)
    Returns option values.

+							
get_container

+				
in file tree.inc, function get_container() (subpackage: tree)
    Given a DN string, this returns the parent container portion of the string.

+							
get_container_contents

+				
in file tree.inc, function get_container_contents() (subpackage: tree)
    Gets a list of child entries for an entry. Given a DN, this function fetches the list of DNs of  child entries one level beneath the parent. For example, for the following tree:

+							
get_enc_type

+				
in file tree.inc, function get_enc_type() (subpackage: tree)

+							
get_entry_system_attrs

+				
in file tree.inc, function get_entry_system_attrs() (subpackage: tree)
    Gets the operational attributes for an entry. Given a DN, this function fetches that entry's

+							
get_icon

+				
in file tree.inc, function get_icon() (subpackage: tree)
    Given a DN and server ID, this function reads the DN's objectClasses and

+							
get_line_end_format

+				
in file export_form.php, function get_line_end_format() (subpackage: tree)
    Helper functoin for fetching the line end format.

+							
get_object_attr

+				
in file tree.inc, function get_object_attr() (subpackage: tree)
    Much like get_object_attrs(), but only returns the values for  one attribute of an object. Example calls:

+							
get_object_attrs

+				
in file tree.inc, function get_object_attrs() (subpackage: tree)
    Gets the attributes/values of an entry. Returns an associative array whose

+							
get_rdn

+				
in file tree.inc, function get_rdn() (subpackage: tree)
    Given a DN string, this returns the 'RDN' portion of the string.

+					

+	

+	top

+  

+	
+	

+		
i

+		

+							
initialize_session_tree

+				
in file tree.inc, function initialize_session_tree() (subpackage: tree)
    Checks and fixes an initial session's tree cache if needed.

+							
is_attr_binary

+				
in file tree.inc, function is_attr_binary() (subpackage: tree)
    Given an attribute name and server ID number, this function returns  whether the attrbiute may contain binary data. This is useful for  developers who wish to display the contents of an arbitrary attribute  but don't want to dump binary data on the page.

+							
is_attr_boolean

+				
in file tree.inc, function is_attr_boolean() (subpackage: tree)
    Given an attribute name and server ID number, this function returns  whether the attrbiute contains boolean data. This is useful for  developers who wish to display the contents of a boolean attribute  with a drop-down.

+							
is_binary_option_required

+				
in file add_attr.php, function is_binary_option_required() (subpackage: tree)

+							
is_dn_attr

+				
in file tree.inc, function is_dn_attr() (subpackage: tree)
    Returns true if the attribute specified is required to take as input a DN.

+							
is_jpeg_photo

+				
in file tree.inc, function is_jpeg_photo() (subpackage: tree)
    Used to determine if the specified attribute is indeed a jpegPhoto. If the  specified attribute is one that houses jpeg data, true is returned. Otherwise  this function returns false.

+							
is_mail_string

+				
in file tree.inc, function is_mail_string() (subpackage: tree)
    Get whether a string looks like an email address (user@example.com).

+							
is_multi_line_attr

+				
in file tree.inc, function is_multi_line_attr() (subpackage: tree)
    Determines if an attribute's value can contain multiple lines. Attributes that fall  in this multi-line category may be configured in config.php. Hence, this function  accesses the global variable $multi_line_attributes;

+							
is_url_string

+				
in file tree.inc, function is_url_string() (subpackage: tree)
    Get whether a string looks like a web URL (http://www.example.com/)

+					

+	

+	top

+  

+	
+	

+		
l

+		

+							
$labels

+				
in file lists.inc, variable lamList::$labels
    list of account specific labels

+							
lamGroupList

+				
in file group.inc, class lamGroupList
    Generates the list view.

+							
lamGroupList

+				
in file group.inc, method lamGroupList::lamGroupList()
    Constructor

+							
lamHostList

+				
in file host.inc, method lamHostList::lamHostList()
    Constructor

+							
lamHostList

+				
in file host.inc, class lamHostList
    Generates the list view.

+							
lamList

+				
in file lists.inc, method lamList::lamList()
    Constructor

+							
lamList

+				
in file lists.inc, class lamList
    Generates the list view.

+							
lamMailAliasList

+				
in file mailAlias.inc, class lamMailAliasList
    Generates the list view.

+							
lamMailAliasList

+				
in file mailAlias.inc, method lamMailAliasList::lamMailAliasList()
    Constructor

+							
lamSmbDomainList

+				
in file smbDomain.inc, method lamSmbDomainList::lamSmbDomainList()
    Constructor

+							
lamSmbDomainList

+				
in file smbDomain.inc, class lamSmbDomainList
    Generates the list view.

+							
lamUserList

+				
in file user.inc, class lamUserList
    Generates the list view.

+							
lamUserList

+				
in file user.inc, method lamUserList::lamUserList()
    Constructor

+							
lists.inc

+				
procedural page lists.inc

+							
listBuildFilter

+				
in file lists.inc, method lamList::listBuildFilter()
    Builds the regular expressions from the filter values.

+							
listDoPost

+				
in file user.inc, method lamUserList::listDoPost()
    Manages all POST actions (e.g. button pressed) for the account lists.

+							
listDoPost

+				
in file lists.inc, method lamList::listDoPost()
    Manages all POST actions (e.g. button pressed) for the account lists.

+							
listDrawNavigationBar

+				
in file lists.inc, method lamList::listDrawNavigationBar()
    Draws a navigation bar to switch between pages

+							
listFilterAccounts

+				
in file lists.inc, method lamList::listFilterAccounts()
    Removes all entries which do not fit to the filter.

+							
listGetAttributeDescriptionList

+				
in file lists.inc, method lamList::listGetAttributeDescriptionList()
    Returns an hash array containing with all attributes to be shown and their descriptions.

+							
listGetParams

+				
in file lists.inc, method lamList::listGetParams()
    Sets some internal parameters.

+							
listPrintButtons

+				
in file user.inc, method lamUserList::listPrintButtons()
    Prints the create, delete and PDF buttons.

+							
listPrintButtons

+				
in file lists.inc, method lamList::listPrintButtons()
    Prints the create, delete and PDF buttons.

+							
listPrintHeader

+				
in file lists.inc, method lamList::listPrintHeader()
    Prints the HTML head.

+							
listPrintJavaScript

+				
in file lists.inc, method lamList::listPrintJavaScript()
    Prints JavaScript code needed for mouse-over effects.

+							
listPrintTableBody

+				
in file user.inc, method lamUserList::listPrintTableBody()
    Prints the entry list

+							
listPrintTableBody

+				
in file group.inc, method lamGroupList::listPrintTableBody()
    Prints the entry list

+							
listPrintTableBody

+				
in file lists.inc, method lamList::listPrintTableBody()
    Prints the entry list

+							
listPrintTableHeader

+				
in file lists.inc, method lamList::listPrintTableHeader()
    Prints the attribute and filter row at the account table head

+							
listRefreshData

+				
in file lists.inc, method lamList::listRefreshData()
    Rereads the entries from LDAP.

+							
listShowOUSelection

+				
in file lists.inc, method lamList::listShowOUSelection()
    Prints a combobox with possible sub-DNs.

+							
listSort

+				
in file lists.inc, method lamList::listSort()
    Sorts an account list by a given attribute

+							
list.php

+				
procedural page list.php

+					

+	

+	top

+  

+	
+	

+		
m

+		

+							
$maxPageEntries

+				
in file lists.inc, variable lamList::$maxPageEntries
    maximum count of entries per page

+					

+	

+	top

+  

+	
+	

+		
n

+		

+							
not_an_attr

+				
in file add_attr_form.php, function not_an_attr() (subpackage: tree)
    Given an attribute $x, this returns true if it is NOT already specified  in the current entry, returns false otherwise.

+							
new_ou_template.php

+				
procedural page new_ou_template.php (subpackage: tree)

+					

+	

+	top

+  

+	
+	

+		
p

+		

+							
$page

+				
in file lists.inc, variable lamList::$page
    current page number

+							
$possibleSuffixes

+				
in file lists.inc, variable lamList::$possibleSuffixes
    list of possible LDAP suffixes(organizational units)

+							
pla_compare_dns

+				
in file tree.inc, function pla_compare_dns() (subpackage: tree)
    Compares 2 DNs. If they are equivelant, returns 0, otherwise,  returns their sorting order (similar to strcmp()):       Returns < 0 if dn1 is less than dn2.

+							
pla_explode_dn

+				
in file tree.inc, function pla_explode_dn() (subpackage: tree)
    Explode a DN into an array of its RDN parts. This function is UTF-8 safe  and replaces the buggy PHP ldap_explode_dn() which does not properly  handle UTF-8 DNs and also causes segmentation faults with some inputs.

+							
pla_ldap_search

+				
in file tree.inc, function pla_ldap_search() (subpackage: tree)
    A handy ldap searching function very similar to PHP's ldap_search() with the  following exceptions: Callers may specify a search scope and the return value  is an array containing the search results rather than an LDAP result resource.

+							
pla_rdelete

+				
in file rdelete.php, function pla_rdelete() (subpackage: tree)

+							
pla_reverse_dn

+				
in file tree.inc, function pla_reverse_dn() (subpackage: tree)
    Reverses a DN such that the top-level RDN is first and the bottom-level RDN is last

+							
pretty_print_dn

+				
in file tree.inc, function pretty_print_dn() (subpackage: tree)
    Returns an HTML-beautified version of a DN.

+					

+	

+	top

+  

+	
+	

+		
r

+		

+							
$refresh

+				
in file lists.inc, variable lamList::$refresh
    refresh page switch

+							
real_attr_name

+				
in file tree.inc, function real_attr_name() (subpackage: tree)
    Prunes off anything after the ";" in an attr name. This is useful for  attributes that may have ";binary" appended to their names. With  real_attr_name(), you can more easily fetch these attributes' schema  with their "real" attribute name.

+							
remove_aliases

+				
in file custom.php, function remove_aliases() (subpackage: tree)
    Removes attributes from the array that are aliases for eachother

+							
rdelete.php

+				
procedural page rdelete.php (subpackage: tree)

+							
refresh.php

+				
procedural page refresh.php (subpackage: tree)

+					

+	

+	top

+  

+	
+	

+		
s

+		

+							
$sortColumn

+				
in file lists.inc, variable lamList::$sortColumn
    sort column name

+							
$suffix

+				
in file lists.inc, variable lamList::$suffix
    LDAP suffix

+							
search_username

+				
in file userlink.php, function search_username()
    Searches LDAP for a specific user name (uid attribute) and returns its DN entry

+							
showPage

+				
in file lists.inc, method lamList::showPage()
    Prints the HTML code to display the list view.

+							
sortAttrs

+				
in file tree.inc, function sortAttrs() (subpackage: tree)

+					

+	

+	top

+  

+	
+	

+		
t

+		

+							
$trans_primary

+				
in file user.inc, variable lamUserList::$trans_primary
    Controls if GID number is translated to group name

+							
$trans_primary_hash

+				
in file user.inc, variable lamUserList::$trans_primary_hash
    translates GID to group name

+							
$type

+				
in file lists.inc, variable lamList::$type
    Account type

+							
tree.inc

+				
procedural page tree.inc (subpackage: tree)

+							
templates.inc

+				
procedural page templates.inc (subpackage: tree)

+							
tree.php

+				
procedural page tree.php (subpackage: tree)

+							
tree_view.php

+				
procedural page tree_view.php (subpackage: tree)

+					

+	

+	top

+  

+	
+	

+		
u

+		

+							
userlink.php

+				
procedural page userlink.php

+							
update_confirm.php

+				
procedural page update_confirm.php (subpackage: tree)

+							
update.php

+				
procedural page update.php (subpackage: tree)

+					

+	

+	top

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/elementindex_main.html b/lam-web/developers/phpdoc/elementindex_main.html
new file mode 100644
index 00000000..c4958b81
--- /dev/null
+++ b/lam-web/developers/phpdoc/elementindex_main.html
@@ -0,0 +1,142 @@
+
+
+Package main Element Index
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
main

+  		  [ class tree: main ]
+		  [ index: main ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              PDF

+              lists

+              profiles

+              LDAP

+              types

+              lib

+              modules

+              selfService

+              configuration

+              tools

+              Help

+              tests

+              main

+            


+                        Files:

+      	  

+					delete.php
+		

+					initsuff.php
+		

+					login.php
+		

+					logout.php
+		

+					main.php
+		

+					main_header.php
+		

+	  


+      
+      
+                		
+      

+
+
+
Element index for package main

+	[ d ]
+	[ g ]
+	[ i ]
+	[ l ]
+	[ m ]
+
+  

+	
+	

+		
d

+		

+							
deleteDN

+				
in file delete.php, function deleteDN()
    Deletes a DN and all child entries.

+							
display_LoginPage

+				
in file login.php, function display_LoginPage()
    Displays the login window.

+							
delete.php

+				
procedural page delete.php

+					

+	

+	top

+  

+	
+	

+		
g

+		

+							
getChildCount

+				
in file delete.php, function getChildCount()
    Returns the number of child entries of a DN.

+					

+	

+	top

+  

+	
+	

+		
i

+		

+							
initsuff.php

+				
procedural page initsuff.php

+					

+	

+	top

+  

+	
+	

+		
l

+		

+							
login.php

+				
procedural page login.php

+							
logout.php

+				
procedural page logout.php

+					

+	

+	top

+  

+	
+	

+		
m

+		

+							
main_header.php

+				
procedural page main_header.php

+							
main.php

+				
procedural page main.php

+					

+	

+	top

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/elementindex_modules.html b/lam-web/developers/phpdoc/elementindex_modules.html
new file mode 100644
index 00000000..61073f22
--- /dev/null
+++ b/lam-web/developers/phpdoc/elementindex_modules.html
@@ -0,0 +1,1041 @@
+
+
+Package modules Element Index
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              PDF

+              lists

+              profiles

+              LDAP

+              types

+              lib

+              modules

+              selfService

+              configuration

+              tools

+              Help

+              tests

+              main

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
+
Element index for package modules

+	[ a ]
+	[ b ]
+	[ c ]
+	[ d ]
+	[ e ]
+	[ f ]
+	[ g ]
+	[ h ]
+	[ i ]
+	[ k ]
+	[ l ]
+	[ m ]
+	[ n ]
+	[ o ]
+	[ p ]
+	[ q ]
+	[ r ]
+	[ s ]
+	[ t ]
+	[ u ]
+	[ x ]
+	[ _ ]
+
+  

+	
+	

+		
_

+		

+							
__sleep

+				
in file modules.inc, method accountContainer::__sleep()
    Encrypts sensitive data before storing in session.

+							
__wakeup

+				
in file modules.inc, method accountContainer::__wakeup()
    Decrypts sensitive data after accountContainer was loaded from session.

+					

+	

+	top

+  

+	
+	

+		
a

+		

+							
$attributes

+				
in file modules.inc, variable accountContainer::$attributes
    Array of all used attributes

+							
$attributes

+				
in file baseModule.inc, variable baseModule::$attributes
    contains all ldap attributes which should be written

+							
$attributes_orig

+				
in file modules.inc, variable accountContainer::$attributes_orig
    original LDAP attributes when account was loaded from LDAP

+							
account

+				
in file account.inc, class account
    Manages the object class "account" for users and hosts.

+							
accountContainer

+				
in file modules.inc, method accountContainer::accountContainer()
    Constructor

+							
accountContainer

+				
in file modules.inc, class accountContainer
    This class includes all modules and attributes of an account.

+							
account.inc

+				
procedural page account.inc

+					

+	

+	top

+  

+	
+	

+		
b

+		

+							
$base

+				
in file modules.inc, variable accountContainer::$base
    Name of accountContainer variable in session

+							
$base

+				
in file baseModule.inc, variable baseModule::$base
    name of parent accountContainer ($_SESSION[$base])

+							
baseModule

+				
in file baseModule.inc, class baseModule
    Parent class of all account modules

+							
baseModule

+				
in file baseModule.inc, method baseModule::baseModule()
    Creates a new base module class

+							
buildUploadAccounts

+				
in file modules.inc, function buildUploadAccounts()
    This function builds the LDAP accounts for the file upload.

+							
build_uploadAccounts

+				
in file posixGroup.inc, method posixGroup::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file posixAccount.inc, method posixAccount::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file sambaAccount.inc, method sambaAccount::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file sambaGroupMapping.inc, method sambaGroupMapping::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file shadowAccount.inc, method shadowAccount::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file sambaSamAccount.inc, method sambaSamAccount::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file nisMailAlias.inc, method nisMailAlias::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file sambaDomain.inc, method sambaDomain::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file ldapPublicKey.inc, method ldapPublicKey::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file ieee802device.inc, method ieee802Device::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file baseModule.inc, method baseModule::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file account.inc, method account::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file inetOrgPerson.inc, method inetOrgPerson::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
build_uploadAccounts

+				
in file kolabUser.inc, method kolabUser::build_uploadAccounts()
    In this function the LDAP account is built up.

+							
baseModule.inc

+				
procedural page baseModule.inc

+					

+	

+	top

+  

+	
+	

+		
c

+		

+							
$changegids

+				
in file posixGroup.inc, variable posixGroup::$changegids
    change GIDs of users and hosts?

+							
$clearTextPassword

+				
in file posixAccount.inc, variable posixAccount::$clearTextPassword

+							
$createhomedir

+				
in file posixAccount.inc, variable posixAccount::$createhomedir

+							
$current_page

+				
in file modules.inc, variable accountContainer::$current_page
    This variable stores the name of the currently displayed page

+							
can_manage

+				
in file baseModule.inc, method baseModule::can_manage()
    Returns true if this module fits for the current scope.

+							
checkASCII

+				
in file posixAccount.inc, method posixAccount::checkASCII()
    Checks if an attribute contains only ASCII charaters and replaces invalid characters.

+							
checkConfigOptions

+				
in file modules.inc, function checkConfigOptions()
    Checks if the configuration options are valid

+							
checkProfileOptions

+				
in file modules.inc, function checkProfileOptions()
    Checks if the profile options are valid

+							
checkSelfServiceOptions

+				
in file sambaSamAccount.inc, method sambaSamAccount::checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP commands which should be executed.

+							
checkSelfServiceOptions

+				
in file baseModule.inc, method baseModule::checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP commands which should be executed.

+							
checkSelfServiceOptions

+				
in file inetOrgPerson.inc, method inetOrgPerson::checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP commands which should be executed.

+							
checkSelfServiceOptions

+				
in file posixAccount.inc, method posixAccount::checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP commands which should be executed.

+							
check_configOptions

+				
in file baseModule.inc, method baseModule::check_configOptions()
    Checks input values of module settings.

+							
check_configOptions

+				
in file posixAccount.inc, method posixAccount::check_configOptions()
    Checks input values of module settings.

+							
check_module_conflicts

+				
in file modules.inc, function check_module_conflicts()
    Checks if there are conflicts between modules

+							
check_module_depends

+				
in file modules.inc, function check_module_depends()
    Checks if there are missing dependencies between modules.

+							
check_profileOptions

+				
in file baseModule.inc, method baseModule::check_profileOptions()
    Checks input values of account profiles.

+							
check_profileOptions

+				
in file quota.inc, method quota::check_profileOptions()
    Checks input values of account profiles.

+							
continue_main

+				
in file modules.inc, method accountContainer::continue_main()
    This function is called when the user clicks on any button on the account pages.

+							
createntlm.inc

+				
procedural page createntlm.inc

+					

+	

+	top

+  

+	
+	

+		
d

+		

+							
$deactivated

+				
in file sambaSamAccount.inc, variable sambaSamAccount::$deactivated
    account deactivated?

+							
$deactivated

+				
in file sambaAccount.inc, variable sambaAccount::$deactivated
    account deactivated?

+							
$dn

+				
in file modules.inc, variable accountContainer::$dn
    DN suffix of the account

+							
$dn

+				
in file account.inc, variable samba3domain::$dn
    DN

+							
$dn_orig

+				
in file modules.inc, variable accountContainer::$dn_orig
    DN suffix of account when it was loaded

+							
delete_attributes

+				
in file quota.inc, method quota::delete_attributes()

+							
delete_attributes

+				
in file posixGroup.inc, method posixGroup::delete_attributes()

+							
delete_attributes

+				
in file baseModule.inc, method baseModule::delete_attributes()
    Dummy function for modules which use no special options on account deletion.

+							
delete_attributes

+				
in file posixAccount.inc, method posixAccount::delete_attributes()
    Additional LDAP operations on delete.

+							
display_html_attributes

+				
in file nisMailAlias.inc, method nisMailAlias::display_html_attributes()
    This function will create the meta HTML code to show a page with all attributes.

+							
display_html_attributes

+				
in file posixAccount.inc, method posixAccount::display_html_attributes()

+							
display_html_attributes

+				
in file sambaAccount.inc, method sambaAccount::display_html_attributes()

+							
display_html_attributes

+				
in file quota.inc, method quota::display_html_attributes()

+							
display_html_attributes

+				
in file posixGroup.inc, method posixGroup::display_html_attributes()

+							
display_html_attributes

+				
in file sambaDomain.inc, method sambaDomain::display_html_attributes()
    This function will create the meta HTML code to show a page with all attributes.

+							
display_html_attributes

+				
in file account.inc, method account::display_html_attributes()

+							
display_html_attributes

+				
in file ldapPublicKey.inc, method ldapPublicKey::display_html_attributes()
    This function will create the meta HTML code to show a page with all attributes.

+							
display_html_attributes

+				
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::display_html_attributes()
    This function will create the meta HTML code to show a page with all attributes.

+							
display_html_attributes

+				
in file ieee802device.inc, method ieee802Device::display_html_attributes()
    This function will create the meta HTML code to show a page with all attributes.

+							
display_html_attributes

+				
in file shadowAccount.inc, method shadowAccount::display_html_attributes()
    This function will create the meta HTML code to show a page with all attributes.

+							
display_html_attributes

+				
in file sambaGroupMapping.inc, method sambaGroupMapping::display_html_attributes()

+							
display_html_attributes

+				
in file inetOrgPerson.inc, method inetOrgPerson::display_html_attributes()

+							
display_html_attributes

+				
in file sambaSamAccount.inc, method sambaSamAccount::display_html_attributes()

+							
display_html_attributes

+				
in file kolabUser.inc, method kolabUser::display_html_attributes()
    This function will create the meta HTML code to show a page with all attributes.

+							
display_html_delete

+				
in file posixAccount.inc, method posixAccount::display_html_delete()

+							
display_html_delete

+				
in file baseModule.inc, method baseModule::display_html_delete()
    Dummy function for modules which do not print extra HTML code on account deletion.

+							
display_html_deleteUser

+				
in file kolabUser.inc, method kolabUser::display_html_deleteUser()
    This function will create the meta HTML code to show a page to delete accounts.

+							
display_html_expire

+				
in file shadowAccount.inc, method shadowAccount::display_html_expire()
    This function will create the meta HTML code to show a page with the expiration date.

+							
display_html_group

+				
in file posixAccount.inc, method posixAccount::display_html_group()
    Displays the group selection.

+							
display_html_logonHours

+				
in file sambaSamAccount.inc, method sambaSamAccount::display_html_logonHours()
    This function will create the HTML page to edit logon hours.

+							
display_html_password

+				
in file inetOrgPerson.inc, method inetOrgPerson::display_html_password()
    Displays the password changing dialog.

+							
display_html_password

+				
in file posixAccount.inc, method posixAccount::display_html_password()
    Displays the password changing dialog.

+							
display_html_password

+				
in file posixGroup.inc, method posixGroup::display_html_password()
    Displays the password changing dialog.

+							
display_html_photo

+				
in file inetOrgPerson.inc, method inetOrgPerson::display_html_photo()
    Displays the photo upload page.

+							
display_html_sambaUserWorkstations

+				
in file sambaSamAccount.inc, method sambaSamAccount::display_html_sambaUserWorkstations()

+							
display_html_time

+				
in file sambaSamAccount.inc, method sambaSamAccount::display_html_time()
    This function will create the meta HTML code to show a page to change time values.

+							
display_html_user

+				
in file posixGroup.inc, method posixGroup::display_html_user()
    Displays selections to add or remove users from current group.

+							
display_html_userWorkstations

+				
in file sambaAccount.inc, method sambaAccount::display_html_userWorkstations()

+							
doHash

+				
in file createntlm.inc, method smbHash::doHash()

+							
doUploadPostActions

+				
in file baseModule.inc, method baseModule::doUploadPostActions()
    This function executes one post upload action.

+							
doUploadPostActions

+				
in file modules.inc, function doUploadPostActions()
    This function executes one post upload action.

+							
doUploadPostActions

+				
in file quota.inc, method quota::doUploadPostActions()
    This function executes one post upload action.

+							
doUploadPostActions

+				
in file posixAccount.inc, method posixAccount::doUploadPostActions()
    This function executes one post upload action.

+					

+	

+	top

+  

+	
+	

+		
e

+		

+							
E_P16

+				
in file createntlm.inc, method smbHash::E_P16()

+							
edit.php

+				
procedural page edit.php

+					

+	

+	top

+  

+	
+	

+		
f

+		

+							
fixLDAPAttributes

+				
in file modules.inc, method accountContainer::fixLDAPAttributes()
    Fixes spelling errors in the attribute names.

+					

+	

+	top

+  

+	
+	

+		
g

+		

+							
$groups

+				
in file posixAccount.inc, variable posixAccount::$groups

+							
$groups_orig

+				
in file posixAccount.inc, variable posixAccount::$groups_orig

+							
getAvailableModules

+				
in file modules.inc, function getAvailableModules()
    Returns an array with all available user module names

+							
getAvailablePDFFields

+				
in file modules.inc, function getAvailablePDFFields()
    Returns a list of available PDF entries.

+							
getButtonStatus

+				
in file account.inc, method account::getButtonStatus()
    Controls if the module button the account page is visible and activated.

+							
getButtonStatus

+				
in file nisMailAlias.inc, method nisMailAlias::getButtonStatus()
    Controls if the module button the account page is visible and activated.

+							
getButtonStatus

+				
in file inetOrgPerson.inc, method inetOrgPerson::getButtonStatus()
    Controls if the module button the account page is visible and activated.

+							
getButtonStatus

+				
in file posixGroup.inc, method posixGroup::getButtonStatus()
    Controls if the module button the account page is visible and activated.

+							
getButtonStatus

+				
in file baseModule.inc, method baseModule::getButtonStatus()
    Controls if the module button the account page is visible and activated.

+							
getConfigOptions

+				
in file modules.inc, function getConfigOptions()
    Returns a hash array (module name => elements) of all module options for the configuration page.

+							
getHelp

+				
in file modules.inc, function getHelp()
    Returns a help entry from an account module.

+							
getLDAPAliases

+				
in file baseModule.inc, method baseModule::getLDAPAliases()
    Returns a list of aliases for LDAP attributes.

+							
getManagedAttributes

+				
in file baseModule.inc, method baseModule::getManagedAttributes()
    Returns a list of LDAP attributes which are managed by this module.

+							
getManagedObjectClasses

+				
in file baseModule.inc, method baseModule::getManagedObjectClasses()
    Returns a list of managed object classes for this module.

+							
getModuleAlias

+				
in file modules.inc, function getModuleAlias()
    Returns the alias name of a module

+							
getModulesDependencies

+				
in file modules.inc, function getModulesDependencies()
    Returns a hash array (module name => dependencies) of all module dependencies

+							
getNextGIDs

+				
in file posixGroup.inc, method posixGroup::getNextGIDs()
    Returns one or more free GID numbers.

+							
getNextUIDs

+				
in file posixAccount.inc, method posixAccount::getNextUIDs()
    Returns one or more free UID numbers.

+							
getProfileOptions

+				
in file modules.inc, function getProfileOptions()
    Returns the elements for the profile page.

+							
getRDNAttributes

+				
in file modules.inc, function getRDNAttributes()
    Returns a list of LDAP attributes which can be used to form the RDN.

+							
getRequiredExtensions

+				
in file modules.inc, function getRequiredExtensions()
    Returns true if the module is a base module

+							
getRequiredExtensions

+				
in file baseModule.inc, method baseModule::getRequiredExtensions()
    Returns a list of required PHP extensions.

+							
getSelfServiceFields

+				
in file baseModule.inc, method baseModule::getSelfServiceFields()
    Returns a list of possible input fields and their descriptions  Format: array(<field identifier> => <field description>)

+							
getSelfServiceOptions

+				
in file inetOrgPerson.inc, method inetOrgPerson::getSelfServiceOptions()
    Returns the meta HTML code for each input field.

+							
getSelfServiceOptions

+				
in file baseModule.inc, method baseModule::getSelfServiceOptions()
    Returns the meta HTML code for each input field.

+							
getSelfServiceOptions

+				
in file posixAccount.inc, method posixAccount::getSelfServiceOptions()
    Returns the meta HTML code for each input field.

+							
getSelfServiceSearchAttributes

+				
in file baseModule.inc, method baseModule::getSelfServiceSearchAttributes()
    Returns a list of possible search attributes for the self service.

+							
getUploadColumns

+				
in file modules.inc, function getUploadColumns()
    Returns an array containing all input columns for the file upload.

+							
get_alias

+				
in file baseModule.inc, method baseModule::get_alias()
    Returns an alias name for the module.

+							
get_configOptions

+				
in file posixGroup.inc, method posixGroup::get_configOptions()
    Returns a list of elements for the configuration.

+							
get_configOptions

+				
in file baseModule.inc, method baseModule::get_configOptions()
    Returns a list of elements for the configuration.

+							
get_dependencies

+				
in file baseModule.inc, method baseModule::get_dependencies()
    This function returns a list with all depending and conflicting modules.

+							
get_help

+				
in file baseModule.inc, method baseModule::get_help()
    This function return the help entry array for a specific help id. Normally this->meta can be used.

+							
get_ldap_filter

+				
in file modules.inc, function get_ldap_filter()
    Returns the LDAP filter used by the account lists

+							
get_ldap_filter

+				
in file baseModule.inc, method baseModule::get_ldap_filter()
    returns an LDAP filter for the account lists

+							
get_metaData

+				
in file account.inc, method account::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file nisMailAlias.inc, method nisMailAlias::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file baseModule.inc, method baseModule::get_metaData()
    Dummy function, meta data is provided by sub classes.

+							
get_metaData

+				
in file sambaAccount.inc, method sambaAccount::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file quota.inc, method quota::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file sambaDomain.inc, method sambaDomain::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file sambaGroupMapping.inc, method sambaGroupMapping::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file kolabUser.inc, method kolabUser::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file inetOrgPerson.inc, method inetOrgPerson::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file shadowAccount.inc, method shadowAccount::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file ldapPublicKey.inc, method ldapPublicKey::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file ieee802device.inc, method ieee802Device::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file sambaSamAccount.inc, method sambaSamAccount::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file posixAccount.inc, method posixAccount::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_metaData

+				
in file posixGroup.inc, method posixGroup::get_metaData()
    Returns meta data that is interpreted by parent class

+							
get_pdfEntries

+				
in file sambaAccount.inc, method sambaAccount::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfEntries

+				
in file sambaSamAccount.inc, method sambaSamAccount::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfEntries

+				
in file shadowAccount.inc, method shadowAccount::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfEntries

+				
in file sambaGroupMapping.inc, method sambaGroupMapping::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfEntries

+				
in file sambaDomain.inc, method sambaDomain::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfEntries

+				
in file quota.inc, method quota::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfEntries

+				
in file posixGroup.inc, method posixGroup::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfEntries

+				
in file account.inc, method account::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfEntries

+				
in file kolabUser.inc, method kolabUser::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfEntries

+				
in file ldapPublicKey.inc, method ldapPublicKey::get_pdfEntries()
    Returns a list of PDF entries

+							
get_pdfEntries

+				
in file ieee802device.inc, method ieee802Device::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfEntries

+				
in file inetOrgPerson.inc, method inetOrgPerson::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfEntries

+				
in file modules.inc, method accountContainer::get_pdfEntries()
    Returns a list of possible PDF entries for this account.

+							
get_pdfEntries

+				
in file posixAccount.inc, method posixAccount::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfEntries

+				
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfEntries

+				
in file nisMailAlias.inc, method nisMailAlias::get_pdfEntries()
    Returns the PDF entries for this module.

+							
get_pdfFields

+				
in file baseModule.inc, method baseModule::get_pdfFields()
    Returns an array with all fields available for this account type on the PDF  output. This method may be overwritten by subclasses or it may be used  by using entries in the $this->meta['PDF_fields'] array of the specific sub-  class.

+							
get_pdf_entries

+				
in file baseModule.inc, method baseModule::get_pdf_entries()
    Returns a hastable with all entries that may be printed out in the PDF. The

+							
get_profileOptions

+				
in file sambaSamAccount.inc, method sambaSamAccount::get_profileOptions()
    Returns a list of elements for the account profiles.

+							
get_profileOptions

+				
in file sambaGroupMapping.inc, method sambaGroupMapping::get_profileOptions()
    Returns a list of elements for the account profiles.

+							
get_profileOptions

+				
in file baseModule.inc, method baseModule::get_profileOptions()
    Returns a list of elements for the account profiles.

+							
get_profileOptions

+				
in file quota.inc, method quota::get_profileOptions()
    Returns a list of elements for the account profiles.

+							
get_profileOptions

+				
in file posixAccount.inc, method posixAccount::get_profileOptions()
    Returns a list of elements for the account profiles.

+							
get_RDNAttributes

+				
in file baseModule.inc, method baseModule::get_RDNAttributes()
    Returns a list of possible LDAP attributes which can be used to form the RDN.

+							
get_scope

+				
in file baseModule.inc, method baseModule::get_scope()
    Returns the account type of this module (user, group, host)

+							
get_type

+				
in file modules.inc, method accountContainer::get_type()
    Returns the accout type of this object (e.g. user, group, host).

+							
get_uploadColumns

+				
in file quota.inc, method quota::get_uploadColumns()
    Returns an array containing all input columns for the file upload.

+							
get_uploadColumns

+				
in file baseModule.inc, method baseModule::get_uploadColumns()
    Returns an array containing all input columns for the file upload.

+							
get_uploadPreDepends

+				
in file baseModule.inc, method baseModule::get_uploadPreDepends()
    Returns a list of module names which must be processed in building the account befor this module.

+					

+	

+	top

+  

+	
+	

+		
h

+		

+							
$hex2bitstring

+				
in file sambaSamAccount.inc, variable sambaSamAccount::$hex2bitstring
    HEX to binary conversion table

+					

+	

+	top

+  

+	
+	

+		
i

+		

+							
$invitationPolicies

+				
in file kolabUser.inc, variable kolabUser::$invitationPolicies
    list of invitation policies

+							
$isNewAccount

+				
in file modules.inc, variable accountContainer::$isNewAccount
    True if this is a newly created account

+							
ieee802Device

+				
in file ieee802device.inc, class ieee802Device
    Provides MAC addresses for hosts.

+							
inetLocalMailRecipient

+				
in file inetLocalMailRecipient.inc, class inetLocalMailRecipient
    Provides mail routing for users.

+							
inetOrgPerson

+				
in file inetOrgPerson.inc, class inetOrgPerson
    This class contains all account LDAP attributes  and funtioncs required to deal with inetOrgPerson.

+							
init

+				
in file sambaSamAccount.inc, method sambaSamAccount::init()
    Initializes the module after it became part of an accountContainer

+							
init

+				
in file posixAccount.inc, method posixAccount::init()

+							
init

+				
in file quota.inc, method quota::init()

+							
init

+				
in file sambaAccount.inc, method sambaAccount::init()
    Initializes the module after it became part of an accountContainer

+							
init

+				
in file sambaGroupMapping.inc, method sambaGroupMapping::init()
    Initializes the module after it became part of an accountContainer

+							
init

+				
in file posixGroup.inc, method posixGroup::init()
    This functin will be called when the module will be loaded *

+							
init

+				
in file baseModule.inc, method baseModule::init()
    Initializes the module after it became part of an accountContainer

+							
is_base_module

+				
in file modules.inc, function is_base_module()
    Returns true if the module is a base module

+							
is_base_module

+				
in file baseModule.inc, method baseModule::is_base_module()
    Returns true if this module is enough to provide a sensible account.

+							
ieee802device.inc

+				
procedural page ieee802device.inc

+							
inetLocalMailRecipient.inc

+				
procedural page inetLocalMailRecipient.inc

+							
inetOrgPerson.inc

+				
procedural page inetOrgPerson.inc

+					

+	

+	top

+  

+	
+	

+		
k

+		

+							
kolabUser

+				
in file kolabUser.inc, method kolabUser::kolabUser()
    Creates a new kolabUser object.

+							
kolabUser

+				
in file kolabUser.inc, class kolabUser
    Manages Kolab user accounts.

+							
kolabUser.inc

+				
procedural page kolabUser.inc

+					

+	

+	top

+  

+	
+	

+		
l

+		

+							
lamdaemon

+				
in file lamdaemon.inc, function lamdaemon()
    Sends commands to lamdaemon script.

+							
lamdaemonSSH

+				
in file lamdaemon.inc, function lamdaemonSSH()
    Sends commands to lamdaemon script via PHP SSH functions.

+							
ldapPublicKey

+				
in file ldapPublicKey.inc, class ldapPublicKey
    Manages SSH public keys.

+							
lamdaemon.inc

+				
procedural page lamdaemon.inc

+							
ldapPublicKey.inc

+				
procedural page ldapPublicKey.inc

+							
lmhash

+				
in file createntlm.inc, method smbHash::lmhash()
    Calculates the LM hash of a given password.

+							
load_account

+				
in file modules.inc, method accountContainer::load_account()
    Loads an LDAP account with the given DN.

+							
load_attributes

+				
in file sambaSamAccount.inc, method sambaSamAccount::load_attributes()

+							
load_attributes

+				
in file quota.inc, method quota::load_attributes()

+							
load_attributes

+				
in file sambaAccount.inc, method sambaAccount::load_attributes()

+							
load_attributes

+				
in file posixAccount.inc, method posixAccount::load_attributes()
    This function loads all needed LDAP attributes.

+							
load_attributes

+				
in file baseModule.inc, method baseModule::load_attributes()
    This function loads the LDAP attributes for this module.

+							
load_Messages

+				
in file sambaAccount.inc, method sambaAccount::load_Messages()
    this functin fills the error message array with messages

+							
load_Messages

+				
in file baseModule.inc, method baseModule::load_Messages()
    This function fills the $messages variable with output messages from this module.

+							
load_Messages

+				
in file kolabUser.inc, method kolabUser::load_Messages()
    This function fills the error message array with messages

+							
load_Messages

+				
in file sambaDomain.inc, method sambaDomain::load_Messages()
    This function fills the error message array with messages

+							
load_Messages

+				
in file sambaGroupMapping.inc, method sambaGroupMapping::load_Messages()
    this functin fills the error message array with messages

+							
load_Messages

+				
in file shadowAccount.inc, method shadowAccount::load_Messages()
    This function builds up the message array.

+							
load_Messages

+				
in file sambaSamAccount.inc, method sambaSamAccount::load_Messages()
    this functin fills the error message array with messages

+							
load_Messages

+				
in file posixGroup.inc, method posixGroup::load_Messages()
    This function fills the $messages variable with output messages from this module.

+							
load_Messages

+				
in file quota.inc, method quota::load_Messages()
    this functin fills the error message array with messages

+							
load_Messages

+				
in file ieee802device.inc, method ieee802Device::load_Messages()
    This function fills the error message array with messages

+							
load_Messages

+				
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::load_Messages()
    This function fills the error message array with messages

+							
load_Messages

+				
in file inetOrgPerson.inc, method inetOrgPerson::load_Messages()
    This function fills the message array.

+							
load_Messages

+				
in file account.inc, method account::load_Messages()
    This function fills the message array.

+							
load_Messages

+				
in file nisMailAlias.inc, method nisMailAlias::load_Messages()
    This function fills the error message array with messages

+							
load_Messages

+				
in file posixAccount.inc, method posixAccount::load_Messages()
    This function fills the error message array with messages.

+							
load_profile

+				
in file sambaSamAccount.inc, method sambaSamAccount::load_profile()
    Loads the values of an account profile into internal variables.

+							
load_profile

+				
in file posixAccount.inc, method posixAccount::load_profile()
    Loads the values of an account profile into internal variables.

+							
load_profile

+				
in file shadowAccount.inc, method shadowAccount::load_profile()
    Loads the values of an account profile into internal variables.

+							
load_profile

+				
in file quota.inc, method quota::load_profile()
    Loads the values of an account profile into internal variables.

+							
load_profile

+				
in file sambaAccount.inc, method sambaAccount::load_profile()
    Loads the values of an account profile into internal variables.

+							
load_profile

+				
in file baseModule.inc, method baseModule::load_profile()
    Loads the values of an account profile into internal variables.

+							
load_profile

+				
in file sambaGroupMapping.inc, method sambaGroupMapping::load_profile()
    Loads the values of an account profile into internal variables.

+							
lshift

+				
in file createntlm.inc, method smbHash::lshift()

+					

+	

+	top

+  

+	
+	

+		
m

+		

+							
$messages

+				
in file baseModule.inc, variable baseModule::$messages
    contains all error messages of a module

+							
$meta

+				
in file baseModule.inc, variable baseModule::$meta
    includes all meta data provided by the sub class

+							
$module

+				
in file modules.inc, variable accountContainer::$module
    This is an array with all module objects

+							
$moduleSettings

+				
in file baseModule.inc, variable baseModule::$moduleSettings
    configuration settings of all modules

+							
modules.inc

+				
procedural page modules.inc

+							
module_complete

+				
in file quota.inc, method quota::module_complete()

+							
module_complete

+				
in file posixGroup.inc, method posixGroup::module_complete()
    This functions is used to check if all settings for this module have been made.

+							
module_complete

+				
in file sambaAccount.inc, method sambaAccount::module_complete()
    This functions returns true if all needed settings are done

+							
module_complete

+				
in file sambaSamAccount.inc, method sambaSamAccount::module_complete()
    This functions is used to check if all settings for this module have been made.

+							
module_complete

+				
in file sambaGroupMapping.inc, method sambaGroupMapping::module_complete()

+							
module_complete

+				
in file posixAccount.inc, method posixAccount::module_complete()
    This functions is used to check if all settings for this module have been made.

+							
module_complete

+				
in file baseModule.inc, method baseModule::module_complete()
    This functions is used to check if all settings for this module have been made.

+							
module_complete

+				
in file inetOrgPerson.inc, method inetOrgPerson::module_complete()
    This functions return true if all needed settings are done.

+							
module_complete

+				
in file account.inc, method account::module_complete()
    This functions returns true if all needed settings are done.

+							
module_complete

+				
in file kolabUser.inc, method kolabUser::module_complete()
    This function returns true if all needed settings are done.

+							
module_ready

+				
in file sambaGroupMapping.inc, method sambaGroupMapping::module_ready()

+							
module_ready

+				
in file baseModule.inc, method baseModule::module_ready()
    This function is used to check if this module page can be displayed.

+							
module_ready

+				
in file sambaAccount.inc, method sambaAccount::module_ready()

+							
module_ready

+				
in file sambaSamAccount.inc, method sambaSamAccount::module_ready()
    This function is used to check if this module page can be displayed.

+							
module_ready

+				
in file quota.inc, method quota::module_ready()

+							
mxor

+				
in file createntlm.inc, method smbHash::mxor()

+					

+	

+	top

+  

+	
+	

+		
n

+		

+							
$name

+				
in file account.inc, variable samba3domain::$name
    Domain name

+							
$nextGroupRID

+				
in file account.inc, variable samba3domain::$nextGroupRID
    Next group RID

+							
$nextRID

+				
in file account.inc, variable samba3domain::$nextRID
    Next RID

+							
$nextUserRID

+				
in file account.inc, variable samba3domain::$nextUserRID
    Next user RID

+							
$noexpire

+				
in file sambaSamAccount.inc, variable sambaSamAccount::$noexpire
    password does not expire?

+							
$noexpire

+				
in file sambaAccount.inc, variable sambaAccount::$noexpire
    password does not expire?

+							
$nopwd

+				
in file sambaSamAccount.inc, variable sambaSamAccount::$nopwd
    use no password?

+							
$nopwd

+				
in file sambaAccount.inc, variable sambaAccount::$nopwd
    use no password?

+							
nisMailAlias.inc

+				
procedural page nisMailAlias.inc

+							
new_account

+				
in file modules.inc, method accountContainer::new_account()
    This function will prepare the object for a new account.

+							
nisMailAlias

+				
in file nisMailAlias.inc, class nisMailAlias
    Provides NIS mail alias management.

+							
nthash

+				
in file createntlm.inc, method smbHash::nthash()
    Calculates the NT hash of a given password.

+					

+	

+	top

+  

+	
+	

+		
o

+		

+							
$order

+				
in file modules.inc, variable accountContainer::$order
    Module order

+							
$orig

+				
in file baseModule.inc, variable baseModule::$orig
    contains all ldap attributes which are loaded from ldap

+					

+	

+	top

+  

+	
+	

+		
p

+		

+							
$perm1

+				
in file createntlm.inc, variable smbHash::$perm1

+							
$perm2

+				
in file createntlm.inc, variable smbHash::$perm2

+							
$perm3

+				
in file createntlm.inc, variable smbHash::$perm3

+							
$perm4

+				
in file createntlm.inc, variable smbHash::$perm4

+							
$perm5

+				
in file createntlm.inc, variable smbHash::$perm5

+							
$perm6

+				
in file createntlm.inc, variable smbHash::$perm6

+							
posixAccount.inc

+				
procedural page posixAccount.inc

+							
posixGroup.inc

+				
procedural page posixGroup.inc

+							
parseHtml

+				
in file modules.inc, function parseHtml()
    Takes a list of meta-HTML elements and prints the equivalent HTML output.

+							
permute

+				
in file createntlm.inc, method smbHash::permute()

+							
posixAccount

+				
in file posixAccount.inc, class posixAccount
    Manages the object class "posixAccount" for users and hosts.

+							
posixGroup

+				
in file posixGroup.inc, class posixGroup
    Manages the object class "posixGroup" for groups.

+							
process_attributes

+				
in file sambaAccount.inc, method sambaAccount::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file quota.inc, method quota::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file ieee802device.inc, method ieee802Device::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file sambaDomain.inc, method sambaDomain::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file sambaGroupMapping.inc, method sambaGroupMapping::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file shadowAccount.inc, method shadowAccount::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file sambaSamAccount.inc, method sambaSamAccount::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file posixAccount.inc, method posixAccount::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file posixGroup.inc, method posixGroup::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file inetOrgPerson.inc, method inetOrgPerson::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file ldapPublicKey.inc, method ldapPublicKey::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file kolabUser.inc, method kolabUser::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file inetLocalMailRecipient.inc, method inetLocalMailRecipient::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file nisMailAlias.inc, method nisMailAlias::process_attributes()
    Processes user input of the primary module page.

+							
process_attributes

+				
in file account.inc, method account::process_attributes()
    Processes user input of the primary module page.

+							
process_deleteUser

+				
in file kolabUser.inc, method kolabUser::process_deleteUser()
    Write variables into object and do some regex checks

+							
process_expire

+				
in file shadowAccount.inc, method shadowAccount::process_expire()
    Processes user input of the expiration page.

+							
process_group

+				
in file posixAccount.inc, method posixAccount::process_group()
    Processes user input of the group selection page.

+							
process_logonHours

+				
in file sambaSamAccount.inc, method sambaSamAccount::process_logonHours()
    Processes user input of the logon hours page.

+							
process_password

+				
in file posixAccount.inc, method posixAccount::process_password()
    Processes user input of the password page.

+							
process_password

+				
in file posixGroup.inc, method posixGroup::process_password()
    Processes user input of the password page.

+							
process_password

+				
in file inetOrgPerson.inc, method inetOrgPerson::process_password()
    Sets a new password.

+							
process_photo

+				
in file inetOrgPerson.inc, method inetOrgPerson::process_photo()
    Sets a new photo.

+							
process_sambaUserWorkstations

+				
in file sambaSamAccount.inc, method sambaSamAccount::process_sambaUserWorkstations()
    Processes user input of the primary module page.

+							
process_time

+				
in file sambaSamAccount.inc, method sambaSamAccount::process_time()
    Processes user input of the time selection page.

+							
process_user

+				
in file posixGroup.inc, method posixGroup::process_user()
    Processes user input of the user selection page.

+							
process_userWorkstations

+				
in file sambaAccount.inc, method sambaAccount::process_userWorkstations()
    Processes user input of the workstation selection page.

+					

+	

+	top

+  

+	
+	

+		
q

+		

+							
$quota

+				
in file quota.inc, variable quota::$quota

+							
quota.inc

+				
procedural page quota.inc

+							
quota

+				
in file quota.inc, class quota
    Manages quotas for users and groups.

+					

+	

+	top

+  

+	
+	

+		
r

+		

+							
$rdn

+				
in file modules.inc, variable accountContainer::$rdn
    RDN attribute of this account

+							
$RIDbase

+				
in file account.inc, variable samba3domain::$RIDbase
    RID base to calculate RIDs, default 1000

+							
$rids

+				
in file sambaSamAccount.inc, variable sambaSamAccount::$rids
    array of well known rids

+							
$rids

+				
in file sambaAccount.inc, variable sambaAccount::$rids
    Array of well known rids

+							
$rids

+				
in file sambaGroupMapping.inc, variable sambaGroupMapping::$rids
    Array of well known RIDs

+					

+	

+	top

+  

+	
+	

+		
s

+		

+							
$sambaGroupTypes

+				
in file sambaGroupMapping.inc, variable sambaGroupMapping::$sambaGroupTypes
    Array of sambaGroupTypes

+							
$sbox

+				
in file createntlm.inc, variable smbHash::$sbox

+							
$sc

+				
in file createntlm.inc, variable smbHash::$sc

+							
$scope

+				
in file baseModule.inc, variable baseModule::$scope
    the account type of this module (user, group, host)

+							
$SID

+				
in file account.inc, variable samba3domain::$SID
    Domain SID

+							
$subpage

+				
in file modules.inc, variable accountContainer::$subpage
    This variable is set to the pagename of a subpage if it should be displayed

+							
sambaAccount.inc

+				
procedural page sambaAccount.inc

+							
sambaDomain.inc

+				
procedural page sambaDomain.inc

+							
sambaGroupMapping.inc

+				
procedural page sambaGroupMapping.inc

+							
sambaSamAccount.inc

+				
procedural page sambaSamAccount.inc

+							
shadowAccount.inc

+				
procedural page shadowAccount.inc

+							
samba3domain

+				
in file account.inc, class samba3domain
    Represents a Samba 3 domain entry

+							
sambaAccount

+				
in file sambaAccount.inc, class sambaAccount
    Manages the object class "sambaAccount" for users and hosts.

+							
sambaAccount

+				
in file sambaAccount.inc, method sambaAccount::sambaAccount()
    Creates a new sambaAccount object.

+							
sambaDomain

+				
in file sambaDomain.inc, class sambaDomain
    Manages Samba 3 domain entries.

+							
sambaGroupMapping

+				
in file sambaGroupMapping.inc, method sambaGroupMapping::sambaGroupMapping()
    Creates a new module for Samba 3 groups.

+							
sambaGroupMapping

+				
in file sambaGroupMapping.inc, class sambaGroupMapping
    Manages the object class "sambaGroupMapping" for groups.

+							
sambaSamAccount

+				
in file sambaSamAccount.inc, class sambaSamAccount
    Manages the object class "sambaSamAccount" for users and hosts.

+							
sambaSamAccount

+				
in file sambaSamAccount.inc, method sambaSamAccount::sambaSamAccount()
    Creates a new sambaSamAccount object.

+							
save_account

+				
in file modules.inc, method accountContainer::save_account()
    This function will save an account to the LDAP database.

+							
save_attributes

+				
in file sambaSamAccount.inc, method sambaSamAccount::save_attributes()

+							
save_attributes

+				
in file sambaGroupMapping.inc, method sambaGroupMapping::save_attributes()

+							
save_attributes

+				
in file shadowAccount.inc, method shadowAccount::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.

+							
save_attributes

+				
in file posixGroup.inc, method posixGroup::save_attributes()

+							
save_attributes

+				
in file baseModule.inc, method baseModule::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.

+							
save_attributes

+				
in file sambaAccount.inc, method sambaAccount::save_attributes()

+							
save_attributes

+				
in file kolabUser.inc, method kolabUser::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.

+							
save_attributes

+				
in file nisMailAlias.inc, method nisMailAlias::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.

+							
save_attributes

+				
in file posixAccount.inc, method posixAccount::save_attributes()
    Returns a list of modifications which have to be made to the LDAP account.

+							
save_attributes

+				
in file quota.inc, method quota::save_attributes()

+							
save_attributes

+				
in file account.inc, method account::save_attributes()

+							
save_attributes

+				
in file inetOrgPerson.inc, method inetOrgPerson::save_attributes()

+							
save_module_attributes

+				
in file modules.inc, method accountContainer::save_module_attributes()
    This function checks which LDAP attributes have changed while the account was edited.

+							
shadowAccount

+				
in file shadowAccount.inc, class shadowAccount
    Manages the object class "shadowAccount" for users.

+							
smbHash

+				
in file createntlm.inc, class smbHash
    Calculates NT and LM hashes.

+							
smb_hash

+				
in file createntlm.inc, method smbHash::smb_hash()

+							
sortModules

+				
in file modules.inc, method accountContainer::sortModules()
    Sorts the module buttons for the account page.

+							
str_to_key

+				
in file createntlm.inc, method smbHash::str_to_key()

+					

+	

+	top

+  

+	
+	

+		
t

+		

+							
$type

+				
in file modules.inc, variable accountContainer::$type
    This variale stores the account type.

+					

+	

+	top

+  

+	
+	

+		
u

+		

+							
$useunixpwd

+				
in file sambaSamAccount.inc, variable sambaSamAccount::$useunixpwd
    use Unix password as samba password?

+							
$useunixpwd

+				
in file sambaAccount.inc, variable sambaAccount::$useunixpwd
    use Unix password as samba password?

+							
unsigned_shift_r

+				
in file createntlm.inc, method smbHash::unsigned_shift_r()
    Unsigned shift operation for 32bit values.

+					

+	

+	top

+  

+	
+	

+		
x

+		

+							
x

+				
in file createntlm.inc, method smbHash::x()
    Fixes too large numbers

+					

+	

+	top

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/elementindex_profiles.html b/lam-web/developers/phpdoc/elementindex_profiles.html
new file mode 100644
index 00000000..988b21ce
--- /dev/null
+++ b/lam-web/developers/phpdoc/elementindex_profiles.html
@@ -0,0 +1,145 @@
+
+
+Package profiles Element Index
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
profiles

+  		  [ class tree: profiles ]
+		  [ index: profiles ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              PDF

+              lists

+              profiles

+              LDAP

+              types

+              lib

+              modules

+              selfService

+              configuration

+              tools

+              Help

+              tests

+              main

+            


+                        Files:

+      	  

+					profiledelete.php
+		

+					profilemain.php
+		

+					profilepage.php
+		

+					profiles.inc
+		

+	  


+      
+      
+                		
+      

+
+
+
Element index for package profiles

+	[ d ]
+	[ g ]
+	[ i ]
+	[ l ]
+	[ p ]
+	[ s ]
+
+  

+	
+	

+		
d

+		

+							
delAccountProfile

+				
in file profiles.inc, function delAccountProfile()
    Deletes an account profile

+					

+	

+	top

+  

+	
+	

+		
g

+		

+							
getAccountProfiles

+				
in file profiles.inc, function getAccountProfiles()
    Returns an array of string with all available profiles for the given account type

+					

+	

+	top

+  

+	
+	

+		
i

+		

+					

+	

+	top

+  

+	
+	

+		
l

+		

+							
loadAccountProfile

+				
in file profiles.inc, function loadAccountProfile()
    Loads an profile of the given account type

+					

+	

+	top

+  

+	
+	

+		
p

+		

+							
profiles.inc

+				
procedural page profiles.inc

+							
profiledelete.php

+				
procedural page profiledelete.php

+							
profilemain.php

+				
procedural page profilemain.php

+							
profilepage.php

+				
procedural page profilepage.php

+					

+	

+	top

+  

+	
+	

+		
s

+		

+							
saveAccountProfile

+				
in file profiles.inc, function saveAccountProfile()
    Saves an hash array (attribute => value) to an account profile

+					

+	

+	top

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/elementindex_selfService.html b/lam-web/developers/phpdoc/elementindex_selfService.html
new file mode 100644
index 00000000..31982732
--- /dev/null
+++ b/lam-web/developers/phpdoc/elementindex_selfService.html
@@ -0,0 +1,205 @@
+
+
+Package selfService Element Index
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
selfService

+  		  [ class tree: selfService ]
+		  [ index: selfService ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              PDF

+              lists

+              profiles

+              LDAP

+              types

+              lib

+              modules

+              selfService

+              configuration

+              tools

+              Help

+              tests

+              main

+            


+                        Files:

+      	  

+					adminLogin.php
+		

+					adminMain.php
+		

+					profManage.php
+		

+					selfService.inc
+		

+					selfServiceLogin.php
+		

+					selfServiceMain.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		selfServiceProfile

+	  

+                		
+      

+
+
+
Element index for package selfService

+	[ a ]
+	[ c ]
+	[ g ]
+	[ i ]
+	[ l ]
+	[ m ]
+	[ p ]
+	[ s ]
+
+  

+	
+	

+		
a

+		

+							
adminLogin.php

+				
procedural page adminLogin.php

+							
adminMain.php

+				
procedural page adminMain.php

+					

+	

+	top

+  

+	
+	

+		
c

+		

+							
checkSelfServiceOptions

+				
in file selfService.inc, function checkSelfServiceOptions()
    Checks if all input values are correct and returns the LDAP commands which should be executed.

+					

+	

+	top

+  

+	
+	

+		
g

+		

+							
getSelfServiceFieldSettings

+				
in file selfService.inc, function getSelfServiceFieldSettings()
    Returns the field settings for the self service.

+							
getSelfServiceOptions

+				
in file selfService.inc, function getSelfServiceOptions()
    Returns meta HTML code for each self service field.

+							
getSelfServiceProfiles

+				
in file selfService.inc, function getSelfServiceProfiles()
    Returns a list of all available self service profiles (without .conf)

+							
getSelfServiceSearchAttributes

+				
in file selfService.inc, function getSelfServiceSearchAttributes()
    Returns a list of possible search attributes for the self service.

+					

+	

+	top

+  

+	
+	

+		
i

+		

+							
$inputFields

+				
in file selfService.inc, variable selfServiceProfile::$inputFields
    input fields

+							
isLAMProVersion

+				
in file selfService.inc, function isLAMProVersion()
    Returns if this is a LAM Pro installation.

+					

+	

+	top

+  

+	
+	

+		
l

+		

+							
$LDAPPassword

+				
in file selfService.inc, variable selfServiceProfile::$LDAPPassword
    LDAP password

+							
$LDAPSuffix

+				
in file selfService.inc, variable selfServiceProfile::$LDAPSuffix
    LDAP suffix

+							
$LDAPUser

+				
in file selfService.inc, variable selfServiceProfile::$LDAPUser
    LDAP user DN

+							
$loginAttributeText

+				
in file selfService.inc, variable selfServiceProfile::$loginAttributeText
    describing text for search attribute

+							
$loginCaption

+				
in file selfService.inc, variable selfServiceProfile::$loginCaption
    describing text for user login

+							
loadSelfServiceProfile

+				
in file selfService.inc, function loadSelfServiceProfile()
    Loads all settings of a self service profile.

+					

+	

+	top

+  

+	
+	

+		
m

+		

+							
$mainPageText

+				
in file selfService.inc, variable selfServiceProfile::$mainPageText
    describing text for self service main page

+					

+	

+	top

+  

+	
+	

+		
p

+		

+							
profManage.php

+				
procedural page profManage.php

+					

+	

+	top

+  

+	
+	

+		
s

+		

+							
$searchAttribute

+				
in file selfService.inc, variable selfServiceProfile::$searchAttribute
    LDAP search attribute

+							
$serverURL

+				
in file selfService.inc, variable selfServiceProfile::$serverURL
    server address

+							
selfService.inc

+				
procedural page selfService.inc

+							
saveSelfServiceProfile

+				
in file selfService.inc, function saveSelfServiceProfile()
    Saves a self service profile.

+							
selfServiceProfile

+				
in file selfService.inc, class selfServiceProfile
    Includes all settings of a self service profile.

+							
selfServiceProfile

+				
in file selfService.inc, method selfServiceProfile::selfServiceProfile()
    Constructor

+							
selfServiceLogin.php

+				
procedural page selfServiceLogin.php

+							
selfServiceMain.php

+				
procedural page selfServiceMain.php

+					

+	

+	top

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/elementindex_tests.html b/lam-web/developers/phpdoc/elementindex_tests.html
new file mode 100644
index 00000000..28b44670
--- /dev/null
+++ b/lam-web/developers/phpdoc/elementindex_tests.html
@@ -0,0 +1,106 @@
+
+
+Package tests Element Index
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
tests

+  		  [ class tree: tests ]
+		  [ index: tests ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              PDF

+              lists

+              profiles

+              LDAP

+              types

+              lib

+              modules

+              selfService

+              configuration

+              tools

+              Help

+              tests

+              main

+            


+                        Files:

+      	  

+					conf-main-test.php
+		

+					conf-test.php
+		

+					status-test.php
+		

+	  


+      
+      
+                		
+      

+
+
+
Element index for package tests

+	[ c ]
+	[ i ]
+	[ s ]
+
+  

+	
+	

+		
c

+		

+							
conf-main-test.php

+				
procedural page conf-main-test.php

+							
conf-test.php

+				
procedural page conf-test.php

+					

+	

+	top

+  

+	
+	

+		
i

+		

+					

+	

+	top

+  

+	
+	

+		
s

+		

+							
status-test.php

+				
procedural page status-test.php

+					

+	

+	top

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/elementindex_tools.html b/lam-web/developers/phpdoc/elementindex_tools.html
new file mode 100644
index 00000000..b1ac1e53
--- /dev/null
+++ b/lam-web/developers/phpdoc/elementindex_tools.html
@@ -0,0 +1,427 @@
+
+
+Package tools Element Index
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
tools

+  		  [ class tree: tools ]
+		  [ index: tools ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              PDF

+              lists

+              profiles

+              LDAP

+              types

+              lib

+              modules

+              selfService

+              configuration

+              tools

+              Help

+              tests

+              main

+            


+                        Files:

+      	  

+					export.inc
+		

+					index.php
+		

+					lamdaemonTest.php
+		

+					massBuildAccounts.php
+		

+					masscreate.php
+		

+					massDoUpload.php
+		

+					ou_edit.php
+		

+					schema.php
+		

+					tools.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LdapExportInfo

+	    		MyCustomExporter

+	    		PlaAbstractExporter

+	    		PlaCSVExporter

+	    		PlaDsmlExporter

+	    		PlaExporter

+	    		PlaLdapExporter

+	    		PlaLdifExporter

+	    		PlaVcardExporter

+	  

+                		
+      

+
+
+
Element index for package tools

+	[ a ]
+	[ b ]
+	[ c ]
+	[ d ]
+	[ e ]
+	[ g ]
+	[ h ]
+	[ i ]
+	[ l ]
+	[ m ]
+	[ n ]
+	[ o ]
+	[ p ]
+	[ q ]
+	[ r ]
+	[ s ]
+	[ t ]
+	[ v ]
+
+  

+	
+	

+		
a

+		

+							
$attributes

+				
in file export.inc, variable PlaLdapExporter::$attributes

+					

+	

+	top

+  

+	
+	

+		
b

+		

+							
$base_dn

+				
in file export.inc, variable LdapExportInfo::$base_dn

+							
$br

+				
in file export.inc, variable PlaExporter::$br

+					

+	

+	top

+  

+	
+	

+		
c

+		

+							
$counter

+				
in file export.inc, variable PlaLdifExporter::$counter

+							
$counter

+				
in file export.inc, variable PlaDsmlExporter::$counter

+					

+	

+	top

+  

+	
+	

+		
d

+		

+							
$deliveryAddress

+				
in file export.inc, variable PlaVcardExporter::$deliveryAddress

+							
displayExportInfo

+				
in file export.inc, method PlaLdifExporter::displayExportInfo()

+							
display_main

+				
in file ou_edit.php, function display_main()

+					

+	

+	top

+  

+	
+	

+		
e

+		

+							
$entry_array

+				
in file export.inc, variable PlaLdapExporter::$entry_array

+							
$entry_id

+				
in file export.inc, variable PlaLdapExporter::$entry_id

+							
$escapeCode

+				
in file export.inc, variable PlaCSVExporter::$escapeCode

+							
$exporter

+				
in file export.inc, variable PlaExporter::$exporter

+							
export

+				
in file export.inc, method PlaLdifExporter::export()
    Export entries to ldif format

+							
export

+				
in file export.inc, method PlaVcardExporter::export()
    When doing an exporter, the method export need to be overriden.

+							
export

+				
in file export.inc, method MyCustomExporter::export()
    When doing an exporter, the method export need to be overriden.

+							
export

+				
in file export.inc, method PlaCSVExporter::export()

+							
export

+				
in file export.inc, method PlaDsmlExporter::export()
    Export the entries to DSML

+							
export

+				
in file export.inc, method PlaExporter::export()
    Abstract method use to export data.

+							
export.inc

+				
procedural page export.inc

+					

+	

+	top

+  

+	
+	

+		
g

+		

+							
get_user_agent_string

+				
in file export.inc, function get_user_agent_string()
    Gets the USER_AGENT string from the $_SERVER array, all in lower case in  an E_NOTICE safe manner.

+					

+	

+	top

+  

+	
+	

+		
h

+		

+							
$hasNext

+				
in file export.inc, variable PlaLdapExporter::$hasNext

+					

+	

+	top

+  

+	
+	

+		
i

+		

+							
$indent_step

+				
in file export.inc, variable PlaDsmlExporter::$indent_step

+							
is_browser_os_mac

+				
in file export.inc, function is_browser_os_mac()
    Determines whether the browser's operating system is Macintosh.

+							
is_browser_os_unix

+				
in file export.inc, function is_browser_os_unix()
    Determines whether the browser's operating system is UNIX (or something like UNIX).

+							
is_browser_os_windows

+				
in file export.inc, function is_browser_os_windows()
    Determines whether the browser's operating system is Windows.

+							
is_safe_ascii

+				
in file export.inc, method PlaExporter::is_safe_ascii()
    Helper method to check if the attribute value should be base 64 encoded.

+							
index.php

+				
procedural page index.php

+					

+	

+	top

+  

+	
+	

+		
l

+		

+							
$ldap_info

+				
in file export.inc, variable PlaLdapExporter::$ldap_info

+							
lamTestLamdaemon

+				
in file lamdaemonTest.php, function lamTestLamdaemon()
    Runs a test case of lamdaemon.

+							
LdapEscape

+				
in file export.inc, method PlaCSVExporter::LdapEscape()

+							
LdapExportInfo

+				
in file export.inc, class LdapExportInfo
    This class encapsulate informations about the ldap server  from which the export is done.

+							
LdapExportInfo

+				
in file export.inc, method LdapExportInfo::LdapExportInfo()
    Create a new LdapExportInfo object

+							
lamdaemonTest.php

+				
procedural page lamdaemonTest.php

+					

+	

+	top

+  

+	
+	

+		
m

+		

+							
$MAX_LDIF_LINE_LENGTH

+				
in file export.inc, variable PlaLdifExporter::$MAX_LDIF_LINE_LENGTH

+							
$multivalue_separator

+				
in file export.inc, variable PlaCSVExporter::$multivalue_separator

+							
multi_lines_display

+				
in file export.inc, method PlaLdifExporter::multi_lines_display()
    Helper method to wrap ldif lines

+							
MyCustomExporter

+				
in file export.inc, class MyCustomExporter

+							
MyCutsomExporter

+				
in file export.inc, method MyCustomExporter::MyCutsomExporter()

+							
massBuildAccounts.php

+				
procedural page massBuildAccounts.php

+							
masscreate.php

+				
procedural page masscreate.php

+							
massDoUpload.php

+				
procedural page massDoUpload.php

+					

+	

+	top

+  

+	
+	

+		
n

+		

+							
$num_entries

+				
in file export.inc, variable PlaLdapExporter::$num_entries

+					

+	

+	top

+  

+	
+	

+		
o

+		

+							
ou_edit.php

+				
procedural page ou_edit.php

+					

+	

+	top

+  

+	
+	

+		
p

+		

+							
PlaAbstractExporter

+				
in file export.inc, class PlaAbstractExporter
    This class represents the base class of all exporters

+							
PlaCSVExporter

+				
in file export.inc, class PlaCSVExporter
    Export to cvs format

+							
PlaCSVExporter

+				
in file export.inc, method PlaCSVExporter::PlaCSVExporter()

+							
PlaDsmlExporter

+				
in file export.inc, method PlaDsmlExporter::PlaDsmlExporter()
    Create a PlaDsmlExporter object

+							
PlaDsmlExporter

+				
in file export.inc, class PlaDsmlExporter
    Export entries to DSML v.1

+							
PlaExporter

+				
in file export.inc, method PlaExporter::PlaExporter()
    Constructor

+							
PlaExporter

+				
in file export.inc, class PlaExporter
    PlaExporter acts a wrapper around another exporter.

+							
PlaLdapExporter

+				
in file export.inc, method PlaLdapExporter::PlaLdapExporter()
    Create a PlaLdapExporter object.

+							
PlaLdapExporter

+				
in file export.inc, class PlaLdapExporter
    Export data from a ldap server

+							
PlaLdifExporter

+				
in file export.inc, class PlaLdifExporter
    Export entries to ldif format

+							
PlaLdifExporter

+				
in file export.inc, method PlaLdifExporter::PlaLdifExporter()
    Create a PlaLdifExporter object

+							
PlaVcardExporter

+				
in file export.inc, class PlaVcardExporter

+							
PlaVcardExporter

+				
in file export.inc, method PlaVcardExporter::PlaVcardExporter()

+							
pla_fetch_entry_array

+				
in file export.inc, method PlaLdapExporter::pla_fetch_entry_array()
    Return the entry as an array

+							
pla_fetch_entry_array

+				
in file export.inc, method PlaAbstractExporter::pla_fetch_entry_array()
    Return the entry as an array

+							
pla_fetch_entry_array

+				
in file export.inc, method PlaExporter::pla_fetch_entry_array()
    Return the entry as an array

+							
pla_fetch_entry_object

+				
in file export.inc, method PlaLdapExporter::pla_fetch_entry_object()
    Return the entry as an Entry object

+							
pla_fetch_entry_object

+				
in file export.inc, method PlaExporter::pla_fetch_entry_object()
    Return the entry as an Entry object

+							
pla_fetch_entry_object

+				
in file export.inc, method PlaAbstractExporter::pla_fetch_entry_object()
    Return the entry as an Entry object

+							
pla_get_ldap_info

+				
in file export.inc, method PlaAbstractExporter::pla_get_ldap_info()
    Return a PlaLdapInfo Object

+							
pla_get_ldap_info

+				
in file export.inc, method PlaLdapExporter::pla_get_ldap_info()
    Return a PlaLdapInfo Object

+							
pla_get_ldap_info

+				
in file export.inc, method PlaExporter::pla_get_ldap_info()
    Return a PlaLdapInfo Object

+							
pla_has_entry

+				
in file export.inc, method PlaAbstractExporter::pla_has_entry()
    Return true if there is some more entries to be processed

+							
pla_has_entry

+				
in file export.inc, method PlaLdapExporter::pla_has_entry()
    Return true if there is some more entries to be processed

+							
pla_has_entry

+				
in file export.inc, method PlaExporter::pla_has_entry()
    Return true if there is some more entries to be processed

+							
pla_num_entries

+				
in file export.inc, method PlaExporter::pla_num_entries()
    Return the number of entries

+							
pla_num_entries

+				
in file export.inc, method PlaLdapExporter::pla_num_entries()
    Return the number of entries

+							
pla_num_entries

+				
in file export.inc, method PlaAbstractExporter::pla_num_entries()
    Return the number of entries

+					

+	

+	top

+  

+	
+	

+		
q

+		

+							
$qualifier

+				
in file export.inc, variable PlaCSVExporter::$qualifier

+							
$queryFilter

+				
in file export.inc, variable PlaLdapExporter::$queryFilter

+							
$query_filter

+				
in file export.inc, variable LdapExportInfo::$query_filter

+					

+	

+	top

+  

+	
+	

+		
r

+		

+							
$results

+				
in file export.inc, variable PlaLdapExporter::$results

+					

+	

+	top

+  

+	
+	

+		
s

+		

+							
$scope

+				
in file export.inc, variable LdapExportInfo::$scope

+							
$scope

+				
in file export.inc, variable PlaLdapExporter::$scope

+							
$separator

+				
in file export.inc, variable PlaCSVExporter::$separator
    When doing an exporter, the method export need to be overriden.

+							
setOutputFormat

+				
in file export.inc, method PlaExporter::setOutputFormat()
    Set the carriage return /linefeed for the export

+							
showColumnData

+				
in file masscreate.php, function showColumnData()
    Prints the properties of one input field.

+							
showMainPage

+				
in file masscreate.php, function showMainPage()
    Displays the acount type specific main page of the upload.

+							
schema.php

+				
procedural page schema.php

+					

+	

+	top

+  

+	
+	

+		
t

+		

+							
tools.php

+				
procedural page tools.php

+					

+	

+	top

+  

+	
+	

+		
v

+		

+							
$vcardMapping

+				
in file export.inc, variable PlaVcardExporter::$vcardMapping

+					

+	

+	top

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/elementindex_types.html b/lam-web/developers/phpdoc/elementindex_types.html
new file mode 100644
index 00000000..1e1bec13
--- /dev/null
+++ b/lam-web/developers/phpdoc/elementindex_types.html
@@ -0,0 +1,260 @@
+
+
+Package types Element Index
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
types

+  		  [ class tree: types ]
+		  [ index: types ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              PDF

+              lists

+              profiles

+              LDAP

+              types

+              lib

+              modules

+              selfService

+              configuration

+              tools

+              Help

+              tests

+              main

+            


+                        Files:

+      	  

+					baseType.inc
+		

+					group.inc
+		

+					host.inc
+		

+					mailAlias.inc
+		

+					smbDomain.inc
+		

+					types.inc
+		

+					user.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		baseType

+	    		group

+	    		host

+	    		mailAlias

+	    		smbDomain

+	    		user

+	  

+                		
+      

+
+
+
Element index for package types

+	[ b ]
+	[ g ]
+	[ h ]
+	[ i ]
+	[ m ]
+	[ s ]
+	[ t ]
+	[ u ]
+
+  

+	
+	

+		
b

+		

+							
baseType

+				
in file baseType.inc, class baseType
    This is the parent class of all account types.

+							
baseType.inc

+				
procedural page baseType.inc

+					

+	

+	top

+  

+	
+	

+		
g

+		

+							
getAlias

+				
in file smbDomain.inc, method smbDomain::getAlias()
    Returns the alias name of this account type.

+							
getAlias

+				
in file baseType.inc, method baseType::getAlias()
    Returns the alias name of this account type.

+							
getAlias

+				
in file host.inc, method host::getAlias()
    Returns the alias name of this account type.

+							
getAlias

+				
in file mailAlias.inc, method mailAlias::getAlias()
    Returns the alias name of this account type.

+							
getAlias

+				
in file group.inc, method group::getAlias()
    Returns the alias name of this account type.

+							
getAlias

+				
in file user.inc, method user::getAlias()
    Returns the alias name of this account type.

+							
getDefaultListAttributes

+				
in file host.inc, method host::getDefaultListAttributes()
    Returns the default attribute list for this account type.

+							
getDefaultListAttributes

+				
in file smbDomain.inc, method smbDomain::getDefaultListAttributes()
    Returns the default attribute list for this account type.

+							
getDefaultListAttributes

+				
in file user.inc, method user::getDefaultListAttributes()
    Returns the default attribute list for this account type.

+							
getDefaultListAttributes

+				
in file types.inc, function getDefaultListAttributes()
    Returns the default attribute list for an account type.

+							
getDefaultListAttributes

+				
in file mailAlias.inc, method mailAlias::getDefaultListAttributes()
    Returns the default attribute list for this account type.

+							
getDefaultListAttributes

+				
in file group.inc, method group::getDefaultListAttributes()
    Returns the default attribute list for this account type.

+							
getDefaultListAttributes

+				
in file baseType.inc, method baseType::getDefaultListAttributes()
    Returns the default attribute list for this account type.

+							
getDescription

+				
in file mailAlias.inc, method mailAlias::getDescription()
    Returns the description of this account type.

+							
getDescription

+				
in file baseType.inc, method baseType::getDescription()
    Returns the description of this account type.

+							
getDescription

+				
in file user.inc, method user::getDescription()
    Returns the description of this account type.

+							
getDescription

+				
in file smbDomain.inc, method smbDomain::getDescription()
    Returns the description of this account type.

+							
getDescription

+				
in file group.inc, method group::getDescription()
    Returns the description of this account type.

+							
getDescription

+				
in file host.inc, method host::getDescription()
    Returns the description of this account type.

+							
getListAttributeDescriptions

+				
in file types.inc, function getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.

+							
getListAttributeDescriptions

+				
in file group.inc, method group::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.

+							
getListAttributeDescriptions

+				
in file user.inc, method user::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.

+							
getListAttributeDescriptions

+				
in file smbDomain.inc, method smbDomain::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.

+							
getListAttributeDescriptions

+				
in file baseType.inc, method baseType::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.

+							
getListAttributeDescriptions

+				
in file host.inc, method host::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.

+							
getListAttributeDescriptions

+				
in file mailAlias.inc, method mailAlias::getListAttributeDescriptions()
    Returns a list of attributes which have a translated description.

+							
getListClassName

+				
in file group.inc, method group::getListClassName()
    Returns the class name for the list object.

+							
getListClassName

+				
in file types.inc, function getListClassName()
    Returns the class name for the list object.

+							
getListClassName

+				
in file user.inc, method user::getListClassName()
    Returns the class name for the list object.

+							
getListClassName

+				
in file baseType.inc, method baseType::getListClassName()
    Returns the class name for the list object.

+							
getListClassName

+				
in file smbDomain.inc, method smbDomain::getListClassName()
    Returns the class name for the list object.

+							
getListClassName

+				
in file host.inc, method host::getListClassName()
    Returns the class name for the list object.

+							
getListClassName

+				
in file mailAlias.inc, method mailAlias::getListClassName()
    Returns the class name for the list object.

+							
getTypeAlias

+				
in file types.inc, function getTypeAlias()
    Returns the alias name of an account type.

+							
getTypeDescription

+				
in file types.inc, function getTypeDescription()
    Returns the description of an account type.

+							
getTypes

+				
in file types.inc, function getTypes()
    Returns a list of available account types.

+							
group

+				
in file group.inc, class group
    The account type for group accounts (e.g. Unix and Samba).

+							
group.inc

+				
procedural page group.inc

+					

+	

+	top

+  

+	
+	

+		
h

+		

+							
host

+				
in file host.inc, class host
    The account type for host accounts (e.g. Samba).

+							
host.inc

+				
procedural page host.inc

+					

+	

+	top

+  

+	
+	

+		
i

+		

+					

+	

+	top

+  

+	
+	

+		
m

+		

+							
mailAlias.inc

+				
procedural page mailAlias.inc

+							
mailAlias

+				
in file mailAlias.inc, class mailAlias
    The account type for mail aliases.

+					

+	

+	top

+  

+	
+	

+		
s

+		

+							
smbDomain.inc

+				
procedural page smbDomain.inc

+							
smbDomain

+				
in file smbDomain.inc, class smbDomain
    The account type for Samba domains.

+					

+	

+	top

+  

+	
+	

+		
t

+		

+							
types.inc

+				
procedural page types.inc

+					

+	

+	top

+  

+	
+	

+		
u

+		

+							
user.inc

+				
procedural page user.inc

+							
user

+				
in file user.inc, class user
    The account type for user accounts (e.g. Unix, Samba and Kolab).

+					

+	

+	top

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/errors.html b/lam-web/developers/phpdoc/errors.html
new file mode 100644
index 00000000..a1b1b073
--- /dev/null
+++ b/lam-web/developers/phpdoc/errors.html
@@ -0,0 +1,60 @@
+
+
+phpDocumentor Parser Errors and Warnings
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
PDF

+  		  [ class tree: PDF ]
+		  [ index: PDF ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                		
+      

+
+Post-parsing

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:13 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/index.html b/lam-web/developers/phpdoc/index.html
new file mode 100644
index 00000000..599dd935
--- /dev/null
+++ b/lam-web/developers/phpdoc/index.html
@@ -0,0 +1,65 @@
+
+
+LDAP Account Manager - Documentation
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
default

+  		  [ class tree: default ]
+		  [ index: default ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                  
+      
+                		
+      

+
+
LDAP Account Manager - Documentation

+Welcome to default!

+

+This documentation was generated by phpDocumentor v1.2.3

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/li_Help.html b/lam-web/developers/phpdoc/li_Help.html
new file mode 100644
index 00000000..fa83ffc9
--- /dev/null
+++ b/lam-web/developers/phpdoc/li_Help.html
@@ -0,0 +1,72 @@
+
+
+LDAP Account Manager - Documentation
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
Help

+  		  [ class tree: Help ]
+		  [ index: Help ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					help.inc
+		

+					help.php
+		

+	  


+      
+      
+                		
+      

+
+
LDAP Account Manager - Documentation

+Welcome to Help!

+

+This documentation was generated by phpDocumentor v1.2.3

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/li_LDAP.html b/lam-web/developers/phpdoc/li_LDAP.html
new file mode 100644
index 00000000..f8b022a7
--- /dev/null
+++ b/lam-web/developers/phpdoc/li_LDAP.html
@@ -0,0 +1,74 @@
+
+
+LDAP Account Manager - Documentation
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
LDAP

+  		  [ class tree: LDAP ]
+		  [ index: LDAP ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					ldap.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		Ldap

+	  

+                		
+      

+
+
LDAP Account Manager - Documentation

+Welcome to LDAP!

+

+This documentation was generated by phpDocumentor v1.2.3

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/li_PDF.html b/lam-web/developers/phpdoc/li_PDF.html
new file mode 100644
index 00000000..12646c26
--- /dev/null
+++ b/lam-web/developers/phpdoc/li_PDF.html
@@ -0,0 +1,99 @@
+
+
+LDAP Account Manager - Documentation
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
PDF

+  		  [ class tree: PDF ]
+		  [ index: PDF ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					fpdf.php
+		

+					pdf.inc
+		

+					pdfdelete.php
+		

+					pdfmain.php
+		

+					pdfpage.php
+		

+					pdfstruct.inc
+		

+					ufpdf.php
+		

+					vera.php
+		

+					verab.php
+		

+					verabi.php
+		

+					verai.php
+		

+					xml_parser.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		FPDF

+	    		lamPDF

+	    		UFPDF

+	    		xmlParser

+	  

+                		
+      

+
+
LDAP Account Manager - Documentation

+Welcome to PDF!

+

+This documentation was generated by phpDocumentor v1.2.3

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/li_configuration.html b/lam-web/developers/phpdoc/li_configuration.html
new file mode 100644
index 00000000..6baaaa11
--- /dev/null
+++ b/lam-web/developers/phpdoc/li_configuration.html
@@ -0,0 +1,91 @@
+
+
+LDAP Account Manager - Documentation
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
configuration

+  		  [ class tree: configuration ]
+		  [ index: configuration ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					config.inc
+		

+					conflogin.php
+		

+					confmain.php
+		

+					confmodules.php
+		

+					conftypes.php
+		

+					index.php
+		

+					mainlogin.php
+		

+					mainmanage.php
+		

+					profmanage.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LAMCfgMain

+	    		LAMConfig

+	  

+                		
+      

+
+
LDAP Account Manager - Documentation

+Welcome to configuration!

+

+This documentation was generated by phpDocumentor v1.2.3

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/li_lib.html b/lam-web/developers/phpdoc/li_lib.html
new file mode 100644
index 00000000..16ee425c
--- /dev/null
+++ b/lam-web/developers/phpdoc/li_lib.html
@@ -0,0 +1,89 @@
+
+
+LDAP Account Manager - Documentation
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lib

+  		  [ class tree: lib ]
+		  [ index: lib ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					cache.inc
+		

+					schema.inc
+		

+					security.inc
+		

+					status.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		AttributeType

+	    		cache

+	    		MatchingRule

+	    		MatchingRuleUse

+	    		ObjectClass

+	    		ObjectClassAttribute

+	    		SchemaItem

+	    		Syntax

+	  

+                		
+      

+
+
LDAP Account Manager - Documentation

+Welcome to lib!

+

+This documentation was generated by phpDocumentor v1.2.3

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/li_lists.html b/lam-web/developers/phpdoc/li_lists.html
new file mode 100644
index 00000000..f1f1d1ec
--- /dev/null
+++ b/lam-web/developers/phpdoc/li_lists.html
@@ -0,0 +1,141 @@
+
+
+LDAP Account Manager - Documentation
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
LDAP Account Manager - Documentation

+Welcome to lists!

+

+This documentation was generated by phpDocumentor v1.2.3

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:33 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/li_main.html b/lam-web/developers/phpdoc/li_main.html
new file mode 100644
index 00000000..347dccea
--- /dev/null
+++ b/lam-web/developers/phpdoc/li_main.html
@@ -0,0 +1,80 @@
+
+
+LDAP Account Manager - Documentation
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
main

+  		  [ class tree: main ]
+		  [ index: main ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					delete.php
+		

+					initsuff.php
+		

+					login.php
+		

+					logout.php
+		

+					main.php
+		

+					main_header.php
+		

+	  


+      
+      
+                		
+      

+
+
LDAP Account Manager - Documentation

+Welcome to main!

+

+This documentation was generated by phpDocumentor v1.2.3

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/li_modules.html b/lam-web/developers/phpdoc/li_modules.html
new file mode 100644
index 00000000..1e7c7434
--- /dev/null
+++ b/lam-web/developers/phpdoc/li_modules.html
@@ -0,0 +1,130 @@
+
+
+LDAP Account Manager - Documentation
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
LDAP Account Manager - Documentation

+Welcome to modules!

+

+This documentation was generated by phpDocumentor v1.2.3

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/li_profiles.html b/lam-web/developers/phpdoc/li_profiles.html
new file mode 100644
index 00000000..0eaf377d
--- /dev/null
+++ b/lam-web/developers/phpdoc/li_profiles.html
@@ -0,0 +1,76 @@
+
+
+LDAP Account Manager - Documentation
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
profiles

+  		  [ class tree: profiles ]
+		  [ index: profiles ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					profiledelete.php
+		

+					profilemain.php
+		

+					profilepage.php
+		

+					profiles.inc
+		

+	  


+      
+      
+                		
+      

+
+
LDAP Account Manager - Documentation

+Welcome to profiles!

+

+This documentation was generated by phpDocumentor v1.2.3

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/li_selfService.html b/lam-web/developers/phpdoc/li_selfService.html
new file mode 100644
index 00000000..5420b765
--- /dev/null
+++ b/lam-web/developers/phpdoc/li_selfService.html
@@ -0,0 +1,84 @@
+
+
+LDAP Account Manager - Documentation
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
selfService

+  		  [ class tree: selfService ]
+		  [ index: selfService ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					adminLogin.php
+		

+					adminMain.php
+		

+					profManage.php
+		

+					selfService.inc
+		

+					selfServiceLogin.php
+		

+					selfServiceMain.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		selfServiceProfile

+	  

+                		
+      

+
+
LDAP Account Manager - Documentation

+Welcome to selfService!

+

+This documentation was generated by phpDocumentor v1.2.3

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/li_tests.html b/lam-web/developers/phpdoc/li_tests.html
new file mode 100644
index 00000000..05c7a71a
--- /dev/null
+++ b/lam-web/developers/phpdoc/li_tests.html
@@ -0,0 +1,74 @@
+
+
+LDAP Account Manager - Documentation
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
tests

+  		  [ class tree: tests ]
+		  [ index: tests ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					conf-main-test.php
+		

+					conf-test.php
+		

+					status-test.php
+		

+	  


+      
+      
+                		
+      

+
+
LDAP Account Manager - Documentation

+Welcome to tests!

+

+This documentation was generated by phpDocumentor v1.2.3

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/li_tools.html b/lam-web/developers/phpdoc/li_tools.html
new file mode 100644
index 00000000..fff7f5e8
--- /dev/null
+++ b/lam-web/developers/phpdoc/li_tools.html
@@ -0,0 +1,98 @@
+
+
+LDAP Account Manager - Documentation
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
tools

+  		  [ class tree: tools ]
+		  [ index: tools ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					export.inc
+		

+					index.php
+		

+					lamdaemonTest.php
+		

+					massBuildAccounts.php
+		

+					masscreate.php
+		

+					massDoUpload.php
+		

+					ou_edit.php
+		

+					schema.php
+		

+					tools.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LdapExportInfo

+	    		MyCustomExporter

+	    		PlaAbstractExporter

+	    		PlaCSVExporter

+	    		PlaDsmlExporter

+	    		PlaExporter

+	    		PlaLdapExporter

+	    		PlaLdifExporter

+	    		PlaVcardExporter

+	  

+                		
+      

+
+
LDAP Account Manager - Documentation

+Welcome to tools!

+

+This documentation was generated by phpDocumentor v1.2.3

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/li_types.html b/lam-web/developers/phpdoc/li_types.html
new file mode 100644
index 00000000..73579e80
--- /dev/null
+++ b/lam-web/developers/phpdoc/li_types.html
@@ -0,0 +1,91 @@
+
+
+LDAP Account Manager - Documentation
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
types

+  		  [ class tree: types ]
+		  [ index: types ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					baseType.inc
+		

+					group.inc
+		

+					host.inc
+		

+					mailAlias.inc
+		

+					smbDomain.inc
+		

+					types.inc
+		

+					user.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		baseType

+	    		group

+	    		host

+	    		mailAlias

+	    		smbDomain

+	    		user

+	  

+                		
+      

+
+
LDAP Account Manager - Documentation

+Welcome to types!

+

+This documentation was generated by phpDocumentor v1.2.3

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lib/AttributeType.html b/lam-web/developers/phpdoc/lib/AttributeType.html
new file mode 100644
index 00000000..3a5242a5
--- /dev/null
+++ b/lam-web/developers/phpdoc/lib/AttributeType.html
@@ -0,0 +1,1253 @@
+
+
+Docs For Class AttributeType
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lib

+  		  [ class tree: lib ]
+		  [ index: lib ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					cache.inc
+		

+					schema.inc
+		

+					security.inc
+		

+					status.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		AttributeType

+	    		cache

+	    		MatchingRule

+	    		MatchingRuleUse

+	    		ObjectClass

+	    		ObjectClassAttribute

+	    		SchemaItem

+	    		Syntax

+	  

+                		
+      

+
+
Class: AttributeType

+Source Location: /lib/schema.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
SchemaItem
+   |
+   --AttributeType


+
Represents an LDAP AttributeType



+
+
+
+
+
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: SchemaItem

+

+

+  SchemaItem::$description
+  
+

+

+   
+

+

+  SchemaItem::$oid
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: SchemaItem

+

+    

+    SchemaItem::SchemaItem()
+
+  

+  

+    Default constructor.
+  

+    

+    SchemaItem::getDescription()
+
+  

+  

+    
+  

+    

+    SchemaItem::getOID()
+
+  

+  

+    
+  

+    

+    SchemaItem::initVars()
+
+  

+  

+    Initialize class members to default values.
+  

+    

+    SchemaItem::setDescription()
+
+  

+  

+    
+  

+    

+    SchemaItem::setOID()
+
+  

+  

+    
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 514]

+Represents an LDAP AttributeType




+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$aliases = 

+	
[line 539]

+  An array of alias attribute names, strings


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$equality = 

+	
[line 523]

+  The equality rule used


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$is_collective = 

+	
[line 533]

+  boolean: is collective?


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$is_no_user_modification = 

+	
[line 535]

+  boolean: can use modify?


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$is_obsolete = 

+	
[line 519]

+  string: the description


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$is_single_value = 

+	
[line 531]

+  boolean: is single valued only?


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$max_length = 

+	
[line 541]

+  The max number of characters this attribute can be


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$name = 

+	
[line 517]

+  The name of this attributeType


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$ordering = 

+	
[line 525]

+  The ordering of the attributeType


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$required_by_object_classes = array()

+	
[line 547]

+  A list of object class names that require this attribute type.


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$sub_str = 

+	
[line 527]

+  Boolean: supports substring matching?


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$sup_attribute = 

+	
[line 521]

+  The attribute from which this attribute inherits (if any)


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$syntax = 

+	
[line 529]

+  The full syntax string, ie 1.2.3.4{16}


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$type = 

+	
[line 543]

+  A string description of the syntax type (taken from the LDAPSyntaxes)


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$usage = 

+	
[line 537]

+  The usage string set by the LDAP schema


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$used_in_object_classes = 

+	
[line 545]

+  An array of objectClasses which use this attributeType (must be set by caller)


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor AttributeType [line 579]

+	

+    

+    

+		AttributeType AttributeType(
+mixed
+$raw_ldap_attr_string)
+    

+    


+	
+		Creates a new AttributeType objcet from a raw LDAP AttributeType string.




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method addAlias [line 878]

+	

+    

+    

+		void addAlias(
+string
+$new_alias_name)
+    

+    


+	
+		Adds an attribute name to the alias array.




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $new_alias_name  The name of a new attribute to add to this attribute's list of aliases.

+    


+        
[ Top ]

+  

+  

+	
+	
method addRequiredByObjectClass [line 948]

+	

+    

+    

+		void addRequiredByObjectClass(
+string
+$object_class_name)
+    

+    


+	
+		Adds an objectClass name to this attribute's list of "required by" objectClasses,  that is the list of objectClasses which must have this attribute.




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $object_class_name  The name of the objectClass to add.

+    


+        
[ Top ]

+  

+  

+	
+	
method addUsedInObjectClass [line 924]

+	

+    

+    

+		void addUsedInObjectClass(
+string
+$object_class_name)
+    

+    


+	
+		Adds an objectClass name to this attribute's list of "used in" objectClasses,  that is the list of objectClasses which provide this attribute.




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $object_class_name  The name of the objectClass to add.

+    


+        
[ Top ]

+  

+  

+	
+	
method getAliases [line 761]

+	

+    

+    

+		array getAliases(
+)
+    

+    


+	
+		Gets the names of attributes that are an alias for this attribute (if any).




+
Tags:

+

+
+  
+    
+  
+
return:  An array of names of attributes which alias this attribute or           an empty array if no attribute aliases this object.

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getEquality [line 733]

+	

+    

+    

+		string getEquality(
+)
+    

+    


+	
+		Gets this attribute's equality string




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getIsCollective [line 833]

+	

+    

+    

+		bool getIsCollective(
+)
+    

+    


+	
+		Gets whether this attribute is collective.




+
Tags:

+

+
+  
+    
+  
+
return:  Returns true if this attribute is collective and false otherwise.

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getIsNoUserModification [line 842]

+	

+    

+    

+		bool getIsNoUserModification(
+)
+    

+    


+	
+		Gets whether this attribute is not modifiable by users.




+
Tags:

+

+
+  
+    
+  
+
return:  Returns true if this attribute is not modifiable by users.

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getIsObsolete [line 705]

+	

+    

+    

+		bool getIsObsolete(
+)
+    

+    


+	
+		Gets whether this attribute has been flagged as obsolete by the LDAP server




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getIsSingleValue [line 815]

+	

+    

+    

+		bool getIsSingleValue(
+)
+    

+    


+	
+		Gets whether this attribute is single-valued. If this attribute only supports single values, true  is returned. If this attribute supports multiple values, false is returned.




+
Tags:

+

+
+  
+    
+  
+
return:  Returns true if this attribute is single-valued or false otherwise.

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getMaxLength [line 805]

+	

+    

+    

+		int getMaxLength(
+)
+    

+    


+	
+		Gets this attribute's the maximum length. If no maximum is defined by the LDAP server, null is returned.




+
Tags:

+

+
+  
+    
+  
+
return:  The maximum length (in characters) of this attribute or null if no maximum is specified.

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getName [line 696]

+	

+    

+    

+		string getName(
+)
+    

+    


+	
+		Gets this attribute's name




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getOrdering [line 742]

+	

+    

+    

+		string getOrdering(
+)
+    

+    


+	
+		Gets this attribute's ordering specification.




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getRequiredByObjectClasses [line 962]

+	

+    

+    

+		array getRequiredByObjectClasses(
+)
+    

+    


+	
+		Gets the list of "required by" objectClasses, that is the list of objectClasses  which provide must have attribute.




+
Tags:

+

+
+  
+    
+  
+
return:  An array of names of objectclasses (strings) which provide this attribute

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getSubstr [line 751]

+	

+    

+    

+		string getSubstr(
+)
+    

+    


+	
+		Gets this attribute's substring matching specification




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getSupAttribute [line 724]

+	

+    

+    

+		string getSupAttribute(
+)
+    

+    


+	
+		Gets this attribute's parent attribute (if any). If this attribute does not  inherit from another attribute, null is returned.




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getSyntaxOID [line 796]

+	

+    

+    

+		string getSyntaxOID(
+)
+    

+    


+	
+		Gets this attribute's syntax OID. Differs from getSyntaxString() in that this  function only returns the actual OID with any length specification removed.

Ie, if the syntax string is "1.2.3.4{16}", this function only retruns  "1.2.3.4".




+
Tags:

+

+
+  
+    
+  
+
return:  The syntax OID string.

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getSyntaxString [line 784]

+	

+    

+    

+		string getSyntaxString(
+)
+    

+    


+	
+		Gets this attribute's raw syntax string (ie: "1.2.3.4{16}").




+
Tags:

+

+
+  
+    
+  
+
return:  The raw syntax string

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getType [line 851]

+	

+    

+    

+		string getType(
+)
+    

+    


+	
+		Gets this attribute's type




+
Tags:

+

+
+  
+    
+  
+
return:  The attribute's type.

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getUsage [line 714]

+	

+    

+    

+		string getUsage(
+)
+    

+    


+	
+		Gets this attribute's usage string as defined by the LDAP server




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getUsedInObjectClasses [line 938]

+	

+    

+    

+		array getUsedInObjectClasses(
+)
+    

+    


+	
+		Gets the list of "used in" objectClasses, that is the list of objectClasses  which provide this attribute.




+
Tags:

+

+
+  
+    
+  
+
return:  An array of names of objectclasses (strings) which provide this attribute

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method initVars [line 552]

+	

+    

+    

+		void initVars(
+)
+    

+    


+	
+		Initialize the class' member variables




+
+	
+Overrides SchemaItem::initVars() (Initialize class members to default values.)


+
+        
[ Top ]

+  

+  

+	
+	
method isAliasFor [line 771]

+	

+    

+    

+		bool isAliasFor(
+string
+$attr_name)
+    

+    


+	
+		Returns whether the specified attribute is an alias for this one (based on this attribute's alias list).




+
Tags:

+

+
+  
+    
+  
+
return:  True if the specified attribute is an alias for this one, or false otherwise.

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $attr_name  The name of the attribute to check.

+    


+        
[ Top ]

+  

+  

+	
+	
method removeAlias [line 862]

+	

+    

+    

+		bool removeAlias(
+string
+$remove_alias_name)
+    

+    


+	
+		Removes an attribute name from this attribute's alias array.




+
Tags:

+

+
+  
+    
+  
+
return:  true on success or false on failure (ie, if the specified            attribute name is not found in this attribute's list of aliases)

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $remove_alias_name  The name of the attribute to remove.

+    


+        
[ Top ]

+  

+  

+	
+	
method setAliases [line 905]

+	

+    

+    

+		void setAliases(
+array
+$new_aliases)
+    

+    


+	
+		Sets this attribute's list of aliases.




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
array  $new_aliases  The array of alias names (strings)

+    


+        
[ Top ]

+  

+  

+	
+	
method setIsSingleValue [line 824]

+	

+    

+    

+		void setIsSingleValue(
+bool
+$is_single_value)
+    

+    


+	
+		Sets whether this attribute is single-valued.




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
bool  $is_single_value  

+    


+        
[ Top ]

+  

+  

+	
+	
method setName [line 887]

+	

+    

+    

+		void setName(
+string
+$new_name)
+    

+    


+	
+		Sets this attriute's name.




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $new_name  The new name to give this attribute.

+    


+        
[ Top ]

+  

+  

+	
+	
method setSupAttribute [line 896]

+	

+    

+    

+		void setSupAttribute(
+string
+$new_sup_attr)
+    

+    


+	
+		Sets this attriute's SUP attribute (ie, the attribute from which this attribute inherits).




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $new_sup_attr  The name of the new parent (SUP) attribute

+    


+        
[ Top ]

+  

+  

+	
+	
method setType [line 914]

+	

+    

+    

+		void setType(
+string
+$new_type)
+    

+    


+	
+		Sets this attribute's type.




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $new_type  The new type.

+    


+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:04 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lib/MatchingRule.html b/lam-web/developers/phpdoc/lib/MatchingRule.html
new file mode 100644
index 00000000..cc4af15d
--- /dev/null
+++ b/lam-web/developers/phpdoc/lib/MatchingRule.html
@@ -0,0 +1,473 @@
+
+
+Docs For Class MatchingRule
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lib

+  		  [ class tree: lib ]
+		  [ index: lib ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					cache.inc
+		

+					schema.inc
+		

+					security.inc
+		

+					status.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		AttributeType

+	    		cache

+	    		MatchingRule

+	    		MatchingRuleUse

+	    		ObjectClass

+	    		ObjectClassAttribute

+	    		SchemaItem

+	    		Syntax

+	  

+                		
+      

+
+
Class: MatchingRule

+Source Location: /lib/schema.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
SchemaItem
+   |
+   --MatchingRule


+
Represents an LDAP MatchingRule



+
+
+
+
+
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: SchemaItem

+

+

+  SchemaItem::$description
+  
+

+

+   
+

+

+  SchemaItem::$oid
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: SchemaItem

+

+    

+    SchemaItem::SchemaItem()
+
+  

+  

+    Default constructor.
+  

+    

+    SchemaItem::getDescription()
+
+  

+  

+    
+  

+    

+    SchemaItem::getOID()
+
+  

+  

+    
+  

+    

+    SchemaItem::initVars()
+
+  

+  

+    Initialize class members to default values.
+  

+    

+    SchemaItem::setDescription()
+
+  

+  

+    
+  

+    

+    SchemaItem::setOID()
+
+  

+  

+    
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 1019]

+Represents an LDAP MatchingRule




+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$is_obsolete = 

+	
[line 1026]

+  Boolean value indicating whether this MatchingRule is obsolete


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$name = 

+	
[line 1022]

+  This rule's name


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$syntax = 

+	
[line 1024]

+  This rule's syntax OID


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$used_by_attrs = 

+	
[line 1028]

+  An array of attribute names who use this MatchingRule


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor MatchingRule [line 1045]

+	

+    

+    

+		MatchingRule MatchingRule(
+mixed
+$raw_ldap_matching_rule_string)
+    

+    


+	
+		Creates a new MatchingRule object from a raw LDAP MatchingRule string.




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method addUsedByAttr [line 1115]

+	

+    

+    

+		true addUsedByAttr(
+mixed
+$new_attr_name)
+    

+    


+	
+		Adds an attribute name to the list of attributes who use this MatchingRule




+
Tags:

+

+
+  
+    
+  
+
return:  if the attribute was added and false otherwise (already in the list)

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getIsObsolete [line 1137]

+	

+    

+    

+		bool getIsObsolete(
+)
+    

+    


+	
+		Gets whether this MatchingRule is flagged as obsolete by the LDAP server.




+
Tags:

+

+
+  
+    
+  
+
return:  True if this MatchingRule is obsolete and false otherwise.

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getName [line 1128]

+	

+    

+    

+		string getName(
+)
+    

+    


+	
+		Gets this MatchingRule's name.




+
Tags:

+

+
+  
+    
+  
+
return:  The name.

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getUsedByAttrs [line 1146]

+	

+    

+    

+		array getUsedByAttrs(
+)
+    

+    


+	
+		Gets an array of attribute names (strings) which use this MatchingRule




+
Tags:

+

+
+  
+    
+  
+
return:  The array of attribute names (strings).

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method initVars [line 1031]

+	

+    

+    

+		void initVars(
+)
+    

+    


+	
+		Initialize the class' member variables




+
+	
+Overrides SchemaItem::initVars() (Initialize class members to default values.)


+
+        
[ Top ]

+  

+  

+	
+	
method setUsedByAttrs [line 1106]

+	

+    

+    

+		void setUsedByAttrs(
+array
+$attrs)
+    

+    


+	
+		Sets the list of used_by_attrs to the array specified by $attrs;




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
array  $attrs  The array of attribute names (strings) which use this MatchingRule

+    


+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:05 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lib/MatchingRuleUse.html b/lam-web/developers/phpdoc/lib/MatchingRuleUse.html
new file mode 100644
index 00000000..4d54aec5
--- /dev/null
+++ b/lam-web/developers/phpdoc/lib/MatchingRuleUse.html
@@ -0,0 +1,354 @@
+
+
+Docs For Class MatchingRuleUse
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lib

+  		  [ class tree: lib ]
+		  [ index: lib ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					cache.inc
+		

+					schema.inc
+		

+					security.inc
+		

+					status.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		AttributeType

+	    		cache

+	    		MatchingRule

+	    		MatchingRuleUse

+	    		ObjectClass

+	    		ObjectClassAttribute

+	    		SchemaItem

+	    		Syntax

+	  

+                		
+      

+
+
Class: MatchingRuleUse

+Source Location: /lib/schema.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
SchemaItem
+   |
+   --MatchingRuleUse


+
Represents an LDAP schema matchingRuleUse entry



+
+
+
+
+
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: SchemaItem

+

+

+  SchemaItem::$description
+  
+

+

+   
+

+

+  SchemaItem::$oid
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: SchemaItem

+

+    

+    SchemaItem::SchemaItem()
+
+  

+  

+    Default constructor.
+  

+    

+    SchemaItem::getDescription()
+
+  

+  

+    
+  

+    

+    SchemaItem::getOID()
+
+  

+  

+    
+  

+    

+    SchemaItem::initVars()
+
+  

+  

+    Initialize class members to default values.
+  

+    

+    SchemaItem::setDescription()
+
+  

+  

+    
+  

+    

+    SchemaItem::setOID()
+
+  

+  

+    
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 1157]

+Represents an LDAP schema matchingRuleUse entry




+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$name = 

+	
[line 1160]

+  The name of the MathingRule this applies to


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$used_by_attrs = 

+	
[line 1163]

+  An array of attributeType names who make use of the mathingRule

identified by $this->oid and $this->name


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor MatchingRuleUse [line 1174]

+	

+    

+    

+		MatchingRuleUse MatchingRuleUse(
+mixed
+$raw_matching_rule_use_string)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getName [line 1239]

+	

+    

+    

+		string getName(
+)
+    

+    


+	
+		Gets this MatchingRuleUse's name




+
Tags:

+

+
+  
+    
+  
+
return:  The name

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getUsedByAttrs [line 1248]

+	

+    

+    

+		array getUsedByAttrs(
+)
+    

+    


+	
+		Gets an array of attribute names (strings) which use this MatchingRuleUse object.




+
Tags:

+

+
+  
+    
+  
+
return:  The array of attribute names (strings).

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method initVars [line 1166]

+	

+    

+    

+		void initVars(
+)
+    

+    


+	
+		Initialize the class' member variables




+
+	
+Overrides SchemaItem::initVars() (Initialize class members to default values.)


+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:05 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lib/ObjectClass.html b/lam-web/developers/phpdoc/lib/ObjectClass.html
new file mode 100644
index 00000000..6f3914ec
--- /dev/null
+++ b/lam-web/developers/phpdoc/lib/ObjectClass.html
@@ -0,0 +1,794 @@
+
+
+Docs For Class ObjectClass
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lib

+  		  [ class tree: lib ]
+		  [ index: lib ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					cache.inc
+		

+					schema.inc
+		

+					security.inc
+		

+					status.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		AttributeType

+	    		cache

+	    		MatchingRule

+	    		MatchingRuleUse

+	    		ObjectClass

+	    		ObjectClassAttribute

+	    		SchemaItem

+	    		Syntax

+	  

+                		
+      

+
+
Class: ObjectClass

+Source Location: /lib/schema.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
SchemaItem
+   |
+   --ObjectClass


+
Represents an LDAP objectClass



+
+
+
+
+
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: SchemaItem

+

+

+  SchemaItem::$description
+  
+

+

+   
+

+

+  SchemaItem::$oid
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: SchemaItem

+

+    

+    SchemaItem::SchemaItem()
+
+  

+  

+    Default constructor.
+  

+    

+    SchemaItem::getDescription()
+
+  

+  

+    
+  

+    

+    SchemaItem::getOID()
+
+  

+  

+    
+  

+    

+    SchemaItem::initVars()
+
+  

+  

+    Initialize class members to default values.
+  

+    

+    SchemaItem::setDescription()
+
+  

+  

+    
+  

+    

+    SchemaItem::setOID()
+
+  

+  

+    
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 91]

+Represents an LDAP objectClass




+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$children_objectclasses = 

+	
[line 106]

+  array of objectClasses which inherit from this one (must be set at runtime explicitly by the caller)


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$is_obsolete = 

+	
[line 104]

+  boolean value indicating whether this objectClass is obsolete


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$may_attrs = 

+	
[line 102]

+  arrays of attribute names that this objectClass allows, but does not require


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$must_attrs = 

+	
[line 100]

+  arrays of attribute names that this objectClass requires


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$name = 

+	
[line 94]

+  This objectClass' name, ie "inetOrgPerson"


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$sup_classes = 

+	
[line 96]

+  array of objectClass names from which this objectClass inherits


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$type = 

+	
[line 98]

+  one of STRUCTURAL, ABSTRACT, or AUXILIARY


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor ObjectClass [line 126]

+	

+    

+    

+		ObjectClass ObjectClass(
+mixed
+$raw_ldap_schema_string)
+    

+    


+	
+		Creates a new ObjectClass object given a raw LDAP objectClass string.




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method addChildObjectClass [line 376]

+	

+    

+    

+		bool addChildObjectClass(
+String
+$object_class_name)
+    

+    


+	
+		Adds an objectClass to the list of objectClasses that inherit  from this objectClass.




+
Tags:

+

+
+  
+    
+  
+
return:  Returns true on success or false on failure (objectclass already existed for example)

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
String  $object_class_name  The name of the objectClass to add

+    


+        
[ Top ]

+  

+  

+	
+	
method addMayAttrs [line 454]

+	

+    

+    

+		void addMayAttrs(
+array
+$new_may_attrs)
+    

+    


+	
+		Behaves identically to addMustAttrs, but it operates on the MAY  attributes of this objectClass.




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
array  $new_may_attrs  An array of attribute names (strings) to add.

+    


+        
[ Top ]

+  

+  

+	
+	
method addMustAttrs [line 439]

+	

+    

+    

+		void addMustAttrs(
+array
+$new_must_attrs)
+    

+    


+	
+		Adds the specified array of attributes to this objectClass' list of  MUST attributes. The resulting array of must attributes will contain  unique members.




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
array  $new_must_attrs  An array of attribute names (strings) to add.

+    


+        
[ Top ]

+  

+  

+	
+	
method getChildObjectClasses [line 392]

+	

+    

+    

+		Array getChildObjectClasses(
+)
+    

+    


+	
+		Returns the array of objectClass names which inherit from this objectClass.




+
Tags:

+

+
+  
+    
+  
+
return:  Names of objectClasses which inherit from this objectClass.

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getIsObsolete [line 427]

+	

+    

+    

+		void getIsObsolete(
+)
+    

+    


+	
+		Gets whether this objectClass is flagged as obsolete by the LDAP server.




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getMayAttrNames [line 361]

+	

+    

+    

+		array getMayAttrNames(
+[array
+$oclasses = null])
+    

+    


+	
+		Gets an array of attribute names (strings) that entries of this ObjectClass must define.

This differs from getMayAttrs in that it returns an array of strings rather than  array of AttributeType objects




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+  
+    
+  
+  
+    
+  
+
return:  The array of allowed attribute names (strings).
see:  ObjectClass::getMustAttrNames()
see:  ObjectClass::getMayAttrs()
see:  ObjectClass::getMustAttrs()

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
array  $oclasses  An array of ObjectClass objects to use when traversing              the inheritance tree. This presents some what of a bootstrapping problem              as we must fetch all objectClasses to determine through inheritance which              attributes this objectClass provides.

+    


+        
[ Top ]

+  

+  

+	
+	
method getMayAttrs [line 303]

+	

+    

+    

+		array getMayAttrs(
+[array
+$oclasses = NULL])
+    

+    


+	
+		Gets an array of AttributeType objects that entries of this ObjectClass may define.

This differs from getMayAttrNames in that it returns an array of AttributeType objects




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+  
+    
+  
+  
+    
+  
+  
+    
+  
+
return:  The array of allowed AttributeType objects.
see:  AttributeType
see:  ObjectClass::getMayAttrNames()
see:  ObjectClass::getMustAttrs()
see:  ObjectClass::getMustAttrNames()

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
array  $oclasses  An array of ObjectClass objects to use when traversing              the inheritance tree. This presents some what of a bootstrapping problem              as we must fetch all objectClasses to determine through inheritance which              attributes this objectClass provides.

+    


+        
[ Top ]

+  

+  

+	
+	
method getMustAttrNames [line 337]

+	

+    

+    

+		array getMustAttrNames(
+[array
+$oclasses = null])
+    

+    


+	
+		Gets an array of attribute names (strings) that entries of this ObjectClass must define.

This differs from getMustAttrs in that it returns an array of strings rather than  array of AttributeType objects




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+  
+    
+  
+  
+    
+  
+
return:  The array of allowed attribute names (strings).
see:  ObjectClass::getMayAttrNames()
see:  ObjectClass::getMayAttrs()
see:  ObjectClass::getMustAttrs()

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
array  $oclasses  An array of ObjectClass objects to use when traversing              the inheritance tree. This presents some what of a bootstrapping problem              as we must fetch all objectClasses to determine through inheritance which              attributes this objectClass provides.

+    


+        
[ Top ]

+  

+  

+	
+	
method getMustAttrs [line 269]

+	

+    

+    

+		array getMustAttrs(
+[array
+$oclasses = NULL])
+    

+    


+	
+		Gets an array of AttributeType objects that entries of this ObjectClass must define.

This differs from getMustAttrNames in that it returns an array of AttributeType objects




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+  
+    
+  
+  
+    
+  
+
return:  The array of required AttributeType objects.
see:  ObjectClass::getMayAttrNames()
see:  ObjectClass::getMayAttrs()
see:  ObjectClass::getMustAttrNames()

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
array  $oclasses  An array of ObjectClass objects to use when traversing              the inheritance tree. This presents some what of a bootstrapping problem              as we must fetch all objectClasses to determine through inheritance which              attributes this objectClass requires.

+    


+        
[ Top ]

+  

+  

+	
+	
method getName [line 401]

+	

+    

+    

+		string getName(
+)
+    

+    


+	
+		Gets the name of this objectClass (ie, "inetOrgPerson")




+
Tags:

+

+
+  
+    
+  
+
return:  The name of the objectClass

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getSupClasses [line 411]

+	

+    

+    

+		array getSupClasses(
+)
+    

+    


+	
+		Gets the objectClass names from which this objectClass inherits.




+
Tags:

+

+
+  
+    
+  
+
return:  An array of objectClass names (strings)

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getType [line 419]

+	

+    

+    

+		void getType(
+)
+    

+    


+	
+		Gets the type of this objectClass: STRUCTURAL, ABSTRACT, or AUXILIARY.




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method initVars [line 109]

+	

+    

+    

+		void initVars(
+)
+    

+    


+	
+		Initialize the class' member variables




+
+	
+Overrides SchemaItem::initVars() (Initialize class members to default values.)


+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:06 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lib/ObjectClassAttribute.html b/lam-web/developers/phpdoc/lib/ObjectClassAttribute.html
new file mode 100644
index 00000000..e9313625
--- /dev/null
+++ b/lam-web/developers/phpdoc/lib/ObjectClassAttribute.html
@@ -0,0 +1,259 @@
+
+
+Docs For Class ObjectClassAttribute
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lib

+  		  [ class tree: lib ]
+		  [ index: lib ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					cache.inc
+		

+					schema.inc
+		

+					security.inc
+		

+					status.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		AttributeType

+	    		cache

+	    		MatchingRule

+	    		MatchingRuleUse

+	    		ObjectClass

+	    		ObjectClassAttribute

+	    		SchemaItem

+	    		Syntax

+	  

+                		
+      

+
+
Class: ObjectClassAttribute

+Source Location: /lib/schema.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+


+
A simple class for representing AttributeTypes used only by the ObjectClass class.



+
+
+
+
+
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+

+

+
+
+
Class Details

+

+[line 476]

+A simple class for representing AttributeTypes used only by the ObjectClass class.

Users should never instantiate this class. It represents an attribute internal to  an ObjectClass. If PHP supported inner-classes and variable permissions, this would  be interior to class ObjectClass and flagged private. The reason this class is used  and not the "real" class AttributeType is because this class supports the notion of  a "source" objectClass, meaning that it keeps track of which objectClass originally  specified it. This class is therefore used by the class ObjectClass to determine  inheritance.




+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$name = 

+	
[line 479]

+  This Attribute's name


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$source = 

+	
[line 481]

+  This Attribute's root


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor ObjectClassAttribute [line 489]

+	

+    

+    

+		ObjectClassAttribute ObjectClassAttribute(
+string
+$name, string
+$source)
+    

+    


+	
+		Creates a new ObjectClassAttribute with specified name and source objectClass.




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
string  $name  the name of the new attribute.
string  $source  the name of the ObjectClass which            specifies this attribute.

+    


+        
[ Top ]

+  

+  

+	
+	
method getName [line 496]

+	

+    

+    

+		void getName(
+)
+    

+    


+	
+		Gets this attribute's name




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getSource [line 502]

+	

+    

+    

+		void getSource(
+)
+    

+    


+	
+		Gets the name of the ObjectClass which originally specified this attribute.




+
+	
+
+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:06 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lib/SchemaItem.html b/lam-web/developers/phpdoc/lib/SchemaItem.html
new file mode 100644
index 00000000..e87472aa
--- /dev/null
+++ b/lam-web/developers/phpdoc/lib/SchemaItem.html
@@ -0,0 +1,348 @@
+
+
+Docs For Class SchemaItem
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lib

+  		  [ class tree: lib ]
+		  [ index: lib ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					cache.inc
+		

+					schema.inc
+		

+					security.inc
+		

+					status.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		AttributeType

+	    		cache

+	    		MatchingRule

+	    		MatchingRuleUse

+	    		ObjectClass

+	    		ObjectClassAttribute

+	    		SchemaItem

+	    		Syntax

+	  

+                		
+      

+
+
Class: SchemaItem

+Source Location: /lib/schema.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+


+
Generic parent class for all schema items. A schema item is  an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.



+
+
+
+
+
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+

+
Child classes:

+

+

+
ObjectClass

+	
Represents an LDAP objectClass

+

+

+
AttributeType

+	
Represents an LDAP AttributeType

+

+

+
Syntax

+	
Represents an LDAP Syntax

+

+

+
MatchingRule

+	
Represents an LDAP MatchingRule

+

+

+
MatchingRuleUse

+	
Represents an LDAP schema matchingRuleUse entry

+

+

+

+

+
+
+
Class Details

+

+[line 45]

+Generic parent class for all schema items. A schema item is  an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.

All schema items have at least two things in common: An OID  and a description. This class provides an implementation for  these two data.




+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$description = 

+	
[line 50]

+  The description of this schema item.


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$oid = 

+	
[line 48]

+  The OID of this schema item.


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor SchemaItem [line 60]

+	

+    

+    

+		SchemaItem SchemaItem(
+)
+    

+    


+	
+		Default constructor.




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getDescription [line 80]

+	

+    

+    

+		void getDescription(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getOID [line 75]

+	

+    

+    

+		void getOID(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method initVars [line 53]

+	

+    

+    

+		void initVars(
+)
+    

+    


+	
+		Initialize class members to default values.




+
+	
Overridden in child classes as:

+		

+	
ObjectClass::initVars()

+		
Initialize the class' member variables

+	

+		

+	
AttributeType::initVars()

+		
Initialize the class' member variables

+	

+		

+	
Syntax::initVars()

+		
Initializes the class' member variables

+	

+		

+	
MatchingRule::initVars()

+		
Initialize the class' member variables

+	

+		

+	
MatchingRuleUse::initVars()

+		
Initialize the class' member variables

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method setDescription [line 70]

+	

+    

+    

+		void setDescription(
+mixed
+$new_desc)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method setOID [line 65]

+	

+    

+    

+		void setOID(
+mixed
+$new_oid)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:06 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lib/Syntax.html b/lam-web/developers/phpdoc/lib/Syntax.html
new file mode 100644
index 00000000..999e6d96
--- /dev/null
+++ b/lam-web/developers/phpdoc/lib/Syntax.html
@@ -0,0 +1,256 @@
+
+
+Docs For Class Syntax
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lib

+  		  [ class tree: lib ]
+		  [ index: lib ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					cache.inc
+		

+					schema.inc
+		

+					security.inc
+		

+					status.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		AttributeType

+	    		cache

+	    		MatchingRule

+	    		MatchingRuleUse

+	    		ObjectClass

+	    		ObjectClassAttribute

+	    		SchemaItem

+	    		Syntax

+	  

+                		
+      

+
+
Class: Syntax

+Source Location: /lib/schema.inc


+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
SchemaItem
+   |
+   --Syntax


+
Represents an LDAP Syntax



+
+
+
+
+
+
+        
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: SchemaItem

+

+

+  SchemaItem::$description
+  
+

+

+   
+

+

+  SchemaItem::$oid
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: SchemaItem

+

+    

+    SchemaItem::SchemaItem()
+
+  

+  

+    Default constructor.
+  

+    

+    SchemaItem::getDescription()
+
+  

+  

+    
+  

+    

+    SchemaItem::getOID()
+
+  

+  

+    
+  

+    

+    SchemaItem::initVars()
+
+  

+  

+    Initialize class members to default values.
+  

+    

+    SchemaItem::setDescription()
+
+  

+  

+    
+  

+    

+    SchemaItem::setOID()
+
+  

+  

+    
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 973]

+Represents an LDAP Syntax




+
[ Top ]


+
+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor Syntax [line 986]

+	

+    

+    

+		Syntax Syntax(
+mixed
+$raw_ldap_syntax_string)
+    

+    


+	
+		Creates a new Syntax object from a raw LDAP syntax string.




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method initVars [line 976]

+	

+    

+    

+		void initVars(
+)
+    

+    


+	
+		Initializes the class' member variables




+
+	
+Overrides SchemaItem::initVars() (Initialize class members to default values.)


+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:06 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lib/_lib_account_inc.html b/lam-web/developers/phpdoc/lib/_lib_account_inc.html
new file mode 100644
index 00000000..75cb80b3
--- /dev/null
+++ b/lam-web/developers/phpdoc/lib/_lib_account_inc.html
@@ -0,0 +1,623 @@
+
+
+Docs for page account.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lib

+  		  [ class tree: lib ]
+		  [ index: lib ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					cache.inc
+		

+					schema.inc
+		

+					security.inc
+		

+					status.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		AttributeType

+	    		cache

+	    		MatchingRule

+	    		MatchingRuleUse

+	    		ObjectClass

+	    		ObjectClassAttribute

+	    		SchemaItem

+	    		Syntax

+	  

+                		
+      

+
+
Procedural File: account.inc

+Source Location: /lib/account.inc


+
+

+

+
+

+
Classes:

+
samba3domain

+	
Represents a Samba 3 domain entry

+



+
+
Page Details:

+This provides several helper function for the account modules.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  Tilo Lutz

+

+


+
Includes:

+

+include_once("createntlm.inc") [line 34]

+Needed to calculate Samba passwords


+


+


+

+  

+	
+	
array_delete [line 71]

+	

+    

+    

+		array array_delete(
+array $values, array $array)
+    

+    


+
+		This function will return all values from $array without values of $values.




+
Tags:

+

+
+  
+    
+  
+
return:  list of remaining values

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
array  $values  list of values which should be removed
array  $array  list of original values

+    	
[ Top ]



+	

+  

+	
+	
cmp_domain [line 421]

+	

+    

+    

+		integer cmp_domain(
+string $a, string $b)
+    

+    


+
+		Helper function to sort the domains




+
Tags:

+

+
+  
+    
+  
+
return:  0 if equal, 1 if $a is greater, -1 if $b is greater

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $a  first argument to compare
string  $b  second argument to compare

+    	
[ Top ]



+	

+  

+	
+	
genpasswd [line 104]

+	

+    

+    

+		string genpasswd(
+)
+    

+    


+
+		This function will return a password with max. 8 characters.




+
Tags:

+

+
+  
+    
+  
+
return:  password

+

+    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
getdays [line 165]

+	

+    

+    

+		number getdays(
+)
+    

+    


+
+		This function will return the days from 1.1.1970 until now.




+
Tags:

+

+
+  
+    
+  
+
return:  of days

+

+    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
getshells [line 42]

+	

+    

+    

+		array getshells(
+)
+    

+    


+
+		Returns a list of shells listed in config/shells.




+
Tags:

+

+
+  
+    
+  
+
return:  list of shell names

+

+    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
get_preg [line 464]

+	

+    

+    

+		boolean get_preg(
+string $argument, string $regexp)
+    

+    


+
+		Checks if a given value matches the selected regular expression.




+
Tags:

+

+
+  
+    
+  
+
return:  true if matches, otherwise false

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $argument  value to check
string  $regexp  pattern name

+    	
[ Top ]



+	

+  

+	
+	
in_array_ignore_case [line 87]

+	

+    

+    

+		void in_array_ignore_case(
+mixed $needle, mixed $haystack)
+    

+    


+
+		Checks if a string exists in an array, ignoring case.

    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
lmPassword [line 200]

+	

+    

+    

+		string lmPassword(
+string $password)
+    

+    


+
+		Generates the LM hash of a password.




+
Tags:

+

+
+  
+    
+  
+
return:  password hash

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $password  password original password

+    	
[ Top ]



+	

+  

+	
+	
ntPassword [line 211]

+	

+    

+    

+		string ntPassword(
+string $password)
+    

+    


+
+		Generates the NT hash of a password.




+
Tags:

+

+
+  
+    
+  
+
return:  password hash

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $password  password original password

+    	
[ Top ]



+	

+  

+	
+	
pwd_disable [line 345]

+	

+    

+    

+		string pwd_disable(
+string $hash)
+    

+    


+
+		Marks an password hash as disabled and returns the new hash string




+
Tags:

+

+
+  
+    
+  
+
return:  disabled hash value

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $hash  hash value to disable

+    	
[ Top ]



+	

+  

+	
+	
pwd_enable [line 320]

+	

+    

+    

+		string pwd_enable(
+string $hash)
+    

+    


+
+		Marks an password hash as enabled and returns the new hash string




+
Tags:

+

+
+  
+    
+  
+
return:  enabled password hash

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $hash  hash value to enable

+    	
[ Top ]



+	

+  

+	
+	
pwd_hash [line 228]

+	

+    

+    

+		string pwd_hash(
+string $password, [boolean $enabled = true], [string $hashType = 'SSHA'])
+    

+    


+
+		Returns the hash value of a plain text password  the hash algorithm depends on the configuration file




+
Tags:

+

+
+  
+    
+  
+
return:  the password hash

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $password  the password string
boolean  $enabled  marks the hash as enabled/disabled (e.g. by prefixing "!")
string  $hashType  password hash type (CRYPT, SHA, SSHA, MD5, SMD5, PLAIN)

+    	
[ Top ]



+	

+  

+	
+	
pwd_is_enabled [line 370]

+	

+    

+    

+		boolean pwd_is_enabled(
+string $hash)
+    

+    


+
+		Checks if a password hash is enabled/disabled




+
Tags:

+

+
+  
+    
+  
+
return:  true if the password is marked as enabled

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $hash  password hash to check

+    	
[ Top ]



+	

+  

+	
+	
RndInt [line 142]

+	

+    

+    

+		integer RndInt(
+string $Format)
+    

+    


+
+		THIS FUNCTION GENERATES A RANDOM NUMBER THAT WILL BE USED TO  RANDOMLY SELECT CHARACTERS.




+
Tags:

+

+
+  
+    
+  
+
return:  random number

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $Format  "letter" or "number"

+    	
[ Top ]



+	

+  

+	
+	
search_domains [line 387]

+	

+    

+    

+		array search_domains(
+)
+    

+    


+
+		Returns an array with all Samba 3 domain entries under the given suffix




+
Tags:

+

+
+  
+    
+  
+
return:  list of samba3domain objects

+

+    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
smbflag [line 177]

+	

+    

+    

+		string smbflag(
+array $input)
+    

+    


+
+		Takes a list of Samba flags and creates the corresponding flag string.




+
Tags:

+

+
+  
+    
+  
+
return:  Samba flag string

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
array  $input  is an array of Samba flags (e.g. X or D)

+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:35 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lib/_lib_cache_inc.html b/lam-web/developers/phpdoc/lib/_lib_cache_inc.html
new file mode 100644
index 00000000..c506e858
--- /dev/null
+++ b/lam-web/developers/phpdoc/lib/_lib_cache_inc.html
@@ -0,0 +1,116 @@
+
+
+Docs for page cache.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lib

+  		  [ class tree: lib ]
+		  [ index: lib ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					cache.inc
+		

+					schema.inc
+		

+					security.inc
+		

+					status.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		AttributeType

+	    		cache

+	    		MatchingRule

+	    		MatchingRuleUse

+	    		ObjectClass

+	    		ObjectClassAttribute

+	    		SchemaItem

+	    		Syntax

+	  

+                		
+      

+
+
Procedural File: cache.inc

+Source Location: /lib/cache.inc


+
+

+

+
+

+
Classes:

+
cache

+	
This class contains all functions which are needed to manage the LDAP cache.

+



+
+
Page Details:

+Provides a cache for LDAP attributes.




+
Tags:

+

+
+  
+    
+  
+
author:  Tilo Lutz

+

+


+
Includes:

+

+include_once('ldap.inc') [line 32]

+en/decryption functions


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:38 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lib/_lib_schema_inc.html b/lam-web/developers/phpdoc/lib/_lib_schema_inc.html
new file mode 100644
index 00000000..fd9dfa45
--- /dev/null
+++ b/lam-web/developers/phpdoc/lib/_lib_schema_inc.html
@@ -0,0 +1,505 @@
+
+
+Docs for page schema.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lib

+  		  [ class tree: lib ]
+		  [ index: lib ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					cache.inc
+		

+					schema.inc
+		

+					security.inc
+		

+					status.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		AttributeType

+	    		cache

+	    		MatchingRule

+	    		MatchingRuleUse

+	    		ObjectClass

+	    		ObjectClassAttribute

+	    		SchemaItem

+	    		Syntax

+	  

+                		
+      

+
+
Procedural File: schema.inc

+Source Location: /lib/schema.inc


+
+

+

+
+

+
Classes:

+
SchemaItem

+	
Generic parent class for all schema items. A schema item is  an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax.

+
ObjectClass

+	
Represents an LDAP objectClass

+
ObjectClassAttribute

+	
A simple class for representing AttributeTypes used only by the ObjectClass class.

+
AttributeType

+	
Represents an LDAP AttributeType

+
Syntax

+	
Represents an LDAP Syntax

+
MatchingRule

+	
Represents an LDAP MatchingRule

+
MatchingRuleUse

+	
Represents an LDAP schema matchingRuleUse entry

+



+
+
Page Details:

+Classes and functions for fetching and parsing schema from an LDAP server.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  The phpLDAPadmin development team

+

+


+


+


+  

+	
+	
SCHEMA_SESSION_CACHE_ENABLED [line 34]

+	

+    

+    

+		SCHEMA_SESSION_CACHE_ENABLED = 1
+    

+    

+
+    To enable/disable session-based schema caching (1: enabled, 0: disabled).

    

+	
+	

+	
[ Top ]



+

+  

+	
+	
add_aliases_to_attrs [line 1701]

+	

+    

+    

+		void add_aliases_to_attrs(
+mixed &$attrs)
+    

+    


+
+		For each attribute that has multiple names, this function adds unique entries to  the attrs array for those names. Ie, attributeType has name 'gn' and 'givenName'.

This function will create a unique entry for 'gn' and 'givenName'.

    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
add_sup_to_attrs [line 1726]

+	

+    

+    

+		void add_sup_to_attrs(
+mixed &$attrs, mixed &$attrs_oid)
+    

+    


+
+		Adds inherited values to each attributeType specified by the SUP directive.

Supports infinite levels of inheritance.  Bug 856832: require a second paramter that has all attributes indexed by OID

    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
cached_schema_available [line 1933]

+	

+    

+    

+		void cached_schema_available(
+mixed $schema_type)
+    

+    


+
+		Returns true if the schema for $schema_type has been cached and

is availble. $schema_type may be one of (lowercase) the following:       objectclasses       attributetypes       ldapsyntaxes       matchingrules       matchingruleuse  Note that _get_raw_schema() takes a similar parameter.

    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
get_cached_schema [line 1970]

+	

+    

+    

+		void get_cached_schema(
+mixed $schema_type)
+    

+    


+
+		Returns the cached array of schemaitem objects for the specified

$schema_type. For list of valid $schema_type values, see above  schema_cache_available(). Note that internally, this function  utilizes a two-layer cache, one in memory using a static variable  for multiple calls within the same page load, and one in a session  for multiple calls within the same user session (spanning multiple  page loads).
Returns an array of SchemaItem objects on success or false on failure.

    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
get_schema_attribute [line 1588]

+	

+    

+    

+		AttributeType get_schema_attribute(
+mixed $attr_name, [string $dn = null], [mixed $use_cache = true], string $oclass_name)
+    

+    


+
+		Gets a single AttributeType object specified by name.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+  
+    
+  
+
return:  The specified AttributeType object or false on error.
see:  get_schema_attributes()
see:  AttributeType

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $oclass_name  The name of the AttributeType to fetch.
string  $dn  (optional) It is easier to fetch schema if a DN is provided              which defines the subschemaSubEntry attribute (all entries should).

+    	
[ Top ]



+	

+  

+	
+	
get_schema_attributes [line 1609]

+	

+    

+    

+		array get_schema_attributes(
+[string $dn = null], [mixed $use_cache = true])
+    

+    


+
+		Gets an associative array of AttributeType objects for the specified  server. Each array entry's key is the name of the attributeType  in lower-case and the value is an AttributeType object.




+
Tags:

+

+
+  
+    
+  
+
return:  An array of AttributeType objects.

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $dn  (optional) It is easier to fetch schema if a DN is provided              which defines the subschemaSubEntry attribute (all entries should).

+    	
[ Top ]



+	

+  

+	
+	
get_schema_matching_rules [line 1838]

+	

+    

+    

+		void get_schema_matching_rules(
+[mixed $dn = null], [mixed $use_cache = true])
+    

+    


+
+		Returns an array of MatchingRule objects for the specified server.

The key of each entry is the OID of the matching rule.

    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
get_schema_objectclass [line 1564]

+	

+    

+    

+		ObjectClass get_schema_objectclass(
+string $oclass_name, [string $dn = null], [mixed $use_cache = true])
+    

+    


+
+		Gets a single ObjectClass object specified by name.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+  
+    
+  
+
return:  The specified ObjectClass object or false on error.
see:  get_schema_objectclasses()
see:  ObjectClass

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $oclass_name  The name of the objectClass to fetch.
string  $dn  (optional) It is easier to fetch schema if a DN is provided              which defines the subschemaSubEntry attribute (all entries should).

+    	
[ Top ]



+	

+  

+	
+	
get_schema_objectclasses [line 1524]

+	

+    

+    

+		array get_schema_objectclasses(
+[string $dn = null], [mixed $use_cache = true])
+    

+    


+
+		Gets an associative array of ObjectClass objects for the specified  server. Each array entry's key is the name of the objectClass  in lower-case and the value is an ObjectClass object.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+  
+    
+  
+
return:  An array of ObjectClass objects.
see:  get_schema_objectclass()
see:  ObjectClass

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $dn  (optional) It is easier to fetch schema if a DN is provided              which defines the subschemaSubEntry attribute (all entries should).

+    	
[ Top ]



+	

+  

+	
+	
get_schema_syntaxes [line 1892]

+	

+    

+    

+		void get_schema_syntaxes(
+[mixed $dn = null], [mixed $use_cache = true])
+    

+    


+
+		Returns an array of Syntax objects that this LDAP server uses mapped to  their descriptions. The key of each entry is the OID of the Syntax.

    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
set_cached_schema [line 2001]

+	

+    

+    

+		void set_cached_schema(
+mixed $schema_type, mixed $schema_items)
+    

+    


+
+		Caches the specified $schema_type.

$schema_items should be an array of SchemaItem instances (ie,  an array of ObjectClass, AttributeType, LDAPSyntax, MatchingRuleUse,  or MatchingRule objects.
Returns true on success of false on failure.

    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
set_schema_cache_unavailable [line 2030]

+	

+    

+    

+		void set_schema_cache_unavailable(
+)
+    

+    


+
+		Sets the schema entry for the server_id to be "unavailable" so that we realize  that we tried to get the schema but could not, so quit trying next time to  fetch it from the server.

    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
_get_raw_schema [line 1334]

+	

+    

+    

+		an _get_raw_schema(
+$schema_to_fetch $schema_to_fetch, [$dn $dn = ''])
+    

+    


+
+		Fetches the raw schema array for the subschemaSubentry of the server. Note,  this function has grown many hairs to accomodate more LDAP servers. It is  needfully complicated as it now supports many popular LDAP servers that  don't necessarily expose their schema "the right way".




+
Tags:

+

+
+  
+    
+  
+
return:  array of strings of this form:     Array (       [0] => "( 1.3.6.1.4.1.7165.1.2.2.4 NAME 'gidPool' DESC 'Pool ...       [1] => "( 1.3.6.1.4.1.7165.2.2.3 NAME 'sambaAccount' DESC 'Sa ...       etc.

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
$schema_to_fetch  $schema_to_fetch  - A string indicating which type of schema to         fetch. Five valid values: 'objectclasses', 'attributetypes',         'ldapsyntaxes', 'matchingruleuse', or 'matchingrules'.         Case insensitive.
$dn  $dn  (optional) This paremeter is the DN of the entry whose schema you          would like to fetch. Entries have the option of specifying          their own subschemaSubentry that points to the DN of the system          schema entry which applies to this attribute. If unspecified,         this will try to retrieve the schema from the RootDSE subschemaSubentry.         Failing that, we use some commonly known schema DNs. Default         value is the Root DSE DN (zero-length string)

+    	
[ Top ]



+	

+  

+	
+	
_get_schema_dn [line 1267]

+	

+    

+    

+		string _get_schema_dn(
+string $dn, [bool $debug = false])
+    

+    


+
+		Helper for _get_raw_schema() which fetches the DN of the schema object

in an LDAP server based on a DN. Entries should set the subSchemaSubEntry  attribute pointing to the DN of the server schema. You can specify  the  DN whose subSchemaSubEntry you wish to retrieve of specify an empty string  to fetch the subScehamSubEntry from the Root DSE.




+
Tags:

+

+
+  
+    
+  
+
return:  The DN of the entry which houses this LDAP server's schema.

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $dn  The DN (may be null) which houses the subschemaSubEntry attribute which                   this function can use to determine the schema entry's DN.
bool  $debug  Switch to true to see some nice and copious output. :)

+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:04 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lib/_lib_security_inc.html b/lam-web/developers/phpdoc/lib/_lib_security_inc.html
new file mode 100644
index 00000000..2b844416
--- /dev/null
+++ b/lam-web/developers/phpdoc/lib/_lib_security_inc.html
@@ -0,0 +1,189 @@
+
+
+Docs for page security.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lib

+  		  [ class tree: lib ]
+		  [ index: lib ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					cache.inc
+		

+					schema.inc
+		

+					security.inc
+		

+					status.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		AttributeType

+	    		cache

+	    		MatchingRule

+	    		MatchingRuleUse

+	    		ObjectClass

+	    		ObjectClassAttribute

+	    		SchemaItem

+	    		Syntax

+	  

+                		
+      

+
+
Procedural File: security.inc

+Source Location: /lib/security.inc


+
+

+

+
+
+
Page Details:

+This file includes functions to perform several security checks on each page load.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once('ldap.inc') [line 34]

+ldap connection

include_once('config.inc') [line 32]

+configuration options


+


+


+

+  

+	
+	
checkClientIP [line 77]

+	

+    

+    

+		void checkClientIP(
+)
+    

+    


+
+		Checks if the client's IP address is on the list of allowed IPs.

The script is stopped if the host is not valid.

    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
logNewMessage [line 151]

+	

+    

+    

+		void logNewMessage(
+string $level, string $message)
+    

+    


+
+		Puts a new message in the log file.

    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $level  log level (LOG_NOTICE, LOG_WARNING, LOG_ERR)
string  $message  log message

+    	
[ Top ]



+	

+  

+	
+	
logoffAndBackToLoginPage [line 104]

+	

+    

+    

+		void logoffAndBackToLoginPage(
+)
+    

+    


+
+		Logs off the user and displays the login page.

    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
startSecureSession [line 43]

+	

+    

+    

+		void startSecureSession(
+)
+    

+    


+
+		Starts a session and checks the environment.

The script is stopped if one of the checks fail.

    


+	
+
+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:07 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lib/_lib_status_inc.html b/lam-web/developers/phpdoc/lib/_lib_status_inc.html
new file mode 100644
index 00000000..26d822e4
--- /dev/null
+++ b/lam-web/developers/phpdoc/lib/_lib_status_inc.html
@@ -0,0 +1,146 @@
+
+
+Docs for page status.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lib

+  		  [ class tree: lib ]
+		  [ index: lib ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					cache.inc
+		

+					schema.inc
+		

+					security.inc
+		

+					status.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		AttributeType

+	    		cache

+	    		MatchingRule

+	    		MatchingRuleUse

+	    		ObjectClass

+	    		ObjectClassAttribute

+	    		SchemaItem

+	    		Syntax

+	  

+                		
+      

+
+
Procedural File: status.inc

+Source Location: /lib/status.inc


+
+

+

+
+
+
Page Details:

+LDAP Account Manager status messages.




+
Tags:

+

+
+  
+    
+  
+
author:  Michael Duergner

+

+


+


+


+

+  

+	
+	
StatusMessage [line 50]

+	

+    

+    

+		void StatusMessage(
+string $MessageTyp, string $MessageHeadline, [string $MessageText = ''], [array $MessageVariables = array()])
+    

+    


+
+		This function prints a short status message. It can be used to print INFO,  WARN and ERROR messages at the moment.

The headline and text may be formated with special tags:  
  
{bold}, {endbold}: All text between these tags is printed bold.  
{color=#123456}, {endcolor}: All text between these tags is printed in the given color.  
{link=http://nodomain.org}, {endlink}: A link with the given target is created. The link text is the text between the tags.

    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $MessageTyp  The type of the message to be printed. It must be one of  the following types: 'INFO', 'WARN' or 'ERROR'.  
 Every other type will lead to an error message indicating an invalid message type.
string  $MessageHeadline  The headline of the status message.  
 It may be formatted with special color/link/bold tags.
string  $MessageText  The text of the status message.  
 It may be formatted with special color/link/bold tags. This parameter is optional.
array  $MessageVariables  The variables that are used to replace the spacers (%s) in the  submitted text. This parameter is optional.

+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:09 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lib/cache.html b/lam-web/developers/phpdoc/lib/cache.html
new file mode 100644
index 00000000..c6a60664
--- /dev/null
+++ b/lam-web/developers/phpdoc/lib/cache.html
@@ -0,0 +1,535 @@
+
+
+Docs For Class cache
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lib

+  		  [ class tree: lib ]
+		  [ index: lib ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					cache.inc
+		

+					schema.inc
+		

+					security.inc
+		

+					status.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		AttributeType

+	    		cache

+	    		MatchingRule

+	    		MatchingRuleUse

+	    		ObjectClass

+	    		ObjectClassAttribute

+	    		SchemaItem

+	    		Syntax

+	  

+                		
+      

+
+
Class: cache

+Source Location: /lib/cache.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+


+
This class contains all functions which are needed to manage the LDAP cache.



+
+
+
+
+
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+

+

+
+
+
Class Details

+

+[line 40]

+This class contains all functions which are needed to manage the LDAP cache.




+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$attributes = 

+	
[line 45]

+  This variable contains a list and their scope of attributes which should be cached


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$ldapcache = 

+	
[line 43]

+  This variable contains the cache


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$time = 

+	
[line 47]

+  This is the last timestamp on which the LDAP cache has been refreshed


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor cache [line 54]

+	

+    

+    

+		cache cache(
+)
+    

+    


+	
+		Constructor.




+
Tags:

+

+
+  
+    
+  
+
return:  cache object

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method add_cache [line 64]

+	

+    

+    

+		void add_cache(
+array
+$attributes)
+    

+    


+	
+		This function adds attributes to the cache.




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
array  $attributes  syntax: is array( scope1 => array ( attributes ), scope2 => array ( attributes ), ...)

+    


+        
[ Top ]

+  

+  

+	
+	
method findgroups [line 236]

+	

+    

+    

+		array findgroups(
+)
+    

+    


+	
+		This function returns an array with all group names which were found in the LDAP directory.




+
Tags:

+

+
+  
+    
+  
+
return:  group names

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getgid [line 218]

+	

+    

+    

+		string getgid(
+string
+$groupname)
+    

+    


+	
+		This function will return the GID number to an existing group name (using the cache).




+
Tags:

+

+
+  
+    
+  
+
return:  GID number

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $groupname  name of group

+    


+        
[ Top ]

+  

+  

+	
+	
method getgrnam [line 254]

+	

+    

+    

+		group getgrnam(
+string
+$gidNumber)
+    

+    


+	
+		This function returns the group name to an existing gidNumber.




+
Tags:

+

+
+  
+    
+  
+
return:  name

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $gidNumber  GID number

+    


+        
[ Top ]

+  

+  

+	
+	
method get_cache [line 93]

+	

+    

+    

+		array get_cache(
+mixed
+$attributes, string
+$objectClass, mixed
+$scopelist)
+    

+    


+	
+		Queries the cache for a list of LDAP entries and their attributes.




+
Tags:

+

+
+  
+    
+  
+
return:  The found LDAP entries.  
Format: array(dn1 => array(uidnumber1), dn2 => array(uidnumber2), ... ) if $attributes is of type string  
or array(dn1 => array(uid => array(myuid), uidNumber => array(1234)), ... ) if $attributes is an array

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
mixed  $attributes  One (string) or many (array) attribute names.
string  $objectClass  The resulting entries need to contain this object class.
mixed  $scopelist  the account type(s) as string or array, all scopes if NULL given

+    


+        
[ Top ]

+  

+  

+	
+	
method in_cache [line 138]

+	

+    

+    

+		void in_cache(
+string
+$value, string
+$attribute, mixed
+$scopelist)
+    

+    


+	
+		This function returns the DN if an LDAP entry with $attribute=$value is found.




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
string  $value  is the searched value of the attribute $attribute
string  $attribute  name of the LDAP attribute
mixed  $scopelist  the account type(s) as string or array, all scopes if NULL given

+    


+        
[ Top ]

+  

+  

+	
+	
method refresh_cache [line 173]

+	

+    

+    

+		void refresh_cache(
+[boolean
+$rebuild = false])
+    

+    


+	
+		This function refreshes the cache.




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
boolean  $rebuild  forces a refresh if set to true

+    


+        
[ Top ]

+  

+  

+	
+	
method __sleep [line 272]

+	

+    

+    

+		array __sleep(
+)
+    

+    


+	
+		Encrypts LDAP cache before saving to session file.




+
Tags:

+

+
+  
+    
+  
+
return:  list of variables to save

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method __wakeup [line 281]

+	

+    

+    

+		void __wakeup(
+)
+    

+    


+	
+		Decrypts LDAP cache after loading from session file.




+
+	
+
+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:38 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/_lib_lists_inc.html b/lam-web/developers/phpdoc/lists/_lib_lists_inc.html
new file mode 100644
index 00000000..7bb76611
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/_lib_lists_inc.html
@@ -0,0 +1,170 @@
+
+
+Docs for page lists.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: lists.inc

+Source Location: /lib/lists.inc


+
+

+

+
+

+
Classes:

+
lamList

+	
Generates the list view.

+



+
+
Page Details:

+This file includes functions to manage the list views.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once("types.inc") [line 33]

+Used to get type information.

include_once("pdfstruct.inc") [line 35]

+Used to get PDF information.

include_once("pdf.inc") [line 37]

+Used to create PDF files.


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:51 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/_templates_lists_list_php.html b/lam-web/developers/phpdoc/lists/_templates_lists_list_php.html
new file mode 100644
index 00000000..cb049685
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/_templates_lists_list_php.html
@@ -0,0 +1,165 @@
+
+
+Docs for page list.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: list.php

+Source Location: /templates/lists/list.php


+
+

+

+
+
+
Page Details:

+This file shows the list views.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once("../../lib/security.inc") [line 33]

+security functions

include_once("../../lib/types.inc") [line 35]

+Used to get type information.

include_once("../../lib/config.inc") [line 37]

+Access to configuration options


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:51 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/_templates_lists_userlink_php.html b/lam-web/developers/phpdoc/lists/_templates_lists_userlink_php.html
new file mode 100644
index 00000000..70b6e83e
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/_templates_lists_userlink_php.html
@@ -0,0 +1,198 @@
+
+
+Docs for page userlink.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: userlink.php

+Source Location: /templates/lists/userlink.php


+
+

+

+
+
+
Page Details:

+This page will redirect to account/edit.php if the given user is valid.

It is called from listgroups.php via the memberUID links.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once("../../lib/security.inc") [line 34]

+security functions

include_once("../../lib/ldap.inc") [line 36]

+Needed to find DNs of users

include_once("../../lib/status.inc") [line 38]

+Used to display error messages


+


+


+

+  

+	
+	
search_username [line 77]

+	

+    

+    

+		string search_username(
+string $name)
+    

+    


+
+		Searches LDAP for a specific user name (uid attribute) and returns its DN entry




+
Tags:

+

+
+  
+    
+  
+
return:  DN

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $name  user name

+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:13 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/lamGroupList.html b/lam-web/developers/phpdoc/lists/lamGroupList.html
new file mode 100644
index 00000000..b2977cae
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/lamGroupList.html
@@ -0,0 +1,498 @@
+
+
+Docs For Class lamGroupList
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Class: lamGroupList

+Source Location: /lib/types/group.inc


+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
lamList
+   |
+   --lamGroupList


+
Generates the list view.



+
Author(s):

+
    
+          
  • Roland Gruber
    • 
+      

+
+
+
+
+    
+
+        
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: lamList

+

+

+  lamList::$attrArray
+  
+

+

+   
+

+

+  lamList::$descArray
+  
+

+

+   
+

+

+  lamList::$entries
+  
+

+

+   
+

+

+  lamList::$filterText
+  
+

+

+   
+

+

+  lamList::$labels
+  
+

+

+   
+

+

+  lamList::$maxPageEntries
+  
+

+

+   
+

+

+  lamList::$page
+  
+

+

+   
+

+

+  lamList::$possibleSuffixes
+  
+

+

+   
+

+

+  lamList::$refresh
+  
+

+

+   
+

+

+  lamList::$sortColumn
+  
+

+

+   
+

+

+  lamList::$suffix
+  
+

+

+   
+

+

+  lamList::$type
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: lamList

+

+    

+    lamList::lamList()
+
+  

+  

+    Constructor
+  

+    

+    lamList::cmp_array()
+
+  

+  

+    Compare function used for usort-method
+  

+    

+    lamList::listBuildFilter()
+
+  

+  

+    Builds the regular expressions from the filter values.
+  

+    

+    lamList::listDoPost()
+
+  

+  

+    Manages all POST actions (e.g. button pressed) for the account lists.
+  

+    

+    lamList::listDrawNavigationBar()
+
+  

+  

+    Draws a navigation bar to switch between pages
+  

+    

+    lamList::listFilterAccounts()
+
+  

+  

+    Removes all entries which do not fit to the filter.
+  

+    

+    lamList::listGetAttributeDescriptionList()
+
+  

+  

+    Returns an hash array containing with all attributes to be shown and their descriptions.
+  

+    

+    lamList::listGetParams()
+
+  

+  

+    Sets some internal parameters.
+  

+    

+    lamList::listPrintButtons()
+
+  

+  

+    Prints the create, delete and PDF buttons.
+  

+    

+    lamList::listPrintHeader()
+
+  

+  

+    Prints the HTML head.
+  

+    

+    lamList::listPrintJavaScript()
+
+  

+  

+    Prints JavaScript code needed for mouse-over effects.
+  

+    

+    lamList::listPrintTableBody()
+
+  

+  

+    Prints the entry list
+  

+    

+    lamList::listPrintTableHeader()
+
+  

+  

+    Prints the attribute and filter row at the account table head
+  

+    

+    lamList::listRefreshData()
+
+  

+  

+    Rereads the entries from LDAP.
+  

+    

+    lamList::listShowOUSelection()
+
+  

+  

+    Prints a combobox with possible sub-DNs.
+  

+    

+    lamList::listSort()
+
+  

+  

+    Sorts an account list by a given attribute
+  

+    

+    lamList::showPage()
+
+  

+  

+    Prints the HTML code to display the list view.
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 99]

+Generates the list view.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+



+
[ Top ]


+
+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor lamGroupList [line 107]

+	

+    

+    

+		lamList lamGroupList(
+string
+$type)
+    

+    


+	
+		Constructor




+
Tags:

+

+
+  
+    
+  
+
return:  list object

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $type  account type

+    


+        
[ Top ]

+  

+  

+	
+	
method listPrintTableBody [line 123]

+	

+    

+    

+		void listPrintTableBody(
+array
+$info)
+    

+    


+	
+		Prints the entry list




+
+	
+Overrides lamList::listPrintTableBody() (Prints the entry list)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
array  $info  entries

+    


+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:46 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/lamHostList.html b/lam-web/developers/phpdoc/lists/lamHostList.html
new file mode 100644
index 00000000..5c795bcf
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/lamHostList.html
@@ -0,0 +1,468 @@
+
+
+Docs For Class lamHostList
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Class: lamHostList

+Source Location: /lib/types/host.inc


+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
lamList
+   |
+   --lamHostList


+
Generates the list view.



+
Author(s):

+
    
+          
  • Roland Gruber
    • 
+      

+
+
+
+
+    
+
+        
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: lamList

+

+

+  lamList::$attrArray
+  
+

+

+   
+

+

+  lamList::$descArray
+  
+

+

+   
+

+

+  lamList::$entries
+  
+

+

+   
+

+

+  lamList::$filterText
+  
+

+

+   
+

+

+  lamList::$labels
+  
+

+

+   
+

+

+  lamList::$maxPageEntries
+  
+

+

+   
+

+

+  lamList::$page
+  
+

+

+   
+

+

+  lamList::$possibleSuffixes
+  
+

+

+   
+

+

+  lamList::$refresh
+  
+

+

+   
+

+

+  lamList::$sortColumn
+  
+

+

+   
+

+

+  lamList::$suffix
+  
+

+

+   
+

+

+  lamList::$type
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: lamList

+

+    

+    lamList::lamList()
+
+  

+  

+    Constructor
+  

+    

+    lamList::cmp_array()
+
+  

+  

+    Compare function used for usort-method
+  

+    

+    lamList::listBuildFilter()
+
+  

+  

+    Builds the regular expressions from the filter values.
+  

+    

+    lamList::listDoPost()
+
+  

+  

+    Manages all POST actions (e.g. button pressed) for the account lists.
+  

+    

+    lamList::listDrawNavigationBar()
+
+  

+  

+    Draws a navigation bar to switch between pages
+  

+    

+    lamList::listFilterAccounts()
+
+  

+  

+    Removes all entries which do not fit to the filter.
+  

+    

+    lamList::listGetAttributeDescriptionList()
+
+  

+  

+    Returns an hash array containing with all attributes to be shown and their descriptions.
+  

+    

+    lamList::listGetParams()
+
+  

+  

+    Sets some internal parameters.
+  

+    

+    lamList::listPrintButtons()
+
+  

+  

+    Prints the create, delete and PDF buttons.
+  

+    

+    lamList::listPrintHeader()
+
+  

+  

+    Prints the HTML head.
+  

+    

+    lamList::listPrintJavaScript()
+
+  

+  

+    Prints JavaScript code needed for mouse-over effects.
+  

+    

+    lamList::listPrintTableBody()
+
+  

+  

+    Prints the entry list
+  

+    

+    lamList::listPrintTableHeader()
+
+  

+  

+    Prints the attribute and filter row at the account table head
+  

+    

+    lamList::listRefreshData()
+
+  

+  

+    Rereads the entries from LDAP.
+  

+    

+    lamList::listShowOUSelection()
+
+  

+  

+    Prints a combobox with possible sub-DNs.
+  

+    

+    lamList::listSort()
+
+  

+  

+    Sorts an account list by a given attribute
+  

+    

+    lamList::showPage()
+
+  

+  

+    Prints the HTML code to display the list view.
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 101]

+Generates the list view.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+



+
[ Top ]


+
+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor lamHostList [line 109]

+	

+    

+    

+		lamList lamHostList(
+string
+$type)
+    

+    


+	
+		Constructor




+
Tags:

+

+
+  
+    
+  
+
return:  list object

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $type  account type

+    


+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:47 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/lamList.html b/lam-web/developers/phpdoc/lists/lamList.html
new file mode 100644
index 00000000..097120f6
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/lamList.html
@@ -0,0 +1,906 @@
+
+
+Docs For Class lamList
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Class: lamList

+Source Location: /lib/lists.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+


+
Generates the list view.



+
Author(s):

+
    
+          
  • Roland Gruber
    • 
+      

+
+
+
+
+    
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+

+
Child classes:

+

+

+
lamMailAliasList

+	
Generates the list view.

+

+

+
lamHostList

+	
Generates the list view.

+

+

+
lamSmbDomainList

+	
Generates the list view.

+

+

+
lamGroupList

+	
Generates the list view.

+

+

+
lamUserList

+	
Generates the list view.

+

+

+

+

+
+
+
Class Details

+

+[line 47]

+Generates the list view.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+



+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$attrArray = array()

+	
[line 56]

+  list of LDAP attributes


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$descArray = array()

+	
[line 59]

+  list of attribute descriptions


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$entries = 

+	
[line 74]

+  LDAP entries


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$filterText = 

+	
[line 77]

+  filter string to include in URL


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$labels = 

+	
[line 83]

+  list of account specific labels


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$maxPageEntries =  10

+	
[line 62]

+  maximum count of entries per page


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$page =  1

+	
[line 53]

+  current page number


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$possibleSuffixes = 

+	
[line 80]

+  list of possible LDAP suffixes(organizational units)


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$refresh =  true

+	
[line 71]

+  refresh page switch


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$sortColumn = 

+	
[line 65]

+  sort column name


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$suffix = 

+	
[line 68]

+  LDAP suffix


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$type = 

+	
[line 50]

+  Account type


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor lamList [line 91]

+	

+    

+    

+		lamList lamList(
+string
+$type)
+    

+    


+	
+		Constructor




+
Tags:

+

+
+  
+    
+  
+
return:  list object

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $type  account type

+    


+        
[ Top ]

+  

+  

+	
+	
method cmp_array [line 254]

+	

+    

+    

+		integer cmp_array(
+array
+$a, array
+$b)
+    

+    


+	
+		Compare function used for usort-method

Rows are sorted with the first attribute entry of the sort column.  If objects have attributes with multiple values only the first is used for sorting.




+
Tags:

+

+
+  
+    
+  
+
return:  0 if both are equal, 1 if $a is greater, -1 if $b is greater

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $a  first row which is compared
array  $b  second row which is compared

+    


+        
[ Top ]

+  

+  

+	
+	
method listBuildFilter [line 158]

+	

+    

+    

+		array listBuildFilter(
+)
+    

+    


+	
+		Builds the regular expressions from the filter values.




+
Tags:

+

+
+  
+    
+  
+
return:  filter data array($attribute => array('regex' => $reg, 'original' => $orig))  $reg is the regular expression to use, $orig the user's unmodified input string

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method listDoPost [line 415]

+	

+    

+    

+		void listDoPost(
+)
+    

+    


+	
+		Manages all POST actions (e.g. button pressed) for the account lists.




+
+	
Overridden in child classes as:

+		

+	
lamUserList::listDoPost()

+		
Manages all POST actions (e.g. button pressed) for the account lists.

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method listDrawNavigationBar [line 274]

+	

+    

+    

+		void listDrawNavigationBar(
+integer
+$count)
+    

+    


+	
+		Draws a navigation bar to switch between pages




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
integer  $count  number of account entries

+    


+        
[ Top ]

+  

+  

+	
+	
method listFilterAccounts [line 201]

+	

+    

+    

+		array listFilterAccounts(
+)
+    

+    


+	
+		Removes all entries which do not fit to the filter.




+
Tags:

+

+
+  
+    
+  
+
return:  filtered list of accounts

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method listGetAttributeDescriptionList [line 576]

+	

+    

+    

+		array listGetAttributeDescriptionList(
+)
+    

+    


+	
+		Returns an hash array containing with all attributes to be shown and their descriptions.

Format: array(attribute => description)




+
Tags:

+

+
+  
+    
+  
+
return:  attribute list

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method listGetParams [line 610]

+	

+    

+    

+		void listGetParams(
+)
+    

+    


+	
+		Sets some internal parameters.




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method listPrintButtons [line 504]

+	

+    

+    

+		void listPrintButtons(
+boolean
+$createOnly)
+    

+    


+	
+		Prints the create, delete and PDF buttons.




+
+	
Overridden in child classes as:

+		

+	
lamUserList::listPrintButtons()

+		
Prints the create, delete and PDF buttons.

+	

+	

+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
boolean  $createOnly  true if only the create button should be displayed

+    


+        
[ Top ]

+  

+  

+	
+	
method listPrintHeader [line 527]

+	

+    

+    

+		void listPrintHeader(
+)
+    

+    


+	
+		Prints the HTML head.




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method listPrintJavaScript [line 539]

+	

+    

+    

+		void listPrintJavaScript(
+)
+    

+    


+	
+		Prints JavaScript code needed for mouse-over effects.




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method listPrintTableBody [line 361]

+	

+    

+    

+		void listPrintTableBody(
+array
+$info)
+    

+    


+	
+		Prints the entry list




+
+	
Overridden in child classes as:

+		

+	
lamGroupList::listPrintTableBody()

+		
Prints the entry list

+	

+		

+	
lamUserList::listPrintTableBody()

+		
Prints the entry list

+	

+	

+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
array  $info  entries

+    


+        
[ Top ]

+  

+  

+	
+	
method listPrintTableHeader [line 314]

+	

+    

+    

+		void listPrintTableHeader(
+)
+    

+    


+	
+		Prints the attribute and filter row at the account table head




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method listRefreshData [line 638]

+	

+    

+    

+		void listRefreshData(
+)
+    

+    


+	
+		Rereads the entries from LDAP.




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method listShowOUSelection [line 482]

+	

+    

+    

+		void listShowOUSelection(
+)
+    

+    


+	
+		Prints a combobox with possible sub-DNs.




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method listSort [line 235]

+	

+    

+    

+		array listSort(
+array
+$info)
+    

+    


+	
+		Sorts an account list by a given attribute




+
Tags:

+

+
+  
+    
+  
+
return:  sorted account list

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
array  $info  the account list

+    


+        
[ Top ]

+  

+  

+	
+	
method showPage [line 105]

+	

+    

+    

+		void showPage(
+)
+    

+    


+	
+		Prints the HTML code to display the list view.




+
+	
+
+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:51 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/lamMailAliasList.html b/lam-web/developers/phpdoc/lists/lamMailAliasList.html
new file mode 100644
index 00000000..81fc65e7
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/lamMailAliasList.html
@@ -0,0 +1,468 @@
+
+
+Docs For Class lamMailAliasList
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Class: lamMailAliasList

+Source Location: /lib/types/mailAlias.inc


+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
lamList
+   |
+   --lamMailAliasList


+
Generates the list view.



+
Author(s):

+
    
+          
  • Roland Gruber
    • 
+      

+
+
+
+
+    
+
+        
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: lamList

+

+

+  lamList::$attrArray
+  
+

+

+   
+

+

+  lamList::$descArray
+  
+

+

+   
+

+

+  lamList::$entries
+  
+

+

+   
+

+

+  lamList::$filterText
+  
+

+

+   
+

+

+  lamList::$labels
+  
+

+

+   
+

+

+  lamList::$maxPageEntries
+  
+

+

+   
+

+

+  lamList::$page
+  
+

+

+   
+

+

+  lamList::$possibleSuffixes
+  
+

+

+   
+

+

+  lamList::$refresh
+  
+

+

+   
+

+

+  lamList::$sortColumn
+  
+

+

+   
+

+

+  lamList::$suffix
+  
+

+

+   
+

+

+  lamList::$type
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: lamList

+

+    

+    lamList::lamList()
+
+  

+  

+    Constructor
+  

+    

+    lamList::cmp_array()
+
+  

+  

+    Compare function used for usort-method
+  

+    

+    lamList::listBuildFilter()
+
+  

+  

+    Builds the regular expressions from the filter values.
+  

+    

+    lamList::listDoPost()
+
+  

+  

+    Manages all POST actions (e.g. button pressed) for the account lists.
+  

+    

+    lamList::listDrawNavigationBar()
+
+  

+  

+    Draws a navigation bar to switch between pages
+  

+    

+    lamList::listFilterAccounts()
+
+  

+  

+    Removes all entries which do not fit to the filter.
+  

+    

+    lamList::listGetAttributeDescriptionList()
+
+  

+  

+    Returns an hash array containing with all attributes to be shown and their descriptions.
+  

+    

+    lamList::listGetParams()
+
+  

+  

+    Sets some internal parameters.
+  

+    

+    lamList::listPrintButtons()
+
+  

+  

+    Prints the create, delete and PDF buttons.
+  

+    

+    lamList::listPrintHeader()
+
+  

+  

+    Prints the HTML head.
+  

+    

+    lamList::listPrintJavaScript()
+
+  

+  

+    Prints JavaScript code needed for mouse-over effects.
+  

+    

+    lamList::listPrintTableBody()
+
+  

+  

+    Prints the entry list
+  

+    

+    lamList::listPrintTableHeader()
+
+  

+  

+    Prints the attribute and filter row at the account table head
+  

+    

+    lamList::listRefreshData()
+
+  

+  

+    Rereads the entries from LDAP.
+  

+    

+    lamList::listShowOUSelection()
+
+  

+  

+    Prints a combobox with possible sub-DNs.
+  

+    

+    lamList::listSort()
+
+  

+  

+    Sorts an account list by a given attribute
+  

+    

+    lamList::showPage()
+
+  

+  

+    Prints the HTML code to display the list view.
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 97]

+Generates the list view.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+



+
[ Top ]


+
+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor lamMailAliasList [line 105]

+	

+    

+    

+		lamList lamMailAliasList(
+string
+$type)
+    

+    


+	
+		Constructor




+
Tags:

+

+
+  
+    
+  
+
return:  list object

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $type  account type

+    


+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:52 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/lamSmbDomainList.html b/lam-web/developers/phpdoc/lists/lamSmbDomainList.html
new file mode 100644
index 00000000..7340eed6
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/lamSmbDomainList.html
@@ -0,0 +1,468 @@
+
+
+Docs For Class lamSmbDomainList
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Class: lamSmbDomainList

+Source Location: /lib/types/smbDomain.inc


+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
lamList
+   |
+   --lamSmbDomainList


+
Generates the list view.



+
Author(s):

+
    
+          
  • Roland Gruber
    • 
+      

+
+
+
+
+    
+
+        
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: lamList

+

+

+  lamList::$attrArray
+  
+

+

+   
+

+

+  lamList::$descArray
+  
+

+

+   
+

+

+  lamList::$entries
+  
+

+

+   
+

+

+  lamList::$filterText
+  
+

+

+   
+

+

+  lamList::$labels
+  
+

+

+   
+

+

+  lamList::$maxPageEntries
+  
+

+

+   
+

+

+  lamList::$page
+  
+

+

+   
+

+

+  lamList::$possibleSuffixes
+  
+

+

+   
+

+

+  lamList::$refresh
+  
+

+

+   
+

+

+  lamList::$sortColumn
+  
+

+

+   
+

+

+  lamList::$suffix
+  
+

+

+   
+

+

+  lamList::$type
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: lamList

+

+    

+    lamList::lamList()
+
+  

+  

+    Constructor
+  

+    

+    lamList::cmp_array()
+
+  

+  

+    Compare function used for usort-method
+  

+    

+    lamList::listBuildFilter()
+
+  

+  

+    Builds the regular expressions from the filter values.
+  

+    

+    lamList::listDoPost()
+
+  

+  

+    Manages all POST actions (e.g. button pressed) for the account lists.
+  

+    

+    lamList::listDrawNavigationBar()
+
+  

+  

+    Draws a navigation bar to switch between pages
+  

+    

+    lamList::listFilterAccounts()
+
+  

+  

+    Removes all entries which do not fit to the filter.
+  

+    

+    lamList::listGetAttributeDescriptionList()
+
+  

+  

+    Returns an hash array containing with all attributes to be shown and their descriptions.
+  

+    

+    lamList::listGetParams()
+
+  

+  

+    Sets some internal parameters.
+  

+    

+    lamList::listPrintButtons()
+
+  

+  

+    Prints the create, delete and PDF buttons.
+  

+    

+    lamList::listPrintHeader()
+
+  

+  

+    Prints the HTML head.
+  

+    

+    lamList::listPrintJavaScript()
+
+  

+  

+    Prints JavaScript code needed for mouse-over effects.
+  

+    

+    lamList::listPrintTableBody()
+
+  

+  

+    Prints the entry list
+  

+    

+    lamList::listPrintTableHeader()
+
+  

+  

+    Prints the attribute and filter row at the account table head
+  

+    

+    lamList::listRefreshData()
+
+  

+  

+    Rereads the entries from LDAP.
+  

+    

+    lamList::listShowOUSelection()
+
+  

+  

+    Prints a combobox with possible sub-DNs.
+  

+    

+    lamList::listSort()
+
+  

+  

+    Sorts an account list by a given attribute
+  

+    

+    lamList::showPage()
+
+  

+  

+    Prints the HTML code to display the list view.
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 97]

+Generates the list view.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+



+
[ Top ]


+
+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor lamSmbDomainList [line 105]

+	

+    

+    

+		lamList lamSmbDomainList(
+string
+$type)
+    

+    


+	
+		Constructor




+
Tags:

+

+
+  
+    
+  
+
return:  list object

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $type  account type

+    


+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:08 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/lamUserList.html b/lam-web/developers/phpdoc/lists/lamUserList.html
new file mode 100644
index 00000000..5b089018
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/lamUserList.html
@@ -0,0 +1,589 @@
+
+
+Docs For Class lamUserList
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Class: lamUserList

+Source Location: /lib/types/user.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
lamList
+   |
+   --lamUserList


+
Generates the list view.



+
Author(s):

+
    
+          
  • Roland Gruber
    • 
+      

+
+
+
+
+    
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: lamList

+

+

+  lamList::$attrArray
+  
+

+

+   
+

+

+  lamList::$descArray
+  
+

+

+   
+

+

+  lamList::$entries
+  
+

+

+   
+

+

+  lamList::$filterText
+  
+

+

+   
+

+

+  lamList::$labels
+  
+

+

+   
+

+

+  lamList::$maxPageEntries
+  
+

+

+   
+

+

+  lamList::$page
+  
+

+

+   
+

+

+  lamList::$possibleSuffixes
+  
+

+

+   
+

+

+  lamList::$refresh
+  
+

+

+   
+

+

+  lamList::$sortColumn
+  
+

+

+   
+

+

+  lamList::$suffix
+  
+

+

+   
+

+

+  lamList::$type
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: lamList

+

+    

+    lamList::lamList()
+
+  

+  

+    Constructor
+  

+    

+    lamList::cmp_array()
+
+  

+  

+    Compare function used for usort-method
+  

+    

+    lamList::listBuildFilter()
+
+  

+  

+    Builds the regular expressions from the filter values.
+  

+    

+    lamList::listDoPost()
+
+  

+  

+    Manages all POST actions (e.g. button pressed) for the account lists.
+  

+    

+    lamList::listDrawNavigationBar()
+
+  

+  

+    Draws a navigation bar to switch between pages
+  

+    

+    lamList::listFilterAccounts()
+
+  

+  

+    Removes all entries which do not fit to the filter.
+  

+    

+    lamList::listGetAttributeDescriptionList()
+
+  

+  

+    Returns an hash array containing with all attributes to be shown and their descriptions.
+  

+    

+    lamList::listGetParams()
+
+  

+  

+    Sets some internal parameters.
+  

+    

+    lamList::listPrintButtons()
+
+  

+  

+    Prints the create, delete and PDF buttons.
+  

+    

+    lamList::listPrintHeader()
+
+  

+  

+    Prints the HTML head.
+  

+    

+    lamList::listPrintJavaScript()
+
+  

+  

+    Prints JavaScript code needed for mouse-over effects.
+  

+    

+    lamList::listPrintTableBody()
+
+  

+  

+    Prints the entry list
+  

+    

+    lamList::listPrintTableHeader()
+
+  

+  

+    Prints the attribute and filter row at the account table head
+  

+    

+    lamList::listRefreshData()
+
+  

+  

+    Rereads the entries from LDAP.
+  

+    

+    lamList::listShowOUSelection()
+
+  

+  

+    Prints a combobox with possible sub-DNs.
+  

+    

+    lamList::listSort()
+
+  

+  

+    Sorts an account list by a given attribute
+  

+    

+    lamList::showPage()
+
+  

+  

+    Prints the HTML code to display the list view.
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 105]

+Generates the list view.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+



+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$trans_primary =  false

+	
[line 108]

+  Controls if GID number is translated to group name


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$trans_primary_hash = array()

+	
[line 111]

+  translates GID to group name


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor lamUserList [line 119]

+	

+    

+    

+		lamList lamUserList(
+string
+$type)
+    

+    


+	
+		Constructor




+
Tags:

+

+
+  
+    
+  
+
return:  list object

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $type  account type

+    


+        
[ Top ]

+  

+  

+	
+	
method listDoPost [line 133]

+	

+    

+    

+		void listDoPost(
+)
+    

+    


+	
+		Manages all POST actions (e.g. button pressed) for the account lists.




+
+	
+Overrides lamList::listDoPost() (Manages all POST actions (e.g. button pressed) for the account lists.)


+
+        
[ Top ]

+  

+  

+	
+	
method listPrintButtons [line 230]

+	

+    

+    

+		void listPrintButtons(
+boolean
+$createOnly)
+    

+    


+	
+		Prints the create, delete and PDF buttons.




+
+	
+Overrides lamList::listPrintButtons() (Prints the create, delete and PDF buttons.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
boolean  $createOnly  true if only the create button should be displayed

+    


+        
[ Top ]

+  

+  

+	
+	
method listPrintTableBody [line 161]

+	

+    

+    

+		void listPrintTableBody(
+array
+$info)
+    

+    


+	
+		Prints the entry list




+
+	
+Overrides lamList::listPrintTableBody() (Prints the entry list)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
array  $info  entries

+    


+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:13 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_lib_tree_inc.html b/lam-web/developers/phpdoc/lists/tree/_lib_tree_inc.html
new file mode 100644
index 00000000..bf687f48
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_lib_tree_inc.html
@@ -0,0 +1,1022 @@
+
+
+Docs for page tree.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: tree.inc

+Source Location: /lib/tree.inc


+
+

+

+
+
+
Page Details:

+This function displays the LDAP tree for all the servers that you have

in config.php. We read the session variable 'tree' to know which  dns are expanded or collapsed. No query string parameters are expected,  however, you can use a '#' offset to scroll to a given dn. The syntax is  tree.php#<rawurlencoded dn>, so if I wanted to scroll to  dc=example,dc=com for server 3, the URL would be: 	tree.php#3_dc%3Dexample%2Cdc%3Dcom




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  David Smith

+

+


+


+


+

+  

+	
+	
arrayLower [line 911]

+	

+    

+    

+		void arrayLower(
+mixed $array)
+    

+    


+
+		    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
build_initial_tree_icons [line 180]

+	

+    

+    

+		void build_initial_tree_icons(
+)
+    

+    


+
+		Builds the initial array that stores the icon-lookup for each server's DN in the tree browser. The returned

array is then stored in the current session. The structure of the returned array is simple, and looks like  this:  

1     Array
2         (
3           [0] => Array
4               (
5                  [dc=example,dc=com] => "dcobject.png"
6               )
7           [1] => Array
8                 [o=Corporation] => "o.png"
9               )
10         )
  This function is not meant as a user-callable function, but rather a convenient, automated method for  setting up the initial data structure for the tree viewer's icon cache.

    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
dn_exists [line 199]

+	

+    

+    

+		bool dn_exists(
+string $dn)
+    

+    


+
+		Gets whether an entry exists based on its DN. If the entry exists,  returns true. Otherwise returns false.

    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $dn  The DN of the entry of interest.

+    	
[ Top ]



+	

+  

+	
+	
draw_formatted_dn [line 647]

+	

+    

+    

+		void draw_formatted_dn(
+mixed $dn)
+    

+    


+
+		Gets a DN string using the user-configured tree_display_format string to format it.

    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
draw_jpeg_photos [line 1122]

+	

+    

+    

+		void draw_jpeg_photos(
+string $dn, [string $attr_name = 'jpegPhoto'], [bool $draw_delete_buttons = false], [bool $draw_bytes_and_size = true], [string $table_html_attrs = 'align="left"'], [mixed $img_html_attrs = ''])
+    

+    


+
+		Draw the jpegPhoto image(s) for an entry wrapped in HTML. Many options are available to  specify how the images are to be displayed.

Usage Examples:   

1     draw_jpeg_photos( 0, "cn=Bob,ou=People,dc=example,dc=com", "jpegPhoto" true, false, "border: 1px; width: 150px" );
2         draw_jpeg_photos( 1, "cn=Fred,ou=People,dc=example,dc=com" );

    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $dn  The DN of the entry that contains the jpeg attribute you want to draw.
string  $attr_name  The name of the attribute containing the jpeg data (usually 'jpegPhoto').
bool  $draw_delete_buttons  If true, draws a button beneath the image titled 'Delete' allowing the user                   to delete the jpeg attribute by calling JavaScript function deleteAttribute() provided                   in the default modification template.
bool  $draw_bytes_and_size  If true, draw text below the image indicating the byte size and dimensions.
string  $table_html_attrs  Specifies optional CSS style attributes for the table tag.

+    	
[ Top ]



+	

+  

+	
+	
draw_server_tree [line 49]

+	

+    

+    

+		void draw_server_tree(
+)
+    

+    


+
+		Prints the HTML of the tree view.

    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
get_container [line 1300]

+	

+    

+    

+		string get_container(
+string $dn)
+    

+    


+
+		Given a DN string, this returns the parent container portion of the string.

For example. given 'cn=Manager,dc=example,dc=com', this function returns  'dc=example,dc=com'.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
return:  The container
see:  get_rdn()

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $dn  The DN whose container string to return.

+    	
[ Top ]



+	

+  

+	
+	
get_container_contents [line 245]

+	

+    

+    

+		array get_container_contents(
+string $dn, [int $size_limit = 0], [string $filter = '(objectClass=*)'])
+    

+    


+
+		Gets a list of child entries for an entry. Given a DN, this function fetches the list of DNs of  child entries one level beneath the parent. For example, for the following tree:


1     dc=example,dc=com
2        ou=People
3           cn=Dave
4           cn=Fred
5           cn=Joe
6           ou=More People
7              cn=Mark
8              cn=Bob
Calling 

1     get_container_contents( "ou=people,dc=example,dc=com" )
  would return the following list:

1     cn=Dave
2       cn=Fred
3       cn=Joe
4       ou=More People




+
Tags:

+

+
+  
+    
+  
+
return:  An array of DN strings listing the immediate children of the specified entry.

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $dn  The DN of the entry whose children to return.
int  $size_limit  (optional) The maximum number of entries to return.              If unspecified, no limit is applied to the number of entries in the returned.
string  $filter  (optional) An LDAP filter to apply when fetching children, example: "(objectClass=inetOrgPerson)"

+    	
[ Top ]



+	

+  

+	
+	
get_enc_type [line 1092]

+	

+    

+    

+		void get_enc_type(
+mixed $user_password)
+    

+    


+
+		    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
get_entry_system_attrs [line 883]

+	

+    

+    

+		array get_entry_system_attrs(
+string $dn, [int $deref = LDAP_DEREF_NEVER])
+    

+    


+
+		Gets the operational attributes for an entry. Given a DN, this function fetches that entry's

operational (ie, system or internal) attributes. These attributes include "createTimeStamp",  "creatorsName", and any other attribute that the LDAP server sets automatically. The returned  associative array is of this form:  

1     Array
2       (
3         [creatorsName] => Array
4             (
5                [0] => "cn=Admin,dc=example,dc=com"
6             )
7         [createTimeStamp]=> Array
8             (
9                [0] => "10401040130"
10            )
11        [hasSubordinates] => Array
12            (
13               [0] => "FALSE"
14            )
15      )




+
Tags:

+

+
+  
+    
+  
+
return:  An associative array whose keys are attribute names and whose values               are arrays of values for the aforementioned attribute.

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $dn  The DN of the entry whose interal attributes are desired.
int  $deref  For aliases and referrals, this parameter specifies whether to             follow references to the referenced DN or to fetch the attributes for             the referencing DN. See http://php.net/ldap_search for the 4 valid             options.

+    	
[ Top ]



+	

+  

+	
+	
get_icon [line 282]

+	

+    

+    

+		string get_icon(
+string $dn)
+    

+    


+
+		Given a DN and server ID, this function reads the DN's objectClasses and

determines which icon best represents the entry. The results of this query  are cached in a session variable so it is not run every time the tree  browser changes, just when exposing new DNs that were not displayed  previously. That means we can afford a little bit of inefficiency here  in favor of coolness. :)
This function returns a string like "country.png". All icon files are assumed  to be contained in the /../../graphics/ directory of phpLDAPadmin.
Developers are encouraged to add new icons to the images directory and modify  this function as needed to suit their types of LDAP entries. If the modifications  are general to an LDAP audience, the phpLDAPadmin team will gladly accept them  as a patch.

    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $dn  The DN of the entry whose icon you wish to fetch.

+    	
[ Top ]



+	

+  

+	
+	
get_object_attr [line 426]

+	

+    

+    

+		void get_object_attr(
+string $dn, string $attr, bool $lower_case_attr_names)
+    

+    


+
+		Much like get_object_attrs(), but only returns the values for  one attribute of an object. Example calls:


1     print_r( get_object_attr( 0, "cn=Bob,ou=people,dc=example,dc=com", "sn" ) );
2      // prints:
3      //  Array
4      //    (
5      //       [0] => "Smith"
6      //    )
7     
8      print_r( get_object_attr( 0, "cn=Bob,ou=people,dc=example,dc=com", "objectClass" ) );
9      // prints:
10     //  Array
11     //    (
12     //       [0] => "top"
13     //       [1] => "person"
14     //    )




+
Tags:

+

+
+  
+    
+  
+
see:  get_object_attrs()

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $dn  The distinguished name (DN) of the entry whose attributes/values to fetch.
string  $attr  The attribute whose value(s) to return (ie, "objectClass", "cn", "userPassword")
bool  $lower_case_attr_names  (optional) If true, all keys of the returned associative               array will be lower case. Otherwise, they will be cased as the LDAP server returns               them.

+    	
[ Top ]



+	

+  

+	
+	
get_object_attrs [line 721]

+	

+    

+    

+		array get_object_attrs(
+string $dn, [bool $lower_case_attr_names = false], [int $deref = LDAP_DEREF_NEVER])
+    

+    


+
+		Gets the attributes/values of an entry. Returns an associative array whose

keys are attribute value names and whose values are arrays of values for  said attribute. Optionally, callers may specify true for the parameter  $lower_case_attr_names to force all keys in the associate array (attribute  names) to be lower case.
Sample return value of 

1     get_object_attrs( 0, "cn=Bob,ou=pepole,dc=example,dc=com" )

1     Array
2       (
3        [objectClass] => Array
4            (
5                [0] => person
6                [1] => top
7            )
8        [cn] => Array
9            (
10               [0] => Bob
11           )
12       [sn] => Array
13           (
14               [0] => Jones
15           )
16       [dn] => Array
17           (
18                [0] => cn=Bob,ou=pepole,dc=example,dc=com
19           )
20      )




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
see:  get_object_attr()
see:  get_entry_system_attrs()

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $dn  The distinguished name (DN) of the entry whose attributes/values to fetch.
bool  $lower_case_attr_names  (optional) If true, all keys of the returned associative               array will be lower case. Otherwise, they will be cased as the LDAP server returns               them.
int  $deref  For aliases and referrals, this parameter specifies whether to             follow references to the referenced DN or to fetch the attributes for             the referencing DN. See http://php.net/ldap_search for the 4 valid             options.

+    	
[ Top ]



+	

+  

+	
+	
get_rdn [line 460]

+	

+    

+    

+		string get_rdn(
+string $dn, [bool $include_attrs = 0])
+    

+    


+
+		Given a DN string, this returns the 'RDN' portion of the string.

For example. given 'cn=Manager,dc=example,dc=com', this function returns  'cn=Manager' (it is really the exact opposite of get_container()).




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
return:  The RDN
see:  get_container()

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $dn  The DN whose RDN to return.
bool  $include_attrs  If true, include attributes in the RDN string.                See http://php.net/ldap_explode_dn for details

+    	
[ Top ]



+	

+  

+	
+	
initialize_session_tree [line 143]

+	

+    

+    

+		void initialize_session_tree(
+)
+    

+    


+
+		Checks and fixes an initial session's tree cache if needed.

This function is not meant as a user-callable function, but rather a convenient,  automated method for checking the initial data structure of the session.

    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
is_attr_binary [line 773]

+	

+    

+    

+		bool is_attr_binary(
+string $attr_name)
+    

+    


+
+		Given an attribute name and server ID number, this function returns  whether the attrbiute may contain binary data. This is useful for  developers who wish to display the contents of an arbitrary attribute  but don't want to dump binary data on the page.




+
Tags:

+

+
+  
+    
+  
+
see:  is_jpeg_photo()

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $attr_name  The name of the attribute to test.

+    	
[ Top ]



+	

+  

+	
+	
is_attr_boolean [line 959]

+	

+    

+    

+		bool is_attr_boolean(
+string $attr_name)
+    

+    


+
+		Given an attribute name and server ID number, this function returns  whether the attrbiute contains boolean data. This is useful for  developers who wish to display the contents of a boolean attribute  with a drop-down.

    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $attr_name  The name of the attribute to test.

+    	
[ Top ]



+	

+  

+	
+	
is_dn_attr [line 1066]

+	

+    

+    

+		bool is_dn_attr(
+string $attr_name)
+    

+    


+
+		Returns true if the attribute specified is required to take as input a DN.

Some examples include 'distinguishedName', 'member' and 'uniqueMember'.

    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $attr_name  The name of the attribute of interest (case insensitive)

+    	
[ Top ]



+	

+  

+	
+	
is_jpeg_photo [line 927]

+	

+    

+    

+		bool is_jpeg_photo(
+string $attr_name)
+    

+    


+
+		Used to determine if the specified attribute is indeed a jpegPhoto. If the  specified attribute is one that houses jpeg data, true is returned. Otherwise  this function returns false.




+
Tags:

+

+
+  
+    
+  
+
see:  draw_jpeg_photos()

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $attr_name  The name of the attribute to test.

+    	
[ Top ]



+	

+  

+	
+	
is_mail_string [line 979]

+	

+    

+    

+		bool is_mail_string(
+string $str)
+    

+    


+
+		Get whether a string looks like an email address (user@example.com).




+
Tags:

+

+
+  
+    
+  
+
return:  Returns true if the specified string looks like    an email address or false otherwise.

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $str  The string to analyze.

+    	
[ Top ]



+	

+  

+	
+	
is_multi_line_attr [line 1027]

+	

+    

+    

+		bool is_multi_line_attr(
+string $attr_name, [string $val = null])
+    

+    


+
+		Determines if an attribute's value can contain multiple lines. Attributes that fall  in this multi-line category may be configured in config.php. Hence, this function  accesses the global variable $multi_line_attributes;

Usage example:  

1     if( is_muli_line_attr( "postalAddress" ) )
2           echo "<textarea name=\"postalAddress\"></textarea>";
3       else
4           echo "<input name=\"postalAddress\" type=\"text\">";

    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $attr_name  The name of the attribute of interestd (case insensivite)
string  $val  (optional) The current value of the attribute (speeds up the                process by searching for carriage returns already in the attribute value)

+    	
[ Top ]



+	

+  

+	
+	
is_url_string [line 995]

+	

+    

+    

+		bool is_url_string(
+string $str)
+    

+    


+
+		Get whether a string looks like a web URL (http://www.example.com/)




+
Tags:

+

+
+  
+    
+  
+
return:  Returns true if the specified string looks like    a web URL or false otherwise.

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $str  The string to analyze.

+    	
[ Top ]



+	

+  

+	
+	
pla_compare_dns [line 562]

+	

+    

+    

+		int pla_compare_dns(
+string $dn1, string $dn2)
+    

+    


+
+		Compares 2 DNs. If they are equivelant, returns 0, otherwise,  returns their sorting order (similar to strcmp()):       Returns < 0 if dn1 is less than dn2.

Returns > 0 if dn1 is greater than dn2.
The comparison is performed starting with the top-most element  of the DN. Thus, the following list:     

1     ou=people,dc=example,dc=com
2            cn=Admin,ou=People,dc=example,dc=com
3            cn=Joe,ou=people,dc=example,dc=com
4            dc=example,dc=com
5            cn=Fred,ou=people,dc=example,dc=org
6            cn=Dave,ou=people,dc=example,dc=org
  Will be sorted thus using usort( $list, "pla_compare_dns" ):     

1     dc=com
2            dc=example,dc=com
3            ou=people,dc=example,dc=com
4            cn=Admin,ou=People,dc=example,dc=com
5            cn=Joe,ou=people,dc=example,dc=com
6            cn=Dave,ou=people,dc=example,dc=org
7            cn=Fred,ou=people,dc=example,dc=org

    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $dn1  The first of two DNs to compare
string  $dn2  The second of two DNs to compare

+    	
[ Top ]



+	

+  

+	
+	
pla_explode_dn [line 492]

+	

+    

+    

+		array pla_explode_dn(
+string $dn, [mixed $with_attributes = 0], int $with_attriutes)
+    

+    


+
+		Explode a DN into an array of its RDN parts. This function is UTF-8 safe  and replaces the buggy PHP ldap_explode_dn() which does not properly  handle UTF-8 DNs and also causes segmentation faults with some inputs.




+
Tags:

+

+
+  
+    
+  
+
return:  An array of RDN parts of this format:  

1     Array
2         (
3            [0] => uid=ppratt
4            [1] => ou=People
5            [2] => dc=example
6            [3] => dc=com
7         )

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $dn  The DN to explode.
int  $with_attriutes  (optional) Whether to include attribute names (see http://php.net/ldap_explode_dn for details)

+    	
[ Top ]



+	

+  

+	
+	
pla_ldap_search [line 1226]

+	

+    

+    

+		void pla_ldap_search(
+string $filter, [string $base_dn = null], [array $attrs = array()], [string $scope = 'sub'], [bool $sort_results = true], [int $deref = LDAP_DEREF_ALWAYS])
+    

+    


+
+		A handy ldap searching function very similar to PHP's ldap_search() with the  following exceptions: Callers may specify a search scope and the return value  is an array containing the search results rather than an LDAP result resource.

Example usage:  

1     $samba_users = ldap_search( 0, "(&(objectClass=sambaAccount)(objectClass=posixAccount))",
2                                   "ou=People,dc=example,dc=com", array( "uid", "homeDirectory" ) );
3      print_r( $samba_users );
4      // prints (for example):
5      //  Array
6      //    (
7      //       [uid=jsmith,ou=People,dc=example,dc=com] => Array
8      //           (
9      //               [dn] => "uid=jsmith,ou=People,dc=example,dc=com"
10     //               [uid] => "jsmith"
11     //               [homeDirectory] => "\\server\jsmith"
12     //           )
13     //       [uid=byoung,ou=People,dc=example,dc=com] => Array
14     //           (
15     //               [dn] => "uid=byoung,ou=Samba,ou=People,dc=example,dc=com"
16     //               [uid] => "byoung"
17     //               [homeDirectory] => "\\server\byoung"
18     //           )
19     //    )
WARNING: This function will use a lot of memory on large searches since the entire result set is  stored in a single array. For large searches, you should consider sing the less memory intensive  PHP LDAP API directly (ldap_search(), ldap_next_entry(), ldap_next_attribute(), etc).

    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $filter  The LDAP filter to use when searching (example: "(objectClass=*)") (see RFC 2254)
string  $base_dn  The DN of the base of search.
array  $attrs  An array of attributes to include in the search result (example: array( "objectClass", "uid", "sn" )).
string  $scope  The LDAP search scope. Must be one of "base", "one", or "sub". Standard LDAP search scope.
bool  $sort_results  Specify false to not sort results by DN or true to have the                   returned array sorted by DN (uses ksort)
int  $deref  When handling aliases or referrals, this specifies whether to follow referrals. Must be one of                   LDAP_DEREF_ALWAYS, LDAP_DEREF_NEVER, LDAP_DEREF_SEARCHING, or LDAP_DEREF_FINDING. See the PHP LDAP API for details.

+    	
[ Top ]



+	

+  

+	
+	
pla_reverse_dn [line 628]

+	

+    

+    

+		string pla_reverse_dn(
+string $dn)
+    

+    


+
+		Reverses a DN such that the top-level RDN is first and the bottom-level RDN is last

For example:  

1     cn=Brigham,ou=People,dc=example,dc=com
  Becomes:  

1     dc=com,dc=example,ou=People,cn=Brigham
  This makes it possible to sort lists of DNs such that they are grouped by container.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
return:  The reversed DN
see:  pla_compare_dns()

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $dn  The DN to reverse

+    	
[ Top ]



+	

+  

+	
+	
pretty_print_dn [line 517]

+	

+    

+    

+		string pretty_print_dn(
+string $dn)
+    

+    


+
+		Returns an HTML-beautified version of a DN.

Internally, this function makes use of pla_explode_dn() to break the  the DN into its components. It then glues them back together with  "pretty" HTML. The returned HTML is NOT to be used as a real DN, but  simply displayed.

    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $dn  The DN to pretty-print.

+    	
[ Top ]



+	

+  

+	
+	
real_attr_name [line 846]

+	

+    

+    

+		string real_attr_name(
+string $attr_name)
+    

+    


+
+		Prunes off anything after the ";" in an attr name. This is useful for  attributes that may have ";binary" appended to their names. With  real_attr_name(), you can more easily fetch these attributes' schema  with their "real" attribute name.

    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $attr_name  The name of the attribute to examine.

+    	
[ Top ]



+	

+  

+	
+	
sortAttrs [line 1005]

+	

+    

+    

+		void sortAttrs(
+mixed $a, mixed $b)
+    

+    


+
+		    


+	
+
+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:09 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_templates_tree_add_attr_form_php.html b/lam-web/developers/phpdoc/lists/tree/_templates_tree_add_attr_form_php.html
new file mode 100644
index 00000000..e05ae208
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_templates_tree_add_attr_form_php.html
@@ -0,0 +1,186 @@
+
+
+Docs for page add_attr_form.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: add_attr_form.php

+Source Location: /templates/tree/add_attr_form.php


+
+

+

+
+
+
Page Details:

+Displays a form for adding an attribute/value to an LDAP entry.

Variables that come in as GET vars: 
  • dn (rawurlencoded)




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  David Smith

+

+


+
Includes:

+

+include_once('../../lib/tree.inc') [line 46]

+tree functions

include_once('../../lib/security.inc') [line 44]

+security functions

include_once('../../lib/config.inc') [line 48]

+access to configuration

include_once('../../lib/ldap.inc') [line 50]

+LDAP functions

include_once('../../lib/status.inc') [line 52]

+status messages


+


+


+

+  

+	
+	
not_an_attr [line 188]

+	

+    

+    

+		void not_an_attr(
+mixed $x)
+    

+    


+
+		Given an attribute $x, this returns true if it is NOT already specified  in the current entry, returns false otherwise.

    


+	
+
+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:36 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_templates_tree_add_attr_php.html b/lam-web/developers/phpdoc/lists/tree/_templates_tree_add_attr_php.html
new file mode 100644
index 00000000..abdb7e00
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_templates_tree_add_attr_php.html
@@ -0,0 +1,187 @@
+
+
+Docs for page add_attr.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: add_attr.php

+Source Location: /templates/tree/add_attr.php


+
+

+

+
+
+
Page Details:

+Adds an attribute/value pair to an object

Variables that come in as POST vars: 
  • dn
  • attr
  • val
  • binary




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  David Smith

+

+


+
Includes:

+

+include_once('../../lib/tree.inc') [line 49]

+tree functions

include_once('../../lib/config.inc') [line 51]

+access to configuration

include_once('../../lib/ldap.inc') [line 53]

+LDAP functions

include_once('../../lib/account.inc') [line 57]

+common functions

include_once('../../lib/security.inc') [line 47]

+security functions

include_once('../../lib/status.inc') [line 55]

+status messages


+


+


+

+  

+	
+	
is_binary_option_required [line 137]

+	

+    

+    

+		void is_binary_option_required(
+mixed $attr)
+    

+    


+
+		    


+	
+
+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:35 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_templates_tree_add_oclass_form_php.html b/lam-web/developers/phpdoc/lists/tree/_templates_tree_add_oclass_form_php.html
new file mode 100644
index 00000000..7813c8c9
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_templates_tree_add_oclass_form_php.html
@@ -0,0 +1,170 @@
+
+
+Docs for page add_oclass_form.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: add_oclass_form.php

+Source Location: /templates/tree/add_oclass_form.php


+
+

+

+
+
+
Page Details:

+This page may simply add the objectClass and take you back to the edit page,  but, in one condition it may prompt the user for input. That condition is this:

If the user has requested to add an objectClass that requires a set of     attributes with 1 or more not defined by the object. In that case, we will     present a form for the user to add those attributes to the object.
Variables that come in as POST vars: 
  • dn (rawurlencoded)
  • new_oclass




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  David Smith

+

+


+
Includes:

+

+include_once('../../lib/security.inc') [line 50]

+security functions

include_once('../../lib/tree.inc') [line 52]

+tree functions

include_once('../../lib/config.inc') [line 54]

+access to configuration

include_once('../../lib/ldap.inc') [line 56]

+LDAP functions

include_once('../../lib/status.inc') [line 58]

+status messages


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:36 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_templates_tree_add_oclass_php.html b/lam-web/developers/phpdoc/lists/tree/_templates_tree_add_oclass_php.html
new file mode 100644
index 00000000..ad62516b
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_templates_tree_add_oclass_php.html
@@ -0,0 +1,170 @@
+
+
+Docs for page add_oclass.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: add_oclass.php

+Source Location: /templates/tree/add_oclass.php


+
+

+

+
+
+
Page Details:

+Adds an objectClass to the specified dn.

Variables that come in as POST vars:
Note, this does not do any schema violation checking. That is  performed in add_oclass_form.php.
Vars that come in as POST: 
  • dn (rawurlencoded)
  • new_oclass
  • new_attrs (array, if any)




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  David Smith

+

+


+
Includes:

+

+include_once('../../lib/security.inc') [line 49]

+security functions

include_once('../../lib/tree.inc') [line 51]

+tree functions

include_once('../../lib/config.inc') [line 53]

+access to configuration

include_once('../../lib/ldap.inc') [line 55]

+LDAP functions

include_once('../../lib/status.inc') [line 57]

+status messages


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:36 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_templates_tree_add_value_form_php.html b/lam-web/developers/phpdoc/lists/tree/_templates_tree_add_value_form_php.html
new file mode 100644
index 00000000..229c67f1
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_templates_tree_add_value_form_php.html
@@ -0,0 +1,170 @@
+
+
+Docs for page add_value_form.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: add_value_form.php

+Source Location: /templates/tree/add_value_form.php


+
+

+

+
+
+
Page Details:

+add_value_form.php  Displays a form to allow the user to enter a new value to add  to the existing list of values for a multi-valued attribute.

Variables that come in as GET vars: 
  • dn (rawurlencoded)
  • attr (rawurlencoded) the attribute to which we are adding a value




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  David Smith

+

+


+
Includes:

+

+include_once('../../lib/security.inc') [line 46]

+security functions

include_once('../../lib/tree.inc') [line 48]

+tree functions

include_once('../../lib/config.inc') [line 50]

+access to configuration

include_once('../../lib/ldap.inc') [line 52]

+LDAP functions

include_once('../../lib/status.inc') [line 54]

+status messages


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:36 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_templates_tree_add_value_php.html b/lam-web/developers/phpdoc/lists/tree/_templates_tree_add_value_php.html
new file mode 100644
index 00000000..23b40b00
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_templates_tree_add_value_php.html
@@ -0,0 +1,170 @@
+
+
+Docs for page add_value.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: add_value.php

+Source Location: /templates/tree/add_value.php


+
+

+

+
+
+
Page Details:

+Adds a value to an attribute for a given dn.

Variables that come in as POST vars: 
  • dn (rawurlencoded)
  • attr (rawurlencoded) the attribute to which we are adding a value
  • new_value (form element)
  • binary
  On success, redirect to the edit_dn page.  On failure, echo an error.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  David Smith

+

+


+
Includes:

+

+include_once('../../lib/security.inc') [line 49]

+security functions

include_once('../../lib/tree.inc') [line 51]

+tree functions

include_once('../../lib/config.inc') [line 53]

+access to configuration

include_once('../../lib/ldap.inc') [line 55]

+LDAP functions

include_once('../../lib/status.inc') [line 57]

+status messages


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:36 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_templates_tree_collapse_php.html b/lam-web/developers/phpdoc/lists/tree/_templates_tree_collapse_php.html
new file mode 100644
index 00000000..bbe956ba
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_templates_tree_collapse_php.html
@@ -0,0 +1,169 @@
+
+
+Docs for page collapse.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: collapse.php

+Source Location: /templates/tree/collapse.php


+
+

+

+
+
+
Page Details:

+This script alters the session variable 'tree', collapsing it  at the dn specified in the query string.

Variables that come in as GET vars: 
  • dn (rawurlencoded)
  • server_id
  Note: this script is equal and opposite to expand.php




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  David Smith

+

+


+
Includes:

+

+include_once('../../lib/security.inc') [line 48]

+security functions

include_once('../../lib/tree.inc') [line 50]

+tree functions

include_once('../../lib/config.inc') [line 52]

+access to configuration

include_once('../../lib/ldap.inc') [line 54]

+LDAP functions


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:39 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_templates_tree_create_form_php.html b/lam-web/developers/phpdoc/lists/tree/_templates_tree_create_form_php.html
new file mode 100644
index 00000000..0cae6331
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_templates_tree_create_form_php.html
@@ -0,0 +1,171 @@
+
+
+Docs for page create_form.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: create_form.php

+Source Location: /templates/tree/create_form.php


+
+

+

+
+
+
Page Details:

+The menu where the user chooses an RDN, Container, and Template for creating a new entry.

After submitting this form, the user is taken to their chosen Template handler.
Variables that come in as GET vars 
  • container (rawurlencoded) (optional)




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  David Smith

+

+


+
Includes:

+

+include_once('../../lib/tree.inc') [line 47]

+tree functions

include_once('../../lib/security.inc') [line 45]

+security functions

include_once('../../lib/config.inc') [line 49]

+access to configuration

include_once('../../lib/ldap.inc') [line 51]

+LDAP functions

include_once('templates/templates.inc') [line 55]

+template configuration

include_once('../../lib/status.inc') [line 53]

+status messages


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:41 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_templates_tree_create_php.html b/lam-web/developers/phpdoc/lists/tree/_templates_tree_create_php.html
new file mode 100644
index 00000000..eac1fe9e
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_templates_tree_create_php.html
@@ -0,0 +1,171 @@
+
+
+Docs for page create.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: create.php

+Source Location: /templates/tree/create.php


+
+

+

+
+
+
Page Details:

+Creates a new object.

Variables that come in as POST vars: 
  • new_dn
  • attrs (an array of attributes)
  • vals (an array of values for the above attrs)
  • required_attrs (an array with indices being the attributes,
+		      and the values being their respective values)
  • object_classes (rawurlencoded, and serialized array of objectClasses)




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  David Smith

+

+


+
Includes:

+

+include_once('../../lib/security.inc') [line 49]

+security functions

include_once('../../lib/tree.inc') [line 51]

+tree functions

include_once('../../lib/config.inc') [line 53]

+access to configuration

include_once('../../lib/ldap.inc') [line 55]

+LDAP functions

include_once('../../lib/status.inc') [line 57]

+status messages


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:41 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_templates_tree_creation_template_php.html b/lam-web/developers/phpdoc/lists/tree/_templates_tree_creation_template_php.html
new file mode 100644
index 00000000..098b594c
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_templates_tree_creation_template_php.html
@@ -0,0 +1,172 @@
+
+
+Docs for page creation_template.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: creation_template.php

+Source Location: /templates/tree/creation_template.php


+
+

+

+
+
+
Page Details:

+This file simply acts as a plugin grabber for the creator templates in  the directory templates/creation/

Expected POST vars:   template




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  David Smith

+

+


+
Includes:

+

+include($handler) [line 93]

+include_once('../../lib/config.inc') [line 48]

+access to configuration

include_once('../../lib/security.inc') [line 44]

+security functions

include_once('../../lib/tree.inc') [line 46]

+tree functions

include_once('../../lib/ldap.inc') [line 50]

+LDAP functions

include_once('templates/templates.inc') [line 54]

+template configuration

include_once('../../lib/status.inc') [line 52]

+status messages


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:41 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_templates_tree_delete_attr_php.html b/lam-web/developers/phpdoc/lists/tree/_templates_tree_delete_attr_php.html
new file mode 100644
index 00000000..89302503
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_templates_tree_delete_attr_php.html
@@ -0,0 +1,170 @@
+
+
+Docs for page delete_attr.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: delete_attr.php

+Source Location: /templates/tree/delete_attr.php


+
+

+

+
+
+
Page Details:

+Deletes an attribute from an entry with NO confirmation.

On success, redirect to edit.php   On failure, echo an error.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  David Smith

+

+


+
Includes:

+

+include_once('../../lib/security.inc') [line 44]

+security functions

include_once('../../lib/tree.inc') [line 46]

+tree functions

include_once('../../lib/config.inc') [line 48]

+access to configuration

include_once('../../lib/ldap.inc') [line 50]

+LDAP functions

include_once('../../lib/status.inc') [line 52]

+status messages


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:42 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_templates_tree_delete_form_php.html b/lam-web/developers/phpdoc/lists/tree/_templates_tree_delete_form_php.html
new file mode 100644
index 00000000..40b37ced
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_templates_tree_delete_form_php.html
@@ -0,0 +1,170 @@
+
+
+Docs for page delete_form.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: delete_form.php

+Source Location: /templates/tree/delete_form.php


+
+

+

+
+
+
Page Details:

+Displays a last chance confirmation form to delete a dn.

Variables that come in as GET vars: 
  • dn (rawurlencoded)




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  David Smith

+

+


+
Includes:

+

+include_once('../../lib/security.inc') [line 44]

+security functions

include_once('../../lib/tree.inc') [line 46]

+tree functions

include_once('../../lib/config.inc') [line 48]

+access to configuration

include_once('../../lib/ldap.inc') [line 50]

+LDAP functions

include_once('../../lib/status.inc') [line 52]

+status messages


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:42 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_templates_tree_delete_php.html b/lam-web/developers/phpdoc/lists/tree/_templates_tree_delete_php.html
new file mode 100644
index 00000000..2c7c4d0f
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_templates_tree_delete_php.html
@@ -0,0 +1,170 @@
+
+
+Docs for page delete.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: delete.php

+Source Location: /templates/tree/delete.php


+
+

+

+
+
+
Page Details:

+Deletes a DN and presents a "job's done" message.

Variables that come in as POST vars: 
  • dn (rawurlencoded)




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  David Smith

+

+


+
Includes:

+

+include_once('../../lib/security.inc') [line 44]

+security functions

include_once('../../lib/tree.inc') [line 46]

+tree functions

include_once('../../lib/config.inc') [line 48]

+access to configuration

include_once('../../lib/ldap.inc') [line 50]

+LDAP functions

include_once('../../lib/status.inc') [line 52]

+status messages


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:41 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_templates_tree_download_binary_attr_php.html b/lam-web/developers/phpdoc/lists/tree/_templates_tree_download_binary_attr_php.html
new file mode 100644
index 00000000..c152cfee
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_templates_tree_download_binary_attr_php.html
@@ -0,0 +1,170 @@
+
+
+Docs for page download_binary_attr.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: download_binary_attr.php

+Source Location: /templates/tree/download_binary_attr.php


+
+

+

+
+
+
Page Details:

+Used to send binary values to user.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  David Smith

+

+


+
Includes:

+

+include_once('../../lib/security.inc') [line 41]

+security functions

include_once('../../lib/tree.inc') [line 43]

+tree functions

include_once('../../lib/config.inc') [line 45]

+access to configuration

include_once('../../lib/ldap.inc') [line 47]

+LDAP functions

include_once('../../lib/status.inc') [line 49]

+status messages


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:42 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_templates_tree_edit_php.html b/lam-web/developers/phpdoc/lists/tree/_templates_tree_edit_php.html
new file mode 100644
index 00000000..92b7b971
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_templates_tree_edit_php.html
@@ -0,0 +1,171 @@
+
+
+Docs for page edit.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: edit.php

+Source Location: /templates/tree/edit.php


+
+

+

+
+
+
Page Details:

+Displays the specified dn from the specified server for editing

Variables that come in as GET vars: 
  • dn (rawurlencoded)
  • modified_attrs (optional) an array of attributes to highlight as
+                              they were changed by the last operation




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  David Smith

+

+


+
Includes:

+

+include_once('../../lib/security.inc') [line 46]

+security functions

include_once('../../lib/tree.inc') [line 48]

+tree functions

include_once('../../lib/config.inc') [line 50]

+access to configuration

include_once('../../lib/ldap.inc') [line 52]

+LDAP functions

include_once('../../lib/status.inc') [line 54]

+status messages


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:42 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_templates_tree_expand_php.html b/lam-web/developers/phpdoc/lists/tree/_templates_tree_expand_php.html
new file mode 100644
index 00000000..1ff6867f
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_templates_tree_expand_php.html
@@ -0,0 +1,169 @@
+
+
+Docs for page expand.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: expand.php

+Source Location: /templates/tree/expand.php


+
+

+

+
+
+
Page Details:

+This script alters the session variable 'tree', expanding it  at the dn specified in the query string.

Variables that come in as GET vars: 
  • dn (rawurlencoded)
  Note: this script is equal and opposite to collapse.php




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  David Smith

+

+


+
Includes:

+

+include_once('../../lib/security.inc') [line 47]

+security functions

include_once('../../lib/tree.inc') [line 49]

+tree functions

include_once('../../lib/config.inc') [line 51]

+access to configuration

include_once('../../lib/ldap.inc') [line 53]

+LDAP functions


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:42 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_templates_tree_export_form_php.html b/lam-web/developers/phpdoc/lists/tree/_templates_tree_export_form_php.html
new file mode 100644
index 00000000..f6135d55
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_templates_tree_export_form_php.html
@@ -0,0 +1,195 @@
+
+
+Docs for page export_form.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: export_form.php

+Source Location: /templates/tree/export_form.php


+
+

+

+
+
+
Page Details:

+export_form.php  --------------------

Html form to choose an export format(ldif,...)




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  The phpLDAPadmin development team

+

+


+
Includes:

+

+include_once('../../lib/security.inc') [line 44]

+security functions

include_once('../../lib/config.inc') [line 48]

+access to configuration

include_once('../../lib/ldap.inc') [line 50]

+LDAP functions

include_once('../../lib/status.inc') [line 52]

+status messages

require('../../lib/export.inc') [line 46]

+export functions


+


+


+

+  

+	
+	
get_line_end_format [line 181]

+	

+    

+    

+		String get_line_end_format(
+)
+    

+    


+
+		Helper functoin for fetching the line end format.




+
Tags:

+

+
+  
+    
+  
+
return:  'win', 'unix', or 'mac' based on the user's browser..

+

+    


+	
+
+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:45 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_templates_tree_export_php.html b/lam-web/developers/phpdoc/lists/tree/_templates_tree_export_php.html
new file mode 100644
index 00000000..84448d53
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_templates_tree_export_php.html
@@ -0,0 +1,171 @@
+
+
+Docs for page export.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: export.php

+Source Location: /templates/tree/export.php


+
+

+

+
+
+
Page Details:

+


+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  The phpLDAPadmin development team

+

+


+
Includes:

+

+include_once('../../lib/ldap.inc') [line 47]

+LDAP functions

include_once('../../lib/config.inc') [line 45]

+access to configuration

include_once('../../lib/status.inc') [line 49]

+status messages

include_once('../../lib/security.inc') [line 39]

+security functions

require('../../lib/export.inc') [line 41]

+export functions

require('../../lib/tree.inc') [line 43]

+common functions


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:44 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_templates_tree_rdelete_php.html b/lam-web/developers/phpdoc/lists/tree/_templates_tree_rdelete_php.html
new file mode 100644
index 00000000..d2f1cd99
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_templates_tree_rdelete_php.html
@@ -0,0 +1,186 @@
+
+
+Docs for page rdelete.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: rdelete.php

+Source Location: /templates/tree/rdelete.php


+
+

+

+
+
+
Page Details:

+Recursively deletes the specified DN and all of its children  Variables that come in as POST vars: 
  • dn (rawurlencoded)





+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  David Smith

+

+


+
Includes:

+

+include_once('../../lib/tree.inc') [line 45]

+tree functions

include_once('../../lib/security.inc') [line 43]

+security functions

include_once('../../lib/config.inc') [line 47]

+access to configuration

include_once('../../lib/ldap.inc') [line 49]

+LDAP functions

include_once('../../lib/status.inc') [line 51]

+status messages


+


+


+

+  

+	
+	
pla_rdelete [line 126]

+	

+    

+    

+		void pla_rdelete(
+mixed $dn)
+    

+    


+
+		    


+	
+
+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:00 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_templates_tree_refresh_php.html b/lam-web/developers/phpdoc/lists/tree/_templates_tree_refresh_php.html
new file mode 100644
index 00000000..fd02adbe
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_templates_tree_refresh_php.html
@@ -0,0 +1,169 @@
+
+
+Docs for page refresh.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: refresh.php

+Source Location: /templates/tree/refresh.php


+
+

+

+
+
+
Page Details:

+This script alters the session variable 'tree', by re-querying  the LDAP server to grab the contents of every expanded container.

Variables that come in as GET vars:




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  David Smith

+

+


+
Includes:

+

+include_once('../../lib/security.inc') [line 44]

+security functions

include_once('../../lib/tree.inc') [line 46]

+tree functions

include_once('../../lib/config.inc') [line 48]

+access to configuration

include_once('../../lib/ldap.inc') [line 50]

+LDAP functions


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:01 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_templates_tree_templates_creation_custom_php.html b/lam-web/developers/phpdoc/lists/tree/_templates_tree_templates_creation_custom_php.html
new file mode 100644
index 00000000..40e5bc1e
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_templates_tree_templates_creation_custom_php.html
@@ -0,0 +1,210 @@
+
+
+Docs for page custom.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: custom.php

+Source Location: /templates/tree/templates/creation/custom.php


+
+

+

+
+
+
Page Details:

+Creates custom LDAP objects.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  David Smith

+

+


+


+


+

+  

+	
+	
get_attr_select_html [line 245]

+	

+    

+    

+		void get_attr_select_html(
+mixed $all_attrs, [mixed $highlight_attr = null])
+    

+    


+
+		Returns option values.

    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
get_binary_attr_select_html [line 264]

+	

+    

+    

+		void get_binary_attr_select_html(
+mixed $binary_attrs, [mixed $highlight_attr = null])
+    

+    


+
+		Returns option values.

    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
remove_aliases [line 285]

+	

+    

+    

+		void remove_aliases(
+mixed &$attribute_list)
+    

+    


+
+		Removes attributes from the array that are aliases for eachother

(just removes the second instance of the aliased attr)

    


+	
+
+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:41 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_templates_tree_templates_creation_new_ou_template_php.html b/lam-web/developers/phpdoc/lists/tree/_templates_tree_templates_creation_new_ou_template_php.html
new file mode 100644
index 00000000..90879a3f
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_templates_tree_templates_creation_new_ou_template_php.html
@@ -0,0 +1,162 @@
+
+
+Docs for page new_ou_template.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: new_ou_template.php

+Source Location: /templates/tree/templates/creation/new_ou_template.php


+
+

+

+
+
+
Page Details:

+Creates new OUs.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  David Smith

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:55 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_templates_tree_templates_templates_inc.html b/lam-web/developers/phpdoc/lists/tree/_templates_tree_templates_templates_inc.html
new file mode 100644
index 00000000..b76bdd80
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_templates_tree_templates_templates_inc.html
@@ -0,0 +1,162 @@
+
+
+Docs for page templates.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: templates.inc

+Source Location: /templates/tree/templates/templates.inc


+
+

+

+
+
+
Page Details:

+Configuration for creation templates.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  David Smith

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:09 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_templates_tree_tree_php.html b/lam-web/developers/phpdoc/lists/tree/_templates_tree_tree_php.html
new file mode 100644
index 00000000..29b8b8fc
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_templates_tree_tree_php.html
@@ -0,0 +1,201 @@
+
+
+Docs for page tree.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: tree.php

+Source Location: /templates/tree/tree.php


+
+

+

+
+
+
Page Details:

+This script displays the LDAP tree for all the servers that you have

in config.php. We read the session variable 'tree' to know which  dns are expanded or collapsed. No query string parameters are expected,  however, you can use a '#' offset to scroll to a given dn. The syntax is  tree.php#<rawurlencoded dn>, so if I wanted to scroll to  dc=example,dc=com for server 3, the URL would be: 	tree.php#3_dc%3Dexample%2Cdc%3Dcom




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  David Smith

+

+


+
Includes:

+

+include_once('../../lib/security.inc') [line 47]

+security functions

include_once('../../lib/tree.inc') [line 49]

+tree functions

include_once('../../lib/ldap.inc') [line 53]

+LDAP functions

include_once('../../lib/config.inc') [line 51]

+access to configuration


+


+


+

+  

+	
+	
draw_create_link [line 175]

+	

+    

+    

+		void draw_create_link(
+mixed $rdn, mixed $level, mixed $encoded_dn)
+    

+    


+
+		    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
draw_tree_html [line 102]

+	

+    

+    

+		void draw_tree_html(
+mixed $dn, [mixed $level = 0])
+    

+    


+
+		Recursively descend on the given dn and draw the tree in html

    


+	
+
+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:12 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_templates_tree_tree_view_php.html b/lam-web/developers/phpdoc/lists/tree/_templates_tree_tree_view_php.html
new file mode 100644
index 00000000..94539cd4
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_templates_tree_tree_view_php.html
@@ -0,0 +1,166 @@
+
+
+Docs for page tree_view.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: tree_view.php

+Source Location: /templates/tree/tree_view.php


+
+

+

+
+
+
Page Details:

+This file includes the main frame of the LDAP browser.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once('../../lib/security.inc') [line 34]

+security functions

include_once('../../lib/tree.inc') [line 36]

+tree functions

include_once('../../lib/config.inc') [line 38]

+access to configuration

include_once('../../lib/ldap.inc') [line 40]

+LDAP functions


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:12 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_templates_tree_update_confirm_php.html b/lam-web/developers/phpdoc/lists/tree/_templates_tree_update_confirm_php.html
new file mode 100644
index 00000000..c137ff99
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_templates_tree_update_confirm_php.html
@@ -0,0 +1,170 @@
+
+
+Docs for page update_confirm.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: update_confirm.php

+Source Location: /templates/tree/update_confirm.php


+
+

+

+
+
+
Page Details:

+Takes the results of clicking "Save" in edit.php and determines which

attributes need to be updated (ie, which ones actually changed). Then,  we present a confirmation table to the user outlining the changes they  are about to make. That form submits directly to update.php, which  makes the change.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  David Smith

+

+


+
Includes:

+

+include_once('../../lib/security.inc') [line 45]

+security functions

include_once('../../lib/tree.inc') [line 47]

+tree functions

include_once('../../lib/config.inc') [line 49]

+access to configuration

include_once('../../lib/ldap.inc') [line 51]

+LDAP functions

include_once('../../lib/account.inc') [line 53]

+common functions


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:13 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/lists/tree/_templates_tree_update_php.html b/lam-web/developers/phpdoc/lists/tree/_templates_tree_update_php.html
new file mode 100644
index 00000000..10901eeb
--- /dev/null
+++ b/lam-web/developers/phpdoc/lists/tree/_templates_tree_update_php.html
@@ -0,0 +1,170 @@
+
+
+Docs for page update.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
lists

+  		  [ class tree: lists ]
+		  [ index: lists ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					list.php
+		

+					lists.inc
+		

+					userlink.php
+		

+	  


+	subpackage tree
  

+					add_attr.php
+		

+					add_attr_form.php
+		

+					add_oclass.php
+		

+					add_oclass_form.php
+		

+					add_value.php
+		

+					add_value_form.php
+		

+					collapse.php
+		

+					create.php
+		

+					create_form.php
+		

+					creation_template.php
+		

+					custom.php
+		

+					delete.php
+		

+					delete_attr.php
+		

+					delete_form.php
+		

+					download_binary_attr.php
+		

+					edit.php
+		

+					expand.php
+		

+					export.php
+		

+					export_form.php
+		

+					new_ou_template.php
+		

+					rdelete.php
+		

+					refresh.php
+		

+					templates.inc
+		

+					tree.inc
+		

+					tree.php
+		

+					tree_view.php
+		

+					update.php
+		

+					update_confirm.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		lamGroupList

+	    		lamHostList

+	    		lamList

+	    		lamMailAliasList

+	    		lamSmbDomainList

+	    		lamUserList

+	  

+                		
+      

+
+
Procedural File: update.php

+Source Location: /templates/tree/update.php


+
+

+

+
+
+
Page Details:

+Updates or deletes a value from a specified   attribute for a specified dn.

Variables that come in on the query string: 
  • dn (rawurlencoded)
  • update_array (an array in the form expected by PHP's ldap_modify, except for deletions)
+     (will never be empty: update_confirm.php ensures that)
  Attribute deletions:  To specify that an attribute is to be deleted (whether multi- or single-valued),   enter that attribute in the update array like this: attr => ''. For example, to   delete the 'sn' attribute from an entry, the update array would look like this:   Array (      sn => ''   )
On success, redirect to edit.php  On failure, echo an error.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  David Smith

+

+


+
Includes:

+

+include_once('../../lib/security.inc') [line 57]

+security functions

include_once('../../lib/tree.inc') [line 59]

+tree functions

include_once('../../lib/config.inc') [line 61]

+access to configuration

include_once('../../lib/ldap.inc') [line 63]

+LDAP functions


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:12 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/main/_templates_delete_php.html b/lam-web/developers/phpdoc/main/_templates_delete_php.html
new file mode 100644
index 00000000..1786f21e
--- /dev/null
+++ b/lam-web/developers/phpdoc/main/_templates_delete_php.html
@@ -0,0 +1,174 @@
+
+
+Docs for page delete.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
main

+  		  [ class tree: main ]
+		  [ index: main ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					delete.php
+		

+					initsuff.php
+		

+					login.php
+		

+					logout.php
+		

+					main.php
+		

+					main_header.php
+		

+	  


+      
+      
+                		
+      

+
+
Procedural File: delete.php

+Source Location: /templates/delete.php


+
+

+

+
+
+
Page Details:

+Used to delete accounts from LDAP tree.




+
Tags:

+

+
+  
+    
+  
+
author:  Tilo Lutz

+

+


+
Includes:

+

+include_once('../lib/status.inc') [line 39]

+message displaying

include_once("../lib/security.inc") [line 33]

+security functions

include_once('../lib/config.inc') [line 37]

+current configuration options

include_once('../lib/ldap.inc') [line 41]

+LDAP connection

include_once('../lib/modules.inc') [line 45]

+module interface

include_once('../lib/lamdaemon.inc') [line 43]

+lamdaemon interface

include_once('../lib/account.inc') [line 35]

+account functions


+


+


+

+  

+	
+	
deleteDN [line 264]

+	

+    

+    

+		array deleteDN(
+string $dn)
+    

+    


+
+		Deletes a DN and all child entries.




+
Tags:

+

+
+  
+    
+  
+
return:  error messages

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $dn  DN to delete

+    	
[ Top ]



+	

+  

+	
+	
getChildCount [line 248]

+	

+    

+    

+		interger getChildCount(
+string $dn)
+    

+    


+
+		Returns the number of child entries of a DN.




+
Tags:

+

+
+  
+    
+  
+
return:  number of childs

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $dn  DN of parent

+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:42 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/main/_templates_initsuff_php.html b/lam-web/developers/phpdoc/main/_templates_initsuff_php.html
new file mode 100644
index 00000000..58cee4e1
--- /dev/null
+++ b/lam-web/developers/phpdoc/main/_templates_initsuff_php.html
@@ -0,0 +1,105 @@
+
+
+Docs for page initsuff.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
main

+  		  [ class tree: main ]
+		  [ index: main ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					delete.php
+		

+					initsuff.php
+		

+					login.php
+		

+					logout.php
+		

+					main.php
+		

+					main_header.php
+		

+	  


+      
+      
+                		
+      

+
+
Procedural File: initsuff.php

+Source Location: /templates/initsuff.php


+
+

+

+
+
+
Page Details:

+Creates main suffixes if they are missing.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once("../lib/security.inc") [line 32]

+security functions

include_once("../lib/config.inc") [line 34]

+access to configuration settings

include_once("../lib/ldap.inc") [line 36]

+LDAP access

include_once("../lib/status.inc") [line 38]

+status messages


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:49 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/main/_templates_login_php.html b/lam-web/developers/phpdoc/main/_templates_login_php.html
new file mode 100644
index 00000000..26912904
--- /dev/null
+++ b/lam-web/developers/phpdoc/main/_templates_login_php.html
@@ -0,0 +1,131 @@
+
+
+Docs for page login.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
main

+  		  [ class tree: main ]
+		  [ index: main ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					delete.php
+		

+					initsuff.php
+		

+					login.php
+		

+					logout.php
+		

+					main.php
+		

+					main_header.php
+		

+	  


+      
+      
+                		
+      

+
+
Procedural File: login.php

+Source Location: /templates/login.php


+
+

+

+
+
+
Page Details:

+Login form of LDAP Account Manager.




+
Tags:

+

+
+  
+    
+  
+
author:  Michael Duergner

+

+


+
Includes:

+

+include("./main.php") [line 400]

+include_once("../lib/selfService.inc") [line 36]

+self service functions

include_once("../lib/status.inc") [line 32]

+status messages

include_once("../lib/config.inc") [line 88]

+access to configuration options

include_once("../lib/ldap.inc") [line 367]

+include_once("../lib/security.inc") [line 34]

+security functions


+


+


+

+  

+	
+	
display_LoginPage [line 98]

+	

+    

+    

+		void display_LoginPage(
+object $config_object)
+    

+    


+
+		Displays the login window.

    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
object  $config_object  current active configuration

+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:52 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/main/_templates_logout_php.html b/lam-web/developers/phpdoc/main/_templates_logout_php.html
new file mode 100644
index 00000000..c2a0b05e
--- /dev/null
+++ b/lam-web/developers/phpdoc/main/_templates_logout_php.html
@@ -0,0 +1,104 @@
+
+
+Docs for page logout.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
main

+  		  [ class tree: main ]
+		  [ index: main ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					delete.php
+		

+					initsuff.php
+		

+					login.php
+		

+					logout.php
+		

+					main.php
+		

+					main_header.php
+		

+	  


+      
+      
+                		
+      

+
+
Procedural File: logout.php

+Source Location: /templates/logout.php


+
+

+

+
+
+
Page Details:

+User is logged off from LDAP server, session is destroyed.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once("../lib/security.inc") [line 39]

+security functions

include_once("../lib/status.inc") [line 41]

+Used to display status messages

include_once("../lib/ldap.inc") [line 43]

+LDAP settings are deleted at logout


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:52 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/main/_templates_main_header_php.html b/lam-web/developers/phpdoc/main/_templates_main_header_php.html
new file mode 100644
index 00000000..bba15cce
--- /dev/null
+++ b/lam-web/developers/phpdoc/main/_templates_main_header_php.html
@@ -0,0 +1,104 @@
+
+
+Docs for page main_header.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
main

+  		  [ class tree: main ]
+		  [ index: main ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					delete.php
+		

+					initsuff.php
+		

+					login.php
+		

+					logout.php
+		

+					main.php
+		

+					main_header.php
+		

+	  


+      
+      
+                		
+      

+
+
Procedural File: main_header.php

+Source Location: /templates/main_header.php


+
+

+

+
+
+
Page Details:

+Head frame in main window, includes links to lists etc.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once("../lib/security.inc") [line 32]

+security functions

include_once("../lib/config.inc") [line 34]

+access to configuration options

include_once("../lib/selfService.inc") [line 36]

+self service functions


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:53 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/main/_templates_main_php.html b/lam-web/developers/phpdoc/main/_templates_main_php.html
new file mode 100644
index 00000000..de95c5f5
--- /dev/null
+++ b/lam-web/developers/phpdoc/main/_templates_main_php.html
@@ -0,0 +1,102 @@
+
+
+Docs for page main.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
main

+  		  [ class tree: main ]
+		  [ index: main ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					delete.php
+		

+					initsuff.php
+		

+					login.php
+		

+					logout.php
+		

+					main.php
+		

+					main_header.php
+		

+	  


+      
+      
+                		
+      

+
+
Procedural File: main.php

+Source Location: /templates/main.php


+
+

+

+
+
+
Page Details:

+This is the main window. The user and group lists will be shown in this frameset.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once('../lib/cache.inc') [line 32]

+LDAP attibute cache


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:53 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/media/background.png b/lam-web/developers/phpdoc/media/background.png
new file mode 100644
index 00000000..638060d2
Binary files /dev/null and b/lam-web/developers/phpdoc/media/background.png differ
diff --git a/lam-web/developers/phpdoc/media/empty.png b/lam-web/developers/phpdoc/media/empty.png
new file mode 100644
index 00000000..b26eb55a
Binary files /dev/null and b/lam-web/developers/phpdoc/media/empty.png differ
diff --git a/lam-web/developers/phpdoc/media/style.css b/lam-web/developers/phpdoc/media/style.css
new file mode 100644
index 00000000..5859cc8c
--- /dev/null
+++ b/lam-web/developers/phpdoc/media/style.css
@@ -0,0 +1,195 @@
+.php {
+	padding: 1em;
+}
+.php-src { font-family: 'Courier New', Courier, monospace; font-weight: normal; }
+
+body
+{
+  color:              #000000;
+  background-color:   #ffffff;
+  background-image:   url("background.png");
+  background-repeat:  repeat-y;
+  font-family:        tahoma, verdana, arial, sans-serif;
+  font-size:          10pt;
+  margin:             0;
+  padding:            0;
+}
+
+a
+{
+  color:              #000099;
+  background-color:   transparent;
+  text-decoration:    none;
+}
+
+a:hover
+{
+  text-decoration:    underline;
+}
+
+a.menu
+{
+  color:              #ffffff;
+  background-color:   transparent;
+}
+
+td
+{
+  font-size:          10pt;
+}
+
+td.header_top
+{
+  color:              #ffffff;
+  background-color:   #9999cc;
+  font-size:          16pt;
+  font-weight:        bold;
+  text-align:         right;
+  padding:            10px;
+}
+
+td.header_line
+{
+  color:              #ffffff;
+  background-color:   #333366;
+}
+
+td.header_menu
+{
+  color:              #ffffff;
+  background-color:   #666699;
+  font-size:          8pt;
+  text-align:         right;
+  padding:            2px;
+  padding-right:      5px;
+}
+
+td.menu
+{
+  padding:            2px;
+  padding-left:       5px;
+}
+
+td.code_border
+{
+  color:              #000000;
+  background-color:   #c0c0c0;
+}
+
+td.code
+{
+  color:              #000000;
+  background-color:   #f0f0f0;
+}
+
+td.type
+{
+  font-style:         italic;
+}
+
+div.credit
+{
+  font-size:          8pt;
+  text-align:         center;
+}
+
+div.package
+{
+  padding-left:       5px;
+}
+
+div.tags
+{
+  padding-left:       15px;
+}
+
+div.function
+{
+  padding-left:       15px;
+}
+
+div.top
+{
+  font-size:          8pt;
+}
+
+div.warning
+{
+  color:              #ff0000;
+  background-color:   transparent;
+}
+
+div.description
+{
+  padding-left:       15px;
+}
+
+hr
+{
+  height:             1px;
+  border-style:       solid;
+  border-color:       #c0c0c0;
+  margin-top:         10px;
+  margin-bottom:      10px;
+}
+
+span.smalllinenumber
+{
+  font-size:          8pt;
+}
+
+ul {
+	margin-left:		0px;
+	padding-left:		8px;
+}
+/* Syntax highlighting */
+
+.src-code { background-color: #f5f5f5; border: 1px solid #ccc9a4; padding: 0px; margin : 0px;
+            font-family: 'Courier New', Courier, monospace; font-weight: normal; }
+.src-line {  font-family: 'Courier New', Courier, monospace; font-weight: normal; }
+
+.src-comm { color: green; }
+.src-id {  }
+.src-inc { color: #0000FF; }
+.src-key { color: #0000FF; }
+.src-num { color: #CC0000; }
+.src-str { color: #66cccc; }
+.src-sym { font-weight: bold; }
+.src-var { }
+
+.src-php { font-weight: bold; }
+
+.src-doc { color: #009999 }
+.src-doc-close-template { color: #0000FF }
+.src-doc-coretag { color: #0099FF; font-weight: bold }
+.src-doc-inlinetag { color: #0099FF }
+.src-doc-internal { color: #6699cc }
+.src-doc-tag { color: #0080CC }
+.src-doc-template { color: #0000FF }
+.src-doc-type { font-style: italic }
+.src-doc-var { font-style: italic }
+
+.tute-tag { color: #009999 }
+.tute-attribute-name { color: #0000FF }
+.tute-attribute-value { color: #0099FF }
+.tute-entity { font-weight: bold; }
+.tute-comment { font-style: italic }
+.tute-inline-tag { color: #636311; font-weight: bold }
+
+/* tutorial */
+
+.authors {  }
+.author { font-style: italic; font-weight: bold }
+.author-blurb { margin: .5em 0em .5em 2em; font-size: 85%; font-weight: normal; font-style: normal }
+.example { border: 1px dashed #999999; background-color: #EEEEEE; padding: .5em; }
+.listing { border: 1px dashed #999999; background-color: #EEEEEE; padding: .5em; white-space: nowrap; }
+.release-info { font-size: 85%; font-style: italic; margin: 1em 0em }
+.ref-title-box {  }
+.ref-title {  }
+.ref-purpose { font-style: italic; color: #666666 }
+.ref-synopsis {  }
+.title { font-weight: bold; margin: 1em 0em 0em 0em; padding: .25em; border: 2px solid #999999; background-color: #9999CC  }
+.cmd-synopsis { margin: 1em 0em }
+.cmd-title { font-weight: bold }
+.toc { margin-left: 2em; padding-left: 0em }
+
diff --git a/lam-web/developers/phpdoc/modules/_lib_baseModule_inc.html b/lam-web/developers/phpdoc/modules/_lib_baseModule_inc.html
new file mode 100644
index 00000000..3a2c3f56
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/_lib_baseModule_inc.html
@@ -0,0 +1,153 @@
+
+
+Docs for page baseModule.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Procedural File: baseModule.inc

+Source Location: /lib/baseModule.inc


+
+

+

+
+

+
Classes:

+
baseModule

+	
Parent class of all account modules

+



+
+
Page Details:

+This is the parent class for all account modules.

It implements the complete module interface and uses meta-data  provided by the account modules for its functions.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:36 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/_lib_createntlm_inc.html b/lam-web/developers/phpdoc/modules/_lib_createntlm_inc.html
new file mode 100644
index 00000000..f66d8e55
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/_lib_createntlm_inc.html
@@ -0,0 +1,153 @@
+
+
+Docs for page createntlm.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Procedural File: createntlm.inc

+Source Location: /lib/createntlm.inc


+
+

+

+
+

+
Classes:

+
smbHash

+	
Calculates NT and LM hashes.

+



+
+
Page Details:

+This class provides functions to calculate Samba NT and LM hashes.

The code is a conversion from createntlm.pl (Benjamin Kuit) and smbdes.c/md4.c (Andrew Tridgell).




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:41 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/_lib_lamdaemon_inc.html b/lam-web/developers/phpdoc/modules/_lib_lamdaemon_inc.html
new file mode 100644
index 00000000..a864e337
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/_lib_lamdaemon_inc.html
@@ -0,0 +1,217 @@
+
+
+Docs for page lamdaemon.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Procedural File: lamdaemon.inc

+Source Location: /lib/lamdaemon.inc


+
+

+

+
+
+
Page Details:

+This file includes functions to control lamdaemon.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  Tilo Lutz

+

+


+


+


+

+  

+	
+	
lamdaemon [line 40]

+	

+    

+    

+		array lamdaemon(
+array $commands)
+    

+    


+
+		Sends commands to lamdaemon script.




+
Tags:

+

+
+  
+    
+  
+
return:  Output of lamdaemon

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
array  $commands  List of command lines

+    	
[ Top ]



+	

+  

+	
+	
lamdaemonSSH [line 109]

+	

+    

+    

+		array lamdaemonSSH(
+array $commands)
+    

+    


+
+		Sends commands to lamdaemon script via PHP SSH functions.




+
Tags:

+

+
+  
+    
+  
+
return:  Output of lamdaemon

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
array  $commands  List of command lines

+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:50 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_account_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_account_inc.html
new file mode 100644
index 00000000..f8b503ed
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/_lib_modules_account_inc.html
@@ -0,0 +1,159 @@
+
+
+Docs for page account.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Procedural File: account.inc

+Source Location: /lib/modules/account.inc


+
+

+

+
+

+
Classes:

+
account

+	
Manages the object class "account" for users and hosts.

+



+
+
Page Details:

+Manages the object class "account" for users and hosts.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+  
+    
+  
+
author:  Michael Duergner
author:  Roland Gruber
author:  Tilo Lutz

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_ieee802device_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_ieee802device_inc.html
new file mode 100644
index 00000000..bbd91127
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/_lib_modules_ieee802device_inc.html
@@ -0,0 +1,153 @@
+
+
+Docs for page ieee802device.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Procedural File: ieee802device.inc

+Source Location: /lib/modules/ieee802device.inc


+
+

+

+
+

+
Classes:

+
ieee802Device

+	
Provides MAC addresses for hosts.

+



+
+
Page Details:

+Provides MAC addresses for hosts.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:47 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_inc.html
new file mode 100644
index 00000000..3bafb2a0
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/_lib_modules_inc.html
@@ -0,0 +1,878 @@
+
+
+Docs for page modules.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Procedural File: modules.inc

+Source Location: /lib/modules.inc


+
+

+

+
+

+
Classes:

+
accountContainer

+	
This class includes all modules and attributes of an account.

+



+
+
Page Details:

+Interface between modules and other parts of LAM.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  Michael Duergner
author:  Tilo Lutz

+

+


+
Includes:

+

+include_once("lamdaemon.inc") [line 43]

+lamdaemon functions

include_once("baseModule.inc") [line 39]

+parent class of account modules

include_once("cache.inc") [line 35]

+LDAP caches

include_once("account.inc") [line 37]

+some helper functions

include_once($modulesINC_dirname.'/'.$entry) [line 55]

+This includes all module files.

include_once("ldap.inc") [line 41]

+access to LDAP server

include_once("security.inc") [line 45]

+security functions


+


+


+

+  

+	
+	
buildUploadAccounts [line 394]

+	

+    

+    

+		mixed buildUploadAccounts(
+string $scope, array $data, array $ids)
+    

+    


+
+		This function builds the LDAP accounts for the file upload.

If there are problems status messages will be printed automatically.




+
Tags:

+

+
+  
+    
+  
+
return:  array including accounts or false if there were errors

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $scope  account type
array  $data  array containing one account in each element
array  $ids  array(<column_name> => <column number>)

+    	
[ Top ]



+	

+  

+	
+	
checkConfigOptions [line 319]

+	

+    

+    

+		array checkConfigOptions(
+array $scopes, array $options)
+    

+    


+
+		Checks if the configuration options are valid




+
Tags:

+

+
+  
+    
+  
+
return:  list of error messages

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
array  $scopes  hash array (module name => array(account types))
array  $options  hash array containing all options (name => array(...))

+    	
[ Top ]



+	

+  

+	
+	
checkProfileOptions [line 285]

+	

+    

+    

+		array checkProfileOptions(
+string $scope, array $options)
+    

+    


+
+		Checks if the profile options are valid




+
Tags:

+

+
+  
+    
+  
+
return:  list of error messages

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $scope  account type (user, group, host)
array  $options  hash array containing all options (name => array(...))

+    	
[ Top ]



+	

+  

+	
+	
check_module_conflicts [line 229]

+	

+    

+    

+		boolean check_module_conflicts(
+array $selected, array $deps)
+    

+    


+
+		Checks if there are conflicts between modules




+
Tags:

+

+
+  
+    
+  
+
return:  false if no conflict was found,  otherwise an array of array(selected module, conflicting module) if conflicts were found

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
array  $selected  selected module names
array  $deps  module dependencies

+    	
[ Top ]



+	

+  

+	
+	
check_module_depends [line 188]

+	

+    

+    

+		mixed check_module_depends(
+array $selected, array $deps)
+    

+    


+
+		Checks if there are missing dependencies between modules.




+
Tags:

+

+
+  
+    
+  
+
return:  false if no misssing dependency was found,  otherwise an array of array(selected module, depending module) if missing dependencies were found

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
array  $selected  selected module names
array  $deps  module dependencies

+    	
[ Top ]



+	

+  

+	
+	
doUploadPostActions [line 474]

+	

+    

+    

+		array doUploadPostActions(
+string $scope, array $data, array $ids, array $failed)
+    

+    


+
+		This function executes one post upload action.




+
Tags:

+

+
+  
+    
+  
+
return:  current status  
 array (  
  'status' => 'finished' | 'inProgress'  
  'module' => <name of active module>  
  'progress' => 0..100  
  'errors' => array (<array of parameters for StatusMessage>)  
 )

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $scope  account type
array  $data  array containing one account in each element
array  $ids  array(<column_name> => <column number>)
array  $failed  list of accounts which were not created successfully

+    	
[ Top ]



+	

+  

+	
+	
getAvailableModules [line 248]

+	

+    

+    

+		array getAvailableModules(
+string $scope)
+    

+    


+
+		Returns an array with all available user module names




+
Tags:

+

+
+  
+    
+  
+
return:  list of possible modules

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $scope  account type (user, group, host)

+    	
[ Top ]



+	

+  

+	
+	
getAvailablePDFFields [line 348]

+	

+    

+    

+		array getAvailablePDFFields(
+string $scope)
+    

+    


+
+		Returns a list of available PDF entries.




+
Tags:

+

+
+  
+    
+  
+
return:  PDF entries

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $scope  account type (user, group, host)

+    	
[ Top ]



+	

+  

+	
+	
getConfigOptions [line 302]

+	

+    

+    

+		array getConfigOptions(
+array $scopes)
+    

+    


+
+		Returns a hash array (module name => elements) of all module options for the configuration page.




+
Tags:

+

+
+  
+    
+  
+
return:  configuration options

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
array  $scopes  hash array (module name => array(account types))

+    	
[ Top ]



+	

+  

+	
+	
getHelp [line 337]

+	

+    

+    

+		array getHelp(
+string $module, string $helpID, [mixed $scope = ''])
+    

+    


+
+		Returns a help entry from an account module.




+
Tags:

+

+
+  
+    
+  
+
return:  help entry

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $helpID  help identifier
string  $module  module name

+    	
[ Top ]



+	

+  

+	
+	
getModuleAlias [line 65]

+	

+    

+    

+		string getModuleAlias(
+string $name, string $scope)
+    

+    


+
+		Returns the alias name of a module




+
Tags:

+

+
+  
+    
+  
+
return:  alias name

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $name  the module name
string  $scope  the account type ("user", "group", "host")

+    	
[ Top ]



+	

+  

+	
+	
getModulesDependencies [line 170]

+	

+    

+    

+		array getModulesDependencies(
+string $scope)
+    

+    


+
+		Returns a hash array (module name => dependencies) of all module dependencies

"dependencies" contains an array with two sub arrays: depends, conflicts  
The elements of "depends" are either module names or an array of module names (OR-case).  
The elements of conflicts are module names.




+
Tags:

+

+
+  
+    
+  
+
return:  dependencies

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $scope  the account type (user, group, host)

+    	
[ Top ]



+	

+  

+	
+	
getProfileOptions [line 268]

+	

+    

+    

+		array getProfileOptions(
+string $scope)
+    

+    


+
+		Returns the elements for the profile page.




+
Tags:

+

+
+  
+    
+  
+
return:  profile elements

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $scope  account type (user, group, host)

+    	
[ Top ]



+	

+  

+	
+	
getRDNAttributes [line 120]

+	

+    

+    

+		array getRDNAttributes(
+string $scope)
+    

+    


+
+		Returns a list of LDAP attributes which can be used to form the RDN.

The list is already sorted by the priority given by the nodules.




+
Tags:

+

+
+  
+    
+  
+
return:  list of LDAP attributes

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $scope  account type (user, group, host)

+    	
[ Top ]



+	

+  

+	
+	
getRequiredExtensions [line 510]

+	

+    

+    

+		array getRequiredExtensions(
+)
+    

+    


+
+		Returns true if the module is a base module




+
Tags:

+

+
+  
+    
+  
+
return:  required extensions

+

+    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
getUploadColumns [line 374]

+	

+    

+    

+		array getUploadColumns(
+string $scope)
+    

+    


+
+		Returns an array containing all input columns for the file upload.

Syntax:  
 array(  
  string: name,  // fixed non-translated name which is used as column name (should be of format: <module name>_<column name>)  
  string: description,  // short descriptive name  
  string: help,  // help ID  
  string: example,  // example value  
  boolean: required  // true, if user must set a value for this column  
 )




+
Tags:

+

+
+  
+    
+  
+
return:  column list

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $scope  account type

+    	
[ Top ]



+	

+  

+	
+	
get_ldap_filter [line 88]

+	

+    

+    

+		string get_ldap_filter(
+string $scope)
+    

+    


+
+		Returns the LDAP filter used by the account lists




+
Tags:

+

+
+  
+    
+  
+
return:  LDAP filter

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $scope  the account type ("user", "group", "host")

+    	
[ Top ]



+	

+  

+	
+	
is_base_module [line 77]

+	

+    

+    

+		boolean is_base_module(
+string $name, string $scope)
+    

+    


+
+		Returns true if the module is a base module




+
Tags:

+

+
+  
+    
+  
+
return:  true if base module

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $name  the module name
string  $scope  the account type ("user", "group", "host")

+    	
[ Top ]



+	

+  

+	
+	
parseHtml [line 538]

+	

+    

+    

+		array parseHtml(
+string $module, array $input, array $values, boolean $restricted, integer &$tabindex, integer &$tabindexLink, string $scope)
+    

+    


+
+		Takes a list of meta-HTML elements and prints the equivalent HTML output.




+
Tags:

+

+
+  
+    
+  
+
return:  List of input field names and their type (name => type)

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $module  Name of account module
array  $input  List of meta-HTML elements
array  $values  List of values which override the defaults in $input (name => value)
boolean  $restricted  If true then no buttons will be displayed
integer  $tabindex  Start value of tabulator index for input fields
integer  $tabindexLink  Start value of tabulator index for links
string  $scope  Account type

+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:53 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_inetLocalMailRecipient_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_inetLocalMailRecipient_inc.html
new file mode 100644
index 00000000..fc18b647
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/_lib_modules_inetLocalMailRecipient_inc.html
@@ -0,0 +1,153 @@
+
+
+Docs for page inetLocalMailRecipient.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Procedural File: inetLocalMailRecipient.inc

+Source Location: /lib/modules/inetLocalMailRecipient.inc


+
+

+

+
+

+
Classes:

+
inetLocalMailRecipient

+	
Provides mail routing for users.

+



+
+
Page Details:

+Provides mail routing for user accounts.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:48 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_inetOrgPerson_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_inetOrgPerson_inc.html
new file mode 100644
index 00000000..943569b4
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/_lib_modules_inetOrgPerson_inc.html
@@ -0,0 +1,159 @@
+
+
+Docs for page inetOrgPerson.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Procedural File: inetOrgPerson.inc

+Source Location: /lib/modules/inetOrgPerson.inc


+
+

+

+
+

+
Classes:

+
inetOrgPerson

+	
This class contains all account LDAP attributes  and funtioncs required to deal with inetOrgPerson.

+



+
+
Page Details:

+Manages the atrributes of object class inetOrgPerson.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+  
+    
+  
+
author:  Michael Duergner
author:  Roland Gruber
author:  Tilo Lutz

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:48 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_kolabUser_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_kolabUser_inc.html
new file mode 100644
index 00000000..dc783956
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/_lib_modules_kolabUser_inc.html
@@ -0,0 +1,153 @@
+
+
+Docs for page kolabUser.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Procedural File: kolabUser.inc

+Source Location: /lib/modules/kolabUser.inc


+
+

+

+
+

+
Classes:

+
kolabUser

+	
Manages Kolab user accounts.

+



+
+
Page Details:

+Manages Kolab user accounts.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:49 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_ldapPublicKey_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_ldapPublicKey_inc.html
new file mode 100644
index 00000000..95e6f756
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/_lib_modules_ldapPublicKey_inc.html
@@ -0,0 +1,156 @@
+
+
+Docs for page ldapPublicKey.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Procedural File: ldapPublicKey.inc

+Source Location: /lib/modules/ldapPublicKey.inc


+
+

+

+
+

+
Classes:

+
ldapPublicKey

+	
Manages SSH public keys.

+



+
+
Page Details:

+Manages SSH public keys.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Andrew Dibble <mailto:adibble@mobitv.com>
author:  Roland Gruber

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:51 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_nisMailAlias_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_nisMailAlias_inc.html
new file mode 100644
index 00000000..9888c50f
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/_lib_modules_nisMailAlias_inc.html
@@ -0,0 +1,153 @@
+
+
+Docs for page nisMailAlias.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Procedural File: nisMailAlias.inc

+Source Location: /lib/modules/nisMailAlias.inc


+
+

+

+
+

+
Classes:

+
nisMailAlias

+	
Provides NIS mail alias management.

+



+
+
Page Details:

+Provides NIS mail alias management.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:55 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_posixAccount_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_posixAccount_inc.html
new file mode 100644
index 00000000..5a61a7e2
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/_lib_modules_posixAccount_inc.html
@@ -0,0 +1,159 @@
+
+
+Docs for page posixAccount.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Procedural File: posixAccount.inc

+Source Location: /lib/modules/posixAccount.inc


+
+

+

+
+

+
Classes:

+
posixAccount

+	
Manages the object class "posixAccount" for users and hosts.

+



+
+
Page Details:

+Manages Unix accounts for users and hosts.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+  
+    
+  
+
author:  Michael Duergner
author:  Roland Gruber
author:  Tilo Lutz

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:56 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_posixGroup_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_posixGroup_inc.html
new file mode 100644
index 00000000..aed05f4c
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/_lib_modules_posixGroup_inc.html
@@ -0,0 +1,159 @@
+
+
+Docs for page posixGroup.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Procedural File: posixGroup.inc

+Source Location: /lib/modules/posixGroup.inc


+
+

+

+
+

+
Classes:

+
posixGroup

+	
Manages the object class "posixGroup" for groups.

+



+
+
Page Details:

+Manages Unix accounts for groups.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+  
+    
+  
+
author:  Michael Duergner
author:  Roland Gruber
author:  Tilo Lutz

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:58 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_quota_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_quota_inc.html
new file mode 100644
index 00000000..7d47cf4c
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/_lib_modules_quota_inc.html
@@ -0,0 +1,159 @@
+
+
+Docs for page quota.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Procedural File: quota.inc

+Source Location: /lib/modules/quota.inc


+
+

+

+
+

+
Classes:

+
quota

+	
Manages quotas for users and groups.

+



+
+
Page Details:

+Manages quotas for users and groups.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+  
+    
+  
+
author:  Michael Duergner
author:  Roland Gruber
author:  Tilo Lutz

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:00 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_sambaAccount_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_sambaAccount_inc.html
new file mode 100644
index 00000000..1a696231
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/_lib_modules_sambaAccount_inc.html
@@ -0,0 +1,159 @@
+
+
+Docs for page sambaAccount.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Procedural File: sambaAccount.inc

+Source Location: /lib/modules/sambaAccount.inc


+
+

+

+
+

+
Classes:

+
sambaAccount

+	
Manages the object class "sambaAccount" for users and hosts.

+



+
+
Page Details:

+Manages Samba 2 accounts for users and hosts.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+  
+    
+  
+
author:  Michael Duergner
author:  Roland Gruber
author:  Tilo Lutz

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:01 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_sambaDomain_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_sambaDomain_inc.html
new file mode 100644
index 00000000..1f13c2a6
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/_lib_modules_sambaDomain_inc.html
@@ -0,0 +1,153 @@
+
+
+Docs for page sambaDomain.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Procedural File: sambaDomain.inc

+Source Location: /lib/modules/sambaDomain.inc


+
+

+

+
+

+
Classes:

+
sambaDomain

+	
Manages Samba 3 domain entries.

+



+
+
Page Details:

+Manages Samba 3 domain entries.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:02 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_sambaGroupMapping_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_sambaGroupMapping_inc.html
new file mode 100644
index 00000000..0a40469d
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/_lib_modules_sambaGroupMapping_inc.html
@@ -0,0 +1,159 @@
+
+
+Docs for page sambaGroupMapping.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Procedural File: sambaGroupMapping.inc

+Source Location: /lib/modules/sambaGroupMapping.inc


+
+

+

+
+

+
Classes:

+
sambaGroupMapping

+	
Manages the object class "sambaGroupMapping" for groups.

+



+
+
Page Details:

+Manages Samba 3 accounts for groups.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+  
+    
+  
+
author:  Michael Duergner
author:  Roland Gruber
author:  Tilo Lutz

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:02 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_sambaSamAccount_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_sambaSamAccount_inc.html
new file mode 100644
index 00000000..db6e90ae
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/_lib_modules_sambaSamAccount_inc.html
@@ -0,0 +1,159 @@
+
+
+Docs for page sambaSamAccount.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Procedural File: sambaSamAccount.inc

+Source Location: /lib/modules/sambaSamAccount.inc


+
+

+

+
+

+
Classes:

+
sambaSamAccount

+	
Manages the object class "sambaSamAccount" for users and hosts.

+



+
+
Page Details:

+Manages Samba 3 accounts for users and hosts.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+  
+    
+  
+
author:  Michael Duergner
author:  Roland Gruber
author:  Tilo Lutz

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:03 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/_lib_modules_shadowAccount_inc.html b/lam-web/developers/phpdoc/modules/_lib_modules_shadowAccount_inc.html
new file mode 100644
index 00000000..ba065efd
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/_lib_modules_shadowAccount_inc.html
@@ -0,0 +1,159 @@
+
+
+Docs for page shadowAccount.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Procedural File: shadowAccount.inc

+Source Location: /lib/modules/shadowAccount.inc


+
+

+

+
+

+
Classes:

+
shadowAccount

+	
Manages the object class "shadowAccount" for users.

+



+
+
Page Details:

+Manages Unix shadow accounts for users.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+  
+    
+  
+
author:  Michael Duergner
author:  Roland Gruber
author:  Tilo Lutz

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:07 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/_templates_account_edit_php.html b/lam-web/developers/phpdoc/modules/_templates_account_edit_php.html
new file mode 100644
index 00000000..5525560c
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/_templates_account_edit_php.html
@@ -0,0 +1,157 @@
+
+
+Docs for page edit.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Procedural File: edit.php

+Source Location: /templates/account/edit.php


+
+

+

+
+
+
Page Details:

+Displays the account detail page.




+
Tags:

+

+
+  
+    
+  
+
author:  Tilo Lutz

+

+


+
Includes:

+

+include_once('../../lib/config.inc') [line 36]

+configuration options

include_once("../../lib/security.inc") [line 34]

+security functions

include_once('../../lib/profiles.inc') [line 38]

+functions to load and save profiles

include_once('../../lib/status.inc') [line 40]

+Return error-message

include_once('../../lib/modules.inc') [line 44]

+module functions

include_once('../../lib/pdf.inc') [line 42]

+Return a pdf-file


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:42 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/account.html b/lam-web/developers/phpdoc/modules/account.html
new file mode 100644
index 00000000..8ff2a8ee
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/account.html
@@ -0,0 +1,765 @@
+
+
+Docs For Class account
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Class: account

+Source Location: /lib/modules/account.inc


+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
baseModule
+   |
+   --account


+
Manages the object class "account" for users and hosts.



+
+
+
+
+
+
+        
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: baseModule

+

+

+  baseModule::$attributes
+  
+

+

+   
+

+

+  baseModule::$base
+  
+

+

+   
+

+

+  baseModule::$messages
+  
+

+

+   
+

+

+  baseModule::$meta
+  
+

+

+   
+

+

+  baseModule::$moduleSettings
+  
+

+

+   
+

+

+  baseModule::$orig
+  
+

+

+   
+

+

+  baseModule::$scope
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: baseModule

+

+    

+    baseModule::baseModule()
+
+  

+  

+    Creates a new base module class
+  

+    

+    baseModule::build_uploadAccounts()
+
+  

+  

+    In this function the LDAP account is built up.
+  

+    

+    baseModule::can_manage()
+
+  

+  

+    Returns true if this module fits for the current scope.
+  

+    

+    baseModule::checkSelfServiceOptions()
+
+  

+  

+    Checks if all input values are correct and returns the LDAP commands which should be executed.
+  

+    

+    baseModule::check_configOptions()
+
+  

+  

+    Checks input values of module settings.
+  

+    

+    baseModule::check_profileOptions()
+
+  

+  

+    Checks input values of account profiles.
+  

+    

+    baseModule::delete_attributes()
+
+  

+  

+    Dummy function for modules which use no special options on account deletion.
+  

+    

+    baseModule::display_html_delete()
+
+  

+  

+    Dummy function for modules which do not print extra HTML code on account deletion.
+  

+    

+    baseModule::doUploadPostActions()
+
+  

+  

+    This function executes one post upload action.
+  

+    

+    baseModule::getButtonStatus()
+
+  

+  

+    Controls if the module button the account page is visible and activated.
+  

+    

+    baseModule::getLDAPAliases()
+
+  

+  

+    Returns a list of aliases for LDAP attributes.
+  

+    

+    baseModule::getManagedAttributes()
+
+  

+  

+    Returns a list of LDAP attributes which are managed by this module.
+  

+    

+    baseModule::getManagedObjectClasses()
+
+  

+  

+    Returns a list of managed object classes for this module.
+  

+    

+    baseModule::getRequiredExtensions()
+
+  

+  

+    Returns a list of required PHP extensions.
+  

+    

+    baseModule::getSelfServiceFields()
+
+  

+  

+    Returns a list of possible input fields and their descriptions  Format: array(<field identifier> => <field description>)
+  

+    

+    baseModule::getSelfServiceOptions()
+
+  

+  

+    Returns the meta HTML code for each input field.
+  

+    

+    baseModule::getSelfServiceSearchAttributes()
+
+  

+  

+    Returns a list of possible search attributes for the self service.
+  

+    

+    baseModule::get_alias()
+
+  

+  

+    Returns an alias name for the module.
+  

+    

+    baseModule::get_configOptions()
+
+  

+  

+    Returns a list of elements for the configuration.
+  

+    

+    baseModule::get_dependencies()
+
+  

+  

+    This function returns a list with all depending and conflicting modules.
+  

+    

+    baseModule::get_help()
+
+  

+  

+    This function return the help entry array for a specific help id. Normally this->meta can be used.
+  

+    

+    baseModule::get_ldap_filter()
+
+  

+  

+    returns an LDAP filter for the account lists
+  

+    

+    baseModule::get_metaData()
+
+  

+  

+    Dummy function, meta data is provided by sub classes.
+  

+    

+    baseModule::get_pdfFields()
+
+  

+  

+    Returns an array with all fields available for this account type on the PDF  output. This method may be overwritten by subclasses or it may be used  by using entries in the $this->meta['PDF_fields'] array of the specific sub-  class.
+  

+    

+    baseModule::get_pdf_entries()
+
+  

+  

+    Returns a hastable with all entries that may be printed out in the PDF. The
+  

+    

+    baseModule::get_profileOptions()
+
+  

+  

+    Returns a list of elements for the account profiles.
+  

+    

+    baseModule::get_RDNAttributes()
+
+  

+  

+    Returns a list of possible LDAP attributes which can be used to form the RDN.
+  

+    

+    baseModule::get_scope()
+
+  

+  

+    Returns the account type of this module (user, group, host)
+  

+    

+    baseModule::get_uploadColumns()
+
+  

+  

+    Returns an array containing all input columns for the file upload.
+  

+    

+    baseModule::get_uploadPreDepends()
+
+  

+  

+    Returns a list of module names which must be processed in building the account befor this module.
+  

+    

+    baseModule::init()
+
+  

+  

+    Initializes the module after it became part of an accountContainer
+  

+    

+    baseModule::is_base_module()
+
+  

+  

+    Returns true if this module is enough to provide a sensible account.
+  

+    

+    baseModule::load_attributes()
+
+  

+  

+    This function loads the LDAP attributes for this module.
+  

+    

+    baseModule::load_Messages()
+
+  

+  

+    This function fills the $messages variable with output messages from this module.
+  

+    

+    baseModule::load_profile()
+
+  

+  

+    Loads the values of an account profile into internal variables.
+  

+    

+    baseModule::module_complete()
+
+  

+  

+    This functions is used to check if all settings for this module have been made.
+  

+    

+    baseModule::module_ready()
+
+  

+  

+    This function is used to check if this module page can be displayed.
+  

+    

+    baseModule::save_attributes()
+
+  

+  

+    Returns a list of modifications which have to be made to the LDAP account.
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 38]

+Manages the object class "account" for users and hosts.




+
[ Top ]


+
+
+

+
+
Class Methods

+

+
+  

+	
+	
method build_uploadAccounts [line 230]

+	

+    

+    

+		array build_uploadAccounts(
+array
+$rawAccounts, array
+$ids, array
+&$partialAccounts)
+    

+    


+	
+		In this function the LDAP account is built up.




+
Tags:

+

+
+  
+    
+  
+
return:  list of error messages if any

+

+


+
+	
+Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)

+    


+        
[ Top ]

+  

+  

+	
+	
method display_html_attributes [line 192]

+	

+    

+    

+		void display_html_attributes(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getButtonStatus [line 138]

+	

+    

+    

+		string getButtonStatus(
+)
+    

+    


+	
+		Controls if the module button the account page is visible and activated.




+
Tags:

+

+
+  
+    
+  
+
return:  status ("enabled", "disabled", "hidden")

+

+


+
+	
+Overrides baseModule::getButtonStatus() (Controls if the module button the account page is visible and activated.)


+
+        
[ Top ]

+  

+  

+	
+	
method get_metaData [line 45]

+	

+    

+    

+		array get_metaData(
+)
+    

+    


+	
+		Returns meta data that is interpreted by parent class




+
Tags:

+

+
+  
+    
+  
+
return:  array with meta data

+

+


+
+	
+Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)


+
+        
[ Top ]

+  

+  

+	
+	
method get_pdfEntries [line 215]

+	

+    

+    

+		array get_pdfEntries(
+)
+    

+    


+	
+		Returns the PDF entries for this module.




+
Tags:

+

+
+  
+    
+  
+
return:  list of possible PDF entries

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method load_Messages [line 115]

+	

+    

+    

+		void load_Messages(
+)
+    

+    


+	
+		This function fills the message array.




+
+	
+Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)


+
+        
[ Top ]

+  

+  

+	
+	
method module_complete [line 127]

+	

+    

+    

+		boolean module_complete(
+)
+    

+    


+	
+		This functions returns true if all needed settings are done.




+
Tags:

+

+
+  
+    
+  
+
return:  true if LDAP operation can be done

+

+


+
+	
+Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)


+
+        
[ Top ]

+  

+  

+	
+	
method process_attributes [line 174]

+	

+    

+    

+		array process_attributes(
+)
+    

+    


+	
+		Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




+
Tags:

+

+
+  
+    
+  
+
return:  list of info/error messages

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method save_attributes [line 157]

+	

+    

+    

+		void save_attributes(
+)
+    

+    


+	
+		


+
+	
+Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)


+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/accountContainer.html b/lam-web/developers/phpdoc/modules/accountContainer.html
new file mode 100644
index 00000000..e4739468
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/accountContainer.html
@@ -0,0 +1,739 @@
+
+
+Docs For Class accountContainer
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Class: accountContainer

+Source Location: /lib/modules.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+


+
This class includes all modules and attributes of an account.



+
+
+
+
+
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+

+

+
+
+
Class Details

+

+[line 709]

+This class includes all modules and attributes of an account.




+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$attributes = 

+	
[line 737]

+  Array of all used attributes

Syntax is attribute => array ( objectClass => MUST or MAY, ...)


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$attributes_orig = 

+	
[line 758]

+  original LDAP attributes when account was loaded from LDAP


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$base = 

+	
[line 764]

+  Name of accountContainer variable in session


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$current_page = 

+	
[line 767]

+  This variable stores the name of the currently displayed page


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$dn = 

+	
[line 749]

+  DN suffix of the account


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$dn_orig = 

+	
[line 752]

+  DN suffix of account when it was loaded


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$isNewAccount = 

+	
[line 773]

+  True if this is a newly created account


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$module = 

+	
[line 746]

+  This is an array with all module objects


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$order = 

+	
[line 761]

+  Module order


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$rdn = 

+	
[line 755]

+  RDN attribute of this account


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$subpage = 

+	
[line 770]

+  This variable is set to the pagename of a subpage if it should be displayed


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$type = 

+	
[line 743]

+  This variale stores the account type.

Currently "user", "group" and "host" are supported.


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor accountContainer [line 716]

+	

+    

+    

+		accountContainer accountContainer(
+string
+$type, string
+$base)
+    

+    


+	
+		Constructor




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
string  $type  account type
string  $base  key in $_SESSION where this object is saved

+    


+        
[ Top ]

+  

+  

+	
+	
method continue_main [line 789]

+	

+    

+    

+		void continue_main(
+)
+    

+    


+	
+		This function is called when the user clicks on any button on the account pages.

It prints the HTML code of each account page.




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method fixLDAPAttributes [line 1207]

+	

+    

+    

+		array fixLDAPAttributes(
+array
+$attributes, array
+$modules)
+    

+    


+	
+		Fixes spelling errors in the attribute names.




+
Tags:

+

+
+  
+    
+  
+
return:  fixed attributes

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $attributes  LDAP attributes
array  $modules  list of active modules

+    


+        
[ Top ]

+  

+  

+	
+	
method get_pdfEntries [line 1523]

+	

+    

+    

+		list get_pdfEntries(
+)
+    

+    


+	
+		Returns a list of possible PDF entries for this account.




+
Tags:

+

+
+  
+    
+  
+
return:  of PDF entries (array(<name> => <PDF lines>))

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_type [line 781]

+	

+    

+    

+		string get_type(
+)
+    

+    


+	
+		Returns the accout type of this object (e.g. user, group, host).




+
Tags:

+

+
+  
+    
+  
+
return:  account type

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method load_account [line 1148]

+	

+    

+    

+		array load_account(
+string
+$dn)
+    

+    


+	
+		Loads an LDAP account with the given DN.




+
Tags:

+

+
+  
+    
+  
+
return:  error messages

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $dn  the DN of the account

+    


+        
[ Top ]

+  

+  

+	
+	
method new_account [line 1280]

+	

+    

+    

+		void new_account(
+)
+    

+    


+	
+		This function will prepare the object for a new account.




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method save_account [line 1309]

+	

+    

+    

+		array save_account(
+)
+    

+    


+	
+		This function will save an account to the LDAP database.




+
Tags:

+

+
+  
+    
+  
+
return:  list of status messages if any errors occured

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method save_module_attributes [line 1074]

+	

+    

+    

+		array save_module_attributes(
+array
+$attributes, array
+$orig)
+    

+    


+	
+		This function checks which LDAP attributes have changed while the account was edited.




+
Tags:

+

+
+  
+    
+  
+
return:  an array which can be passed to $this->saveAccount()

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $attributes  list of current LDAP attributes
array  $orig  list of old attributes when account was loaded

+    


+        
[ Top ]

+  

+  

+	
+	
method sortModules [line 1536]

+	

+    

+    

+		void sortModules(
+)
+    

+    


+	
+		Sorts the module buttons for the account page.




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method __sleep [line 1599]

+	

+    

+    

+		array __sleep(
+)
+    

+    


+	
+		Encrypts sensitive data before storing in session.




+
Tags:

+

+
+  
+    
+  
+
return:  list of attributes which are serialized

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method __wakeup [line 1611]

+	

+    

+    

+		void __wakeup(
+)
+    

+    


+	
+		Decrypts sensitive data after accountContainer was loaded from session.




+
+	
+
+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:54 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/baseModule.html b/lam-web/developers/phpdoc/modules/baseModule.html
new file mode 100644
index 00000000..98f821fd
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/baseModule.html
@@ -0,0 +1,2068 @@
+
+
+Docs For Class baseModule
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Class: baseModule

+Source Location: /lib/baseModule.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+


+
Parent class of all account modules



+
+
+
+
+
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+

+
Child classes:

+

+

+
account

+	
Manages the object class "account" for users and hosts.

+

+

+
ieee802Device

+	
Provides MAC addresses for hosts.

+

+

+
posixGroup

+	
Manages the object class "posixGroup" for groups.

+

+

+
quota

+	
Manages quotas for users and groups.

+

+

+
sambaAccount

+	
Manages the object class "sambaAccount" for users and hosts.

+

+

+
sambaSamAccount

+	
Manages the object class "sambaSamAccount" for users and hosts.

+

+

+
posixAccount

+	
Manages the object class "posixAccount" for users and hosts.

+

+

+
kolabUser

+	
Manages Kolab user accounts.

+

+

+
sambaGroupMapping

+	
Manages the object class "sambaGroupMapping" for groups.

+

+

+
shadowAccount

+	
Manages the object class "shadowAccount" for users.

+

+

+
ldapPublicKey

+	
Manages SSH public keys.

+

+

+
sambaDomain

+	
Manages Samba 3 domain entries.

+

+

+
inetOrgPerson

+	
This class contains all account LDAP attributes  and funtioncs required to deal with inetOrgPerson.

+

+

+
inetLocalMailRecipient

+	
Provides mail routing for users.

+

+

+
nisMailAlias

+	
Provides NIS mail alias management.

+

+

+

+

+
+
+
Class Details

+

+[line 40]

+Parent class of all account modules




+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$attributes = 

+	
[line 55]

+  contains all ldap attributes which should be written


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$base = 

+	
[line 52]

+  name of parent accountContainer ($_SESSION[$base])


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$messages = 

+	
[line 61]

+  contains all error messages of a module


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$meta = 

+	
[line 43]

+  includes all meta data provided by the sub class


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$moduleSettings = 

+	
[line 49]

+  configuration settings of all modules


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$orig = 

+	
[line 58]

+  contains all ldap attributes which are loaded from ldap


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$scope = 

+	
[line 46]

+  the account type of this module (user, group, host)


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor baseModule [line 68]

+	

+    

+    

+		baseModule baseModule(
+string
+$scope)
+    

+    


+	
+		Creates a new base module class




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $scope  the account type (user, group, host)

+    


+        
[ Top ]

+  

+  

+	
+	
method build_uploadAccounts [line 490]

+	

+    

+    

+		array build_uploadAccounts(
+array
+$rawAccounts, array
+$ids, array
+&$partialAccounts)
+    

+    


+	
+		In this function the LDAP account is built up.




+
Tags:

+

+
+  
+    
+  
+
return:  list of error messages if any

+

+


+
+	
Overridden in child classes as:

+		

+	
account::build_uploadAccounts()

+		
In this function the LDAP account is built up.

+	

+		

+	
ieee802Device::build_uploadAccounts()

+		
In this function the LDAP account is built up.

+	

+		

+	
posixGroup::build_uploadAccounts()

+		
In this function the LDAP account is built up.

+	

+		

+	
sambaAccount::build_uploadAccounts()

+		
In this function the LDAP account is built up.

+	

+		

+	
sambaSamAccount::build_uploadAccounts()

+		
In this function the LDAP account is built up.

+	

+		

+	
posixAccount::build_uploadAccounts()

+		
In this function the LDAP account is built up.

+	

+		

+	
kolabUser::build_uploadAccounts()

+		
In this function the LDAP account is built up.

+	

+		

+	
sambaGroupMapping::build_uploadAccounts()

+		
In this function the LDAP account is built up.

+	

+		

+	
shadowAccount::build_uploadAccounts()

+		
In this function the LDAP account is built up.

+	

+		

+	
ldapPublicKey::build_uploadAccounts()

+		
In this function the LDAP account is built up.

+	

+		

+	
sambaDomain::build_uploadAccounts()

+		
In this function the LDAP account is built up.

+	

+		

+	
inetOrgPerson::build_uploadAccounts()

+		
In this function the LDAP account is built up.

+	

+		

+	
inetLocalMailRecipient::build_uploadAccounts()

+		
In this function the LDAP account is built up.

+	

+		

+	
nisMailAlias::build_uploadAccounts()

+		
In this function the LDAP account is built up.

+	

+	

+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)

+    


+        
[ Top ]

+  

+  

+	
+	
method can_manage [line 155]

+	

+    

+    

+		boolean can_manage(
+)
+    

+    


+	
+		Returns true if this module fits for the current scope.




+
Tags:

+

+
+  
+    
+  
+
return:  true if module fits

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method checkSelfServiceOptions [line 684]

+	

+    

+    

+		array checkSelfServiceOptions(
+string
+$fields, array
+$attributes)
+    

+    


+	
+		Checks if all input values are correct and returns the LDAP commands which should be executed.




+
Tags:

+

+
+  
+    
+  
+
return:  messages and LDAP commands (array('messages' => array(), 'add' => array(), 'del' => array(), 'mod' => array()))

+

+


+
+	
Overridden in child classes as:

+		

+	
sambaSamAccount::checkSelfServiceOptions()

+		
Checks if all input values are correct and returns the LDAP commands which should be executed.

+	

+		

+	
posixAccount::checkSelfServiceOptions()

+		
Checks if all input values are correct and returns the LDAP commands which should be executed.

+	

+		

+	
inetOrgPerson::checkSelfServiceOptions()

+		
Checks if all input values are correct and returns the LDAP commands which should be executed.

+	

+	

+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
string  $fields  input fields
array  $attributes  LDAP attributes

+    


+        
[ Top ]

+  

+  

+	
+	
method check_configOptions [line 350]

+	

+    

+    

+		array check_configOptions(
+array
+$scopes, array
+$options)
+    

+    


+	
+		Checks input values of module settings.




+
Tags:

+

+
+  
+    
+  
+
return:  list of error messages

+

+


+
+	
Overridden in child classes as:

+		

+	
posixAccount::check_configOptions()

+		
Checks input values of module settings.

+	

+	

+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $scopes  list of account types which are used
array  $options  hash array containing the settings (array('option' => array('value')))

+    


+        
[ Top ]

+  

+  

+	
+	
method check_profileOptions [line 235]

+	

+    

+    

+		array check_profileOptions(
+array
+$options)
+    

+    


+	
+		Checks input values of account profiles.




+
Tags:

+

+
+  
+    
+  
+
return:  list of error messages (array(type, title, text)) to generate StatusMessages, if any

+

+


+
+	
Overridden in child classes as:

+		

+	
quota::check_profileOptions()

+		
Checks input values of account profiles.

+	

+	

+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
array  $options  a hash array (name => value) containing the options

+    


+        
[ Top ]

+  

+  

+	
+	
method delete_attributes [line 586]

+	

+    

+    

+		List delete_attributes(
+)
+    

+    


+	
+		Dummy function for modules which use no special options on account deletion.




+
Tags:

+

+
+  
+    
+  
+
return:  of LDAP operations, same as for save_attributes()

+

+


+
+	
Overridden in child classes as:

+		

+	
posixGroup::delete_attributes()

+		

+	

+		

+	
quota::delete_attributes()

+		

+	

+		

+	
posixAccount::delete_attributes()

+		
Additional LDAP operations on delete.

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method display_html_delete [line 595]

+	

+    

+    

+		meta display_html_delete(
+)
+    

+    


+	
+		Dummy function for modules which do not print extra HTML code on account deletion.




+
Tags:

+

+
+  
+    
+  
+
return:  HTML code

+

+


+
+	
Overridden in child classes as:

+		

+	
posixAccount::display_html_delete()

+		

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method doUploadPostActions [line 558]

+	

+    

+    

+		array doUploadPostActions(
+array
+$data, array
+$ids, array
+$failed, array
+&$temp)
+    

+    


+	
+		This function executes one post upload action.




+
Tags:

+

+
+  
+    
+  
+
return:  current status  
 array (  
  'status' => 'finished' | 'inProgress'  
  'progress' => 0..100  
  'errors' => array (<array of parameters for StatusMessage>)  
 )

+

+


+
+	
Overridden in child classes as:

+		

+	
quota::doUploadPostActions()

+		
This function executes one post upload action.

+	

+		

+	
posixAccount::doUploadPostActions()

+		
This function executes one post upload action.

+	

+	

+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $data  array containing one account in each element
array  $ids  array(<column_name> => <column number>)
array  $failed  list of accounts which were not created successfully
array  $temp  variable to store temporary data between two post actions

+    


+        
[ Top ]

+  

+  

+	
+	
method getButtonStatus [line 540]

+	

+    

+    

+		string getButtonStatus(
+)
+    

+    


+	
+		Controls if the module button the account page is visible and activated.




+
Tags:

+

+
+  
+    
+  
+
return:  status ("enabled", "disabled", "hidden")

+

+


+
+	
Overridden in child classes as:

+		

+	
account::getButtonStatus()

+		
Controls if the module button the account page is visible and activated.

+	

+		

+	
posixGroup::getButtonStatus()

+		
Controls if the module button the account page is visible and activated.

+	

+		

+	
inetOrgPerson::getButtonStatus()

+		
Controls if the module button the account page is visible and activated.

+	

+		

+	
nisMailAlias::getButtonStatus()

+		
Controls if the module button the account page is visible and activated.

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getLDAPAliases [line 616]

+	

+    

+    

+		array getLDAPAliases(
+)
+    

+    


+	
+		Returns a list of aliases for LDAP attributes.

All alias attributes will be renamed to the given attribute names.




+
Tags:

+

+
+  
+    
+  
+
return:  list of aliases (alias name => attribute name)

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getManagedAttributes [line 627]

+	

+    

+    

+		array getManagedAttributes(
+)
+    

+    


+	
+		Returns a list of LDAP attributes which are managed by this module.

All attribute names will be renamed to match the given spelling.




+
Tags:

+

+
+  
+    
+  
+
return:  list of attributes

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getManagedObjectClasses [line 605]

+	

+    

+    

+		array getManagedObjectClasses(
+)
+    

+    


+	
+		Returns a list of managed object classes for this module.

This is used to fix incorrect spelled object class names.




+
Tags:

+

+
+  
+    
+  
+
return:  list of object classes

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getRequiredExtensions [line 637]

+	

+    

+    

+		array getRequiredExtensions(
+)
+    

+    


+	
+		Returns a list of required PHP extensions.




+
Tags:

+

+
+  
+    
+  
+
return:  extensions

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getSelfServiceFields [line 658]

+	

+    

+    

+		array getSelfServiceFields(
+)
+    

+    


+	
+		Returns a list of possible input fields and their descriptions  Format: array(<field identifier> => <field description>)




+
Tags:

+

+
+  
+    
+  
+
return:  fields

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getSelfServiceOptions [line 672]

+	

+    

+    

+		array getSelfServiceOptions(
+array
+$fields, array
+$attributes)
+    

+    


+	
+		Returns the meta HTML code for each input field.

format: array(<field1> => array(<META HTML>), ...)  It is not possible to display help links.




+
Tags:

+

+
+  
+    
+  
+
return:  meta HTML

+

+


+
+	
Overridden in child classes as:

+		

+	
posixAccount::getSelfServiceOptions()

+		
Returns the meta HTML code for each input field.

+	

+		

+	
inetOrgPerson::getSelfServiceOptions()

+		
Returns the meta HTML code for each input field.

+	

+	

+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $fields  list of active fields
array  $attributes  attributes of LDAP account (attribute names in lower case)

+    


+        
[ Top ]

+  

+  

+	
+	
method getSelfServiceSearchAttributes [line 647]

+	

+    

+    

+		array getSelfServiceSearchAttributes(
+)
+    

+    


+	
+		Returns a list of possible search attributes for the self service.




+
Tags:

+

+
+  
+    
+  
+
return:  attributes

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_alias [line 190]

+	

+    

+    

+		string get_alias(
+)
+    

+    


+	
+		Returns an alias name for the module.

This alias is used in various places instead of the less descriptive class name.  The alias also has less syntax restrictions and may contain spaces or special characters.




+
Tags:

+

+
+  
+    
+  
+
return:  alias name

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_configOptions [line 334]

+	

+    

+    

+		array get_configOptions(
+array
+$scopes, array
+$allScopes)
+    

+    


+	
+		Returns a list of elements for the configuration.




+
Tags:

+

+
+  
+    
+  
+
return:  configuration elements

+

+


+
+	
Overridden in child classes as:

+		

+	
posixGroup::get_configOptions()

+		
Returns a list of elements for the configuration.

+	

+	

+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $scopes  account types (user, group, host)
array  $allScopes  list of all modules and active scopes

+    


+        
[ Top ]

+  

+  

+	
+	
method get_dependencies [line 214]

+	

+    

+    

+		array get_dependencies(
+)
+    

+    


+	
+		This function returns a list with all depending and conflicting modules.




+
Tags:

+

+
+  
+    
+  
+
return:  list of dependencies and conflicts

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_help [line 504]

+	

+    

+    

+		array get_help(
+string
+$id, string
+$scope)
+    

+    


+	
+		This function return the help entry array for a specific help id. Normally this->meta can be used.




+
Tags:

+

+
+  
+    
+  
+
return:  The desired help entry.

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
string  $id  The id string for the help entry needed.
string  $scope  The scope for which the help entry should be retrieved. May be empty when  there is now difference of the help entry depending on the actual scope.

+    


+        
[ Top ]

+  

+  

+	
+	
method get_ldap_filter [line 177]

+	

+    

+    

+		string get_ldap_filter(
+)
+    

+    


+	
+		returns an LDAP filter for the account lists




+
Tags:

+

+
+  
+    
+  
+
return:  LDAP filter

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_metaData [line 137]

+	

+    

+    

+		array get_metaData(
+)
+    

+    


+	
+		Dummy function, meta data is provided by sub classes.




+
Tags:

+

+
+  
+    
+  
+
return:  empty array

+

+


+
+	
Overridden in child classes as:

+		

+	
account::get_metaData()

+		
Returns meta data that is interpreted by parent class

+	

+		

+	
ieee802Device::get_metaData()

+		
Returns meta data that is interpreted by parent class

+	

+		

+	
posixGroup::get_metaData()

+		
Returns meta data that is interpreted by parent class

+	

+		

+	
quota::get_metaData()

+		
Returns meta data that is interpreted by parent class

+	

+		

+	
sambaAccount::get_metaData()

+		
Returns meta data that is interpreted by parent class

+	

+		

+	
sambaSamAccount::get_metaData()

+		
Returns meta data that is interpreted by parent class

+	

+		

+	
posixAccount::get_metaData()

+		
Returns meta data that is interpreted by parent class

+	

+		

+	
kolabUser::get_metaData()

+		
Returns meta data that is interpreted by parent class

+	

+		

+	
sambaGroupMapping::get_metaData()

+		
Returns meta data that is interpreted by parent class

+	

+		

+	
shadowAccount::get_metaData()

+		
Returns meta data that is interpreted by parent class

+	

+		

+	
ldapPublicKey::get_metaData()

+		
Returns meta data that is interpreted by parent class

+	

+		

+	
sambaDomain::get_metaData()

+		
Returns meta data that is interpreted by parent class

+	

+		

+	
inetOrgPerson::get_metaData()

+		
Returns meta data that is interpreted by parent class

+	

+		

+	
inetLocalMailRecipient::get_metaData()

+		
Returns meta data that is interpreted by parent class

+	

+		

+	
nisMailAlias::get_metaData()

+		
Returns meta data that is interpreted by parent class

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_pdfFields [line 434]

+	

+    

+    

+		array get_pdfFields(
+string
+$scope)
+    

+    


+	
+		Returns an array with all fields available for this account type on the PDF  output. This method may be overwritten by subclasses or it may be used  by using entries in the $this->meta['PDF_fields'] array of the specific sub-  class.




+
Tags:

+

+
+  
+    
+  
+
return:  list of available fields for PDF output

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $scope  account type

+    


+        
[ Top ]

+  

+  

+	
+	
method get_pdf_entries [line 449]

+	

+    

+    

+		array get_pdf_entries(
+[string
+$scope = 'user'])
+    

+    


+	
+		Returns a hastable with all entries that may be printed out in the PDF. The

syntax of the hashtable is specified by the module specification and the  corresponding DTD. This method must be overwritten in case that there  are non static things to be returned. The $this->meta['PDF_entries'] array  may be used when there is only static content.




+
Tags:

+

+
+  
+    
+  
+
return:  hastable of entries for the PDF. Each entry is an array where  each entry is treated as a new line in the PDF.

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $scope  account type

+    


+        
[ Top ]

+  

+  

+	
+	
method get_profileOptions [line 224]

+	

+    

+    

+		profile get_profileOptions(
+)
+    

+    


+	
+		Returns a list of elements for the account profiles.




+
Tags:

+

+
+  
+    
+  
+
return:  elements

+

+


+
+	
Overridden in child classes as:

+		

+	
quota::get_profileOptions()

+		
Returns a list of elements for the account profiles.

+	

+		

+	
sambaSamAccount::get_profileOptions()

+		
Returns a list of elements for the account profiles.

+	

+		

+	
posixAccount::get_profileOptions()

+		
Returns a list of elements for the account profiles.

+	

+		

+	
sambaGroupMapping::get_profileOptions()

+		
Returns a list of elements for the account profiles.

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_RDNAttributes [line 204]

+	

+    

+    

+		array get_RDNAttributes(
+)
+    

+    


+	
+		Returns a list of possible LDAP attributes which can be used to form the RDN.

The returned elements have this form: <attribute> => <priority>  
 <attribute> is the name of the LDAP attribute  
 <priority> defines the priority of the attribute (can be "low", "normal", "high")




+
Tags:

+

+
+  
+    
+  
+
return:  list of attributes

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_scope [line 146]

+	

+    

+    

+		string get_scope(
+)
+    

+    


+	
+		Returns the account type of this module (user, group, host)




+
Tags:

+

+
+  
+    
+  
+
return:  account type

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_uploadColumns [line 467]

+	

+    

+    

+		array get_uploadColumns(
+)
+    

+    


+	
+		Returns an array containing all input columns for the file upload.

Syntax:  
 array(  
  string: name,  // fixed non-translated name which is used as column name (should be of format: <module name>_<column name>)  
  string: description,  // short descriptive name  
  string: help,  // help ID  
  string: example,  // example value  
  boolean: required  // true, if user must set a value for this column  
 )




+
Tags:

+

+
+  
+    
+  
+
return:  column list

+

+


+
+	
Overridden in child classes as:

+		

+	
quota::get_uploadColumns()

+		
Returns an array containing all input columns for the file upload.

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_uploadPreDepends [line 477]

+	

+    

+    

+		array get_uploadPreDepends(
+)
+    

+    


+	
+		Returns a list of module names which must be processed in building the account befor this module.




+
Tags:

+

+
+  
+    
+  
+
return:  list of module names

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method init [line 86]

+	

+    

+    

+		void init(
+string
+$base)
+    

+    


+	
+		Initializes the module after it became part of an accountContainer




+
+	
Overridden in child classes as:

+		

+	
posixGroup::init()

+		
This functin will be called when the module will be loaded *

+	

+		

+	
quota::init()

+		

+	

+		

+	
sambaAccount::init()

+		
Initializes the module after it became part of an accountContainer

+	

+		

+	
sambaSamAccount::init()

+		
Initializes the module after it became part of an accountContainer

+	

+		

+	
posixAccount::init()

+		

+	

+		

+	
sambaGroupMapping::init()

+		
Initializes the module after it became part of an accountContainer

+	

+	

+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $base  the name of the accountContainer object ($_SESSION[$base])

+    


+        
[ Top ]

+  

+  

+	
+	
method is_base_module [line 167]

+	

+    

+    

+		boolean is_base_module(
+)
+    

+    


+	
+		Returns true if this module is enough to provide a sensible account.

There is no relation to the name of this class.




+
Tags:

+

+
+  
+    
+  
+
return:  true if base module

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method load_attributes [line 105]

+	

+    

+    

+		void load_attributes(
+array
+$attributes)
+    

+    


+	
+		This function loads the LDAP attributes for this module.




+
+	
Overridden in child classes as:

+		

+	
quota::load_attributes()

+		

+	

+		

+	
sambaAccount::load_attributes()

+		

+	

+		

+	
sambaSamAccount::load_attributes()

+		

+	

+		

+	
posixAccount::load_attributes()

+		
This function loads all needed LDAP attributes.

+	

+	

+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
array  $attributes  attribute list

+    


+        
[ Top ]

+  

+  

+	
+	
method load_Messages [line 78]

+	

+    

+    

+		void load_Messages(
+)
+    

+    


+	
+		This function fills the $messages variable with output messages from this module.




+
+	
Overridden in child classes as:

+		

+	
account::load_Messages()

+		
This function fills the message array.

+	

+		

+	
ieee802Device::load_Messages()

+		
This function fills the error message array with messages

+	

+		

+	
posixGroup::load_Messages()

+		
This function fills the $messages variable with output messages from this module.

+	

+		

+	
quota::load_Messages()

+		
this functin fills the error message array with messages

+	

+		

+	
sambaAccount::load_Messages()

+		
this functin fills the error message array with messages

+	

+		

+	
sambaSamAccount::load_Messages()

+		
this functin fills the error message array with messages

+	

+		

+	
posixAccount::load_Messages()

+		
This function fills the error message array with messages.

+	

+		

+	
kolabUser::load_Messages()

+		
This function fills the error message array with messages

+	

+		

+	
sambaGroupMapping::load_Messages()

+		
this functin fills the error message array with messages

+	

+		

+	
shadowAccount::load_Messages()

+		
This function builds up the message array.

+	

+		

+	
sambaDomain::load_Messages()

+		
This function fills the error message array with messages

+	

+		

+	
inetOrgPerson::load_Messages()

+		
This function fills the message array.

+	

+		

+	
inetLocalMailRecipient::load_Messages()

+		
This function fills the error message array with messages

+	

+		

+	
nisMailAlias::load_Messages()

+		
This function fills the error message array with messages

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method load_profile [line 316]

+	

+    

+    

+		void load_profile(
+array
+$profile)
+    

+    


+	
+		Loads the values of an account profile into internal variables.




+
+	
Overridden in child classes as:

+		

+	
quota::load_profile()

+		
Loads the values of an account profile into internal variables.

+	

+		

+	
sambaAccount::load_profile()

+		
Loads the values of an account profile into internal variables.

+	

+		

+	
sambaSamAccount::load_profile()

+		
Loads the values of an account profile into internal variables.

+	

+		

+	
posixAccount::load_profile()

+		
Loads the values of an account profile into internal variables.

+	

+		

+	
sambaGroupMapping::load_profile()

+		
Loads the values of an account profile into internal variables.

+	

+		

+	
shadowAccount::load_profile()

+		
Loads the values of an account profile into internal variables.

+	

+	

+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
array  $profile  hash array with profile values (identifier => value)

+    


+        
[ Top ]

+  

+  

+	
+	
method module_complete [line 531]

+	

+    

+    

+		boolean module_complete(
+)
+    

+    


+	
+		This functions is used to check if all settings for this module have been made.




+
Tags:

+

+
+  
+    
+  
+
return:  true, if settings are complete

+

+


+
+	
Overridden in child classes as:

+		

+	
account::module_complete()

+		
This functions returns true if all needed settings are done.

+	

+		

+	
posixGroup::module_complete()

+		
This functions is used to check if all settings for this module have been made.

+	

+		

+	
quota::module_complete()

+		

+	

+		

+	
sambaAccount::module_complete()

+		
This functions returns true if all needed settings are done

+	

+		

+	
sambaSamAccount::module_complete()

+		
This functions is used to check if all settings for this module have been made.

+	

+		

+	
posixAccount::module_complete()

+		
This functions is used to check if all settings for this module have been made.

+	

+		

+	
kolabUser::module_complete()

+		
This function returns true if all needed settings are done.

+	

+		

+	
sambaGroupMapping::module_complete()

+		

+	

+		

+	
inetOrgPerson::module_complete()

+		
This functions return true if all needed settings are done.

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method module_ready [line 522]

+	

+    

+    

+		boolean module_ready(
+)
+    

+    


+	
+		This function is used to check if this module page can be displayed.

It returns false if a module depends on data from other modules which was not yet entered.




+
Tags:

+

+
+  
+    
+  
+
return:  true, if page can be displayed

+

+


+
+	
Overridden in child classes as:

+		

+	
quota::module_ready()

+		

+	

+		

+	
sambaAccount::module_ready()

+		

+	

+		

+	
sambaSamAccount::module_ready()

+		
This function is used to check if this module page can be displayed.

+	

+		

+	
sambaGroupMapping::module_ready()

+		

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method save_attributes [line 577]

+	

+    

+    

+		array save_attributes(
+)
+    

+    


+	
+		Returns a list of modifications which have to be made to the LDAP account.




+
Tags:

+

+
+  
+    
+  
+
return:  list of modifications  
This function returns an array with 3 entries:  
array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )  
DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)  
"add" are attributes which have to be added to LDAP entry  
"remove" are attributes which have to be removed from LDAP entry  
"modify" are attributes which have to been modified in LDAP entry

+

+


+
+	
Overridden in child classes as:

+		

+	
account::save_attributes()

+		

+	

+		

+	
posixGroup::save_attributes()

+		

+	

+		

+	
quota::save_attributes()

+		

+	

+		

+	
sambaAccount::save_attributes()

+		

+	

+		

+	
sambaSamAccount::save_attributes()

+		

+	

+		

+	
posixAccount::save_attributes()

+		
Returns a list of modifications which have to be made to the LDAP account.

+	

+		

+	
kolabUser::save_attributes()

+		
Returns a list of modifications which have to be made to the LDAP account.

+	

+		

+	
sambaGroupMapping::save_attributes()

+		

+	

+		

+	
shadowAccount::save_attributes()

+		
Returns a list of modifications which have to be made to the LDAP account.

+	

+		

+	
inetOrgPerson::save_attributes()

+		

+	

+		

+	
nisMailAlias::save_attributes()

+		
Returns a list of modifications which have to be made to the LDAP account.

+	

+	

+	
+
+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:36 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/ieee802Device.html b/lam-web/developers/phpdoc/modules/ieee802Device.html
new file mode 100644
index 00000000..b8c318ae
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/ieee802Device.html
@@ -0,0 +1,690 @@
+
+
+Docs For Class ieee802Device
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Class: ieee802Device

+Source Location: /lib/modules/ieee802device.inc


+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
baseModule
+   |
+   --ieee802Device


+
Provides MAC addresses for hosts.



+
+
+
+
+
+
+        
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: baseModule

+

+

+  baseModule::$attributes
+  
+

+

+   
+

+

+  baseModule::$base
+  
+

+

+   
+

+

+  baseModule::$messages
+  
+

+

+   
+

+

+  baseModule::$meta
+  
+

+

+   
+

+

+  baseModule::$moduleSettings
+  
+

+

+   
+

+

+  baseModule::$orig
+  
+

+

+   
+

+

+  baseModule::$scope
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: baseModule

+

+    

+    baseModule::baseModule()
+
+  

+  

+    Creates a new base module class
+  

+    

+    baseModule::build_uploadAccounts()
+
+  

+  

+    In this function the LDAP account is built up.
+  

+    

+    baseModule::can_manage()
+
+  

+  

+    Returns true if this module fits for the current scope.
+  

+    

+    baseModule::checkSelfServiceOptions()
+
+  

+  

+    Checks if all input values are correct and returns the LDAP commands which should be executed.
+  

+    

+    baseModule::check_configOptions()
+
+  

+  

+    Checks input values of module settings.
+  

+    

+    baseModule::check_profileOptions()
+
+  

+  

+    Checks input values of account profiles.
+  

+    

+    baseModule::delete_attributes()
+
+  

+  

+    Dummy function for modules which use no special options on account deletion.
+  

+    

+    baseModule::display_html_delete()
+
+  

+  

+    Dummy function for modules which do not print extra HTML code on account deletion.
+  

+    

+    baseModule::doUploadPostActions()
+
+  

+  

+    This function executes one post upload action.
+  

+    

+    baseModule::getButtonStatus()
+
+  

+  

+    Controls if the module button the account page is visible and activated.
+  

+    

+    baseModule::getLDAPAliases()
+
+  

+  

+    Returns a list of aliases for LDAP attributes.
+  

+    

+    baseModule::getManagedAttributes()
+
+  

+  

+    Returns a list of LDAP attributes which are managed by this module.
+  

+    

+    baseModule::getManagedObjectClasses()
+
+  

+  

+    Returns a list of managed object classes for this module.
+  

+    

+    baseModule::getRequiredExtensions()
+
+  

+  

+    Returns a list of required PHP extensions.
+  

+    

+    baseModule::getSelfServiceFields()
+
+  

+  

+    Returns a list of possible input fields and their descriptions  Format: array(<field identifier> => <field description>)
+  

+    

+    baseModule::getSelfServiceOptions()
+
+  

+  

+    Returns the meta HTML code for each input field.
+  

+    

+    baseModule::getSelfServiceSearchAttributes()
+
+  

+  

+    Returns a list of possible search attributes for the self service.
+  

+    

+    baseModule::get_alias()
+
+  

+  

+    Returns an alias name for the module.
+  

+    

+    baseModule::get_configOptions()
+
+  

+  

+    Returns a list of elements for the configuration.
+  

+    

+    baseModule::get_dependencies()
+
+  

+  

+    This function returns a list with all depending and conflicting modules.
+  

+    

+    baseModule::get_help()
+
+  

+  

+    This function return the help entry array for a specific help id. Normally this->meta can be used.
+  

+    

+    baseModule::get_ldap_filter()
+
+  

+  

+    returns an LDAP filter for the account lists
+  

+    

+    baseModule::get_metaData()
+
+  

+  

+    Dummy function, meta data is provided by sub classes.
+  

+    

+    baseModule::get_pdfFields()
+
+  

+  

+    Returns an array with all fields available for this account type on the PDF  output. This method may be overwritten by subclasses or it may be used  by using entries in the $this->meta['PDF_fields'] array of the specific sub-  class.
+  

+    

+    baseModule::get_pdf_entries()
+
+  

+  

+    Returns a hastable with all entries that may be printed out in the PDF. The
+  

+    

+    baseModule::get_profileOptions()
+
+  

+  

+    Returns a list of elements for the account profiles.
+  

+    

+    baseModule::get_RDNAttributes()
+
+  

+  

+    Returns a list of possible LDAP attributes which can be used to form the RDN.
+  

+    

+    baseModule::get_scope()
+
+  

+  

+    Returns the account type of this module (user, group, host)
+  

+    

+    baseModule::get_uploadColumns()
+
+  

+  

+    Returns an array containing all input columns for the file upload.
+  

+    

+    baseModule::get_uploadPreDepends()
+
+  

+  

+    Returns a list of module names which must be processed in building the account befor this module.
+  

+    

+    baseModule::init()
+
+  

+  

+    Initializes the module after it became part of an accountContainer
+  

+    

+    baseModule::is_base_module()
+
+  

+  

+    Returns true if this module is enough to provide a sensible account.
+  

+    

+    baseModule::load_attributes()
+
+  

+  

+    This function loads the LDAP attributes for this module.
+  

+    

+    baseModule::load_Messages()
+
+  

+  

+    This function fills the $messages variable with output messages from this module.
+  

+    

+    baseModule::load_profile()
+
+  

+  

+    Loads the values of an account profile into internal variables.
+  

+    

+    baseModule::module_complete()
+
+  

+  

+    This functions is used to check if all settings for this module have been made.
+  

+    

+    baseModule::module_ready()
+
+  

+  

+    This function is used to check if this module page can be displayed.
+  

+    

+    baseModule::save_attributes()
+
+  

+  

+    Returns a list of modifications which have to be made to the LDAP account.
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 35]

+Provides MAC addresses for hosts.




+
[ Top ]


+
+
+

+
+
Class Methods

+

+
+  

+	
+	
method build_uploadAccounts [line 160]

+	

+    

+    

+		array build_uploadAccounts(
+array
+$rawAccounts, array
+$ids, array
+&$partialAccounts)
+    

+    


+	
+		In this function the LDAP account is built up.




+
Tags:

+

+
+  
+    
+  
+
return:  list of error messages if any

+

+


+
+	
+Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)

+    


+        
[ Top ]

+  

+  

+	
+	
method display_html_attributes [line 92]

+	

+    

+    

+		void display_html_attributes(
+)
+    

+    


+	
+		This function will create the meta HTML code to show a page with all attributes.




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_metaData [line 42]

+	

+    

+    

+		array get_metaData(
+)
+    

+    


+	
+		Returns meta data that is interpreted by parent class




+
Tags:

+

+
+  
+    
+  
+
return:  array with meta data

+

+


+
+	
+Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)


+
+        
[ Top ]

+  

+  

+	
+	
method get_pdfEntries [line 189]

+	

+    

+    

+		array get_pdfEntries(
+)
+    

+    


+	
+		Returns the PDF entries for this module.




+
Tags:

+

+
+  
+    
+  
+
return:  list of possible PDF entries

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method load_Messages [line 83]

+	

+    

+    

+		void load_Messages(
+)
+    

+    


+	
+		This function fills the error message array with messages




+
+	
+Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)


+
+        
[ Top ]

+  

+  

+	
+	
method process_attributes [line 118]

+	

+    

+    

+		array process_attributes(
+)
+    

+    


+	
+		Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




+
Tags:

+

+
+  
+    
+  
+
return:  list of info/error messages

+

+


+
+	
+
+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:47 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/inetLocalMailRecipient.html b/lam-web/developers/phpdoc/modules/inetLocalMailRecipient.html
new file mode 100644
index 00000000..4f4918ff
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/inetLocalMailRecipient.html
@@ -0,0 +1,690 @@
+
+
+Docs For Class inetLocalMailRecipient
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Class: inetLocalMailRecipient

+Source Location: /lib/modules/inetLocalMailRecipient.inc


+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
baseModule
+   |
+   --inetLocalMailRecipient


+
Provides mail routing for users.



+
+
+
+
+
+
+        
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: baseModule

+

+

+  baseModule::$attributes
+  
+

+

+   
+

+

+  baseModule::$base
+  
+

+

+   
+

+

+  baseModule::$messages
+  
+

+

+   
+

+

+  baseModule::$meta
+  
+

+

+   
+

+

+  baseModule::$moduleSettings
+  
+

+

+   
+

+

+  baseModule::$orig
+  
+

+

+   
+

+

+  baseModule::$scope
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: baseModule

+

+    

+    baseModule::baseModule()
+
+  

+  

+    Creates a new base module class
+  

+    

+    baseModule::build_uploadAccounts()
+
+  

+  

+    In this function the LDAP account is built up.
+  

+    

+    baseModule::can_manage()
+
+  

+  

+    Returns true if this module fits for the current scope.
+  

+    

+    baseModule::checkSelfServiceOptions()
+
+  

+  

+    Checks if all input values are correct and returns the LDAP commands which should be executed.
+  

+    

+    baseModule::check_configOptions()
+
+  

+  

+    Checks input values of module settings.
+  

+    

+    baseModule::check_profileOptions()
+
+  

+  

+    Checks input values of account profiles.
+  

+    

+    baseModule::delete_attributes()
+
+  

+  

+    Dummy function for modules which use no special options on account deletion.
+  

+    

+    baseModule::display_html_delete()
+
+  

+  

+    Dummy function for modules which do not print extra HTML code on account deletion.
+  

+    

+    baseModule::doUploadPostActions()
+
+  

+  

+    This function executes one post upload action.
+  

+    

+    baseModule::getButtonStatus()
+
+  

+  

+    Controls if the module button the account page is visible and activated.
+  

+    

+    baseModule::getLDAPAliases()
+
+  

+  

+    Returns a list of aliases for LDAP attributes.
+  

+    

+    baseModule::getManagedAttributes()
+
+  

+  

+    Returns a list of LDAP attributes which are managed by this module.
+  

+    

+    baseModule::getManagedObjectClasses()
+
+  

+  

+    Returns a list of managed object classes for this module.
+  

+    

+    baseModule::getRequiredExtensions()
+
+  

+  

+    Returns a list of required PHP extensions.
+  

+    

+    baseModule::getSelfServiceFields()
+
+  

+  

+    Returns a list of possible input fields and their descriptions  Format: array(<field identifier> => <field description>)
+  

+    

+    baseModule::getSelfServiceOptions()
+
+  

+  

+    Returns the meta HTML code for each input field.
+  

+    

+    baseModule::getSelfServiceSearchAttributes()
+
+  

+  

+    Returns a list of possible search attributes for the self service.
+  

+    

+    baseModule::get_alias()
+
+  

+  

+    Returns an alias name for the module.
+  

+    

+    baseModule::get_configOptions()
+
+  

+  

+    Returns a list of elements for the configuration.
+  

+    

+    baseModule::get_dependencies()
+
+  

+  

+    This function returns a list with all depending and conflicting modules.
+  

+    

+    baseModule::get_help()
+
+  

+  

+    This function return the help entry array for a specific help id. Normally this->meta can be used.
+  

+    

+    baseModule::get_ldap_filter()
+
+  

+  

+    returns an LDAP filter for the account lists
+  

+    

+    baseModule::get_metaData()
+
+  

+  

+    Dummy function, meta data is provided by sub classes.
+  

+    

+    baseModule::get_pdfFields()
+
+  

+  

+    Returns an array with all fields available for this account type on the PDF  output. This method may be overwritten by subclasses or it may be used  by using entries in the $this->meta['PDF_fields'] array of the specific sub-  class.
+  

+    

+    baseModule::get_pdf_entries()
+
+  

+  

+    Returns a hastable with all entries that may be printed out in the PDF. The
+  

+    

+    baseModule::get_profileOptions()
+
+  

+  

+    Returns a list of elements for the account profiles.
+  

+    

+    baseModule::get_RDNAttributes()
+
+  

+  

+    Returns a list of possible LDAP attributes which can be used to form the RDN.
+  

+    

+    baseModule::get_scope()
+
+  

+  

+    Returns the account type of this module (user, group, host)
+  

+    

+    baseModule::get_uploadColumns()
+
+  

+  

+    Returns an array containing all input columns for the file upload.
+  

+    

+    baseModule::get_uploadPreDepends()
+
+  

+  

+    Returns a list of module names which must be processed in building the account befor this module.
+  

+    

+    baseModule::init()
+
+  

+  

+    Initializes the module after it became part of an accountContainer
+  

+    

+    baseModule::is_base_module()
+
+  

+  

+    Returns true if this module is enough to provide a sensible account.
+  

+    

+    baseModule::load_attributes()
+
+  

+  

+    This function loads the LDAP attributes for this module.
+  

+    

+    baseModule::load_Messages()
+
+  

+  

+    This function fills the $messages variable with output messages from this module.
+  

+    

+    baseModule::load_profile()
+
+  

+  

+    Loads the values of an account profile into internal variables.
+  

+    

+    baseModule::module_complete()
+
+  

+  

+    This functions is used to check if all settings for this module have been made.
+  

+    

+    baseModule::module_ready()
+
+  

+  

+    This function is used to check if this module page can be displayed.
+  

+    

+    baseModule::save_attributes()
+
+  

+  

+    Returns a list of modifications which have to be made to the LDAP account.
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 35]

+Provides mail routing for users.




+
[ Top ]


+
+
+

+
+
Class Methods

+

+
+  

+	
+	
method build_uploadAccounts [line 251]

+	

+    

+    

+		array build_uploadAccounts(
+array
+$rawAccounts, array
+$ids, array
+&$partialAccounts)
+    

+    


+	
+		In this function the LDAP account is built up.




+
Tags:

+

+
+  
+    
+  
+
return:  list of error messages if any

+

+


+
+	
+Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)

+    


+        
[ Top ]

+  

+  

+	
+	
method display_html_attributes [line 131]

+	

+    

+    

+		void display_html_attributes(
+)
+    

+    


+	
+		This function will create the meta HTML code to show a page with all attributes.




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_metaData [line 42]

+	

+    

+    

+		array get_metaData(
+)
+    

+    


+	
+		Returns meta data that is interpreted by parent class




+
Tags:

+

+
+  
+    
+  
+
return:  array with meta data

+

+


+
+	
+Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)


+
+        
[ Top ]

+  

+  

+	
+	
method get_pdfEntries [line 304]

+	

+    

+    

+		array get_pdfEntries(
+)
+    

+    


+	
+		Returns the PDF entries for this module.




+
Tags:

+

+
+  
+    
+  
+
return:  list of possible PDF entries

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method load_Messages [line 119]

+	

+    

+    

+		void load_Messages(
+)
+    

+    


+	
+		This function fills the error message array with messages




+
+	
+Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)


+
+        
[ Top ]

+  

+  

+	
+	
method process_attributes [line 173]

+	

+    

+    

+		array process_attributes(
+)
+    

+    


+	
+		Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




+
Tags:

+

+
+  
+    
+  
+
return:  list of info/error messages

+

+


+
+	
+
+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:48 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/inetOrgPerson.html b/lam-web/developers/phpdoc/modules/inetOrgPerson.html
new file mode 100644
index 00000000..1659862c
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/inetOrgPerson.html
@@ -0,0 +1,949 @@
+
+
+Docs For Class inetOrgPerson
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Class: inetOrgPerson

+Source Location: /lib/modules/inetOrgPerson.inc


+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
baseModule
+   |
+   --inetOrgPerson


+
This class contains all account LDAP attributes  and funtioncs required to deal with inetOrgPerson.



+
+
+
+
+
+
+        
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: baseModule

+

+

+  baseModule::$attributes
+  
+

+

+   
+

+

+  baseModule::$base
+  
+

+

+   
+

+

+  baseModule::$messages
+  
+

+

+   
+

+

+  baseModule::$meta
+  
+

+

+   
+

+

+  baseModule::$moduleSettings
+  
+

+

+   
+

+

+  baseModule::$orig
+  
+

+

+   
+

+

+  baseModule::$scope
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: baseModule

+

+    

+    baseModule::baseModule()
+
+  

+  

+    Creates a new base module class
+  

+    

+    baseModule::build_uploadAccounts()
+
+  

+  

+    In this function the LDAP account is built up.
+  

+    

+    baseModule::can_manage()
+
+  

+  

+    Returns true if this module fits for the current scope.
+  

+    

+    baseModule::checkSelfServiceOptions()
+
+  

+  

+    Checks if all input values are correct and returns the LDAP commands which should be executed.
+  

+    

+    baseModule::check_configOptions()
+
+  

+  

+    Checks input values of module settings.
+  

+    

+    baseModule::check_profileOptions()
+
+  

+  

+    Checks input values of account profiles.
+  

+    

+    baseModule::delete_attributes()
+
+  

+  

+    Dummy function for modules which use no special options on account deletion.
+  

+    

+    baseModule::display_html_delete()
+
+  

+  

+    Dummy function for modules which do not print extra HTML code on account deletion.
+  

+    

+    baseModule::doUploadPostActions()
+
+  

+  

+    This function executes one post upload action.
+  

+    

+    baseModule::getButtonStatus()
+
+  

+  

+    Controls if the module button the account page is visible and activated.
+  

+    

+    baseModule::getLDAPAliases()
+
+  

+  

+    Returns a list of aliases for LDAP attributes.
+  

+    

+    baseModule::getManagedAttributes()
+
+  

+  

+    Returns a list of LDAP attributes which are managed by this module.
+  

+    

+    baseModule::getManagedObjectClasses()
+
+  

+  

+    Returns a list of managed object classes for this module.
+  

+    

+    baseModule::getRequiredExtensions()
+
+  

+  

+    Returns a list of required PHP extensions.
+  

+    

+    baseModule::getSelfServiceFields()
+
+  

+  

+    Returns a list of possible input fields and their descriptions  Format: array(<field identifier> => <field description>)
+  

+    

+    baseModule::getSelfServiceOptions()
+
+  

+  

+    Returns the meta HTML code for each input field.
+  

+    

+    baseModule::getSelfServiceSearchAttributes()
+
+  

+  

+    Returns a list of possible search attributes for the self service.
+  

+    

+    baseModule::get_alias()
+
+  

+  

+    Returns an alias name for the module.
+  

+    

+    baseModule::get_configOptions()
+
+  

+  

+    Returns a list of elements for the configuration.
+  

+    

+    baseModule::get_dependencies()
+
+  

+  

+    This function returns a list with all depending and conflicting modules.
+  

+    

+    baseModule::get_help()
+
+  

+  

+    This function return the help entry array for a specific help id. Normally this->meta can be used.
+  

+    

+    baseModule::get_ldap_filter()
+
+  

+  

+    returns an LDAP filter for the account lists
+  

+    

+    baseModule::get_metaData()
+
+  

+  

+    Dummy function, meta data is provided by sub classes.
+  

+    

+    baseModule::get_pdfFields()
+
+  

+  

+    Returns an array with all fields available for this account type on the PDF  output. This method may be overwritten by subclasses or it may be used  by using entries in the $this->meta['PDF_fields'] array of the specific sub-  class.
+  

+    

+    baseModule::get_pdf_entries()
+
+  

+  

+    Returns a hastable with all entries that may be printed out in the PDF. The
+  

+    

+    baseModule::get_profileOptions()
+
+  

+  

+    Returns a list of elements for the account profiles.
+  

+    

+    baseModule::get_RDNAttributes()
+
+  

+  

+    Returns a list of possible LDAP attributes which can be used to form the RDN.
+  

+    

+    baseModule::get_scope()
+
+  

+  

+    Returns the account type of this module (user, group, host)
+  

+    

+    baseModule::get_uploadColumns()
+
+  

+  

+    Returns an array containing all input columns for the file upload.
+  

+    

+    baseModule::get_uploadPreDepends()
+
+  

+  

+    Returns a list of module names which must be processed in building the account befor this module.
+  

+    

+    baseModule::init()
+
+  

+  

+    Initializes the module after it became part of an accountContainer
+  

+    

+    baseModule::is_base_module()
+
+  

+  

+    Returns true if this module is enough to provide a sensible account.
+  

+    

+    baseModule::load_attributes()
+
+  

+  

+    This function loads the LDAP attributes for this module.
+  

+    

+    baseModule::load_Messages()
+
+  

+  

+    This function fills the $messages variable with output messages from this module.
+  

+    

+    baseModule::load_profile()
+
+  

+  

+    Loads the values of an account profile into internal variables.
+  

+    

+    baseModule::module_complete()
+
+  

+  

+    This functions is used to check if all settings for this module have been made.
+  

+    

+    baseModule::module_ready()
+
+  

+  

+    This function is used to check if this module page can be displayed.
+  

+    

+    baseModule::save_attributes()
+
+  

+  

+    Returns a list of modifications which have to be made to the LDAP account.
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 38]

+This class contains all account LDAP attributes  and funtioncs required to deal with inetOrgPerson.




+
[ Top ]


+
+
+

+
+
Class Methods

+

+
+  

+	
+	
method build_uploadAccounts [line 837]

+	

+    

+    

+		array build_uploadAccounts(
+array
+$rawAccounts, array
+$ids, array
+&$partialAccounts)
+    

+    


+	
+		In this function the LDAP account is built up.




+
Tags:

+

+
+  
+    
+  
+
return:  list of error messages if any

+

+


+
+	
+Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)

+    


+        
[ Top ]

+  

+  

+	
+	
method checkSelfServiceOptions [line 1145]

+	

+    

+    

+		array checkSelfServiceOptions(
+string
+$fields, array
+$attributes)
+    

+    


+	
+		Checks if all input values are correct and returns the LDAP commands which should be executed.




+
Tags:

+

+
+  
+    
+  
+
return:  messages and LDAP commands (array('messages' => array(), 'add' => array(), 'del' => array(), 'mod' => array()))

+

+


+
+	
+Overrides baseModule::checkSelfServiceOptions() (Checks if all input values are correct and returns the LDAP commands which should be executed.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
string  $fields  input fields
array  $attributes  LDAP attributes

+    


+        
[ Top ]

+  

+  

+	
+	
method display_html_attributes [line 545]

+	

+    

+    

+		void display_html_attributes(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method display_html_password [line 749]

+	

+    

+    

+		array display_html_password(
+)
+    

+    


+	
+		Displays the password changing dialog.




+
Tags:

+

+
+  
+    
+  
+
return:  meta HTML code

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method display_html_photo [line 789]

+	

+    

+    

+		array display_html_photo(
+)
+    

+    


+	
+		Displays the photo upload page.




+
Tags:

+

+
+  
+    
+  
+
return:  meta HTML code

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getButtonStatus [line 391]

+	

+    

+    

+		string getButtonStatus(
+)
+    

+    


+	
+		Controls if the module button the account page is visible and activated.




+
Tags:

+

+
+  
+    
+  
+
return:  status ("enabled", "disabled", "hidden")

+

+


+
+	
+Overrides baseModule::getButtonStatus() (Controls if the module button the account page is visible and activated.)


+
+        
[ Top ]

+  

+  

+	
+	
method getSelfServiceOptions [line 1053]

+	

+    

+    

+		array getSelfServiceOptions(
+array
+$fields, array
+$attributes)
+    

+    


+	
+		Returns the meta HTML code for each input field.

format: array(<field1> => array(<META HTML>), ...)  It is not possible to display help links.




+
Tags:

+

+
+  
+    
+  
+
return:  meta HTML

+

+


+
+	
+Overrides baseModule::getSelfServiceOptions() (Returns the meta HTML code for each input field.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $fields  list of active fields
array  $attributes  attributes of LDAP account (attribute names in lower case)

+    


+        
[ Top ]

+  

+  

+	
+	
method get_metaData [line 85]

+	

+    

+    

+		array get_metaData(
+)
+    

+    


+	
+		Returns meta data that is interpreted by parent class




+
Tags:

+

+
+  
+    
+  
+
return:  array with meta data

+

+


+
+	
+Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)


+
+        
[ Top ]

+  

+  

+	
+	
method get_pdfEntries [line 808]

+	

+    

+    

+		array get_pdfEntries(
+)
+    

+    


+	
+		Returns the PDF entries for this module.




+
Tags:

+

+
+  
+    
+  
+
return:  list of possible PDF entries

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method load_Messages [line 43]

+	

+    

+    

+		void load_Messages(
+)
+    

+    


+	
+		This function fills the message array.




+
+	
+Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)


+
+        
[ Top ]

+  

+  

+	
+	
method module_complete [line 374]

+	

+    

+    

+		boolean module_complete(
+)
+    

+    


+	
+		This functions return true if all needed settings are done.




+
Tags:

+

+
+  
+    
+  
+
return:  true, if all is ok

+

+


+
+	
+Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)


+
+        
[ Top ]

+  

+  

+	
+	
method process_attributes [line 448]

+	

+    

+    

+		array process_attributes(
+)
+    

+    


+	
+		Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




+
Tags:

+

+
+  
+    
+  
+
return:  list of info/error messages

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method process_password [line 727]

+	

+    

+    

+		void process_password(
+)
+    

+    


+	
+		Sets a new password.




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method process_photo [line 769]

+	

+    

+    

+		void process_photo(
+)
+    

+    


+	
+		Sets a new photo.




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method save_attributes [line 410]

+	

+    

+    

+		void save_attributes(
+)
+    

+    


+	
+		


+
+	
+Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)


+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:48 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/kolabUser.html b/lam-web/developers/phpdoc/modules/kolabUser.html
new file mode 100644
index 00000000..a3dca8c1
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/kolabUser.html
@@ -0,0 +1,840 @@
+
+
+Docs For Class kolabUser
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Class: kolabUser

+Source Location: /lib/modules/kolabUser.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
baseModule
+   |
+   --kolabUser


+
Manages Kolab user accounts.



+
+
+
+
+
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: baseModule

+

+

+  baseModule::$attributes
+  
+

+

+   
+

+

+  baseModule::$base
+  
+

+

+   
+

+

+  baseModule::$messages
+  
+

+

+   
+

+

+  baseModule::$meta
+  
+

+

+   
+

+

+  baseModule::$moduleSettings
+  
+

+

+   
+

+

+  baseModule::$orig
+  
+

+

+   
+

+

+  baseModule::$scope
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: baseModule

+

+    

+    baseModule::baseModule()
+
+  

+  

+    Creates a new base module class
+  

+    

+    baseModule::build_uploadAccounts()
+
+  

+  

+    In this function the LDAP account is built up.
+  

+    

+    baseModule::can_manage()
+
+  

+  

+    Returns true if this module fits for the current scope.
+  

+    

+    baseModule::checkSelfServiceOptions()
+
+  

+  

+    Checks if all input values are correct and returns the LDAP commands which should be executed.
+  

+    

+    baseModule::check_configOptions()
+
+  

+  

+    Checks input values of module settings.
+  

+    

+    baseModule::check_profileOptions()
+
+  

+  

+    Checks input values of account profiles.
+  

+    

+    baseModule::delete_attributes()
+
+  

+  

+    Dummy function for modules which use no special options on account deletion.
+  

+    

+    baseModule::display_html_delete()
+
+  

+  

+    Dummy function for modules which do not print extra HTML code on account deletion.
+  

+    

+    baseModule::doUploadPostActions()
+
+  

+  

+    This function executes one post upload action.
+  

+    

+    baseModule::getButtonStatus()
+
+  

+  

+    Controls if the module button the account page is visible and activated.
+  

+    

+    baseModule::getLDAPAliases()
+
+  

+  

+    Returns a list of aliases for LDAP attributes.
+  

+    

+    baseModule::getManagedAttributes()
+
+  

+  

+    Returns a list of LDAP attributes which are managed by this module.
+  

+    

+    baseModule::getManagedObjectClasses()
+
+  

+  

+    Returns a list of managed object classes for this module.
+  

+    

+    baseModule::getRequiredExtensions()
+
+  

+  

+    Returns a list of required PHP extensions.
+  

+    

+    baseModule::getSelfServiceFields()
+
+  

+  

+    Returns a list of possible input fields and their descriptions  Format: array(<field identifier> => <field description>)
+  

+    

+    baseModule::getSelfServiceOptions()
+
+  

+  

+    Returns the meta HTML code for each input field.
+  

+    

+    baseModule::getSelfServiceSearchAttributes()
+
+  

+  

+    Returns a list of possible search attributes for the self service.
+  

+    

+    baseModule::get_alias()
+
+  

+  

+    Returns an alias name for the module.
+  

+    

+    baseModule::get_configOptions()
+
+  

+  

+    Returns a list of elements for the configuration.
+  

+    

+    baseModule::get_dependencies()
+
+  

+  

+    This function returns a list with all depending and conflicting modules.
+  

+    

+    baseModule::get_help()
+
+  

+  

+    This function return the help entry array for a specific help id. Normally this->meta can be used.
+  

+    

+    baseModule::get_ldap_filter()
+
+  

+  

+    returns an LDAP filter for the account lists
+  

+    

+    baseModule::get_metaData()
+
+  

+  

+    Dummy function, meta data is provided by sub classes.
+  

+    

+    baseModule::get_pdfFields()
+
+  

+  

+    Returns an array with all fields available for this account type on the PDF  output. This method may be overwritten by subclasses or it may be used  by using entries in the $this->meta['PDF_fields'] array of the specific sub-  class.
+  

+    

+    baseModule::get_pdf_entries()
+
+  

+  

+    Returns a hastable with all entries that may be printed out in the PDF. The
+  

+    

+    baseModule::get_profileOptions()
+
+  

+  

+    Returns a list of elements for the account profiles.
+  

+    

+    baseModule::get_RDNAttributes()
+
+  

+  

+    Returns a list of possible LDAP attributes which can be used to form the RDN.
+  

+    

+    baseModule::get_scope()
+
+  

+  

+    Returns the account type of this module (user, group, host)
+  

+    

+    baseModule::get_uploadColumns()
+
+  

+  

+    Returns an array containing all input columns for the file upload.
+  

+    

+    baseModule::get_uploadPreDepends()
+
+  

+  

+    Returns a list of module names which must be processed in building the account befor this module.
+  

+    

+    baseModule::init()
+
+  

+  

+    Initializes the module after it became part of an accountContainer
+  

+    

+    baseModule::is_base_module()
+
+  

+  

+    Returns true if this module is enough to provide a sensible account.
+  

+    

+    baseModule::load_attributes()
+
+  

+  

+    This function loads the LDAP attributes for this module.
+  

+    

+    baseModule::load_Messages()
+
+  

+  

+    This function fills the $messages variable with output messages from this module.
+  

+    

+    baseModule::load_profile()
+
+  

+  

+    Loads the values of an account profile into internal variables.
+  

+    

+    baseModule::module_complete()
+
+  

+  

+    This functions is used to check if all settings for this module have been made.
+  

+    

+    baseModule::module_ready()
+
+  

+  

+    This function is used to check if this module page can be displayed.
+  

+    

+    baseModule::save_attributes()
+
+  

+  

+    Returns a list of modifications which have to be made to the LDAP account.
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 35]

+Manages Kolab user accounts.




+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$invitationPolicies = 

+	
[line 38]

+  list of invitation policies


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor kolabUser [line 45]

+	

+    

+    

+		kolabUser kolabUser(
+string
+$scope)
+    

+    


+	
+		Creates a new kolabUser object.




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $scope  account type (user, group, host)

+    


+        
[ Top ]

+  

+  

+	
+	
method build_uploadAccounts [line 604]

+	

+    

+    

+		array build_uploadAccounts(
+array
+$rawAccounts, array
+$ids, array
+&$partialAccounts)
+    

+    


+	
+		In this function the LDAP account is built up.




+
Tags:

+

+
+  
+    
+  
+
return:  list of error messages if any

+

+


+
+	
+Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)

+    


+        
[ Top ]

+  

+  

+	
+	
method display_html_attributes [line 262]

+	

+    

+    

+		void display_html_attributes(
+)
+    

+    


+	
+		This function will create the meta HTML code to show a page with all attributes.




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method display_html_deleteUser [line 556]

+	

+    

+    

+		void display_html_deleteUser(
+)
+    

+    


+	
+		This function will create the meta HTML code to show a page to delete accounts.




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_metaData [line 63]

+	

+    

+    

+		array get_metaData(
+)
+    

+    


+	
+		Returns meta data that is interpreted by parent class




+
Tags:

+

+
+  
+    
+  
+
return:  array with meta data

+

+


+
+	
+Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)


+
+        
[ Top ]

+  

+  

+	
+	
method get_pdfEntries [line 742]

+	

+    

+    

+		array get_pdfEntries(
+)
+    

+    


+	
+		Returns the PDF entries for this module.




+
Tags:

+

+
+  
+    
+  
+
return:  list of possible PDF entries

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method load_Messages [line 223]

+	

+    

+    

+		void load_Messages(
+)
+    

+    


+	
+		This function fills the error message array with messages




+
+	
+Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)


+
+        
[ Top ]

+  

+  

+	
+	
method module_complete [line 583]

+	

+    

+    

+		true, module_complete(
+)
+    

+    


+	
+		This function returns true if all needed settings are done.




+
Tags:

+

+
+  
+    
+  
+
return:  if account can be saved

+

+


+
+	
+Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)


+
+        
[ Top ]

+  

+  

+	
+	
method process_attributes [line 412]

+	

+    

+    

+		array process_attributes(
+)
+    

+    


+	
+		Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




+
Tags:

+

+
+  
+    
+  
+
return:  list of info/error messages

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method process_deleteUser [line 571]

+	

+    

+    

+		void process_deleteUser(
+)
+    

+    


+	
+		Write variables into object and do some regex checks




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method save_attributes [line 251]

+	

+    

+    

+		array save_attributes(
+)
+    

+    


+	
+		Returns a list of modifications which have to be made to the LDAP account.




+
Tags:

+

+
+  
+    
+  
+
return:  list of modifications  
This function returns an array with 3 entries:  
array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )  
DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)  
"add" are attributes which have to be added to LDAP entry  
"remove" are attributes which have to be removed from LDAP entry  
"modify" are attributes which have to been modified in LDAP entry

+

+


+
+	
+Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)


+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:49 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/ldapPublicKey.html b/lam-web/developers/phpdoc/modules/ldapPublicKey.html
new file mode 100644
index 00000000..84cf077b
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/ldapPublicKey.html
@@ -0,0 +1,662 @@
+
+
+Docs For Class ldapPublicKey
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Class: ldapPublicKey

+Source Location: /lib/modules/ldapPublicKey.inc


+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
baseModule
+   |
+   --ldapPublicKey


+
Manages SSH public keys.



+
+
+
+
+
+
+        
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: baseModule

+

+

+  baseModule::$attributes
+  
+

+

+   
+

+

+  baseModule::$base
+  
+

+

+   
+

+

+  baseModule::$messages
+  
+

+

+   
+

+

+  baseModule::$meta
+  
+

+

+   
+

+

+  baseModule::$moduleSettings
+  
+

+

+   
+

+

+  baseModule::$orig
+  
+

+

+   
+

+

+  baseModule::$scope
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: baseModule

+

+    

+    baseModule::baseModule()
+
+  

+  

+    Creates a new base module class
+  

+    

+    baseModule::build_uploadAccounts()
+
+  

+  

+    In this function the LDAP account is built up.
+  

+    

+    baseModule::can_manage()
+
+  

+  

+    Returns true if this module fits for the current scope.
+  

+    

+    baseModule::checkSelfServiceOptions()
+
+  

+  

+    Checks if all input values are correct and returns the LDAP commands which should be executed.
+  

+    

+    baseModule::check_configOptions()
+
+  

+  

+    Checks input values of module settings.
+  

+    

+    baseModule::check_profileOptions()
+
+  

+  

+    Checks input values of account profiles.
+  

+    

+    baseModule::delete_attributes()
+
+  

+  

+    Dummy function for modules which use no special options on account deletion.
+  

+    

+    baseModule::display_html_delete()
+
+  

+  

+    Dummy function for modules which do not print extra HTML code on account deletion.
+  

+    

+    baseModule::doUploadPostActions()
+
+  

+  

+    This function executes one post upload action.
+  

+    

+    baseModule::getButtonStatus()
+
+  

+  

+    Controls if the module button the account page is visible and activated.
+  

+    

+    baseModule::getLDAPAliases()
+
+  

+  

+    Returns a list of aliases for LDAP attributes.
+  

+    

+    baseModule::getManagedAttributes()
+
+  

+  

+    Returns a list of LDAP attributes which are managed by this module.
+  

+    

+    baseModule::getManagedObjectClasses()
+
+  

+  

+    Returns a list of managed object classes for this module.
+  

+    

+    baseModule::getRequiredExtensions()
+
+  

+  

+    Returns a list of required PHP extensions.
+  

+    

+    baseModule::getSelfServiceFields()
+
+  

+  

+    Returns a list of possible input fields and their descriptions  Format: array(<field identifier> => <field description>)
+  

+    

+    baseModule::getSelfServiceOptions()
+
+  

+  

+    Returns the meta HTML code for each input field.
+  

+    

+    baseModule::getSelfServiceSearchAttributes()
+
+  

+  

+    Returns a list of possible search attributes for the self service.
+  

+    

+    baseModule::get_alias()
+
+  

+  

+    Returns an alias name for the module.
+  

+    

+    baseModule::get_configOptions()
+
+  

+  

+    Returns a list of elements for the configuration.
+  

+    

+    baseModule::get_dependencies()
+
+  

+  

+    This function returns a list with all depending and conflicting modules.
+  

+    

+    baseModule::get_help()
+
+  

+  

+    This function return the help entry array for a specific help id. Normally this->meta can be used.
+  

+    

+    baseModule::get_ldap_filter()
+
+  

+  

+    returns an LDAP filter for the account lists
+  

+    

+    baseModule::get_metaData()
+
+  

+  

+    Dummy function, meta data is provided by sub classes.
+  

+    

+    baseModule::get_pdfFields()
+
+  

+  

+    Returns an array with all fields available for this account type on the PDF  output. This method may be overwritten by subclasses or it may be used  by using entries in the $this->meta['PDF_fields'] array of the specific sub-  class.
+  

+    

+    baseModule::get_pdf_entries()
+
+  

+  

+    Returns a hastable with all entries that may be printed out in the PDF. The
+  

+    

+    baseModule::get_profileOptions()
+
+  

+  

+    Returns a list of elements for the account profiles.
+  

+    

+    baseModule::get_RDNAttributes()
+
+  

+  

+    Returns a list of possible LDAP attributes which can be used to form the RDN.
+  

+    

+    baseModule::get_scope()
+
+  

+  

+    Returns the account type of this module (user, group, host)
+  

+    

+    baseModule::get_uploadColumns()
+
+  

+  

+    Returns an array containing all input columns for the file upload.
+  

+    

+    baseModule::get_uploadPreDepends()
+
+  

+  

+    Returns a list of module names which must be processed in building the account befor this module.
+  

+    

+    baseModule::init()
+
+  

+  

+    Initializes the module after it became part of an accountContainer
+  

+    

+    baseModule::is_base_module()
+
+  

+  

+    Returns true if this module is enough to provide a sensible account.
+  

+    

+    baseModule::load_attributes()
+
+  

+  

+    This function loads the LDAP attributes for this module.
+  

+    

+    baseModule::load_Messages()
+
+  

+  

+    This function fills the $messages variable with output messages from this module.
+  

+    

+    baseModule::load_profile()
+
+  

+  

+    Loads the values of an account profile into internal variables.
+  

+    

+    baseModule::module_complete()
+
+  

+  

+    This functions is used to check if all settings for this module have been made.
+  

+    

+    baseModule::module_ready()
+
+  

+  

+    This function is used to check if this module page can be displayed.
+  

+    

+    baseModule::save_attributes()
+
+  

+  

+    Returns a list of modifications which have to be made to the LDAP account.
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 36]

+Manages SSH public keys.




+
[ Top ]


+
+
+

+
+
Class Methods

+

+
+  

+	
+	
method build_uploadAccounts [line 138]

+	

+    

+    

+		array build_uploadAccounts(
+array
+$rawAccounts, array
+$ids, array
+&$partialAccounts)
+    

+    


+	
+		In this function the LDAP account is built up.




+
Tags:

+

+
+  
+    
+  
+
return:  list of error messages if any

+

+


+
+	
+Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)

+    


+        
[ Top ]

+  

+  

+	
+	
method display_html_attributes [line 85]

+	

+    

+    

+		void display_html_attributes(
+)
+    

+    


+	
+		This function will create the meta HTML code to show a page with all attributes.




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_metaData [line 43]

+	

+    

+    

+		array get_metaData(
+)
+    

+    


+	
+		Returns meta data that is interpreted by parent class




+
Tags:

+

+
+  
+    
+  
+
return:  array with meta data

+

+


+
+	
+Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)


+
+        
[ Top ]

+  

+  

+	
+	
method get_pdfEntries [line 158]

+	

+    

+    

+		void get_pdfEntries(
+)
+    

+    


+	
+		Returns a list of PDF entries




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method process_attributes [line 111]

+	

+    

+    

+		array process_attributes(
+)
+    

+    


+	
+		Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




+
Tags:

+

+
+  
+    
+  
+
return:  list of info/error messages

+

+


+
+	
+
+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:51 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/nisMailAlias.html b/lam-web/developers/phpdoc/modules/nisMailAlias.html
new file mode 100644
index 00000000..170838aa
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/nisMailAlias.html
@@ -0,0 +1,746 @@
+
+
+Docs For Class nisMailAlias
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Class: nisMailAlias

+Source Location: /lib/modules/nisMailAlias.inc


+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
baseModule
+   |
+   --nisMailAlias


+
Provides NIS mail alias management.



+
+
+
+
+
+
+        
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: baseModule

+

+

+  baseModule::$attributes
+  
+

+

+   
+

+

+  baseModule::$base
+  
+

+

+   
+

+

+  baseModule::$messages
+  
+

+

+   
+

+

+  baseModule::$meta
+  
+

+

+   
+

+

+  baseModule::$moduleSettings
+  
+

+

+   
+

+

+  baseModule::$orig
+  
+

+

+   
+

+

+  baseModule::$scope
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: baseModule

+

+    

+    baseModule::baseModule()
+
+  

+  

+    Creates a new base module class
+  

+    

+    baseModule::build_uploadAccounts()
+
+  

+  

+    In this function the LDAP account is built up.
+  

+    

+    baseModule::can_manage()
+
+  

+  

+    Returns true if this module fits for the current scope.
+  

+    

+    baseModule::checkSelfServiceOptions()
+
+  

+  

+    Checks if all input values are correct and returns the LDAP commands which should be executed.
+  

+    

+    baseModule::check_configOptions()
+
+  

+  

+    Checks input values of module settings.
+  

+    

+    baseModule::check_profileOptions()
+
+  

+  

+    Checks input values of account profiles.
+  

+    

+    baseModule::delete_attributes()
+
+  

+  

+    Dummy function for modules which use no special options on account deletion.
+  

+    

+    baseModule::display_html_delete()
+
+  

+  

+    Dummy function for modules which do not print extra HTML code on account deletion.
+  

+    

+    baseModule::doUploadPostActions()
+
+  

+  

+    This function executes one post upload action.
+  

+    

+    baseModule::getButtonStatus()
+
+  

+  

+    Controls if the module button the account page is visible and activated.
+  

+    

+    baseModule::getLDAPAliases()
+
+  

+  

+    Returns a list of aliases for LDAP attributes.
+  

+    

+    baseModule::getManagedAttributes()
+
+  

+  

+    Returns a list of LDAP attributes which are managed by this module.
+  

+    

+    baseModule::getManagedObjectClasses()
+
+  

+  

+    Returns a list of managed object classes for this module.
+  

+    

+    baseModule::getRequiredExtensions()
+
+  

+  

+    Returns a list of required PHP extensions.
+  

+    

+    baseModule::getSelfServiceFields()
+
+  

+  

+    Returns a list of possible input fields and their descriptions  Format: array(<field identifier> => <field description>)
+  

+    

+    baseModule::getSelfServiceOptions()
+
+  

+  

+    Returns the meta HTML code for each input field.
+  

+    

+    baseModule::getSelfServiceSearchAttributes()
+
+  

+  

+    Returns a list of possible search attributes for the self service.
+  

+    

+    baseModule::get_alias()
+
+  

+  

+    Returns an alias name for the module.
+  

+    

+    baseModule::get_configOptions()
+
+  

+  

+    Returns a list of elements for the configuration.
+  

+    

+    baseModule::get_dependencies()
+
+  

+  

+    This function returns a list with all depending and conflicting modules.
+  

+    

+    baseModule::get_help()
+
+  

+  

+    This function return the help entry array for a specific help id. Normally this->meta can be used.
+  

+    

+    baseModule::get_ldap_filter()
+
+  

+  

+    returns an LDAP filter for the account lists
+  

+    

+    baseModule::get_metaData()
+
+  

+  

+    Dummy function, meta data is provided by sub classes.
+  

+    

+    baseModule::get_pdfFields()
+
+  

+  

+    Returns an array with all fields available for this account type on the PDF  output. This method may be overwritten by subclasses or it may be used  by using entries in the $this->meta['PDF_fields'] array of the specific sub-  class.
+  

+    

+    baseModule::get_pdf_entries()
+
+  

+  

+    Returns a hastable with all entries that may be printed out in the PDF. The
+  

+    

+    baseModule::get_profileOptions()
+
+  

+  

+    Returns a list of elements for the account profiles.
+  

+    

+    baseModule::get_RDNAttributes()
+
+  

+  

+    Returns a list of possible LDAP attributes which can be used to form the RDN.
+  

+    

+    baseModule::get_scope()
+
+  

+  

+    Returns the account type of this module (user, group, host)
+  

+    

+    baseModule::get_uploadColumns()
+
+  

+  

+    Returns an array containing all input columns for the file upload.
+  

+    

+    baseModule::get_uploadPreDepends()
+
+  

+  

+    Returns a list of module names which must be processed in building the account befor this module.
+  

+    

+    baseModule::init()
+
+  

+  

+    Initializes the module after it became part of an accountContainer
+  

+    

+    baseModule::is_base_module()
+
+  

+  

+    Returns true if this module is enough to provide a sensible account.
+  

+    

+    baseModule::load_attributes()
+
+  

+  

+    This function loads the LDAP attributes for this module.
+  

+    

+    baseModule::load_Messages()
+
+  

+  

+    This function fills the $messages variable with output messages from this module.
+  

+    

+    baseModule::load_profile()
+
+  

+  

+    Loads the values of an account profile into internal variables.
+  

+    

+    baseModule::module_complete()
+
+  

+  

+    This functions is used to check if all settings for this module have been made.
+  

+    

+    baseModule::module_ready()
+
+  

+  

+    This function is used to check if this module page can be displayed.
+  

+    

+    baseModule::save_attributes()
+
+  

+  

+    Returns a list of modifications which have to be made to the LDAP account.
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 35]

+Provides NIS mail alias management.




+
[ Top ]


+
+
+

+
+
Class Methods

+

+
+  

+	
+	
method build_uploadAccounts [line 228]

+	

+    

+    

+		array build_uploadAccounts(
+array
+$rawAccounts, array
+$ids, array
+&$partialAccounts)
+    

+    


+	
+		In this function the LDAP account is built up.




+
Tags:

+

+
+  
+    
+  
+
return:  list of error messages if any

+

+


+
+	
+Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)

+    


+        
[ Top ]

+  

+  

+	
+	
method display_html_attributes [line 129]

+	

+    

+    

+		void display_html_attributes(
+)
+    

+    


+	
+		This function will create the meta HTML code to show a page with all attributes.




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getButtonStatus [line 209]

+	

+    

+    

+		string getButtonStatus(
+)
+    

+    


+	
+		Controls if the module button the account page is visible and activated.




+
Tags:

+

+
+  
+    
+  
+
return:  status ("enabled", "disabled", "hidden")

+

+


+
+	
+Overrides baseModule::getButtonStatus() (Controls if the module button the account page is visible and activated.)


+
+        
[ Top ]

+  

+  

+	
+	
method get_metaData [line 42]

+	

+    

+    

+		array get_metaData(
+)
+    

+    


+	
+		Returns meta data that is interpreted by parent class




+
Tags:

+

+
+  
+    
+  
+
return:  array with meta data

+

+


+
+	
+Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)


+
+        
[ Top ]

+  

+  

+	
+	
method get_pdfEntries [line 267]

+	

+    

+    

+		array get_pdfEntries(
+)
+    

+    


+	
+		Returns the PDF entries for this module.




+
Tags:

+

+
+  
+    
+  
+
return:  list of possible PDF entries

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method load_Messages [line 100]

+	

+    

+    

+		void load_Messages(
+)
+    

+    


+	
+		This function fills the error message array with messages




+
+	
+Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)


+
+        
[ Top ]

+  

+  

+	
+	
method process_attributes [line 160]

+	

+    

+    

+		array process_attributes(
+)
+    

+    


+	
+		Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




+
Tags:

+

+
+  
+    
+  
+
return:  list of info/error messages

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method save_attributes [line 118]

+	

+    

+    

+		array save_attributes(
+)
+    

+    


+	
+		Returns a list of modifications which have to be made to the LDAP account.




+
Tags:

+

+
+  
+    
+  
+
return:  list of modifications  
This function returns an array with 3 entries:  
array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )  
DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)  
"add" are attributes which have to be added to LDAP entry  
"remove" are attributes which have to be removed from LDAP entry  
"modify" are attributes which have to been modified in LDAP entry

+

+


+
+	
+Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)


+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:55 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/posixAccount.html b/lam-web/developers/phpdoc/modules/posixAccount.html
new file mode 100644
index 00000000..2785b1e6
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/posixAccount.html
@@ -0,0 +1,1363 @@
+
+
+Docs For Class posixAccount
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Class: posixAccount

+Source Location: /lib/modules/posixAccount.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
baseModule
+   |
+   --posixAccount


+
Manages the object class "posixAccount" for users and hosts.



+
+
+
+
+
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: baseModule

+

+

+  baseModule::$attributes
+  
+

+

+   
+

+

+  baseModule::$base
+  
+

+

+   
+

+

+  baseModule::$messages
+  
+

+

+   
+

+

+  baseModule::$meta
+  
+

+

+   
+

+

+  baseModule::$moduleSettings
+  
+

+

+   
+

+

+  baseModule::$orig
+  
+

+

+   
+

+

+  baseModule::$scope
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: baseModule

+

+    

+    baseModule::baseModule()
+
+  

+  

+    Creates a new base module class
+  

+    

+    baseModule::build_uploadAccounts()
+
+  

+  

+    In this function the LDAP account is built up.
+  

+    

+    baseModule::can_manage()
+
+  

+  

+    Returns true if this module fits for the current scope.
+  

+    

+    baseModule::checkSelfServiceOptions()
+
+  

+  

+    Checks if all input values are correct and returns the LDAP commands which should be executed.
+  

+    

+    baseModule::check_configOptions()
+
+  

+  

+    Checks input values of module settings.
+  

+    

+    baseModule::check_profileOptions()
+
+  

+  

+    Checks input values of account profiles.
+  

+    

+    baseModule::delete_attributes()
+
+  

+  

+    Dummy function for modules which use no special options on account deletion.
+  

+    

+    baseModule::display_html_delete()
+
+  

+  

+    Dummy function for modules which do not print extra HTML code on account deletion.
+  

+    

+    baseModule::doUploadPostActions()
+
+  

+  

+    This function executes one post upload action.
+  

+    

+    baseModule::getButtonStatus()
+
+  

+  

+    Controls if the module button the account page is visible and activated.
+  

+    

+    baseModule::getLDAPAliases()
+
+  

+  

+    Returns a list of aliases for LDAP attributes.
+  

+    

+    baseModule::getManagedAttributes()
+
+  

+  

+    Returns a list of LDAP attributes which are managed by this module.
+  

+    

+    baseModule::getManagedObjectClasses()
+
+  

+  

+    Returns a list of managed object classes for this module.
+  

+    

+    baseModule::getRequiredExtensions()
+
+  

+  

+    Returns a list of required PHP extensions.
+  

+    

+    baseModule::getSelfServiceFields()
+
+  

+  

+    Returns a list of possible input fields and their descriptions  Format: array(<field identifier> => <field description>)
+  

+    

+    baseModule::getSelfServiceOptions()
+
+  

+  

+    Returns the meta HTML code for each input field.
+  

+    

+    baseModule::getSelfServiceSearchAttributes()
+
+  

+  

+    Returns a list of possible search attributes for the self service.
+  

+    

+    baseModule::get_alias()
+
+  

+  

+    Returns an alias name for the module.
+  

+    

+    baseModule::get_configOptions()
+
+  

+  

+    Returns a list of elements for the configuration.
+  

+    

+    baseModule::get_dependencies()
+
+  

+  

+    This function returns a list with all depending and conflicting modules.
+  

+    

+    baseModule::get_help()
+
+  

+  

+    This function return the help entry array for a specific help id. Normally this->meta can be used.
+  

+    

+    baseModule::get_ldap_filter()
+
+  

+  

+    returns an LDAP filter for the account lists
+  

+    

+    baseModule::get_metaData()
+
+  

+  

+    Dummy function, meta data is provided by sub classes.
+  

+    

+    baseModule::get_pdfFields()
+
+  

+  

+    Returns an array with all fields available for this account type on the PDF  output. This method may be overwritten by subclasses or it may be used  by using entries in the $this->meta['PDF_fields'] array of the specific sub-  class.
+  

+    

+    baseModule::get_pdf_entries()
+
+  

+  

+    Returns a hastable with all entries that may be printed out in the PDF. The
+  

+    

+    baseModule::get_profileOptions()
+
+  

+  

+    Returns a list of elements for the account profiles.
+  

+    

+    baseModule::get_RDNAttributes()
+
+  

+  

+    Returns a list of possible LDAP attributes which can be used to form the RDN.
+  

+    

+    baseModule::get_scope()
+
+  

+  

+    Returns the account type of this module (user, group, host)
+  

+    

+    baseModule::get_uploadColumns()
+
+  

+  

+    Returns an array containing all input columns for the file upload.
+  

+    

+    baseModule::get_uploadPreDepends()
+
+  

+  

+    Returns a list of module names which must be processed in building the account befor this module.
+  

+    

+    baseModule::init()
+
+  

+  

+    Initializes the module after it became part of an accountContainer
+  

+    

+    baseModule::is_base_module()
+
+  

+  

+    Returns true if this module is enough to provide a sensible account.
+  

+    

+    baseModule::load_attributes()
+
+  

+  

+    This function loads the LDAP attributes for this module.
+  

+    

+    baseModule::load_Messages()
+
+  

+  

+    This function fills the $messages variable with output messages from this module.
+  

+    

+    baseModule::load_profile()
+
+  

+  

+    Loads the values of an account profile into internal variables.
+  

+    

+    baseModule::module_complete()
+
+  

+  

+    This functions is used to check if all settings for this module have been made.
+  

+    

+    baseModule::module_ready()
+
+  

+  

+    This function is used to check if this module page can be displayed.
+  

+    

+    baseModule::save_attributes()
+
+  

+  

+    Returns a list of modifications which have to be made to the LDAP account.
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 38]

+Manages the object class "posixAccount" for users and hosts.




+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$clearTextPassword = 

+	
[line 46]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$createhomedir = 

+	
[line 45]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$groups = 

+	
[line 43]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$groups_orig = 

+	
[line 44]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
method build_uploadAccounts [line 1098]

+	

+    

+    

+		array build_uploadAccounts(
+array
+$rawAccounts, array
+$ids, array
+&$partialAccounts)
+    

+    


+	
+		In this function the LDAP account is built up.




+
Tags:

+

+
+  
+    
+  
+
return:  list of error messages if any

+

+


+
+	
+Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)

+    


+        
[ Top ]

+  

+  

+	
+	
method checkASCII [line 730]

+	

+    

+    

+		string checkASCII(
+string
+$attribute)
+    

+    


+	
+		Checks if an attribute contains only ASCII charaters and replaces invalid characters.




+
Tags:

+

+
+  
+    
+  
+
return:  attribute value with replaced non-ASCII characters

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $attribute  attribute value

+    


+        
[ Top ]

+  

+  

+	
+	
method checkSelfServiceOptions [line 1521]

+	

+    

+    

+		array checkSelfServiceOptions(
+string
+$fields, array
+$attributes)
+    

+    


+	
+		Checks if all input values are correct and returns the LDAP commands which should be executed.




+
Tags:

+

+
+  
+    
+  
+
return:  messages and LDAP commands (array('messages' => array(), 'add' => array(), 'del' => array(), 'mod' => array()))

+

+


+
+	
+Overrides baseModule::checkSelfServiceOptions() (Checks if all input values are correct and returns the LDAP commands which should be executed.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
string  $fields  input fields
array  $attributes  LDAP attributes

+    


+        
[ Top ]

+  

+  

+	
+	
method check_configOptions [line 1039]

+	

+    

+    

+		array check_configOptions(
+array
+$scopes, array
+$options)
+    

+    


+	
+		Checks input values of module settings.




+
Tags:

+

+
+  
+    
+  
+
return:  list of error messages

+

+


+
+	
+Overrides baseModule::check_configOptions() (Checks input values of module settings.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $scopes  list of account types which are used
array  $options  hash array containing the settings (array('option' => array('value')))

+    


+        
[ Top ]

+  

+  

+	
+	
method delete_attributes [line 502]

+	

+    

+    

+		List delete_attributes(
+)
+    

+    


+	
+		Additional LDAP operations on delete.




+
Tags:

+

+
+  
+    
+  
+
return:  of LDAP operations, same as for save_attributes()

+

+


+
+	
+Overrides baseModule::delete_attributes() (Dummy function for modules which use no special options on account deletion.)


+
+        
[ Top ]

+  

+  

+	
+	
method display_html_attributes [line 794]

+	

+    

+    

+		void display_html_attributes(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method display_html_delete [line 872]

+	

+    

+    

+		void display_html_delete(
+)
+    

+    


+	
+		


+
+	
+Overrides baseModule::display_html_delete() (Dummy function for modules which do not print extra HTML code on account deletion.)


+
+        
[ Top ]

+  

+  

+	
+	
method display_html_group [line 887]

+	

+    

+    

+		array display_html_group(
+)
+    

+    


+	
+		Displays the group selection.




+
Tags:

+

+
+  
+    
+  
+
return:  meta HTML code

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method display_html_password [line 932]

+	

+    

+    

+		array display_html_password(
+)
+    

+    


+	
+		Displays the password changing dialog.




+
Tags:

+

+
+  
+    
+  
+
return:  meta HTML code

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method doUploadPostActions [line 1353]

+	

+    

+    

+		array doUploadPostActions(
+array
+$data, array
+$ids, array
+$failed, array
+&$temp)
+    

+    


+	
+		This function executes one post upload action.




+
Tags:

+

+
+  
+    
+  
+
return:  current status  
 array (  
  'status' => 'finished' | 'inProgress'  
  'progress' => 0..100  
  'errors' => array (<array of parameters for StatusMessage>)  
 )

+

+


+
+	
+Overrides baseModule::doUploadPostActions() (This function executes one post upload action.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $data  array containing one account in each element
array  $ids  array(<column_name> => <column number>)
array  $failed  list of accounts which were not created successfully
array  $temp  variable to store temporary data between two post actions

+    


+        
[ Top ]

+  

+  

+	
+	
method getNextUIDs [line 1435]

+	

+    

+    

+		mixed getNextUIDs(
+integer
+$count, array
+&$errors)
+    

+    


+	
+		Returns one or more free UID numbers.




+
Tags:

+

+
+  
+    
+  
+
return:  Null if no UIDs are free else an array of free UIDs.

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
integer  $count  Number of needed free UIDs.
array  $errors  list of error messages where errors can be added

+    


+        
[ Top ]

+  

+  

+	
+	
method getSelfServiceOptions [line 1501]

+	

+    

+    

+		array getSelfServiceOptions(
+array
+$fields, array
+$attributes)
+    

+    


+	
+		Returns the meta HTML code for each input field.

format: array(<field1> => array(<META HTML>), ...)  It is not possible to display help links.




+
Tags:

+

+
+  
+    
+  
+
return:  meta HTML

+

+


+
+	
+Overrides baseModule::getSelfServiceOptions() (Returns the meta HTML code for each input field.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $fields  list of active fields
array  $attributes  attributes of LDAP account (attribute names in lower case)

+    


+        
[ Top ]

+  

+  

+	
+	
method get_metaData [line 98]

+	

+    

+    

+		array get_metaData(
+)
+    

+    


+	
+		Returns meta data that is interpreted by parent class




+
Tags:

+

+
+  
+    
+  
+
return:  array with meta data

+

+


+
+	
+Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)


+
+        
[ Top ]

+  

+  

+	
+	
method get_pdfEntries [line 1014]

+	

+    

+    

+		array get_pdfEntries(
+)
+    

+    


+	
+		Returns the PDF entries for this module.




+
Tags:

+

+
+  
+    
+  
+
return:  list of possible PDF entries

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_profileOptions [line 954]

+	

+    

+    

+		profile get_profileOptions(
+)
+    

+    


+	
+		Returns a list of elements for the account profiles.




+
Tags:

+

+
+  
+    
+  
+
return:  elements

+

+


+
+	
+Overrides baseModule::get_profileOptions() (Returns a list of elements for the account profiles.)


+
+        
[ Top ]

+  

+  

+	
+	
method init [line 396]

+	

+    

+    

+		void init(
+mixed
+$base)
+    

+    


+	
+		


+
+	
+Overrides baseModule::init() (Initializes the module after it became part of an accountContainer)


+
+        
[ Top ]

+  

+  

+	
+	
method load_attributes [line 428]

+	

+    

+    

+		void load_attributes(
+array
+$attr)
+    

+    


+	
+		This function loads all needed LDAP attributes.




+
+	
+Overrides baseModule::load_attributes() (This function loads the LDAP attributes for this module.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
array  $attr  list of attributes

+    


+        
[ Top ]

+  

+  

+	
+	
method load_Messages [line 51]

+	

+    

+    

+		void load_Messages(
+)
+    

+    


+	
+		This function fills the error message array with messages.




+
+	
+Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)


+
+        
[ Top ]

+  

+  

+	
+	
method load_profile [line 992]

+	

+    

+    

+		void load_profile(
+array
+$profile)
+    

+    


+	
+		Loads the values of an account profile into internal variables.




+
+	
+Overrides baseModule::load_profile() (Loads the values of an account profile into internal variables.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
array  $profile  hash array with profile values (identifier => value)

+    


+        
[ Top ]

+  

+  

+	
+	
method module_complete [line 414]

+	

+    

+    

+		boolean module_complete(
+)
+    

+    


+	
+		This functions is used to check if all settings for this module have been made.




+
Tags:

+

+
+  
+    
+  
+
return:  true, if settings are complete

+

+


+
+	
+Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)


+
+        
[ Top ]

+  

+  

+	
+	
method process_attributes [line 521]

+	

+    

+    

+		array process_attributes(
+)
+    

+    


+	
+		Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




+
Tags:

+

+
+  
+    
+  
+
return:  list of info/error messages

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method process_group [line 755]

+	

+    

+    

+		array process_group(
+)
+    

+    


+	
+		Processes user input of the group selection page.

It checks if all input values are correct and updates the associated LDAP attributes.




+
Tags:

+

+
+  
+    
+  
+
return:  list of info/error messages

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method process_password [line 772]

+	

+    

+    

+		array process_password(
+)
+    

+    


+	
+		Processes user input of the password page.

It checks if all input values are correct and updates the associated LDAP attributes.




+
Tags:

+

+
+  
+    
+  
+
return:  list of info/error messages

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method save_attributes [line 454]

+	

+    

+    

+		array save_attributes(
+)
+    

+    


+	
+		Returns a list of modifications which have to be made to the LDAP account.




+
Tags:

+

+
+  
+    
+  
+
return:  list of modifications  
This function returns an array with 3 entries:  
array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )  
DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)  
"add" are attributes which have to be added to LDAP entry  
"remove" are attributes which have to be removed from LDAP entry  
"modify" are attributes which have to been modified in LDAP entry

+

+


+
+	
+Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)


+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:56 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/posixGroup.html b/lam-web/developers/phpdoc/modules/posixGroup.html
new file mode 100644
index 00000000..0f591741
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/posixGroup.html
@@ -0,0 +1,1032 @@
+
+
+Docs For Class posixGroup
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Class: posixGroup

+Source Location: /lib/modules/posixGroup.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
baseModule
+   |
+   --posixGroup


+
Manages the object class "posixGroup" for groups.



+
+
+
+
+
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: baseModule

+

+

+  baseModule::$attributes
+  
+

+

+   
+

+

+  baseModule::$base
+  
+

+

+   
+

+

+  baseModule::$messages
+  
+

+

+   
+

+

+  baseModule::$meta
+  
+

+

+   
+

+

+  baseModule::$moduleSettings
+  
+

+

+   
+

+

+  baseModule::$orig
+  
+

+

+   
+

+

+  baseModule::$scope
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: baseModule

+

+    

+    baseModule::baseModule()
+
+  

+  

+    Creates a new base module class
+  

+    

+    baseModule::build_uploadAccounts()
+
+  

+  

+    In this function the LDAP account is built up.
+  

+    

+    baseModule::can_manage()
+
+  

+  

+    Returns true if this module fits for the current scope.
+  

+    

+    baseModule::checkSelfServiceOptions()
+
+  

+  

+    Checks if all input values are correct and returns the LDAP commands which should be executed.
+  

+    

+    baseModule::check_configOptions()
+
+  

+  

+    Checks input values of module settings.
+  

+    

+    baseModule::check_profileOptions()
+
+  

+  

+    Checks input values of account profiles.
+  

+    

+    baseModule::delete_attributes()
+
+  

+  

+    Dummy function for modules which use no special options on account deletion.
+  

+    

+    baseModule::display_html_delete()
+
+  

+  

+    Dummy function for modules which do not print extra HTML code on account deletion.
+  

+    

+    baseModule::doUploadPostActions()
+
+  

+  

+    This function executes one post upload action.
+  

+    

+    baseModule::getButtonStatus()
+
+  

+  

+    Controls if the module button the account page is visible and activated.
+  

+    

+    baseModule::getLDAPAliases()
+
+  

+  

+    Returns a list of aliases for LDAP attributes.
+  

+    

+    baseModule::getManagedAttributes()
+
+  

+  

+    Returns a list of LDAP attributes which are managed by this module.
+  

+    

+    baseModule::getManagedObjectClasses()
+
+  

+  

+    Returns a list of managed object classes for this module.
+  

+    

+    baseModule::getRequiredExtensions()
+
+  

+  

+    Returns a list of required PHP extensions.
+  

+    

+    baseModule::getSelfServiceFields()
+
+  

+  

+    Returns a list of possible input fields and their descriptions  Format: array(<field identifier> => <field description>)
+  

+    

+    baseModule::getSelfServiceOptions()
+
+  

+  

+    Returns the meta HTML code for each input field.
+  

+    

+    baseModule::getSelfServiceSearchAttributes()
+
+  

+  

+    Returns a list of possible search attributes for the self service.
+  

+    

+    baseModule::get_alias()
+
+  

+  

+    Returns an alias name for the module.
+  

+    

+    baseModule::get_configOptions()
+
+  

+  

+    Returns a list of elements for the configuration.
+  

+    

+    baseModule::get_dependencies()
+
+  

+  

+    This function returns a list with all depending and conflicting modules.
+  

+    

+    baseModule::get_help()
+
+  

+  

+    This function return the help entry array for a specific help id. Normally this->meta can be used.
+  

+    

+    baseModule::get_ldap_filter()
+
+  

+  

+    returns an LDAP filter for the account lists
+  

+    

+    baseModule::get_metaData()
+
+  

+  

+    Dummy function, meta data is provided by sub classes.
+  

+    

+    baseModule::get_pdfFields()
+
+  

+  

+    Returns an array with all fields available for this account type on the PDF  output. This method may be overwritten by subclasses or it may be used  by using entries in the $this->meta['PDF_fields'] array of the specific sub-  class.
+  

+    

+    baseModule::get_pdf_entries()
+
+  

+  

+    Returns a hastable with all entries that may be printed out in the PDF. The
+  

+    

+    baseModule::get_profileOptions()
+
+  

+  

+    Returns a list of elements for the account profiles.
+  

+    

+    baseModule::get_RDNAttributes()
+
+  

+  

+    Returns a list of possible LDAP attributes which can be used to form the RDN.
+  

+    

+    baseModule::get_scope()
+
+  

+  

+    Returns the account type of this module (user, group, host)
+  

+    

+    baseModule::get_uploadColumns()
+
+  

+  

+    Returns an array containing all input columns for the file upload.
+  

+    

+    baseModule::get_uploadPreDepends()
+
+  

+  

+    Returns a list of module names which must be processed in building the account befor this module.
+  

+    

+    baseModule::init()
+
+  

+  

+    Initializes the module after it became part of an accountContainer
+  

+    

+    baseModule::is_base_module()
+
+  

+  

+    Returns true if this module is enough to provide a sensible account.
+  

+    

+    baseModule::load_attributes()
+
+  

+  

+    This function loads the LDAP attributes for this module.
+  

+    

+    baseModule::load_Messages()
+
+  

+  

+    This function fills the $messages variable with output messages from this module.
+  

+    

+    baseModule::load_profile()
+
+  

+  

+    Loads the values of an account profile into internal variables.
+  

+    

+    baseModule::module_complete()
+
+  

+  

+    This functions is used to check if all settings for this module have been made.
+  

+    

+    baseModule::module_ready()
+
+  

+  

+    This function is used to check if this module page can be displayed.
+  

+    

+    baseModule::save_attributes()
+
+  

+  

+    Returns a list of modifications which have to be made to the LDAP account.
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 39]

+Manages the object class "posixGroup" for groups.




+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$changegids = 

+	
[line 42]

+  change GIDs of users and hosts?


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
method build_uploadAccounts [line 53]

+	

+    

+    

+		array build_uploadAccounts(
+array
+$rawAccounts, array
+$ids, array
+&$partialAccounts)
+    

+    


+	
+		In this function the LDAP account is built up.




+
Tags:

+

+
+  
+    
+  
+
return:  list of error messages if any

+

+


+
+	
+Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)

+    


+        
[ Top ]

+  

+  

+	
+	
method delete_attributes [line 125]

+	

+    

+    

+		void delete_attributes(
+)
+    

+    


+	
+		


+
+	
+Overrides baseModule::delete_attributes() (Dummy function for modules which use no special options on account deletion.)


+
+        
[ Top ]

+  

+  

+	
+	
method display_html_attributes [line 146]

+	

+    

+    

+		void display_html_attributes(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method display_html_password [line 249]

+	

+    

+    

+		array display_html_password(
+)
+    

+    


+	
+		Displays the password changing dialog.




+
Tags:

+

+
+  
+    
+  
+
return:  meta HTML code

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method display_html_user [line 202]

+	

+    

+    

+		array display_html_user(
+)
+    

+    


+	
+		Displays selections to add or remove users from current group.




+
Tags:

+

+
+  
+    
+  
+
return:  meta HTML output

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getButtonStatus [line 495]

+	

+    

+    

+		string getButtonStatus(
+)
+    

+    


+	
+		Controls if the module button the account page is visible and activated.




+
Tags:

+

+
+  
+    
+  
+
return:  status ("enabled", "disabled", "hidden")

+

+


+
+	
+Overrides baseModule::getButtonStatus() (Controls if the module button the account page is visible and activated.)


+
+        
[ Top ]

+  

+  

+	
+	
method getNextGIDs [line 728]

+	

+    

+    

+		mixed getNextGIDs(
+integer
+$count, array
+&$errors)
+    

+    


+	
+		Returns one or more free GID numbers.




+
Tags:

+

+
+  
+    
+  
+
return:  Null if no GIDs are free else an array of free GIDs.

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
integer  $count  Number of needed free GIDs.
array  $errors  list of error messages where errors can be added

+    


+        
[ Top ]

+  

+  

+	
+	
method get_configOptions [line 410]

+	

+    

+    

+		array get_configOptions(
+array
+$scopes, array
+$allScopes)
+    

+    


+	
+		Returns a list of elements for the configuration.




+
Tags:

+

+
+  
+    
+  
+
return:  configuration elements

+

+


+
+	
+Overrides baseModule::get_configOptions() (Returns a list of elements for the configuration.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $scopes  account types (user, group, host)
array  $allScopes  list of all modules and active scopes

+    


+        
[ Top ]

+  

+  

+	
+	
method get_metaData [line 271]

+	

+    

+    

+		array get_metaData(
+)
+    

+    


+	
+		Returns meta data that is interpreted by parent class




+
Tags:

+

+
+  
+    
+  
+
return:  array with meta data

+

+


+
+	
+Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)


+
+        
[ Top ]

+  

+  

+	
+	
method get_pdfEntries [line 431]

+	

+    

+    

+		array get_pdfEntries(
+)
+    

+    


+	
+		Returns the PDF entries for this module.




+
Tags:

+

+
+  
+    
+  
+
return:  list of possible PDF entries

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method init [line 441]

+	

+    

+    

+		void init(
+mixed
+$base)
+    

+    


+	
+		This functin will be called when the module will be loaded *




+
+	
+Overrides baseModule::init() (Initializes the module after it became part of an accountContainer)


+
+        
[ Top ]

+  

+  

+	
+	
method load_Messages [line 451]

+	

+    

+    

+		void load_Messages(
+)
+    

+    


+	
+		This function fills the $messages variable with output messages from this module.




+
+	
+Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)


+
+        
[ Top ]

+  

+  

+	
+	
method module_complete [line 476]

+	

+    

+    

+		boolean module_complete(
+)
+    

+    


+	
+		This functions is used to check if all settings for this module have been made.




+
Tags:

+

+
+  
+    
+  
+
return:  true, if settings are complete

+

+


+
+	
+Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)


+
+        
[ Top ]

+  

+  

+	
+	
method process_attributes [line 513]

+	

+    

+    

+		array process_attributes(
+)
+    

+    


+	
+		Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




+
Tags:

+

+
+  
+    
+  
+
return:  list of info/error messages

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method process_password [line 659]

+	

+    

+    

+		array process_password(
+)
+    

+    


+	
+		Processes user input of the password page.

It checks if all input values are correct and updates the associated LDAP attributes.




+
Tags:

+

+
+  
+    
+  
+
return:  list of info/error messages

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method process_user [line 640]

+	

+    

+    

+		array process_user(
+)
+    

+    


+	
+		Processes user input of the user selection page.

It checks if all input values are correct and updates the associated LDAP attributes.




+
Tags:

+

+
+  
+    
+  
+
return:  list of info/error messages

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method save_attributes [line 681]

+	

+    

+    

+		void save_attributes(
+)
+    

+    


+	
+		


+
+	
+Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)


+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:58 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/quota.html b/lam-web/developers/phpdoc/modules/quota.html
new file mode 100644
index 00000000..a9ec58e0
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/quota.html
@@ -0,0 +1,963 @@
+
+
+Docs For Class quota
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Class: quota

+Source Location: /lib/modules/quota.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
baseModule
+   |
+   --quota


+
Manages quotas for users and groups.



+
+
+
+
+
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: baseModule

+

+

+  baseModule::$attributes
+  
+

+

+   
+

+

+  baseModule::$base
+  
+

+

+   
+

+

+  baseModule::$messages
+  
+

+

+   
+

+

+  baseModule::$meta
+  
+

+

+   
+

+

+  baseModule::$moduleSettings
+  
+

+

+   
+

+

+  baseModule::$orig
+  
+

+

+   
+

+

+  baseModule::$scope
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: baseModule

+

+    

+    baseModule::baseModule()
+
+  

+  

+    Creates a new base module class
+  

+    

+    baseModule::build_uploadAccounts()
+
+  

+  

+    In this function the LDAP account is built up.
+  

+    

+    baseModule::can_manage()
+
+  

+  

+    Returns true if this module fits for the current scope.
+  

+    

+    baseModule::checkSelfServiceOptions()
+
+  

+  

+    Checks if all input values are correct and returns the LDAP commands which should be executed.
+  

+    

+    baseModule::check_configOptions()
+
+  

+  

+    Checks input values of module settings.
+  

+    

+    baseModule::check_profileOptions()
+
+  

+  

+    Checks input values of account profiles.
+  

+    

+    baseModule::delete_attributes()
+
+  

+  

+    Dummy function for modules which use no special options on account deletion.
+  

+    

+    baseModule::display_html_delete()
+
+  

+  

+    Dummy function for modules which do not print extra HTML code on account deletion.
+  

+    

+    baseModule::doUploadPostActions()
+
+  

+  

+    This function executes one post upload action.
+  

+    

+    baseModule::getButtonStatus()
+
+  

+  

+    Controls if the module button the account page is visible and activated.
+  

+    

+    baseModule::getLDAPAliases()
+
+  

+  

+    Returns a list of aliases for LDAP attributes.
+  

+    

+    baseModule::getManagedAttributes()
+
+  

+  

+    Returns a list of LDAP attributes which are managed by this module.
+  

+    

+    baseModule::getManagedObjectClasses()
+
+  

+  

+    Returns a list of managed object classes for this module.
+  

+    

+    baseModule::getRequiredExtensions()
+
+  

+  

+    Returns a list of required PHP extensions.
+  

+    

+    baseModule::getSelfServiceFields()
+
+  

+  

+    Returns a list of possible input fields and their descriptions  Format: array(<field identifier> => <field description>)
+  

+    

+    baseModule::getSelfServiceOptions()
+
+  

+  

+    Returns the meta HTML code for each input field.
+  

+    

+    baseModule::getSelfServiceSearchAttributes()
+
+  

+  

+    Returns a list of possible search attributes for the self service.
+  

+    

+    baseModule::get_alias()
+
+  

+  

+    Returns an alias name for the module.
+  

+    

+    baseModule::get_configOptions()
+
+  

+  

+    Returns a list of elements for the configuration.
+  

+    

+    baseModule::get_dependencies()
+
+  

+  

+    This function returns a list with all depending and conflicting modules.
+  

+    

+    baseModule::get_help()
+
+  

+  

+    This function return the help entry array for a specific help id. Normally this->meta can be used.
+  

+    

+    baseModule::get_ldap_filter()
+
+  

+  

+    returns an LDAP filter for the account lists
+  

+    

+    baseModule::get_metaData()
+
+  

+  

+    Dummy function, meta data is provided by sub classes.
+  

+    

+    baseModule::get_pdfFields()
+
+  

+  

+    Returns an array with all fields available for this account type on the PDF  output. This method may be overwritten by subclasses or it may be used  by using entries in the $this->meta['PDF_fields'] array of the specific sub-  class.
+  

+    

+    baseModule::get_pdf_entries()
+
+  

+  

+    Returns a hastable with all entries that may be printed out in the PDF. The
+  

+    

+    baseModule::get_profileOptions()
+
+  

+  

+    Returns a list of elements for the account profiles.
+  

+    

+    baseModule::get_RDNAttributes()
+
+  

+  

+    Returns a list of possible LDAP attributes which can be used to form the RDN.
+  

+    

+    baseModule::get_scope()
+
+  

+  

+    Returns the account type of this module (user, group, host)
+  

+    

+    baseModule::get_uploadColumns()
+
+  

+  

+    Returns an array containing all input columns for the file upload.
+  

+    

+    baseModule::get_uploadPreDepends()
+
+  

+  

+    Returns a list of module names which must be processed in building the account befor this module.
+  

+    

+    baseModule::init()
+
+  

+  

+    Initializes the module after it became part of an accountContainer
+  

+    

+    baseModule::is_base_module()
+
+  

+  

+    Returns true if this module is enough to provide a sensible account.
+  

+    

+    baseModule::load_attributes()
+
+  

+  

+    This function loads the LDAP attributes for this module.
+  

+    

+    baseModule::load_Messages()
+
+  

+  

+    This function fills the $messages variable with output messages from this module.
+  

+    

+    baseModule::load_profile()
+
+  

+  

+    Loads the values of an account profile into internal variables.
+  

+    

+    baseModule::module_complete()
+
+  

+  

+    This functions is used to check if all settings for this module have been made.
+  

+    

+    baseModule::module_ready()
+
+  

+  

+    This function is used to check if this module page can be displayed.
+  

+    

+    baseModule::save_attributes()
+
+  

+  

+    Returns a list of modifications which have to be made to the LDAP account.
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 39]

+Manages quotas for users and groups.




+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$quota = 

+	
[line 172]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
method check_profileOptions [line 395]

+	

+    

+    

+		array check_profileOptions(
+array
+$options)
+    

+    


+	
+		Checks input values of account profiles.




+
Tags:

+

+
+  
+    
+  
+
return:  list of error messages (array(type, title, text)) to generate StatusMessages, if any

+

+


+
+	
+Overrides baseModule::check_profileOptions() (Checks input values of account profiles.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
array  $options  a hash array (name => value) containing the options

+    


+        
[ Top ]

+  

+  

+	
+	
method delete_attributes [line 257]

+	

+    

+    

+		void delete_attributes(
+)
+    

+    


+	
+		


+
+	
+Overrides baseModule::delete_attributes() (Dummy function for modules which use no special options on account deletion.)


+
+        
[ Top ]

+  

+  

+	
+	
method display_html_attributes [line 308]

+	

+    

+    

+		void display_html_attributes(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method doUploadPostActions [line 510]

+	

+    

+    

+		array doUploadPostActions(
+array
+$data, array
+$ids, array
+$failed, array
+&$temp)
+    

+    


+	
+		This function executes one post upload action.




+
Tags:

+

+
+  
+    
+  
+
return:  current status  
 array (  
  'status' => 'finished' | 'inProgress'  
  'progress' => 0..100  
  'errors' => array (<array of parameters for StatusMessage>)  
 )

+

+


+
+	
+Overrides baseModule::doUploadPostActions() (This function executes one post upload action.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $data  array containing one account in each element
array  $ids  array(<column_name> => <column number>)
array  $failed  list of accounts which were not created successfully
array  $temp  variable to store temporary data between two post actions

+    


+        
[ Top ]

+  

+  

+	
+	
method get_metaData [line 65]

+	

+    

+    

+		array get_metaData(
+)
+    

+    


+	
+		Returns meta data that is interpreted by parent class




+
Tags:

+

+
+  
+    
+  
+
return:  array with meta data

+

+


+
+	
+Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)


+
+        
[ Top ]

+  

+  

+	
+	
method get_pdfEntries [line 437]

+	

+    

+    

+		array get_pdfEntries(
+)
+    

+    


+	
+		Returns the PDF entries for this module.




+
Tags:

+

+
+  
+    
+  
+
return:  list of possible PDF entries

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_profileOptions [line 352]

+	

+    

+    

+		profile get_profileOptions(
+)
+    

+    


+	
+		Returns a list of elements for the account profiles.




+
Tags:

+

+
+  
+    
+  
+
return:  elements

+

+


+
+	
+Overrides baseModule::get_profileOptions() (Returns a list of elements for the account profiles.)


+
+        
[ Top ]

+  

+  

+	
+	
method get_uploadColumns [line 476]

+	

+    

+    

+		array get_uploadColumns(
+)
+    

+    


+	
+		Returns an array containing all input columns for the file upload.

Syntax:  
 array(  
  string: name,  // fixed non-translated name which is used as column name (should be of format: <module name>_<column name>)  
  string: description,  // short descriptive name  
  string: help,  // help ID  
  string: example,  // example value  
  boolean: required  // true, if user must set a value for this column  
 )




+
Tags:

+

+
+  
+    
+  
+
return:  column list

+

+


+
+	
+Overrides baseModule::get_uploadColumns() (Returns an array containing all input columns for the file upload.)


+
+        
[ Top ]

+  

+  

+	
+	
method init [line 130]

+	

+    

+    

+		void init(
+mixed
+$base)
+    

+    


+	
+		


+
+	
+Overrides baseModule::init() (Initializes the module after it became part of an accountContainer)


+
+        
[ Top ]

+  

+  

+	
+	
method load_attributes [line 191]

+	

+    

+    

+		void load_attributes(
+mixed
+$attr)
+    

+    


+	
+		


+
+	
+Overrides baseModule::load_attributes() (This function loads the LDAP attributes for this module.)


+
+        
[ Top ]

+  

+  

+	
+	
method load_Messages [line 43]

+	

+    

+    

+		void load_Messages(
+)
+    

+    


+	
+		this functin fills the error message array with messages




+
+	
+Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)


+
+        
[ Top ]

+  

+  

+	
+	
method load_profile [line 422]

+	

+    

+    

+		void load_profile(
+array
+$profile)
+    

+    


+	
+		Loads the values of an account profile into internal variables.




+
+	
+Overrides baseModule::load_profile() (Loads the values of an account profile into internal variables.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
array  $profile  hash array with profile values (identifier => value)

+    


+        
[ Top ]

+  

+  

+	
+	
method module_complete [line 183]

+	

+    

+    

+		void module_complete(
+)
+    

+    


+	
+		


+
+	
+Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)


+
+        
[ Top ]

+  

+  

+	
+	
method module_ready [line 174]

+	

+    

+    

+		void module_ready(
+)
+    

+    


+	
+		


+
+	
+Overrides baseModule::module_ready() (This function is used to check if this module page can be displayed.)


+
+        
[ Top ]

+  

+  

+	
+	
method process_attributes [line 276]

+	

+    

+    

+		array process_attributes(
+)
+    

+    


+	
+		Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




+
Tags:

+

+
+  
+    
+  
+
return:  list of info/error messages

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method save_attributes [line 231]

+	

+    

+    

+		void save_attributes(
+)
+    

+    


+	
+		


+
+	
+Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)


+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:00 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/samba3domain.html b/lam-web/developers/phpdoc/modules/samba3domain.html
new file mode 100644
index 00000000..97576e34
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/samba3domain.html
@@ -0,0 +1,295 @@
+
+
+Docs For Class samba3domain
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Class: samba3domain

+Source Location: /lib/account.inc


+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+


+
Represents a Samba 3 domain entry



+
+
+
+
+
+
+        
+		
+
Variables

+
+

+

+
+
+
+
+
+
+
+
+
+

+

+
+
+
Class Details

+

+[line 433]

+Represents a Samba 3 domain entry




+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$dn = 

+	
[line 436]

+  DN


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$name = 

+	
[line 439]

+  Domain name


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$nextGroupRID = 

+	
[line 451]

+  Next group RID


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$nextRID = 

+	
[line 445]

+  Next RID


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$nextUserRID = 

+	
[line 448]

+  Next user RID


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$RIDbase =  1000

+	
[line 454]

+  RID base to calculate RIDs, default 1000


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$SID = 

+	
[line 442]

+  Domain SID


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:35 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/sambaAccount.html b/lam-web/developers/phpdoc/modules/sambaAccount.html
new file mode 100644
index 00000000..4e70b822
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/sambaAccount.html
@@ -0,0 +1,1003 @@
+
+
+Docs For Class sambaAccount
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Class: sambaAccount

+Source Location: /lib/modules/sambaAccount.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
baseModule
+   |
+   --sambaAccount


+
Manages the object class "sambaAccount" for users and hosts.



+
+
+
+
+
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: baseModule

+

+

+  baseModule::$attributes
+  
+

+

+   
+

+

+  baseModule::$base
+  
+

+

+   
+

+

+  baseModule::$messages
+  
+

+

+   
+

+

+  baseModule::$meta
+  
+

+

+   
+

+

+  baseModule::$moduleSettings
+  
+

+

+   
+

+

+  baseModule::$orig
+  
+

+

+   
+

+

+  baseModule::$scope
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: baseModule

+

+    

+    baseModule::baseModule()
+
+  

+  

+    Creates a new base module class
+  

+    

+    baseModule::build_uploadAccounts()
+
+  

+  

+    In this function the LDAP account is built up.
+  

+    

+    baseModule::can_manage()
+
+  

+  

+    Returns true if this module fits for the current scope.
+  

+    

+    baseModule::checkSelfServiceOptions()
+
+  

+  

+    Checks if all input values are correct and returns the LDAP commands which should be executed.
+  

+    

+    baseModule::check_configOptions()
+
+  

+  

+    Checks input values of module settings.
+  

+    

+    baseModule::check_profileOptions()
+
+  

+  

+    Checks input values of account profiles.
+  

+    

+    baseModule::delete_attributes()
+
+  

+  

+    Dummy function for modules which use no special options on account deletion.
+  

+    

+    baseModule::display_html_delete()
+
+  

+  

+    Dummy function for modules which do not print extra HTML code on account deletion.
+  

+    

+    baseModule::doUploadPostActions()
+
+  

+  

+    This function executes one post upload action.
+  

+    

+    baseModule::getButtonStatus()
+
+  

+  

+    Controls if the module button the account page is visible and activated.
+  

+    

+    baseModule::getLDAPAliases()
+
+  

+  

+    Returns a list of aliases for LDAP attributes.
+  

+    

+    baseModule::getManagedAttributes()
+
+  

+  

+    Returns a list of LDAP attributes which are managed by this module.
+  

+    

+    baseModule::getManagedObjectClasses()
+
+  

+  

+    Returns a list of managed object classes for this module.
+  

+    

+    baseModule::getRequiredExtensions()
+
+  

+  

+    Returns a list of required PHP extensions.
+  

+    

+    baseModule::getSelfServiceFields()
+
+  

+  

+    Returns a list of possible input fields and their descriptions  Format: array(<field identifier> => <field description>)
+  

+    

+    baseModule::getSelfServiceOptions()
+
+  

+  

+    Returns the meta HTML code for each input field.
+  

+    

+    baseModule::getSelfServiceSearchAttributes()
+
+  

+  

+    Returns a list of possible search attributes for the self service.
+  

+    

+    baseModule::get_alias()
+
+  

+  

+    Returns an alias name for the module.
+  

+    

+    baseModule::get_configOptions()
+
+  

+  

+    Returns a list of elements for the configuration.
+  

+    

+    baseModule::get_dependencies()
+
+  

+  

+    This function returns a list with all depending and conflicting modules.
+  

+    

+    baseModule::get_help()
+
+  

+  

+    This function return the help entry array for a specific help id. Normally this->meta can be used.
+  

+    

+    baseModule::get_ldap_filter()
+
+  

+  

+    returns an LDAP filter for the account lists
+  

+    

+    baseModule::get_metaData()
+
+  

+  

+    Dummy function, meta data is provided by sub classes.
+  

+    

+    baseModule::get_pdfFields()
+
+  

+  

+    Returns an array with all fields available for this account type on the PDF  output. This method may be overwritten by subclasses or it may be used  by using entries in the $this->meta['PDF_fields'] array of the specific sub-  class.
+  

+    

+    baseModule::get_pdf_entries()
+
+  

+  

+    Returns a hastable with all entries that may be printed out in the PDF. The
+  

+    

+    baseModule::get_profileOptions()
+
+  

+  

+    Returns a list of elements for the account profiles.
+  

+    

+    baseModule::get_RDNAttributes()
+
+  

+  

+    Returns a list of possible LDAP attributes which can be used to form the RDN.
+  

+    

+    baseModule::get_scope()
+
+  

+  

+    Returns the account type of this module (user, group, host)
+  

+    

+    baseModule::get_uploadColumns()
+
+  

+  

+    Returns an array containing all input columns for the file upload.
+  

+    

+    baseModule::get_uploadPreDepends()
+
+  

+  

+    Returns a list of module names which must be processed in building the account befor this module.
+  

+    

+    baseModule::init()
+
+  

+  

+    Initializes the module after it became part of an accountContainer
+  

+    

+    baseModule::is_base_module()
+
+  

+  

+    Returns true if this module is enough to provide a sensible account.
+  

+    

+    baseModule::load_attributes()
+
+  

+  

+    This function loads the LDAP attributes for this module.
+  

+    

+    baseModule::load_Messages()
+
+  

+  

+    This function fills the $messages variable with output messages from this module.
+  

+    

+    baseModule::load_profile()
+
+  

+  

+    Loads the values of an account profile into internal variables.
+  

+    

+    baseModule::module_complete()
+
+  

+  

+    This functions is used to check if all settings for this module have been made.
+  

+    

+    baseModule::module_ready()
+
+  

+  

+    This function is used to check if this module page can be displayed.
+  

+    

+    baseModule::save_attributes()
+
+  

+  

+    Returns a list of modifications which have to be made to the LDAP account.
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 38]

+Manages the object class "sambaAccount" for users and hosts.




+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$deactivated = 

+	
[line 433]

+  account deactivated?


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$noexpire = 

+	
[line 431]

+  password does not expire?


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$nopwd = 

+	
[line 429]

+  use no password?


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$rids = 

+	
[line 436]

+  Array of well known rids


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$useunixpwd = 

+	
[line 427]

+  use Unix password as samba password?


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor sambaAccount [line 45]

+	

+    

+    

+		sambaAccount sambaAccount(
+string
+$scope)
+    

+    


+	
+		Creates a new sambaAccount object.




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $scope  account type (user, group, host)

+    


+        
[ Top ]

+  

+  

+	
+	
method build_uploadAccounts [line 872]

+	

+    

+    

+		array build_uploadAccounts(
+array
+$rawAccounts, array
+$ids, array
+&$partialAccounts)
+    

+    


+	
+		In this function the LDAP account is built up.




+
Tags:

+

+
+  
+    
+  
+
return:  list of error messages if any

+

+


+
+	
+Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)

+    


+        
[ Top ]

+  

+  

+	
+	
method display_html_attributes [line 696]

+	

+    

+    

+		void display_html_attributes(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method display_html_userWorkstations [line 819]

+	

+    

+    

+		void display_html_userWorkstations(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_metaData [line 96]

+	

+    

+    

+		array get_metaData(
+)
+    

+    


+	
+		Returns meta data that is interpreted by parent class




+
Tags:

+

+
+  
+    
+  
+
return:  array with meta data

+

+


+
+	
+Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)


+
+        
[ Top ]

+  

+  

+	
+	
method get_pdfEntries [line 853]

+	

+    

+    

+		array get_pdfEntries(
+)
+    

+    


+	
+		Returns the PDF entries for this module.




+
Tags:

+

+
+  
+    
+  
+
return:  list of possible PDF entries

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method init [line 416]

+	

+    

+    

+		void init(
+string
+$base)
+    

+    


+	
+		Initializes the module after it became part of an accountContainer




+
+	
+Overrides baseModule::init() (Initializes the module after it became part of an accountContainer)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $base  the name of the accountContainer object ($_SESSION[$base])

+    


+        
[ Top ]

+  

+  

+	
+	
method load_attributes [line 458]

+	

+    

+    

+		void load_attributes(
+mixed
+$attr)
+    

+    


+	
+		


+
+	
+Overrides baseModule::load_attributes() (This function loads the LDAP attributes for this module.)


+
+        
[ Top ]

+  

+  

+	
+	
method load_Messages [line 59]

+	

+    

+    

+		void load_Messages(
+)
+    

+    


+	
+		this functin fills the error message array with messages




+
+	
+Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)


+
+        
[ Top ]

+  

+  

+	
+	
method load_profile [line 1122]

+	

+    

+    

+		void load_profile(
+array
+$profile)
+    

+    


+	
+		Loads the values of an account profile into internal variables.




+
+	
+Overrides baseModule::load_profile() (Loads the values of an account profile into internal variables.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
array  $profile  hash array with profile values (identifier => value)

+    


+        
[ Top ]

+  

+  

+	
+	
method module_complete [line 449]

+	

+    

+    

+		boolean module_complete(
+)
+    

+    


+	
+		This functions returns true if all needed settings are done




+
Tags:

+

+
+  
+    
+  
+
return:  true if ready to save account

+

+


+
+	
+Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)


+
+        
[ Top ]

+  

+  

+	
+	
method module_ready [line 438]

+	

+    

+    

+		void module_ready(
+)
+    

+    


+	
+		


+
+	
+Overrides baseModule::module_ready() (This function is used to check if this module page can be displayed.)


+
+        
[ Top ]

+  

+  

+	
+	
method process_attributes [line 504]

+	

+    

+    

+		array process_attributes(
+)
+    

+    


+	
+		Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




+
Tags:

+

+
+  
+    
+  
+
return:  list of info/error messages

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method process_userWorkstations [line 648]

+	

+    

+    

+		array process_userWorkstations(
+)
+    

+    


+	
+		Processes user input of the workstation selection page.

It checks if all input values are correct and updates the associated LDAP attributes.




+
Tags:

+

+
+  
+    
+  
+
return:  list of info/error messages

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method save_attributes [line 478]

+	

+    

+    

+		void save_attributes(
+)
+    

+    


+	
+		


+
+	
+Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)


+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:01 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/sambaDomain.html b/lam-web/developers/phpdoc/modules/sambaDomain.html
new file mode 100644
index 00000000..45cf445b
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/sambaDomain.html
@@ -0,0 +1,690 @@
+
+
+Docs For Class sambaDomain
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Class: sambaDomain

+Source Location: /lib/modules/sambaDomain.inc


+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
baseModule
+   |
+   --sambaDomain


+
Manages Samba 3 domain entries.



+
+
+
+
+
+
+        
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: baseModule

+

+

+  baseModule::$attributes
+  
+

+

+   
+

+

+  baseModule::$base
+  
+

+

+   
+

+

+  baseModule::$messages
+  
+

+

+   
+

+

+  baseModule::$meta
+  
+

+

+   
+

+

+  baseModule::$moduleSettings
+  
+

+

+   
+

+

+  baseModule::$orig
+  
+

+

+   
+

+

+  baseModule::$scope
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: baseModule

+

+    

+    baseModule::baseModule()
+
+  

+  

+    Creates a new base module class
+  

+    

+    baseModule::build_uploadAccounts()
+
+  

+  

+    In this function the LDAP account is built up.
+  

+    

+    baseModule::can_manage()
+
+  

+  

+    Returns true if this module fits for the current scope.
+  

+    

+    baseModule::checkSelfServiceOptions()
+
+  

+  

+    Checks if all input values are correct and returns the LDAP commands which should be executed.
+  

+    

+    baseModule::check_configOptions()
+
+  

+  

+    Checks input values of module settings.
+  

+    

+    baseModule::check_profileOptions()
+
+  

+  

+    Checks input values of account profiles.
+  

+    

+    baseModule::delete_attributes()
+
+  

+  

+    Dummy function for modules which use no special options on account deletion.
+  

+    

+    baseModule::display_html_delete()
+
+  

+  

+    Dummy function for modules which do not print extra HTML code on account deletion.
+  

+    

+    baseModule::doUploadPostActions()
+
+  

+  

+    This function executes one post upload action.
+  

+    

+    baseModule::getButtonStatus()
+
+  

+  

+    Controls if the module button the account page is visible and activated.
+  

+    

+    baseModule::getLDAPAliases()
+
+  

+  

+    Returns a list of aliases for LDAP attributes.
+  

+    

+    baseModule::getManagedAttributes()
+
+  

+  

+    Returns a list of LDAP attributes which are managed by this module.
+  

+    

+    baseModule::getManagedObjectClasses()
+
+  

+  

+    Returns a list of managed object classes for this module.
+  

+    

+    baseModule::getRequiredExtensions()
+
+  

+  

+    Returns a list of required PHP extensions.
+  

+    

+    baseModule::getSelfServiceFields()
+
+  

+  

+    Returns a list of possible input fields and their descriptions  Format: array(<field identifier> => <field description>)
+  

+    

+    baseModule::getSelfServiceOptions()
+
+  

+  

+    Returns the meta HTML code for each input field.
+  

+    

+    baseModule::getSelfServiceSearchAttributes()
+
+  

+  

+    Returns a list of possible search attributes for the self service.
+  

+    

+    baseModule::get_alias()
+
+  

+  

+    Returns an alias name for the module.
+  

+    

+    baseModule::get_configOptions()
+
+  

+  

+    Returns a list of elements for the configuration.
+  

+    

+    baseModule::get_dependencies()
+
+  

+  

+    This function returns a list with all depending and conflicting modules.
+  

+    

+    baseModule::get_help()
+
+  

+  

+    This function return the help entry array for a specific help id. Normally this->meta can be used.
+  

+    

+    baseModule::get_ldap_filter()
+
+  

+  

+    returns an LDAP filter for the account lists
+  

+    

+    baseModule::get_metaData()
+
+  

+  

+    Dummy function, meta data is provided by sub classes.
+  

+    

+    baseModule::get_pdfFields()
+
+  

+  

+    Returns an array with all fields available for this account type on the PDF  output. This method may be overwritten by subclasses or it may be used  by using entries in the $this->meta['PDF_fields'] array of the specific sub-  class.
+  

+    

+    baseModule::get_pdf_entries()
+
+  

+  

+    Returns a hastable with all entries that may be printed out in the PDF. The
+  

+    

+    baseModule::get_profileOptions()
+
+  

+  

+    Returns a list of elements for the account profiles.
+  

+    

+    baseModule::get_RDNAttributes()
+
+  

+  

+    Returns a list of possible LDAP attributes which can be used to form the RDN.
+  

+    

+    baseModule::get_scope()
+
+  

+  

+    Returns the account type of this module (user, group, host)
+  

+    

+    baseModule::get_uploadColumns()
+
+  

+  

+    Returns an array containing all input columns for the file upload.
+  

+    

+    baseModule::get_uploadPreDepends()
+
+  

+  

+    Returns a list of module names which must be processed in building the account befor this module.
+  

+    

+    baseModule::init()
+
+  

+  

+    Initializes the module after it became part of an accountContainer
+  

+    

+    baseModule::is_base_module()
+
+  

+  

+    Returns true if this module is enough to provide a sensible account.
+  

+    

+    baseModule::load_attributes()
+
+  

+  

+    This function loads the LDAP attributes for this module.
+  

+    

+    baseModule::load_Messages()
+
+  

+  

+    This function fills the $messages variable with output messages from this module.
+  

+    

+    baseModule::load_profile()
+
+  

+  

+    Loads the values of an account profile into internal variables.
+  

+    

+    baseModule::module_complete()
+
+  

+  

+    This functions is used to check if all settings for this module have been made.
+  

+    

+    baseModule::module_ready()
+
+  

+  

+    This function is used to check if this module page can be displayed.
+  

+    

+    baseModule::save_attributes()
+
+  

+  

+    Returns a list of modifications which have to be made to the LDAP account.
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 35]

+Manages Samba 3 domain entries.




+
[ Top ]


+
+
+

+
+
Class Methods

+

+
+  

+	
+	
method build_uploadAccounts [line 501]

+	

+    

+    

+		array build_uploadAccounts(
+array
+$rawAccounts, array
+$ids, array
+&$partialAccounts)
+    

+    


+	
+		In this function the LDAP account is built up.




+
Tags:

+

+
+  
+    
+  
+
return:  list of error messages if any

+

+


+
+	
+Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)

+    


+        
[ Top ]

+  

+  

+	
+	
method display_html_attributes [line 206]

+	

+    

+    

+		void display_html_attributes(
+)
+    

+    


+	
+		This function will create the meta HTML code to show a page with all attributes.




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_metaData [line 42]

+	

+    

+    

+		array get_metaData(
+)
+    

+    


+	
+		Returns meta data that is interpreted by parent class




+
Tags:

+

+
+  
+    
+  
+
return:  array with meta data

+

+


+
+	
+Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)


+
+        
[ Top ]

+  

+  

+	
+	
method get_pdfEntries [line 580]

+	

+    

+    

+		array get_pdfEntries(
+)
+    

+    


+	
+		Returns the PDF entries for this module.




+
Tags:

+

+
+  
+    
+  
+
return:  list of possible PDF entries

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method load_Messages [line 183]

+	

+    

+    

+		void load_Messages(
+)
+    

+    


+	
+		This function fills the error message array with messages




+
+	
+Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)


+
+        
[ Top ]

+  

+  

+	
+	
method process_attributes [line 350]

+	

+    

+    

+		array process_attributes(
+)
+    

+    


+	
+		Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




+
Tags:

+

+
+  
+    
+  
+
return:  list of info/error messages

+

+


+
+	
+
+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:02 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/sambaGroupMapping.html b/lam-web/developers/phpdoc/modules/sambaGroupMapping.html
new file mode 100644
index 00000000..605e9000
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/sambaGroupMapping.html
@@ -0,0 +1,907 @@
+
+
+Docs For Class sambaGroupMapping
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Class: sambaGroupMapping

+Source Location: /lib/modules/sambaGroupMapping.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
baseModule
+   |
+   --sambaGroupMapping


+
Manages the object class "sambaGroupMapping" for groups.



+
+
+
+
+
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: baseModule

+

+

+  baseModule::$attributes
+  
+

+

+   
+

+

+  baseModule::$base
+  
+

+

+   
+

+

+  baseModule::$messages
+  
+

+

+   
+

+

+  baseModule::$meta
+  
+

+

+   
+

+

+  baseModule::$moduleSettings
+  
+

+

+   
+

+

+  baseModule::$orig
+  
+

+

+   
+

+

+  baseModule::$scope
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: baseModule

+

+    

+    baseModule::baseModule()
+
+  

+  

+    Creates a new base module class
+  

+    

+    baseModule::build_uploadAccounts()
+
+  

+  

+    In this function the LDAP account is built up.
+  

+    

+    baseModule::can_manage()
+
+  

+  

+    Returns true if this module fits for the current scope.
+  

+    

+    baseModule::checkSelfServiceOptions()
+
+  

+  

+    Checks if all input values are correct and returns the LDAP commands which should be executed.
+  

+    

+    baseModule::check_configOptions()
+
+  

+  

+    Checks input values of module settings.
+  

+    

+    baseModule::check_profileOptions()
+
+  

+  

+    Checks input values of account profiles.
+  

+    

+    baseModule::delete_attributes()
+
+  

+  

+    Dummy function for modules which use no special options on account deletion.
+  

+    

+    baseModule::display_html_delete()
+
+  

+  

+    Dummy function for modules which do not print extra HTML code on account deletion.
+  

+    

+    baseModule::doUploadPostActions()
+
+  

+  

+    This function executes one post upload action.
+  

+    

+    baseModule::getButtonStatus()
+
+  

+  

+    Controls if the module button the account page is visible and activated.
+  

+    

+    baseModule::getLDAPAliases()
+
+  

+  

+    Returns a list of aliases for LDAP attributes.
+  

+    

+    baseModule::getManagedAttributes()
+
+  

+  

+    Returns a list of LDAP attributes which are managed by this module.
+  

+    

+    baseModule::getManagedObjectClasses()
+
+  

+  

+    Returns a list of managed object classes for this module.
+  

+    

+    baseModule::getRequiredExtensions()
+
+  

+  

+    Returns a list of required PHP extensions.
+  

+    

+    baseModule::getSelfServiceFields()
+
+  

+  

+    Returns a list of possible input fields and their descriptions  Format: array(<field identifier> => <field description>)
+  

+    

+    baseModule::getSelfServiceOptions()
+
+  

+  

+    Returns the meta HTML code for each input field.
+  

+    

+    baseModule::getSelfServiceSearchAttributes()
+
+  

+  

+    Returns a list of possible search attributes for the self service.
+  

+    

+    baseModule::get_alias()
+
+  

+  

+    Returns an alias name for the module.
+  

+    

+    baseModule::get_configOptions()
+
+  

+  

+    Returns a list of elements for the configuration.
+  

+    

+    baseModule::get_dependencies()
+
+  

+  

+    This function returns a list with all depending and conflicting modules.
+  

+    

+    baseModule::get_help()
+
+  

+  

+    This function return the help entry array for a specific help id. Normally this->meta can be used.
+  

+    

+    baseModule::get_ldap_filter()
+
+  

+  

+    returns an LDAP filter for the account lists
+  

+    

+    baseModule::get_metaData()
+
+  

+  

+    Dummy function, meta data is provided by sub classes.
+  

+    

+    baseModule::get_pdfFields()
+
+  

+  

+    Returns an array with all fields available for this account type on the PDF  output. This method may be overwritten by subclasses or it may be used  by using entries in the $this->meta['PDF_fields'] array of the specific sub-  class.
+  

+    

+    baseModule::get_pdf_entries()
+
+  

+  

+    Returns a hastable with all entries that may be printed out in the PDF. The
+  

+    

+    baseModule::get_profileOptions()
+
+  

+  

+    Returns a list of elements for the account profiles.
+  

+    

+    baseModule::get_RDNAttributes()
+
+  

+  

+    Returns a list of possible LDAP attributes which can be used to form the RDN.
+  

+    

+    baseModule::get_scope()
+
+  

+  

+    Returns the account type of this module (user, group, host)
+  

+    

+    baseModule::get_uploadColumns()
+
+  

+  

+    Returns an array containing all input columns for the file upload.
+  

+    

+    baseModule::get_uploadPreDepends()
+
+  

+  

+    Returns a list of module names which must be processed in building the account befor this module.
+  

+    

+    baseModule::init()
+
+  

+  

+    Initializes the module after it became part of an accountContainer
+  

+    

+    baseModule::is_base_module()
+
+  

+  

+    Returns true if this module is enough to provide a sensible account.
+  

+    

+    baseModule::load_attributes()
+
+  

+  

+    This function loads the LDAP attributes for this module.
+  

+    

+    baseModule::load_Messages()
+
+  

+  

+    This function fills the $messages variable with output messages from this module.
+  

+    

+    baseModule::load_profile()
+
+  

+  

+    Loads the values of an account profile into internal variables.
+  

+    

+    baseModule::module_complete()
+
+  

+  

+    This functions is used to check if all settings for this module have been made.
+  

+    

+    baseModule::module_ready()
+
+  

+  

+    This function is used to check if this module page can be displayed.
+  

+    

+    baseModule::save_attributes()
+
+  

+  

+    Returns a list of modifications which have to be made to the LDAP account.
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 39]

+Manages the object class "sambaGroupMapping" for groups.




+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$rids = 

+	
[line 43]

+  Array of well known RIDs


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$sambaGroupTypes = 

+	
[line 45]

+  Array of sambaGroupTypes


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor sambaGroupMapping [line 52]

+	

+    

+    

+		sambaGroupMapping sambaGroupMapping(
+string
+$scope)
+    

+    


+	
+		Creates a new module for Samba 3 groups.




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $scope  account type

+    


+        
[ Top ]

+  

+  

+	
+	
method build_uploadAccounts [line 101]

+	

+    

+    

+		array build_uploadAccounts(
+array
+$rawAccounts, array
+$ids, array
+&$partialAccounts)
+    

+    


+	
+		In this function the LDAP account is built up.




+
Tags:

+

+
+  
+    
+  
+
return:  list of error messages if any

+

+


+
+	
+Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)

+    


+        
[ Top ]

+  

+  

+	
+	
method display_html_attributes [line 170]

+	

+    

+    

+		void display_html_attributes(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_metaData [line 232]

+	

+    

+    

+		array get_metaData(
+)
+    

+    


+	
+		Returns meta data that is interpreted by parent class




+
Tags:

+

+
+  
+    
+  
+
return:  array with meta data

+

+


+
+	
+Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)


+
+        
[ Top ]

+  

+  

+	
+	
method get_pdfEntries [line 322]

+	

+    

+    

+		array get_pdfEntries(
+)
+    

+    


+	
+		Returns the PDF entries for this module.




+
Tags:

+

+
+  
+    
+  
+
return:  list of possible PDF entries

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_profileOptions [line 336]

+	

+    

+    

+		profile get_profileOptions(
+)
+    

+    


+	
+		Returns a list of elements for the account profiles.




+
Tags:

+

+
+  
+    
+  
+
return:  elements

+

+


+
+	
+Overrides baseModule::get_profileOptions() (Returns a list of elements for the account profiles.)


+
+        
[ Top ]

+  

+  

+	
+	
method init [line 83]

+	

+    

+    

+		void init(
+string
+$base)
+    

+    


+	
+		Initializes the module after it became part of an accountContainer




+
+	
+Overrides baseModule::init() (Initializes the module after it became part of an accountContainer)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $base  the name of the accountContainer object ($_SESSION[$base])

+    


+        
[ Top ]

+  

+  

+	
+	
method load_Messages [line 374]

+	

+    

+    

+		void load_Messages(
+)
+    

+    


+	
+		this functin fills the error message array with messages




+
+	
+Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)


+
+        
[ Top ]

+  

+  

+	
+	
method load_profile [line 359]

+	

+    

+    

+		void load_profile(
+array
+$profile)
+    

+    


+	
+		Loads the values of an account profile into internal variables.




+
+	
+Overrides baseModule::load_profile() (Loads the values of an account profile into internal variables.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
array  $profile  hash array with profile values (identifier => value)

+    


+        
[ Top ]

+  

+  

+	
+	
method module_complete [line 384]

+	

+    

+    

+		void module_complete(
+)
+    

+    


+	
+		


+
+	
+Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)


+
+        
[ Top ]

+  

+  

+	
+	
method module_ready [line 392]

+	

+    

+    

+		void module_ready(
+)
+    

+    


+	
+		


+
+	
+Overrides baseModule::module_ready() (This function is used to check if this module page can be displayed.)


+
+        
[ Top ]

+  

+  

+	
+	
method process_attributes [line 404]

+	

+    

+    

+		array process_attributes(
+)
+    

+    


+	
+		Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




+
Tags:

+

+
+  
+    
+  
+
return:  list of info/error messages

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method save_attributes [line 455]

+	

+    

+    

+		void save_attributes(
+)
+    

+    


+	
+		


+
+	
+Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)


+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:02 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/sambaSamAccount.html b/lam-web/developers/phpdoc/modules/sambaSamAccount.html
new file mode 100644
index 00000000..c5e0f6ad
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/sambaSamAccount.html
@@ -0,0 +1,1215 @@
+
+
+Docs For Class sambaSamAccount
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Class: sambaSamAccount

+Source Location: /lib/modules/sambaSamAccount.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
baseModule
+   |
+   --sambaSamAccount


+
Manages the object class "sambaSamAccount" for users and hosts.



+
+
+
+
+
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: baseModule

+

+

+  baseModule::$attributes
+  
+

+

+   
+

+

+  baseModule::$base
+  
+

+

+   
+

+

+  baseModule::$messages
+  
+

+

+   
+

+

+  baseModule::$meta
+  
+

+

+   
+

+

+  baseModule::$moduleSettings
+  
+

+

+   
+

+

+  baseModule::$orig
+  
+

+

+   
+

+

+  baseModule::$scope
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: baseModule

+

+    

+    baseModule::baseModule()
+
+  

+  

+    Creates a new base module class
+  

+    

+    baseModule::build_uploadAccounts()
+
+  

+  

+    In this function the LDAP account is built up.
+  

+    

+    baseModule::can_manage()
+
+  

+  

+    Returns true if this module fits for the current scope.
+  

+    

+    baseModule::checkSelfServiceOptions()
+
+  

+  

+    Checks if all input values are correct and returns the LDAP commands which should be executed.
+  

+    

+    baseModule::check_configOptions()
+
+  

+  

+    Checks input values of module settings.
+  

+    

+    baseModule::check_profileOptions()
+
+  

+  

+    Checks input values of account profiles.
+  

+    

+    baseModule::delete_attributes()
+
+  

+  

+    Dummy function for modules which use no special options on account deletion.
+  

+    

+    baseModule::display_html_delete()
+
+  

+  

+    Dummy function for modules which do not print extra HTML code on account deletion.
+  

+    

+    baseModule::doUploadPostActions()
+
+  

+  

+    This function executes one post upload action.
+  

+    

+    baseModule::getButtonStatus()
+
+  

+  

+    Controls if the module button the account page is visible and activated.
+  

+    

+    baseModule::getLDAPAliases()
+
+  

+  

+    Returns a list of aliases for LDAP attributes.
+  

+    

+    baseModule::getManagedAttributes()
+
+  

+  

+    Returns a list of LDAP attributes which are managed by this module.
+  

+    

+    baseModule::getManagedObjectClasses()
+
+  

+  

+    Returns a list of managed object classes for this module.
+  

+    

+    baseModule::getRequiredExtensions()
+
+  

+  

+    Returns a list of required PHP extensions.
+  

+    

+    baseModule::getSelfServiceFields()
+
+  

+  

+    Returns a list of possible input fields and their descriptions  Format: array(<field identifier> => <field description>)
+  

+    

+    baseModule::getSelfServiceOptions()
+
+  

+  

+    Returns the meta HTML code for each input field.
+  

+    

+    baseModule::getSelfServiceSearchAttributes()
+
+  

+  

+    Returns a list of possible search attributes for the self service.
+  

+    

+    baseModule::get_alias()
+
+  

+  

+    Returns an alias name for the module.
+  

+    

+    baseModule::get_configOptions()
+
+  

+  

+    Returns a list of elements for the configuration.
+  

+    

+    baseModule::get_dependencies()
+
+  

+  

+    This function returns a list with all depending and conflicting modules.
+  

+    

+    baseModule::get_help()
+
+  

+  

+    This function return the help entry array for a specific help id. Normally this->meta can be used.
+  

+    

+    baseModule::get_ldap_filter()
+
+  

+  

+    returns an LDAP filter for the account lists
+  

+    

+    baseModule::get_metaData()
+
+  

+  

+    Dummy function, meta data is provided by sub classes.
+  

+    

+    baseModule::get_pdfFields()
+
+  

+  

+    Returns an array with all fields available for this account type on the PDF  output. This method may be overwritten by subclasses or it may be used  by using entries in the $this->meta['PDF_fields'] array of the specific sub-  class.
+  

+    

+    baseModule::get_pdf_entries()
+
+  

+  

+    Returns a hastable with all entries that may be printed out in the PDF. The
+  

+    

+    baseModule::get_profileOptions()
+
+  

+  

+    Returns a list of elements for the account profiles.
+  

+    

+    baseModule::get_RDNAttributes()
+
+  

+  

+    Returns a list of possible LDAP attributes which can be used to form the RDN.
+  

+    

+    baseModule::get_scope()
+
+  

+  

+    Returns the account type of this module (user, group, host)
+  

+    

+    baseModule::get_uploadColumns()
+
+  

+  

+    Returns an array containing all input columns for the file upload.
+  

+    

+    baseModule::get_uploadPreDepends()
+
+  

+  

+    Returns a list of module names which must be processed in building the account befor this module.
+  

+    

+    baseModule::init()
+
+  

+  

+    Initializes the module after it became part of an accountContainer
+  

+    

+    baseModule::is_base_module()
+
+  

+  

+    Returns true if this module is enough to provide a sensible account.
+  

+    

+    baseModule::load_attributes()
+
+  

+  

+    This function loads the LDAP attributes for this module.
+  

+    

+    baseModule::load_Messages()
+
+  

+  

+    This function fills the $messages variable with output messages from this module.
+  

+    

+    baseModule::load_profile()
+
+  

+  

+    Loads the values of an account profile into internal variables.
+  

+    

+    baseModule::module_complete()
+
+  

+  

+    This functions is used to check if all settings for this module have been made.
+  

+    

+    baseModule::module_ready()
+
+  

+  

+    This function is used to check if this module page can be displayed.
+  

+    

+    baseModule::save_attributes()
+
+  

+  

+    Returns a list of modifications which have to be made to the LDAP account.
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 38]

+Manages the object class "sambaSamAccount" for users and hosts.




+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$deactivated = 

+	
[line 48]

+  account deactivated?


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$hex2bitstring = array('0' => '0000', '1' => '0001', '2' => '0010', '3' => '0011', '4' => '0100',

+      '5' => '0101', '6' => '0110', '7' => '0111', '8' => '1000', '9' => '1001', 'A' => '1010',

+      'B' => '1011', 'C' => '1100', 'D' => '1101', 'E' => '1110', 'F' => '1111')

+	
[line 52]

+  HEX to binary conversion table


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$noexpire = 

+	
[line 46]

+  password does not expire?


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$nopwd = 

+	
[line 44]

+  use no password?


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$rids = 

+	
[line 50]

+  array of well known rids


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$useunixpwd = 

+	
[line 42]

+  use Unix password as samba password?


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor sambaSamAccount [line 62]

+	

+    

+    

+		sambaSamAccount sambaSamAccount(
+string
+$scope)
+    

+    


+	
+		Creates a new sambaSamAccount object.




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $scope  account type (user, group, host)

+    


+        
[ Top ]

+  

+  

+	
+	
method build_uploadAccounts [line 1392]

+	

+    

+    

+		array build_uploadAccounts(
+array
+$rawAccounts, array
+$ids, array
+&$partialAccounts)
+    

+    


+	
+		In this function the LDAP account is built up.




+
Tags:

+

+
+  
+    
+  
+
return:  list of error messages if any

+

+


+
+	
+Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)

+    


+        
[ Top ]

+  

+  

+	
+	
method checkSelfServiceOptions [line 1726]

+	

+    

+    

+		array checkSelfServiceOptions(
+string
+$fields, array
+$attributes)
+    

+    


+	
+		Checks if all input values are correct and returns the LDAP commands which should be executed.




+
Tags:

+

+
+  
+    
+  
+
return:  messages and LDAP commands (array('messages' => array(), 'add' => array(), 'del' => array(), 'mod' => array()))

+

+


+
+	
+Overrides baseModule::checkSelfServiceOptions() (Checks if all input values are correct and returns the LDAP commands which should be executed.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
string  $fields  input fields
array  $attributes  LDAP attributes

+    


+        
[ Top ]

+  

+  

+	
+	
method display_html_attributes [line 828]

+	

+    

+    

+		void display_html_attributes(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method display_html_logonHours [line 1042]

+	

+    

+    

+		array display_html_logonHours(
+)
+    

+    


+	
+		This function will create the HTML page to edit logon hours.




+
Tags:

+

+
+  
+    
+  
+
return:  meta HTML code

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method display_html_sambaUserWorkstations [line 1008]

+	

+    

+    

+		void display_html_sambaUserWorkstations(
+)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method display_html_time [line 1105]

+	

+    

+    

+		array display_html_time(
+)
+    

+    


+	
+		This function will create the meta HTML code to show a page to change time values.




+
Tags:

+

+
+  
+    
+  
+
return:  meta HTML code

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_metaData [line 113]

+	

+    

+    

+		array get_metaData(
+)
+    

+    


+	
+		Returns meta data that is interpreted by parent class




+
Tags:

+

+
+  
+    
+  
+
return:  array with meta data

+

+


+
+	
+Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)


+
+        
[ Top ]

+  

+  

+	
+	
method get_pdfEntries [line 1373]

+	

+    

+    

+		array get_pdfEntries(
+)
+    

+    


+	
+		Returns the PDF entries for this module.




+
Tags:

+

+
+  
+    
+  
+
return:  list of possible PDF entries

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_profileOptions [line 1156]

+	

+    

+    

+		profile get_profileOptions(
+)
+    

+    


+	
+		Returns a list of elements for the account profiles.




+
Tags:

+

+
+  
+    
+  
+
return:  elements

+

+


+
+	
+Overrides baseModule::get_profileOptions() (Returns a list of elements for the account profiles.)


+
+        
[ Top ]

+  

+  

+	
+	
method init [line 462]

+	

+    

+    

+		void init(
+string
+$base)
+    

+    


+	
+		Initializes the module after it became part of an accountContainer




+
+	
+Overrides baseModule::init() (Initializes the module after it became part of an accountContainer)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $base  the name of the accountContainer object ($_SESSION[$base])

+    


+        
[ Top ]

+  

+  

+	
+	
method load_attributes [line 503]

+	

+    

+    

+		void load_attributes(
+mixed
+$attr)
+    

+    


+	
+		


+
+	
+Overrides baseModule::load_attributes() (This function loads the LDAP attributes for this module.)


+
+        
[ Top ]

+  

+  

+	
+	
method load_Messages [line 74]

+	

+    

+    

+		void load_Messages(
+)
+    

+    


+	
+		this functin fills the error message array with messages




+
+	
+Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)


+
+        
[ Top ]

+  

+  

+	
+	
method load_profile [line 1281]

+	

+    

+    

+		void load_profile(
+array
+$profile)
+    

+    


+	
+		Loads the values of an account profile into internal variables.




+
+	
+Overrides baseModule::load_profile() (Loads the values of an account profile into internal variables.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
array  $profile  hash array with profile values (identifier => value)

+    


+        
[ Top ]

+  

+  

+	
+	
method module_complete [line 494]

+	

+    

+    

+		boolean module_complete(
+)
+    

+    


+	
+		This functions is used to check if all settings for this module have been made.




+
Tags:

+

+
+  
+    
+  
+
return:  true, if settings are complete

+

+


+
+	
+Overrides baseModule::module_complete() (This functions is used to check if all settings for this module have been made.)


+
+        
[ Top ]

+  

+  

+	
+	
method module_ready [line 482]

+	

+    

+    

+		boolean module_ready(
+)
+    

+    


+	
+		This function is used to check if this module page can be displayed.

It returns false if a module depends on data from other modules which was not yet entered.




+
Tags:

+

+
+  
+    
+  
+
return:  true, if page can be displayed

+

+


+
+	
+Overrides baseModule::module_ready() (This function is used to check if this module page can be displayed.)


+
+        
[ Top ]

+  

+  

+	
+	
method process_attributes [line 551]

+	

+    

+    

+		array process_attributes(
+)
+    

+    


+	
+		Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




+
Tags:

+

+
+  
+    
+  
+
return:  list of info/error messages

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method process_logonHours [line 762]

+	

+    

+    

+		array process_logonHours(
+)
+    

+    


+	
+		Processes user input of the logon hours page.

It checks if all input values are correct and updates the associated LDAP attributes.




+
Tags:

+

+
+  
+    
+  
+
return:  list of info/error messages

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method process_sambaUserWorkstations [line 712]

+	

+    

+    

+		array process_sambaUserWorkstations(
+)
+    

+    


+	
+		Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




+
Tags:

+

+
+  
+    
+  
+
return:  list of info/error messages

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method process_time [line 788]

+	

+    

+    

+		array process_time(
+)
+    

+    


+	
+		Processes user input of the time selection page.




+
Tags:

+

+
+  
+    
+  
+
return:  list of info/error messages

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method save_attributes [line 523]

+	

+    

+    

+		void save_attributes(
+)
+    

+    


+	
+		


+
+	
+Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)


+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:03 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/shadowAccount.html b/lam-web/developers/phpdoc/modules/shadowAccount.html
new file mode 100644
index 00000000..1e7ec7d3
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/shadowAccount.html
@@ -0,0 +1,813 @@
+
+
+Docs For Class shadowAccount
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Class: shadowAccount

+Source Location: /lib/modules/shadowAccount.inc


+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
baseModule
+   |
+   --shadowAccount


+
Manages the object class "shadowAccount" for users.



+
+
+
+
+
+
+        
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: baseModule

+

+

+  baseModule::$attributes
+  
+

+

+   
+

+

+  baseModule::$base
+  
+

+

+   
+

+

+  baseModule::$messages
+  
+

+

+   
+

+

+  baseModule::$meta
+  
+

+

+   
+

+

+  baseModule::$moduleSettings
+  
+

+

+   
+

+

+  baseModule::$orig
+  
+

+

+   
+

+

+  baseModule::$scope
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: baseModule

+

+    

+    baseModule::baseModule()
+
+  

+  

+    Creates a new base module class
+  

+    

+    baseModule::build_uploadAccounts()
+
+  

+  

+    In this function the LDAP account is built up.
+  

+    

+    baseModule::can_manage()
+
+  

+  

+    Returns true if this module fits for the current scope.
+  

+    

+    baseModule::checkSelfServiceOptions()
+
+  

+  

+    Checks if all input values are correct and returns the LDAP commands which should be executed.
+  

+    

+    baseModule::check_configOptions()
+
+  

+  

+    Checks input values of module settings.
+  

+    

+    baseModule::check_profileOptions()
+
+  

+  

+    Checks input values of account profiles.
+  

+    

+    baseModule::delete_attributes()
+
+  

+  

+    Dummy function for modules which use no special options on account deletion.
+  

+    

+    baseModule::display_html_delete()
+
+  

+  

+    Dummy function for modules which do not print extra HTML code on account deletion.
+  

+    

+    baseModule::doUploadPostActions()
+
+  

+  

+    This function executes one post upload action.
+  

+    

+    baseModule::getButtonStatus()
+
+  

+  

+    Controls if the module button the account page is visible and activated.
+  

+    

+    baseModule::getLDAPAliases()
+
+  

+  

+    Returns a list of aliases for LDAP attributes.
+  

+    

+    baseModule::getManagedAttributes()
+
+  

+  

+    Returns a list of LDAP attributes which are managed by this module.
+  

+    

+    baseModule::getManagedObjectClasses()
+
+  

+  

+    Returns a list of managed object classes for this module.
+  

+    

+    baseModule::getRequiredExtensions()
+
+  

+  

+    Returns a list of required PHP extensions.
+  

+    

+    baseModule::getSelfServiceFields()
+
+  

+  

+    Returns a list of possible input fields and their descriptions  Format: array(<field identifier> => <field description>)
+  

+    

+    baseModule::getSelfServiceOptions()
+
+  

+  

+    Returns the meta HTML code for each input field.
+  

+    

+    baseModule::getSelfServiceSearchAttributes()
+
+  

+  

+    Returns a list of possible search attributes for the self service.
+  

+    

+    baseModule::get_alias()
+
+  

+  

+    Returns an alias name for the module.
+  

+    

+    baseModule::get_configOptions()
+
+  

+  

+    Returns a list of elements for the configuration.
+  

+    

+    baseModule::get_dependencies()
+
+  

+  

+    This function returns a list with all depending and conflicting modules.
+  

+    

+    baseModule::get_help()
+
+  

+  

+    This function return the help entry array for a specific help id. Normally this->meta can be used.
+  

+    

+    baseModule::get_ldap_filter()
+
+  

+  

+    returns an LDAP filter for the account lists
+  

+    

+    baseModule::get_metaData()
+
+  

+  

+    Dummy function, meta data is provided by sub classes.
+  

+    

+    baseModule::get_pdfFields()
+
+  

+  

+    Returns an array with all fields available for this account type on the PDF  output. This method may be overwritten by subclasses or it may be used  by using entries in the $this->meta['PDF_fields'] array of the specific sub-  class.
+  

+    

+    baseModule::get_pdf_entries()
+
+  

+  

+    Returns a hastable with all entries that may be printed out in the PDF. The
+  

+    

+    baseModule::get_profileOptions()
+
+  

+  

+    Returns a list of elements for the account profiles.
+  

+    

+    baseModule::get_RDNAttributes()
+
+  

+  

+    Returns a list of possible LDAP attributes which can be used to form the RDN.
+  

+    

+    baseModule::get_scope()
+
+  

+  

+    Returns the account type of this module (user, group, host)
+  

+    

+    baseModule::get_uploadColumns()
+
+  

+  

+    Returns an array containing all input columns for the file upload.
+  

+    

+    baseModule::get_uploadPreDepends()
+
+  

+  

+    Returns a list of module names which must be processed in building the account befor this module.
+  

+    

+    baseModule::init()
+
+  

+  

+    Initializes the module after it became part of an accountContainer
+  

+    

+    baseModule::is_base_module()
+
+  

+  

+    Returns true if this module is enough to provide a sensible account.
+  

+    

+    baseModule::load_attributes()
+
+  

+  

+    This function loads the LDAP attributes for this module.
+  

+    

+    baseModule::load_Messages()
+
+  

+  

+    This function fills the $messages variable with output messages from this module.
+  

+    

+    baseModule::load_profile()
+
+  

+  

+    Loads the values of an account profile into internal variables.
+  

+    

+    baseModule::module_complete()
+
+  

+  

+    This functions is used to check if all settings for this module have been made.
+  

+    

+    baseModule::module_ready()
+
+  

+  

+    This function is used to check if this module page can be displayed.
+  

+    

+    baseModule::save_attributes()
+
+  

+  

+    Returns a list of modifications which have to be made to the LDAP account.
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 38]

+Manages the object class "shadowAccount" for users.




+
[ Top ]


+
+
+

+
+
Class Methods

+

+
+  

+	
+	
method build_uploadAccounts [line 374]

+	

+    

+    

+		array build_uploadAccounts(
+array
+$rawAccounts, array
+$ids, array
+&$partialAccounts)
+    

+    


+	
+		In this function the LDAP account is built up.




+
Tags:

+

+
+  
+    
+  
+
return:  list of error messages if any

+

+


+
+	
+Overrides baseModule::build_uploadAccounts() (In this function the LDAP account is built up.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $rawAccounts  list of hash arrays (name => value) from user input
array  $partialAccounts  list of hash arrays (name => value) which are later added to LDAP
array  $ids  list of IDs for column position (e.g. "posixAccount_uid" => 5)

+    


+        
[ Top ]

+  

+  

+	
+	
method display_html_attributes [line 258]

+	

+    

+    

+		array display_html_attributes(
+)
+    

+    


+	
+		This function will create the meta HTML code to show a page with all attributes.




+
Tags:

+

+
+  
+    
+  
+
return:  meta HTML code

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method display_html_expire [line 324]

+	

+    

+    

+		array display_html_expire(
+)
+    

+    


+	
+		This function will create the meta HTML code to show a page with the expiration date.




+
Tags:

+

+
+  
+    
+  
+
return:  meta HTML code

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method get_metaData [line 63]

+	

+    

+    

+		array get_metaData(
+)
+    

+    


+	
+		Returns meta data that is interpreted by parent class




+
Tags:

+

+
+  
+    
+  
+
return:  array with meta data

+

+


+
+	
+Overrides baseModule::get_metaData() (Dummy function, meta data is provided by sub classes.)


+
+        
[ Top ]

+  

+  

+	
+	
method get_pdfEntries [line 359]

+	

+    

+    

+		array get_pdfEntries(
+)
+    

+    


+	
+		Returns the PDF entries for this module.




+
Tags:

+

+
+  
+    
+  
+
return:  list of possible PDF entries

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method load_Messages [line 43]

+	

+    

+    

+		void load_Messages(
+)
+    

+    


+	
+		This function builds up the message array.




+
+	
+Overrides baseModule::load_Messages() (This function fills the $messages variable with output messages from this module.)


+
+        
[ Top ]

+  

+  

+	
+	
method load_profile [line 454]

+	

+    

+    

+		void load_profile(
+array
+$profile)
+    

+    


+	
+		Loads the values of an account profile into internal variables.




+
+	
+Overrides baseModule::load_profile() (Loads the values of an account profile into internal variables.)


+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
array  $profile  hash array with profile values (identifier => value)

+    


+        
[ Top ]

+  

+  

+	
+	
method process_attributes [line 238]

+	

+    

+    

+		array process_attributes(
+)
+    

+    


+	
+		Processes user input of the primary module page.

It checks if all input values are correct and updates the associated LDAP attributes.




+
Tags:

+

+
+  
+    
+  
+
return:  list of info/error messages

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method process_expire [line 305]

+	

+    

+    

+		array process_expire(
+)
+    

+    


+	
+		Processes user input of the expiration page.

It checks if all input values are correct and updates the associated LDAP attributes.




+
Tags:

+

+
+  
+    
+  
+
return:  list of info/error messages

+

+


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method save_attributes [line 220]

+	

+    

+    

+		array save_attributes(
+)
+    

+    


+	
+		Returns a list of modifications which have to be made to the LDAP account.




+
Tags:

+

+
+  
+    
+  
+
return:  list of modifications  
This function returns an array with 3 entries:  
array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )  
DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)  
"add" are attributes which have to be added to LDAP entry  
"remove" are attributes which have to be removed from LDAP entry  
"modify" are attributes which have to been modified in LDAP entry

+

+


+
+	
+Overrides baseModule::save_attributes() (Returns a list of modifications which have to be made to the LDAP account.)


+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:07 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/modules/smbHash.html b/lam-web/developers/phpdoc/modules/smbHash.html
new file mode 100644
index 00000000..2dd41d54
--- /dev/null
+++ b/lam-web/developers/phpdoc/modules/smbHash.html
@@ -0,0 +1,696 @@
+
+
+Docs For Class smbHash
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
modules

+  		  [ class tree: modules ]
+		  [ index: modules ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					account.inc
+		

+					baseModule.inc
+		

+					createntlm.inc
+		

+					edit.php
+		

+					ieee802device.inc
+		

+					inetLocalMailRecipient.inc
+		

+					inetOrgPerson.inc
+		

+					kolabUser.inc
+		

+					lamdaemon.inc
+		

+					ldapPublicKey.inc
+		

+					modules.inc
+		

+					nisMailAlias.inc
+		

+					posixAccount.inc
+		

+					posixGroup.inc
+		

+					quota.inc
+		

+					sambaAccount.inc
+		

+					sambaDomain.inc
+		

+					sambaGroupMapping.inc
+		

+					sambaSamAccount.inc
+		

+					shadowAccount.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		account

+	    		accountContainer

+	    		baseModule

+	    		ieee802Device

+	    		inetLocalMailRecipient

+	    		inetOrgPerson

+	    		kolabUser

+	    		ldapPublicKey

+	    		nisMailAlias

+	    		posixAccount

+	    		posixGroup

+	    		quota

+	    		samba3domain

+	    		sambaAccount

+	    		sambaDomain

+	    		sambaGroupMapping

+	    		sambaSamAccount

+	    		shadowAccount

+	    		smbHash

+	  

+                		
+      

+
+
Class: smbHash

+Source Location: /lib/createntlm.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+


+
Calculates NT and LM hashes.



+
+
+
+
+
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+

+

+
+
+
Class Details

+

+[line 41]

+Calculates NT and LM hashes.

The important functions are lmhash($password) and nthash($password).




+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$perm1 = array(57, 49, 41, 33, 25, 17,  9,

+              1, 58, 50, 42, 34, 26, 18,

+             10,  2, 59, 51, 43, 35, 27,

+             19, 11,  3, 60, 52, 44, 36,

+             63, 55, 47, 39, 31, 23, 15,

+              7, 62, 54, 46, 38, 30, 22,

+             14,  6, 61, 53, 45, 37, 29,

+             21, 13,  5, 28, 20, 12,  4)

+	
[line 45]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$perm2 = array(14, 17, 11, 24,  1,  5,

+              3, 28, 15,  6, 21, 10,

+             23, 19, 12,  4, 26,  8,

+             16,  7, 27, 20, 13,  2,

+             41, 52, 31, 37, 47, 55,

+             30, 40, 51, 45, 33, 48,

+             44, 49, 39, 56, 34, 53,

+             46, 42, 50, 36, 29, 32)

+	
[line 54]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$perm3 = array(58, 50, 42, 34, 26, 18, 10,  2,

+             60, 52, 44, 36, 28, 20, 12,  4,

+             62, 54, 46, 38, 30, 22, 14,  6,

+             64, 56, 48, 40, 32, 24, 16,  8,

+             57, 49, 41, 33, 25, 17,  9,  1,

+             59, 51, 43, 35, 27, 19, 11,  3,

+             61, 53, 45, 37, 29, 21, 13,  5,

+             63, 55, 47, 39, 31, 23, 15,  7)

+	
[line 63]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$perm4 = array(32,  1,  2,  3,  4,  5,

+                 4,  5,  6,  7,  8,  9,

+                 8,  9, 10, 11, 12, 13,

+                12, 13, 14, 15, 16, 17,

+                16, 17, 18, 19, 20, 21,

+                20, 21, 22, 23, 24, 25,

+                24, 25, 26, 27, 28, 29,

+                28, 29, 30, 31, 32,  1)

+	
[line 72]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$perm5 = array(16,  7, 20, 21,

+                   29, 12, 28, 17,

+                    1, 15, 23, 26,

+                    5, 18, 31, 10,

+                    2,  8, 24, 14,

+                   32, 27,  3,  9,

+                   19, 13, 30,  6,

+                   22, 11,  4, 25)

+	
[line 81]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$perm6 = array(40,  8, 48, 16, 56, 24, 64, 32,

+             39,  7, 47, 15, 55, 23, 63, 31,

+             38,  6, 46, 14, 54, 22, 62, 30,

+             37,  5, 45, 13, 53, 21, 61, 29,

+             36,  4, 44, 12, 52, 20, 60, 28,

+             35,  3, 43, 11, 51, 19, 59, 27,

+             34,  2, 42, 10, 50, 18, 58, 26,

+             33,  1, 41,  9, 49, 17, 57, 25)

+	
[line 90]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$sbox = array(array(array(14,  4, 13,  1,  2, 15, 11,  8,  3, 10,  6, 12,  5,  9,  0,  7),array(0,15,7,4,14,2,13,1,10,6,12,11,9,5,3,8),array(4,1,14,8,13,6,2,11,15,12,9,7,3,10,5,0),array(15,12,8,2,4,9,1,7,5,11,3,14,10,0,6,13)),array(array(15,1,8,14,6,11,3,4,9,7,2,13,12,0,5,10),array(3,13,4,7,15,2,8,14,12,0,1,10,6,9,11,5),array(0,14,7,11,10,4,13,1,5,8,12,6,9,3,2,15),array(13,8,10,1,3,15,4,2,11,6,7,12,0,5,14,9)),array(array(10,0,9,14,6,3,15,5,1,13,12,7,11,4,2,8),array(13,7,0,9,3,4,6,10,2,8,5,14,12,11,15,1),array(13,6,4,9,8,15,3,0,11,1,2,12,5,10,14,7),array(1,10,13,0,6,9,8,7,4,15,14,3,11,5,2,12)),array(array(7,13,14,3,0,6,9,10,1,2,8,5,11,12,4,15),array(13,8,11,5,6,15,0,3,4,7,2,12,1,10,14,9),array(10,6,9,0,12,11,7,13,15,1,3,14,5,2,8,4),array(3,15,0,6,10,1,13,8,9,4,5,11,12,7,2,14)),array(array(2,12,4,1,7,10,11,6,8,5,3,15,13,0,14,9),array(14,11,2,12,4,7,13,1,5,0,15,10,3,9,8,6),array(4,2,1,11,10,13,7,8,15,9,12,5,6,3,0,14),array(11,8,12,7,1,14,2,13,6,15,0,9,10,4,5,3)),array(array(12,1,10,15,9,2,6,8,0,13,3,4,14,7,5,11),array(10,15,4,2,7,12,9,5,6,1,13,14,0,11,3,8),array(9,14,15,5,2,8,12,3,7,0,4,10,1,13,11,6),array(4,3,2,12,9,5,15,10,11,14,1,7,6,0,8,13)),array(array(4,11,2,14,15,0,8,13,3,12,9,7,5,10,6,1),array(13,0,11,7,4,9,1,10,14,3,5,12,2,15,8,6),array(1,4,11,13,12,3,7,14,10,15,6,8,0,5,9,2),array(6,11,13,8,1,4,10,7,9,5,0,15,14,2,3,12)),array(array(13,2,8,4,6,15,11,1,10,9,3,14,5,0,12,7),array(1,15,13,8,10,3,7,4,12,5,6,11,0,14,9,2),array(7,11,4,1,9,12,14,2,0,6,10,13,15,3,5,8),array(2,1,14,7,4,10,8,13,15,12,9,0,3,5,6,11)))

+	
[line 103]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$sc = array(1, 1, 2, 2, 2, 2, 2, 2, 1, 2, 2, 2, 2, 2, 2, 1)

+	
[line 99]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
method doHash [line 189]

+	

+    

+    

+		array doHash(
+array
+$in, array
+$key, boolean
+$forw)
+    

+    


+	
+		


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $in  
array  $key  
boolean  $forw  

+    


+        
[ Top ]

+  

+  

+	
+	
method E_P16 [line 290]

+	

+    

+    

+		void E_P16(
+mixed
+$in)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method lmhash [line 314]

+	

+    

+    

+		string lmhash(
+[string
+$password = ""])
+    

+    


+	
+		Calculates the LM hash of a given password.




+
Tags:

+

+
+  
+    
+  
+
return:  hash value

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $password  password

+    


+        
[ Top ]

+  

+  

+	
+	
method lshift [line 149]

+	

+    

+    

+		array lshift(
+integer
+$count, array
+$data)
+    

+    


+	
+		


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $data  
integer  $count  count

+    


+        
[ Top ]

+  

+  

+	
+	
method mxor [line 175]

+	

+    

+    

+		array mxor(
+array
+$in1, array
+$in2)
+    

+    


+	
+		


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $in1  
array  $in2  

+    


+        
[ Top ]

+  

+  

+	
+	
method nthash [line 331]

+	

+    

+    

+		string nthash(
+[string
+$password = ""])
+    

+    


+	
+		Calculates the NT hash of a given password.




+
Tags:

+

+
+  
+    
+  
+
return:  hash value

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
string  $password  password

+    


+        
[ Top ]

+  

+  

+	
+	
method permute [line 162]

+	

+    

+    

+		array permute(
+array
+$in, array
+$p, mixed
+$n)
+    

+    


+	
+		


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
array  $in  in input data
array  $p  p permutation

+    


+        
[ Top ]

+  

+  

+	
+	
method smb_hash [line 270]

+	

+    

+    

+		void smb_hash(
+mixed
+$in, mixed
+$key, mixed
+$forw)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method str_to_key [line 255]

+	

+    

+    

+		void str_to_key(
+mixed
+$str)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method unsigned_shift_r [line 340]

+	

+    

+    

+		void unsigned_shift_r(
+mixed
+$a, mixed
+$b)
+    

+    


+	
+		Unsigned shift operation for 32bit values.

PHP 4 only supports signed shifts by default.




+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method x [line 139]

+	

+    

+    

+		void x(
+mixed
+$i)
+    

+    


+	
+		Fixes too large numbers




+
+	
+
+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:41 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/profiles/_lib_profiles_inc.html b/lam-web/developers/phpdoc/profiles/_lib_profiles_inc.html
new file mode 100644
index 00000000..6765b2ff
--- /dev/null
+++ b/lam-web/developers/phpdoc/profiles/_lib_profiles_inc.html
@@ -0,0 +1,246 @@
+
+
+Docs for page profiles.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
profiles

+  		  [ class tree: profiles ]
+		  [ index: profiles ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					profiledelete.php
+		

+					profilemain.php
+		

+					profilepage.php
+		

+					profiles.inc
+		

+	  


+      
+      
+                		
+      

+
+
Procedural File: profiles.inc

+Source Location: /lib/profiles.inc


+
+

+

+
+
+
Page Details:

+This file provides functions to load and save account profiles.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+


+


+

+  

+	
+	
delAccountProfile [line 147]

+	

+    

+    

+		boolean delAccountProfile(
+string $file, string $scope)
+    

+    


+
+		Deletes an account profile




+
Tags:

+

+
+  
+    
+  
+
return:  true if profile was deleted

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $file  name of profile (Without .<scope> extension)
string  $scope  account type

+    	
[ Top ]



+	

+  

+	
+	
getAccountProfiles [line 38]

+	

+    

+    

+		array getAccountProfiles(
+string $scope)
+    

+    


+
+		Returns an array of string with all available profiles for the given account type




+
Tags:

+

+
+  
+    
+  
+
return:  profile names

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $scope  account type

+    	
[ Top ]



+	

+  

+	
+	
loadAccountProfile [line 66]

+	

+    

+    

+		array loadAccountProfile(
+string $profile, string $scope)
+    

+    


+
+		Loads an profile of the given account type




+
Tags:

+

+
+  
+    
+  
+
return:  hash array (attribute => value)

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $profile  name of the profile (without .<scope> extension)
string  $scope  account type

+    	
[ Top ]



+	

+  

+	
+	
saveAccountProfile [line 110]

+	

+    

+    

+		boolean saveAccountProfile(
+array $attributes, string $profile, string $scope)
+    

+    


+
+		Saves an hash array (attribute => value) to an account profile

file is created, if needed




+
Tags:

+

+
+  
+    
+  
+
return:  true, if saving succeeded

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $profile  name of the account profile (without .<scope> extension)
array  $attributes  hash array (attribute => value)
string  $scope  account type

+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:59 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/profiles/_templates_profedit_profiledelete_php.html b/lam-web/developers/phpdoc/profiles/_templates_profedit_profiledelete_php.html
new file mode 100644
index 00000000..33eb6699
--- /dev/null
+++ b/lam-web/developers/phpdoc/profiles/_templates_profedit_profiledelete_php.html
@@ -0,0 +1,101 @@
+
+
+Docs for page profiledelete.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
profiles

+  		  [ class tree: profiles ]
+		  [ index: profiles ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					profiledelete.php
+		

+					profilemain.php
+		

+					profilepage.php
+		

+					profiles.inc
+		

+	  


+      
+      
+                		
+      

+
+
Procedural File: profiledelete.php

+Source Location: /templates/profedit/profiledelete.php


+
+

+

+
+
+
Page Details:

+Manages deletion of profiles.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once("../../lib/security.inc") [line 32]

+security functions

include_once("../../lib/profiles.inc") [line 34]

+helper functions for profiles

include_once("../../lib/ldap.inc") [line 36]

+access to LDAP server

include_once("../../lib/config.inc") [line 38]

+access to configuration options


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:59 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/profiles/_templates_profedit_profilemain_php.html b/lam-web/developers/phpdoc/profiles/_templates_profedit_profilemain_php.html
new file mode 100644
index 00000000..df8ded4b
--- /dev/null
+++ b/lam-web/developers/phpdoc/profiles/_templates_profedit_profilemain_php.html
@@ -0,0 +1,101 @@
+
+
+Docs for page profilemain.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
profiles

+  		  [ class tree: profiles ]
+		  [ index: profiles ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					profiledelete.php
+		

+					profilemain.php
+		

+					profilepage.php
+		

+					profiles.inc
+		

+	  


+      
+      
+                		
+      

+
+
Procedural File: profilemain.php

+Source Location: /templates/profedit/profilemain.php


+
+

+

+
+
+
Page Details:

+This is the main window of the profile editor.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once("../../lib/security.inc") [line 32]

+security functions

include_once("../../lib/profiles.inc") [line 34]

+helper functions for profiles

include_once("../../lib/ldap.inc") [line 36]

+access to LDAP server

include_once("../../lib/config.inc") [line 38]

+access to configuration options


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:59 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/profiles/_templates_profedit_profilepage_php.html b/lam-web/developers/phpdoc/profiles/_templates_profedit_profilepage_php.html
new file mode 100644
index 00000000..5e9eb270
--- /dev/null
+++ b/lam-web/developers/phpdoc/profiles/_templates_profedit_profilepage_php.html
@@ -0,0 +1,103 @@
+
+
+Docs for page profilepage.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
profiles

+  		  [ class tree: profiles ]
+		  [ index: profiles ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					profiledelete.php
+		

+					profilemain.php
+		

+					profilepage.php
+		

+					profiles.inc
+		

+	  


+      
+      
+                		
+      

+
+
Procedural File: profilepage.php

+Source Location: /templates/profedit/profilepage.php


+
+

+

+
+
+
Page Details:

+Manages creating/changing of profiles.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once("../../lib/profiles.inc") [line 34]

+helper functions for profiles

include_once("../../lib/security.inc") [line 32]

+security functions

include_once("../../lib/ldap.inc") [line 36]

+access to LDAP server

include_once("../../lib/config.inc") [line 38]

+access to configuration options

include_once("../../lib/status.inc") [line 42]

+Used to display status messages

include_once("../../lib/modules.inc") [line 40]

+access to account modules


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:59 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/ric_INSTALL.html b/lam-web/developers/phpdoc/ric_INSTALL.html
new file mode 100644
index 00000000..05fd9815
--- /dev/null
+++ b/lam-web/developers/phpdoc/ric_INSTALL.html
@@ -0,0 +1,133 @@
+
+
+INSTALL
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
default

+  		  [ class tree: default ]
+		  [ index: default ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                  
+      
+                		
+      

+
+
INSTALL

+
+
+Installation Instructions for LAM
+---------------------------------
+
+
+1. Requirements
+
+   - Apache webserver (SSL optional) with PHP module (PHP with
+     ldap, gettext, xml and optional mcrypt)
+   - some LAM plugins may require additional PHP extensions (you will get a
+     note on the login page if something is missing)
+   - Perl (optional, needed only for lamdaemon)
+   - OpenLDAP (>2.0)
+   - A web browser :-)
+
+   MHash is only needed if you use PHP < 4.3 and if you want to use SHA or SSHA
+   for password hashes.
+   MCrypt will be used to store your LDAP password encrypted in the session file.
+
+   Getting mcrypt and mhash for Suse/RedHat:
+
+   Either you compile PHP4 yourself or you use some unofficial packages:
+
+   - Suse: ftp://ftp.suse.com/pub/people/poeml/mod_php4
+   - RedHat: http://ftp.horde.org/pub/RPMS
+
+
+   See docs/README.schema.txt for information about used LDAP schema files.
+
+
+2. Installation
+
+   1. Extract package with:
+      tar xzf ldap-account-manager-<version>.tar.gz
+
+   2a. Copy the files into the html-file scope of the webserver. For example
+       /apache/htdocs.
+
+       Set appropriate file permissions:
+        - lam/sess: write permission for apache user
+        - lam/tmp: write permission for apache user
+        - lam/config (with subdirectories): write permission for apache user
+        - lam/lib: lamdaemon.pl must be set executable (See also
+          docs/readme.lamdeamon.txt)
+
+   2b. You can also use the included configure script to install LAM. See
+       "./configure --help" for a list of install options.
+
+   3. Configure config.cfg and create a configuration profile.
+      Copy config.cfg_sample to config.cfg and set the master password and default
+      profile.
+
+      Open the index.html in your web browser:
+       - Follow the link "Configuration Login" from the start page.
+        (The default password to edit the options is "lam")
+       - Select the default lam profile or create a new profile.
+       - Change the settings to fit your environment.
+
+
+
+3. Setting up PHP
+
+   LAM runs with PHP4 or PHP5.
+
+   Needed changes in your php.ini:
+
+    * memory_limit = 64M
+
+
+

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/ric_README.html b/lam-web/developers/phpdoc/ric_README.html
new file mode 100644
index 00000000..a8538cc6
--- /dev/null
+++ b/lam-web/developers/phpdoc/ric_README.html
@@ -0,0 +1,142 @@
+
+
+README
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
default

+  		  [ class tree: default ]
+		  [ index: default ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                  
+      
+                		
+      

+
+
README

+
+
+LAM - Readme
+============
+
+  LDAP Account Manager (LAM) manages user, group and host accounts in an LDAP
+  directory. LAM runs on any webserver with PHP4/5 support and connects to your
+  LDAP server unencrypted or via SSL/TLS.
+  Currently LAM supports these account types: Samba 2 and 3, Unix, Kolab 2,
+  address book entries, NIS mail aliases and MAC addresses. There is a tree
+  viewer included to allow access to the raw LDAP attributes. You can use
+  templates for account creation and use multiple configuration profiles.
+  LAM is translated to Catalan, Chinese (Traditional), Dutch, English, French,
+  German, Hungarian, Italian, Japanese, Russian and Spanish.
+
+  http://sourceforge.net/projects/lam/
+
+    Copyright (C) 2003 - 2006 Michael Duergner <michael@duergner.com>
+                              Roland Gruber <post@rolandgruber.de>
+                              Tilo Lutz <tilolutz@gmx.de>
+
+  Requirements:
+    PHP4/5
+    Openldap (2.0 or greater)
+    A web-browser that supports CSS
+
+  Summary:
+    With LAM you can easily manage user, group and machine accounts stored in
+    an LDAP directory over a web interface. At the moment it supports:
+
+      - managing user/group/host/domain entries
+      - filtering and sorting
+      - account profiles
+      - multiple configuration profiles
+      - tree viwer
+      - schema browser
+      - OU Editor
+      - account creation via file upload
+      - PDF export for all accounts
+      - manage user/group Quota and create home directories
+
+  Important:
+    The default password to edit the configuration options is "lam".
+
+  Installation:
+    Please see the INSTALL file.
+
+  Documentation:
+    Basic documentation is available in the directory "docs".
+
+  Upgrade from older versions:
+    See docs/README.upgrade.txt for upgrade instructions.
+
+  Internationalisation:
+    If you want to use a translated version of LAM be sure to install the
+    needed locales. See the LAM "locale" directory for a list of supported locales and languages.
+    You can get a list of all installed locales on your sysem by executing: locale -a
+    Debian users can add locales with "dpkg-reconfigure locales".
+
+  Security:
+    It is strongly recommended to use a SSL connection to your web server.
+
+    LAM needs to store your LDAP user name + password in the session. The session
+    files are saved in sess/ and are accessible only by the web server. To increase
+    security username and password are encrypted with MCrypt/AES if available.
+    The key and IV are generated at random when you log in. They are stored in two
+    cookies.
+ 
+  Download:
+    You can get the newest version at http://lam.sourceforge.net/.
+
+  License:
+    LAM is published under the GNU General Public License.
+    The complete list of licenses can be found in the copyright file.
+
+
+    Have fun!
+        The LAM devel team
+
+

+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:34 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/tests/_tests_conf-main-test_php.html b/lam-web/developers/phpdoc/tests/_tests_conf-main-test_php.html
new file mode 100644
index 00000000..6a65c396
--- /dev/null
+++ b/lam-web/developers/phpdoc/tests/_tests_conf-main-test_php.html
@@ -0,0 +1,96 @@
+
+
+Docs for page conf-main-test.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
tests

+  		  [ class tree: tests ]
+		  [ index: tests ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					conf-main-test.php
+		

+					conf-test.php
+		

+					status-test.php
+		

+	  


+      
+      
+                		
+      

+
+
Procedural File: conf-main-test.php

+Source Location: /tests/conf-main-test.php


+
+

+

+
+
+
Page Details:

+This test reads all preferences from config.cfg. Then it writes new values and verifies  if they were written. At last the old values are restored.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include("../lib/config.inc") [line 33]

+configuration interface


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:39 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/tests/_tests_conf-test_php.html b/lam-web/developers/phpdoc/tests/_tests_conf-test_php.html
new file mode 100644
index 00000000..b4446f97
--- /dev/null
+++ b/lam-web/developers/phpdoc/tests/_tests_conf-test_php.html
@@ -0,0 +1,96 @@
+
+
+Docs for page conf-test.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
tests

+  		  [ class tree: tests ]
+		  [ index: tests ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					conf-main-test.php
+		

+					conf-test.php
+		

+					status-test.php
+		

+	  


+      
+      
+                		
+      

+
+
Procedural File: conf-test.php

+Source Location: /tests/conf-test.php


+
+

+

+
+
+
Page Details:

+This test reads all preferences from lam.conf. Then it writes new values and verifies  if they were written. At last the old values are restored.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include("../lib/config.inc") [line 33]

+access to configuration functions


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:39 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/tests/_tests_status-test_php.html b/lam-web/developers/phpdoc/tests/_tests_status-test_php.html
new file mode 100644
index 00000000..8b94bfa8
--- /dev/null
+++ b/lam-web/developers/phpdoc/tests/_tests_status-test_php.html
@@ -0,0 +1,96 @@
+
+
+Docs for page status-test.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
tests

+  		  [ class tree: tests ]
+		  [ index: tests ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					conf-main-test.php
+		

+					conf-test.php
+		

+					status-test.php
+		

+	  


+      
+      
+                		
+      

+
+
Procedural File: status-test.php

+Source Location: /tests/status-test.php


+
+

+

+
+
+
Page Details:

+LDAP Account Manager status messages.




+
Tags:

+

+
+  
+    
+  
+
author:  Michael Duergner

+

+


+
Includes:

+

+include_once("../lib/status.inc") [line 32]

+message displaying


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:09 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/tools/LdapExportInfo.html b/lam-web/developers/phpdoc/tools/LdapExportInfo.html
new file mode 100644
index 00000000..e2f101c0
--- /dev/null
+++ b/lam-web/developers/phpdoc/tools/LdapExportInfo.html
@@ -0,0 +1,252 @@
+
+
+Docs For Class LdapExportInfo
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
tools

+  		  [ class tree: tools ]
+		  [ index: tools ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					export.inc
+		

+					index.php
+		

+					lamdaemonTest.php
+		

+					massBuildAccounts.php
+		

+					masscreate.php
+		

+					massDoUpload.php
+		

+					ou_edit.php
+		

+					schema.php
+		

+					tools.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LdapExportInfo

+	    		MyCustomExporter

+	    		PlaAbstractExporter

+	    		PlaCSVExporter

+	    		PlaDsmlExporter

+	    		PlaExporter

+	    		PlaLdapExporter

+	    		PlaLdifExporter

+	    		PlaVcardExporter

+	  

+                		
+      

+
+
Class: LdapExportInfo

+Source Location: /lib/export.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+


+
This class encapsulate informations about the ldap server  from which the export is done.



+
+
+
+
+
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+

+

+
+
+
Class Details

+

+[line 84]

+This class encapsulate informations about the ldap server  from which the export is done.

The following info are provided within this class:
$base_dn:  if the source of the export is the ldap server,             it indicates the base dn of the search.  $query_filter: if the source of the export is the ldap server,                  it indicates the query filter for the search.  $scope: if the source of the export is the ldap server,          it indicates the scope of the search.




+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$base_dn = 

+	
[line 86]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$query_filter = 

+	
[line 87]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$scope = 

+	
[line 88]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor LdapExportInfo [line 98]

+	

+    

+    

+		LdapExportInfo LdapExportInfo(
+[String
+$base_dn = NULL], [String
+$query_filter = NULL], [String
+$scope = NULL])
+    

+    


+	
+		Create a new LdapExportInfo object




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
String  $base_dn  the base_dn for the search in a ldap server
String  $query_filter  the query filter for the search
String  $scope  the scope of the search in a ldap server

+    


+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:43 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/tools/MyCustomExporter.html b/lam-web/developers/phpdoc/tools/MyCustomExporter.html
new file mode 100644
index 00000000..1824960f
--- /dev/null
+++ b/lam-web/developers/phpdoc/tools/MyCustomExporter.html
@@ -0,0 +1,326 @@
+
+
+Docs For Class MyCustomExporter
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
tools

+  		  [ class tree: tools ]
+		  [ index: tools ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					export.inc
+		

+					index.php
+		

+					lamdaemonTest.php
+		

+					massBuildAccounts.php
+		

+					masscreate.php
+		

+					massDoUpload.php
+		

+					ou_edit.php
+		

+					schema.php
+		

+					tools.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LdapExportInfo

+	    		MyCustomExporter

+	    		PlaAbstractExporter

+	    		PlaCSVExporter

+	    		PlaDsmlExporter

+	    		PlaExporter

+	    		PlaLdapExporter

+	    		PlaLdifExporter

+	    		PlaVcardExporter

+	  

+                		
+      

+
+
Class: MyCustomExporter

+Source Location: /lib/export.inc


+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
PlaAbstractExporter
+   |
+   --PlaExporter
+      |
+      --MyCustomExporter


+



+
+
+
+
+
+
+        
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: PlaExporter

+

+

+  PlaExporter::$br
+  
+

+

+   
+

+

+  PlaExporter::$exporter
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: PlaExporter

+

+    

+    PlaExporter::PlaExporter()
+
+  

+  

+    Constructor
+  

+    

+    PlaExporter::export()
+
+  

+  

+    Abstract method use to export data.
+  

+    

+    PlaExporter::is_safe_ascii()
+
+  

+  

+    Helper method to check if the attribute value should be base 64 encoded.
+  

+    

+    PlaExporter::pla_fetch_entry_array()
+
+  

+  

+    Return the entry as an array
+  

+    

+    PlaExporter::pla_fetch_entry_object()
+
+  

+  

+    Return the entry as an Entry object
+  

+    

+    PlaExporter::pla_get_ldap_info()
+
+  

+  

+    Return a PlaLdapInfo Object
+  

+    

+    PlaExporter::pla_has_entry()
+
+  

+  

+    Return true if there is some more entries to be processed
+  

+    

+    PlaExporter::pla_num_entries()
+
+  

+  

+    Return the number of entries
+  

+    

+    PlaExporter::setOutputFormat()
+
+  

+  

+    Set the carriage return /linefeed for the export
+  

+  

+
Class: PlaAbstractExporter

+

+    

+    PlaAbstractExporter::pla_fetch_entry_array()
+
+  

+  

+    Return the entry as an array
+  

+    

+    PlaAbstractExporter::pla_fetch_entry_object()
+
+  

+  

+    Return the entry as an Entry object
+  

+    

+    PlaAbstractExporter::pla_get_ldap_info()
+
+  

+  

+    Return a PlaLdapInfo Object
+  

+    

+    PlaAbstractExporter::pla_has_entry()
+
+  

+  

+    Return true if there is some more entries to be processed
+  

+    

+    PlaAbstractExporter::pla_num_entries()
+
+  

+  

+    Return the number of entries
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 792]

+



+
[ Top ]


+
+
+

+
+
Class Methods

+

+
+  

+	
+	
method export [line 804]

+	

+    

+    

+		void export(
+)
+    

+    


+	
+		When doing an exporter, the method export need to be overriden.

A basic implementation is provided here. Customize to your need




+
+	
+Overrides PlaExporter::export() (Abstract method use to export data.)


+
+        
[ Top ]

+  

+  

+	
+	
method MyCutsomExporter [line 794]

+	

+    

+    

+		void MyCutsomExporter(
+mixed
+$exporter)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:43 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/tools/PlaAbstractExporter.html b/lam-web/developers/phpdoc/tools/PlaAbstractExporter.html
new file mode 100644
index 00000000..dbafd080
--- /dev/null
+++ b/lam-web/developers/phpdoc/tools/PlaAbstractExporter.html
@@ -0,0 +1,367 @@
+
+
+Docs For Class PlaAbstractExporter
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
tools

+  		  [ class tree: tools ]
+		  [ index: tools ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					export.inc
+		

+					index.php
+		

+					lamdaemonTest.php
+		

+					massBuildAccounts.php
+		

+					masscreate.php
+		

+					massDoUpload.php
+		

+					ou_edit.php
+		

+					schema.php
+		

+					tools.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LdapExportInfo

+	    		MyCustomExporter

+	    		PlaAbstractExporter

+	    		PlaCSVExporter

+	    		PlaDsmlExporter

+	    		PlaExporter

+	    		PlaLdapExporter

+	    		PlaLdifExporter

+	    		PlaVcardExporter

+	  

+                		
+      

+
+
Class: PlaAbstractExporter

+Source Location: /lib/export.inc


+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+


+
This class represents the base class of all exporters



+
Author(s):

+
    
+        

+
+
+
+
+    
+
+        
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+

+
Child classes:

+

+

+
PlaExporter

+	
PlaExporter acts a wrapper around another exporter.

+

+

+
PlaLdapExporter

+	
Export data from a ldap server

+

+

+

+

+
+
+
Class Details

+

+[line 119]

+This class represents the base class of all exporters

It can be subclassed directly if your intend is to write  a source exporter(ie. it will act only as a decoree  which will be wrapped by an another exporter.)  If you consider writting an exporter for filtering data  or directly display entries, please consider subclass  the PlaExporter




+
Tags:

+

+
+  
+    
+  
+
see:  PlaExporter

+

+



+
[ Top ]


+
+
+

+
+
Class Methods

+

+
+  

+	
+	
method pla_fetch_entry_array [line 137]

+	

+    

+    

+		array pla_fetch_entry_array(
+)
+    

+    


+	
+		Return the entry as an array




+
Tags:

+

+
+  
+    
+  
+
return:  an entry as an array

+

+


+
+	
Overridden in child classes as:

+		

+	
PlaExporter::pla_fetch_entry_array()

+		
Return the entry as an array

+	

+		

+	
PlaLdapExporter::pla_fetch_entry_array()

+		
Return the entry as an array

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method pla_fetch_entry_object [line 143]

+	

+    

+    

+		Entry pla_fetch_entry_object(
+)
+    

+    


+	
+		Return the entry as an Entry object




+
Tags:

+

+
+  
+    
+  
+
return:  an entry  as an Entry Object

+

+


+
+	
Overridden in child classes as:

+		

+	
PlaExporter::pla_fetch_entry_object()

+		
Return the entry as an Entry object

+	

+		

+	
PlaLdapExporter::pla_fetch_entry_object()

+		
Return the entry as an Entry object

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method pla_get_ldap_info [line 149]

+	

+    

+    

+		LdapInfo pla_get_ldap_info(
+)
+    

+    


+	
+		Return a PlaLdapInfo Object




+
Tags:

+

+
+  
+    
+  
+
return:  Object with info from the ldap serveur

+

+


+
+	
Overridden in child classes as:

+		

+	
PlaExporter::pla_get_ldap_info()

+		
Return a PlaLdapInfo Object

+	

+		

+	
PlaLdapExporter::pla_get_ldap_info()

+		
Return a PlaLdapInfo Object

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method pla_has_entry [line 131]

+	

+    

+    

+		bool pla_has_entry(
+)
+    

+    


+	
+		Return true if there is some more entries to be processed




+
Tags:

+

+
+  
+    
+  
+
return:  if there is some more entries to be processed

+

+


+
+	
Overridden in child classes as:

+		

+	
PlaExporter::pla_has_entry()

+		
Return true if there is some more entries to be processed

+	

+		

+	
PlaLdapExporter::pla_has_entry()

+		
Return true if there is some more entries to be processed

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method pla_num_entries [line 125]

+	

+    

+    

+		int pla_num_entries(
+)
+    

+    


+	
+		Return the number of entries




+
Tags:

+

+
+  
+    
+  
+
return:  the number of entries to be exported

+

+


+
+	
Overridden in child classes as:

+		

+	
PlaExporter::pla_num_entries()

+		
Return the number of entries

+	

+		

+	
PlaLdapExporter::pla_num_entries()

+		
Return the number of entries

+	

+	

+	
+
+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:43 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/tools/PlaCSVExporter.html b/lam-web/developers/phpdoc/tools/PlaCSVExporter.html
new file mode 100644
index 00000000..ec85ac02
--- /dev/null
+++ b/lam-web/developers/phpdoc/tools/PlaCSVExporter.html
@@ -0,0 +1,433 @@
+
+
+Docs For Class PlaCSVExporter
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
tools

+  		  [ class tree: tools ]
+		  [ index: tools ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					export.inc
+		

+					index.php
+		

+					lamdaemonTest.php
+		

+					massBuildAccounts.php
+		

+					masscreate.php
+		

+					massDoUpload.php
+		

+					ou_edit.php
+		

+					schema.php
+		

+					tools.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LdapExportInfo

+	    		MyCustomExporter

+	    		PlaAbstractExporter

+	    		PlaCSVExporter

+	    		PlaDsmlExporter

+	    		PlaExporter

+	    		PlaLdapExporter

+	    		PlaLdifExporter

+	    		PlaVcardExporter

+	  

+                		
+      

+
+
Class: PlaCSVExporter

+Source Location: /lib/export.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
PlaAbstractExporter
+   |
+   --PlaExporter
+      |
+      --PlaCSVExporter


+
Export to cvs format



+
Author(s):

+
    
+          
  • Glen Ogilvie
    • 
+      

+
+
+
+
+    
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: PlaExporter

+

+

+  PlaExporter::$br
+  
+

+

+   
+

+

+  PlaExporter::$exporter
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: PlaExporter

+

+    

+    PlaExporter::PlaExporter()
+
+  

+  

+    Constructor
+  

+    

+    PlaExporter::export()
+
+  

+  

+    Abstract method use to export data.
+  

+    

+    PlaExporter::is_safe_ascii()
+
+  

+  

+    Helper method to check if the attribute value should be base 64 encoded.
+  

+    

+    PlaExporter::pla_fetch_entry_array()
+
+  

+  

+    Return the entry as an array
+  

+    

+    PlaExporter::pla_fetch_entry_object()
+
+  

+  

+    Return the entry as an Entry object
+  

+    

+    PlaExporter::pla_get_ldap_info()
+
+  

+  

+    Return a PlaLdapInfo Object
+  

+    

+    PlaExporter::pla_has_entry()
+
+  

+  

+    Return true if there is some more entries to be processed
+  

+    

+    PlaExporter::pla_num_entries()
+
+  

+  

+    Return the number of entries
+  

+    

+    PlaExporter::setOutputFormat()
+
+  

+  

+    Set the carriage return /linefeed for the export
+  

+  

+
Class: PlaAbstractExporter

+

+    

+    PlaAbstractExporter::pla_fetch_entry_array()
+
+  

+  

+    Return the entry as an array
+  

+    

+    PlaAbstractExporter::pla_fetch_entry_object()
+
+  

+  

+    Return the entry as an Entry object
+  

+    

+    PlaAbstractExporter::pla_get_ldap_info()
+
+  

+  

+    Return a PlaLdapInfo Object
+  

+    

+    PlaAbstractExporter::pla_has_entry()
+
+  

+  

+    Return true if there is some more entries to be processed
+  

+    

+    PlaAbstractExporter::pla_num_entries()
+
+  

+  

+    Return the number of entries
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 684]

+Export to cvs format




+
Tags:

+

+
+  
+    
+  
+
author:  Glen Ogilvie

+

+



+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$escapeCode =  '"'

+	
[line 698]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$multivalue_separator =  " | "

+	
[line 697]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$qualifier =  '"'

+	
[line 696]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$separator =  ","

+	
[line 695]

+  When doing an exporter, the method export need to be overriden.

A basic implementation is provided here. Customize to your need


+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor PlaCSVExporter [line 686]

+	

+    

+    

+		PlaCSVExporter PlaCSVExporter(
+mixed
+$exporter)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method export [line 700]

+	

+    

+    

+		void export(
+)
+    

+    


+	
+		


+
+	
+Overrides PlaExporter::export() (Abstract method use to export data.)


+
+        
[ Top ]

+  

+  

+	
+	
method LdapEscape [line 780]

+	

+    

+    

+		void LdapEscape(
+mixed
+$var)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:43 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/tools/PlaDsmlExporter.html b/lam-web/developers/phpdoc/tools/PlaDsmlExporter.html
new file mode 100644
index 00000000..67160139
--- /dev/null
+++ b/lam-web/developers/phpdoc/tools/PlaDsmlExporter.html
@@ -0,0 +1,390 @@
+
+
+Docs For Class PlaDsmlExporter
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
tools

+  		  [ class tree: tools ]
+		  [ index: tools ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					export.inc
+		

+					index.php
+		

+					lamdaemonTest.php
+		

+					massBuildAccounts.php
+		

+					masscreate.php
+		

+					massDoUpload.php
+		

+					ou_edit.php
+		

+					schema.php
+		

+					tools.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LdapExportInfo

+	    		MyCustomExporter

+	    		PlaAbstractExporter

+	    		PlaCSVExporter

+	    		PlaDsmlExporter

+	    		PlaExporter

+	    		PlaLdapExporter

+	    		PlaLdifExporter

+	    		PlaVcardExporter

+	  

+                		
+      

+
+
Class: PlaDsmlExporter

+Source Location: /lib/export.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
PlaAbstractExporter
+   |
+   --PlaExporter
+      |
+      --PlaDsmlExporter


+
Export entries to DSML v.1



+
Author(s):

+
    
+        

+
+
+
+
+    
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: PlaExporter

+

+

+  PlaExporter::$br
+  
+

+

+   
+

+

+  PlaExporter::$exporter
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: PlaExporter

+

+    

+    PlaExporter::PlaExporter()
+
+  

+  

+    Constructor
+  

+    

+    PlaExporter::export()
+
+  

+  

+    Abstract method use to export data.
+  

+    

+    PlaExporter::is_safe_ascii()
+
+  

+  

+    Helper method to check if the attribute value should be base 64 encoded.
+  

+    

+    PlaExporter::pla_fetch_entry_array()
+
+  

+  

+    Return the entry as an array
+  

+    

+    PlaExporter::pla_fetch_entry_object()
+
+  

+  

+    Return the entry as an Entry object
+  

+    

+    PlaExporter::pla_get_ldap_info()
+
+  

+  

+    Return a PlaLdapInfo Object
+  

+    

+    PlaExporter::pla_has_entry()
+
+  

+  

+    Return true if there is some more entries to be processed
+  

+    

+    PlaExporter::pla_num_entries()
+
+  

+  

+    Return the number of entries
+  

+    

+    PlaExporter::setOutputFormat()
+
+  

+  

+    Set the carriage return /linefeed for the export
+  

+  

+
Class: PlaAbstractExporter

+

+    

+    PlaAbstractExporter::pla_fetch_entry_array()
+
+  

+  

+    Return the entry as an array
+  

+    

+    PlaAbstractExporter::pla_fetch_entry_object()
+
+  

+  

+    Return the entry as an Entry object
+  

+    

+    PlaAbstractExporter::pla_get_ldap_info()
+
+  

+  

+    Return a PlaLdapInfo Object
+  

+    

+    PlaAbstractExporter::pla_has_entry()
+
+  

+  

+    Return true if there is some more entries to be processed
+  

+    

+    PlaAbstractExporter::pla_num_entries()
+
+  

+  

+    Return the number of entries
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 478]

+Export entries to DSML v.1




+
Tags:

+

+
+  
+    
+  
+
extends:  PlaExporter

+

+



+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$counter =  0

+	
[line 482]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$indent_step =  2

+	
[line 481]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor PlaDsmlExporter [line 488]

+	

+    

+    

+		PlaDsmlExporter PlaDsmlExporter(
+PlaAbstractExporter
+$exporter)
+    

+    


+	
+		Create a PlaDsmlExporter object




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
PlaAbstractExporter  $exporter  the decoree exporter

+    


+        
[ Top ]

+  

+  

+	
+	
method export [line 495]

+	

+    

+    

+		void export(
+)
+    

+    


+	
+		Export the entries to DSML




+
+	
+Overrides PlaExporter::export() (Abstract method use to export data.)


+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:43 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/tools/PlaExporter.html b/lam-web/developers/phpdoc/tools/PlaExporter.html
new file mode 100644
index 00000000..17b43b1d
--- /dev/null
+++ b/lam-web/developers/phpdoc/tools/PlaExporter.html
@@ -0,0 +1,544 @@
+
+
+Docs For Class PlaExporter
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
tools

+  		  [ class tree: tools ]
+		  [ index: tools ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					export.inc
+		

+					index.php
+		

+					lamdaemonTest.php
+		

+					massBuildAccounts.php
+		

+					masscreate.php
+		

+					massDoUpload.php
+		

+					ou_edit.php
+		

+					schema.php
+		

+					tools.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LdapExportInfo

+	    		MyCustomExporter

+	    		PlaAbstractExporter

+	    		PlaCSVExporter

+	    		PlaDsmlExporter

+	    		PlaExporter

+	    		PlaLdapExporter

+	    		PlaLdifExporter

+	    		PlaVcardExporter

+	  

+                		
+      

+
+
Class: PlaExporter

+Source Location: /lib/export.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
PlaAbstractExporter
+   |
+   --PlaExporter


+
PlaExporter acts a wrapper around another exporter.



+
+
+
+
+
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Child classes:

+

+

+
PlaLdifExporter

+	
Export entries to ldif format

+

+

+
PlaDsmlExporter

+	
Export entries to DSML v.1

+

+

+
PlaVcardExporter

+	

+

+

+
PlaCSVExporter

+	
Export to cvs format

+

+

+
MyCustomExporter

+	

+

+

+		
+
Inherited Methods

+

+
Class: PlaAbstractExporter

+

+    

+    PlaAbstractExporter::pla_fetch_entry_array()
+
+  

+  

+    Return the entry as an array
+  

+    

+    PlaAbstractExporter::pla_fetch_entry_object()
+
+  

+  

+    Return the entry as an Entry object
+  

+    

+    PlaAbstractExporter::pla_get_ldap_info()
+
+  

+  

+    Return a PlaLdapInfo Object
+  

+    

+    PlaAbstractExporter::pla_has_entry()
+
+  

+  

+    Return true if there is some more entries to be processed
+  

+    

+    PlaAbstractExporter::pla_num_entries()
+
+  

+  

+    Return the number of entries
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 161]

+PlaExporter acts a wrapper around another exporter.

In other words, it will act as a decorator for another decorator




+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$br = "\n"

+	
[line 163]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$exporter = 

+	
[line 165]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor PlaExporter [line 171]

+	

+    

+    

+		PlaExporter PlaExporter(
+source
+$source)
+    

+    


+	
+		Constructor




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
source  $source  the decoree for this exporter

+    


+        
[ Top ]

+  

+  

+	
+	
method export [line 233]

+	

+    

+    

+		void export(
+)
+    

+    


+	
+		Abstract method use to export data.

Must be implemented in a sub-class if you write an exporter  which export data.  Leave it empty if you write a sub-class which do only some filtering.




+
+	
Overridden in child classes as:

+		

+	
PlaLdifExporter::export()

+		
Export entries to ldif format

+	

+		

+	
PlaDsmlExporter::export()

+		
Export the entries to DSML

+	

+		

+	
PlaVcardExporter::export()

+		
When doing an exporter, the method export need to be overriden.

+	

+		

+	
PlaCSVExporter::export()

+		

+	

+		

+	
MyCustomExporter::export()

+		
When doing an exporter, the method export need to be overriden.

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method is_safe_ascii [line 220]

+	

+    

+    

+		bool is_safe_ascii(
+String
+$str)
+    

+    


+	
+		Helper method to check if the attribute value should be base 64 encoded.




+
Tags:

+

+
+  
+    
+  
+
return:  true if the string is safe ascii, false otherwise.

+

+


+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
String  $str  the string to check.

+    


+        
[ Top ]

+  

+  

+	
+	
method pla_fetch_entry_array [line 195]

+	

+    

+    

+		array pla_fetch_entry_array(
+)
+    

+    


+	
+		Return the entry as an array




+
Tags:

+

+
+  
+    
+  
+
return:  an entry as an array

+

+


+
+	
+Overrides PlaAbstractExporter::pla_fetch_entry_array() (Return the entry as an array)


+
+        
[ Top ]

+  

+  

+	
+	
method pla_fetch_entry_object [line 203]

+	

+    

+    

+		Entry pla_fetch_entry_object(
+)
+    

+    


+	
+		Return the entry as an Entry object




+
Tags:

+

+
+  
+    
+  
+
return:  an entry  as an Entry Object

+

+


+
+	
+Overrides PlaAbstractExporter::pla_fetch_entry_object() (Return the entry as an Entry object)


+
+        
[ Top ]

+  

+  

+	
+	
method pla_get_ldap_info [line 211]

+	

+    

+    

+		LdapInfo pla_get_ldap_info(
+)
+    

+    


+	
+		Return a PlaLdapInfo Object




+
Tags:

+

+
+  
+    
+  
+
return:  Object with info from the ldap serveur

+

+


+
+	
+Overrides PlaAbstractExporter::pla_get_ldap_info() (Return a PlaLdapInfo Object)


+
+        
[ Top ]

+  

+  

+	
+	
method pla_has_entry [line 187]

+	

+    

+    

+		bool pla_has_entry(
+)
+    

+    


+	
+		Return true if there is some more entries to be processed




+
Tags:

+

+
+  
+    
+  
+
return:  if there is some more entries to be processed

+

+


+
+	
+Overrides PlaAbstractExporter::pla_has_entry() (Return true if there is some more entries to be processed)


+
+        
[ Top ]

+  

+  

+	
+	
method pla_num_entries [line 179]

+	

+    

+    

+		int pla_num_entries(
+)
+    

+    


+	
+		Return the number of entries




+
Tags:

+

+
+  
+    
+  
+
return:  the number of entries to be exported

+

+


+
+	
+Overrides PlaAbstractExporter::pla_num_entries() (Return the number of entries)


+
+        
[ Top ]

+  

+  

+	
+	
method setOutputFormat [line 239]

+	

+    

+    

+		void setOutputFormat(
+String
+$br)
+    

+    


+	
+		Set the carriage return /linefeed for the export




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
String  $br  the CRLF to be set

+    


+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:43 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/tools/PlaLdapExporter.html b/lam-web/developers/phpdoc/tools/PlaLdapExporter.html
new file mode 100644
index 00000000..9a9b349a
--- /dev/null
+++ b/lam-web/developers/phpdoc/tools/PlaLdapExporter.html
@@ -0,0 +1,546 @@
+
+
+Docs For Class PlaLdapExporter
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
tools

+  		  [ class tree: tools ]
+		  [ index: tools ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					export.inc
+		

+					index.php
+		

+					lamdaemonTest.php
+		

+					massBuildAccounts.php
+		

+					masscreate.php
+		

+					massDoUpload.php
+		

+					ou_edit.php
+		

+					schema.php
+		

+					tools.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LdapExportInfo

+	    		MyCustomExporter

+	    		PlaAbstractExporter

+	    		PlaCSVExporter

+	    		PlaDsmlExporter

+	    		PlaExporter

+	    		PlaLdapExporter

+	    		PlaLdifExporter

+	    		PlaVcardExporter

+	  

+                		
+      

+
+
Class: PlaLdapExporter

+Source Location: /lib/export.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
PlaAbstractExporter
+   |
+   --PlaLdapExporter


+
Export data from a ldap server



+
Author(s):

+
    
+        

+
+
+
+
+    
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+

+
Inherited Methods

+

+
Class: PlaAbstractExporter

+

+    

+    PlaAbstractExporter::pla_fetch_entry_array()
+
+  

+  

+    Return the entry as an array
+  

+    

+    PlaAbstractExporter::pla_fetch_entry_object()
+
+  

+  

+    Return the entry as an Entry object
+  

+    

+    PlaAbstractExporter::pla_get_ldap_info()
+
+  

+  

+    Return a PlaLdapInfo Object
+  

+    

+    PlaAbstractExporter::pla_has_entry()
+
+  

+  

+    Return true if there is some more entries to be processed
+  

+    

+    PlaAbstractExporter::pla_num_entries()
+
+  

+  

+    Return the number of entries
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 252]

+Export data from a ldap server




+
Tags:

+

+
+  
+    
+  
+
extends:  PlaAbstractExporter

+

+



+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$attributes = 

+	
[line 261]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$entry_array = 

+	
[line 256]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$entry_id = 

+	
[line 253]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$hasNext = 

+	
[line 260]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$ldap_info = 

+	
[line 258]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$num_entries = 

+	
[line 257]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$queryFilter = 

+	
[line 259]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$results = 

+	
[line 254]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$scope = 

+	
[line 255]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor PlaLdapExporter [line 268]

+	

+    

+    

+		PlaLdapExporter PlaLdapExporter(
+String
+$queryFilter, String
+$base_dn, String
+$scope, mixed
+$attributes)
+    

+    


+	
+		Create a PlaLdapExporter object.




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+          
+        
+        
+        
+      
+        
String  $queryFilter  the queryFilter for the export
String  $base_dn  the base_dn for the data to export
String  $scope  the scope for export

+    


+        
[ Top ]

+  

+  

+	
+	
method pla_fetch_entry_array [line 306]

+	

+    

+    

+		array pla_fetch_entry_array(
+)
+    

+    


+	
+		Return the entry as an array




+
Tags:

+

+
+  
+    
+  
+
return:  an entry as an array

+

+


+
+	
+Overrides PlaAbstractExporter::pla_fetch_entry_array() (Return the entry as an array)


+
+        
[ Top ]

+  

+  

+	
+	
method pla_fetch_entry_object [line 314]

+	

+    

+    

+		Entry pla_fetch_entry_object(
+)
+    

+    


+	
+		Return the entry as an Entry object




+
Tags:

+

+
+  
+    
+  
+
return:  an entry  as an Entry Object

+

+


+
+	
+Overrides PlaAbstractExporter::pla_fetch_entry_object() (Return the entry as an Entry object)


+
+        
[ Top ]

+  

+  

+	
+	
method pla_get_ldap_info [line 322]

+	

+    

+    

+		LdapInfo pla_get_ldap_info(
+)
+    

+    


+	
+		Return a PlaLdapInfo Object




+
Tags:

+

+
+  
+    
+  
+
return:  Object with info from the ldap serveur

+

+


+
+	
+Overrides PlaAbstractExporter::pla_get_ldap_info() (Return a PlaLdapInfo Object)


+
+        
[ Top ]

+  

+  

+	
+	
method pla_has_entry [line 338]

+	

+    

+    

+		bool pla_has_entry(
+)
+    

+    


+	
+		Return true if there is some more entries to be processed




+
Tags:

+

+
+  
+    
+  
+
return:  if there is some more entries to be processed

+

+


+
+	
+Overrides PlaAbstractExporter::pla_has_entry() (Return true if there is some more entries to be processed)


+
+        
[ Top ]

+  

+  

+	
+	
method pla_num_entries [line 330]

+	

+    

+    

+		int pla_num_entries(
+)
+    

+    


+	
+		Return the number of entries




+
Tags:

+

+
+  
+    
+  
+
return:  the number of entries to be exported

+

+


+
+	
+Overrides PlaAbstractExporter::pla_num_entries() (Return the number of entries)


+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:44 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/tools/PlaLdifExporter.html b/lam-web/developers/phpdoc/tools/PlaLdifExporter.html
new file mode 100644
index 00000000..e9557a5f
--- /dev/null
+++ b/lam-web/developers/phpdoc/tools/PlaLdifExporter.html
@@ -0,0 +1,440 @@
+
+
+Docs For Class PlaLdifExporter
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
tools

+  		  [ class tree: tools ]
+		  [ index: tools ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					export.inc
+		

+					index.php
+		

+					lamdaemonTest.php
+		

+					massBuildAccounts.php
+		

+					masscreate.php
+		

+					massDoUpload.php
+		

+					ou_edit.php
+		

+					schema.php
+		

+					tools.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LdapExportInfo

+	    		MyCustomExporter

+	    		PlaAbstractExporter

+	    		PlaCSVExporter

+	    		PlaDsmlExporter

+	    		PlaExporter

+	    		PlaLdapExporter

+	    		PlaLdifExporter

+	    		PlaVcardExporter

+	  

+                		
+      

+
+
Class: PlaLdifExporter

+Source Location: /lib/export.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
PlaAbstractExporter
+   |
+   --PlaExporter
+      |
+      --PlaLdifExporter


+
Export entries to ldif format



+
Author(s):

+
    
+        

+
+
+
+
+    
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: PlaExporter

+

+

+  PlaExporter::$br
+  
+

+

+   
+

+

+  PlaExporter::$exporter
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: PlaExporter

+

+    

+    PlaExporter::PlaExporter()
+
+  

+  

+    Constructor
+  

+    

+    PlaExporter::export()
+
+  

+  

+    Abstract method use to export data.
+  

+    

+    PlaExporter::is_safe_ascii()
+
+  

+  

+    Helper method to check if the attribute value should be base 64 encoded.
+  

+    

+    PlaExporter::pla_fetch_entry_array()
+
+  

+  

+    Return the entry as an array
+  

+    

+    PlaExporter::pla_fetch_entry_object()
+
+  

+  

+    Return the entry as an Entry object
+  

+    

+    PlaExporter::pla_get_ldap_info()
+
+  

+  

+    Return a PlaLdapInfo Object
+  

+    

+    PlaExporter::pla_has_entry()
+
+  

+  

+    Return true if there is some more entries to be processed
+  

+    

+    PlaExporter::pla_num_entries()
+
+  

+  

+    Return the number of entries
+  

+    

+    PlaExporter::setOutputFormat()
+
+  

+  

+    Set the carriage return /linefeed for the export
+  

+  

+
Class: PlaAbstractExporter

+

+    

+    PlaAbstractExporter::pla_fetch_entry_array()
+
+  

+  

+    Return the entry as an array
+  

+    

+    PlaAbstractExporter::pla_fetch_entry_object()
+
+  

+  

+    Return the entry as an Entry object
+  

+    

+    PlaAbstractExporter::pla_get_ldap_info()
+
+  

+  

+    Return a PlaLdapInfo Object
+  

+    

+    PlaAbstractExporter::pla_has_entry()
+
+  

+  

+    Return true if there is some more entries to be processed
+  

+    

+    PlaAbstractExporter::pla_num_entries()
+
+  

+  

+    Return the number of entries
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 378]

+Export entries to ldif format




+
Tags:

+

+
+  
+    
+  
+
extends:  PlaExporter

+

+



+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$counter =  0

+	
[line 381]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$MAX_LDIF_LINE_LENGTH =  76

+	
[line 384]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor PlaLdifExporter [line 390]

+	

+    

+    

+		PlaLdifExporter PlaLdifExporter(
+PlaAbstractExporter
+$exporter)
+    

+    


+	
+		Create a PlaLdifExporter object




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
PlaAbstractExporter  $exporter  the source exporter

+    


+        
[ Top ]

+  

+  

+	
+	
method displayExportInfo [line 439]

+	

+    

+    

+		void displayExportInfo(
+mixed
+$pla_ldap_info)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method export [line 397]

+	

+    

+    

+		void export(
+)
+    

+    


+	
+		Export entries to ldif format




+
+	
+Overrides PlaExporter::export() (Abstract method use to export data.)


+
+        
[ Top ]

+  

+  

+	
+	
method multi_lines_display [line 452]

+	

+    

+    

+		void multi_lines_display(
+String
+$str)
+    

+    


+	
+		Helper method to wrap ldif lines




+
+	
+
+
+        
Parameters:

+    

+    
+          
+        
+        
+        
+      
+        
String  $str  the line to be wrapped if needed.

+    


+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:44 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/tools/PlaVcardExporter.html b/lam-web/developers/phpdoc/tools/PlaVcardExporter.html
new file mode 100644
index 00000000..6166075d
--- /dev/null
+++ b/lam-web/developers/phpdoc/tools/PlaVcardExporter.html
@@ -0,0 +1,385 @@
+
+
+Docs For Class PlaVcardExporter
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
tools

+  		  [ class tree: tools ]
+		  [ index: tools ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					export.inc
+		

+					index.php
+		

+					lamdaemonTest.php
+		

+					massBuildAccounts.php
+		

+					masscreate.php
+		

+					massDoUpload.php
+		

+					ou_edit.php
+		

+					schema.php
+		

+					tools.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LdapExportInfo

+	    		MyCustomExporter

+	    		PlaAbstractExporter

+	    		PlaCSVExporter

+	    		PlaDsmlExporter

+	    		PlaExporter

+	    		PlaLdapExporter

+	    		PlaLdifExporter

+	    		PlaVcardExporter

+	  

+                		
+      

+
+
Class: PlaVcardExporter

+Source Location: /lib/export.inc


+
+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
PlaAbstractExporter
+   |
+   --PlaExporter
+      |
+      --PlaVcardExporter


+



+
+
+
+
+
+
+        
+		
+
Variables

+
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+
+

+
Inherited Variables

+

+
Class: PlaExporter

+

+

+  PlaExporter::$br
+  
+

+

+   
+

+

+  PlaExporter::$exporter
+  
+

+

+   
+

+

+

+		
+
Inherited Methods

+

+
Class: PlaExporter

+

+    

+    PlaExporter::PlaExporter()
+
+  

+  

+    Constructor
+  

+    

+    PlaExporter::export()
+
+  

+  

+    Abstract method use to export data.
+  

+    

+    PlaExporter::is_safe_ascii()
+
+  

+  

+    Helper method to check if the attribute value should be base 64 encoded.
+  

+    

+    PlaExporter::pla_fetch_entry_array()
+
+  

+  

+    Return the entry as an array
+  

+    

+    PlaExporter::pla_fetch_entry_object()
+
+  

+  

+    Return the entry as an Entry object
+  

+    

+    PlaExporter::pla_get_ldap_info()
+
+  

+  

+    Return a PlaLdapInfo Object
+  

+    

+    PlaExporter::pla_has_entry()
+
+  

+  

+    Return true if there is some more entries to be processed
+  

+    

+    PlaExporter::pla_num_entries()
+
+  

+  

+    Return the number of entries
+  

+    

+    PlaExporter::setOutputFormat()
+
+  

+  

+    Set the carriage return /linefeed for the export
+  

+  

+
Class: PlaAbstractExporter

+

+    

+    PlaAbstractExporter::pla_fetch_entry_array()
+
+  

+  

+    Return the entry as an array
+  

+    

+    PlaAbstractExporter::pla_fetch_entry_object()
+
+  

+  

+    Return the entry as an Entry object
+  

+    

+    PlaAbstractExporter::pla_get_ldap_info()
+
+  

+  

+    Return a PlaLdapInfo Object
+  

+    

+    PlaAbstractExporter::pla_has_entry()
+
+  

+  

+    Return true if there is some more entries to be processed
+  

+    

+    PlaAbstractExporter::pla_num_entries()
+
+  

+  

+    Return the number of entries
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 565]

+



+
[ Top ]


+
+

+
+
Class Variables

+

+	
+	

+	
$deliveryAddress = array("postOfficeBox",

+            "street",

+            "l",

+            "st",

+            "postalCode",

+            "c")

+	
[line 582]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+	
+	

+	
$vcardMapping = array('cn' => 'FN',

+             'title' => 'TITLE',

+             'homePhone' => 'TEL;HOME',

+             'mobile' => 'TEL;CELL',

+             'mail' => 'EMAIL;Internet',

+             'labeledURI' =>'URL',

+             'o' => 'ORG',

+             'audio' => 'SOUND',

+             'facsmileTelephoneNumber' =>'TEL;WORK;HOME;VOICE;FAX',

+             'jpegPhoto' => 'PHOTO;ENCODING=BASE64',

+             'businessCategory' => 'ROLE',

+             'description' => 'NOTE'

+             )

+	
[line 568]

+  
+  

+	

+  
+    
+      
+      
+    
+      
Type:  mixed

+	



+	
[ Top ]


+


+
+

+
+
Class Methods

+

+
+  

+	
+	
constructor PlaVcardExporter [line 589]

+	

+    

+    

+		PlaVcardExporter PlaVcardExporter(
+mixed
+$exporter)
+    

+    


+	
+		


+
+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method export [line 598]

+	

+    

+    

+		void export(
+)
+    

+    


+	
+		When doing an exporter, the method export need to be overriden.

A basic implementation is provided here. Customize to your need




+
+	
+Overrides PlaExporter::export() (Abstract method use to export data.)


+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:44 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/tools/_lib_export_inc.html b/lam-web/developers/phpdoc/tools/_lib_export_inc.html
new file mode 100644
index 00000000..3fd1e6da
--- /dev/null
+++ b/lam-web/developers/phpdoc/tools/_lib_export_inc.html
@@ -0,0 +1,244 @@
+
+
+Docs for page export.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
tools

+  		  [ class tree: tools ]
+		  [ index: tools ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					export.inc
+		

+					index.php
+		

+					lamdaemonTest.php
+		

+					massBuildAccounts.php
+		

+					masscreate.php
+		

+					massDoUpload.php
+		

+					ou_edit.php
+		

+					schema.php
+		

+					tools.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LdapExportInfo

+	    		MyCustomExporter

+	    		PlaAbstractExporter

+	    		PlaCSVExporter

+	    		PlaDsmlExporter

+	    		PlaExporter

+	    		PlaLdapExporter

+	    		PlaLdifExporter

+	    		PlaVcardExporter

+	  

+                		
+      

+
+
Procedural File: export.inc

+Source Location: /lib/export.inc


+
+

+

+
+

+
Classes:

+
LdapExportInfo

+	
This class encapsulate informations about the ldap server  from which the export is done.

+
PlaAbstractExporter

+	
This class represents the base class of all exporters

+
PlaExporter

+	
PlaExporter acts a wrapper around another exporter.

+
PlaLdapExporter

+	
Export data from a ldap server

+
PlaLdifExporter

+	
Export entries to ldif format

+
PlaDsmlExporter

+	
Export entries to DSML v.1

+
PlaVcardExporter

+	

+
PlaCSVExporter

+	
Export to cvs format

+
MyCustomExporter

+	

+



+
+
Page Details:

+Functions and classes for exporting LDAP entries to others formats (LDIF,DSML,..)  An example is provided at the bottom of this file if you want implement yours.




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  The phpLDAPadmin development team

+

+


+
Includes:

+

+include_once('status.inc') [line 40]

+used to print status messages


+


+


+

+  

+	
+	
get_user_agent_string [line 847]

+	

+    

+    

+		String get_user_agent_string(
+)
+    

+    


+
+		Gets the USER_AGENT string from the $_SERVER array, all in lower case in  an E_NOTICE safe manner.




+
Tags:

+

+
+  
+    
+  
+
return:  The user agent string as reported by the browser.

+

+    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
is_browser_os_mac [line 947]

+	

+    

+    

+		boolean is_browser_os_mac(
+)
+    

+    


+
+		Determines whether the browser's operating system is Macintosh.




+
Tags:

+

+
+  
+    
+  
+
return:  True if the brower's OS is mac, false otherwise.

+

+    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
is_browser_os_unix [line 859]

+	

+    

+    

+		boolean is_browser_os_unix(
+)
+    

+    


+
+		Determines whether the browser's operating system is UNIX (or something like UNIX).




+
Tags:

+

+
+  
+    
+  
+
return:  True if the brower's OS is UNIX, false otherwise.

+

+    


+	
+
+    	
[ Top ]



+	

+  

+	
+	
is_browser_os_windows [line 910]

+	

+    

+    

+		boolean is_browser_os_windows(
+)
+    

+    


+
+		Determines whether the browser's operating system is Windows.




+
Tags:

+

+
+  
+    
+  
+
return:  True if the brower's OS is Windows, false otherwise.

+

+    


+	
+
+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:42 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/tools/_templates_massBuildAccounts_php.html b/lam-web/developers/phpdoc/tools/_templates_massBuildAccounts_php.html
new file mode 100644
index 00000000..7c7ca500
--- /dev/null
+++ b/lam-web/developers/phpdoc/tools/_templates_massBuildAccounts_php.html
@@ -0,0 +1,123 @@
+
+
+Docs for page massBuildAccounts.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
tools

+  		  [ class tree: tools ]
+		  [ index: tools ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					export.inc
+		

+					index.php
+		

+					lamdaemonTest.php
+		

+					massBuildAccounts.php
+		

+					masscreate.php
+		

+					massDoUpload.php
+		

+					ou_edit.php
+		

+					schema.php
+		

+					tools.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LdapExportInfo

+	    		MyCustomExporter

+	    		PlaAbstractExporter

+	    		PlaCSVExporter

+	    		PlaDsmlExporter

+	    		PlaExporter

+	    		PlaLdapExporter

+	    		PlaLdifExporter

+	    		PlaVcardExporter

+	  

+                		
+      

+
+
Procedural File: massBuildAccounts.php

+Source Location: /templates/massBuildAccounts.php


+
+

+

+
+
+
Page Details:

+Creates the accounts by parsing the uploaded file.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once("../lib/security.inc") [line 32]

+security functions

include_once('../lib/config.inc') [line 34]

+access to configuration

include_once('../lib/status.inc') [line 36]

+status messages

include_once('../lib/modules.inc') [line 38]

+account modules


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:53 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/tools/_templates_massDoUpload_php.html b/lam-web/developers/phpdoc/tools/_templates_massDoUpload_php.html
new file mode 100644
index 00000000..c41019cd
--- /dev/null
+++ b/lam-web/developers/phpdoc/tools/_templates_massDoUpload_php.html
@@ -0,0 +1,125 @@
+
+
+Docs for page massDoUpload.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
tools

+  		  [ class tree: tools ]
+		  [ index: tools ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					export.inc
+		

+					index.php
+		

+					lamdaemonTest.php
+		

+					massBuildAccounts.php
+		

+					masscreate.php
+		

+					massDoUpload.php
+		

+					ou_edit.php
+		

+					schema.php
+		

+					tools.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LdapExportInfo

+	    		MyCustomExporter

+	    		PlaAbstractExporter

+	    		PlaCSVExporter

+	    		PlaDsmlExporter

+	    		PlaExporter

+	    		PlaLdapExporter

+	    		PlaLdifExporter

+	    		PlaVcardExporter

+	  

+                		
+      

+
+
Procedural File: massDoUpload.php

+Source Location: /templates/massDoUpload.php


+
+

+

+
+
+
Page Details:

+Creates LDAP accounts for file upload.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once('../lib/config.inc') [line 34]

+access to configuration

include_once("../lib/security.inc") [line 32]

+security functions

include_once('../lib/ldap.inc') [line 36]

+LDAP handle

include_once('../lib/status.inc') [line 38]

+status messages

include_once('../lib/cache.inc') [line 42]

+LAM cache

include_once('../lib/modules.inc') [line 40]

+account modules


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:53 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/tools/_templates_masscreate_php.html b/lam-web/developers/phpdoc/tools/_templates_masscreate_php.html
new file mode 100644
index 00000000..a1cf24fc
--- /dev/null
+++ b/lam-web/developers/phpdoc/tools/_templates_masscreate_php.html
@@ -0,0 +1,181 @@
+
+
+Docs for page masscreate.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
tools

+  		  [ class tree: tools ]
+		  [ index: tools ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					export.inc
+		

+					index.php
+		

+					lamdaemonTest.php
+		

+					massBuildAccounts.php
+		

+					masscreate.php
+		

+					massDoUpload.php
+		

+					ou_edit.php
+		

+					schema.php
+		

+					tools.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LdapExportInfo

+	    		MyCustomExporter

+	    		PlaAbstractExporter

+	    		PlaCSVExporter

+	    		PlaDsmlExporter

+	    		PlaExporter

+	    		PlaLdapExporter

+	    		PlaLdifExporter

+	    		PlaVcardExporter

+	  

+                		
+      

+
+
Procedural File: masscreate.php

+Source Location: /templates/masscreate.php


+
+

+

+
+
+
Page Details:

+Start page of file upload




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once('../lib/config.inc') [line 34]

+access to configuration

include_once('../lib/status.inc') [line 36]

+status messages

include_once("../lib/security.inc") [line 32]

+security functions

include_once('../lib/modules.inc') [line 38]

+account modules


+


+


+

+  

+	
+	
showColumnData [line 288]

+	

+    

+    

+		void showColumnData(
+string $module, array $data, string $scope)
+    

+    


+
+		Prints the properties of one input field.

    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $module  account module name
array  $data  field data from modules
string  $scope  account type

+    	
[ Top ]



+	

+  

+	
+	
showMainPage [line 120]

+	

+    

+    

+		void showMainPage(
+string $scope)
+    

+    


+
+		Displays the acount type specific main page of the upload.

    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $scope  account type

+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:53 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/tools/_templates_ou_edit_php.html b/lam-web/developers/phpdoc/tools/_templates_ou_edit_php.html
new file mode 100644
index 00000000..96007e4a
--- /dev/null
+++ b/lam-web/developers/phpdoc/tools/_templates_ou_edit_php.html
@@ -0,0 +1,139 @@
+
+
+Docs for page ou_edit.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
tools

+  		  [ class tree: tools ]
+		  [ index: tools ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					export.inc
+		

+					index.php
+		

+					lamdaemonTest.php
+		

+					massBuildAccounts.php
+		

+					masscreate.php
+		

+					massDoUpload.php
+		

+					ou_edit.php
+		

+					schema.php
+		

+					tools.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LdapExportInfo

+	    		MyCustomExporter

+	    		PlaAbstractExporter

+	    		PlaCSVExporter

+	    		PlaDsmlExporter

+	    		PlaExporter

+	    		PlaLdapExporter

+	    		PlaLdifExporter

+	    		PlaVcardExporter

+	  

+                		
+      

+
+
Procedural File: ou_edit.php

+Source Location: /templates/ou_edit.php


+
+

+

+
+
+
Page Details:

+This is an editor for organizational units.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once("../lib/security.inc") [line 32]

+security functions

include_once("../lib/config.inc") [line 34]

+access to configuration data

include_once("../lib/ldap.inc") [line 36]

+access LDAP server

include_once("../lib/status.inc") [line 38]

+used to print status messages


+


+


+

+  

+	
+	
display_main [line 141]

+	

+    

+    

+		void display_main(
+)
+    

+    


+
+		    


+	
+
+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:55 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/tools/_templates_schema_schema_php.html b/lam-web/developers/phpdoc/tools/_templates_schema_schema_php.html
new file mode 100644
index 00000000..5b5d3340
--- /dev/null
+++ b/lam-web/developers/phpdoc/tools/_templates_schema_schema_php.html
@@ -0,0 +1,126 @@
+
+
+Docs for page schema.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
tools

+  		  [ class tree: tools ]
+		  [ index: tools ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					export.inc
+		

+					index.php
+		

+					lamdaemonTest.php
+		

+					massBuildAccounts.php
+		

+					masscreate.php
+		

+					massDoUpload.php
+		

+					ou_edit.php
+		

+					schema.php
+		

+					tools.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LdapExportInfo

+	    		MyCustomExporter

+	    		PlaAbstractExporter

+	    		PlaCSVExporter

+	    		PlaDsmlExporter

+	    		PlaExporter

+	    		PlaLdapExporter

+	    		PlaLdifExporter

+	    		PlaVcardExporter

+	  

+                		
+      

+
+
Procedural File: schema.php

+Source Location: /templates/schema/schema.php


+
+

+

+
+
+
Page Details:

+Displays the LDAP schema of the server




+
Tags:

+

+
+  
+    
+  
+  
+    
+  
+
author:  Roland Gruber
author:  David Smith

+

+


+
Includes:

+

+include_once("../../lib/security.inc") [line 35]

+security functions

include_once("../../lib/ldap.inc") [line 37]

+access to LDAP server

include_once("../../lib/config.inc") [line 39]

+access to configuration options

require_once("../../lib/schema.inc") [line 41]

+schema functions


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:06 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/tools/_templates_tests_index_php.html b/lam-web/developers/phpdoc/tools/_templates_tests_index_php.html
new file mode 100644
index 00000000..8ad8bad8
--- /dev/null
+++ b/lam-web/developers/phpdoc/tools/_templates_tests_index_php.html
@@ -0,0 +1,121 @@
+
+
+Docs for page index.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
tools

+  		  [ class tree: tools ]
+		  [ index: tools ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					export.inc
+		

+					index.php
+		

+					lamdaemonTest.php
+		

+					massBuildAccounts.php
+		

+					masscreate.php
+		

+					massDoUpload.php
+		

+					ou_edit.php
+		

+					schema.php
+		

+					tools.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LdapExportInfo

+	    		MyCustomExporter

+	    		PlaAbstractExporter

+	    		PlaCSVExporter

+	    		PlaDsmlExporter

+	    		PlaExporter

+	    		PlaLdapExporter

+	    		PlaLdifExporter

+	    		PlaVcardExporter

+	  

+                		
+      

+
+
Procedural File: index.php

+Source Location: /templates/tests/index.php


+
+

+

+
+
+
Page Details:

+Provides a list of LAM tests.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once("../../lib/security.inc") [line 32]

+security functions

include_once("../../lib/config.inc") [line 34]

+access to configuration options


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:47 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/tools/_templates_tests_lamdaemonTest_php.html b/lam-web/developers/phpdoc/tools/_templates_tests_lamdaemonTest_php.html
new file mode 100644
index 00000000..b24d6f01
--- /dev/null
+++ b/lam-web/developers/phpdoc/tools/_templates_tests_lamdaemonTest_php.html
@@ -0,0 +1,169 @@
+
+
+Docs for page lamdaemonTest.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
tools

+  		  [ class tree: tools ]
+		  [ index: tools ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					export.inc
+		

+					index.php
+		

+					lamdaemonTest.php
+		

+					massBuildAccounts.php
+		

+					masscreate.php
+		

+					massDoUpload.php
+		

+					ou_edit.php
+		

+					schema.php
+		

+					tools.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LdapExportInfo

+	    		MyCustomExporter

+	    		PlaAbstractExporter

+	    		PlaCSVExporter

+	    		PlaDsmlExporter

+	    		PlaExporter

+	    		PlaLdapExporter

+	    		PlaLdifExporter

+	    		PlaVcardExporter

+	  

+                		
+      

+
+
Procedural File: lamdaemonTest.php

+Source Location: /templates/tests/lamdaemonTest.php


+
+

+

+
+
+
Page Details:

+Tests the lamdaemon script.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once("../../lib/config.inc") [line 34]

+access to configuration options

include_once("../../lib/security.inc") [line 32]

+security functions


+


+


+

+  

+	
+	
lamTestLamdaemon [line 159]

+	

+    

+    

+		boolean lamTestLamdaemon(
+string $command, boolean $stopTest, connection $handle, string $testText)
+    

+    


+
+		Runs a test case of lamdaemon.




+
Tags:

+

+
+  
+    
+  
+
return:  true, if errors occured

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+		      
+        
+        
+        
+      
+				
string  $command  test command
boolean  $stopTest  specifies if test should be run
connection  $handle  SSH connection
string  $testText  describing text

+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:50 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/tools/_templates_tools_php.html b/lam-web/developers/phpdoc/tools/_templates_tools_php.html
new file mode 100644
index 00000000..ecbc098e
--- /dev/null
+++ b/lam-web/developers/phpdoc/tools/_templates_tools_php.html
@@ -0,0 +1,121 @@
+
+
+Docs for page tools.php
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
tools

+  		  [ class tree: tools ]
+		  [ index: tools ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					export.inc
+		

+					index.php
+		

+					lamdaemonTest.php
+		

+					massBuildAccounts.php
+		

+					masscreate.php
+		

+					massDoUpload.php
+		

+					ou_edit.php
+		

+					schema.php
+		

+					tools.php
+		

+	  


+      
+      
+            Classes:

+        

+		    		LdapExportInfo

+	    		MyCustomExporter

+	    		PlaAbstractExporter

+	    		PlaCSVExporter

+	    		PlaDsmlExporter

+	    		PlaExporter

+	    		PlaLdapExporter

+	    		PlaLdifExporter

+	    		PlaVcardExporter

+	  

+                		
+      

+
+
Procedural File: tools.php

+Source Location: /templates/tools.php


+
+

+

+
+
+
Page Details:

+Provides a list of tools like file upload or profile editor.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once("../lib/security.inc") [line 32]

+security functions

include_once("../lib/config.inc") [line 34]

+access to configuration options


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:09 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/types/_lib_baseType_inc.html b/lam-web/developers/phpdoc/types/_lib_baseType_inc.html
new file mode 100644
index 00000000..8f5e1849
--- /dev/null
+++ b/lam-web/developers/phpdoc/types/_lib_baseType_inc.html
@@ -0,0 +1,114 @@
+
+
+Docs for page baseType.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
types

+  		  [ class tree: types ]
+		  [ index: types ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					baseType.inc
+		

+					group.inc
+		

+					host.inc
+		

+					mailAlias.inc
+		

+					smbDomain.inc
+		

+					types.inc
+		

+					user.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		baseType

+	    		group

+	    		host

+	    		mailAlias

+	    		smbDomain

+	    		user

+	  

+                		
+      

+
+
Procedural File: baseType.inc

+Source Location: /lib/baseType.inc


+
+

+

+
+

+
Classes:

+
baseType

+	
This is the parent class of all account types.

+



+
+
Page Details:

+This is the parent class of all account types.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:38 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/types/_lib_types_group_inc.html b/lam-web/developers/phpdoc/types/_lib_types_group_inc.html
new file mode 100644
index 00000000..9e62cf13
--- /dev/null
+++ b/lam-web/developers/phpdoc/types/_lib_types_group_inc.html
@@ -0,0 +1,116 @@
+
+
+Docs for page group.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
types

+  		  [ class tree: types ]
+		  [ index: types ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					baseType.inc
+		

+					group.inc
+		

+					host.inc
+		

+					mailAlias.inc
+		

+					smbDomain.inc
+		

+					types.inc
+		

+					user.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		baseType

+	    		group

+	    		host

+	    		mailAlias

+	    		smbDomain

+	    		user

+	  

+                		
+      

+
+
Procedural File: group.inc

+Source Location: /lib/types/group.inc


+
+

+

+
+

+
Classes:

+
group

+	
The account type for group accounts (e.g. Unix and Samba).

+
lamGroupList

+	
Generates the list view.

+



+
+
Page Details:

+The account type for group accounts (e.g. Unix and Samba).




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:46 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/types/_lib_types_host_inc.html b/lam-web/developers/phpdoc/types/_lib_types_host_inc.html
new file mode 100644
index 00000000..c236bd9f
--- /dev/null
+++ b/lam-web/developers/phpdoc/types/_lib_types_host_inc.html
@@ -0,0 +1,116 @@
+
+
+Docs for page host.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
types

+  		  [ class tree: types ]
+		  [ index: types ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					baseType.inc
+		

+					group.inc
+		

+					host.inc
+		

+					mailAlias.inc
+		

+					smbDomain.inc
+		

+					types.inc
+		

+					user.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		baseType

+	    		group

+	    		host

+	    		mailAlias

+	    		smbDomain

+	    		user

+	  

+                		
+      

+
+
Procedural File: host.inc

+Source Location: /lib/types/host.inc


+
+

+

+
+

+
Classes:

+
host

+	
The account type for host accounts (e.g. Samba).

+
lamHostList

+	
Generates the list view.

+



+
+
Page Details:

+The account type for host accounts (e.g. Samba).




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:46 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/types/_lib_types_inc.html b/lam-web/developers/phpdoc/types/_lib_types_inc.html
new file mode 100644
index 00000000..cece370a
--- /dev/null
+++ b/lam-web/developers/phpdoc/types/_lib_types_inc.html
@@ -0,0 +1,305 @@
+
+
+Docs for page types.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
types

+  		  [ class tree: types ]
+		  [ index: types ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					baseType.inc
+		

+					group.inc
+		

+					host.inc
+		

+					mailAlias.inc
+		

+					smbDomain.inc
+		

+					types.inc
+		

+					user.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		baseType

+	    		group

+	    		host

+	    		mailAlias

+	    		smbDomain

+	    		user

+	  

+                		
+      

+
+
Procedural File: types.inc

+Source Location: /lib/types.inc


+
+

+

+
+
+
Page Details:

+This file is the interface to the different account types.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+
Includes:

+

+include_once("baseType.inc") [line 32]

+parent class of account types

include_once("lists.inc") [line 34]

+parent class of list views

include_once($typesINC_dirname.'/'.$entry) [line 45]

+This includes all type definitions.


+


+


+

+  

+	
+	
getDefaultListAttributes [line 107]

+	

+    

+    

+		string getDefaultListAttributes(
+string $type)
+    

+    


+
+		Returns the default attribute list for an account type.

It is used as default value for the configuration editor.




+
Tags:

+

+
+  
+    
+  
+
return:  attribute list

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $type  account type

+    	
[ Top ]



+	

+  

+	
+	
getListAttributeDescriptions [line 119]

+	

+    

+    

+		array getListAttributeDescriptions(
+string $type)
+    

+    


+
+		Returns a list of attributes which have a translated description.

This is used for the head row in the list view.




+
Tags:

+

+
+  
+    
+  
+
return:  list of descriptions

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $type  account type

+    	
[ Top ]



+	

+  

+	
+	
getListClassName [line 95]

+	

+    

+    

+		string getListClassName(
+string $type)
+    

+    


+
+		Returns the class name for the list object.




+
Tags:

+

+
+  
+    
+  
+
return:  class name

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $type  account type

+    	
[ Top ]



+	

+  

+	
+	
getTypeAlias [line 73]

+	

+    

+    

+		string getTypeAlias(
+string $type)
+    

+    


+
+		Returns the alias name of an account type.




+
Tags:

+

+
+  
+    
+  
+
return:  type alias

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $type  type name

+    	
[ Top ]



+	

+  

+	
+	
getTypeDescription [line 84]

+	

+    

+    

+		string getTypeDescription(
+string $type)
+    

+    


+
+		Returns the description of an account type.




+
Tags:

+

+
+  
+    
+  
+
return:  type description

+

+    


+	
+
+    		
Parameters

+    
+		      
+        
+        
+        
+      
+				
string  $type  type name

+    	
[ Top ]



+	

+  

+	
+	
getTypes [line 54]

+	

+    

+    

+		array getTypes(
+)
+    

+    


+
+		Returns a list of available account types.




+
Tags:

+

+
+  
+    
+  
+
return:  list of types

+

+    


+	
+
+    	
[ Top ]



+	

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:12 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/types/_lib_types_mailAlias_inc.html b/lam-web/developers/phpdoc/types/_lib_types_mailAlias_inc.html
new file mode 100644
index 00000000..10a01811
--- /dev/null
+++ b/lam-web/developers/phpdoc/types/_lib_types_mailAlias_inc.html
@@ -0,0 +1,116 @@
+
+
+Docs for page mailAlias.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
types

+  		  [ class tree: types ]
+		  [ index: types ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					baseType.inc
+		

+					group.inc
+		

+					host.inc
+		

+					mailAlias.inc
+		

+					smbDomain.inc
+		

+					types.inc
+		

+					user.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		baseType

+	    		group

+	    		host

+	    		mailAlias

+	    		smbDomain

+	    		user

+	  

+                		
+      

+
+
Procedural File: mailAlias.inc

+Source Location: /lib/types/mailAlias.inc


+
+

+

+
+

+
Classes:

+
mailAlias

+	
The account type for mail aliases.

+
lamMailAliasList

+	
Generates the list view.

+



+
+
Page Details:

+The account type for mail aliases.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:52 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/types/_lib_types_smbDomain_inc.html b/lam-web/developers/phpdoc/types/_lib_types_smbDomain_inc.html
new file mode 100644
index 00000000..25887982
--- /dev/null
+++ b/lam-web/developers/phpdoc/types/_lib_types_smbDomain_inc.html
@@ -0,0 +1,116 @@
+
+
+Docs for page smbDomain.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
types

+  		  [ class tree: types ]
+		  [ index: types ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					baseType.inc
+		

+					group.inc
+		

+					host.inc
+		

+					mailAlias.inc
+		

+					smbDomain.inc
+		

+					types.inc
+		

+					user.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		baseType

+	    		group

+	    		host

+	    		mailAlias

+	    		smbDomain

+	    		user

+	  

+                		
+      

+
+
Procedural File: smbDomain.inc

+Source Location: /lib/types/smbDomain.inc


+
+

+

+
+

+
Classes:

+
smbDomain

+	
The account type for Samba domains.

+
lamSmbDomainList

+	
Generates the list view.

+



+
+
Page Details:

+The account type for Samba domains.




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:08 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/types/_lib_types_user_inc.html b/lam-web/developers/phpdoc/types/_lib_types_user_inc.html
new file mode 100644
index 00000000..8df9ff2c
--- /dev/null
+++ b/lam-web/developers/phpdoc/types/_lib_types_user_inc.html
@@ -0,0 +1,116 @@
+
+
+Docs for page user.inc
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
types

+  		  [ class tree: types ]
+		  [ index: types ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					baseType.inc
+		

+					group.inc
+		

+					host.inc
+		

+					mailAlias.inc
+		

+					smbDomain.inc
+		

+					types.inc
+		

+					user.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		baseType

+	    		group

+	    		host

+	    		mailAlias

+	    		smbDomain

+	    		user

+	  

+                		
+      

+
+
Procedural File: user.inc

+Source Location: /lib/types/user.inc


+
+

+

+
+

+
Classes:

+
user

+	
The account type for user accounts (e.g. Unix, Samba and Kolab).

+
lamUserList

+	
Generates the list view.

+



+
+
Page Details:

+The account type for user accounts (e.g. Unix, Samba and Kolab).




+
Tags:

+

+
+  
+    
+  
+
author:  Roland Gruber

+

+


+


+


+

+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:13 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/types/baseType.html b/lam-web/developers/phpdoc/types/baseType.html
new file mode 100644
index 00000000..9c30def5
--- /dev/null
+++ b/lam-web/developers/phpdoc/types/baseType.html
@@ -0,0 +1,420 @@
+
+
+Docs For Class baseType
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
types

+  		  [ class tree: types ]
+		  [ index: types ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					baseType.inc
+		

+					group.inc
+		

+					host.inc
+		

+					mailAlias.inc
+		

+					smbDomain.inc
+		

+					types.inc
+		

+					user.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		baseType

+	    		group

+	    		host

+	    		mailAlias

+	    		smbDomain

+	    		user

+	  

+                		
+      

+
+
Class: baseType

+Source Location: /lib/baseType.inc


+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+


+
This is the parent class of all account types.



+
+
+
+
+
+
+        
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+

+
Child classes:

+

+

+
mailAlias

+	
The account type for mail aliases.

+

+

+
host

+	
The account type for host accounts (e.g. Samba).

+

+

+
smbDomain

+	
The account type for Samba domains.

+

+

+
group

+	
The account type for group accounts (e.g. Unix and Samba).

+

+

+
user

+	
The account type for user accounts (e.g. Unix, Samba and Kolab).

+

+

+

+

+
+
+
Class Details

+

+[line 36]

+This is the parent class of all account types.




+
[ Top ]


+
+
+

+
+
Class Methods

+

+
+  

+	
+	
method getAlias [line 44]

+	

+    

+    

+		string getAlias(
+)
+    

+    


+	
+		Returns the alias name of this account type.

This function must be overwritten by the child classes.




+
Tags:

+

+
+  
+    
+  
+
return:  alias name

+

+


+
+	
Overridden in child classes as:

+		

+	
mailAlias::getAlias()

+		
Returns the alias name of this account type.

+	

+		

+	
host::getAlias()

+		
Returns the alias name of this account type.

+	

+		

+	
smbDomain::getAlias()

+		
Returns the alias name of this account type.

+	

+		

+	
group::getAlias()

+		
Returns the alias name of this account type.

+	

+		

+	
user::getAlias()

+		
Returns the alias name of this account type.

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getDefaultListAttributes [line 73]

+	

+    

+    

+		string getDefaultListAttributes(
+)
+    

+    


+	
+		Returns the default attribute list for this account type.

This function must be overwritten by the child classes.




+
Tags:

+

+
+  
+    
+  
+
return:  attribute list

+

+


+
+	
Overridden in child classes as:

+		

+	
mailAlias::getDefaultListAttributes()

+		
Returns the default attribute list for this account type.

+	

+		

+	
host::getDefaultListAttributes()

+		
Returns the default attribute list for this account type.

+	

+		

+	
smbDomain::getDefaultListAttributes()

+		
Returns the default attribute list for this account type.

+	

+		

+	
group::getDefaultListAttributes()

+		
Returns the default attribute list for this account type.

+	

+		

+	
user::getDefaultListAttributes()

+		
Returns the default attribute list for this account type.

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getDescription [line 54]

+	

+    

+    

+		string getDescription(
+)
+    

+    


+	
+		Returns the description of this account type.

This function must be overwritten by the child classes.




+
Tags:

+

+
+  
+    
+  
+
return:  description

+

+


+
+	
Overridden in child classes as:

+		

+	
mailAlias::getDescription()

+		
Returns the description of this account type.

+	

+		

+	
host::getDescription()

+		
Returns the description of this account type.

+	

+		

+	
smbDomain::getDescription()

+		
Returns the description of this account type.

+	

+		

+	
group::getDescription()

+		
Returns the description of this account type.

+	

+		

+	
user::getDescription()

+		
Returns the description of this account type.

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getListAttributeDescriptions [line 83]

+	

+    

+    

+		array getListAttributeDescriptions(
+)
+    

+    


+	
+		Returns a list of attributes which have a translated description.

This is used for the head row in the list view.




+
Tags:

+

+
+  
+    
+  
+
return:  list of descriptions

+

+


+
+	
Overridden in child classes as:

+		

+	
mailAlias::getListAttributeDescriptions()

+		
Returns a list of attributes which have a translated description.

+	

+		

+	
host::getListAttributeDescriptions()

+		
Returns a list of attributes which have a translated description.

+	

+		

+	
smbDomain::getListAttributeDescriptions()

+		
Returns a list of attributes which have a translated description.

+	

+		

+	
group::getListAttributeDescriptions()

+		
Returns a list of attributes which have a translated description.

+	

+		

+	
user::getListAttributeDescriptions()

+		
Returns a list of attributes which have a translated description.

+	

+	

+	
+
+
+        
[ Top ]

+  

+  

+	
+	
method getListClassName [line 63]

+	

+    

+    

+		string getListClassName(
+)
+    

+    


+	
+		Returns the class name for the list object.




+
Tags:

+

+
+  
+    
+  
+
return:  class name

+

+


+
+	
Overridden in child classes as:

+		

+	
mailAlias::getListClassName()

+		
Returns the class name for the list object.

+	

+		

+	
host::getListClassName()

+		
Returns the class name for the list object.

+	

+		

+	
smbDomain::getListClassName()

+		
Returns the class name for the list object.

+	

+		

+	
group::getListClassName()

+		
Returns the class name for the list object.

+	

+		

+	
user::getListClassName()

+		
Returns the class name for the list object.

+	

+	

+	
+
+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:38 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/types/group.html b/lam-web/developers/phpdoc/types/group.html
new file mode 100644
index 00000000..5d391e9e
--- /dev/null
+++ b/lam-web/developers/phpdoc/types/group.html
@@ -0,0 +1,330 @@
+
+
+Docs For Class group
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
types

+  		  [ class tree: types ]
+		  [ index: types ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					baseType.inc
+		

+					group.inc
+		

+					host.inc
+		

+					mailAlias.inc
+		

+					smbDomain.inc
+		

+					types.inc
+		

+					user.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		baseType

+	    		group

+	    		host

+	    		mailAlias

+	    		smbDomain

+	    		user

+	  

+                		
+      

+
+
Class: group

+Source Location: /lib/types/group.inc


+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
baseType
+   |
+   --group


+
The account type for group accounts (e.g. Unix and Samba).



+
+
+
+
+
+
+        
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+

+
Inherited Methods

+

+
Class: baseType

+

+    

+    baseType::getAlias()
+
+  

+  

+    Returns the alias name of this account type.
+  

+    

+    baseType::getDefaultListAttributes()
+
+  

+  

+    Returns the default attribute list for this account type.
+  

+    

+    baseType::getDescription()
+
+  

+  

+    Returns the description of this account type.
+  

+    

+    baseType::getListAttributeDescriptions()
+
+  

+  

+    Returns a list of attributes which have a translated description.
+  

+    

+    baseType::getListClassName()
+
+  

+  

+    Returns the class name for the list object.
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 36]

+The account type for group accounts (e.g. Unix and Samba).




+
[ Top ]


+
+
+

+
+
Class Methods

+

+
+  

+	
+	
method getAlias [line 43]

+	

+    

+    

+		string getAlias(
+)
+    

+    


+	
+		Returns the alias name of this account type.




+
Tags:

+

+
+  
+    
+  
+
return:  alias name

+

+


+
+	
+Overrides baseType::getAlias() (Returns the alias name of this account type.)


+
+        
[ Top ]

+  

+  

+	
+	
method getDefaultListAttributes [line 70]

+	

+    

+    

+		string getDefaultListAttributes(
+)
+    

+    


+	
+		Returns the default attribute list for this account type.




+
Tags:

+

+
+  
+    
+  
+
return:  attribute list

+

+


+
+	
+Overrides baseType::getDefaultListAttributes() (Returns the default attribute list for this account type.)


+
+        
[ Top ]

+  

+  

+	
+	
method getDescription [line 52]

+	

+    

+    

+		string getDescription(
+)
+    

+    


+	
+		Returns the description of this account type.




+
Tags:

+

+
+  
+    
+  
+
return:  description

+

+


+
+	
+Overrides baseType::getDescription() (Returns the description of this account type.)


+
+        
[ Top ]

+  

+  

+	
+	
method getListAttributeDescriptions [line 80]

+	

+    

+    

+		array getListAttributeDescriptions(
+)
+    

+    


+	
+		Returns a list of attributes which have a translated description.

This is used for the head row in the list view.




+
Tags:

+

+
+  
+    
+  
+
return:  list of descriptions

+

+


+
+	
+Overrides baseType::getListAttributeDescriptions() (Returns a list of attributes which have a translated description.)


+
+        
[ Top ]

+  

+  

+	
+	
method getListClassName [line 61]

+	

+    

+    

+		string getListClassName(
+)
+    

+    


+	
+		Returns the class name for the list object.




+
Tags:

+

+
+  
+    
+  
+
return:  class name

+

+


+
+	
+Overrides baseType::getListClassName() (Returns the class name for the list object.)


+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:46 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/types/host.html b/lam-web/developers/phpdoc/types/host.html
new file mode 100644
index 00000000..5731baa0
--- /dev/null
+++ b/lam-web/developers/phpdoc/types/host.html
@@ -0,0 +1,330 @@
+
+
+Docs For Class host
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
types

+  		  [ class tree: types ]
+		  [ index: types ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					baseType.inc
+		

+					group.inc
+		

+					host.inc
+		

+					mailAlias.inc
+		

+					smbDomain.inc
+		

+					types.inc
+		

+					user.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		baseType

+	    		group

+	    		host

+	    		mailAlias

+	    		smbDomain

+	    		user

+	  

+                		
+      

+
+
Class: host

+Source Location: /lib/types/host.inc


+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
baseType
+   |
+   --host


+
The account type for host accounts (e.g. Samba).



+
+
+
+
+
+
+        
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+

+
Inherited Methods

+

+
Class: baseType

+

+    

+    baseType::getAlias()
+
+  

+  

+    Returns the alias name of this account type.
+  

+    

+    baseType::getDefaultListAttributes()
+
+  

+  

+    Returns the default attribute list for this account type.
+  

+    

+    baseType::getDescription()
+
+  

+  

+    Returns the description of this account type.
+  

+    

+    baseType::getListAttributeDescriptions()
+
+  

+  

+    Returns a list of attributes which have a translated description.
+  

+    

+    baseType::getListClassName()
+
+  

+  

+    Returns the class name for the list object.
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 36]

+The account type for host accounts (e.g. Samba).




+
[ Top ]


+
+
+

+
+
Class Methods

+

+
+  

+	
+	
method getAlias [line 43]

+	

+    

+    

+		string getAlias(
+)
+    

+    


+	
+		Returns the alias name of this account type.




+
Tags:

+

+
+  
+    
+  
+
return:  alias name

+

+


+
+	
+Overrides baseType::getAlias() (Returns the alias name of this account type.)


+
+        
[ Top ]

+  

+  

+	
+	
method getDefaultListAttributes [line 70]

+	

+    

+    

+		string getDefaultListAttributes(
+)
+    

+    


+	
+		Returns the default attribute list for this account type.




+
Tags:

+

+
+  
+    
+  
+
return:  attribute list

+

+


+
+	
+Overrides baseType::getDefaultListAttributes() (Returns the default attribute list for this account type.)


+
+        
[ Top ]

+  

+  

+	
+	
method getDescription [line 52]

+	

+    

+    

+		string getDescription(
+)
+    

+    


+	
+		Returns the description of this account type.




+
Tags:

+

+
+  
+    
+  
+
return:  description

+

+


+
+	
+Overrides baseType::getDescription() (Returns the description of this account type.)


+
+        
[ Top ]

+  

+  

+	
+	
method getListAttributeDescriptions [line 80]

+	

+    

+    

+		array getListAttributeDescriptions(
+)
+    

+    


+	
+		Returns a list of attributes which have a translated description.

This is used for the head row in the list view.




+
Tags:

+

+
+  
+    
+  
+
return:  list of descriptions

+

+


+
+	
+Overrides baseType::getListAttributeDescriptions() (Returns a list of attributes which have a translated description.)


+
+        
[ Top ]

+  

+  

+	
+	
method getListClassName [line 61]

+	

+    

+    

+		string getListClassName(
+)
+    

+    


+	
+		Returns the class name for the list object.




+
Tags:

+

+
+  
+    
+  
+
return:  class name

+

+


+
+	
+Overrides baseType::getListClassName() (Returns the class name for the list object.)


+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:46 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/types/mailAlias.html b/lam-web/developers/phpdoc/types/mailAlias.html
new file mode 100644
index 00000000..f9793493
--- /dev/null
+++ b/lam-web/developers/phpdoc/types/mailAlias.html
@@ -0,0 +1,330 @@
+
+
+Docs For Class mailAlias
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
types

+  		  [ class tree: types ]
+		  [ index: types ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					baseType.inc
+		

+					group.inc
+		

+					host.inc
+		

+					mailAlias.inc
+		

+					smbDomain.inc
+		

+					types.inc
+		

+					user.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		baseType

+	    		group

+	    		host

+	    		mailAlias

+	    		smbDomain

+	    		user

+	  

+                		
+      

+
+
Class: mailAlias

+Source Location: /lib/types/mailAlias.inc


+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
baseType
+   |
+   --mailAlias


+
The account type for mail aliases.



+
+
+
+
+
+
+        
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+

+
Inherited Methods

+

+
Class: baseType

+

+    

+    baseType::getAlias()
+
+  

+  

+    Returns the alias name of this account type.
+  

+    

+    baseType::getDefaultListAttributes()
+
+  

+  

+    Returns the default attribute list for this account type.
+  

+    

+    baseType::getDescription()
+
+  

+  

+    Returns the description of this account type.
+  

+    

+    baseType::getListAttributeDescriptions()
+
+  

+  

+    Returns a list of attributes which have a translated description.
+  

+    

+    baseType::getListClassName()
+
+  

+  

+    Returns the class name for the list object.
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 36]

+The account type for mail aliases.




+
[ Top ]


+
+
+

+
+
Class Methods

+

+
+  

+	
+	
method getAlias [line 43]

+	

+    

+    

+		string getAlias(
+)
+    

+    


+	
+		Returns the alias name of this account type.




+
Tags:

+

+
+  
+    
+  
+
return:  alias name

+

+


+
+	
+Overrides baseType::getAlias() (Returns the alias name of this account type.)


+
+        
[ Top ]

+  

+  

+	
+	
method getDefaultListAttributes [line 70]

+	

+    

+    

+		string getDefaultListAttributes(
+)
+    

+    


+	
+		Returns the default attribute list for this account type.




+
Tags:

+

+
+  
+    
+  
+
return:  attribute list

+

+


+
+	
+Overrides baseType::getDefaultListAttributes() (Returns the default attribute list for this account type.)


+
+        
[ Top ]

+  

+  

+	
+	
method getDescription [line 52]

+	

+    

+    

+		string getDescription(
+)
+    

+    


+	
+		Returns the description of this account type.




+
Tags:

+

+
+  
+    
+  
+
return:  description

+

+


+
+	
+Overrides baseType::getDescription() (Returns the description of this account type.)


+
+        
[ Top ]

+  

+  

+	
+	
method getListAttributeDescriptions [line 80]

+	

+    

+    

+		array getListAttributeDescriptions(
+)
+    

+    


+	
+		Returns a list of attributes which have a translated description.

This is used for the head row in the list view.




+
Tags:

+

+
+  
+    
+  
+
return:  list of descriptions

+

+


+
+	
+Overrides baseType::getListAttributeDescriptions() (Returns a list of attributes which have a translated description.)


+
+        
[ Top ]

+  

+  

+	
+	
method getListClassName [line 61]

+	

+    

+    

+		string getListClassName(
+)
+    

+    


+	
+		Returns the class name for the list object.




+
Tags:

+

+
+  
+    
+  
+
return:  class name

+

+


+
+	
+Overrides baseType::getListClassName() (Returns the class name for the list object.)


+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:00:52 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/types/smbDomain.html b/lam-web/developers/phpdoc/types/smbDomain.html
new file mode 100644
index 00000000..73c4c1c6
--- /dev/null
+++ b/lam-web/developers/phpdoc/types/smbDomain.html
@@ -0,0 +1,330 @@
+
+
+Docs For Class smbDomain
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
types

+  		  [ class tree: types ]
+		  [ index: types ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					baseType.inc
+		

+					group.inc
+		

+					host.inc
+		

+					mailAlias.inc
+		

+					smbDomain.inc
+		

+					types.inc
+		

+					user.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		baseType

+	    		group

+	    		host

+	    		mailAlias

+	    		smbDomain

+	    		user

+	  

+                		
+      

+
+
Class: smbDomain

+Source Location: /lib/types/smbDomain.inc


+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
baseType
+   |
+   --smbDomain


+
The account type for Samba domains.



+
+
+
+
+
+
+        
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+

+
Inherited Methods

+

+
Class: baseType

+

+    

+    baseType::getAlias()
+
+  

+  

+    Returns the alias name of this account type.
+  

+    

+    baseType::getDefaultListAttributes()
+
+  

+  

+    Returns the default attribute list for this account type.
+  

+    

+    baseType::getDescription()
+
+  

+  

+    Returns the description of this account type.
+  

+    

+    baseType::getListAttributeDescriptions()
+
+  

+  

+    Returns a list of attributes which have a translated description.
+  

+    

+    baseType::getListClassName()
+
+  

+  

+    Returns the class name for the list object.
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 36]

+The account type for Samba domains.




+
[ Top ]


+
+
+

+
+
Class Methods

+

+
+  

+	
+	
method getAlias [line 43]

+	

+    

+    

+		string getAlias(
+)
+    

+    


+	
+		Returns the alias name of this account type.




+
Tags:

+

+
+  
+    
+  
+
return:  alias name

+

+


+
+	
+Overrides baseType::getAlias() (Returns the alias name of this account type.)


+
+        
[ Top ]

+  

+  

+	
+	
method getDefaultListAttributes [line 70]

+	

+    

+    

+		string getDefaultListAttributes(
+)
+    

+    


+	
+		Returns the default attribute list for this account type.




+
Tags:

+

+
+  
+    
+  
+
return:  attribute list

+

+


+
+	
+Overrides baseType::getDefaultListAttributes() (Returns the default attribute list for this account type.)


+
+        
[ Top ]

+  

+  

+	
+	
method getDescription [line 52]

+	

+    

+    

+		string getDescription(
+)
+    

+    


+	
+		Returns the description of this account type.




+
Tags:

+

+
+  
+    
+  
+
return:  description

+

+


+
+	
+Overrides baseType::getDescription() (Returns the description of this account type.)


+
+        
[ Top ]

+  

+  

+	
+	
method getListAttributeDescriptions [line 80]

+	

+    

+    

+		array getListAttributeDescriptions(
+)
+    

+    


+	
+		Returns a list of attributes which have a translated description.

This is used for the head row in the list view.




+
Tags:

+

+
+  
+    
+  
+
return:  list of descriptions

+

+


+
+	
+Overrides baseType::getListAttributeDescriptions() (Returns a list of attributes which have a translated description.)


+
+        
[ Top ]

+  

+  

+	
+	
method getListClassName [line 61]

+	

+    

+    

+		string getListClassName(
+)
+    

+    


+	
+		Returns the class name for the list object.




+
Tags:

+

+
+  
+    
+  
+
return:  class name

+

+


+
+	
+Overrides baseType::getListClassName() (Returns the class name for the list object.)


+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:08 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file
diff --git a/lam-web/developers/phpdoc/types/user.html b/lam-web/developers/phpdoc/types/user.html
new file mode 100644
index 00000000..3a946d1d
--- /dev/null
+++ b/lam-web/developers/phpdoc/types/user.html
@@ -0,0 +1,330 @@
+
+
+Docs For Class user
+
+
+
+
+
+  
+    
+  
+  
+  
+    
+  
+  
+
types

+  		  [ class tree: types ]
+		  [ index: types ]
+		  [ all elements ]
+    

+
+
+  
+    
+    
+  
+

+	

+					
README

+					
INSTALL

+			

+      Packages:

+              configuration

+              Help

+              LDAP

+              lib

+              lists

+              main

+              modules

+              PDF

+              profiles

+              selfService

+              tests

+              tools

+              types

+            


+                        Files:

+      	  

+					baseType.inc
+		

+					group.inc
+		

+					host.inc
+		

+					mailAlias.inc
+		

+					smbDomain.inc
+		

+					types.inc
+		

+					user.inc
+		

+	  


+      
+      
+            Classes:

+        

+		    		baseType

+	    		group

+	    		host

+	    		mailAlias

+	    		smbDomain

+	    		user

+	  

+                		
+      

+
+
Class: user

+Source Location: /lib/types/user.inc


+
+
+
+
+
+
+
+
+
+
+

+
+
Class Overview

+
baseType
+   |
+   --user


+
The account type for user accounts (e.g. Unix, Samba and Kolab).



+
+
+
+
+
+
+        
+		
+
Methods

+
+

+

+
+
+
+
+
+
+
+
+
+
+

+
Inherited Methods

+

+
Class: baseType

+

+    

+    baseType::getAlias()
+
+  

+  

+    Returns the alias name of this account type.
+  

+    

+    baseType::getDefaultListAttributes()
+
+  

+  

+    Returns the default attribute list for this account type.
+  

+    

+    baseType::getDescription()
+
+  

+  

+    Returns the description of this account type.
+  

+    

+    baseType::getListAttributeDescriptions()
+
+  

+  

+    Returns a list of attributes which have a translated description.
+  

+    

+    baseType::getListClassName()
+
+  

+  

+    Returns the class name for the list object.
+  

+  

+

+

+

+
+
+
Class Details

+

+[line 36]

+The account type for user accounts (e.g. Unix, Samba and Kolab).




+
[ Top ]


+
+
+

+
+
Class Methods

+

+
+  

+	
+	
method getAlias [line 43]

+	

+    

+    

+		string getAlias(
+)
+    

+    


+	
+		Returns the alias name of this account type.




+
Tags:

+

+
+  
+    
+  
+
return:  alias name

+

+


+
+	
+Overrides baseType::getAlias() (Returns the alias name of this account type.)


+
+        
[ Top ]

+  

+  

+	
+	
method getDefaultListAttributes [line 70]

+	

+    

+    

+		string getDefaultListAttributes(
+)
+    

+    


+	
+		Returns the default attribute list for this account type.




+
Tags:

+

+
+  
+    
+  
+
return:  attribute list

+

+


+
+	
+Overrides baseType::getDefaultListAttributes() (Returns the default attribute list for this account type.)


+
+        
[ Top ]

+  

+  

+	
+	
method getDescription [line 52]

+	

+    

+    

+		string getDescription(
+)
+    

+    


+	
+		Returns the description of this account type.




+
Tags:

+

+
+  
+    
+  
+
return:  description

+

+


+
+	
+Overrides baseType::getDescription() (Returns the description of this account type.)


+
+        
[ Top ]

+  

+  

+	
+	
method getListAttributeDescriptions [line 80]

+	

+    

+    

+		array getListAttributeDescriptions(
+)
+    

+    


+	
+		Returns a list of attributes which have a translated description.

This is used for the head row in the list view.




+
Tags:

+

+
+  
+    
+  
+
return:  list of descriptions

+

+


+
+	
+Overrides baseType::getListAttributeDescriptions() (Returns a list of attributes which have a translated description.)


+
+        
[ Top ]

+  

+  

+	
+	
method getListClassName [line 61]

+	

+    

+    

+		string getListClassName(
+)
+    

+    


+	
+		Returns the class name for the list object.




+
Tags:

+

+
+  
+    
+  
+
return:  class name

+

+


+
+	
+Overrides baseType::getListClassName() (Returns the class name for the list object.)


+
+        
[ Top ]

+  

+


+
+
+        

+		    

+		    Documentation generated on Wed, 15 Nov 2006 18:01:13 +0100 by phpDocumentor 1.2.3
+	      

+      

+    

+
+
+
\ No newline at end of file