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
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
|
<html>
<head>
<title>Docs for page functions.php</title>
<link rel="stylesheet" type="text/css" href="../media/style.css">
</head>
<body>
<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
<tr>
<td class="header_top">phpLDAPadmin</td>
</tr>
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
<tr>
<td class="header_menu">
[ <a href="../classtrees_phpLDAPadmin.html" class="menu">class tree: phpLDAPadmin</a> ]
[ <a href="../elementindex_phpLDAPadmin.html" class="menu">index: phpLDAPadmin</a> ]
[ <a href="../elementindex.html" class="menu">all elements</a> ]
</td>
</tr>
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
</table>
<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="200" class="menu">
<div id="ric">
<p><a href="../ric_README.html">README</a></p>
</div>
<div id="todolist">
<p><a href="../todolist.html">Todo List</a></p>
</div>
<b>Packages:</b><br />
<a href="../li_main.html">main</a><br />
<a href="../li_configuration.html">configuration</a><br />
<a href="../li_Crypt_AES.html">Crypt_AES</a><br />
<a href="../li_Crypt_DES.html">Crypt_DES</a><br />
<a href="../li_Crypt_Hash.html">Crypt_Hash</a><br />
<a href="../li_Crypt_Random.html">Crypt_Random</a><br />
<a href="../li_Crypt_RC4.html">Crypt_RC4</a><br />
<a href="../li_Crypt_Rijndael.html">Crypt_Rijndael</a><br />
<a href="../li_Crypt_RSA.html">Crypt_RSA</a><br />
<a href="../li_Crypt_TerraDES.html">Crypt_TerraDES</a><br />
<a href="../li_Crypt_TripleDES.html">Crypt_TripleDES</a><br />
<a href="../li_default.html">default</a><br />
<a href="../li_Help.html">Help</a><br />
<a href="../li_horde-cipher.html">horde-cipher</a><br />
<a href="../li_lam.html">lam</a><br />
<a href="../li_LDAP.html">LDAP</a><br />
<a href="../li_lib.html">lib</a><br />
<a href="../li_lists.html">lists</a><br />
<a href="../li_Math_BigInteger.html">Math_BigInteger</a><br />
<a href="../li_metaHTML.html">metaHTML</a><br />
<a href="../li_modules.html">modules</a><br />
<a href="../li_Net_SFTP.html">Net_SFTP</a><br />
<a href="../li_Net_SSH1.html">Net_SSH1</a><br />
<a href="../li_Net_SSH2.html">Net_SSH2</a><br />
<a href="../li_PDF.html">PDF</a><br />
<a href="../li_phpLDAPadmin.html">phpLDAPadmin</a><br />
<a href="../li_PHP_Compat.html">PHP_Compat</a><br />
<a href="../li_profiles.html">profiles</a><br />
<a href="../li_selfService.html">selfService</a><br />
<a href="../li_tools.html">tools</a><br />
<a href="../li_types.html">types</a><br />
<br /><br />
<b>Files:</b><br />
<div class="package">
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---AJAXTree.php.html"> AJAXTree.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---Attribute.php.html"> Attribute.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---AttributeFactory.php.html"> AttributeFactory.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---BinaryAttribute.php.html"> BinaryAttribute.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---common.php.html"> common.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---htdocs---common.php.html"> common.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---config_default.php.html"> config_default.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---DateAttribute.php.html"> DateAttribute.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---DnAttribute.php.html"> DnAttribute.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---ds.php.html"> ds.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---ds_ldap_pla.php.html"> ds_ldap_pla.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---ds_myldap.php.html"> ds_myldap.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---export_functions.php.html"> export_functions.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---functions.php.html"> functions.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---GidAttribute.php.html"> GidAttribute.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---hooks.php.html"> hooks.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---HTMLTree.php.html"> HTMLTree.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---import_functions.php.html"> import_functions.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---index.php.html"> index.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---JpegAttribute.php.html"> JpegAttribute.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---MassRender.php.html"> MassRender.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---MultiLineAttribute.php.html"> MultiLineAttribute.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---ObjectClassAttribute.php.html"> ObjectClassAttribute.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---page.php.html"> page.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---PageRender.php.html"> PageRender.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---PasswordAttribute.php.html"> PasswordAttribute.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---Query.php.html"> Query.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---QueryRender.php.html"> QueryRender.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---query_functions.php.html"> query_functions.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---RandomPasswordAttribute.php.html"> RandomPasswordAttribute.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---SambaPasswordAttribute.php.html"> SambaPasswordAttribute.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---schema_functions.php.html"> schema_functions.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---SelectionAttribute.php.html"> SelectionAttribute.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---ShadowAttribute.php.html"> ShadowAttribute.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---syslog.php.html"> syslog.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---Template.php.html"> Template.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---TemplateRender.php.html"> TemplateRender.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---template_functions.php.html"> template_functions.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---Tree.php.html"> Tree.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---TreeItem.php.html"> TreeItem.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---Visitor.php.html"> Visitor.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---xml2array.php.html"> xml2array.php
</a><br>
<a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---xmlTemplates.php.html"> xmlTemplates.php
</a><br>
</div><br />
subpackage <b>Page</b><br> <div class="package">
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---add_attr_form.php.html"> add_attr_form.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---add_oclass_form.php.html"> add_oclass_form.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---add_value_form.php.html"> add_value_form.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---cmd.php.html"> cmd.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---compare.php.html"> compare.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---compare_form.php.html"> compare_form.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---copy.php.html"> copy.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---copy_form.php.html"> copy_form.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---create.php.html"> create.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---create_confirm.php.html"> create_confirm.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---delete.php.html"> delete.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---delete_attr.php.html"> delete_attr.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---delete_form.php.html"> delete_form.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---download_binary_attr.php.html"> download_binary_attr.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---entry_chooser.php.html"> entry_chooser.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---export.php.html"> export.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---export_form.php.html"> export_form.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---import.php.html"> import.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---import_form.php.html"> import_form.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---index.php.html"> index.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---mass_delete.php.html"> mass_delete.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---mass_edit.php.html"> mass_edit.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---mass_update.php.html"> mass_update.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---modify_member_form.php.html"> modify_member_form.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---password_checker.php.html"> password_checker.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---query_engine.php.html"> query_engine.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---rdelete.php.html"> rdelete.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---refresh.php.html"> refresh.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---rename.php.html"> rename.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---rename_form.php.html"> rename_form.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---template_engine.php.html"> template_engine.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---update.php.html"> update.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---update_confirm.php.html"> update_confirm.php
</a><br>
<a href="../phpLDAPadmin/Page/_templates---3rdParty---pla---htdocs---view_jpeg_photo.php.html"> view_jpeg_photo.php
</a><br>
</div><br />
subpackage <b>Session</b><br> <div class="package">
<a href="../phpLDAPadmin/Session/_templates---3rdParty---pla---lib---session_functions.php.html"> session_functions.php
</a><br>
</div><br />
subpackage <b>Tree</b><br> <div class="package">
<a href="../phpLDAPadmin/Tree/_templates---3rdParty---pla---htdocs---collapse.php.html"> collapse.php
</a><br>
<a href="../phpLDAPadmin/Tree/_templates---3rdParty---pla---htdocs---draw_tree_node.php.html"> draw_tree_node.php
</a><br>
<a href="../phpLDAPadmin/Tree/_templates---3rdParty---pla---htdocs---expand.php.html"> expand.php
</a><br>
</div><br />
<b>Classes:</b><br />
<div class="package">
Tree<br /> <a href="../phpLDAPadmin/Tree/AJAXTree.html">AJAXTree</a><br />
<a href="../phpLDAPadmin/Tree/Config.html">Config</a><br />
<a href="../phpLDAPadmin/Tree/HTMLTree.html">HTMLTree</a><br />
<a href="../phpLDAPadmin/Tree/Tree.html">Tree</a><br />
<a href="../phpLDAPadmin/Tree/TreeItem.html">TreeItem</a><br />
</div>
<div class="package">
Templates<br /> <a href="../phpLDAPadmin/Templates/Attribute.html">Attribute</a><br />
<a href="../phpLDAPadmin/Templates/AttributeFactory.html">AttributeFactory</a><br />
<a href="../phpLDAPadmin/Templates/BinaryAttribute.html">BinaryAttribute</a><br />
<a href="../phpLDAPadmin/Templates/DateAttribute.html">DateAttribute</a><br />
<a href="../phpLDAPadmin/Templates/DnAttribute.html">DnAttribute</a><br />
<a href="../phpLDAPadmin/Templates/GidAttribute.html">GidAttribute</a><br />
<a href="../phpLDAPadmin/Templates/JpegAttribute.html">JpegAttribute</a><br />
<a href="../phpLDAPadmin/Templates/MassRender.html">MassRender</a><br />
<a href="../phpLDAPadmin/Templates/MultiLineAttribute.html">MultiLineAttribute</a><br />
<a href="../phpLDAPadmin/Templates/ObjectClassAttribute.html">ObjectClassAttribute</a><br />
<a href="../phpLDAPadmin/Templates/PageRender.html">PageRender</a><br />
<a href="../phpLDAPadmin/Templates/PasswordAttribute.html">PasswordAttribute</a><br />
<a href="../phpLDAPadmin/Templates/QueryRender.html">QueryRender</a><br />
<a href="../phpLDAPadmin/Templates/RandomPasswordAttribute.html">RandomPasswordAttribute</a><br />
<a href="../phpLDAPadmin/Templates/SambaPasswordAttribute.html">SambaPasswordAttribute</a><br />
<a href="../phpLDAPadmin/Templates/SelectionAttribute.html">SelectionAttribute</a><br />
<a href="../phpLDAPadmin/Templates/ShadowAttribute.html">ShadowAttribute</a><br />
<a href="../phpLDAPadmin/Templates/Template.html">Template</a><br />
<a href="../phpLDAPadmin/Templates/TemplateRender.html">TemplateRender</a><br />
<a href="../phpLDAPadmin/Templates/Templates.html">Templates</a><br />
<a href="../phpLDAPadmin/Templates/Visitor.html">Visitor</a><br />
<a href="../phpLDAPadmin/Templates/xmlTemplate.html">xmlTemplate</a><br />
<a href="../phpLDAPadmin/Templates/xmlTemplates.html">xmlTemplates</a><br />
</div>
<div class="package">
DataStore<br /> <a href="../phpLDAPadmin/DataStore/Datastore.html">Datastore</a><br />
<a href="../phpLDAPadmin/DataStore/DS.html">DS</a><br />
<a href="../phpLDAPadmin/DataStore/ldap_pla.html">ldap_pla</a><br />
<a href="../phpLDAPadmin/DataStore/myldap.html">myldap</a><br />
</div>
<div class="package">
Export<br /> <a href="../phpLDAPadmin/Export/Export.html">Export</a><br />
<a href="../phpLDAPadmin/Export/ExportCSV.html">ExportCSV</a><br />
<a href="../phpLDAPadmin/Export/ExportDSML.html">ExportDSML</a><br />
<a href="../phpLDAPadmin/Export/Exporter.html">Exporter</a><br />
<a href="../phpLDAPadmin/Export/ExportLDIF.html">ExportLDIF</a><br />
<a href="../phpLDAPadmin/Export/ExportVCARD.html">ExportVCARD</a><br />
</div>
<div class="package">
Import<br /> <a href="../phpLDAPadmin/Import/Import.html">Import</a><br />
<a href="../phpLDAPadmin/Import/Importer.html">Importer</a><br />
<a href="../phpLDAPadmin/Import/ImportLDIF.html">ImportLDIF</a><br />
</div>
<div class="package">
Page<br /> <a href="../phpLDAPadmin/Page/block.html">block</a><br />
<a href="../phpLDAPadmin/Page/page.html">page</a><br />
</div>
<div class="package">
Queries<br /> <a href="../phpLDAPadmin/Queries/Queries.html">Queries</a><br />
<a href="../phpLDAPadmin/Queries/Query.html">Query</a><br />
</div>
<div class="package">
Schema<br /> <a href="../phpLDAPadmin/Schema/AttributeType.html">AttributeType</a><br />
<a href="../phpLDAPadmin/Schema/MatchingRule.html">MatchingRule</a><br />
<a href="../phpLDAPadmin/Schema/MatchingRuleUse.html">MatchingRuleUse</a><br />
<a href="../phpLDAPadmin/Schema/ObjectClass.html">ObjectClass</a><br />
<a href="../phpLDAPadmin/Schema/ObjectClass_ObjectClassAttribute.html">ObjectClass_ObjectClassAttribute</a><br />
<a href="../phpLDAPadmin/Schema/SchemaItem.html">SchemaItem</a><br />
<a href="../phpLDAPadmin/Schema/Syntax.html">Syntax</a><br />
</div>
<div class="package">
XML<br /> <a href="../phpLDAPadmin/XML/xml2array.html">xml2array</a><br />
</div>
</td>
<td>
<table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
<h1>Procedural File: functions.php</h1>
Source Location: /templates/3rdParty/pla/lib/functions.php<br /><br />
<br>
<br>
<h2>Page Details:</h2>
A collection of common generic functions used throughout the application.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b> </td><td>The phpLDAPadmin development team</td>
</tr>
</table>
</div>
<br /><br />
<br /><br />
<br /><br />
<hr />
<a name="defineCONFDIR"></a>
<h3>CONFDIR <span class="smalllinenumber">[line 18]</span></h3>
<div class="tags">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>CONFDIR = sprintf('%s/',realpath(LIBDIR.'../config'))</code>
</td></tr></table>
</td></tr></table>
<br />
</div>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
<hr />
<a name="defineDOCDIR"></a>
<h3>DOCDIR <span class="smalllinenumber">[line 21]</span></h3>
<div class="tags">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>DOCDIR = sprintf('%s/',realpath(LIBDIR.'../doc/'))</code>
</td></tr></table>
</td></tr></table>
<br />
</div>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
<hr />
<a name="defineHOOKSDIR"></a>
<h3>HOOKSDIR <span class="smalllinenumber">[line 22]</span></h3>
<div class="tags">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>HOOKSDIR = sprintf('%s/',realpath(LIBDIR.'../hooks/'))</code>
</td></tr></table>
</td></tr></table>
<br />
</div>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
<hr />
<a name="defineHTDOCDIR"></a>
<h3>HTDOCDIR <span class="smalllinenumber">[line 16]</span></h3>
<div class="tags">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>HTDOCDIR = sprintf('%s/',realpath(LIBDIR.'../htdocs/'))</code>
</td></tr></table>
</td></tr></table>
<br />
</div>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
<hr />
<a name="defineJSDIR"></a>
<h3>JSDIR <span class="smalllinenumber">[line 23]</span></h3>
<div class="tags">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>JSDIR = 'js/'</code>
</td></tr></table>
</td></tr></table>
<br />
</div>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
<hr />
<a name="defineLANGDIR"></a>
<h3>LANGDIR <span class="smalllinenumber">[line 17]</span></h3>
<div class="tags">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>LANGDIR = sprintf('%s/',realpath(LIBDIR.'../locale/'))</code>
</td></tr></table>
</td></tr></table>
<br />
</div>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
<hr />
<a name="defineQUERYDIR"></a>
<h3>QUERYDIR <span class="smalllinenumber">[line 19]</span></h3>
<div class="tags">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>QUERYDIR = sprintf('%s/',realpath(LIBDIR.'../queries/'))</code>
</td></tr></table>
</td></tr></table>
<br />
</div>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
<hr />
<a name="defineTMPLDIR"></a>
<h3>TMPLDIR <span class="smalllinenumber">[line 20]</span></h3>
<div class="tags">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>TMPLDIR = sprintf('%s/',realpath(LIBDIR.'../templates/'))</code>
</td></tr></table>
</td></tr></table>
<br />
</div>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
<br />
<hr />
<a name="functionapp_error_handler"></a>
<h3>app_error_handler <span class="smalllinenumber">[line 122]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void app_error_handler(
int $errno, string $errstr, string $file, int $lineno)</code>
</td></tr></table>
</td></tr></table><br />
Custom error handling function.<br /><br /><p>When a PHP error occurs, PHP will call this function rather than printing the typical PHP error string. This provides the application the ability to format an error message so that it looks better. Optionally, it can present a link so that a user can search/submit bugs. This function is not to be called directly. It is exclusively for the use of PHP internally. If this function is called by PHP from within a context where error handling has been disabled (ie, from within a function called with "@" prepended), then this function does nothing.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b> </td><td><a href="http://www.php.net/set_error_handler">set_error_handler</a></td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int </td>
<td><b>$errno</b> </td>
<td>The PHP error number that occurred (ie, E_ERROR, E_WARNING, E_PARSE, etc).</td>
</tr>
<tr>
<td class="type">string </td>
<td><b>$errstr</b> </td>
<td>The PHP error string provided (ie, "Warning index "foo" is undefined)</td>
</tr>
<tr>
<td class="type">string </td>
<td><b>$file</b> </td>
<td>The file in which the PHP error ocurred.</td>
</tr>
<tr>
<td class="type">int </td>
<td><b>$lineno</b> </td>
<td>The line number on which the PHP error ocurred</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionapp_name"></a>
<h3>app_name <span class="smalllinenumber">[line 167]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void app_name(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns the application name.<br /><br /> <br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionapp_version"></a>
<h3>app_version <span class="smalllinenumber">[line 177]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string app_version(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns the application version currently running. The version is read from the file named VERSION.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>The current version as read from the VERSION file.</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionarrayLower"></a>
<h3>arrayLower <span class="smalllinenumber">[line 2551]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array arrayLower(
array $array)</code>
</td></tr></table>
</td></tr></table><br />
Reads an array and returns the array values back in lower case<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>Array with values converted to lowercase.</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array </td>
<td><b>$array</b> </td>
<td>The array to convert the values to lowercase.</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionarray_stripslashes"></a>
<h3>array_stripslashes <span class="smalllinenumber">[line 74]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void array_stripslashes(
Array &$array)</code>
</td></tr></table>
</td></tr></table><br />
Strips all slashes from the specified array in place (pass by ref).<br /><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">Array </td>
<td><b>&$array</b> </td>
<td>The array to strip slashes from, typically one of $_GET, $_POST, or $_COOKIE.</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionarray_to_query_string"></a>
<h3>array_to_query_string <span class="smalllinenumber">[line 2481]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string array_to_query_string(
array $array, [array $exclude_vars = array()])</code>
</td></tr></table>
</td></tr></table><br />
Converts an array to a query-string with the option to exclude certain variables from the returned query string. This is convenient if callers want to convert the current GET query string or POST array into a string and replace certain variables with their own.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>The string created from the array.</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array </td>
<td><b>$array</b> </td>
<td>The associate array to convert whose form is such that the keys are the names of the variables and the values are said variables' values like this: <ol><li><div class="src-line"> <span class="src-key">Array </span><span class="src-sym">(</span></div></li>
<li><div class="src-line"> <span class="src-sym">[</span><span class="src-id">server_id</span><span class="src-sym">] </span>= <span class="src-num">0</span><span class="src-sym">,</span></div></li>
<li><div class="src-line"> <span class="src-sym">[</span><span class="src-id">dn</span><span class="src-sym">] </span>= <span class="src-str">"dc=example,dc=com"</span><span class="src-sym">,</span></div></li>
<li><div class="src-line"> <span class="src-sym">[</span><span class="src-id">attr</span><span class="src-sym">] </span>= <span class="src-str">"sn"</span></div></li>
<li><div class="src-line"> <span class="src-sym">)</span></div></li>
</ol> This will produce a string like this: "server_id=0&dn=dc=example,dc=com&attr=sn"</td>
</tr>
<tr>
<td class="type">array </td>
<td><b>$exclude_vars</b> </td>
<td>(optional) An array of variables to exclude in the resulting string</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionauto_lang"></a>
<h3>auto_lang <span class="smalllinenumber">[line 186]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void auto_lang(
$lang)</code>
</td></tr></table>
</td></tr></table><br />
This function will convert the browser two character language into the default 5 character language, where the country portion should NOT be assumed to be upper case characters of the first two characters.<br /><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$lang</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functiona_array_rand"></a>
<h3>a_array_rand <span class="smalllinenumber">[line 2838]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string a_array_rand(
array $input, integer $num_req)</code>
</td></tr></table>
</td></tr></table><br />
This function returns an array of $num_req values randomly picked from the $input array<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>The padded string</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array </td>
<td><b>$input</b> </td>
<td>Array of values</td>
</tr>
<tr>
<td class="type">integer </td>
<td><b>$num_req</b> </td>
<td>Number of values in returned array</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionbinSIDtoText"></a>
<h3>binSIDtoText <span class="smalllinenumber">[line 2676]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void binSIDtoText(
$binsid)</code>
</td></tr></table>
</td></tr></table><br />
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$binsid</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionblowfish_decrypt"></a>
<h3>blowfish_decrypt <span class="smalllinenumber">[line 710]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string blowfish_decrypt(
string $encdata, [string $secret = null])</code>
</td></tr></table>
</td></tr></table><br />
Decryption using blowfish algorithm<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>Original data</td>
</tr>
<tr>
<td><b>author:</b> </td><td>lem9 (taken from the phpMyAdmin source)</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$encdata</b> </td>
<td>Encrypted data</td>
</tr>
<tr>
<td class="type">string </td>
<td><b>$secret</b> </td>
<td>The secret</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionblowfish_encrypt"></a>
<h3>blowfish_encrypt <span class="smalllinenumber">[line 661]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string blowfish_encrypt(
string $data, [string $secret = null])</code>
</td></tr></table>
</td></tr></table><br />
Encryption using blowfish algorithm<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>The encrypted result</td>
</tr>
<tr>
<td><b>author:</b> </td><td>lem9 (taken from the phpMyAdmin source)</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$data</b> </td>
<td>Original data</td>
</tr>
<tr>
<td class="type">string </td>
<td><b>$secret</b> </td>
<td>The secret</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functioncheck_config"></a>
<h3>check_config <span class="smalllinenumber">[line 197]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void check_config(
$config_file)</code>
</td></tr></table>
</td></tr></table><br />
Makes sure that the config file is properly setup.<br /><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$config_file</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functioncmd_control_pane"></a>
<h3>cmd_control_pane <span class="smalllinenumber">[line 286]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array cmd_control_pane(
$type)</code>
</td></tr></table>
</td></tr></table><br />
Commands available in the control_panel of the page<br /><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$type</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functiondebug_dump"></a>
<h3>debug_dump <span class="smalllinenumber">[line 359]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void debug_dump(
string|array $variable, [boolean $die = false], [ $onlydebugaddr = false])</code>
</td></tr></table>
</td></tr></table><br />
This function dumps the $variable for debugging purposes<br /><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string|array </td>
<td><b>$variable</b> </td>
<td>Variable to dump</td>
</tr>
<tr>
<td class="type">boolean </td>
<td><b>$die</b> </td>
<td>Whether to stop execution or not.</td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$onlydebugaddr</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functiondebug_dump_backtrace"></a>
<h3>debug_dump_backtrace <span class="smalllinenumber">[line 368]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void debug_dump_backtrace(
[boolean $msg = 'Calling BackTrace'], [ $die = false])</code>
</td></tr></table>
</td></tr></table><br />
This function generates a backtrace<br /><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">boolean </td>
<td><b>$msg</b> </td>
<td>Whether to stop execution or not.</td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$die</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functiondebug_log"></a>
<h3>debug_log <span class="smalllinenumber">[line 410]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void debug_log(
string $msg, int $level, $indent)</code>
</td></tr></table>
</td></tr></table><br />
Debug Logging<br /><br /><p>The global debug level is turned on in your configuration file by setting: <ol><li><div class="src-line"> <span class="src-var">$config</span><span class="src-sym">-></span><span class="src-id">custom</span><span class="src-sym">-></span><span class="src-id">debug</span><span class="src-sym">[</span><span class="src-str">'level'</span><span class="src-sym">] </span>= <span class="src-num">255</span><span class="src-sym">;</span></div></li>
</ol> together with atleast one output direction (currently file and syslog are supported). <ol><li><div class="src-line"> <span class="src-var">$config</span><span class="src-sym">-></span><span class="src-id">custom</span><span class="src-sym">-></span><span class="src-id">debug</span><span class="src-sym">[</span><span class="src-str">'file'</span><span class="src-sym">] </span>= <span class="src-str">'/tmp/app_debug.log'</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"> <span class="src-var">$config</span><span class="src-sym">-></span><span class="src-id">custom</span><span class="src-sym">-></span><span class="src-id">debug</span><span class="src-sym">[</span><span class="src-str">'syslog'</span><span class="src-sym">] </span>= <span class="src-id">true</span><span class="src-sym">;</span></div></li>
</ol></p><p>The debug level is turned into binary, then if the message levels bit is on the message will be sent to the debug log. (Thus setting your debug level to 255, all bits on, will results in all messages being printed.)</p><p>The message level bits are defined here. 0( 1) = Entry/Return results from function calls. 1( 2) = Configuration Processing 2( 4) = Template Processing 3( 8) = Schema Processing 4( 16) = LDAP Server Communication 5( 32) = Tree Processing 7( 64) = Other non generic messages 8(128) = Page Processing 9(256) = Hooks Processing</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b> </td><td><a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---syslog.php.html">syslog.php</a></td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$msg</b> </td>
<td>Message to send to syslog</td>
</tr>
<tr>
<td class="type">int </td>
<td><b>$level</b> </td>
<td>Log bit number for this message.</td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$indent</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functiondebug_sysmsg"></a>
<h3>debug_sysmsg <span class="smalllinenumber">[line 375]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void debug_sysmsg(
$msg)</code>
</td></tr></table>
</td></tr></table><br />
Send a debug as a sys message<br /><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$msg</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functiondel_cached_item"></a>
<h3>del_cached_item <span class="smalllinenumber">[line 841]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void del_cached_item(
$index, $item, [ $subitem = 'null'])</code>
</td></tr></table>
</td></tr></table><br />
Deletes the cache for a specified $item for the specified $index<br /><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$index</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$item</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$subitem</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functiondn_escape"></a>
<h3>dn_escape <span class="smalllinenumber">[line 2367]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void dn_escape(
$dn)</code>
</td></tr></table>
</td></tr></table><br />
Parse a DN and escape any special characters<br /><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$dn</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functiondn_unescape"></a>
<h3>dn_unescape <span class="smalllinenumber">[line 2388]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void dn_unescape(
$dn)</code>
</td></tr></table>
</td></tr></table><br />
Parse a DN and unescape any special characters<br /><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$dn</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functiondraw_chooser_link"></a>
<h3>draw_chooser_link <span class="smalllinenumber">[line 2288]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void draw_chooser_link(
string $form, boolean $element, [ $include_choose_text = true], [ $rdn = 'none'])</code>
</td></tr></table>
</td></tr></table><br />
Draws an HTML browse button which, when clicked, pops up a DN chooser dialog.<br /><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$form</b> </td>
<td>The name of the form element to which this chooser dialog will publish the user's choice. The form element must be a member of a form with the "name" or "id" attribute set in the form tag, and the element must also define "name" or "id" for JavaScript to uniquely identify it. Example $form_element values may include "creation_form.container" or "edit_form.member_uid". See /templates/modification/default.php for example usage.</td>
</tr>
<tr>
<td class="type">boolean </td>
<td><b>$element</b> </td>
<td>(optional) If true, the function draws the localized text "choose" to the right of the button.</td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$include_choose_text</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$rdn</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functiondraw_formatted_dn"></a>
<h3>draw_formatted_dn <span class="smalllinenumber">[line 2568]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void draw_formatted_dn(
$server, $entry)</code>
</td></tr></table>
</td></tr></table><br />
Gets a DN string using the user-configured tree_display_format string to format it.<br /><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$server</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$entry</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functiondraw_jpeg_photo"></a>
<h3>draw_jpeg_photo <span class="smalllinenumber">[line 1930]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void draw_jpeg_photo(
object The $server, string $dn, [string $attr_name = 'jpegphoto'], int $index, [boolean $draw_delete_buttons = false], [array $options = array()])</code>
</td></tr></table>
</td></tr></table><br />
Draw the jpegPhoto image(s) for an entry wrapped in HTML. Many options are available to specify how the images are to be displayed.<br /><br /><p>Usage Examples: <ol><li><div class="src-line"> <a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---functions.php.html#functiondraw_jpeg_photo">draw_jpeg_photo</a><span class="src-sym">(</span><span class="src-num">0</span><span class="src-sym">,</span><span class="src-str">'cn=Bob,ou=People,dc=example,dc=com'</span><span class="src-sym">,</span><span class="src-str">"jpegPhoto"</span><span class="src-sym">,</span><span class="src-num">0</span><span class="src-sym">,</span><span class="src-id">true</span><span class="src-sym">,</span><span class="src-key">array</span><span class="src-sym">(</span><span class="src-str">'img_opts'</span>=><span class="src-str">"border: 1px; width: 150px"</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"> <a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---functions.php.html#functiondraw_jpeg_photo">draw_jpeg_photo</a><span class="src-sym">(</span><span class="src-num">1</span><span class="src-sym">,</span><span class="src-str">'cn=Fred,ou=People,dc=example,dc=com'</span><span class="src-sym">,</span><span class="src-id">null</span><span class="src-sym">,</span><span class="src-num">1</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></p><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">object The </td>
<td><b>$server</b> </td>
<td>Server to get the image from.</td>
</tr>
<tr>
<td class="type">string </td>
<td><b>$dn</b> </td>
<td>The DN of the entry that contains the jpeg attribute you want to draw.</td>
</tr>
<tr>
<td class="type">string </td>
<td><b>$attr_name</b> </td>
<td>The name of the attribute containing the jpeg data (usually 'jpegPhoto').</td>
</tr>
<tr>
<td class="type">int </td>
<td><b>$index</b> </td>
<td>Index of the attribute to draw</td>
</tr>
<tr>
<td class="type">boolean </td>
<td><b>$draw_delete_buttons</b> </td>
<td>If true, draws a button beneath the image titled 'Delete' allowing the user to delete the jpeg attribute by calling JavaScript function deleteAttribute() provided in the default modification template.</td>
</tr>
<tr>
<td class="type">array </td>
<td><b>$options</b> </td>
<td>Specifies optional image and CSS style attributes for the table tag. Supported keys are fixed_width, fixed_height, img_opts.</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionerror"></a>
<h3>error <span class="smalllinenumber">[line 498]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void error(
$msg, [ $type = 'note'], [ $redirect = null], [ $fatal = false], [ $backtrace = false])</code>
</td></tr></table>
</td></tr></table><br />
Display an error message in the system message panel of the page.<br /><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$msg</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$type</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$redirect</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$fatal</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$backtrace</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionexpand_dn_with_base"></a>
<h3>expand_dn_with_base <span class="smalllinenumber">[line 1676]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string|null expand_dn_with_base(
string $base, string $sub_dn)</code>
</td></tr></table>
</td></tr></table><br />
Appends a servers base to a "sub" dn or returns the base.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>Returns null if both base is null and sub_dn is null or empty</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$base</b> </td>
<td>The baseDN to be added if the DN is relative</td>
</tr>
<tr>
<td class="type">string </td>
<td><b>$sub_dn</b> </td>
<td>The DN to be made absolute</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionfull_str_pad"></a>
<h3>full_str_pad <span class="smalllinenumber">[line 764]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string full_str_pad(
string $input, integer $pad_length, [string $pad_string = ''], [integer $pad_type = 0])</code>
</td></tr></table>
</td></tr></table><br />
String padding<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>The padded string</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$input</b> </td>
<td>Input string</td>
</tr>
<tr>
<td class="type">integer </td>
<td><b>$pad_length</b> </td>
<td>Length of the result</td>
</tr>
<tr>
<td class="type">string </td>
<td><b>$pad_string</b> </td>
<td>The filling string</td>
</tr>
<tr>
<td class="type">integer </td>
<td><b>$pad_type</b> </td>
<td>Padding mode</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionget_cached_item"></a>
<h3>get_cached_item <span class="smalllinenumber">[line 799]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>Returns get_cached_item(
$index, $item, [ $subitem = 'null'])</code>
</td></tr></table>
</td></tr></table><br />
Returns the cached array of LDAP resources.<br /><br /><p>Note that internally, this function utilizes a two-layer cache, one in memory using a static variable for multiple calls within the same page load, and one in a session for multiple calls within the same user session (spanning multiple page loads).</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>the cached attributed requested, or null if there is nothing cached..</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$index</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$item</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$subitem</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionget_custom_file"></a>
<h3>get_custom_file <span class="smalllinenumber">[line 901]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string get_custom_file(
int $index, string $filename, $path)</code>
</td></tr></table>
</td></tr></table><br />
Get a customized file for a server We don't need any caching, because it's done by PHP<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>The customized filename, if exists, or the standard one</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int </td>
<td><b>$index</b> </td>
<td>The ID of the server</td>
</tr>
<tr>
<td class="type">string </td>
<td><b>$filename</b> </td>
<td>The requested filename</td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$path</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionget_enc_type"></a>
<h3>get_enc_type <span class="smalllinenumber">[line 2249]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string get_enc_type(
string $user_password)</code>
</td></tr></table>
</td></tr></table><br />
Detects password encryption type<br /><br /><p>Returns crypto string listed in braces. If it is 'crypt' password, returns crypto detected in password hash. Function should detect md5crypt, blowfish and extended DES crypt. If function fails to detect encryption type, it returns NULL.</p><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$user_password</b> </td>
<td>Hashed password</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionget_href"></a>
<h3>get_href <span class="smalllinenumber">[line 2413]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string get_href(
string $type, [ $extra_info = ''])</code>
</td></tr></table>
</td></tr></table><br />
Fetches the URL for the specified item. This is a convenience function for fetching project HREFs (like bugs)<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>The URL to the requested item.</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$type</b> </td>
<td>One of "open_bugs", "add_bug", "donate", or "add_rfe" (rfe = request for enhancement)</td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$extra_info</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionget_icon"></a>
<h3>get_icon <span class="smalllinenumber">[line 1495]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string get_icon(
string $server_id, $dn, [ $object_classes = array()])</code>
</td></tr></table>
</td></tr></table><br />
Given a DN and server ID, this function reads the DN's objectClasses and<br /><br /><p>determines which icon best represents the entry. The results of this query are cached in a session variable so it is not run every time the tree browser changes, just when exposing new DNs that were not displayed previously. That means we can afford a little bit of inefficiency here in favor of coolness. :)</p><p>This function returns a string like "country.png". All icon files are assumed to be contained in the /images/ directory of phpLDAPadmin.</p><p>Developers are encouraged to add new icons to the images directory and modify this function as needed to suit their types of LDAP entries. If the modifications are general to an LDAP audience, the phpLDAPadmin team will gladly accept them as a patch.</p><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$server_id</b> </td>
<td>The DN of the entry whose icon you wish to fetch.</td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$dn</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$object_classes</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionget_next_number"></a>
<h3>get_next_number <span class="smalllinenumber">[line 1303]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>int get_next_number(
string $base, string $attr, [boolean $increment = false], [string $filter = false], [ $startmin = null])</code>
</td></tr></table>
</td></tr></table><br />
For LDAP servers with auto_number enabled, this function will get the next available number using the host's preferred mechanism (pool or search).<br /><br /><p>This is configured in config.php by server:</p><p><ol><li><div class="src-line"> <span class="src-var">$servers</span><span class="src-sym">-></span><span class="src-id">setValue</span><span class="src-sym">(</span><span class="src-str">'auto_number'</span><span class="src-sym">,</span><span class="src-str">'enable'</span><span class="src-sym">,</span><span class="src-id">true</span>|<span class="src-id">false</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></p><p>The available mechanisms are: pool: The pool mechanism uses a user-configured entry in the LDAP server to store the last used "number". This mechanism simply fetches and increments and returns that value.</p><p>search: The search mechanism will search the LDAP server that has the attribute set. It will then find the smallest value and "fills in the gaps" by incrementing the smallest attribute until an unused value is found.</p><p>NOTE: Both mechanisms do NOT prevent race conditions or toe-stomping, so care must be taken when actually creating the entry to check that the number returned here has not been used in the mean time. Note that the two different mechanisms may (will!) return different values as they use different algorithms to arrive at their result. Do not be alarmed if (when!) this is the case.</p><p>See config.php.example for more notes on the two mechanisms.</p><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$base</b> </td>
<td>Base to start the search from</td>
</tr>
<tr>
<td class="type">string </td>
<td><b>$attr</b> </td>
<td>Attribute to query</td>
</tr>
<tr>
<td class="type">boolean </td>
<td><b>$increment</b> </td>
<td>Increment the result (for pool searches)</td>
</tr>
<tr>
<td class="type">string </td>
<td><b>$filter</b> </td>
<td>LDAP filter to use (for pool searches)</td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$startmin</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionget_rdn"></a>
<h3>get_rdn <span class="smalllinenumber">[line 1728]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string get_rdn(
string $dn, [boolean $include_attrs = 0], [ $decode = false])</code>
</td></tr></table>
</td></tr></table><br />
Given a DN string, this returns the 'RDN' portion of the string.<br /><br /><p>For example. given 'cn=Manager,dc=example,dc=com', this function returns 'cn=Manager' (it is really the exact opposite of ds_ldap::getContainer()).</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>The RDN</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$dn</b> </td>
<td>The DN whose RDN to return.</td>
</tr>
<tr>
<td class="type">boolean </td>
<td><b>$include_attrs</b> </td>
<td>If true, include attributes in the RDN string. See http://php.net/ldap_explode_dn for details</td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$decode</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionget_request"></a>
<h3>get_request <span class="smalllinenumber">[line 573]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>The get_request(
$attr, [ $type = 'POST'], [ $die = false], [ $default = null])</code>
</td></tr></table>
</td></tr></table><br />
Return the result of a form variable, with optional default<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>form GET/REQUEST/SESSION/POST variable value or its default</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$attr</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$type</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$die</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$default</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionhtmlid"></a>
<h3>htmlid <span class="smalllinenumber">[line 2886]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string htmlid(
string $sid, $dn)</code>
</td></tr></table>
</td></tr></table><br />
Returns a HTML id that can be used in the URL after the #.<br /><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$sid</b> </td>
<td>The DN to pretty-print.</td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$dn</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionisAjaxEnabled"></a>
<h3>isAjaxEnabled <span class="smalllinenumber">[line 2893]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void isAjaxEnabled(
)</code>
</td></tr></table>
</td></tr></table><br />
Is PLA configured for AJAX display<br /><br /> <br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionisCompress"></a>
<h3>isCompress <span class="smalllinenumber">[line 1017]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void isCompress(
)</code>
</td></tr></table>
</td></tr></table><br />
Is compression enabled for output<br /><br /> <br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionis_dn_string"></a>
<h3>is_dn_string <span class="smalllinenumber">[line 1106]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>boolean is_dn_string(
string $str)</code>
</td></tr></table>
</td></tr></table><br />
Given a string, this function returns true if the string has the format of a DN (ie, looks like "cn=Foo,dc=example,dc=com"). Returns false otherwise.<br /><br /><p>The purpose of this function is so that developers can examine a string and know if it looks like a DN, and draw a hyperlink as needed.</p><p>(See unit_test.php for test cases)</p><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$str</b> </td>
<td>The attribute to examine for "DNness"</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionis_mail_string"></a>
<h3>is_mail_string <span class="smalllinenumber">[line 1143]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>boolean is_mail_string(
string $str)</code>
</td></tr></table>
</td></tr></table><br />
Get whether a string looks like an email address (user@example.com).<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>Returns true if the specified string looks like an email address or false otherwise.</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$str</b> </td>
<td>The string to analyze.</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionis_url_string"></a>
<h3>is_url_string <span class="smalllinenumber">[line 1161]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>boolean is_url_string(
string $str)</code>
</td></tr></table>
</td></tr></table><br />
Get whether a string looks like a web URL (http://www.example.com/)<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>Returns true if the specified string looks like a web URL or false otherwise.</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$str</b> </td>
<td>The string to analyze.</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionldap_error_msg"></a>
<h3>ldap_error_msg <span class="smalllinenumber">[line 1885]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void ldap_error_msg(
$msg, $errnum)</code>
</td></tr></table>
</td></tr></table><br />
Print an LDAP error message<br /><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$msg</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$errnum</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionlittleEndian"></a>
<h3>littleEndian <span class="smalllinenumber">[line 2664]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void littleEndian(
$hex)</code>
</td></tr></table>
</td></tr></table><br />
Converts a little-endian hex-number to one, that 'hexdec' can convert<br /><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$hex</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionmasort"></a>
<h3>masort <span class="smalllinenumber">[line 927]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array masort(
array &$data, string $sortby, [boolean $rev = 0])</code>
</td></tr></table>
</td></tr></table><br />
Sort a multi dimensional array.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>Sorted multi demension array.</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array </td>
<td><b>&$data</b> </td>
<td>Multi demension array passed by reference</td>
</tr>
<tr>
<td class="type">string </td>
<td><b>$sortby</b> </td>
<td>Comma delimited string of sort keys.</td>
</tr>
<tr>
<td class="type">boolean </td>
<td><b>$rev</b> </td>
<td>Whether to reverse sort.</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionobfuscate_password_display"></a>
<h3>obfuscate_password_display <span class="smalllinenumber">[line 1044]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>boolean obfuscate_password_display(
[string $enc = null])</code>
</td></tr></table>
</td></tr></table><br />
Fetches whether the user has configured phpLDAPadmin to obfuscate passwords with "*********" when displaying them.<br /><br /><p>This is configured in config.php thus: <ol><li><div class="src-line"> <span class="src-var">$config</span><span class="src-sym">-></span><span class="src-id">custom</span><span class="src-sym">-></span><span class="src-id">appearance</span><span class="src-sym">[</span><span class="src-str">'obfuscate_password_display'</span><span class="src-sym">] </span>= <span class="src-id">true</span><span class="src-sym">;</span></div></li>
</ol></p><p>Or if it is OK to show encrypted passwords but not clear text passwords <ol><li><div class="src-line"> <span class="src-var">$config</span><span class="src-sym">-></span><span class="src-id">custom</span><span class="src-sym">-></span><span class="src-id">appearance</span><span class="src-sym">[</span><span class="src-str">'show_clear_password'</span><span class="src-sym">] </span>= <span class="src-id">false</span><span class="src-sym">;</span></div></li>
</ol></p><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$enc</b> </td>
<td>Password encoding type</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionpassword_check"></a>
<h3>password_check <span class="smalllinenumber">[line 2095]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>Boolean password_check(
String $cryptedpassword, String $plainpassword, [ $attribute = 'userpassword'])</code>
</td></tr></table>
</td></tr></table><br />
Given a clear-text password and a hash, this function determines if the clear-text password is the password that was used to generate the hash. This is handy to verify a user's password when all that is given is the hash and a "guess".<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>True if the clear password matches the hash, and false otherwise.</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">String </td>
<td><b>$cryptedpassword</b> </td>
<td>The hash.</td>
</tr>
<tr>
<td class="type">String </td>
<td><b>$plainpassword</b> </td>
<td>The password in clear text to test.</td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$attribute</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionpassword_generate"></a>
<h3>password_generate <span class="smalllinenumber">[line 2756]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void password_generate(
)</code>
</td></tr></table>
</td></tr></table><br />
This function returns a string automatically generated<br /><br /><p>based on the criteria defined in the array $criteria in config.php</p><br /> <br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionpassword_hash"></a>
<h3>password_hash <span class="smalllinenumber">[line 2044]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string password_hash(
string $password_clear, string $enc_type)</code>
</td></tr></table>
</td></tr></table><br />
Hashes a password and returns the hash based on the specified enc_type.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>The hashed password.</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$password_clear</b> </td>
<td>The password to hash in clear text.</td>
</tr>
<tr>
<td class="type">string </td>
<td><b>$enc_type</b> </td>
<td>Standard LDAP encryption type which must be one of crypt, ext_des, md5crypt, blowfish, md5, sha, smd5, ssha, or clear.</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionpassword_types"></a>
<h3>password_types <span class="smalllinenumber">[line 2022]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void password_types(
)</code>
</td></tr></table>
</td></tr></table><br />
Return the list of available password types<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>todo:</b> </td><td>Dynamically work this list out so we only present hashes that we can encrypt</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionpla_compare_dns"></a>
<h3>pla_compare_dns <span class="smalllinenumber">[line 1204]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>int pla_compare_dns(
string $dn1, string $dn2)</code>
</td></tr></table>
</td></tr></table><br />
Compares 2 DNs. If they are equivelant, returns 0, otherwise, returns their sorting order (similar to strcmp()): Returns < 0 if dn1 is less than dn2.<br /><br /><p>Returns > 0 if dn1 is greater than dn2.</p><p>The comparison is performed starting with the top-most element of the DN. Thus, the following list: <ol><li><div class="src-line"> <span class="src-id">ou</span>=<span class="src-id">people</span><span class="src-sym">,</span><span class="src-id">dc</span>=<span class="src-id">example</span><span class="src-sym">,</span><span class="src-id">dc</span>=<span class="src-id">com</span></div></li>
<li><div class="src-line"> <span class="src-id">cn</span>=<span class="src-id">Admin</span><span class="src-sym">,</span><span class="src-id">ou</span>=<span class="src-id">People</span><span class="src-sym">,</span><span class="src-id">dc</span>=<span class="src-id">example</span><span class="src-sym">,</span><span class="src-id">dc</span>=<span class="src-id">com</span></div></li>
<li><div class="src-line"> <span class="src-id">cn</span>=<span class="src-id">Joe</span><span class="src-sym">,</span><span class="src-id">ou</span>=<span class="src-id">people</span><span class="src-sym">,</span><span class="src-id">dc</span>=<span class="src-id">example</span><span class="src-sym">,</span><span class="src-id">dc</span>=<span class="src-id">com</span></div></li>
<li><div class="src-line"> <span class="src-id">dc</span>=<span class="src-id">example</span><span class="src-sym">,</span><span class="src-id">dc</span>=<span class="src-id">com</span></div></li>
<li><div class="src-line"> <span class="src-id">cn</span>=<span class="src-id">Fred</span><span class="src-sym">,</span><span class="src-id">ou</span>=<span class="src-id">people</span><span class="src-sym">,</span><span class="src-id">dc</span>=<span class="src-id">example</span><span class="src-sym">,</span><span class="src-id">dc</span>=<span class="src-id">org</span></div></li>
<li><div class="src-line"> <span class="src-id">cn</span>=<span class="src-id">Dave</span><span class="src-sym">,</span><span class="src-id">ou</span>=<span class="src-id">people</span><span class="src-sym">,</span><span class="src-id">dc</span>=<span class="src-id">example</span><span class="src-sym">,</span><span class="src-id">dc</span>=<span class="src-id">org</span></div></li>
</ol> Will be sorted thus using usort( $list, "pla_compare_dns" ): <ol><li><div class="src-line"> <span class="src-id">dc</span>=<span class="src-id">com</span></div></li>
<li><div class="src-line"> <span class="src-id">dc</span>=<span class="src-id">example</span><span class="src-sym">,</span><span class="src-id">dc</span>=<span class="src-id">com</span></div></li>
<li><div class="src-line"> <span class="src-id">ou</span>=<span class="src-id">people</span><span class="src-sym">,</span><span class="src-id">dc</span>=<span class="src-id">example</span><span class="src-sym">,</span><span class="src-id">dc</span>=<span class="src-id">com</span></div></li>
<li><div class="src-line"> <span class="src-id">cn</span>=<span class="src-id">Admin</span><span class="src-sym">,</span><span class="src-id">ou</span>=<span class="src-id">People</span><span class="src-sym">,</span><span class="src-id">dc</span>=<span class="src-id">example</span><span class="src-sym">,</span><span class="src-id">dc</span>=<span class="src-id">com</span></div></li>
<li><div class="src-line"> <span class="src-id">cn</span>=<span class="src-id">Joe</span><span class="src-sym">,</span><span class="src-id">ou</span>=<span class="src-id">people</span><span class="src-sym">,</span><span class="src-id">dc</span>=<span class="src-id">example</span><span class="src-sym">,</span><span class="src-id">dc</span>=<span class="src-id">com</span></div></li>
<li><div class="src-line"> <span class="src-id">cn</span>=<span class="src-id">Dave</span><span class="src-sym">,</span><span class="src-id">ou</span>=<span class="src-id">people</span><span class="src-sym">,</span><span class="src-id">dc</span>=<span class="src-id">example</span><span class="src-sym">,</span><span class="src-id">dc</span>=<span class="src-id">org</span></div></li>
<li><div class="src-line"> <span class="src-id">cn</span>=<span class="src-id">Fred</span><span class="src-sym">,</span><span class="src-id">ou</span>=<span class="src-id">people</span><span class="src-sym">,</span><span class="src-id">dc</span>=<span class="src-id">example</span><span class="src-sym">,</span><span class="src-id">dc</span>=<span class="src-id">org</span></div></li>
</ol></p><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$dn1</b> </td>
<td>The first of two DNs to compare</td>
</tr>
<tr>
<td class="type">string </td>
<td><b>$dn2</b> </td>
<td>The second of two DNs to compare</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionpla_explode_dn"></a>
<h3>pla_explode_dn <span class="smalllinenumber">[line 2319]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array pla_explode_dn(
string $dn, [int $with_attributes = 0])</code>
</td></tr></table>
</td></tr></table><br />
Explode a DN into an array of its RDN parts.<br /><br /><p>NOTE: When a multivalue RDN is passed to ldap_explode_dn, the results returns with 'value + value';</p><p><ol><li><div class="src-line"> <span class="src-key">Array </span><span class="src-sym">(</span></div></li>
<li><div class="src-line"> <span class="src-sym">[</span><span class="src-num">0</span><span class="src-sym">] </span>=> <span class="src-id">uid</span>=<span class="src-id">ppratt</span></div></li>
<li><div class="src-line"> <span class="src-sym">[</span><span class="src-num">1</span><span class="src-sym">] </span>=> <span class="src-id">ou</span>=<span class="src-id">People</span></div></li>
<li><div class="src-line"> <span class="src-sym">[</span><span class="src-num">2</span><span class="src-sym">] </span>=> <span class="src-id">dc</span>=<span class="src-id">example</span></div></li>
<li><div class="src-line"> <span class="src-sym">[</span><span class="src-num">3</span><span class="src-sym">] </span>=> <span class="src-id">dc</span>=<span class="src-id">com</span></div></li>
<li><div class="src-line"> <span class="src-sym">)</span></div></li>
</ol></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>An array of RDN parts of this format:</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$dn</b> </td>
<td>The DN to explode.</td>
</tr>
<tr>
<td class="type">int </td>
<td><b>$with_attributes</b> </td>
<td>(optional) Whether to include attribute names (see http://php.net/ldap_explode_dn for details)</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionpla_reverse_dn"></a>
<h3>pla_reverse_dn <span class="smalllinenumber">[line 2528]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string pla_reverse_dn(
string $dn)</code>
</td></tr></table>
</td></tr></table><br />
Reverses a DN such that the top-level RDN is first and the bottom-level RDN is last<br /><br /><p>For example: <ol><li><div class="src-line"> <span class="src-id">cn</span>=<span class="src-id">Brigham</span><span class="src-sym">,</span><span class="src-id">ou</span>=<span class="src-id">People</span><span class="src-sym">,</span><span class="src-id">dc</span>=<span class="src-id">example</span><span class="src-sym">,</span><span class="src-id">dc</span>=<span class="src-id">com</span></div></li>
</ol> Becomes: <ol><li><div class="src-line"> <span class="src-id">dc</span>=<span class="src-id">com</span><span class="src-sym">,</span><span class="src-id">dc</span>=<span class="src-id">example</span><span class="src-sym">,</span><span class="src-id">ou</span>=<span class="src-id">People</span><span class="src-sym">,</span><span class="src-id">cn</span>=<span class="src-id">Brigham</span></div></li>
</ol> This makes it possible to sort lists of DNs such that they are grouped by container.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>The reversed DN</td>
</tr>
<tr>
<td><b>see:</b> </td><td>pla_explode_dns</td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../phpLDAPadmin/_templates---3rdParty---pla---lib---functions.php.html#functionpla_compare_dns">pla_compare_dns()</a></td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$dn</b> </td>
<td>The DN to reverse</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionpla_verbose_error"></a>
<h3>pla_verbose_error <span class="smalllinenumber">[line 1786]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array pla_verbose_error(
string $key)</code>
</td></tr></table>
</td></tr></table><br />
Given an LDAP error number, returns a verbose description of the error.<br /><br /><p>This function parses ldap_error_codes.txt and looks up the specified ldap error number, and returns the verbose message defined in that file.</p><p><ol><li><div class="src-line"> <span class="src-key">Array </span><span class="src-sym">(</span></div></li>
<li><div class="src-line"> <span class="src-sym">[</span><span class="src-id">title</span><span class="src-sym">] </span>=> <span class="src-str">"Invalid Credentials"</span></div></li>
<li><div class="src-line"> <span class="src-sym">[</span><span class="src-id">description</span><span class="src-sym">] </span>=> <span class="src-str">"An invalid username and/or password was supplied to the LDAP server."</span></div></li>
<li><div class="src-line"> <span class="src-sym">)</span></div></li>
</ol></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>An associative array contianing the error title and description like so:</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$key</b> </td>
<td>The hex error number (ie, "0x42") of the LDAP error of interest.</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionpretty_print_dn"></a>
<h3>pretty_print_dn <span class="smalllinenumber">[line 1073]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string pretty_print_dn(
string $dn)</code>
</td></tr></table>
</td></tr></table><br />
Returns an HTML-beautified version of a DN.<br /><br /><p>Internally, this function makes use of pla_explode_dn() to break the the DN into its components. It then glues them back together with "pretty" HTML. The returned HTML is NOT to be used as a real DN, but simply displayed.</p><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$dn</b> </td>
<td>The DN to pretty-print.</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionrandom_junk"></a>
<h3>random_junk <span class="smalllinenumber">[line 2875]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void random_junk(
)</code>
</td></tr></table>
</td></tr></table><br />
This is for Opera. By putting "random junk" in the query string, it thinks<br /><br /><p>that it does not have a cached version of the page, and will thus fetch the page rather than display the cached version</p><br /> <br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionrandom_salt"></a>
<h3>random_salt <span class="smalllinenumber">[line 1702]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string random_salt(
int $length)</code>
</td></tr></table>
</td></tr></table><br />
Used to generate a random salt for crypt-style passwords. Salt strings are used to make pre-built hash cracking dictionaries difficult to use as the hash algorithm uses not only the user's password but also a randomly generated string. The string is stored as the first N characters of the hash for reference of hashing algorithms later.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>The generated salt string.</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">int </td>
<td><b>$length</b> </td>
<td>The length of the salt string to generate.</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionrdn_explode"></a>
<h3>rdn_explode <span class="smalllinenumber">[line 1750]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void rdn_explode(
$rdn)</code>
</td></tr></table>
</td></tr></table><br />
Split an RDN into its attributes<br /><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$rdn</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionreturn_ldap_hash"></a>
<h3>return_ldap_hash <span class="smalllinenumber">[line 2707]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array return_ldap_hash(
string $base, string $filter, string $key, array $attrs, [boolean $sort = true])</code>
</td></tr></table>
</td></tr></table><br />
Query LDAP and return a hash.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>Array of values keyed by $key.</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$base</b> </td>
<td>The base DN to use.</td>
</tr>
<tr>
<td class="type">string </td>
<td><b>$filter</b> </td>
<td>LDAP Query filter.</td>
</tr>
<tr>
<td class="type">string </td>
<td><b>$key</b> </td>
<td>LDAP attribute to use as key.</td>
</tr>
<tr>
<td class="type">array </td>
<td><b>$attrs</b> </td>
<td>Attributes to use as values.</td>
</tr>
<tr>
<td class="type">boolean </td>
<td><b>$sort</b> </td>
<td>Specify false to not sort results by DN or true to have the returned array sorted by DN (uses ksort) or an array of attribute names to sort by attribute values</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionserver_select_list"></a>
<h3>server_select_list <span class="smalllinenumber">[line 2626]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void server_select_list(
[ $selected = null], [ $logged_on = false], [ $name = 'index'], [ $isVisible = true], [ $js = null])</code>
</td></tr></table>
</td></tr></table><br />
Server html select list<br /><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$selected</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$logged_on</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$name</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$isVisible</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$js</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionset_cached_item"></a>
<h3>set_cached_item <span class="smalllinenumber">[line 821]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void set_cached_item(
$index, $item, [ $subitem = 'null'], $data)</code>
</td></tr></table>
</td></tr></table><br />
Caches the specified $item for the specified $index.<br /><br /><p>Returns true on success of false on failure.</p><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$index</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$item</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$subitem</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$data</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionset_cookie"></a>
<h3>set_cookie <span class="smalllinenumber">[line 866]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>boolean set_cookie(
string $name, string $val, [int $expire = null], [string $dir = null])</code>
</td></tr></table>
</td></tr></table><br />
Utility wrapper for setting cookies, which takes into consideration application configuration values. On success, true is returned. On failure, false is returned.<br /><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$name</b> </td>
<td>The name of the cookie to set.</td>
</tr>
<tr>
<td class="type">string </td>
<td><b>$val</b> </td>
<td>The value of the cookie to set.</td>
</tr>
<tr>
<td class="type">int </td>
<td><b>$expire</b> </td>
<td>(optional) The duration in seconds of this cookie. If unspecified, $cookie_time is used from config.php</td>
</tr>
<tr>
<td class="type">string </td>
<td><b>$dir</b> </td>
<td>(optional) The directory value of this cookie (see php.net/setcookie)</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionsortAttrs"></a>
<h3>sortAttrs <span class="smalllinenumber">[line 2538]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void sortAttrs(
$a, $b)</code>
</td></tr></table>
</td></tr></table><br />
Attribute sorting<br /><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$a</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$b</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionsupport_oid_to_text"></a>
<h3>support_oid_to_text <span class="smalllinenumber">[line 1838]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array support_oid_to_text(
string $key)</code>
</td></tr></table>
</td></tr></table><br />
Given an LDAP OID number, returns a verbose description of the OID.<br /><br /><p>This function parses ldap_supported_oids.txt and looks up the specified OID, and returns the verbose message defined in that file.</p><p><ol><li><div class="src-line"> <span class="src-key">Array </span><span class="src-sym">(</span></div></li>
<li><div class="src-line"> <span class="src-sym">[</span><span class="src-id">title</span><span class="src-sym">] </span>=> <span class="src-id">All Operational <a href="../phpLDAPadmin/Templates/Attribute.html">Attribute</a></span></div></li>
<li><div class="src-line"> <span class="src-sym">[</span><span class="src-id">ref</span><span class="src-sym">] </span>=> <span class="src-id">RFC </span><span class="src-num">3673</span></div></li>
<li><div class="src-line"> <span class="src-sym">[</span><span class="src-id">desc</span><span class="src-sym">] </span>=> <span class="src-id">An LDAP extension which clients may </span>use <span class="src-id">to request the </span><span class="src-key">return </span><span class="src-id">of all operational attributes</span>.</div></li>
<li><div class="src-line"> <span class="src-sym">)</span></div></li>
</ol></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>An associative array contianing the OID title and description like so:</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string </td>
<td><b>$key</b> </td>
<td>The OID number (ie, "1.3.6.1.4.1.4203.1.5.1") of the OID of interest.</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionsystem_message"></a>
<h3>system_message <span class="smalllinenumber">[line 608]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void system_message(
$msg, [ $redirect = null])</code>
</td></tr></table>
</td></tr></table><br />
Record a system message.<br /><br /><p>This function can be used as an alternative to generate a system message, if page hasnt yet been defined.</p><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$msg</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$redirect</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionutime"></a>
<h3>utime <span class="smalllinenumber">[line 2455]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>double utime(
)</code>
</td></tr></table>
</td></tr></table><br />
Returns the current time as a double (including micro-seconds).<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b> </td><td>The current time in seconds since the beginning of the UNIX epoch (Midnight Jan. 1, 1970)</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="function_"></a>
<h3>_ <span class="smalllinenumber">[line 96]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _(
$msg)</code>
</td></tr></table>
</td></tr></table><br />
If gettext is not available in PHP, then this will provide compatibility for it.<br /><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$msg</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="function__autoload"></a>
<h3>__autoload <span class="smalllinenumber">[line 54]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void __autoload(
$className)</code>
</td></tr></table>
</td></tr></table><br />
Loads class definition<br /><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type"> </td>
<td><b>$className</b> </td>
<td></td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<div class="credit">
<hr />
Documentation generated on Sun, 25 Mar 2012 19:35:35 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.1</a>
</div>
</td></tr></table>
</td>
</tr>
</table>
</body>
</html>
|
