1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
|
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>LDAP Account Manager » \nisnetgroup</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">LDAP Account Manager</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/Crypt.html"><i class="icon-folder-open"></i> Crypt</a></li>
<li><a href="../packages/Help.html"><i class="icon-folder-open"></i> Help</a></li>
<li><a href="../packages/LDAP.html"><i class="icon-folder-open"></i> LDAP</a></li>
<li><a href="../packages/Math.html"><i class="icon-folder-open"></i> Math</a></li>
<li><a href="../packages/Net.html"><i class="icon-folder-open"></i> Net</a></li>
<li><a href="../packages/PDF.html"><i class="icon-folder-open"></i> PDF</a></li>
<li><a href="../packages/PHP.html"><i class="icon-folder-open"></i> PHP</a></li>
<li><a href="../packages/configuration.html"><i class="icon-folder-open"></i> configuration</a></li>
<li><a href="../packages/horde.html"><i class="icon-folder-open"></i> horde</a></li>
<li><a href="../packages/lam.html"><i class="icon-folder-open"></i> lam</a></li>
<li><a href="../packages/lib.html"><i class="icon-folder-open"></i> lib</a></li>
<li><a href="../packages/lists.html"><i class="icon-folder-open"></i> lists</a></li>
<li><a href="../packages/main.html"><i class="icon-folder-open"></i> main</a></li>
<li><a href="../packages/metaHTML.html"><i class="icon-folder-open"></i> metaHTML</a></li>
<li><a href="../packages/modules.html"><i class="icon-folder-open"></i> modules</a></li>
<li><a href="../packages/phpLDAPadmin.html"><i class="icon-folder-open"></i> phpLDAPadmin</a></li>
<li><a href="../packages/profiles.html"><i class="icon-folder-open"></i> profiles</a></li>
<li><a href="../packages/selfService.html"><i class="icon-folder-open"></i> selfService</a></li>
<li><a href="../packages/tools.html"><i class="icon-folder-open"></i> tools</a></li>
<li><a href="../packages/types.html"><i class="icon-folder-open"></i> types</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
<span class="label label-info">1055</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
<ul><li>todo
<span class="label label-info">15</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
<span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
Javascript is disabled; several features are only available
if Javascript is enabled.
</div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public inherited"><a href="#__construct" title="__construct :: Creates a new base module class"><span class="description">Creates a new base module class</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#build_uploadAccounts" title="build_uploadAccounts :: In this function the LDAP account is built up."><span class="description">In this function the LDAP account is built up.</span><pre>build_uploadAccounts()</pre></a></li>
<li class="method public inherited"><a href="#canSelfServiceFieldBeReadOnly" title="canSelfServiceFieldBeReadOnly :: Returns if a given self service field can be set in read-only mode."><span class="description">Returns if a given self service field can be set in read-only mode.</span><pre>canSelfServiceFieldBeReadOnly()</pre></a></li>
<li class="method public inherited"><a href="#can_manage" title="can_manage :: Returns true if this module can manage accounts of the current type, otherwise false."><span class="description">Returns true if this module can manage accounts of the current type, otherwise false.</span><pre>can_manage()</pre></a></li>
<li class="method public inherited"><a href="#checkSelfServiceOptions" title="checkSelfServiceOptions :: Checks if all input values are correct and returns the LDAP attributes which should be changed."><span class="description">Checks if all input values are correct and returns the LDAP attributes which should be changed.</span><pre>checkSelfServiceOptions()</pre></a></li>
<li class="method public inherited"><a href="#checkSelfServiceSettings" title="checkSelfServiceSettings :: Checks if the self service settings are valid."><span class="description">Checks if the self service settings are valid.</span><pre>checkSelfServiceSettings()</pre></a></li>
<li class="method public inherited"><a href="#check_configOptions" title="check_configOptions :: Checks input values of module settings."><span class="description">Checks input values of module settings.</span><pre>check_configOptions()</pre></a></li>
<li class="method public inherited"><a href="#check_profileOptions" title="check_profileOptions :: Checks input values of account profiles."><span class="description">Checks input values of account profiles.</span><pre>check_profileOptions()</pre></a></li>
<li class="method public inherited"><a href="#delete_attributes" title="delete_attributes :: This function returns an array with the same syntax as save_attributes()."><span class="description">This function returns an array with the same syntax as save_attributes().</span><pre>delete_attributes()</pre></a></li>
<li class="method public inherited"><a href="#displaySpecialSelfServicePage" title="displaySpecialSelfServicePage :: This function creates meta HTML code to display the module specific page
for the self service."><span class="description">This function creates meta HTML code to display the module specific page
for the self service.</span><pre>displaySpecialSelfServicePage()</pre></a></li>
<li class="method public "><a href="#display_html_attributes" title="display_html_attributes :: Returns the HTML meta data for the main account page."><span class="description">Returns the HTML meta data for the main account page.</span><pre>display_html_attributes()</pre></a></li>
<li class="method public inherited"><a href="#display_html_delete" title="display_html_delete :: This function creates meta HTML code which will be displayed when an account should be deleted."><span class="description">This function creates meta HTML code which will be displayed when an account should be deleted.</span><pre>display_html_delete()</pre></a></li>
<li class="method public "><a href="#display_html_group" title="display_html_group :: Displays the group selection."><span class="description">Displays the group selection.</span><pre>display_html_group()</pre></a></li>
<li class="method public "><a href="#display_html_select" title="display_html_select :: Displays the host/user selection."><span class="description">Displays the host/user selection.</span><pre>display_html_select()</pre></a></li>
<li class="method public inherited"><a href="#doUploadPostActions" title="doUploadPostActions :: This function is responsible to do additional tasks after the account has been created in LDAP (e.g."><span class="description">This function is responsible to do additional tasks after the account has been created in LDAP (e.g.</span><pre>doUploadPostActions()</pre></a></li>
<li class="method public inherited"><a href="#doUploadPreActions" title="doUploadPreActions :: Runs any actions that need to be done before an LDAP entry is created."><span class="description">Runs any actions that need to be done before an LDAP entry is created.</span><pre>doUploadPreActions()</pre></a></li>
<li class="method public inherited"><a href="#getAttributes" title="getAttributes :: Returns the LDAP attributes which are managed in this module."><span class="description">Returns the LDAP attributes which are managed in this module.</span><pre>getAttributes()</pre></a></li>
<li class="method public inherited"><a href="#getButtonStatus" title="getButtonStatus :: Controls if the module button the account page is visible and activated."><span class="description">Controls if the module button the account page is visible and activated.</span><pre>getButtonStatus()</pre></a></li>
<li class="method public inherited"><a href="#getIcon" title="getIcon :: Returns the path to the module icon."><span class="description">Returns the path to the module icon.</span><pre>getIcon()</pre></a></li>
<li class="method public inherited"><a href="#getLDAPAliases" title="getLDAPAliases :: Returns a list of aliases for LDAP attributes."><span class="description">Returns a list of aliases for LDAP attributes.</span><pre>getLDAPAliases()</pre></a></li>
<li class="method public inherited"><a href="#getLinkToSpecialSelfServicePage" title="getLinkToSpecialSelfServicePage :: This allows modules to create a link to a module specific page
for the self service."><span class="description">This allows modules to create a link to a module specific page
for the self service.</span><pre>getLinkToSpecialSelfServicePage()</pre></a></li>
<li class="method public inherited"><a href="#getManagedAttributes" title="getManagedAttributes :: Returns a list of LDAP attributes which are managed by this module."><span class="description">Returns a list of LDAP attributes which are managed by this module.</span><pre>getManagedAttributes()</pre></a></li>
<li class="method public inherited"><a href="#getManagedObjectClasses" title="getManagedObjectClasses :: Returns a list of managed object classes for this module."><span class="description">Returns a list of managed object classes for this module.</span><pre>getManagedObjectClasses()</pre></a></li>
<li class="method public inherited"><a href="#getOriginalAttributes" title="getOriginalAttributes :: Returns the LDAP attributes which are managed in this module (with unchanged values)."><span class="description">Returns the LDAP attributes which are managed in this module (with unchanged values).</span><pre>getOriginalAttributes()</pre></a></li>
<li class="method public inherited"><a href="#getRequiredExtensions" title="getRequiredExtensions :: This function returns a list of PHP extensions (e.g."><span class="description">This function returns a list of PHP extensions (e.g.</span><pre>getRequiredExtensions()</pre></a></li>
<li class="method public inherited"><a href="#getSelfServiceFields" title="getSelfServiceFields :: Returns a list of possible input fields and their descriptions."><span class="description">Returns a list of possible input fields and their descriptions.</span><pre>getSelfServiceFields()</pre></a></li>
<li class="method public inherited"><a href="#getSelfServiceOptions" title="getSelfServiceOptions :: Returns the meta HTML code for each input field."><span class="description">Returns the meta HTML code for each input field.</span><pre>getSelfServiceOptions()</pre></a></li>
<li class="method public inherited"><a href="#getSelfServiceSearchAttributes" title="getSelfServiceSearchAttributes :: This function returns a list of possible LDAP attributes (e.g."><span class="description">This function returns a list of possible LDAP attributes (e.g.</span><pre>getSelfServiceSearchAttributes()</pre></a></li>
<li class="method public inherited"><a href="#getSelfServiceSettings" title="getSelfServiceSettings :: Returns a list of self service configuration settings."><span class="description">Returns a list of self service configuration settings.</span><pre>getSelfServiceSettings()</pre></a></li>
<li class="method public inherited"><a href="#get_RDNAttributes" title="get_RDNAttributes :: Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name)."><span class="description">Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name).</span><pre>get_RDNAttributes()</pre></a></li>
<li class="method public inherited"><a href="#get_alias" title="get_alias :: Returns an alias name for the module."><span class="description">Returns an alias name for the module.</span><pre>get_alias()</pre></a></li>
<li class="method public inherited"><a href="#get_configOptions" title="get_configOptions :: Returns a list of configuration options."><span class="description">Returns a list of configuration options.</span><pre>get_configOptions()</pre></a></li>
<li class="method public inherited"><a href="#get_dependencies" title="get_dependencies :: This function returns a list with all depending and conflicting modules."><span class="description">This function returns a list with all depending and conflicting modules.</span><pre>get_dependencies()</pre></a></li>
<li class="method public inherited"><a href="#get_help" title="get_help :: This function returns the help entry array for a specific help id."><span class="description">This function returns the help entry array for a specific help id.</span><pre>get_help()</pre></a></li>
<li class="method public inherited"><a href="#get_ldap_filter" title="get_ldap_filter :: Returns an LDAP filter for the account lists"><span class="description">Returns an LDAP filter for the account lists</span><pre>get_ldap_filter()</pre></a></li>
<li class="method public "><a href="#get_metaData" title="get_metaData :: Returns meta data that is interpreted by parent class"><span class="description">Returns meta data that is interpreted by parent class</span><pre>get_metaData()</pre></a></li>
<li class="method public "><a href="#get_pdfEntries" title="get_pdfEntries :: Returns a list of PDF entries"><span class="description">Returns a list of PDF entries</span><pre>get_pdfEntries()</pre></a></li>
<li class="method public inherited"><a href="#get_pdfFields" title="get_pdfFields :: Returns a hashtable with all entries that may be printed out in the PDF."><span class="description">Returns a hashtable with all entries that may be printed out in the PDF.</span><pre>get_pdfFields()</pre></a></li>
<li class="method public inherited"><a href="#get_profileOptions" title="get_profileOptions :: This function defines what attributes will be used in the account profiles and their appearance in the profile editor."><span class="description">This function defines what attributes will be used in the account profiles and their appearance in the profile editor.</span><pre>get_profileOptions()</pre></a></li>
<li class="method public inherited"><a href="#get_scope" title="get_scope :: Returns the account type of this module (user, group, host)"><span class="description">Returns the account type of this module (user, group, host)</span><pre>get_scope()</pre></a></li>
<li class="method public inherited"><a href="#get_uploadColumns" title="get_uploadColumns :: Returns an array containing all input columns for the file upload."><span class="description">Returns an array containing all input columns for the file upload.</span><pre>get_uploadColumns()</pre></a></li>
<li class="method public inherited"><a href="#get_uploadPreDepends" title="get_uploadPreDepends :: Returns a list of module names which must be processed in building the account befor this module."><span class="description">Returns a list of module names which must be processed in building the account befor this module.</span><pre>get_uploadPreDepends()</pre></a></li>
<li class="method public inherited"><a href="#handleAjaxRequest" title="handleAjaxRequest :: Manages AJAX requests."><span class="description">Manages AJAX requests.</span><pre>handleAjaxRequest()</pre></a></li>
<li class="method public inherited"><a href="#init" title="init :: Initializes the module after it became part of an {@link accountContainer}"><span class="description">Initializes the module after it became part of an {@link accountContainer}</span><pre>init()</pre></a></li>
<li class="method public inherited"><a href="#is_base_module" title="is_base_module :: Returns true if your module is a base module and otherwise false."><span class="description">Returns true if your module is a base module and otherwise false.</span><pre>is_base_module()</pre></a></li>
<li class="method public "><a href="#load_Messages" title="load_Messages :: This function fills the $messages variable with output messages from this module."><span class="description">This function fills the $messages variable with output messages from this module.</span><pre>load_Messages()</pre></a></li>
<li class="method public inherited"><a href="#load_attributes" title="load_attributes :: This function loads the LDAP attributes when an account should be loaded."><span class="description">This function loads the LDAP attributes when an account should be loaded.</span><pre>load_attributes()</pre></a></li>
<li class="method public inherited"><a href="#load_profile" title="load_profile :: This function loads the values from an account profile to the module's internal data structures."><span class="description">This function loads the values from an account profile to the module's internal data structures.</span><pre>load_profile()</pre></a></li>
<li class="method public "><a href="#module_complete" title="module_complete :: This functions is used to check if all settings for this module have been made."><span class="description">This functions is used to check if all settings for this module have been made.</span><pre>module_complete()</pre></a></li>
<li class="method public inherited"><a href="#module_ready" title="module_ready :: This function is used to check if this module page can be displayed."><span class="description">This function is used to check if this module page can be displayed.</span><pre>module_ready()</pre></a></li>
<li class="method public inherited"><a href="#postDeleteActions" title="postDeleteActions :: Allows the module to run commands after the LDAP entry is deleted."><span class="description">Allows the module to run commands after the LDAP entry is deleted.</span><pre>postDeleteActions()</pre></a></li>
<li class="method public inherited"><a href="#postModifyActions" title="postModifyActions :: Allows the module to run commands after the LDAP entry is changed or created."><span class="description">Allows the module to run commands after the LDAP entry is changed or created.</span><pre>postModifyActions()</pre></a></li>
<li class="method public inherited"><a href="#postModifySelfService" title="postModifySelfService :: Allows the module to run commands after the LDAP entry is changed or created."><span class="description">Allows the module to run commands after the LDAP entry is changed or created.</span><pre>postModifySelfService()</pre></a></li>
<li class="method public inherited"><a href="#preDeleteActions" title="preDeleteActions :: Allows the module to run commands before the LDAP entry is deleted."><span class="description">Allows the module to run commands before the LDAP entry is deleted.</span><pre>preDeleteActions()</pre></a></li>
<li class="method public inherited"><a href="#preModifyActions" title="preModifyActions :: Allows the module to run commands before the LDAP entry is changed or created."><span class="description">Allows the module to run commands before the LDAP entry is changed or created.</span><pre>preModifyActions()</pre></a></li>
<li class="method public inherited"><a href="#preModifySelfService" title="preModifySelfService :: Allows the module to run commands before the LDAP entry is changed or created."><span class="description">Allows the module to run commands before the LDAP entry is changed or created.</span><pre>preModifySelfService()</pre></a></li>
<li class="method public "><a href="#process_attributes" title="process_attributes :: Processes user input of the primary module page."><span class="description">Processes user input of the primary module page.</span><pre>process_attributes()</pre></a></li>
<li class="method public "><a href="#process_group" title="process_group :: Processes user input of the group selection page."><span class="description">Processes user input of the group selection page.</span><pre>process_group()</pre></a></li>
<li class="method public "><a href="#process_select" title="process_select :: Processes user input of the host/user selection page."><span class="description">Processes user input of the host/user selection page.</span><pre>process_select()</pre></a></li>
<li class="method public "><a href="#save_attributes" title="save_attributes :: Returns a list of modifications which have to be made to the LDAP account."><span class="description">Returns a list of modifications which have to be made to the LDAP account.</span><pre>save_attributes()</pre></a></li>
<li class="method public inherited"><a href="#supportsAdminInterface" title="supportsAdminInterface :: Specifies if this module supports the LAM admin interface."><span class="description">Specifies if this module supports the LAM admin interface.</span><pre>supportsAdminInterface()</pre></a></li>
<li class="nav-header protected">» Protected</li>
<li class="method protected inherited"><a href="#addMultiValueInputTextField" title="addMultiValueInputTextField :: Adds a text input field that may contain multiple values to the given htmlTable."><span class="description">Adds a text input field that may contain multiple values to the given htmlTable.</span><pre>addMultiValueInputTextField()</pre></a></li>
<li class="method protected inherited"><a href="#addSimpleInputTextField" title="addSimpleInputTextField :: Adds a simple text input field to the given htmlTable."><span class="description">Adds a simple text input field to the given htmlTable.</span><pre>addSimpleInputTextField()</pre></a></li>
<li class="method protected inherited"><a href="#addSimplePDFField" title="addSimplePDFField :: Adds a simple PDF entry to the given array."><span class="description">Adds a simple PDF entry to the given array.</span><pre>addSimplePDFField()</pre></a></li>
<li class="method protected inherited"><a href="#addSimpleSelfServiceTextField" title="addSimpleSelfServiceTextField :: Adds a simple text input field for the self service."><span class="description">Adds a simple text input field for the self service.</span><pre>addSimpleSelfServiceTextField()</pre></a></li>
<li class="method protected inherited"><a href="#checkSimpleSelfServiceTextField" title="checkSimpleSelfServiceTextField :: Checks the input value of a self service text field."><span class="description">Checks the input value of a self service text field.</span><pre>checkSimpleSelfServiceTextField()</pre></a></li>
<li class="method protected inherited"><a href="#getAccountContainer" title="getAccountContainer :: Returns the {@link accountContainer} object."><span class="description">Returns the {@link accountContainer} object.</span><pre>getAccountContainer()</pre></a></li>
<li class="method protected inherited"><a href="#isBooleanConfigOptionSet" title="isBooleanConfigOptionSet :: Returns if the given configuration option is set."><span class="description">Returns if the given configuration option is set.</span><pre>isBooleanConfigOptionSet()</pre></a></li>
<li class="method protected inherited"><a href="#processMultiValueInputTextField" title="processMultiValueInputTextField :: Validates a multi-value text field."><span class="description">Validates a multi-value text field.</span><pre>processMultiValueInputTextField()</pre></a></li>
<li class="nav-header private">» Private</li>
<li class="method private "><a href="#getGroupList" title="getGroupList :: Returns a list of existing NIS net groups."><span class="description">Returns a list of existing NIS net groups.</span><pre>getGroupList()</pre></a></li>
<li class="method private "><a href="#getHostList" title="getHostList :: Returns a list of existing hosts."><span class="description">Returns a list of existing hosts.</span><pre>getHostList()</pre></a></li>
<li class="method private "><a href="#getUserList" title="getUserList :: Returns a list of existing users."><span class="description">Returns a list of existing users.</span><pre>getUserList()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="nav-header protected">» Protected</li>
<li class="property protected inherited"><a href="#%24attributes" title="$attributes :: contains all ldap attributes which should be written"><span class="description">contains all ldap attributes which should be written</span><pre>$attributes</pre></a></li>
<li class="property protected inherited"><a href="#%24autoAddObjectClasses" title="$autoAddObjectClasses :: if true, managed object classes are added when an account is created or loaded (default: true)"><span class="description">if true, managed object classes are added when an account is created or loaded (default: true)</span><pre>$autoAddObjectClasses</pre></a></li>
<li class="property protected inherited"><a href="#%24messages" title="$messages :: contains all error messages of a module"><span class="description">contains all error messages of a module</span><pre>$messages</pre></a></li>
<li class="property protected inherited"><a href="#%24meta" title="$meta :: includes all meta data provided by the sub class"><span class="description">includes all meta data provided by the sub class</span><pre>$meta</pre></a></li>
<li class="property protected inherited"><a href="#%24moduleSettings" title="$moduleSettings :: configuration settings of all modules"><span class="description">configuration settings of all modules</span><pre>$moduleSettings</pre></a></li>
<li class="property protected inherited"><a href="#%24orig" title="$orig :: contains all ldap attributes which are loaded from ldap"><span class="description">contains all ldap attributes which are loaded from ldap</span><pre>$orig</pre></a></li>
<li class="property protected inherited"><a href="#%24selfServiceSettings" title="$selfServiceSettings :: self service settings of all modules"><span class="description">self service settings of all modules</span><pre>$selfServiceSettings</pre></a></li>
<li class="nav-header private">» Private</li>
<li class="property private inherited"><a href="#%24base" title="$base :: name of parent accountContainer ($_SESSION[$base])"><span class="description">name of parent accountContainer ($_SESSION[$base])</span><pre>$base</pre></a></li>
<li class="property private "><a href="#%24cachedGroupList" title="$cachedGroupList :: group cache"><span class="description">group cache</span><pre>$cachedGroupList</pre></a></li>
<li class="property private "><a href="#%24cachedHostList" title="$cachedHostList :: host cache"><span class="description">host cache</span><pre>$cachedHostList</pre></a></li>
<li class="property private "><a href="#%24cachedUserList" title="$cachedUserList :: user cache"><span class="description">user cache</span><pre>$cachedUserList</pre></a></li>
<li class="property private inherited"><a href="#%24scope" title="$scope :: the account type of this module (user, group, host)"><span class="description">the account type of this module (user, group, host)</span><pre>$scope</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5Cnisnetgroup" id="\nisnetgroup"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li><a href="../namespaces/global.html">global</a></li>
<li class="active">
<span class="divider">\</span><a href="../classes/nisnetgroup.html">nisnetgroup</a>
</li>
</ul>
<div href="../classes/nisnetgroup.html" class="element class">
<p class="short_description">Manages entries based on the object class nisNetgroup.</p>
<div class="details">
<p class="long_description"><p>It implements the complete module interface and uses meta-data
provided by the account modules for its functions.<br>
<br>
<b>Location and naming of modules</b><br>
All LAM modules are placed in lib/modules/ and are named "<class name>.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.<br>
<br>
You can avoid to override many functions by using <a href="get_metaData()">get_metaData()</a>.<br>
<br>
All module classes should extend the baseModule class.</p></p>
<table class="table table-bordered">
<tr>
<th>package</th>
<td><a href="../packages/modules.html">modules</a></td>
</tr>
<tr>
<th>author</th>
<td><a href="">Roland Gruber</a></td>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>Creates a new base module class</h2>
<pre>__construct(string $scope) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::__construct()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$scope</h4>
<code>string</code><p>the account type (user, group, host)</p>
</div>
</div></div>
</div>
<a name="build_uploadAccounts" id="build_uploadAccounts"></a><div class="element clickable method public build_uploadAccounts" data-toggle="collapse" data-target=".build_uploadAccounts .collapse">
<h2>In this function the LDAP account is built up.</h2>
<pre>build_uploadAccounts(array $rawAccounts, array $ids, array $partialAccounts, array $selectedModules) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method does not require the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
Returns an array which contains subarrays to generate StatusMessages if any errors occured.</p></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$rawAccounts</h4>
<code>array</code><p>list of hash arrays (name => value) from user input</p>
</div>
<div class="subelement argument">
<h4>$ids</h4>
<code>array</code><p>list of IDs for column position (e.g. "posixAccount_uid" => 5)</p>
</div>
<div class="subelement argument">
<h4>$partialAccounts</h4>
<code>array</code><p>list of hash arrays (name => value) which are later added to LDAP</p>
</div>
<div class="subelement argument">
<h4>$selectedModules</h4>
<code>array</code><p>list of selected account modules</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>list of error messages if any</div>
</div></div>
</div>
<a name="canSelfServiceFieldBeReadOnly" id="canSelfServiceFieldBeReadOnly"></a><div class="element clickable method public canSelfServiceFieldBeReadOnly" data-toggle="collapse" data-target=".canSelfServiceFieldBeReadOnly .collapse">
<h2>Returns if a given self service field can be set in read-only mode.</h2>
<pre>canSelfServiceFieldBeReadOnly(String $fieldID, <a href="../classes/selfServiceProfile.html">\selfServiceProfile</a> $profile) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::canSelfServiceFieldBeReadOnly()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$fieldID</h4>
<code>String</code><p>field identifier</p></div>
<div class="subelement argument">
<h4>$profile</h4>
<code><a href="../classes/selfServiceProfile.html">\selfServiceProfile</a></code><p>currently edited profile</p></div>
</div></div>
</div>
<a name="can_manage" id="can_manage"></a><div class="element clickable method public can_manage" data-toggle="collapse" data-target=".can_manage .collapse">
<h2>Returns true if this module can manage accounts of the current type, otherwise false.</h2>
<pre>can_manage() : boolean</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method does not require the existence of an enclosing <a href="accountContainer">accountContainer</a>.</p></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\global\baseModule::get_metaData()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\baseModule::can_manage()</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response">
<code>boolean</code>true if module fits</div>
</div></div>
</div>
<a name="checkSelfServiceOptions" id="checkSelfServiceOptions"></a><div class="element clickable method public checkSelfServiceOptions" data-toggle="collapse" data-target=".checkSelfServiceOptions .collapse">
<h2>Checks if all input values are correct and returns the LDAP attributes which should be changed.</h2>
<pre>checkSelfServiceOptions(string $fields, array $attributes, boolean $passwordChangeOnly, array $readOnlyFields) : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p><br>Return values:
<br>messages: array of parameters to create status messages
<br>add: array of attributes to add
<br>del: array of attributes to remove
<br>mod: array of attributes to modify
<br>info: array of values with informational value (e.g. to be used later by pre/postModify actions)</p>
<p>Calling this method does not require the existence of an enclosing <a href="accountContainer">accountContainer</a>.</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::checkSelfServiceOptions()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$fields</h4>
<code>string</code><p>input fields</p></div>
<div class="subelement argument">
<h4>$attributes</h4>
<code>array</code><p>LDAP attributes</p></div>
<div class="subelement argument">
<h4>$passwordChangeOnly</h4>
<code>boolean</code><p>indicates that the user is only allowed to change his password and no LDAP content is readable</p></div>
<div class="subelement argument">
<h4>$readOnlyFields</h4>
<code>array</code><p>list of read-only fields</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>messages and attributes (array('messages' => array(), 'add' => array('mail' => array('test@test.com')), 'del' => array(), 'mod' => array(), 'info' => array()))</div>
</div></div>
</div>
<a name="checkSelfServiceSettings" id="checkSelfServiceSettings"></a><div class="element clickable method public checkSelfServiceSettings" data-toggle="collapse" data-target=".checkSelfServiceSettings .collapse">
<h2>Checks if the self service settings are valid.</h2>
<pre>checkSelfServiceSettings(array $options, <a href="../classes/selfServiceProfile.html">\selfServiceProfile</a> $profile) : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method does not require the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
If the input data is invalid the return value is an array that contains arrays
to build StatusMessages (message type, message head, message text). If no errors
occured the function returns an empty array.</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::checkSelfServiceSettings()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$options</h4>
<code>array</code><p>hash array (option name => value) that contains the input. The option values are all arrays containing one or more elements.</p>
</div>
<div class="subelement argument">
<h4>$profile</h4>
<code><a href="../classes/selfServiceProfile.html">\selfServiceProfile</a></code><p>self service profile</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>error messages</div>
</div></div>
</div>
<a name="check_configOptions" id="check_configOptions"></a><div class="element clickable method public check_configOptions" data-toggle="collapse" data-target=".check_configOptions .collapse">
<h2>Checks input values of module settings.</h2>
<pre>check_configOptions(array $scopes, array $options) : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method does not require the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
If the input data is invalid the return value is an array that contains subarrays to build StatusMessages ('message type', 'message head', 'message text').
<br>If no errors occured the function returns an empty array.</p></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\global\baseModule::get_metaData()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\baseModule::check_configOptions()</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$scopes</h4>
<code>array</code><p>list of account types which are used</p></div>
<div class="subelement argument">
<h4>$options</h4>
<code>array</code><p>hash array (option name => value) that contains the input. The option values are all arrays containing one or more elements.</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>list of error messages</div>
</div></div>
</div>
<a name="check_profileOptions" id="check_profileOptions"></a><div class="element clickable method public check_profileOptions" data-toggle="collapse" data-target=".check_profileOptions .collapse">
<h2>Checks input values of account profiles.</h2>
<pre>check_profileOptions(array $options) : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method does not require the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
$options is an hash array (option name => value) that contains the user input.
The option values are all arrays containing one or more elements.<br>
If the input data is invalid the return value is an array that contains arrays
to build StatusMessages (message type, message head, message text). If no errors occured
the function returns an empty array.</p></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\global\baseModule::get_metaData()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\baseModule::check_profileOptions()</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$options</h4>
<code>array</code><p>a hash array (name => value) containing the user input</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>list of error messages (array(type, title, text)) to generate StatusMessages, if any</div>
</div></div>
</div>
<a name="delete_attributes" id="delete_attributes"></a><div class="element clickable method public delete_attributes" data-toggle="collapse" data-target=".delete_attributes .collapse">
<h2>This function returns an array with the same syntax as save_attributes().</h2>
<pre>delete_attributes() : \List</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method requires the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
It allows additional LDAP changes when an account is deleted.</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::delete_attributes()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>\List</code>of LDAP operations, same as for save_attributes()</div>
</div></div>
</div>
<a name="displaySpecialSelfServicePage" id="displaySpecialSelfServicePage"></a><div class="element clickable method public displaySpecialSelfServicePage" data-toggle="collapse" data-target=".displaySpecialSelfServicePage .collapse">
<h2>This function creates meta HTML code to display the module specific page
for the self service.</h2>
<pre>displaySpecialSelfServicePage(<a href="../classes/selfServiceProfile.html">\selfServiceProfile</a> $profile) : <a href="../classes/htmlElement.html">\htmlElement</a></pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\global\htmlElement</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\baseModule::displaySpecialSelfServicePage()</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$profile</h4>
<code><a href="../classes/selfServiceProfile.html">\selfServiceProfile</a></code><p>self service settings</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code><a href="../classes/htmlElement.html">\htmlElement</a></code>meta HTML object</div>
</div></div>
</div>
<a name="display_html_attributes" id="display_html_attributes"></a><div class="element clickable method public display_html_attributes" data-toggle="collapse" data-target=".display_html_attributes .collapse">
<h2>Returns the HTML meta data for the main account page.</h2>
<pre>display_html_attributes() : <a href="../classes/htmlElement.html">\htmlElement</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method requires the existence of an enclosing <a href="accountContainer">accountContainer</a>.</p></p>
<h3>Returns</h3>
<div class="subelement response">
<code><a href="../classes/htmlElement.html">\htmlElement</a></code>HTML meta data</div>
</div></div>
</div>
<a name="display_html_delete" id="display_html_delete"></a><div class="element clickable method public display_html_delete" data-toggle="collapse" data-target=".display_html_delete .collapse">
<h2>This function creates meta HTML code which will be displayed when an account should be deleted.</h2>
<pre>display_html_delete() : <a href="../classes/htmlElement.html">\htmlElement</a></pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method requires the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
This can be used to interact with the user, e.g. should the home directory be deleted? The output
of all modules is displayed on a single page.</p></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\global\htmlElement</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\baseModule::display_html_delete()</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response">
<code><a href="../classes/htmlElement.html">\htmlElement</a></code>meta HTML object</div>
</div></div>
</div>
<a name="display_html_group" id="display_html_group"></a><div class="element clickable method public display_html_group" data-toggle="collapse" data-target=".display_html_group .collapse">
<h2>Displays the group selection.</h2>
<pre>display_html_group() : <a href="../classes/htmlElement.html">\htmlElement</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code><a href="../classes/htmlElement.html">\htmlElement</a></code>meta HTML code</div>
</div></div>
</div>
<a name="display_html_select" id="display_html_select"></a><div class="element clickable method public display_html_select" data-toggle="collapse" data-target=".display_html_select .collapse">
<h2>Displays the host/user selection.</h2>
<pre>display_html_select() : <a href="../classes/htmlElement.html">\htmlElement</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code><a href="../classes/htmlElement.html">\htmlElement</a></code>meta HTML code</div>
</div></div>
</div>
<a name="doUploadPostActions" id="doUploadPostActions"></a><div class="element clickable method public doUploadPostActions" data-toggle="collapse" data-target=".doUploadPostActions .collapse">
<h2>This function is responsible to do additional tasks after the account has been created in LDAP (e.g.</h2>
<pre>doUploadPostActions(array $data, array $ids, array $failed, array $temp, array $accounts) : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>modifying group memberships, adding Quota etc..).</p>
<p>Calling this method does not require the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
This function is called as long as the returned status is 'finished'. Please make sure
that one function call lasts no longer than 3-4 seconds. Otherwise the upload may fail
because the time limit is exceeded. You should not make more than one LDAP operation in
each call.</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::doUploadPostActions()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$data</h4>
<code>array</code><p>array containing one account in each element</p></div>
<div class="subelement argument">
<h4>$ids</h4>
<code>array</code><p>maps the column names to keys for the sub arrays (array(<column_name> => <column number>))</p>
</div>
<div class="subelement argument">
<h4>$failed</h4>
<code>array</code><p>list of account numbers which could not be successfully uploaded to LDAP</p></div>
<div class="subelement argument">
<h4>$temp</h4>
<code>array</code><p>variable to store temporary data between two post actions</p></div>
<div class="subelement argument">
<h4>$accounts</h4>
<code>array</code><p>list of LDAP entries</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>current status <br> array ( <br> 'status' => 'finished' | 'inProgress' // defines if all operations are complete <br> 'progress' => 0..100 // the progress of the operations in percent <br> 'errors' => array // list of arrays which are used to generate StatusMessages <br> )</div>
</div></div>
</div>
<a name="doUploadPreActions" id="doUploadPreActions"></a><div class="element clickable method public doUploadPreActions" data-toggle="collapse" data-target=".doUploadPreActions .collapse">
<h2>Runs any actions that need to be done before an LDAP entry is created.</h2>
<pre>doUploadPreActions(array $attributes) : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::doUploadPreActions()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$attributes</h4>
<code>array</code><p>LDAP attributes of this entry (attributes are provided as reference, handle modifications of $attributes with care)</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>array which contains status messages. Each entry is an array containing the status message parameters.</div>
</div></div>
</div>
<a name="getAttributes" id="getAttributes"></a><div class="element clickable method public getAttributes" data-toggle="collapse" data-target=".getAttributes .collapse">
<h2>Returns the LDAP attributes which are managed in this module.</h2>
<pre>getAttributes() : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::getAttributes()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>attributes</div>
</div></div>
</div>
<a name="getButtonStatus" id="getButtonStatus"></a><div class="element clickable method public getButtonStatus" data-toggle="collapse" data-target=".getButtonStatus .collapse">
<h2>Controls if the module button the account page is visible and activated.</h2>
<pre>getButtonStatus() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method requires the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
<b>Possible return values:</b></p>
<ul>
<li><b>enabled:</b> button is visible and active</li>
<li><b>disabled:</b> button is visible and deactivated (greyed)</li>
<li><b>hidden:</b> no button will be shown</li>
</ul></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::getButtonStatus()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>status ("enabled", "disabled", "hidden")</div>
</div></div>
</div>
<a name="getIcon" id="getIcon"></a><div class="element clickable method public getIcon" data-toggle="collapse" data-target=".getIcon .collapse">
<h2>Returns the path to the module icon.</h2>
<pre>getIcon() : \unknown</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>The path must be releative to graphics (e.g. key.png). You can also set $this->meta['icon'].
The preferred size is 32x32px.</p></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\global\baseModule::get_metaData()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\baseModule::getIcon()</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response"><code>\unknown</code></div>
</div></div>
</div>
<a name="getLDAPAliases" id="getLDAPAliases"></a><div class="element clickable method public getLDAPAliases" data-toggle="collapse" data-target=".getLDAPAliases .collapse">
<h2>Returns a list of aliases for LDAP attributes.</h2>
<pre>getLDAPAliases() : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method does not require the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
All alias attributes will be renamed to the given attribute names.</p></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\global\baseModule::get_metaData()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\baseModule::getLDAPAliases()</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>list of aliases like array("alias name" => "attribute name")</div>
</div></div>
</div>
<a name="getLinkToSpecialSelfServicePage" id="getLinkToSpecialSelfServicePage"></a><div class="element clickable method public getLinkToSpecialSelfServicePage" data-toggle="collapse" data-target=".getLinkToSpecialSelfServicePage .collapse">
<h2>This allows modules to create a link to a module specific page
for the self service.</h2>
<pre>getLinkToSpecialSelfServicePage(array $settings) : String</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>The link is shown on the login page of the self service. You
can use this to provide e.g. a page to reset passwords.</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::getLinkToSpecialSelfServicePage()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$settings</h4>
<code>array</code><p>self service settings</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>String</code>link text (null if no special page used)</div>
</div></div>
</div>
<a name="getManagedAttributes" id="getManagedAttributes"></a><div class="element clickable method public getManagedAttributes" data-toggle="collapse" data-target=".getManagedAttributes .collapse">
<h2>Returns a list of LDAP attributes which are managed by this module.</h2>
<pre>getManagedAttributes() : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>All attribute names will be renamed to match the given spelling.</p></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\global\baseModule::get_metaData()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\baseModule::getManagedAttributes()</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>list of attributes</div>
</div></div>
</div>
<a name="getManagedObjectClasses" id="getManagedObjectClasses"></a><div class="element clickable method public getManagedObjectClasses" data-toggle="collapse" data-target=".getManagedObjectClasses .collapse">
<h2>Returns a list of managed object classes for this module.</h2>
<pre>getManagedObjectClasses() : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method does not require the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
This is used to fix spelling errors in LDAP-Entries (e.g. if "posixACCOUNT" is read instead of "posixAccount" from LDAP).<br>
<br>
<b>Example:</b> return array('posixAccount')</p></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\global\baseModule::get_metaData()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\baseModule::getManagedObjectClasses()</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>list of object classes</div>
</div></div>
</div>
<a name="getOriginalAttributes" id="getOriginalAttributes"></a><div class="element clickable method public getOriginalAttributes" data-toggle="collapse" data-target=".getOriginalAttributes .collapse">
<h2>Returns the LDAP attributes which are managed in this module (with unchanged values).</h2>
<pre>getOriginalAttributes() : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::getOriginalAttributes()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>attributes</div>
</div></div>
</div>
<a name="getRequiredExtensions" id="getRequiredExtensions"></a><div class="element clickable method public getRequiredExtensions" data-toggle="collapse" data-target=".getRequiredExtensions .collapse">
<h2>This function returns a list of PHP extensions (e.g.</h2>
<pre>getRequiredExtensions() : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>hash) which are needed by this module.</p>
<p>Calling this method does not require the existence of an enclosing <a href="accountContainer">accountContainer</a>.</p></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\global\baseModule::get_metaData()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\baseModule::getRequiredExtensions()</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>extensions</div>
</div></div>
</div>
<a name="getSelfServiceFields" id="getSelfServiceFields"></a><div class="element clickable method public getSelfServiceFields" data-toggle="collapse" data-target=".getSelfServiceFields .collapse">
<h2>Returns a list of possible input fields and their descriptions.</h2>
<pre>getSelfServiceFields() : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method does not require the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
<b>Format:</b> array(<field identifier> => <field description>)</p></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\global\baseModule::get_metaData()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\baseModule::getSelfServiceFields()</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>fields</div>
</div></div>
</div>
<a name="getSelfServiceOptions" id="getSelfServiceOptions"></a><div class="element clickable method public getSelfServiceOptions" data-toggle="collapse" data-target=".getSelfServiceOptions .collapse">
<h2>Returns the meta HTML code for each input field.</h2>
<pre>getSelfServiceOptions(array $fields, array $attributes, boolean $passwordChangeOnly, array $readOnlyFields) : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method does not require the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
It is not possible to display help links.</p></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\global\htmlElement</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\baseModule::getSelfServiceOptions()</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$fields</h4>
<code>array</code><p>list of active fields</p></div>
<div class="subelement argument">
<h4>$attributes</h4>
<code>array</code><p>attributes of LDAP account</p></div>
<div class="subelement argument">
<h4>$passwordChangeOnly</h4>
<code>boolean</code><p>indicates that the user is only allowed to change his password and no LDAP content is readable</p></div>
<div class="subelement argument">
<h4>$readOnlyFields</h4>
<code>array</code><p>list of read-only fields</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>list of meta HTML elements (field name => htmlTableRow)</div>
</div></div>
</div>
<a name="getSelfServiceSearchAttributes" id="getSelfServiceSearchAttributes"></a><div class="element clickable method public getSelfServiceSearchAttributes" data-toggle="collapse" data-target=".getSelfServiceSearchAttributes .collapse">
<h2>This function returns a list of possible LDAP attributes (e.g.</h2>
<pre>getSelfServiceSearchAttributes() : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>uid, cn, ...) which can be used to search for LDAP objects.</p>
<p>Calling this method does not require the existence of an enclosing <a href="accountContainer">accountContainer</a>.</p></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\global\baseModule::get_metaData()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\baseModule::getSelfServiceSearchAttributes()</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>attributes</div>
</div></div>
</div>
<a name="getSelfServiceSettings" id="getSelfServiceSettings"></a><div class="element clickable method public getSelfServiceSettings" data-toggle="collapse" data-target=".getSelfServiceSettings .collapse">
<h2>Returns a list of self service configuration settings.</h2>
<pre>getSelfServiceSettings(<a href="../classes/selfServiceProfile.html">\selfServiceProfile</a> $profile) : <a href="../classes/htmlElement.html">\htmlElement</a></pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method does not require the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
The name attributes are used as keywords to load
and save settings. We recommend to use the module name as prefix for them
(e.g. posixAccount_homeDirectory) to avoid naming conflicts.</p></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\global\baseModule::get_metaData()</td>
</tr>
<tr>
<th>see</th>
<td>\global\htmlElement</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\baseModule::getSelfServiceSettings()</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$profile</h4>
<code><a href="../classes/selfServiceProfile.html">\selfServiceProfile</a></code><p>currently edited profile</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code><a href="../classes/htmlElement.html">\htmlElement</a></code>meta HTML object</div>
</div></div>
</div>
<a name="get_RDNAttributes" id="get_RDNAttributes"></a><div class="element clickable method public get_RDNAttributes" data-toggle="collapse" data-target=".get_RDNAttributes .collapse">
<h2>Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name).</h2>
<pre>get_RDNAttributes() : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method does not require the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
The returned elements have this form: <attribute> => <priority>
<br> <attribute> is the name of the LDAP attribute
<br> <priority> defines the priority of the attribute (can be "low", "normal", "high")<br>
<br>
<b>Example:</b> return array('uid' => 'normal', 'cn' => 'low')</p></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\global\baseModule::get_metaData()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\baseModule::get_RDNAttributes()</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>list of attributes</div>
</div></div>
</div>
<a name="get_alias" id="get_alias"></a><div class="element clickable method public get_alias" data-toggle="collapse" data-target=".get_alias .collapse">
<h2>Returns an alias name for the module.</h2>
<pre>get_alias() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method does not require the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
This function returns a more descriptive string than the class name. Alias names are used for the buttons on the account pages and the module selection in the configuration wizard.<br>
Please take care that your alias name is not too long. It may contain any character but should not include parts that may be interpreted by the browser (e.g. '<' or '>').
If you use different aliases dependent on the account type please make sure that there is a general alias for unknown types.</p></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\global\baseModule::get_metaData()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\baseModule::get_alias()</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>alias name</div>
</div></div>
</div>
<a name="get_configOptions" id="get_configOptions"></a><div class="element clickable method public get_configOptions" data-toggle="collapse" data-target=".get_configOptions .collapse">
<h2>Returns a list of configuration options.</h2>
<pre>get_configOptions(array $scopes, array $allScopes) : mixed</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method does not require the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
The field names are used as keywords to load and save settings.
We recommend to use the module name as prefix for them (e.g. posixAccount_homeDirectory) to avoid naming conflicts.</p></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\global\baseModule::get_metaData()</td>
</tr>
<tr>
<th>see</th>
<td>\global\htmlElement</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\baseModule::get_configOptions()</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$scopes</h4>
<code>array</code><p>account types (user, group, host)</p>
</div>
<div class="subelement argument">
<h4>$allScopes</h4>
<code>array</code><p>list of all active account modules and their scopes (module => array(scopes))</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>mixed</code>htmlElement or array of htmlElement</div>
</div></div>
</div>
<a name="get_dependencies" id="get_dependencies"></a><div class="element clickable method public get_dependencies" data-toggle="collapse" data-target=".get_dependencies .collapse">
<h2>This function returns a list with all depending and conflicting modules.</h2>
<pre>get_dependencies() : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method does not require the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
The return value is an array with two sub arrays, "depends" and "conflicts".
All values of the conflict array are string values with module names. All values of the depends
array are either string values with module names or arrays which include only string values with
module names.<br>
If an element of the depends array is itself an array, this means that your module
depends on one of these modules.<br>
<br>
<b>Example:</b> return array("depends" => array("posixAccount", array("qmail", "sendmail")), "conflicts" => array("exim"))</p></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\global\baseModule::get_metaData()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\baseModule::get_dependencies()</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>list of dependencies and conflicts</div>
</div></div>
</div>
<a name="get_help" id="get_help"></a><div class="element clickable method public get_help" data-toggle="collapse" data-target=".get_help .collapse">
<h2>This function returns the help entry array for a specific help id.</h2>
<pre>get_help(string $id) : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method does not require the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
The result is an hashtable with the following keys:<br></p>
<ul>
<li><b>Headline (required)</b><br>
The headline of this help entry. Can consist of any alpha-numeric characters. No HTML/CSS elements are allowed.</li>
<li><b>Text (required)</b><br>
The text of the help entry which may contain any alpha-numeric characters.</li>
<li><b>SeeAlso (optional)</b><br>
A reference to anonther related web site. It must be an array containing a field called "text" with the link text
that should be displayed and a field called "link" which is the link target.</li>
</ul>
<p><br>
<b>Example:</b><br>
<br>
array('Headline' => 'This is the head line', 'Text' => 'Help content', 'SeeAlso' => array('text' => 'LAM homepage', 'link' => 'http://www.ldap-account-manager.org/'))</p></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\global\baseModule::get_metaData()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\baseModule::get_help()</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$id</h4>
<code>string</code><p>The id string for the help entry needed.</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>The desired help entry.</div>
</div></div>
</div>
<a name="get_ldap_filter" id="get_ldap_filter"></a><div class="element clickable method public get_ldap_filter" data-toggle="collapse" data-target=".get_ldap_filter .collapse">
<h2>Returns an LDAP filter for the account lists</h2>
<pre>get_ldap_filter() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method does not require the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
Returns an array('or' => '...', 'and' => '...') that is used to build the LDAP filter. Usually, this is used to filter object classes.
All "or" filter parts of the base modules are combined with OR and then combined with the "and" parts.<br>
The resulting LDAP filter will look like this: (&(|(OR1)(OR2)(OR3))(AND1)(AND2)(AND3))<br>
<br>
<b>Example:</b> return array('or' => '(objectClass=posixAccount)', 'and' => '(!(uid=*$))')</p></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\global\baseModule::get_metaData()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\baseModule::get_ldap_filter()</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>LDAP filter</div>
</div></div>
</div>
<a name="get_metaData" id="get_metaData"></a><div class="element clickable method public get_metaData" data-toggle="collapse" data-target=".get_metaData .collapse">
<h2>Returns meta data that is interpreted by parent class</h2>
<pre>get_metaData() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Only subclasses will return real data.<br>
<br>
The aim of the meta data is to reduce the number
of functions in the subclasses. All major data is centralized in one place.<br>
<br>
The returned array contains a list of key-value pairs for the different functions.<br></p>
<ul>
<li><b><a href="can_manage()">can_manage()</a></b><br>
<br>
<b>Key:</b> account_types<br>
<b>Value:</b> array of account types<br>
<br>
<b>Example:</b> "account_types" => array("user", "host")
<br><br>
</li>
<li><b><a href="is_base_module()">is_base_module()</a></b><br>
<br>
<b>Key:</b> is_base<br>
<b>Value:</b> boolean<br>
<br>
<b>Example:</b> "is_base" => true
<br><br>
</li>
<li><b><a href="get_ldap_filter()">get_ldap_filter()</a></b><br>
<br>
<b>Key:</b> ldap_filter<br>
<b>Value:</b> array of filters<br>
<br>
<b>Example:</b> "ldap_filter" => array('or' => 'objectClass=posixAccount', 'and' => '(!(uid=*$))')
<br><br>
</li>
<li><b><a href="getManagedObjectClasses()">getManagedObjectClasses()</a></b><br>
<br>
<b>Key:</b> objectClasses<br>
<b>Value:</b> array of object classes<br>
<br>
<b>Example:</b> "objectClasses" => array('posixAccount')
<br><br>
</li>
<li><b><a href="getLDAPAliases()">getLDAPAliases()</a></b><br>
<br>
<b>Key:</b> LDAPaliases<br>
<b>Value:</b> array of aliases<br>
<br>
<b>Example:</b> "LDAPaliases" => array('commonName' => 'cn')
<br><br>
</li>
<li><b><a href="get_RDNAttributes()">get_RDNAttributes()</a></b><br>
<br>
<b>Key:</b> RDN<br>
<b>Value:</b> array of RDNs<br>
<br>
<b>Example:</b> "RDN" => array('uid' => 'normal', 'cn' => 'low')
<br><br>
</li>
<li><b><a href="get_dependencies()">get_dependencies()</a></b><br>
<br>
<b>Key:</b> dependencies<br>
<b>Value:</b> array of dependencies<br>
<br>
<b>Example:</b> "dependencies" => array("depends" => array("posixAccount", array("qmail", "sendmail")), "conflicts" => array("exim"))
<br><br>
</li>
<li><b><a href="get_profileOptions()">get_profileOptions()</a></b><br>
<br>
<b>Key:</b> profile_options<br>
<b>Value:</b> array of profile options<br>
<br>
The syntax for the value array is the same as for the return value of get_profileOptions().
<br><br>
</li>
<li><b><a href="check_profileOptions()">check_profileOptions()</a></b><br>
<br>
<b>Key:</b> profile_checks<br>
<b>Value:</b> array of checks (array("optionName" => array()))<br>
<br>
The "optionName" keys of the value array are the names of the option identifiers.<br>
Each array element is an array itself containing these values:
<ul>
<li><b>type:</b> determines how to check input<br>
Possible values:
<ul>
<li><b>regex:</b> check with regular expression from regex variable, case sensitive</li>
<li><b>regex_i:</b> check with regular expression from regex variable, case insensitive</li>
<li><b>int_greater:</b> integer value of cmp_name1 must be greater than the integer value from the option cmp_name2</li>
<li><b>int_greaterOrEqual:</b> integer value of cmp_name1 must be greater or equal than the integer value from the option cmp_name2</li>
</ul>
</li>
<li><b>error_message:</b> message that is displayed if input value was syntactically incorrect<br>
error_message is an array to build StatusMessages (message type, message head, message text, additional variables)
<li><b>regex:</b> regular expression string (only if type is regex/regex_i)</li>
<li><b>cmp_name1:</b> name of first input variable that is used for comparison (only if type is int_greater/int_greaterOrEqual)</li>
<li><b>cmp_name2:</b> name of second input variable that is used for comparison (only if type is int_greater/int_greaterOrEqual)</li>
<li><b>required:</b> true or false, if this input field must be filled set to true (optional)
<li><b>required_message:</b> message that is displayed if no input value was given (only if required == true)<br>
required_message is an array to build StatusMessages (message type, message head, message text, additional variables)
</li>
</ul>
<br><br>
</li>
<li><b><a href="load_profile()">load_profile()</a></b><br>
<br>
<b>Key:</b> profile_mappings<br>
<b>Value:</b> array('profile_identifier1' => 'LDAP_attribute1', 'profile_identifier2' => 'LDAP_attribute2')<br>
<br>
The mapped values are stored directly in $this->attributes.
<br>
<b>Example:</b> "profile_mappings" => array('inetOrgPerson_title' => 'title')
<br><br>
</li>
<li><b><a href="get_configOptions()">get_configOptions()</a></b><br>
<br>
<b>Key:</b> config_options<br>
<b>Value:</b> array('user' => array, 'host' => array, 'all' => array)<br>
<br>
The values from 'all' are always returned, the other values only if they are inside the $scopes array.<br>
The syntax for sub arrays is the same as for the return value of <a href="get_configOptions()">get_configOptions()</a>.
<br><br>
</li>
<li><b><a href="check_configOptions()">check_configOptions()</a></b><br>
<br>
<b>Key:</b> config_checks<br>
<b>Value:</b> array('user' => array, 'host' => 'array', 'all' => array)<br>
<br>
The values from 'all' are always used for checking, the other values only if they are inside the $scopes array.
The syntax for sub arrays is the same as for <a href="check_configOptions()">check_configOptions()</a>.
<br><br>
</li>
<li><b><a href="get_uploadColumns()">get_uploadColumns()</a></b><br>
<br>
<b>Key:</b> upload_columns<br>
<b>Value:</b> array<br>
<br>
The syntax for array is the same as for the return value of <a href="get_uploadColumns()">get_uploadColumns()</a>.
<br><br>
</li>
<li><b><a href="get_uploadPreDepends()">get_uploadPreDepends()</a></b><br>
<br>
<b>Key:</b> upload_preDepends<br>
<b>Value:</b> array<br>
<br>
The syntax for array is the same as for the return value of <a href="get_uploadPreDepends()">get_uploadPreDepends()</a>.
<br><br>
</li>
<li><b><a href="getRequiredExtensions()">getRequiredExtensions()</a></b><br>
<br>
<b>Key:</b> extensions<br>
<b>Value:</b> array of extension names<br>
<br>
<b>Example:</b> "extensions" => array('hash')
<br><br>
</li>
<li><b><a href="get_help()">get_help()</a></b><br>
<br>
<b>Key:</b> help<br>
<b>Value:</b> hashtable of help entries<br>
<br>
The hashtable is an array which maps help IDs to help entries.<br>
<br>
<b>Example:</b> 'help' => array('myEntry' => array('Headline' => 'This is the head line', 'Text' => 'Help content'))
<br><br>
</li>
<li><b><a href="getSelfServiceSearchAttributes()">getSelfServiceSearchAttributes()</a></b><br>
<br>
<b>Key:</b> selfServiceSearchAttributes<br>
<b>Value:</b> array of attribute names<br>
<br>
<b>Example:</b> "selfServiceSearchAttributes" => array('uid')
<br><br>
</li>
<li><b><a href="getSelfServiceFields()">getSelfServiceFields()</a></b><br>
<br>
<b>Key:</b> selfServiceFieldSettings<br>
<b>Value:</b> array of self service fields<br>
<br>
<b>Example:</b> "selfServiceFieldSettings" => array('pwd' => 'Password')
<br><br>
</li>
</ul>
<p><b>Example:</b> return array("is_base" => true);</p></p>
<table class="table table-bordered"><tr>
<th>see</th>
<td>\global\baseModule::get_metaData()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>array with meta data</div>
</div></div>
</div>
<a name="get_pdfEntries" id="get_pdfEntries"></a><div class="element clickable method public get_pdfEntries" data-toggle="collapse" data-target=".get_pdfEntries .collapse">
<h2>Returns a list of PDF entries</h2>
<pre>get_pdfEntries() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>list of possible PDF entries</div>
</div></div>
</div>
<a name="get_pdfFields" id="get_pdfFields"></a><div class="element clickable method public get_pdfFields" data-toggle="collapse" data-target=".get_pdfFields .collapse">
<h2>Returns a hashtable with all entries that may be printed out in the PDF.</h2>
<pre>get_pdfFields() : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method does not require the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
This method must be overwritten in case that there are non static values
to be returned. The $this->meta['PDF_fields'] array may be used for static content.<br>
<br>
<b>Format of returned hashtable:</b><br>
<br>
This function uses XML formatted commands to define the PDF output. Each part in the PDF
document is surrounded by "<block>" and "</block>".<br>
Inside the <block> tags there are different ways to format the output:</p>
<ul>
<li><b>simple line with attribute name and value:</b> <block><key><b>attribute name</b></key><value><b>attribute value</b></value></block></li>
<li><b>table:</b> <block><key><b>attribute name</b></key><tr><td><b>value</b><td><td><b>value</b><td></tr></block><block><tr><td><b>value</b></td><td><b>value</b><td></tr></block></li>
</ul>
<p><b>Special commands:</b></p>
<ul>
<li><b>Alignment in <td>:</b> You can specify the alignment in <td> tags with align=(L|R|C) (e.g. <td align=\"L\">)</li>
<li><b>Cell width:</b> <td> allows an attribute "width" to set the cell width (e.g. <td width=20%> or <td width=30>).</li>
<li><b>Line breaks:</b> Line breaks can be specified by adding a <<br>> tag. The new line will start at the left border of the PDF document.</li>
</ul>
<p><br>
<b>Examples:</b><br>
<br>
<b>Simple name+value lines:</b><br><br>
In most cases you will just want to display a single line per attribute with its name and value.<br>
<br>
'myAttribute' => '<block><key>AttrName</key><value>12345</value></block>'<br>
<br>
This will give the following PDF output:<br>
<br>
<b>Attribute name:</b> 12345<br>
<br>
<br>
<b>Multiline values:</b><br><br>
Sometimes you have multivalued attributes where it is not applicable to write all values in one line but
where you want to list your values one below the other or show a table. This can be done by using the <td> tag.<br>
<br>
This example only uses one column but you can just use more <td> tags per <block> tag to display more columns.<br>
<br>
'myAttribute' => '<block><key>AttrName</key><tr><td align=\"L\">123</td></tr></block><block><tr><td align=\"L\">456</td></tr></block><block><tr><td align=\"L\">789</td></tr></block>'</p></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\global\baseModule::get_metaData()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\baseModule::get_pdfFields()</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>PDF entries</div>
</div></div>
</div>
<a name="get_profileOptions" id="get_profileOptions"></a><div class="element clickable method public get_profileOptions" data-toggle="collapse" data-target=".get_profileOptions .collapse">
<h2>This function defines what attributes will be used in the account profiles and their appearance in the profile editor.</h2>
<pre>get_profileOptions() : <a href="../classes/htmlElement.html">\htmlElement</a></pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method does not require the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
The return value is an object implementing htmlElement.<br>
The field name are used as keywords to load
and save profiles. We recommend to use the module name as prefix for them
(e.g. posixAccount_homeDirectory) to avoid naming conflicts.</p></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\global\baseModule::get_metaData()</td>
</tr>
<tr>
<th>see</th>
<td>\global\htmlElement</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\baseModule::get_profileOptions()</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response">
<code><a href="../classes/htmlElement.html">\htmlElement</a></code>meta HTML object</div>
</div></div>
</div>
<a name="get_scope" id="get_scope"></a><div class="element clickable method public get_scope" data-toggle="collapse" data-target=".get_scope .collapse">
<h2>Returns the account type of this module (user, group, host)</h2>
<pre>get_scope() : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::get_scope()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>account type</div>
</div></div>
</div>
<a name="get_uploadColumns" id="get_uploadColumns"></a><div class="element clickable method public get_uploadColumns" data-toggle="collapse" data-target=".get_uploadColumns .collapse">
<h2>Returns an array containing all input columns for the file upload.</h2>
<pre>get_uploadColumns(array $selectedModules) : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method does not require the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
This funtion returns an array which contains subarrays which represent an upload column.
<b>Syntax of column arrays:</b>
<br>
<br> array(
<br> string: name, // fixed non-translated name which is used as column name (should be of format: <module name>_<column name>)
<br> string: description, // short descriptive name
<br> string: help, // help ID
<br> string: example, // example value
<br> string: values, // possible input values (optional)
<br> string: default, // default value (optional)
<br> boolean: required // true, if user must set a value for this column
<br> boolean: unique // true if all values of this column must be different values (optional, default: "false")
<br> )</p></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\global\baseModule::get_metaData()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\baseModule::get_uploadColumns()</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$selectedModules</h4>
<code>array</code><p>list of selected account modules</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>column list</div>
</div></div>
</div>
<a name="get_uploadPreDepends" id="get_uploadPreDepends"></a><div class="element clickable method public get_uploadPreDepends" data-toggle="collapse" data-target=".get_uploadPreDepends .collapse">
<h2>Returns a list of module names which must be processed in building the account befor this module.</h2>
<pre>get_uploadPreDepends() : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method does not require the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
The named modules may not be active, LAM will check this automatically.</p></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\global\baseModule::get_metaData()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\baseModule::get_uploadPreDepends()</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>list of module names</div>
</div></div>
</div>
<a name="handleAjaxRequest" id="handleAjaxRequest"></a><div class="element clickable method public handleAjaxRequest" data-toggle="collapse" data-target=".handleAjaxRequest .collapse">
<h2>Manages AJAX requests.</h2>
<pre>handleAjaxRequest() </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>This function may be called with or without an account container.</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::handleAjaxRequest()</td>
</tr></table>
</div></div>
</div>
<a name="init" id="init"></a><div class="element clickable method public init" data-toggle="collapse" data-target=".init .collapse">
<h2>Initializes the module after it became part of an {@link accountContainer}</h2>
<pre>init(string $base) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method requires the existence of an enclosing <a href="accountContainer">accountContainer</a>.</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::init()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$base</h4>
<code>string</code><p>the name of the {@link accountContainer} object ($_SESSION[$base])</p>
</div>
</div></div>
</div>
<a name="is_base_module" id="is_base_module"></a><div class="element clickable method public is_base_module" data-toggle="collapse" data-target=".is_base_module .collapse">
<h2>Returns true if your module is a base module and otherwise false.</h2>
<pre>is_base_module() : boolean</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method does not require the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
Every account type needs exactly one base module. A base module manages a structural object class.
E.g. the inetOrgPerson module is a base module since its object class is structural.</p></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\global\baseModule::get_metaData()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\baseModule::is_base_module()</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response">
<code>boolean</code>true if base module (defaults to false if no meta data is provided)</div>
</div></div>
</div>
<a name="load_Messages" id="load_Messages"></a><div class="element clickable method public load_Messages" data-toggle="collapse" data-target=".load_Messages .collapse">
<h2>This function fills the $messages variable with output messages from this module.</h2>
<pre>load_Messages() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"><p>Calling this method requires the existence of an enclosing <a href="accountContainer">accountContainer</a>.</p></p></div></div>
</div>
<a name="load_attributes" id="load_attributes"></a><div class="element clickable method public load_attributes" data-toggle="collapse" data-target=".load_attributes .collapse">
<h2>This function loads the LDAP attributes when an account should be loaded.</h2>
<pre>load_attributes(array $attributes) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method requires the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
By default this method loads the object classes and accounts which are specified in <a href="getManagedObjectClasses()">getManagedObjectClasses()</a>
and <a href="getManagedAttributes()">getManagedAttributes()</a>.</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::load_attributes()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$attributes</h4>
<code>array</code><p>array like the array returned by get_ldap_attributes(dn of account) but without count indices</p>
</div>
</div></div>
</div>
<a name="load_profile" id="load_profile"></a><div class="element clickable method public load_profile" data-toggle="collapse" data-target=".load_profile .collapse">
<h2>This function loads the values from an account profile to the module's internal data structures.</h2>
<pre>load_profile(array $profile) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method does not require the existence of an enclosing <a href="accountContainer">accountContainer</a>.</p></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\global\baseModule::get_metaData()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\baseModule::load_profile()</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$profile</h4>
<code>array</code><p>hash array with profile values (identifier => value)</p>
</div>
</div></div>
</div>
<a name="module_complete" id="module_complete"></a><div class="element clickable method public module_complete" data-toggle="collapse" data-target=".module_complete .collapse">
<h2>This functions is used to check if all settings for this module have been made.</h2>
<pre>module_complete() : boolean</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method requires the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
This function tells LAM if it can create/modify the LDAP account. If your module needs any
additional input then set this to false. The user will be notified that your module needs
more input.<br>
This method's return value defaults to true.</p></p>
<h3>Returns</h3>
<div class="subelement response">
<code>boolean</code>true, if settings are complete</div>
</div></div>
</div>
<a name="module_ready" id="module_ready"></a><div class="element clickable method public module_ready" data-toggle="collapse" data-target=".module_ready .collapse">
<h2>This function is used to check if this module page can be displayed.</h2>
<pre>module_ready() : boolean</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method requires the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
Your module might depend on input of other modules. This function determines if the user
can change to your module page or not. The return value is true if your module accepts
input, otherwise false.<br>
This method's return value defaults to true.</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::module_ready()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>boolean</code>true, if page can be displayed</div>
</div></div>
</div>
<a name="postDeleteActions" id="postDeleteActions"></a><div class="element clickable method public postDeleteActions" data-toggle="collapse" data-target=".postDeleteActions .collapse">
<h2>Allows the module to run commands after the LDAP entry is deleted.</h2>
<pre>postDeleteActions() : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method requires the existence of an enclosing <a href="accountContainer">accountContainer</a>.</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::postDeleteActions()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>Array which contains status messages. Each entry is an array containing the status message parameters.</div>
</div></div>
</div>
<a name="postModifyActions" id="postModifyActions"></a><div class="element clickable method public postModifyActions" data-toggle="collapse" data-target=".postModifyActions .collapse">
<h2>Allows the module to run commands after the LDAP entry is changed or created.</h2>
<pre>postModifyActions(boolean $newAccount, array $attributes) : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method requires the existence of an enclosing <a href="accountContainer">accountContainer</a>.</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::postModifyActions()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$newAccount</h4>
<code>boolean</code><p>new account</p></div>
<div class="subelement argument">
<h4>$attributes</h4>
<code>array</code><p>LDAP attributes of this entry</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>array which contains status messages. Each entry is an array containing the status message parameters.</div>
</div></div>
</div>
<a name="postModifySelfService" id="postModifySelfService"></a><div class="element clickable method public postModifySelfService" data-toggle="collapse" data-target=".postModifySelfService .collapse">
<h2>Allows the module to run commands after the LDAP entry is changed or created.</h2>
<pre>postModifySelfService(array $attributes) : boolean</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::postModifySelfService()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$attributes</h4>
<code>array</code><p>LDAP attributes of this entry</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>boolean</code>true, if no problems occured</div>
</div></div>
</div>
<a name="preDeleteActions" id="preDeleteActions"></a><div class="element clickable method public preDeleteActions" data-toggle="collapse" data-target=".preDeleteActions .collapse">
<h2>Allows the module to run commands before the LDAP entry is deleted.</h2>
<pre>preDeleteActions() : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method requires the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br></p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::preDeleteActions()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>Array which contains status messages. Each entry is an array containing the status message parameters.</div>
</div></div>
</div>
<a name="preModifyActions" id="preModifyActions"></a><div class="element clickable method public preModifyActions" data-toggle="collapse" data-target=".preModifyActions .collapse">
<h2>Allows the module to run commands before the LDAP entry is changed or created.</h2>
<pre>preModifyActions(boolean $newAccount, array $attributes) : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method requires the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br>
The modification is aborted if an error message is returned.</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::preModifyActions()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$newAccount</h4>
<code>boolean</code><p>new account</p></div>
<div class="subelement argument">
<h4>$attributes</h4>
<code>array</code><p>LDAP attributes of this entry (added/modified attributes are provided as reference, handle modifications of $attributes with care)</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>array which contains status messages. Each entry is an array containing the status message parameters.</div>
</div></div>
</div>
<a name="preModifySelfService" id="preModifySelfService"></a><div class="element clickable method public preModifySelfService" data-toggle="collapse" data-target=".preModifySelfService .collapse">
<h2>Allows the module to run commands before the LDAP entry is changed or created.</h2>
<pre>preModifySelfService(array $attributes) : boolean</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>An error message should be printed if the function returns false.</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::preModifySelfService()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$attributes</h4>
<code>array</code><p>LDAP attributes of this entry</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>boolean</code>true, if no problems occured</div>
</div></div>
</div>
<a name="process_attributes" id="process_attributes"></a><div class="element clickable method public process_attributes" data-toggle="collapse" data-target=".process_attributes .collapse">
<h2>Processes user input of the primary module page.</h2>
<pre>process_attributes() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>It checks if all input values are correct and updates the associated LDAP attributes.</p></p>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>list of info/error messages</div>
</div></div>
</div>
<a name="process_group" id="process_group"></a><div class="element clickable method public process_group" data-toggle="collapse" data-target=".process_group .collapse">
<h2>Processes user input of the group selection page.</h2>
<pre>process_group() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>It checks if all input values are correct and updates the associated LDAP attributes.</p></p>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>list of info/error messages</div>
</div></div>
</div>
<a name="process_select" id="process_select"></a><div class="element clickable method public process_select" data-toggle="collapse" data-target=".process_select .collapse">
<h2>Processes user input of the host/user selection page.</h2>
<pre>process_select() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>It checks if all input values are correct and updates the associated LDAP attributes.</p></p>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>list of info/error messages</div>
</div></div>
</div>
<a name="save_attributes" id="save_attributes"></a><div class="element clickable method public save_attributes" data-toggle="collapse" data-target=".save_attributes .collapse">
<h2>Returns a list of modifications which have to be made to the LDAP account.</h2>
<pre>save_attributes() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Calling this method requires the existence of an enclosing <a href="accountContainer">accountContainer</a>.<br>
<br></p>
<p><br>This function returns an array with 3 entries:
<br>array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
<br>DN is the DN to change. It is possible to change several DNs (e.g. create a new user and add him
to some groups via attribute memberUid)<br>
<br><b>"add"</b> are attributes which have to be added to the LDAP entry
<br><b>"remove"</b> are attributes which have to be removed from the LDAP entry
<br><b>"modify"</b> are attributes which have to be modified in the LDAP entry
<br><b>"notchanged"</b> are attributes which stay unchanged
<br><b>"info"</b> values with informational value (e.g. to be used later by pre/postModify actions)
<br>
<br>This builds the required comands from $this-attributes and $this->orig.</p></p>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>list of modifications <br>This function returns an array with 3 entries: <br>array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) <br>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) <br>"add" are attributes which have to be added to LDAP entry <br>"remove" are attributes which have to be removed from LDAP entry <br>"modify" are attributes which have to been modified in LDAP entry <br>"info" are values with informational value (e.g. to be used later by pre/postModify actions)</div>
</div></div>
</div>
<a name="supportsAdminInterface" id="supportsAdminInterface"></a><div class="element clickable method public supportsAdminInterface" data-toggle="collapse" data-target=".supportsAdminInterface .collapse">
<h2>Specifies if this module supports the LAM admin interface.</h2>
<pre>supportsAdminInterface() : boolean</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>The LAM admin interface are the pages that allow to manage e.g. users and groups.
In contrast there is also the LAM self service interface. Most modules support
the admin interface.</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::supportsAdminInterface()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>boolean</code>support admin interface</div>
</div></div>
</div>
<a name="addMultiValueInputTextField" id="addMultiValueInputTextField"></a><div class="element clickable method protected addMultiValueInputTextField" data-toggle="collapse" data-target=".addMultiValueInputTextField .collapse">
<h2>Adds a text input field that may contain multiple values to the given htmlTable.</h2>
<pre>addMultiValueInputTextField(<a href="../classes/htmlTable.html">\htmlTable</a> $container, String $attrName, String $label, boolean $required, integer $length) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>The field name will be the same as the attribute name plus a counting number (e.g. street_0).
The last field will be followed by a button to add a new value. This is named add_{attribute name} (e.g. add_street).
There must be a help entry with the attribute name as ID.
A new line will also be added after this entry so multiple calls will show the fields one below the other.</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::addMultiValueInputTextField()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$container</h4>
<code><a href="../classes/htmlTable.html">\htmlTable</a></code><p>parent container</p></div>
<div class="subelement argument">
<h4>$attrName</h4>
<code>String</code><p>attribute name</p></div>
<div class="subelement argument">
<h4>$label</h4>
<code>String</code><p>label name</p></div>
<div class="subelement argument">
<h4>$required</h4>
<code>boolean</code><p>this is a required field (default false)</p>
</div>
<div class="subelement argument">
<h4>$length</h4>
<code>integer</code><p>field length</p></div>
</div></div>
</div>
<a name="addSimpleInputTextField" id="addSimpleInputTextField"></a><div class="element clickable method protected addSimpleInputTextField" data-toggle="collapse" data-target=".addSimpleInputTextField .collapse">
<h2>Adds a simple text input field to the given htmlTable.</h2>
<pre>addSimpleInputTextField(<a href="../classes/htmlTable.html">\htmlTable</a> $container, String $attrName, String $label, boolean $required, integer $length, boolean $isTextArea) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>The field name will be the same as the attribute name. There must also be a help entry with the attribute name as ID.
A new line will also be added after this entry so multiple calls will show the fields one below the other.</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::addSimpleInputTextField()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$container</h4>
<code><a href="../classes/htmlTable.html">\htmlTable</a></code><p>parent container</p></div>
<div class="subelement argument">
<h4>$attrName</h4>
<code>String</code><p>attribute name</p></div>
<div class="subelement argument">
<h4>$label</h4>
<code>String</code><p>label name</p></div>
<div class="subelement argument">
<h4>$required</h4>
<code>boolean</code><p>this is a required field (default false)</p>
</div>
<div class="subelement argument">
<h4>$length</h4>
<code>integer</code><p>field length</p></div>
<div class="subelement argument">
<h4>$isTextArea</h4>
<code>boolean</code><p>show as text area (default false)</p>
</div>
</div></div>
</div>
<a name="addSimplePDFField" id="addSimplePDFField"></a><div class="element clickable method protected addSimplePDFField" data-toggle="collapse" data-target=".addSimplePDFField .collapse">
<h2>Adds a simple PDF entry to the given array.</h2>
<pre>addSimplePDFField(array $result, String $name, String $label, String $attrName, String $delimiter) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::addSimplePDFField()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$result</h4>
<code>array</code><p>result array (entry will be added here)</p>
</div>
<div class="subelement argument">
<h4>$name</h4>
<code>String</code><p>ID</p></div>
<div class="subelement argument">
<h4>$label</h4>
<code>String</code><p>label name</p></div>
<div class="subelement argument">
<h4>$attrName</h4>
<code>String</code><p>attribute name (default: =$name)</p>
</div>
<div class="subelement argument">
<h4>$delimiter</h4>
<code>String</code><p>delimiter if multiple attribute values exist (default: ", ")</p>
</div>
</div></div>
</div>
<a name="addSimpleSelfServiceTextField" id="addSimpleSelfServiceTextField"></a><div class="element clickable method protected addSimpleSelfServiceTextField" data-toggle="collapse" data-target=".addSimpleSelfServiceTextField .collapse">
<h2>Adds a simple text input field for the self service.</h2>
<pre>addSimpleSelfServiceTextField(array $container, String $name, String $label, array $fields, array $attributes, array $readOnlyFields, boolean $required, boolean $isTextArea) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>The field name will be the same as the class name plus "_" plus attribute name (e.g. posixAccount_cn).</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::addSimpleSelfServiceTextField()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$container</h4>
<code>array</code><p>array that is used as return value for getSelfServiceOptions()</p>
</div>
<div class="subelement argument">
<h4>$name</h4>
<code>String</code><p>attribute name (== field name)</p>
</div>
<div class="subelement argument">
<h4>$label</h4>
<code>String</code><p>label to display in front of input field</p></div>
<div class="subelement argument">
<h4>$fields</h4>
<code>array</code><p>list of active fields</p></div>
<div class="subelement argument">
<h4>$attributes</h4>
<code>array</code><p>attributes of LDAP account</p></div>
<div class="subelement argument">
<h4>$readOnlyFields</h4>
<code>array</code><p>list of read-only fields</p>
</div>
<div class="subelement argument">
<h4>$required</h4>
<code>boolean</code><p>field is required</p></div>
<div class="subelement argument">
<h4>$isTextArea</h4>
<code>boolean</code><p>display as text area</p></div>
</div></div>
</div>
<a name="checkSimpleSelfServiceTextField" id="checkSimpleSelfServiceTextField"></a><div class="element clickable method protected checkSimpleSelfServiceTextField" data-toggle="collapse" data-target=".checkSimpleSelfServiceTextField .collapse">
<h2>Checks the input value of a self service text field.</h2>
<pre>checkSimpleSelfServiceTextField(array $container, String $name, array $attributes, string $fields, array $readOnlyFields, String $validationID) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>The field name must be the same as the class name plus "_" plus attribute name (e.g. posixAccount_cn).
If validation is used then there must exist a message named [{attribute name}][0] (e.g. $this->messages['street'][0]).</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::checkSimpleSelfServiceTextField()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$container</h4>
<code>array</code><p>return value of checkSelfServiceOptions()</p>
</div>
<div class="subelement argument">
<h4>$name</h4>
<code>String</code><p>attribute name</p></div>
<div class="subelement argument">
<h4>$attributes</h4>
<code>array</code><p>LDAP attributes</p></div>
<div class="subelement argument">
<h4>$fields</h4>
<code>string</code><p>input fields</p></div>
<div class="subelement argument">
<h4>$readOnlyFields</h4>
<code>array</code><p>list of read-only fields</p>
</div>
<div class="subelement argument">
<h4>$validationID</h4>
<code>String</code><p>validation ID for get_preg()</p>
</div>
</div></div>
</div>
<a name="getAccountContainer" id="getAccountContainer"></a><div class="element clickable method protected getAccountContainer" data-toggle="collapse" data-target=".getAccountContainer .collapse">
<h2>Returns the {@link accountContainer} object.</h2>
<pre>getAccountContainer() : <a href="../classes/accountContainer.html">\accountContainer</a></pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\global\accountContainer</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\baseModule::getAccountContainer()</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response">
<code><a href="../classes/accountContainer.html">\accountContainer</a></code>accountContainer object</div>
</div></div>
</div>
<a name="isBooleanConfigOptionSet" id="isBooleanConfigOptionSet"></a><div class="element clickable method protected isBooleanConfigOptionSet" data-toggle="collapse" data-target=".isBooleanConfigOptionSet .collapse">
<h2>Returns if the given configuration option is set.</h2>
<pre>isBooleanConfigOptionSet(String $optionName) : boolean</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>This function returns false if the configuration options cannot be read.</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::isBooleanConfigOptionSet()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$optionName</h4>
<code>String</code><p>name of the option</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>boolean</code>true if option is set</div>
</div></div>
</div>
<a name="processMultiValueInputTextField" id="processMultiValueInputTextField"></a><div class="element clickable method protected processMultiValueInputTextField" data-toggle="collapse" data-target=".processMultiValueInputTextField .collapse">
<h2>Validates a multi-value text field.</h2>
<pre>processMultiValueInputTextField(String $attrName, array $errors, String $validationID) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>The input fields must be created with function addMultiValueInputTextField().
If validation is used then there must exist a message named [{attribute name}][0] (e.g. $this->messages['street'][0]).</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::processMultiValueInputTextField()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$attrName</h4>
<code>String</code><p>attribute name</p></div>
<div class="subelement argument">
<h4>$errors</h4>
<code>array</code><p>errors array where to put validation errors</p></div>
<div class="subelement argument">
<h4>$validationID</h4>
<code>String</code><p>validation ID for function get_preg() (default: null, null means no validation)</p>
</div>
</div></div>
</div>
<a name="getGroupList" id="getGroupList"></a><div class="element clickable method private getGroupList" data-toggle="collapse" data-target=".getGroupList .collapse">
<h2>Returns a list of existing NIS net groups.</h2>
<pre>getGroupList() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>group names</div>
</div></div>
</div>
<a name="getHostList" id="getHostList"></a><div class="element clickable method private getHostList" data-toggle="collapse" data-target=".getHostList .collapse">
<h2>Returns a list of existing hosts.</h2>
<pre>getHostList() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>host names</div>
</div></div>
</div>
<a name="getUserList" id="getUserList"></a><div class="element clickable method private getUserList" data-toggle="collapse" data-target=".getUserList .collapse">
<h2>Returns a list of existing users.</h2>
<pre>getUserList() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>user names</div>
</div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24attributes" id="$attributes"> </a><div class="element clickable property protected $attributes" data-toggle="collapse" data-target=".$attributes .collapse">
<h2>contains all ldap attributes which should be written</h2>
<pre>$attributes </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::$$attributes</td>
</tr></table>
</div></div>
</div>
<a name="%24autoAddObjectClasses" id="$autoAddObjectClasses"> </a><div class="element clickable property protected $autoAddObjectClasses" data-toggle="collapse" data-target=".$autoAddObjectClasses .collapse">
<h2>if true, managed object classes are added when an account is created or loaded (default: true)</h2>
<pre>$autoAddObjectClasses </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::$$autoAddObjectClasses</td>
</tr></table>
</div></div>
</div>
<a name="%24messages" id="$messages"> </a><div class="element clickable property protected $messages" data-toggle="collapse" data-target=".$messages .collapse">
<h2>contains all error messages of a module</h2>
<pre>$messages </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::$$messages</td>
</tr></table>
</div></div>
</div>
<a name="%24meta" id="$meta"> </a><div class="element clickable property protected $meta" data-toggle="collapse" data-target=".$meta .collapse">
<h2>includes all meta data provided by the sub class</h2>
<pre>$meta </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::$$meta</td>
</tr></table>
</div></div>
</div>
<a name="%24moduleSettings" id="$moduleSettings"> </a><div class="element clickable property protected $moduleSettings" data-toggle="collapse" data-target=".$moduleSettings .collapse">
<h2>configuration settings of all modules</h2>
<pre>$moduleSettings </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::$$moduleSettings</td>
</tr></table>
</div></div>
</div>
<a name="%24orig" id="$orig"> </a><div class="element clickable property protected $orig" data-toggle="collapse" data-target=".$orig .collapse">
<h2>contains all ldap attributes which are loaded from ldap</h2>
<pre>$orig </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::$$orig</td>
</tr></table>
</div></div>
</div>
<a name="%24selfServiceSettings" id="$selfServiceSettings"> </a><div class="element clickable property protected $selfServiceSettings" data-toggle="collapse" data-target=".$selfServiceSettings .collapse">
<h2>self service settings of all modules</h2>
<pre>$selfServiceSettings </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::$$selfServiceSettings</td>
</tr></table>
</div></div>
</div>
<a name="%24base" id="$base"> </a><div class="element clickable property private $base" data-toggle="collapse" data-target=".$base .collapse">
<h2>name of parent accountContainer ($_SESSION[$base])</h2>
<pre>$base </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::$$base</td>
</tr></table>
</div></div>
</div>
<a name="%24cachedGroupList" id="$cachedGroupList"> </a><div class="element clickable property private $cachedGroupList" data-toggle="collapse" data-target=".$cachedGroupList .collapse">
<h2>group cache</h2>
<pre>$cachedGroupList </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24cachedHostList" id="$cachedHostList"> </a><div class="element clickable property private $cachedHostList" data-toggle="collapse" data-target=".$cachedHostList .collapse">
<h2>host cache</h2>
<pre>$cachedHostList </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24cachedUserList" id="$cachedUserList"> </a><div class="element clickable property private $cachedUserList" data-toggle="collapse" data-target=".$cachedUserList .collapse">
<h2>user cache</h2>
<pre>$cachedUserList </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24scope" id="$scope"> </a><div class="element clickable property private $scope" data-toggle="collapse" data-target=".$scope .collapse">
<h2>the account type of this module (user, group, host)</h2>
<pre>$scope </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\baseModule::$$scope</td>
</tr></table>
</div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
generated on 2013-06-17T21:08:49+02:00.<br></footer></div>
</div>
</body>
</html>
|