~ubuntu-branches/ubuntu/trusty/ldap-account-manager/trusty-proposed
» Revision
29
: docs/devel/phpdoc/structure.xml
« back to all changes in this revision
Viewing changes to docs/devel/phpdoc/structure.xml
- browse files at revision 29
- compare with another revision
- download diff
- download tarball
- view history from revision 29
- Committer: Package Import Robot
- Author(s): Roland Gruber
- Date: 2013-07-21 11:15:58 UTC
- mfrom: (1.2.21)
- Revision ID: package-import@ubuntu.com-20130721111558-ex49xgcpo71fh0xg
Tags: 4.2.1-2
* Apache 2.4 support
* Fix "transition towards Apache 2.4"
support conf-enabled (Closes: #669824)
* Fix "[ldap-account-manager] Can't install ldap-account-manager"
support conf-enabled (Closes: #711778)
* Fix "transition towards Apache 2.4"
support conf-enabled (Closes: #669824)
* Fix "[ldap-account-manager] Can't install ldap-account-manager"
support conf-enabled (Closes: #711778)
- files added:
- docs/devel/mod_selfService.htm
- files removed:
- docs/devel/phpdoc/classes/ieee802Device.html
- files modified:
- HISTORY
added
removed
docs/devel/phpdoc/structure.xml
1380
1380
</method>
1381
1381
</class>
1382
1382
</file>
1383
<file path="lib/types/asteriskExt.inc" hash="5395247f5f8d42295a26f25e744b6610" package="types">
1383
<file path="lib/types/asteriskExt.inc" hash="e490cc35d321d3381bd1f2bd8528f3f2" package="types">
1384
1384
<docblock line="26">
1385
1385
<description><![CDATA[The account type for Asterisk extensions.]]></description>
1386
1386
<long-description><![CDATA[]]></long-description>
1675
1675
</method>
1676
1676
</class>
1677
1677
</file>
1678
<file path="lib/types/host.inc" hash="1064fde8809dd06755ba98aca85e8ca6" package="types">
1678
<file path="lib/types/host.inc" hash="cc00769edbc086620d134a94043f778f" package="types">
1679
1679
<docblock line="24">
1680
1680
<description><![CDATA[The account type for host accounts (e.g.]]></description>
1681
1681
<long-description><![CDATA[<p>Samba).</p>]]></long-description>
1754
1754
</tag>
1755
1755
</docblock>
1756
1756
</method>
1757
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="106" package="types">
1757
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="107" package="types">
1758
1758
<name>getTitleBarTitle</name>
1759
1759
<full_name>getTitleBarTitle</full_name>
1760
<docblock line="100">
1760
<docblock line="101">
1761
1761
<description><![CDATA[Returns the the title text for the title bar on the new/edit page.]]></description>
1762
1762
<long-description><![CDATA[]]></long-description>
1763
<tag line="100" name="param" description="account container" type="\accountContainer" variable="$container">
1763
<tag line="101" name="param" description="account container" type="\accountContainer" variable="$container">
1764
1764
<type by_reference="false">\accountContainer</type>
1765
1765
</tag>
1766
<tag line="100" name="return" description="title text" type="String">
1766
<tag line="101" name="return" description="title text" type="String">
1767
1767
<type by_reference="false">String</type>
1768
1768
</tag>
1769
1769
</docblock>
1770
<argument line="106">
1770
<argument line="107">
1771
1771
<name>$container</name>
1772
1772
<default><![CDATA[]]></default>
1773
1773
<type/>
1774
1774
</argument>
1775
1775
</method>
1776
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="136" package="types">
1776
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="140" package="types">
1777
1777
<name>getTitleBarSubtitle</name>
1778
1778
<full_name>getTitleBarSubtitle</full_name>
1779
<docblock line="130">
1779
<docblock line="134">
1780
1780
<description><![CDATA[Returns the the title text for the title bar on the new/edit page.]]></description>
1781
1781
<long-description><![CDATA[]]></long-description>
1782
<tag line="130" name="param" description="account container" type="\accountContainer" variable="$container">
1782
<tag line="134" name="param" description="account container" type="\accountContainer" variable="$container">
1783
1783
<type by_reference="false">\accountContainer</type>
1784
1784
</tag>
1785
<tag line="130" name="return" description="title text" type="String">
1785
<tag line="134" name="return" description="title text" type="String">
1786
1786
<type by_reference="false">String</type>
1787
1787
</tag>
1788
1788
</docblock>
1789
<argument line="136">
1789
<argument line="140">
1790
1790
<name>$container</name>
1791
1791
<default><![CDATA[]]></default>
1792
1792
<type/>
1793
1793
</argument>
1794
1794
</method>
1795
1795
</class>
1796
<class final="false" abstract="false" namespace="global" line="175" package="lists">
1796
<class final="false" abstract="false" namespace="global" line="182" package="lists">
1797
1797
<extends>\lamList</extends>
1798
1798
<name>lamHostList</name>
1799
1799
<full_name>\lamHostList</full_name>
1800
<docblock line="168">
1800
<docblock line="175">
1801
1801
<description><![CDATA[Generates the list view.]]></description>
1802
1802
<long-description><![CDATA[]]></long-description>
1803
<tag line="168" name="package" description="lists"/>
1804
<tag line="168" name="author" description="Roland Gruber"/>
1803
<tag line="175" name="package" description="lists"/>
1804
<tag line="175" name="author" description="Roland Gruber"/>
1805
1805
</docblock>
1806
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="183" package="lists">
1806
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="190" package="lists">
1807
1807
<name>__construct</name>
1808
1808
<full_name>__construct</full_name>
1809
<docblock line="177">
1809
<docblock line="184">
1810
1810
<description><![CDATA[Constructor]]></description>
1811
1811
<long-description><![CDATA[]]></long-description>
1812
<tag line="177" name="param" description="account type" type="string" variable="$type">
1812
<tag line="184" name="param" description="account type" type="string" variable="$type">
1813
1813
<type by_reference="false">string</type>
1814
1814
</tag>
1815
<tag line="177" name="return" description="list object" type="\lamList">
1815
<tag line="184" name="return" description="list object" type="\lamList">
1816
1816
<type by_reference="false">\lamList</type>
1817
1817
</tag>
1818
1818
</docblock>
1819
<argument line="183">
1819
<argument line="190">
1820
1820
<name>$type</name>
1821
1821
<default><![CDATA[]]></default>
1822
1822
<type/>
1973
1973
</method>
1974
1974
</class>
1975
1975
</file>
1976
<file path="lib/types/group.inc" hash="b3edff0144d79e0c4221cf7e2c5aa321" package="types">
1976
<file path="lib/types/group.inc" hash="244c1baa3cfe9ac510c0c31a4b7c9029" package="types">
1977
1977
<docblock line="24">
1978
1978
<description><![CDATA[The account type for group accounts (e.g.]]></description>
1979
1979
<long-description><![CDATA[<p>Unix and Samba).</p>]]></long-description>
2072
2072
<type/>
2073
2073
</argument>
2074
2074
</method>
2075
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="147" package="types">
2075
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="150" package="types">
2076
2076
<name>getTitleBarSubtitle</name>
2077
2077
<full_name>getTitleBarSubtitle</full_name>
2078
<docblock line="141">
2078
<docblock line="144">
2079
2079
<description><![CDATA[Returns the the title text for the title bar on the new/edit page.]]></description>
2080
2080
<long-description><![CDATA[]]></long-description>
2081
<tag line="141" name="param" description="account container" type="\accountContainer" variable="$container">
2081
<tag line="144" name="param" description="account container" type="\accountContainer" variable="$container">
2082
2082
<type by_reference="false">\accountContainer</type>
2083
2083
</tag>
2084
<tag line="141" name="return" description="title text" type="String">
2084
<tag line="144" name="return" description="title text" type="String">
2085
2085
<type by_reference="false">String</type>
2086
2086
</tag>
2087
2087
</docblock>
2088
<argument line="147">
2088
<argument line="150">
2089
2089
<name>$container</name>
2090
2090
<default><![CDATA[]]></default>
2091
2091
<type/>
2092
2092
</argument>
2093
2093
</method>
2094
2094
</class>
2095
<class final="false" abstract="false" namespace="global" line="182" package="lists">
2095
<class final="false" abstract="false" namespace="global" line="188" package="lists">
2096
2096
<extends>\lamList</extends>
2097
2097
<name>lamGroupList</name>
2098
2098
<full_name>\lamGroupList</full_name>
2099
<docblock line="175">
2099
<docblock line="181">
2100
2100
<description><![CDATA[Generates the list view.]]></description>
2101
2101
<long-description><![CDATA[]]></long-description>
2102
<tag line="175" name="package" description="lists"/>
2103
<tag line="175" name="author" description="Roland Gruber"/>
2102
<tag line="181" name="package" description="lists"/>
2103
<tag line="181" name="author" description="Roland Gruber"/>
2104
2104
</docblock>
2105
<constant namespace="global" line="191" package="lists">
2105
<constant namespace="global" line="197" package="lists">
2106
2106
<name>TRANS_PRIMARY_OPTION_NAME</name>
2107
2107
<full_name>TRANS_PRIMARY_OPTION_NAME</full_name>
2108
2108
<value><![CDATA["LG_TP"]]></value>
2109
<docblock line="190">
2109
<docblock line="196">
2110
2110
<description><![CDATA[ID for config option]]></description>
2111
2111
<long-description><![CDATA[]]></long-description>
2112
2112
</docblock>
2113
2113
</constant>
2114
<property final="false" static="false" visibility="private" line="185" namespace="global" package="main">
2114
<property final="false" static="false" visibility="private" line="191" namespace="global" package="main">
2115
2115
<name>$use_primary</name>
2116
2116
<default><![CDATA[false]]></default>
2117
<docblock line="184">
2117
<docblock line="190">
2118
2118
<description><![CDATA[Controls if include primary group members into group memebers]]></description>
2119
2119
<long-description><![CDATA[]]></long-description>
2120
2120
</docblock>
2121
2121
</property>
2122
<property final="false" static="false" visibility="private" line="187" namespace="global" package="main">
2122
<property final="false" static="false" visibility="private" line="193" namespace="global" package="main">
2123
2123
<name>$primary_hash</name>
2124
2124
<default><![CDATA[array()]]></default>
2125
<docblock line="186">
2125
<docblock line="192">
2126
2126
<description><![CDATA[Primary group members hash]]></description>
2127
2127
<long-description><![CDATA[]]></long-description>
2128
2128
</docblock>
2129
2129
</property>
2130
<property final="false" static="false" visibility="private" line="189" namespace="global" package="main">
2130
<property final="false" static="false" visibility="private" line="195" namespace="global" package="main">
2131
2131
<name>$refresh_primary</name>
2132
2132
<default><![CDATA[false]]></default>
2133
<docblock line="188">
2133
<docblock line="194">
2134
2134
<description><![CDATA[Controls if primary group members needs refresh]]></description>
2135
2135
<long-description><![CDATA[]]></long-description>
2136
2136
</docblock>
2137
2137
</property>
2138
<property final="false" static="false" visibility="private" line="193" namespace="global" package="main">
2138
<property final="false" static="false" visibility="private" line="199" namespace="global" package="main">
2139
2139
<name>$include_primary</name>
2140
2140
<default><![CDATA[false]]></default>
2141
<docblock line="192">
2141
<docblock line="198">
2142
2142
<description><![CDATA[specifies if primary group members are visible]]></description>
2143
2143
<long-description><![CDATA[]]></long-description>
2144
2144
</docblock>
2145
2145
</property>
2146
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="201" package="lists">
2146
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="207" package="lists">
2147
2147
<name>__construct</name>
2148
2148
<full_name>__construct</full_name>
2149
<docblock line="195">
2149
<docblock line="201">
2150
2150
<description><![CDATA[Constructor]]></description>
2151
2151
<long-description><![CDATA[]]></long-description>
2152
<tag line="195" name="param" description="account type" type="string" variable="$type">
2152
<tag line="201" name="param" description="account type" type="string" variable="$type">
2153
2153
<type by_reference="false">string</type>
2154
2154
</tag>
2155
<tag line="195" name="return" description="list object" type="\lamList">
2155
<tag line="201" name="return" description="list object" type="\lamList">
2156
2156
<type by_reference="false">\lamList</type>
2157
2157
</tag>
2158
2158
</docblock>
2159
<argument line="201">
2159
<argument line="207">
2160
2160
<name>$type</name>
2161
2161
<default><![CDATA[]]></default>
2162
2162
<type/>
2163
2163
</argument>
2164
2164
</method>
2165
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="213" package="lists">
2165
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="219" package="lists">
2166
2166
<name>listGetParams</name>
2167
2167
<full_name>listGetParams</full_name>
2168
<docblock line="210">
2168
<docblock line="216">
2169
2169
<description><![CDATA[Sets some internal parameters.]]></description>
2170
2170
<long-description><![CDATA[]]></long-description>
2171
2171
</docblock>
2172
2172
</method>
2173
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="227" package="lists">
2173
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="233" package="lists">
2174
2174
<name>listPrintTableCellContent</name>
2175
2175
<full_name>listPrintTableCellContent</full_name>
2176
<docblock line="221">
2176
<docblock line="227">
2177
2177
<description><![CDATA[Prints the content of a cell in the account list for a given LDAP entry and attribute.]]></description>
2178
2178
<long-description><![CDATA[]]></long-description>
2179
<tag line="221" name="param" description="LDAP attributes" type="array" variable="$entry">
2179
<tag line="227" name="param" description="LDAP attributes" type="array" variable="$entry">
2180
2180
<type by_reference="false">array</type>
2181
2181
</tag>
2182
<tag line="221" name="param" description="attribute name" type="string" variable="$attribute">
2182
<tag line="227" name="param" description="attribute name" type="string" variable="$attribute">
2183
2183
<type by_reference="false">string</type>
2184
2184
</tag>
2185
2185
</docblock>
2186
<argument line="227">
2186
<argument line="233">
2187
2187
<name>$entry</name>
2188
2188
<default><![CDATA[]]></default>
2189
2189
<type/>
2190
2190
</argument>
2191
<argument line="227">
2191
<argument line="233">
2192
2192
<name>$attribute</name>
2193
2193
<default><![CDATA[]]></default>
2194
2194
<type/>
2195
2195
</argument>
2196
2196
</method>
2197
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="299" package="lists">
2197
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="305" package="lists">
2198
2198
<name>listRefreshData</name>
2199
2199
<full_name>listRefreshData</full_name>
2200
<docblock line="296">
2200
<docblock line="302">
2201
2201
<description><![CDATA[Rereads the entries from LDAP.]]></description>
2202
2202
<long-description><![CDATA[]]></long-description>
2203
2203
</docblock>
2204
2204
</method>
2205
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="309" package="lists">
2205
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="315" package="lists">
2206
2206
<name>groupRefreshPrimary</name>
2207
2207
<full_name>groupRefreshPrimary</full_name>
2208
<docblock line="306">
2208
<docblock line="312">
2209
2209
<description><![CDATA[Refreshes the primary group members list.]]></description>
2210
2210
<long-description><![CDATA[]]></long-description>
2211
2211
</docblock>
2212
2212
</method>
2213
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="335" package="lists">
2213
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="341" package="lists">
2214
2214
<name>listGetAllConfigOptions</name>
2215
2215
<full_name>listGetAllConfigOptions</full_name>
2216
<docblock line="330">
2216
<docblock line="336">
2217
2217
<description><![CDATA[Returns a list of possible configuration options.]]></description>
2218
2218
<long-description><![CDATA[]]></long-description>
2219
<tag line="330" name="return" description="list of lamListOption objects" type="array">
2219
<tag line="336" name="return" description="list of lamListOption objects" type="array">
2220
2220
<type by_reference="false">array</type>
2221
2221
</tag>
2222
2222
</docblock>
2223
2223
</method>
2224
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="344" package="lists">
2224
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="350" package="lists">
2225
2225
<name>listConfigurationChanged</name>
2226
2226
<full_name>listConfigurationChanged</full_name>
2227
<docblock line="341">
2227
<docblock line="347">
2228
2228
<description><![CDATA[Called when the configuration options changed.]]></description>
2229
2229
<long-description><![CDATA[]]></long-description>
2230
2230
</docblock>
2231
2231
</method>
2232
2232
</class>
2233
2233
</file>
2234
<file path="lib/types/user.inc" hash="47bed3e68ec9c83ec4736cb654307295" package="types">
2234
<file path="lib/types/user.inc" hash="eccd3c5319fe19ab3386e81cd21e6bb8" package="types">
2235
2235
<docblock line="24">
2236
2236
<description><![CDATA[The account type for user accounts (e.g.]]></description>
2237
2237
<long-description><![CDATA[<p>Unix, Samba and Kolab).</p>]]></long-description>
2329
2329
<type/>
2330
2330
</argument>
2331
2331
</method>
2332
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="180" package="types">
2332
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="184" package="types">
2333
2333
<name>getTitleBarSubtitle</name>
2334
2334
<full_name>getTitleBarSubtitle</full_name>
2335
<docblock line="174">
2335
<docblock line="178">
2336
2336
<description><![CDATA[Returns the the title text for the title bar on the new/edit page.]]></description>
2337
2337
<long-description><![CDATA[]]></long-description>
2338
<tag line="174" name="param" description="account container" type="\accountContainer" variable="$container">
2338
<tag line="178" name="param" description="account container" type="\accountContainer" variable="$container">
2339
2339
<type by_reference="false">\accountContainer</type>
2340
2340
</tag>
2341
<tag line="174" name="return" description="title text" type="String">
2341
<tag line="178" name="return" description="title text" type="String">
2342
2342
<type by_reference="false">String</type>
2343
2343
</tag>
2344
2344
</docblock>
2345
<argument line="180">
2345
<argument line="184">
2346
2346
<name>$container</name>
2347
2347
<default><![CDATA[]]></default>
2348
2348
<type/>
2349
2349
</argument>
2350
2350
</method>
2351
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="214" package="types">
2351
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="221" package="types">
2352
2352
<name>buildAccountStatusIcon</name>
2353
2353
<full_name>buildAccountStatusIcon</full_name>
2354
<docblock line="208">
2354
<docblock line="215">
2355
2355
<description><![CDATA[Builds the HTML code for the icon that shows the account status (locked/unlocked).]]></description>
2356
2356
<long-description><![CDATA[]]></long-description>
2357
<tag line="208" name="param" description="account container" type="\accountContainer" variable="$container">
2357
<tag line="215" name="param" description="account container" type="\accountContainer" variable="$container">
2358
2358
<type by_reference="false">\accountContainer</type>
2359
2359
</tag>
2360
<tag line="208" name="return" description="HTML code for icon" type="String">
2360
<tag line="215" name="return" description="HTML code for icon" type="String">
2361
2361
<type by_reference="false">String</type>
2362
2362
</tag>
2363
2363
</docblock>
2364
<argument line="214">
2364
<argument line="221">
2365
2365
<name>$container</name>
2366
2366
<default><![CDATA[]]></default>
2367
2367
<type/>
2368
2368
</argument>
2369
2369
</method>
2370
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="298" package="types">
2370
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="321" package="types">
2371
2371
<name>buildAccountStatusDialogDiv</name>
2372
2372
<full_name>buildAccountStatusDialogDiv</full_name>
2373
<docblock line="288">
2373
<docblock line="309">
2374
2374
<description><![CDATA[Builds the dialog to (un)lock parts of an account.]]></description>
2375
2375
<long-description><![CDATA[]]></long-description>
2376
<tag line="288" name="param" description="Unix part is active" type="boolean" variable="$unixAvailable">
2377
<type by_reference="false">boolean</type>
2378
</tag>
2379
<tag line="288" name="param" description="Unix part is locked" type="boolean" variable="$unixLocked">
2380
<type by_reference="false">boolean</type>
2381
</tag>
2382
<tag line="288" name="param" description="Samba part is active" type="boolean" variable="$sambaAvailable">
2383
<type by_reference="false">boolean</type>
2384
</tag>
2385
<tag line="288" name="param" description="Samba part is locked" type="boolean" variable="$sambaLocked">
2386
<type by_reference="false">boolean</type>
2387
</tag>
2388
<tag line="288" name="param" description="PPolicy part is active" type="boolean" variable="$ppolicyAvailable">
2389
<type by_reference="false">boolean</type>
2390
</tag>
2391
<tag line="288" name="param" description="PPolicy part is locked" type="boolean" variable="$ppolicyLocked">
2376
<tag line="309" name="param" description="Unix part is active" type="boolean" variable="$unixAvailable">
2377
<type by_reference="false">boolean</type>
2378
</tag>
2379
<tag line="309" name="param" description="Unix part is locked" type="boolean" variable="$unixLocked">
2380
<type by_reference="false">boolean</type>
2381
</tag>
2382
<tag line="309" name="param" description="Samba part is active" type="boolean" variable="$sambaAvailable">
2383
<type by_reference="false">boolean</type>
2384
</tag>
2385
<tag line="309" name="param" description="Samba part is locked" type="boolean" variable="$sambaLocked">
2386
<type by_reference="false">boolean</type>
2387
</tag>
2388
<tag line="309" name="param" description="PPolicy part is active" type="boolean" variable="$ppolicyAvailable">
2389
<type by_reference="false">boolean</type>
2390
</tag>
2391
<tag line="309" name="param" description="PPolicy part is locked" type="boolean" variable="$ppolicyLocked">
2392
<type by_reference="false">boolean</type>
2393
</tag>
2394
<tag line="309" name="param" description="Windows part is active" type="boolean" variable="$windowsAvailable">
2395
<type by_reference="false">boolean</type>
2396
</tag>
2397
<tag line="309" name="param" description="Windows part is locked" type="boolean" variable="$windowsLocked">
2392
2398
<type by_reference="false">boolean</type>
2393
2399
</tag>
2394
2400
</docblock>
2395
<argument line="298">
2401
<argument line="321">
2396
2402
<name>$unixAvailable</name>
2397
2403
<default><![CDATA[]]></default>
2398
2404
<type/>
2399
2405
</argument>
2400
<argument line="298">
2406
<argument line="321">
2401
2407
<name>$unixLocked</name>
2402
2408
<default><![CDATA[]]></default>
2403
2409
<type/>
2404
2410
</argument>
2405
<argument line="298">
2411
<argument line="321">
2406
2412
<name>$sambaAvailable</name>
2407
2413
<default><![CDATA[]]></default>
2408
2414
<type/>
2409
2415
</argument>
2410
<argument line="298">
2416
<argument line="321">
2411
2417
<name>$sambaLocked</name>
2412
2418
<default><![CDATA[]]></default>
2413
2419
<type/>
2414
2420
</argument>
2415
<argument line="298">
2421
<argument line="321">
2416
2422
<name>$ppolicyAvailable</name>
2417
2423
<default><![CDATA[]]></default>
2418
2424
<type/>
2419
2425
</argument>
2420
<argument line="298">
2426
<argument line="321">
2421
2427
<name>$ppolicyLocked</name>
2422
2428
<default><![CDATA[]]></default>
2423
2429
<type/>
2424
2430
</argument>
2431
<argument line="321">
2432
<name>$windowsAvailable</name>
2433
<default><![CDATA[]]></default>
2434
<type/>
2435
</argument>
2436
<argument line="321">
2437
<name>$windowsLocked</name>
2438
<default><![CDATA[]]></default>
2439
<type/>
2440
</argument>
2425
2441
</method>
2426
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="409" package="types">
2442
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="441" package="types">
2427
2443
<name>runEditPagePostAction</name>
2428
2444
<full_name>runEditPagePostAction</full_name>
2429
<docblock line="403">
2445
<docblock line="435">
2430
2446
<description><![CDATA[This function is called after the edit page is processed and before the page content is generated.]]></description>
2431
2447
<long-description><![CDATA[<p>This can be used to run custom handlers after each page processing.</p>]]></long-description>
2432
<tag line="403" name="param" description="account container" type="\accountContainer" variable="$container">
2448
<tag line="435" name="param" description="account container" type="\accountContainer" variable="$container">
2433
2449
<type by_reference="false">\accountContainer</type>
2434
2450
</tag>
2435
2451
</docblock>
2436
<argument line="409">
2452
<argument line="441">
2437
2453
<name>$container</name>
2438
2454
<default><![CDATA[]]></default>
2439
2455
<type/>
2440
2456
</argument>
2441
2457
</method>
2442
2458
</class>
2443
<class final="false" abstract="false" namespace="global" line="462" package="lists">
2459
<class final="false" abstract="false" namespace="global" line="502" package="lists">
2444
2460
<extends>\lamList</extends>
2445
2461
<name>lamUserList</name>
2446
2462
<full_name>\lamUserList</full_name>
2447
<docblock line="455">
2463
<docblock line="495">
2448
2464
<description><![CDATA[Generates the list view.]]></description>
2449
2465
<long-description><![CDATA[]]></long-description>
2450
<tag line="455" name="package" description="lists"/>
2451
<tag line="455" name="author" description="Roland Gruber"/>
2466
<tag line="495" name="package" description="lists"/>
2467
<tag line="495" name="author" description="Roland Gruber"/>
2452
2468
</docblock>
2453
<constant namespace="global" line="474" package="lists">
2469
<constant namespace="global" line="514" package="lists">
2454
2470
<name>TRANS_PRIMARY_OPTION_NAME</name>
2455
2471
<full_name>TRANS_PRIMARY_OPTION_NAME</full_name>
2456
2472
<value><![CDATA["LU_TP"]]></value>
2457
<docblock line="473">
2473
<docblock line="513">
2458
2474
<description><![CDATA[ID for config option to translate primary group GIDs to group names]]></description>
2459
2475
<long-description><![CDATA[]]></long-description>
2460
2476
</docblock>
2461
2477
</constant>
2462
<constant namespace="global" line="476" package="lists">
2478
<constant namespace="global" line="516" package="lists">
2463
2479
<name>ACCOUNT_STATUS_OPTION_NAME</name>
2464
2480
<full_name>ACCOUNT_STATUS_OPTION_NAME</full_name>
2465
2481
<value><![CDATA["LU_AS"]]></value>
2466
<docblock line="475">
2482
<docblock line="515">
2467
2483
<description><![CDATA[ID for config option to show account status]]></description>
2468
2484
<long-description><![CDATA[]]></long-description>
2469
2485
</docblock>
2470
2486
</constant>
2471
<constant namespace="global" line="479" package="lists">
2487
<constant namespace="global" line="519" package="lists">
2472
2488
<name>ATTR_ACCOUNT_STATUS</name>
2473
2489
<full_name>ATTR_ACCOUNT_STATUS</full_name>
2474
2490
<value><![CDATA['lam_virtual_account_status']]></value>
2475
<docblock line="478">
2491
<docblock line="518">
2476
2492
<description><![CDATA[virtual attribute name for account status column]]></description>
2477
2493
<long-description><![CDATA[]]></long-description>
2478
2494
</docblock>
2479
2495
</constant>
2480
<property final="false" static="false" visibility="private" line="465" namespace="global" package="main">
2496
<property final="false" static="false" visibility="private" line="505" namespace="global" package="main">
2481
2497
<name>$trans_primary</name>
2482
2498
<default><![CDATA[false]]></default>
2483
<docblock line="464">
2499
<docblock line="504">
2484
2500
<description><![CDATA[Controls if GID number is translated to group name]]></description>
2485
2501
<long-description><![CDATA[]]></long-description>
2486
2502
</docblock>
2487
2503
</property>
2488
<property final="false" static="false" visibility="private" line="468" namespace="global" package="main">
2504
<property final="false" static="false" visibility="private" line="508" namespace="global" package="main">
2489
2505
<name>$showAccountStatus</name>
2490
2506
<default><![CDATA[false]]></default>
2491
<docblock line="467">
2507
<docblock line="507">
2492
2508
<description><![CDATA[Controls if the account status is shown]]></description>
2493
2509
<long-description><![CDATA[]]></long-description>
2494
2510
</docblock>
2495
2511
</property>
2496
<property final="false" static="false" visibility="private" line="471" namespace="global" package="main">
2512
<property final="false" static="false" visibility="private" line="511" namespace="global" package="main">
2497
2513
<name>$trans_primary_hash</name>
2498
2514
<default><![CDATA[array()]]></default>
2499
<docblock line="470">
2515
<docblock line="510">
2500
2516
<description><![CDATA[translates GID to group name]]></description>
2501
2517
<long-description><![CDATA[]]></long-description>
2502
2518
</docblock>
2503
2519
</property>
2504
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="487" package="lists">
2520
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="527" package="lists">
2505
2521
<name>__construct</name>
2506
2522
<full_name>__construct</full_name>
2507
<docblock line="481">
2523
<docblock line="521">
2508
2524
<description><![CDATA[Constructor]]></description>
2509
2525
<long-description><![CDATA[]]></long-description>
2510
<tag line="481" name="param" description="account type" type="string" variable="$type">
2526
<tag line="521" name="param" description="account type" type="string" variable="$type">
2511
2527
<type by_reference="false">string</type>
2512
2528
</tag>
2513
<tag line="481" name="return" description="list object" type="\lamList">
2529
<tag line="521" name="return" description="list object" type="\lamList">
2514
2530
<type by_reference="false">\lamList</type>
2515
2531
</tag>
2516
2532
</docblock>
2517
<argument line="487">
2533
<argument line="527">
2518
2534
<name>$type</name>
2519
2535
<default><![CDATA[]]></default>
2520
2536
<type/>
2521
2537
</argument>
2522
2538
</method>
2523
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="499" package="lists">
2539
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="539" package="lists">
2524
2540
<name>listGetParams</name>
2525
2541
<full_name>listGetParams</full_name>
2526
<docblock line="496">
2542
<docblock line="536">
2527
2543
<description><![CDATA[Sets some internal parameters.]]></description>
2528
2544
<long-description><![CDATA[]]></long-description>
2529
2545
</docblock>
2530
2546
</method>
2531
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="510" package="lists">
2547
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="550" package="lists">
2532
2548
<name>listRefreshData</name>
2533
2549
<full_name>listRefreshData</full_name>
2534
<docblock line="507">
2550
<docblock line="547">
2535
2551
<description><![CDATA[Rereads the entries from LDAP.]]></description>
2536
2552
<long-description><![CDATA[]]></long-description>
2537
2553
</docblock>
2538
2554
</method>
2539
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="523" package="lists">
2555
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="563" package="lists">
2540
2556
<name>refreshPrimaryGroupTranslation</name>
2541
2557
<full_name>refreshPrimaryGroupTranslation</full_name>
2542
<docblock line="520">
2558
<docblock line="560">
2543
2559
<description><![CDATA[Refreshes the GID to group name cache.]]></description>
2544
2560
<long-description><![CDATA[]]></long-description>
2545
2561
</docblock>
2546
2562
</method>
2547
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="540" package="lists">
2563
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="581" package="lists">
2548
2564
<name>listPrintTableCellContent</name>
2549
2565
<full_name>listPrintTableCellContent</full_name>
2550
<docblock line="534">
2566
<docblock line="575">
2551
2567
<description><![CDATA[Prints the content of a cell in the account list for a given LDAP entry and attribute.]]></description>
2552
2568
<long-description><![CDATA[]]></long-description>
2553
<tag line="534" name="param" description="LDAP attributes" type="array" variable="$entry">
2569
<tag line="575" name="param" description="LDAP attributes" type="array" variable="$entry">
2554
2570
<type by_reference="false">array</type>
2555
2571
</tag>
2556
<tag line="534" name="param" description="attribute name" type="string" variable="$attribute">
2572
<tag line="575" name="param" description="attribute name" type="string" variable="$attribute">
2557
2573
<type by_reference="false">string</type>
2558
2574
</tag>
2559
2575
</docblock>
2560
<argument line="540">
2576
<argument line="581">
2561
2577
<name>$entry</name>
2562
2578
<default><![CDATA[]]></default>
2563
2579
<type/>
2564
2580
</argument>
2565
<argument line="540">
2581
<argument line="581">
2566
2582
<name>$attribute</name>
2567
2583
<default><![CDATA[]]></default>
2568
2584
<type/>
2569
2585
</argument>
2570
2586
</method>
2571
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="626" package="lists">
2587
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="667" package="lists">
2572
2588
<name>getAdditionalTools</name>
2573
2589
<full_name>getAdditionalTools</full_name>
2574
<docblock line="621">
2590
<docblock line="662">
2575
2591
<description><![CDATA[Returns a list of lamListTool objects to display next to the edit/delete buttons.]]></description>
2576
2592
<long-description><![CDATA[]]></long-description>
2577
<tag line="621" name="return" description="tools" type="\lamListTool[]">
2593
<tag line="662" name="return" description="tools" type="\lamListTool[]">
2578
2594
<type by_reference="false">\lamListTool[]</type>
2579
2595
</tag>
2580
2596
</docblock>
2581
2597
</method>
2582
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="639" package="lists">
2598
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="680" package="lists">
2583
2599
<name>listGetAllConfigOptions</name>
2584
2600
<full_name>listGetAllConfigOptions</full_name>
2585
<docblock line="634">
2601
<docblock line="675">
2586
2602
<description><![CDATA[Returns a list of possible configuration options.]]></description>
2587
2603
<long-description><![CDATA[]]></long-description>
2588
<tag line="634" name="return" description="list of lamListOption objects" type="array">
2604
<tag line="675" name="return" description="list of lamListOption objects" type="array">
2589
2605
<type by_reference="false">array</type>
2590
2606
</tag>
2591
2607
</docblock>
2592
2608
</method>
2593
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="649" package="lists">
2609
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="690" package="lists">
2594
2610
<name>listConfigurationChanged</name>
2595
2611
<full_name>listConfigurationChanged</full_name>
2596
<docblock line="646">
2612
<docblock line="687">
2597
2613
<description><![CDATA[Called when the configuration options changed.]]></description>
2598
2614
<long-description><![CDATA[]]></long-description>
2599
2615
</docblock>
2600
2616
</method>
2601
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="670" package="lists">
2617
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="711" package="lists">
2602
2618
<name>listGetAttributeDescriptionList</name>
2603
2619
<full_name>listGetAttributeDescriptionList</full_name>
2604
<docblock line="662">
2620
<docblock line="703">
2605
2621
<description><![CDATA[Returns an hash array containing with all attributes to be shown and their descriptions.]]></description>
2606
2622
<long-description><![CDATA[<p><br>Format: array(attribute => description)
2607
2623
<br>
2608
2624
<br>The user list may display an additional account status column</p>]]></long-description>
2609
<tag line="662" name="return" description="attribute list" type="array">
2625
<tag line="703" name="return" description="attribute list" type="array">
2610
2626
<type by_reference="false">array</type>
2611
2627
</tag>
2612
2628
</docblock>
2613
2629
</method>
2614
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="687" package="lists">
2630
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="728" package="lists">
2615
2631
<name>canBeFiltered</name>
2616
2632
<full_name>canBeFiltered</full_name>
2617
<docblock line="678">
2633
<docblock line="719">
2618
2634
<description><![CDATA[Returns if the given attribute can be filtered.]]></description>
2619
2635
<long-description><![CDATA[<p>If filtering is not possible then no filter box will be displayed.
2620
2636
<br>
2621
2637
<br>The user list allows no filtering for account status.</p>]]></long-description>
2622
<tag line="678" name="param" description="attribute name" type="String" variable="$attr">
2638
<tag line="719" name="param" description="attribute name" type="String" variable="$attr">
2623
2639
<type by_reference="false">String</type>
2624
2640
</tag>
2625
<tag line="678" name="return" description="filtering possible" type="boolean">
2641
<tag line="719" name="return" description="filtering possible" type="boolean">
2626
2642
<type by_reference="false">boolean</type>
2627
2643
</tag>
2628
2644
</docblock>
2629
<argument line="687">
2645
<argument line="728">
2630
2646
<name>$attr</name>
2631
2647
<default><![CDATA[]]></default>
2632
2648
<type/>
2633
2649
</argument>
2634
2650
</method>
2635
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="705" package="lists">
2651
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="746" package="lists">
2636
2652
<name>getAdditionalLDAPAttributesToRead</name>
2637
2653
<full_name>getAdditionalLDAPAttributesToRead</full_name>
2638
<docblock line="697">
2654
<docblock line="738">
2639
2655
<description><![CDATA[Returns a list of additional LDAP attributes that should be read.]]></description>
2640
2656
<long-description><![CDATA[<p>This can be used to show additional data even if the user selected other attributes to show in the list.
2641
2657
<br>
2642
2658
<br>The user list reads pwdAccountLockedTime, sambaAcctFlags and userPassword</p>]]></long-description>
2643
<tag line="697" name="return" description="additional attribute names" type="array">
2659
<tag line="738" name="return" description="additional attribute names" type="array">
2644
2660
<type by_reference="false">array</type>
2645
2661
</tag>
2646
2662
</docblock>
2647
2663
</method>
2648
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="719" package="lists">
2664
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="761" package="lists">
2649
2665
<name>injectAccountStatusAttribute</name>
2650
2666
<full_name>injectAccountStatusAttribute</full_name>
2651
<docblock line="716">
2667
<docblock line="758">
2652
2668
<description><![CDATA[Injects values for the virtual account status attribute to make it sortable.]]></description>
2653
2669
<long-description><![CDATA[]]></long-description>
2654
2670
</docblock>
2655
2671
</method>
2656
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="740" package="lists">
2672
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="786" package="lists">
2657
2673
<name>printAccountStatus</name>
2658
2674
<full_name>printAccountStatus</full_name>
2659
<docblock line="735">
2675
<docblock line="781">
2660
2676
<description><![CDATA[Prints the account status.]]></description>
2661
2677
<long-description><![CDATA[]]></long-description>
2662
<tag line="735" name="param" description="LDAP attributes" type="array" variable="$attrs">
2678
<tag line="781" name="param" description="LDAP attributes" type="array" variable="$attrs">
2663
2679
<type by_reference="false">array</type>
2664
2680
</tag>
2665
2681
</docblock>
2666
<argument line="740">
2682
<argument line="786">
2667
2683
<name>$attrs</name>
2668
2684
<default><![CDATA[]]></default>
2669
2685
<type/>
2670
2686
</argument>
2671
2687
</method>
2672
<method final="false" abstract="false" static="true" visibility="public" namespace="global" line="802" package="lists">
2688
<method final="false" abstract="false" static="true" visibility="public" namespace="global" line="862" package="lists">
2673
2689
<name>isUnixAvailable</name>
2674
2690
<full_name>isUnixAvailable</full_name>
2675
<docblock line="796">
2691
<docblock line="856">
2676
2692
<description><![CDATA[Returns if the Unix part exists.]]></description>
2677
2693
<long-description><![CDATA[]]></long-description>
2678
<tag line="796" name="param" description="LDAP attributes" type="array" variable="$attrs">
2694
<tag line="856" name="param" description="LDAP attributes" type="array" variable="$attrs">
2679
2695
<type by_reference="false">array</type>
2680
2696
</tag>
2681
<tag line="796" name="return" description="Unix part exists" type="boolean">
2697
<tag line="856" name="return" description="Unix part exists" type="boolean">
2682
2698
<type by_reference="false">boolean</type>
2683
2699
</tag>
2684
2700
</docblock>
2685
<argument line="802">
2701
<argument line="862">
2686
2702
<name>$attrs</name>
2687
2703
<default><![CDATA[]]></default>
2688
2704
<type/>
2689
2705
</argument>
2690
2706
</method>
2691
<method final="false" abstract="false" static="true" visibility="public" namespace="global" line="812" package="lists">
2707
<method final="false" abstract="false" static="true" visibility="public" namespace="global" line="872" package="lists">
2692
2708
<name>isUnixLocked</name>
2693
2709
<full_name>isUnixLocked</full_name>
2694
<docblock line="806">
2710
<docblock line="866">
2695
2711
<description><![CDATA[Returns if the Unix part is locked.]]></description>
2696
2712
<long-description><![CDATA[]]></long-description>
2697
<tag line="806" name="param" description="LDAP attributes" type="array" variable="$attrs">
2713
<tag line="866" name="param" description="LDAP attributes" type="array" variable="$attrs">
2698
2714
<type by_reference="false">array</type>
2699
2715
</tag>
2700
<tag line="806" name="return" description="Unix part locked" type="boolean">
2716
<tag line="866" name="return" description="Unix part locked" type="boolean">
2701
2717
<type by_reference="false">boolean</type>
2702
2718
</tag>
2703
2719
</docblock>
2704
<argument line="812">
2720
<argument line="872">
2705
2721
<name>$attrs</name>
2706
2722
<default><![CDATA[]]></default>
2707
2723
<type/>
2708
2724
</argument>
2709
2725
</method>
2710
<method final="false" abstract="false" static="true" visibility="public" namespace="global" line="822" package="lists">
2726
<method final="false" abstract="false" static="true" visibility="public" namespace="global" line="882" package="lists">
2711
2727
<name>isSambaAvailable</name>
2712
2728
<full_name>isSambaAvailable</full_name>
2713
<docblock line="816">
2729
<docblock line="876">
2714
2730
<description><![CDATA[Returns if the Samba part exists.]]></description>
2715
2731
<long-description><![CDATA[]]></long-description>
2716
<tag line="816" name="param" description="LDAP attributes" type="array" variable="$attrs">
2732
<tag line="876" name="param" description="LDAP attributes" type="array" variable="$attrs">
2717
2733
<type by_reference="false">array</type>
2718
2734
</tag>
2719
<tag line="816" name="return" description="Samba part exists" type="boolean">
2735
<tag line="876" name="return" description="Samba part exists" type="boolean">
2720
2736
<type by_reference="false">boolean</type>
2721
2737
</tag>
2722
2738
</docblock>
2723
<argument line="822">
2739
<argument line="882">
2724
2740
<name>$attrs</name>
2725
2741
<default><![CDATA[]]></default>
2726
2742
<type/>
2727
2743
</argument>
2728
2744
</method>
2729
<method final="false" abstract="false" static="true" visibility="public" namespace="global" line="832" package="lists">
2745
<method final="false" abstract="false" static="true" visibility="public" namespace="global" line="892" package="lists">
2730
2746
<name>isSambaLocked</name>
2731
2747
<full_name>isSambaLocked</full_name>
2732
<docblock line="826">
2748
<docblock line="886">
2733
2749
<description><![CDATA[Returns if the Samba part is locked.]]></description>
2734
2750
<long-description><![CDATA[]]></long-description>
2735
<tag line="826" name="param" description="LDAP attributes" type="array" variable="$attrs">
2751
<tag line="886" name="param" description="LDAP attributes" type="array" variable="$attrs">
2736
2752
<type by_reference="false">array</type>
2737
2753
</tag>
2738
<tag line="826" name="return" description="Samba part is locked" type="boolean">
2754
<tag line="886" name="return" description="Samba part is locked" type="boolean">
2739
2755
<type by_reference="false">boolean</type>
2740
2756
</tag>
2741
2757
</docblock>
2742
<argument line="832">
2758
<argument line="892">
2743
2759
<name>$attrs</name>
2744
2760
<default><![CDATA[]]></default>
2745
2761
<type/>
2746
2762
</argument>
2747
2763
</method>
2748
<method final="false" abstract="false" static="true" visibility="public" namespace="global" line="842" package="lists">
2764
<method final="false" abstract="false" static="true" visibility="public" namespace="global" line="902" package="lists">
2749
2765
<name>isPPolicyAvailable</name>
2750
2766
<full_name>isPPolicyAvailable</full_name>
2751
<docblock line="836">
2767
<docblock line="896">
2752
2768
<description><![CDATA[Returns if the PPolicy part exists.]]></description>
2753
2769
<long-description><![CDATA[]]></long-description>
2754
<tag line="836" name="param" description="LDAP attributes" type="array" variable="$attrs">
2770
<tag line="896" name="param" description="LDAP attributes" type="array" variable="$attrs">
2755
2771
<type by_reference="false">array</type>
2756
2772
</tag>
2757
<tag line="836" name="return" description="PPolicy part exists" type="boolean">
2773
<tag line="896" name="return" description="PPolicy part exists" type="boolean">
2758
2774
<type by_reference="false">boolean</type>
2759
2775
</tag>
2760
2776
</docblock>
2761
<argument line="842">
2777
<argument line="902">
2762
2778
<name>$attrs</name>
2763
2779
<default><![CDATA[]]></default>
2764
2780
<type/>
2765
2781
</argument>
2766
2782
</method>
2767
<method final="false" abstract="false" static="true" visibility="public" namespace="global" line="852" package="lists">
2783
<method final="false" abstract="false" static="true" visibility="public" namespace="global" line="912" package="lists">
2768
2784
<name>isPPolicyLocked</name>
2769
2785
<full_name>isPPolicyLocked</full_name>
2770
<docblock line="846">
2786
<docblock line="906">
2771
2787
<description><![CDATA[Returns if the PPolicy part is locked.]]></description>
2772
2788
<long-description><![CDATA[]]></long-description>
2773
<tag line="846" name="param" description="LDAP attributes" type="array" variable="$attrs">
2774
<type by_reference="false">array</type>
2775
</tag>
2776
<tag line="846" name="return" description="PPolicy part is locked" type="boolean">
2777
<type by_reference="false">boolean</type>
2778
</tag>
2779
</docblock>
2780
<argument line="852">
2789
<tag line="906" name="param" description="LDAP attributes" type="array" variable="$attrs">
2790
<type by_reference="false">array</type>
2791
</tag>
2792
<tag line="906" name="return" description="PPolicy part is locked" type="boolean">
2793
<type by_reference="false">boolean</type>
2794
</tag>
2795
</docblock>
2796
<argument line="912">
2797
<name>$attrs</name>
2798
<default><![CDATA[]]></default>
2799
<type/>
2800
</argument>
2801
</method>
2802
<method final="false" abstract="false" static="true" visibility="public" namespace="global" line="922" package="lists">
2803
<name>isWindowsAvailable</name>
2804
<full_name>isWindowsAvailable</full_name>
2805
<docblock line="916">
2806
<description><![CDATA[Returns if the Windows part exists.]]></description>
2807
<long-description><![CDATA[]]></long-description>
2808
<tag line="916" name="param" description="LDAP attributes" type="array" variable="$attrs">
2809
<type by_reference="false">array</type>
2810
</tag>
2811
<tag line="916" name="return" description="Windows part exists" type="boolean">
2812
<type by_reference="false">boolean</type>
2813
</tag>
2814
</docblock>
2815
<argument line="922">
2816
<name>$attrs</name>
2817
<default><![CDATA[]]></default>
2818
<type/>
2819
</argument>
2820
</method>
2821
<method final="false" abstract="false" static="true" visibility="public" namespace="global" line="932" package="lists">
2822
<name>isWindowsLocked</name>
2823
<full_name>isWindowsLocked</full_name>
2824
<docblock line="926">
2825
<description><![CDATA[Returns if the Windows part is locked.]]></description>
2826
<long-description><![CDATA[]]></long-description>
2827
<tag line="926" name="param" description="LDAP attributes" type="array" variable="$attrs">
2828
<type by_reference="false">array</type>
2829
</tag>
2830
<tag line="926" name="return" description="Windows part is locked" type="boolean">
2831
<type by_reference="false">boolean</type>
2832
</tag>
2833
</docblock>
2834
<argument line="932">
2781
2835
<name>$attrs</name>
2782
2836
<default><![CDATA[]]></default>
2783
2837
<type/>
2785
2839
</method>
2786
2840
</class>
2787
2841
</file>
2788
<file path="lib/types/dhcp.inc" hash="46fa85f4ce2c0202f0e3eb0a2dea3100" package="types">
2842
<file path="lib/types/dhcp.inc" hash="937d4e7daae844244b6a4f708c0f5b8d" package="types">
2789
2843
<docblock line="26">
2790
2844
<description><![CDATA[The account type for DHCP]]></description>
2791
2845
<long-description><![CDATA[]]></long-description>
2980
3034
<type/>
2981
3035
</argument>
2982
3036
</method>
2983
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="254" package="lists">
3037
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="256" package="lists">
2984
3038
<name>listDoPost</name>
2985
3039
<full_name>listDoPost</full_name>
2986
3040
<docblock line="251">
2987
3041
<description><![CDATA[Manages all POST actions (e.g.]]></description>
2988
3042
<long-description><![CDATA[<p>button pressed) for the account lists.</p>]]></long-description>
3043
<tag line="251" name="return" description="HTML fragment to insert into beginning of account list" type="String">
3044
<type by_reference="false">String</type>
3045
</tag>
2989
3046
</docblock>
2990
3047
</method>
2991
3048
</class>
3139
3196
</method>
3140
3197
</class>
3141
3198
</file>
3142
<file path="lib/account.inc" hash="a250ed85a29786ab58f75afd2fdb8f34" package="lib">
3199
<file path="lib/account.inc" hash="5bbffef4d388a8acc1ae02eb26cd5391" package="lib">
3143
3200
<docblock line="25">
3144
3201
<description><![CDATA[This provides several helper function for the account modules.]]></description>
3145
3202
<long-description><![CDATA[]]></long-description>
3376
3433
<type/>
3377
3434
</argument>
3378
3435
</function>
3379
<function namespace="global" line="277" package="lib">
3436
<function namespace="global" line="278" package="lib">
3437
<name>pwd_is_lockable</name>
3438
<full_name>\pwd_is_lockable</full_name>
3439
<docblock line="271">
3440
<description><![CDATA[Checks if a Unix password can be locked.]]></description>
3441
<long-description><![CDATA[<p>This checks if the password is not plain text but e.g. contains {SSHA}.</p>]]></long-description>
3442
<tag line="271" name="param" description="password value" type="String" variable="$password">
3443
<type by_reference="false">String</type>
3444
</tag>
3445
<tag line="271" name="return" description="can be locked" type="boolean">
3446
<type by_reference="false">boolean</type>
3447
</tag>
3448
</docblock>
3449
<argument line="278">
3450
<name>$password</name>
3451
<default><![CDATA[]]></default>
3452
<type/>
3453
</argument>
3454
</function>
3455
<function namespace="global" line="291" package="lib">
3380
3456
<name>pwd_is_enabled</name>
3381
3457
<full_name>\pwd_is_enabled</full_name>
3382
<docblock line="271">
3458
<docblock line="285">
3383
3459
<description><![CDATA[Checks if a password hash is enabled/disabled]]></description>
3384
3460
<long-description><![CDATA[]]></long-description>
3385
<tag line="271" name="param" description="password hash to check" type="string" variable="$hash">
3461
<tag line="285" name="param" description="password hash to check" type="string" variable="$hash">
3386
3462
<type by_reference="false">string</type>
3387
3463
</tag>
3388
<tag line="271" name="return" description="true if the password is marked as enabled" type="boolean">
3464
<tag line="285" name="return" description="true if the password is marked as enabled" type="boolean">
3389
3465
<type by_reference="false">boolean</type>
3390
3466
</tag>
3391
3467
</docblock>
3392
<argument line="277">
3468
<argument line="291">
3393
3469
<name>$hash</name>
3394
3470
<default><![CDATA[]]></default>
3395
3471
<type/>
3396
3472
</argument>
3397
3473
</function>
3398
<function namespace="global" line="294" package="lib">
3474
<function namespace="global" line="308" package="lib">
3399
3475
<name>generateRandomPassword</name>
3400
3476
<full_name>\generateRandomPassword</full_name>
3401
<docblock line="289">
3477
<docblock line="303">
3402
3478
<description><![CDATA[Generates a random password with 12 digits.]]></description>
3403
3479
<long-description><![CDATA[]]></long-description>
3404
<tag line="289" name="return" description="password" type="String">
3480
<tag line="303" name="return" description="password" type="String">
3405
3481
<type by_reference="false">String</type>
3406
3482
</tag>
3407
3483
</docblock>
3408
3484
</function>
3409
<function namespace="global" line="322" package="lib">
3485
<function namespace="global" line="336" package="lib">
3410
3486
<name>search_domains</name>
3411
3487
<full_name>\search_domains</full_name>
3412
<docblock line="315">
3488
<docblock line="329">
3413
3489
<description><![CDATA[Returns an array with all Samba 3 domain entries under the given suffix]]></description>
3414
3490
<long-description><![CDATA[]]></long-description>
3415
<tag line="315" name="param" description="LDAP handle (if null then $_SESSION['ldap']->server() is used)" type="\handle" variable="$server">
3491
<tag line="329" name="param" description="LDAP handle (if null then $_SESSION['ldap']->server() is used)" type="\handle" variable="$server">
3416
3492
<type by_reference="false">\handle</type>
3417
3493
</tag>
3418
<tag line="315" name="param" description="LDAP suffix to search (if null then $_SESSION['config']->get_Suffix('smbDomain') is used)" type="String" variable="$suffix">
3494
<tag line="329" name="param" description="LDAP suffix to search (if null then $_SESSION['config']->get_Suffix('smbDomain') is used)" type="String" variable="$suffix">
3419
3495
<type by_reference="false">String</type>
3420
3496
</tag>
3421
<tag line="315" name="return" description="list of samba3domain objects" type="array">
3497
<tag line="329" name="return" description="list of samba3domain objects" type="array">
3422
3498
<type by_reference="false">array</type>
3423
3499
</tag>
3424
3500
</docblock>
3425
<argument line="322">
3501
<argument line="336">
3426
3502
<name>$server</name>
3427
3503
<default><![CDATA[null]]></default>
3428
3504
<type/>
3429
3505
</argument>
3430
<argument line="322">
3506
<argument line="336">
3431
3507
<name>$suffix</name>
3432
3508
<default><![CDATA[null]]></default>
3433
3509
<type/>
3434
3510
</argument>
3435
3511
</function>
3436
<function namespace="global" line="391" package="lib">
3512
<function namespace="global" line="405" package="lib">
3437
3513
<name>get_preg</name>
3438
3514
<full_name>\get_preg</full_name>
3439
<docblock line="384">
3515
<docblock line="398">
3440
3516
<description><![CDATA[Checks if a given value matches the selected regular expression.]]></description>
3441
3517
<long-description><![CDATA[]]></long-description>
3442
<tag line="384" name="param" description="value to check" type="string" variable="$argument">
3443
<type by_reference="false">string</type>
3444
</tag>
3445
<tag line="384" name="param" description="pattern name" type="string" variable="$regexp">
3446
<type by_reference="false">string</type>
3447
</tag>
3448
<tag line="384" name="return" description="true if matches, otherwise false" type="boolean">
3518
<tag line="398" name="param" description="value to check" type="string" variable="$argument">
3519
<type by_reference="false">string</type>
3520
</tag>
3521
<tag line="398" name="param" description="pattern name" type="string" variable="$regexp">
3522
<type by_reference="false">string</type>
3523
</tag>
3524
<tag line="398" name="return" description="true if matches, otherwise false" type="boolean">
3449
3525
<type by_reference="false">boolean</type>
3450
3526
</tag>
3451
3527
</docblock>
3452
<argument line="391">
3528
<argument line="405">
3453
3529
<name>$argument</name>
3454
3530
<default><![CDATA[]]></default>
3455
3531
<type/>
3456
3532
</argument>
3457
<argument line="391">
3533
<argument line="405">
3458
3534
<name>$regexp</name>
3459
3535
<default><![CDATA[]]></default>
3460
3536
<type/>
3461
3537
</argument>
3462
3538
</function>
3463
<function namespace="global" line="551" package="lib">
3539
<function namespace="global" line="565" package="lib">
3464
3540
<name>escapeDN</name>
3465
3541
<full_name>\escapeDN</full_name>
3466
<docblock line="545">
3542
<docblock line="559">
3467
3543
<description><![CDATA[Escapes any special characters in an LDAP DN.]]></description>
3468
3544
<long-description><![CDATA[]]></long-description>
3469
<tag line="545" name="param" description="DN" type="String" variable="$dn">
3545
<tag line="559" name="param" description="DN" type="String" variable="$dn">
3470
3546
<type by_reference="false">String</type>
3471
3547
</tag>
3472
<tag line="545" name="return" description="escaped DN" type="String">
3548
<tag line="559" name="return" description="escaped DN" type="String">
3473
3549
<type by_reference="false">String</type>
3474
3550
</tag>
3475
3551
</docblock>
3476
<argument line="551">
3552
<argument line="565">
3477
3553
<name>$dn</name>
3478
3554
<default><![CDATA[]]></default>
3479
3555
<type/>
3480
3556
</argument>
3481
3557
</function>
3482
<function namespace="global" line="570" package="lib">
3558
<function namespace="global" line="584" package="lib">
3483
3559
<name>searchLDAPByAttribute</name>
3484
3560
<full_name>\searchLDAPByAttribute</full_name>
3485
<docblock line="560">
3561
<docblock line="574">
3486
3562
<description><![CDATA[This will search the given LDAP suffix for all entries which have the given attribute.]]></description>
3487
3563
<long-description><![CDATA[]]></long-description>
3488
<tag line="560" name="param" description="attribute name (may be null)" type="String" variable="$name">
3489
<type by_reference="false">String</type>
3490
</tag>
3491
<tag line="560" name="param" description="attribute value" type="String" variable="$value">
3492
<type by_reference="false">String</type>
3493
</tag>
3494
<tag line="560" name="param" description="object class (may be null)" type="String" variable="$objectClass">
3495
<type by_reference="false">String</type>
3496
</tag>
3497
<tag line="560" name="param" description="list of attributes to return" type="array" variable="$attributes">
3498
<type by_reference="false">array</type>
3499
</tag>
3500
<tag line="560" name="param" description="account types" type="array" variable="$scopes">
3501
<type by_reference="false">array</type>
3502
</tag>
3503
<tag line="560" name="return" description="list of found entries" type="array">
3564
<tag line="574" name="param" description="attribute name (may be null)" type="String" variable="$name">
3565
<type by_reference="false">String</type>
3566
</tag>
3567
<tag line="574" name="param" description="attribute value" type="String" variable="$value">
3568
<type by_reference="false">String</type>
3569
</tag>
3570
<tag line="574" name="param" description="object class (may be null)" type="String" variable="$objectClass">
3571
<type by_reference="false">String</type>
3572
</tag>
3573
<tag line="574" name="param" description="list of attributes to return" type="array" variable="$attributes">
3574
<type by_reference="false">array</type>
3575
</tag>
3576
<tag line="574" name="param" description="account types" type="array" variable="$scopes">
3577
<type by_reference="false">array</type>
3578
</tag>
3579
<tag line="574" name="return" description="list of found entries" type="array">
3504
3580
<type by_reference="false">array</type>
3505
3581
</tag>
3506
3582
</docblock>
3507
<argument line="570">
3583
<argument line="584">
3508
3584
<name>$name</name>
3509
3585
<default><![CDATA[]]></default>
3510
3586
<type/>
3511
3587
</argument>
3512
<argument line="570">
3588
<argument line="584">
3513
3589
<name>$value</name>
3514
3590
<default><![CDATA[]]></default>
3515
3591
<type/>
3516
3592
</argument>
3517
<argument line="570">
3593
<argument line="584">
3518
3594
<name>$objectClass</name>
3519
3595
<default><![CDATA[]]></default>
3520
3596
<type/>
3521
3597
</argument>
3522
<argument line="570">
3598
<argument line="584">
3523
3599
<name>$attributes</name>
3524
3600
<default><![CDATA[]]></default>
3525
3601
<type/>
3526
3602
</argument>
3527
<argument line="570">
3603
<argument line="584">
3528
3604
<name>$scopes</name>
3529
3605
<default><![CDATA[]]></default>
3530
3606
<type/>
3531
3607
</argument>
3532
3608
</function>
3533
<function namespace="global" line="612" package="lib">
3609
<function namespace="global" line="626" package="lib">
3534
3610
<name>searchLDAPByFilter</name>
3535
3611
<full_name>\searchLDAPByFilter</full_name>
3536
<docblock line="603">
3612
<docblock line="617">
3537
3613
<description><![CDATA[This will search the given LDAP suffix for all entries which match the given filter.]]></description>
3538
3614
<long-description><![CDATA[]]></long-description>
3539
<tag line="603" name="param" description="" type="String" variable="$filter">
3615
<tag line="617" name="param" description="" type="String" variable="$filter">
3540
3616
<type by_reference="false">String</type>
3541
3617
</tag>
3542
<tag line="603" name="param" description="list of attributes to return" type="array" variable="$attributes">
3543
<type by_reference="false">array</type>
3544
</tag>
3545
<tag line="603" name="param" description="account types" type="array" variable="$scopes">
3546
<type by_reference="false">array</type>
3547
</tag>
3548
<tag line="603" name="param" description="get only attributes but no values (default: false)" type="boolean" variable="$attrsOnly">
3618
<tag line="617" name="param" description="list of attributes to return" type="array" variable="$attributes">
3619
<type by_reference="false">array</type>
3620
</tag>
3621
<tag line="617" name="param" description="account types" type="array" variable="$scopes">
3622
<type by_reference="false">array</type>
3623
</tag>
3624
<tag line="617" name="param" description="get only attributes but no values (default: false)" type="boolean" variable="$attrsOnly">
3549
3625
<type by_reference="false">boolean</type>
3550
3626
</tag>
3551
<tag line="603" name="return" description="list of found entries" type="array">
3627
<tag line="617" name="return" description="list of found entries" type="array">
3552
3628
<type by_reference="false">array</type>
3553
3629
</tag>
3554
3630
</docblock>
3555
<argument line="612">
3631
<argument line="626">
3556
3632
<name>$filter</name>
3557
3633
<default><![CDATA[]]></default>
3558
3634
<type/>
3559
3635
</argument>
3560
<argument line="612">
3636
<argument line="626">
3561
3637
<name>$attributes</name>
3562
3638
<default><![CDATA[]]></default>
3563
3639
<type/>
3564
3640
</argument>
3565
<argument line="612">
3641
<argument line="626">
3566
3642
<name>$scopes</name>
3567
3643
<default><![CDATA[]]></default>
3568
3644
<type/>
3569
3645
</argument>
3570
<argument line="612">
3646
<argument line="626">
3571
3647
<name>$attrsOnly</name>
3572
3648
<default><![CDATA[false]]></default>
3573
3649
<type/>
3574
3650
</argument>
3575
3651
</function>
3576
<function namespace="global" line="642" package="lib">
3652
<function namespace="global" line="656" package="lib">
3577
3653
<name>searchLDAP</name>
3578
3654
<full_name>\searchLDAP</full_name>
3579
<docblock line="634">
3655
<docblock line="648">
3580
3656
<description><![CDATA[Runs an LDAP search.]]></description>
3581
3657
<long-description><![CDATA[]]></long-description>
3582
<tag line="634" name="param" description="LDAP suffix" type="String" variable="$suffix">
3583
<type by_reference="false">String</type>
3584
</tag>
3585
<tag line="634" name="param" description="filter" type="String" variable="$filter">
3586
<type by_reference="false">String</type>
3587
</tag>
3588
<tag line="634" name="param" description="list of attributes to return" type="array" variable="$attributes">
3658
<tag line="648" name="param" description="LDAP suffix" type="String" variable="$suffix">
3659
<type by_reference="false">String</type>
3660
</tag>
3661
<tag line="648" name="param" description="filter" type="String" variable="$filter">
3662
<type by_reference="false">String</type>
3663
</tag>
3664
<tag line="648" name="param" description="list of attributes to return" type="array" variable="$attributes">
3589
3665
<type by_reference="false">array</type>
3590
3666
</tag>
3591
<tag line="634" name="return" description="list of found entries" type="array">
3667
<tag line="648" name="return" description="list of found entries" type="array">
3592
3668
<type by_reference="false">array</type>
3593
3669
</tag>
3594
3670
</docblock>
3595
<argument line="642">
3671
<argument line="656">
3596
3672
<name>$suffix</name>
3597
3673
<default><![CDATA[]]></default>
3598
3674
<type/>
3599
3675
</argument>
3600
<argument line="642">
3676
<argument line="656">
3601
3677
<name>$filter</name>
3602
3678
<default><![CDATA[]]></default>
3603
3679
<type/>
3604
3680
</argument>
3605
<argument line="642">
3681
<argument line="656">
3606
3682
<name>$attributes</name>
3607
3683
<default><![CDATA[]]></default>
3608
3684
<type/>
3609
3685
</argument>
3610
3686
</function>
3611
<function namespace="global" line="665" package="lib">
3687
<function namespace="global" line="679" package="lib">
3612
3688
<name>ldapGetDN</name>
3613
3689
<full_name>\ldapGetDN</full_name>
3614
<docblock line="657">
3690
<docblock line="671">
3615
3691
<description><![CDATA[Returns the given DN.]]></description>
3616
3692
<long-description><![CDATA[]]></long-description>
3617
<tag line="657" name="param" description="DN" type="String" variable="$dn">
3693
<tag line="671" name="param" description="DN" type="String" variable="$dn">
3618
3694
<type by_reference="false">String</type>
3619
3695
</tag>
3620
<tag line="657" name="param" description="list of attributes to fetch" type="array" variable="$attributes">
3696
<tag line="671" name="param" description="list of attributes to fetch" type="array" variable="$attributes">
3621
3697
<type by_reference="false">array</type>
3622
3698
</tag>
3623
<tag line="657" name="param" description="LDAP handle (optional for admin interface pages)" type="\handle" variable="$handle">
3699
<tag line="671" name="param" description="LDAP handle (optional for admin interface pages)" type="\handle" variable="$handle">
3624
3700
<type by_reference="false">\handle</type>
3625
3701
</tag>
3626
<tag line="657" name="return" description="attributes or null if not found" type="array">
3702
<tag line="671" name="return" description="attributes or null if not found" type="array">
3627
3703
<type by_reference="false">array</type>
3628
3704
</tag>
3629
3705
</docblock>
3630
<argument line="665">
3706
<argument line="679">
3631
3707
<name>$dn</name>
3632
3708
<default><![CDATA[]]></default>
3633
3709
<type/>
3634
3710
</argument>
3635
<argument line="665">
3711
<argument line="679">
3636
3712
<name>$attributes</name>
3637
3713
<default><![CDATA[array('dn')]]></default>
3638
3714
<type/>
3639
3715
</argument>
3640
<argument line="665">
3716
<argument line="679">
3641
3717
<name>$handle</name>
3642
3718
<default><![CDATA[null]]></default>
3643
3719
<type/>
3644
3720
</argument>
3645
3721
</function>
3646
<function namespace="global" line="687" package="lib">
3722
<function namespace="global" line="701" package="lib">
3647
3723
<name>getLastLDAPError</name>
3648
3724
<full_name>\getLastLDAPError</full_name>
3649
<docblock line="682">
3725
<docblock line="696">
3650
3726
<description><![CDATA[Returns the parameters for a StatusMessage of the last LDAP search.]]></description>
3651
3727
<long-description><![CDATA[]]></long-description>
3652
<tag line="682" name="return" description="parameters for StatusMessage or null if all was ok" type="array">
3728
<tag line="696" name="return" description="parameters for StatusMessage or null if all was ok" type="array">
3653
3729
<type by_reference="false">array</type>
3654
3730
</tag>
3655
3731
</docblock>
3656
3732
</function>
3657
<function namespace="global" line="716" package="lib">
3733
<function namespace="global" line="730" package="lib">
3658
3734
<name>cleanLDAPResult</name>
3659
3735
<full_name>\cleanLDAPResult</full_name>
3660
<docblock line="710">
3736
<docblock line="724">
3661
3737
<description><![CDATA[Cleans the result of an LDAP search.]]></description>
3662
3738
<long-description><![CDATA[<p>This will remove all 'count' entries and also all numeric array keys.</p>]]></long-description>
3663
<tag line="710" name="param" description="LDAP entries in format $entries[entry number][attribute name][attribute values]" type="array" variable="$entries">
3739
<tag line="724" name="param" description="LDAP entries in format $entries[entry number][attribute name][attribute values]" type="array" variable="$entries">
3664
3740
<type by_reference="false">array</type>
3665
3741
</tag>
3666
3742
</docblock>
3667
<argument line="716">
3743
<argument line="730">
3668
3744
<name>$entries</name>
3669
3745
<default><![CDATA[]]></default>
3670
3746
<type/>
3671
3747
</argument>
3672
3748
</function>
3673
<function namespace="global" line="747" package="lib">
3749
<function namespace="global" line="761" package="lib">
3674
3750
<name>getAbstractDN</name>
3675
3751
<full_name>\getAbstractDN</full_name>
3676
<docblock line="740">
3752
<docblock line="754">
3677
3753
<description><![CDATA[Transforms a DN into a more user friendly format.]]></description>
3678
3754
<long-description><![CDATA[<p>E.g. "dc=company,dc=de" is transformed to "company > de".</p>]]></long-description>
3679
<tag line="740" name="param" description="DN" type="String" variable="$dn">
3755
<tag line="754" name="param" description="DN" type="String" variable="$dn">
3680
3756
<type by_reference="false">String</type>
3681
3757
</tag>
3682
<tag line="740" name="return" description="transformed DN" type="String">
3758
<tag line="754" name="return" description="transformed DN" type="String">
3683
3759
<type by_reference="false">String</type>
3684
3760
</tag>
3685
3761
</docblock>
3686
<argument line="747">
3762
<argument line="761">
3687
3763
<name>$dn</name>
3688
3764
<default><![CDATA[]]></default>
3689
3765
<type/>
3690
3766
</argument>
3691
3767
</function>
3692
<function namespace="global" line="768" package="lib">
3768
<function namespace="global" line="782" package="lib">
3693
3769
<name>compareDN</name>
3694
3770
<full_name>\compareDN</full_name>
3695
<docblock line="761">
3771
<docblock line="775">
3696
3772
<description><![CDATA[Helper function to sort DNs.]]></description>
3697
3773
<long-description><![CDATA[]]></long-description>
3698
<tag line="761" name="param" description="first argument to compare" type="string" variable="$a">
3699
<type by_reference="false">string</type>
3700
</tag>
3701
<tag line="761" name="param" description="second argument to compare" type="string" variable="$b">
3702
<type by_reference="false">string</type>
3703
</tag>
3704
<tag line="761" name="return" description="0 if equal, 1 if $a is greater, -1 if $b is greater" type="integer">
3774
<tag line="775" name="param" description="first argument to compare" type="string" variable="$a">
3775
<type by_reference="false">string</type>
3776
</tag>
3777
<tag line="775" name="param" description="second argument to compare" type="string" variable="$b">
3778
<type by_reference="false">string</type>
3779
</tag>
3780
<tag line="775" name="return" description="0 if equal, 1 if $a is greater, -1 if $b is greater" type="integer">
3705
3781
<type by_reference="false">integer</type>
3706
3782
</tag>
3707
3783
</docblock>
3708
<argument line="768">
3784
<argument line="782">
3709
3785
<name>$a</name>
3710
3786
<default><![CDATA[]]></default>
3711
3787
<type/>
3712
3788
</argument>
3713
<argument line="768">
3789
<argument line="782">
3714
3790
<name>$b</name>
3715
3791
<default><![CDATA[]]></default>
3716
3792
<type/>
3717
3793
</argument>
3718
3794
</function>
3719
<function namespace="global" line="802" package="lib">
3795
<function namespace="global" line="816" package="lib">
3720
3796
<name>formatLDAPTimestamp</name>
3721
3797
<full_name>\formatLDAPTimestamp</full_name>
3722
<docblock line="796">
3798
<docblock line="810">
3723
3799
<description><![CDATA[Formats an LDAP time string (e.g.]]></description>
3724
3800
<long-description><![CDATA[<p>from createTimestamp).</p>]]></long-description>
3725
<tag line="796" name="param" description="LDAP time value" type="String" variable="$time">
3801
<tag line="810" name="param" description="LDAP time value" type="String" variable="$time">
3726
3802
<type by_reference="false">String</type>
3727
3803
</tag>
3728
<tag line="796" name="return" description="formated time" type="String">
3804
<tag line="810" name="return" description="formated time" type="String">
3729
3805
<type by_reference="false">String</type>
3730
3806
</tag>
3731
3807
</docblock>
3732
<argument line="802">
3808
<argument line="816">
3733
3809
<name>$time</name>
3734
3810
<default><![CDATA[]]></default>
3735
3811
<type/>
3736
3812
</argument>
3737
3813
</function>
3738
<function namespace="global" line="812" package="lib">
3814
<function namespace="global" line="826" package="lib">
3739
3815
<name>obfuscateText</name>
3740
3816
<full_name>\obfuscateText</full_name>
3741
<docblock line="807">
3817
<docblock line="821">
3742
3818
<description><![CDATA[Simple function to obfuscate strings.]]></description>
3743
3819
<long-description><![CDATA[]]></long-description>
3744
<tag line="807" name="param" description="text to obfuscate" type="String" variable="$text">
3820
<tag line="821" name="param" description="text to obfuscate" type="String" variable="$text">
3745
3821
<type by_reference="false">String</type>
3746
3822
</tag>
3747
3823
</docblock>
3748
<argument line="812">
3824
<argument line="826">
3749
3825
<name>$text</name>
3750
3826
<default><![CDATA[]]></default>
3751
3827
<type/>
3752
3828
</argument>
3753
3829
</function>
3754
<function namespace="global" line="824" package="lib">
3830
<function namespace="global" line="838" package="lib">
3755
3831
<name>deobfuscateText</name>
3756
3832
<full_name>\deobfuscateText</full_name>
3757
<docblock line="819">
3833
<docblock line="833">
3758
3834
<description><![CDATA[Simple function to deobfuscate strings.]]></description>
3759
3835
<long-description><![CDATA[]]></long-description>
3760
<tag line="819" name="param" description="text to deobfuscate" type="String" variable="$text">
3836
<tag line="833" name="param" description="text to deobfuscate" type="String" variable="$text">
3761
3837
<type by_reference="false">String</type>
3762
3838
</tag>
3763
3839
</docblock>
3764
<argument line="824">
3840
<argument line="838">
3765
3841
<name>$text</name>
3766
3842
<default><![CDATA[]]></default>
3767
3843
<type/>
3768
3844
</argument>
3769
3845
</function>
3770
<function namespace="global" line="837" package="lib">
3846
<function namespace="global" line="851" package="lib">
3771
3847
<name>isObfuscatedText</name>
3772
3848
<full_name>\isObfuscatedText</full_name>
3773
<docblock line="831">
3849
<docblock line="845">
3774
3850
<description><![CDATA[Checks if the given text is obfuscated.]]></description>
3775
3851
<long-description><![CDATA[]]></long-description>
3776
<tag line="831" name="param" description="text to check" type="String" variable="$text">
3852
<tag line="845" name="param" description="text to check" type="String" variable="$text">
3777
3853
<type by_reference="false">String</type>
3778
3854
</tag>
3779
<tag line="831" name="return" description="obfuscated or not" type="boolean">
3855
<tag line="845" name="return" description="obfuscated or not" type="boolean">
3780
3856
<type by_reference="false">boolean</type>
3781
3857
</tag>
3782
3858
</docblock>
3783
<argument line="837">
3859
<argument line="851">
3784
3860
<name>$text</name>
3785
3861
<default><![CDATA[]]></default>
3786
3862
<type/>
3787
3863
</argument>
3788
3864
</function>
3789
<function namespace="global" line="856" package="lib">
3865
<function namespace="global" line="870" package="lib">
3790
3866
<name>extractRDNAttribute</name>
3791
3867
<full_name>\extractRDNAttribute</full_name>
3792
<docblock line="850">
3868
<docblock line="864">
3793
3869
<description><![CDATA[Extracts the RDN attribute name from a given DN.]]></description>
3794
3870
<long-description><![CDATA[]]></long-description>
3795
<tag line="850" name="param" description="DN" type="String" variable="$dn">
3871
<tag line="864" name="param" description="DN" type="String" variable="$dn">
3796
3872
<type by_reference="false">String</type>
3797
3873
</tag>
3798
<tag line="850" name="return" description="RDN attribute name" type="String">
3874
<tag line="864" name="return" description="RDN attribute name" type="String">
3799
3875
<type by_reference="false">String</type>
3800
3876
</tag>
3801
3877
</docblock>
3802
<argument line="856">
3878
<argument line="870">
3803
3879
<name>$dn</name>
3804
3880
<default><![CDATA[]]></default>
3805
3881
<type/>
3806
3882
</argument>
3807
3883
</function>
3808
<function namespace="global" line="868" package="lib">
3884
<function namespace="global" line="882" package="lib">
3809
3885
<name>extractRDNValue</name>
3810
3886
<full_name>\extractRDNValue</full_name>
3811
<docblock line="862">
3887
<docblock line="876">
3812
3888
<description><![CDATA[Extracts the RDN attribute value from a given DN.]]></description>
3813
3889
<long-description><![CDATA[]]></long-description>
3814
<tag line="862" name="param" description="DN" type="String" variable="$dn">
3890
<tag line="876" name="param" description="DN" type="String" variable="$dn">
3815
3891
<type by_reference="false">String</type>
3816
3892
</tag>
3817
<tag line="862" name="return" description="RDN attribute value" type="String">
3893
<tag line="876" name="return" description="RDN attribute value" type="String">
3818
3894
<type by_reference="false">String</type>
3819
3895
</tag>
3820
3896
</docblock>
3821
<argument line="868">
3897
<argument line="882">
3822
3898
<name>$dn</name>
3823
3899
<default><![CDATA[]]></default>
3824
3900
<type/>
3825
3901
</argument>
3826
3902
</function>
3827
<function namespace="global" line="881" package="lib">
3903
<function namespace="global" line="895" package="lib">
3828
3904
<name>extractDNSuffix</name>
3829
3905
<full_name>\extractDNSuffix</full_name>
3830
<docblock line="874">
3906
<docblock line="888">
3831
3907
<description><![CDATA[Extracts the DN suffix from a given DN.]]></description>
3832
3908
<long-description><![CDATA[<p>E.g. ou=people,dc=test,dc=com will result in dc=test,dc=com.</p>]]></long-description>
3833
<tag line="874" name="param" description="DN" type="String" variable="$dn">
3909
<tag line="888" name="param" description="DN" type="String" variable="$dn">
3834
3910
<type by_reference="false">String</type>
3835
3911
</tag>
3836
<tag line="874" name="return" description="DN suffix" type="String">
3912
<tag line="888" name="return" description="DN suffix" type="String">
3837
3913
<type by_reference="false">String</type>
3838
3914
</tag>
3839
3915
</docblock>
3840
<argument line="881">
3916
<argument line="895">
3841
3917
<name>$dn</name>
3842
3918
<default><![CDATA[]]></default>
3843
3919
<type/>
3844
3920
</argument>
3845
3921
</function>
3846
<function namespace="global" line="893" package="lib">
3922
<function namespace="global" line="908" package="lib">
3847
3923
<name>sendPasswordMail</name>
3848
3924
<full_name>\sendPasswordMail</full_name>
3849
<docblock line="886">
3925
<docblock line="900">
3850
3926
<description><![CDATA[Sends the password mail.]]></description>
3851
3927
<long-description><![CDATA[]]></long-description>
3852
<tag line="886" name="param" description="new password" type="String" variable="$pwd">
3928
<tag line="900" name="param" description="new password" type="String" variable="$pwd">
3853
3929
<type by_reference="false">String</type>
3854
3930
</tag>
3855
<tag line="886" name="param" description="LDAP attributes of user" type="array" variable="$user">
3931
<tag line="900" name="param" description="LDAP attributes of user" type="array" variable="$user">
3856
3932
<type by_reference="false">array</type>
3857
3933
</tag>
3858
<tag line="886" name="return" description="list of arrays that can be used to create status messages" type="array">
3934
<tag line="900" name="param" description="recipient address (optional, $user['mail'][0] used by default)" type="String" variable="$recipient">
3935
<type by_reference="false">String</type>
3936
</tag>
3937
<tag line="900" name="return" description="list of arrays that can be used to create status messages" type="array">
3859
3938
<type by_reference="false">array</type>
3860
3939
</tag>
3861
3940
</docblock>
3862
<argument line="893">
3941
<argument line="908">
3863
3942
<name>$pwd</name>
3864
3943
<default><![CDATA[]]></default>
3865
3944
<type/>
3866
3945
</argument>
3867
<argument line="893">
3946
<argument line="908">
3868
3947
<name>$user</name>
3869
3948
<default><![CDATA[]]></default>
3870
3949
<type/>
3871
3950
</argument>
3951
<argument line="908">
3952
<name>$recipient</name>
3953
<default><![CDATA[null]]></default>
3954
<type/>
3955
</argument>
3872
3956
</function>
3873
<class final="false" abstract="false" namespace="global" line="354" package="modules">
3957
<class final="false" abstract="false" namespace="global" line="368" package="modules">
3874
3958
<extends/>
3875
3959
<name>samba3domain</name>
3876
3960
<full_name>\samba3domain</full_name>
3877
<docblock line="349">
3961
<docblock line="363">
3878
3962
<description><![CDATA[Represents a Samba 3 domain entry]]></description>
3879
3963
<long-description><![CDATA[]]></long-description>
3880
<tag line="349" name="package" description="modules"/>
3964
<tag line="363" name="package" description="modules"/>
3881
3965
</docblock>
3882
<property final="false" static="false" visibility="public" line="357" namespace="global" package="main">
3966
<property final="false" static="false" visibility="public" line="371" namespace="global" package="main">
3883
3967
<name>$dn</name>
3884
3968
<default><![CDATA[]]></default>
3885
<docblock line="356">
3969
<docblock line="370">
3886
3970
<description><![CDATA[DN]]></description>
3887
3971
<long-description><![CDATA[]]></long-description>
3888
3972
</docblock>
3889
3973
</property>
3890
<property final="false" static="false" visibility="public" line="360" namespace="global" package="main">
3974
<property final="false" static="false" visibility="public" line="374" namespace="global" package="main">
3891
3975
<name>$name</name>
3892
3976
<default><![CDATA[]]></default>
3893
<docblock line="359">
3977
<docblock line="373">
3894
3978
<description><![CDATA[Domain name]]></description>
3895
3979
<long-description><![CDATA[]]></long-description>
3896
3980
</docblock>
3897
3981
</property>
3898
<property final="false" static="false" visibility="public" line="363" namespace="global" package="main">
3982
<property final="false" static="false" visibility="public" line="377" namespace="global" package="main">
3899
3983
<name>$SID</name>
3900
3984
<default><![CDATA[]]></default>
3901
<docblock line="362">
3985
<docblock line="376">
3902
3986
<description><![CDATA[Domain SID]]></description>
3903
3987
<long-description><![CDATA[]]></long-description>
3904
3988
</docblock>
3905
3989
</property>
3906
<property final="false" static="false" visibility="public" line="366" namespace="global" package="main">
3990
<property final="false" static="false" visibility="public" line="380" namespace="global" package="main">
3907
3991
<name>$nextRID</name>
3908
3992
<default><![CDATA[]]></default>
3909
<docblock line="365">
3993
<docblock line="379">
3910
3994
<description><![CDATA[Next RID]]></description>
3911
3995
<long-description><![CDATA[]]></long-description>
3912
3996
</docblock>
3913
3997
</property>
3914
<property final="false" static="false" visibility="public" line="369" namespace="global" package="main">
3998
<property final="false" static="false" visibility="public" line="383" namespace="global" package="main">
3915
3999
<name>$nextUserRID</name>
3916
4000
<default><![CDATA[]]></default>
3917
<docblock line="368">
4001
<docblock line="382">
3918
4002
<description><![CDATA[Next user RID]]></description>
3919
4003
<long-description><![CDATA[]]></long-description>
3920
4004
</docblock>
3921
4005
</property>
3922
<property final="false" static="false" visibility="public" line="372" namespace="global" package="main">
4006
<property final="false" static="false" visibility="public" line="386" namespace="global" package="main">
3923
4007
<name>$nextGroupRID</name>
3924
4008
<default><![CDATA[]]></default>
3925
<docblock line="371">
4009
<docblock line="385">
3926
4010
<description><![CDATA[Next group RID]]></description>
3927
4011
<long-description><![CDATA[]]></long-description>
3928
4012
</docblock>
3929
4013
</property>
3930
<property final="false" static="false" visibility="public" line="375" namespace="global" package="main">
4014
<property final="false" static="false" visibility="public" line="389" namespace="global" package="main">
3931
4015
<name>$RIDbase</name>
3932
4016
<default><![CDATA[1000]]></default>
3933
<docblock line="374">
4017
<docblock line="388">
3934
4018
<description><![CDATA[RID base to calculate RIDs, default 1000]]></description>
3935
4019
<long-description><![CDATA[]]></long-description>
3936
4020
</docblock>
3937
4021
</property>
3938
<property final="false" static="false" visibility="public" line="378" namespace="global" package="main">
4022
<property final="false" static="false" visibility="public" line="392" namespace="global" package="main">
3939
4023
<name>$minPwdAge</name>
3940
4024
<default><![CDATA[]]></default>
3941
<docblock line="377">
4025
<docblock line="391">
3942
4026
<description><![CDATA[seconds after the password can be changed]]></description>
3943
4027
<long-description><![CDATA[]]></long-description>
3944
4028
</docblock>
3945
4029
</property>
3946
<property final="false" static="false" visibility="public" line="381" namespace="global" package="main">
4030
<property final="false" static="false" visibility="public" line="395" namespace="global" package="main">
3947
4031
<name>$maxPwdAge</name>
3948
4032
<default><![CDATA[]]></default>
3949
<docblock line="380">
4033
<docblock line="394">
3950
4034
<description><![CDATA[seconds after the password must be changed]]></description>
3951
4035
<long-description><![CDATA[]]></long-description>
3952
4036
</docblock>
3953
4037
</property>
3954
4038
</class>
4039
<class final="false" abstract="false" namespace="global" line="974" package="main">
4040
<extends/>
4041
<name>moduleCache</name>
4042
<full_name>\moduleCache</full_name>
4043
<docblock line="968">
4044
<description><![CDATA[Caches module objects.]]></description>
4045
<long-description><![CDATA[<p>This improves performance if the same module does not need to be created multiple times (calling get_metaData() each time).</p>]]></long-description>
4046
<tag line="968" name="author" description="Roland Gruber"/>
4047
</docblock>
4048
<property final="false" static="true" visibility="private" line="977" namespace="global" package="main">
4049
<name>$cache</name>
4050
<default><![CDATA[array()]]></default>
4051
<docblock line="976">
4052
<description><![CDATA[module cache ("name:scope" => module)]]></description>
4053
<long-description><![CDATA[]]></long-description>
4054
</docblock>
4055
</property>
4056
<method final="false" abstract="false" static="true" visibility="public" namespace="global" line="985" package="main">
4057
<name>getModule</name>
4058
<full_name>getModule</full_name>
4059
<docblock line="979">
4060
<description><![CDATA[Returns a new/cached module with the given name and scope.]]></description>
4061
<long-description><![CDATA[]]></long-description>
4062
<tag line="979" name="param" description="module name" type="String" variable="$name">
4063
<type by_reference="false">String</type>
4064
</tag>
4065
<tag line="979" name="param" description="module scope (e.g. user)" type="String" variable="$scope">
4066
<type by_reference="false">String</type>
4067
</tag>
4068
</docblock>
4069
<argument line="985">
4070
<name>$name</name>
4071
<default><![CDATA[]]></default>
4072
<type/>
4073
</argument>
4074
<argument line="985">
4075
<name>$scope</name>
4076
<default><![CDATA[]]></default>
4077
<type/>
4078
</argument>
4079
</method>
4080
</class>
3955
4081
</file>
3956
<file path="lib/html.inc" hash="44df86dacbf8c012fdd71ef40737ef10" package="metaHTML">
4082
<file path="lib/html.inc" hash="331cebdeb3e4a839c123cce7e29d7a1a" package="metaHTML">
3957
4083
<docblock line="24">
3958
4084
<description><![CDATA[Interface between modules and other parts of LAM.]]></description>
3959
4085
<long-description><![CDATA[]]></long-description>
4871
4997
<tag line="632" name="param" description="autocompletion starts after this number of caracters entered (default 1; 0 means immediate start)" type="int" variable="$minLength">
4872
4998
<type by_reference="false">int</type>
4873
4999
</tag>
4874
<tag line="632" name="param" description="allow multiple autocompletion values in the same fields" type="boolean" variable="$multiValue">
5000
<tag line="632" name="param" description="allow multiple autocompletion values in the same fields (default: false)" type="boolean" variable="$multiValue">
4875
5001
<type by_reference="false">boolean</type>
4876
5002
</tag>
4877
5003
<tag line="632" name="param" description="separator expression if multiple autocompletion values are allowed (default ",\s*")" type="String" variable="$multiSeparator">
9049
9175
</class>
9050
9176
<class final="false" abstract="false" namespace="global" line="2844" package="metaHTML">
9051
9177
<extends>\htmlElement</extends>
9178
<name>htmlEqualHeight</name>
9179
<full_name>\htmlEqualHeight</full_name>
9180
<docblock line="2839">
9181
<description><![CDATA[Sets all given elements to the same height.]]></description>
9182
<long-description><![CDATA[]]></long-description>
9183
<tag line="2839" name="package" description="metaHTML"/>
9184
</docblock>
9185
<property final="false" static="false" visibility="private" line="2847" namespace="global" package="main">
9186
<name>$elements</name>
9187
<default><![CDATA[array()]]></default>
9188
<docblock line="2846">
9189
<description><![CDATA[list of element IDs]]></description>
9190
<long-description><![CDATA[]]></long-description>
9191
</docblock>
9192
</property>
9193
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2854" package="metaHTML">
9194
<name>__construct</name>
9195
<full_name>__construct</full_name>
9196
<docblock line="2849">
9197
<description><![CDATA[Constructor.]]></description>
9198
<long-description><![CDATA[]]></long-description>
9199
<tag line="2849" name="param" description="list of element IDs" type="array" variable="$elements">
9200
<type by_reference="false">array</type>
9201
</tag>
9202
</docblock>
9203
<argument line="2854">
9204
<name>$elements</name>
9205
<default><![CDATA[]]></default>
9206
<type/>
9207
</argument>
9208
</method>
9209
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2871" package="metaHTML">
9210
<name>generateHTML</name>
9211
<full_name>generateHTML</full_name>
9212
<docblock line="2860">
9213
<description><![CDATA[Prints the HTML code for this element.]]></description>
9214
<long-description><![CDATA[]]></long-description>
9215
<tag line="2860" name="param" description="Name of account module" type="string" variable="$module">
9216
<type by_reference="false">string</type>
9217
</tag>
9218
<tag line="2860" name="param" description="List of meta-HTML elements" type="array" variable="$input">
9219
<type by_reference="false">array</type>
9220
</tag>
9221
<tag line="2860" name="param" description="List of values which override the defaults in $input (name => value)" type="array" variable="$values">
9222
<type by_reference="false">array</type>
9223
</tag>
9224
<tag line="2860" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
9225
<type by_reference="false">boolean</type>
9226
</tag>
9227
<tag line="2860" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
9228
<type by_reference="false">integer</type>
9229
</tag>
9230
<tag line="2860" name="param" description="Account type" type="string" variable="$scope">
9231
<type by_reference="false">string</type>
9232
</tag>
9233
<tag line="2860" name="return" description="List of input field names and their type (name => type)" type="array">
9234
<type by_reference="false">array</type>
9235
</tag>
9236
</docblock>
9237
<argument line="2871">
9238
<name>$module</name>
9239
<default><![CDATA[]]></default>
9240
<type/>
9241
</argument>
9242
<argument line="2871">
9243
<name>$input</name>
9244
<default><![CDATA[]]></default>
9245
<type/>
9246
</argument>
9247
<argument line="2871">
9248
<name>$values</name>
9249
<default><![CDATA[]]></default>
9250
<type/>
9251
</argument>
9252
<argument line="2871">
9253
<name>$restricted</name>
9254
<default><![CDATA[]]></default>
9255
<type/>
9256
</argument>
9257
<argument line="2871">
9258
<name>$tabindex</name>
9259
<default><![CDATA[]]></default>
9260
<type/>
9261
</argument>
9262
<argument line="2871">
9263
<name>$scope</name>
9264
<default><![CDATA[]]></default>
9265
<type/>
9266
</argument>
9267
</method>
9268
</class>
9269
<class final="false" abstract="false" namespace="global" line="2896" package="metaHTML">
9270
<extends>\htmlElement</extends>
9052
9271
<name>htmlSortableList</name>
9053
9272
<full_name>\htmlSortableList</full_name>
9054
<docblock line="2839">
9273
<docblock line="2891">
9055
9274
<description><![CDATA[Creates a list of elements that can be sorted by the user via drag'n'drop.]]></description>
9056
9275
<long-description><![CDATA[]]></long-description>
9057
<tag line="2839" name="package" description="metaHTML"/>
9276
<tag line="2891" name="package" description="metaHTML"/>
9058
9277
</docblock>
9059
<property final="false" static="false" visibility="private" line="2847" namespace="global" package="main">
9278
<property final="false" static="false" visibility="private" line="2899" namespace="global" package="main">
9060
9279
<name>$elements</name>
9061
9280
<default><![CDATA[array()]]></default>
9062
<docblock line="2846">
9281
<docblock line="2898">
9063
9282
<description><![CDATA[list of elements]]></description>
9064
9283
<long-description><![CDATA[]]></long-description>
9065
9284
</docblock>
9066
9285
</property>
9067
<property final="false" static="false" visibility="private" line="2849" namespace="global" package="main">
9286
<property final="false" static="false" visibility="private" line="2901" namespace="global" package="main">
9068
9287
<name>$id</name>
9069
9288
<default><![CDATA['']]></default>
9070
<docblock line="2848">
9289
<docblock line="2900">
9071
9290
<description><![CDATA[HTML ID]]></description>
9072
9291
<long-description><![CDATA[]]></long-description>
9073
9292
</docblock>
9074
9293
</property>
9075
<property final="false" static="false" visibility="private" line="2851" namespace="global" package="main">
9294
<property final="false" static="false" visibility="private" line="2903" namespace="global" package="main">
9076
9295
<name>$elementWidth</name>
9077
9296
<default><![CDATA['']]></default>
9078
<docblock line="2850">
9297
<docblock line="2902">
9079
9298
<description><![CDATA[element width]]></description>
9080
9299
<long-description><![CDATA[]]></long-description>
9081
9300
</docblock>
9082
9301
</property>
9083
<property final="false" static="false" visibility="private" line="2853" namespace="global" package="main">
9302
<property final="false" static="false" visibility="private" line="2905" namespace="global" package="main">
9084
9303
<name>$onUpdate</name>
9085
9304
<default><![CDATA[null]]></default>
9086
<docblock line="2852">
9305
<docblock line="2904">
9087
9306
<description><![CDATA[on update event]]></description>
9088
9307
<long-description><![CDATA[]]></long-description>
9089
9308
</docblock>
9090
9309
</property>
9091
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2862" package="metaHTML">
9310
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2914" package="metaHTML">
9092
9311
<name>__construct</name>
9093
9312
<full_name>__construct</full_name>
9094
<docblock line="2855">
9313
<docblock line="2907">
9095
9314
<description><![CDATA[Constructor.]]></description>
9096
9315
<long-description><![CDATA[]]></long-description>
9097
<tag line="2855" name="param" description="list of element IDs (HTML special chars must be escaped already)" type="array" variable="$elements">
9316
<tag line="2907" name="param" description="list of element IDs (HTML special chars must be escaped already)" type="array" variable="$elements">
9098
9317
<type by_reference="false">array</type>
9099
9318
</tag>
9100
<tag line="2855" name="param" description="HTML ID" type="String" variable="$id">
9319
<tag line="2907" name="param" description="HTML ID" type="String" variable="$id">
9101
9320
<type by_reference="false">String</type>
9102
9321
</tag>
9103
<tag line="2855" name="param" description="width of elements (default 250px)" type="String" variable="$elementWidth">
9322
<tag line="2907" name="param" description="width of elements (default 250px)" type="String" variable="$elementWidth">
9104
9323
<type by_reference="false">String</type>
9105
9324
</tag>
9106
9325
</docblock>
9107
<argument line="2862">
9326
<argument line="2914">
9108
9327
<name>$elements</name>
9109
9328
<default><![CDATA[]]></default>
9110
9329
<type/>
9111
9330
</argument>
9112
<argument line="2862">
9331
<argument line="2914">
9113
9332
<name>$id</name>
9114
9333
<default><![CDATA[]]></default>
9115
9334
<type/>
9116
9335
</argument>
9117
<argument line="2862">
9336
<argument line="2914">
9118
9337
<name>$elementWidth</name>
9119
9338
<default><![CDATA['250px']]></default>
9120
9339
<type/>
9121
9340
</argument>
9122
9341
</method>
9123
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2879" package="metaHTML">
9342
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2931" package="metaHTML">
9124
9343
<name>generateHTML</name>
9125
9344
<full_name>generateHTML</full_name>
9126
<docblock line="2868">
9345
<docblock line="2920">
9127
9346
<description><![CDATA[Prints the HTML code for this element.]]></description>
9128
9347
<long-description><![CDATA[]]></long-description>
9129
<tag line="2868" name="param" description="Name of account module" type="string" variable="$module">
9348
<tag line="2920" name="param" description="Name of account module" type="string" variable="$module">
9130
9349
<type by_reference="false">string</type>
9131
9350
</tag>
9132
<tag line="2868" name="param" description="List of meta-HTML elements" type="array" variable="$input">
9133
<type by_reference="false">array</type>
9134
</tag>
9135
<tag line="2868" name="param" description="List of values which override the defaults in $input (name => value)" type="array" variable="$values">
9136
<type by_reference="false">array</type>
9137
</tag>
9138
<tag line="2868" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
9351
<tag line="2920" name="param" description="List of meta-HTML elements" type="array" variable="$input">
9352
<type by_reference="false">array</type>
9353
</tag>
9354
<tag line="2920" name="param" description="List of values which override the defaults in $input (name => value)" type="array" variable="$values">
9355
<type by_reference="false">array</type>
9356
</tag>
9357
<tag line="2920" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
9139
9358
<type by_reference="false">boolean</type>
9140
9359
</tag>
9141
<tag line="2868" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
9360
<tag line="2920" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
9142
9361
<type by_reference="false">integer</type>
9143
9362
</tag>
9144
<tag line="2868" name="param" description="Account type" type="string" variable="$scope">
9363
<tag line="2920" name="param" description="Account type" type="string" variable="$scope">
9145
9364
<type by_reference="false">string</type>
9146
9365
</tag>
9147
<tag line="2868" name="return" description="List of input field names and their type (name => type)" type="array">
9366
<tag line="2920" name="return" description="List of input field names and their type (name => type)" type="array">
9148
9367
<type by_reference="false">array</type>
9149
9368
</tag>
9150
9369
</docblock>
9151
<argument line="2879">
9370
<argument line="2931">
9152
9371
<name>$module</name>
9153
9372
<default><![CDATA[]]></default>
9154
9373
<type/>
9155
9374
</argument>
9156
<argument line="2879">
9375
<argument line="2931">
9157
9376
<name>$input</name>
9158
9377
<default><![CDATA[]]></default>
9159
9378
<type/>
9160
9379
</argument>
9161
<argument line="2879">
9380
<argument line="2931">
9162
9381
<name>$values</name>
9163
9382
<default><![CDATA[]]></default>
9164
9383
<type/>
9165
9384
</argument>
9166
<argument line="2879">
9385
<argument line="2931">
9167
9386
<name>$restricted</name>
9168
9387
<default><![CDATA[]]></default>
9169
9388
<type/>
9170
9389
</argument>
9171
<argument line="2879">
9390
<argument line="2931">
9172
9391
<name>$tabindex</name>
9173
9392
<default><![CDATA[]]></default>
9174
9393
<type/>
9175
9394
</argument>
9176
<argument line="2879">
9395
<argument line="2931">
9177
9396
<name>$scope</name>
9178
9397
<default><![CDATA[]]></default>
9179
9398
<type/>
9180
9399
</argument>
9181
9400
</method>
9182
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2918" package="metaHTML">
9401
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2970" package="metaHTML">
9183
9402
<name>setOnUpdate</name>
9184
9403
<full_name>setOnUpdate</full_name>
9185
<docblock line="2911">
9404
<docblock line="2963">
9186
9405
<description><![CDATA[Sets the JS code that is executed when the element order was changed.]]></description>
9187
9406
<long-description><![CDATA[<p>The code can access the variables event and ui. See JQueryUI docs for details.
9188
9407
ui.item.data('posOrig') will contain the original position of the moved element.</p>]]></long-description>
9189
<tag line="2911" name="param" description="JS code" type="String" variable="$onUpdate">
9408
<tag line="2963" name="param" description="JS code" type="String" variable="$onUpdate">
9190
9409
<type by_reference="false">String</type>
9191
9410
</tag>
9192
9411
</docblock>
9193
<argument line="2918">
9412
<argument line="2970">
9194
9413
<name>$onUpdate</name>
9195
9414
<default><![CDATA[]]></default>
9196
9415
<type/>
9197
9416
</argument>
9198
9417
</method>
9199
9418
</class>
9419
<class final="false" abstract="false" namespace="global" line="2980" package="main">
9420
<extends>\htmlElement</extends>
9421
<name>htmlAccordion</name>
9422
<full_name>\htmlAccordion</full_name>
9423
<docblock line="2976">
9424
<description><![CDATA[Creates a list of content elements in accordion style.]]></description>
9425
<long-description><![CDATA[<p>HTML special characters must be escaped before providing to htmlAccordion.</p>]]></long-description>
9426
</docblock>
9427
<property final="false" static="false" visibility="private" line="2982" namespace="global" package="main">
9428
<name>$id</name>
9429
<default><![CDATA[null]]></default>
9430
</property>
9431
<property final="false" static="false" visibility="private" line="2983" namespace="global" package="main">
9432
<name>$elements</name>
9433
<default><![CDATA[null]]></default>
9434
</property>
9435
<property final="false" static="false" visibility="private" line="2984" namespace="global" package="main">
9436
<name>$openInitial</name>
9437
<default><![CDATA['1']]></default>
9438
</property>
9439
<property final="false" static="false" visibility="private" line="2985" namespace="global" package="main">
9440
<name>$collapsible</name>
9441
<default><![CDATA[false]]></default>
9442
</property>
9443
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2995" package="main">
9444
<name>__construct</name>
9445
<full_name>__construct</full_name>
9446
<docblock line="2987">
9447
<description><![CDATA[Constructor.]]></description>
9448
<long-description><![CDATA[]]></long-description>
9449
<tag line="2987" name="param" description="HTML ID" type="String" variable="$id">
9450
<type by_reference="false">String</type>
9451
</tag>
9452
<tag line="2987" name="param" description="list of content elements array('title' => htmlElement)" type="array" variable="$elements">
9453
<type by_reference="false">array</type>
9454
</tag>
9455
<tag line="2987" name="param" description="index of element that is initially opened (default: 0), set to 'false' to close all" type="String" variable="$openInitial">
9456
<type by_reference="false">String</type>
9457
</tag>
9458
<tag line="2987" name="param" description="specifies if all elements may be closed at the same time (default: false, true if $openInitial is false)" type="boolean" variable="$collapsible">
9459
<type by_reference="false">boolean</type>
9460
</tag>
9461
</docblock>
9462
<argument line="2995">
9463
<name>$id</name>
9464
<default><![CDATA[]]></default>
9465
<type/>
9466
</argument>
9467
<argument line="2995">
9468
<name>$elements</name>
9469
<default><![CDATA[]]></default>
9470
<type/>
9471
</argument>
9472
<argument line="2995">
9473
<name>$openInitial</name>
9474
<default><![CDATA['0']]></default>
9475
<type/>
9476
</argument>
9477
<argument line="2995">
9478
<name>$collapsible</name>
9479
<default><![CDATA[false]]></default>
9480
<type/>
9481
</argument>
9482
</method>
9483
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3018" package="main">
9484
<name>generateHTML</name>
9485
<full_name>generateHTML</full_name>
9486
<docblock line="3007">
9487
<description><![CDATA[Prints the HTML code for this element.]]></description>
9488
<long-description><![CDATA[]]></long-description>
9489
<tag line="3007" name="param" description="Name of account module" type="string" variable="$module">
9490
<type by_reference="false">string</type>
9491
</tag>
9492
<tag line="3007" name="param" description="List of meta-HTML elements" type="array" variable="$input">
9493
<type by_reference="false">array</type>
9494
</tag>
9495
<tag line="3007" name="param" description="List of values which override the defaults in $input (name => value)" type="array" variable="$values">
9496
<type by_reference="false">array</type>
9497
</tag>
9498
<tag line="3007" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
9499
<type by_reference="false">boolean</type>
9500
</tag>
9501
<tag line="3007" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
9502
<type by_reference="false">integer</type>
9503
</tag>
9504
<tag line="3007" name="param" description="Account type" type="string" variable="$scope">
9505
<type by_reference="false">string</type>
9506
</tag>
9507
<tag line="3007" name="return" description="List of input field names and their type (name => type)" type="array">
9508
<type by_reference="false">array</type>
9509
</tag>
9510
</docblock>
9511
<argument line="3018">
9512
<name>$module</name>
9513
<default><![CDATA[]]></default>
9514
<type/>
9515
</argument>
9516
<argument line="3018">
9517
<name>$input</name>
9518
<default><![CDATA[]]></default>
9519
<type/>
9520
</argument>
9521
<argument line="3018">
9522
<name>$values</name>
9523
<default><![CDATA[]]></default>
9524
<type/>
9525
</argument>
9526
<argument line="3018">
9527
<name>$restricted</name>
9528
<default><![CDATA[]]></default>
9529
<type/>
9530
</argument>
9531
<argument line="3018">
9532
<name>$tabindex</name>
9533
<default><![CDATA[]]></default>
9534
<type/>
9535
</argument>
9536
<argument line="3018">
9537
<name>$scope</name>
9538
<default><![CDATA[]]></default>
9539
<type/>
9540
</argument>
9541
</method>
9542
</class>
9200
9543
<parse_markers>
9201
9544
<error line="632" code="50014">Name of argument $multiSeparatorExp does not match with the DocBlock's name $multiSeparator in enableAutocompletion()</error>
9202
9545
<notice line="2705" code="50013">Parameter $classes could not be found in __construct()</notice>
9546
<error line="2982" code="50018">No DocBlock was found for property $id</error>
9547
<error line="2983" code="50018">No DocBlock was found for property $elements</error>
9548
<error line="2984" code="50018">No DocBlock was found for property $openInitial</error>
9549
<error line="2985" code="50018">No DocBlock was found for property $collapsible</error>
9203
9550
</parse_markers>
9204
9551
</file>
9205
9552
<file path="lib/upgrade.inc" hash="f34d33a378bf09e5cfbb1678d0153f68" package="main">
10982
11329
</argument>
10983
11330
</function>
10984
11331
</file>
10985
<file path="lib/selfService.inc" hash="71c292db44fee214012aa04011f45b1f" package="selfService">
11332
<file path="lib/selfService.inc" hash="c339ec506c13d42d9330d138ac2b66e6" package="selfService">
10986
11333
<docblock line="25">
10987
11334
<description><![CDATA[Interface between modules and self service pages.]]></description>
10988
11335
<long-description><![CDATA[<p>This file also includes the self service profile class and helper functions.</p>]]></long-description>
13581
13928
<error line="725" code="50010">No DocBlock was found for method utf8_to_codepoints()</error>
13582
13929
</parse_markers>
13583
13930
</file>
13584
<file path="lib/modules/asteriskAccount.inc" hash="19bd3e1f612ea7504492929b88bad762" package="modules">
13931
<file path="lib/modules/asteriskAccount.inc" hash="53af8bf48c1b4e24bbc23ff4761ca8e4" package="modules">
13585
13932
<docblock line="26">
13586
13933
<description><![CDATA[Manages the Asterisk extension of user accounts.]]></description>
13587
13934
<long-description><![CDATA[]]></long-description>
13677
14024
<long-description><![CDATA[]]></long-description>
13678
14025
</docblock>
13679
14026
</method>
13680
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1291" package="modules">
14027
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1233" package="modules">
13681
14028
<name>build_uploadAccounts</name>
13682
14029
<full_name>build_uploadAccounts</full_name>
13683
<docblock line="1282">
14030
<docblock line="1224">
13684
14031
<description><![CDATA[In this function the LDAP account is built up.]]></description>
13685
14032
<long-description><![CDATA[]]></long-description>
13686
<tag line="1282" name="param" description="list of hash arrays (name => value) from user input" type="array" variable="$rawAccounts">
13687
<type by_reference="false">array</type>
13688
</tag>
13689
<tag line="1282" name="param" description="list of IDs for column position (e.g. "posixAccount_uid" => 5)" type="array" variable="$ids">
13690
<type by_reference="false">array</type>
13691
</tag>
13692
<tag line="1282" name="param" description="list of hash arrays (name => value) which are later added to LDAP" type="array" variable="$partialAccounts">
13693
<type by_reference="false">array</type>
13694
</tag>
13695
<tag line="1282" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
13696
<type by_reference="false">array</type>
13697
</tag>
13698
<tag line="1282" name="return" description="list of error messages if any" type="array">
14033
<tag line="1224" name="param" description="list of hash arrays (name => value) from user input" type="array" variable="$rawAccounts">
14034
<type by_reference="false">array</type>
14035
</tag>
14036
<tag line="1224" name="param" description="list of IDs for column position (e.g. "posixAccount_uid" => 5)" type="array" variable="$ids">
14037
<type by_reference="false">array</type>
14038
</tag>
14039
<tag line="1224" name="param" description="list of hash arrays (name => value) which are later added to LDAP" type="array" variable="$partialAccounts">
14040
<type by_reference="false">array</type>
14041
</tag>
14042
<tag line="1224" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
14043
<type by_reference="false">array</type>
14044
</tag>
14045
<tag line="1224" name="return" description="list of error messages if any" type="array">
13699
14046
<type by_reference="false">array</type>
13700
14047
</tag>
13701
14048
</docblock>
13702
<argument line="1291">
14049
<argument line="1233">
13703
14050
<name>$rawAccounts</name>
13704
14051
<default><![CDATA[]]></default>
13705
14052
<type/>
13706
14053
</argument>
13707
<argument line="1291">
14054
<argument line="1233">
13708
14055
<name>$ids</name>
13709
14056
<default><![CDATA[]]></default>
13710
14057
<type/>
13711
14058
</argument>
13712
<argument line="1291">
14059
<argument line="1233">
13713
14060
<name>$partialAccounts</name>
13714
14061
<default><![CDATA[]]></default>
13715
14062
<type/>
13716
14063
</argument>
13717
<argument line="1291">
14064
<argument line="1233">
13718
14065
<name>$selectedModules</name>
13719
14066
<default><![CDATA[]]></default>
13720
14067
<type/>
13721
14068
</argument>
13722
14069
</method>
13723
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1505" package="modules">
14070
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1447" package="modules">
13724
14071
<name>managesPasswordAttributes</name>
13725
14072
<full_name>managesPasswordAttributes</full_name>
13726
<docblock line="1499">
14073
<docblock line="1441">
13727
14074
<description><![CDATA[This method specifies if a module manages password attributes.]]></description>
13728
14075
<long-description><![CDATA[]]></long-description>
13729
<tag line="1499" name="see" description="\global\passwordService::managesPasswordAttributes" refers="\global\passwordService::managesPasswordAttributes"/>
13730
<tag line="1499" name="return" description="true if this module manages password attributes" type="boolean">
14076
<tag line="1441" name="see" description="\global\passwordService::managesPasswordAttributes" refers="\global\passwordService::managesPasswordAttributes"/>
14077
<tag line="1441" name="return" description="true if this module manages password attributes" type="boolean">
13731
14078
<type by_reference="false">boolean</type>
13732
14079
</tag>
13733
14080
</docblock>
13734
14081
</method>
13735
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1517" package="modules">
14082
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1459" package="modules">
13736
14083
<name>supportsForcePasswordChange</name>
13737
14084
<full_name>supportsForcePasswordChange</full_name>
13738
<docblock line="1512">
14085
<docblock line="1454">
13739
14086
<description><![CDATA[Specifies if this module supports to force that a user must change his password on next login.]]></description>
13740
14087
<long-description><![CDATA[]]></long-description>
13741
<tag line="1512" name="return" description="force password change supported" type="boolean">
14088
<tag line="1454" name="return" description="force password change supported" type="boolean">
13742
14089
<type by_reference="false">boolean</type>
13743
14090
</tag>
13744
14091
</docblock>
13745
14092
</method>
13746
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1532" package="modules">
14093
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1474" package="modules">
13747
14094
<name>passwordChangeRequested</name>
13748
14095
<full_name>passwordChangeRequested</full_name>
13749
<docblock line="1521">
14096
<docblock line="1463">
13750
14097
<description><![CDATA[This function is called whenever the password should be changed.]]></description>
13751
14098
<long-description><![CDATA[<p>Account modules
13752
14099
must change their password attributes only if the modules list contains their module name.</p>]]></long-description>
13753
<tag line="1521" name="param" description="new password" type="String" variable="$password">
14100
<tag line="1463" name="param" description="new password" type="String" variable="$password">
13754
14101
<type by_reference="false">String</type>
13755
14102
</tag>
13756
<tag line="1521" name="param" description="list of modules for which the password should be changed" type="\$modules" variable="$modules">
14103
<tag line="1463" name="param" description="list of modules for which the password should be changed" type="\$modules" variable="$modules">
13757
14104
<type by_reference="false">\$modules</type>
13758
14105
</tag>
13759
<tag line="1521" name="param" description="force the user to change his password at next login" type="boolean" variable="$forcePasswordChange">
14106
<tag line="1463" name="param" description="force the user to change his password at next login" type="boolean" variable="$forcePasswordChange">
13760
14107
<type by_reference="false">boolean</type>
13761
14108
</tag>
13762
<tag line="1521" name="return" description="list of error messages if any as parameter array for StatusMessage e.g. return arrray(array('ERROR', 'Password change failed.'))" type="array">
14109
<tag line="1463" name="return" description="list of error messages if any as parameter array for StatusMessage e.g. return arrray(array('ERROR', 'Password change failed.'))" type="array">
13763
14110
<type by_reference="false">array</type>
13764
14111
</tag>
13765
<tag line="1521" name="see" description="\global\passwordService::passwordChangeRequested" refers="\global\passwordService::passwordChangeRequested"/>
14112
<tag line="1463" name="see" description="\global\passwordService::passwordChangeRequested" refers="\global\passwordService::passwordChangeRequested"/>
13766
14113
</docblock>
13767
<argument line="1532">
14114
<argument line="1474">
13768
14115
<name>$password</name>
13769
14116
<default><![CDATA[]]></default>
13770
14117
<type/>
13771
14118
</argument>
13772
<argument line="1532">
14119
<argument line="1474">
13773
14120
<name>$modules</name>
13774
14121
<default><![CDATA[]]></default>
13775
14122
<type/>
13776
14123
</argument>
13777
<argument line="1532">
14124
<argument line="1474">
13778
14125
<name>$forcePasswordChange</name>
13779
14126
<default><![CDATA[]]></default>
13780
14127
<type/>
13781
14128
</argument>
13782
14129
</method>
13783
<method final="false" abstract="false" static="true" visibility="public" namespace="global" line="1548" package="modules">
14130
<method final="false" abstract="false" static="true" visibility="public" namespace="global" line="1490" package="modules">
13784
14131
<name>buildPasswordString</name>
13785
14132
<full_name>buildPasswordString</full_name>
13786
<docblock line="1540">
14133
<docblock line="1482">
13787
14134
<description><![CDATA[Builds the password string for the password attribute.]]></description>
13788
14135
<long-description><![CDATA[]]></long-description>
13789
<tag line="1540" name="param" description="LDAP attributes" type="array" variable="$attributes">
13790
<type by_reference="false">array</type>
13791
</tag>
13792
<tag line="1540" name="param" description="module configuration settings" type="array" variable="$moduleSettings">
13793
<type by_reference="false">array</type>
13794
</tag>
13795
<tag line="1540" name="param" description="password" type="String" variable="$password">
14136
<tag line="1482" name="param" description="LDAP attributes" type="array" variable="$attributes">
14137
<type by_reference="false">array</type>
14138
</tag>
14139
<tag line="1482" name="param" description="module configuration settings" type="array" variable="$moduleSettings">
14140
<type by_reference="false">array</type>
14141
</tag>
14142
<tag line="1482" name="param" description="password" type="String" variable="$password">
13796
14143
<type by_reference="false">String</type>
13797
14144
</tag>
13798
<tag line="1540" name="return" description="value for password attribute" type="String">
14145
<tag line="1482" name="return" description="value for password attribute" type="String">
13799
14146
<type by_reference="false">String</type>
13800
14147
</tag>
13801
14148
</docblock>
13802
<argument line="1548">
14149
<argument line="1490">
13803
14150
<name>$attributes</name>
13804
14151
<default><![CDATA[]]></default>
13805
14152
<type/>
13806
14153
</argument>
13807
<argument line="1548">
14154
<argument line="1490">
13808
14155
<name>$moduleSettings</name>
13809
14156
<default><![CDATA[]]></default>
13810
14157
<type/>
13811
14158
</argument>
13812
<argument line="1548">
14159
<argument line="1490">
13813
14160
<name>$password</name>
13814
14161
<default><![CDATA[]]></default>
13815
14162
<type/>
13816
14163
</argument>
13817
14164
</method>
13818
<method final="false" abstract="false" static="true" visibility="private" namespace="global" line="1563" package="modules">
14165
<method final="false" abstract="false" static="true" visibility="private" namespace="global" line="1505" package="modules">
13819
14166
<name>hashPassword</name>
13820
14167
<full_name>hashPassword</full_name>
13821
<docblock line="1557">
14168
<docblock line="1499">
13822
14169
<description><![CDATA[Hashes a password value to Asterisk format.]]></description>
13823
14170
<long-description><![CDATA[]]></long-description>
13824
<tag line="1557" name="param" description="password" type="String" variable="$password">
14171
<tag line="1499" name="param" description="password" type="String" variable="$password">
13825
14172
<type by_reference="false">String</type>
13826
14173
</tag>
13827
<tag line="1557" name="return" description="hash" type="String">
14174
<tag line="1499" name="return" description="hash" type="String">
13828
14175
<type by_reference="false">String</type>
13829
14176
</tag>
13830
14177
</docblock>
13831
<argument line="1563">
14178
<argument line="1505">
13832
14179
<name>$password</name>
13833
14180
<default><![CDATA[]]></default>
13834
14181
<type/>
13835
14182
</argument>
13836
14183
</method>
13837
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1584" package="modules">
14184
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1526" package="modules">
13838
14185
<name>checkSelfServiceOptions</name>
13839
14186
<full_name>checkSelfServiceOptions</full_name>
13840
<docblock line="1567">
14187
<docblock line="1509">
13841
14188
<description><![CDATA[Checks if all input values are correct and returns the LDAP attributes which should be changed.]]></description>
13842
14189
<long-description><![CDATA[<p><br>Return values:
13843
14190
<br>messages: array of parameters to create status messages
13847
14194
<br>info: array of values with informational value (e.g. to be used later by pre/postModify actions)</p>
13848
14195
13849
14196
<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
13850
<tag line="1567" name="param" description="input fields" type="string" variable="$fields">
14197
<tag line="1509" name="param" description="input fields" type="string" variable="$fields">
13851
14198
<type by_reference="false">string</type>
13852
14199
</tag>
13853
<tag line="1567" name="param" description="LDAP attributes" type="array" variable="$attributes">
14200
<tag line="1509" name="param" description="LDAP attributes" type="array" variable="$attributes">
13854
14201
<type by_reference="false">array</type>
13855
14202
</tag>
13856
<tag line="1567" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
14203
<tag line="1509" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
13857
14204
<type by_reference="false">boolean</type>
13858
14205
</tag>
13859
<tag line="1567" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
14206
<tag line="1509" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
13860
14207
<type by_reference="false">array</type>
13861
14208
</tag>
13862
<tag line="1567" name="return" description="messages and attributes (array('messages' => array(), 'add' => array('mail' => array('test@test.com')), 'del' => array(), 'mod' => array(), 'info' => array()))" type="array">
14209
<tag line="1509" name="return" description="messages and attributes (array('messages' => array(), 'add' => array('mail' => array('test@test.com')), 'del' => array(), 'mod' => array(), 'info' => array()))" type="array">
13863
14210
<type by_reference="false">array</type>
13864
14211
</tag>
13865
14212
</docblock>
13866
<argument line="1584">
14213
<argument line="1526">
13867
14214
<name>$fields</name>
13868
14215
<default><![CDATA[]]></default>
13869
14216
<type/>
13870
14217
</argument>
13871
<argument line="1584">
14218
<argument line="1526">
13872
14219
<name>$attributes</name>
13873
14220
<default><![CDATA[]]></default>
13874
14221
<type/>
13875
14222
</argument>
13876
<argument line="1584">
14223
<argument line="1526">
13877
14224
<name>$passwordChangeOnly</name>
13878
14225
<default><![CDATA[]]></default>
13879
14226
<type/>
13880
14227
</argument>
13881
<argument line="1584">
14228
<argument line="1526">
13882
14229
<name>$readOnlyFields</name>
13883
14230
<default><![CDATA[]]></default>
13884
14231
<type/>
13886
14233
</method>
13887
14234
</class>
13888
14235
</file>
13889
<file path="lib/modules/account.inc" hash="9a9a2f902ee86b1c0e5d8bad24b4a069" package="modules">
14236
<file path="lib/modules/account.inc" hash="edf7f37ce9556d6c6cecb5d59af40def" package="modules">
13890
14237
<docblock line="24">
13891
14238
<description><![CDATA[Manages the object class "account" for users and hosts.]]></description>
13892
14239
<long-description><![CDATA[]]></long-description>
13990
14337
</tag>
13991
14338
</docblock>
13992
14339
</method>
13993
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="256" package="modules">
14340
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="252" package="modules">
13994
14341
<name>get_uploadColumns</name>
13995
14342
<full_name>get_uploadColumns</full_name>
13996
<docblock line="241">
14343
<docblock line="237">
13997
14344
<description><![CDATA[Returns an array containing all input columns for the file upload.]]></description>
13998
14345
<long-description><![CDATA[<p>Syntax:
13999
14346
<br> array(
14003
14350
<br> string: example, // example value
14004
14351
<br> boolean: required // true, if user must set a value for this column
14005
14352
<br> )</p>]]></long-description>
14006
<tag line="241" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
14353
<tag line="237" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
14007
14354
<type by_reference="false">array</type>
14008
14355
</tag>
14009
<tag line="241" name="return" description="column list" type="array">
14356
<tag line="237" name="return" description="column list" type="array">
14010
14357
<type by_reference="false">array</type>
14011
14358
</tag>
14012
14359
</docblock>
14013
<argument line="256">
14360
<argument line="252">
14014
14361
<name>$selectedModules</name>
14015
14362
<default><![CDATA[]]></default>
14016
14363
<type/>
14017
14364
</argument>
14018
14365
</method>
14019
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="278" package="modules">
14366
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="274" package="modules">
14020
14367
<name>build_uploadAccounts</name>
14021
14368
<full_name>build_uploadAccounts</full_name>
14022
<docblock line="269">
14369
<docblock line="265">
14023
14370
<description><![CDATA[In this function the LDAP account is built up.]]></description>
14024
14371
<long-description><![CDATA[]]></long-description>
14025
<tag line="269" name="param" description="list of hash arrays (name => value) from user input" type="array" variable="$rawAccounts">
14026
<type by_reference="false">array</type>
14027
</tag>
14028
<tag line="269" name="param" description="list of IDs for column position (e.g. "posixAccount_uid" => 5)" type="array" variable="$ids">
14029
<type by_reference="false">array</type>
14030
</tag>
14031
<tag line="269" name="param" description="list of hash arrays (name => value) which are later added to LDAP" type="array" variable="$partialAccounts">
14032
<type by_reference="false">array</type>
14033
</tag>
14034
<tag line="269" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
14035
<type by_reference="false">array</type>
14036
</tag>
14037
<tag line="269" name="return" description="list of error messages if any" type="array">
14372
<tag line="265" name="param" description="list of hash arrays (name => value) from user input" type="array" variable="$rawAccounts">
14373
<type by_reference="false">array</type>
14374
</tag>
14375
<tag line="265" name="param" description="list of IDs for column position (e.g. "posixAccount_uid" => 5)" type="array" variable="$ids">
14376
<type by_reference="false">array</type>
14377
</tag>
14378
<tag line="265" name="param" description="list of hash arrays (name => value) which are later added to LDAP" type="array" variable="$partialAccounts">
14379
<type by_reference="false">array</type>
14380
</tag>
14381
<tag line="265" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
14382
<type by_reference="false">array</type>
14383
</tag>
14384
<tag line="265" name="return" description="list of error messages if any" type="array">
14038
14385
<type by_reference="false">array</type>
14039
14386
</tag>
14040
14387
</docblock>
14041
<argument line="278">
14388
<argument line="274">
14042
14389
<name>$rawAccounts</name>
14043
14390
<default><![CDATA[]]></default>
14044
14391
<type/>
14045
14392
</argument>
14046
<argument line="278">
14393
<argument line="274">
14047
14394
<name>$ids</name>
14048
14395
<default><![CDATA[]]></default>
14049
14396
<type/>
14050
14397
</argument>
14051
<argument line="278">
14398
<argument line="274">
14052
14399
<name>$partialAccounts</name>
14053
14400
<default><![CDATA[]]></default>
14054
14401
<type/>
14055
14402
</argument>
14056
<argument line="278">
14403
<argument line="274">
14057
14404
<name>$selectedModules</name>
14058
14405
<default><![CDATA[]]></default>
14059
14406
<type/>
14061
14408
</method>
14062
14409
</class>
14063
14410
</file>
14064
<file path="lib/modules/ieee802device.inc" hash="4a7c2dc85fbeae64a400b2e99c2e846f" package="modules">
14411
<file path="lib/modules/ieee802device.inc" hash="9f721a849ac00bae33a375c7b4a8df2d" package="modules">
14065
14412
<docblock line="23">
14066
14413
<description><![CDATA[Provides MAC addresses for hosts.]]></description>
14067
14414
<long-description><![CDATA[]]></long-description>
14070
14417
</docblock>
14071
14418
<class final="false" abstract="false" namespace="global" line="35" package="modules">
14072
14419
<extends>\baseModule</extends>
14073
<name>ieee802Device</name>
14074
<full_name>\ieee802Device</full_name>
14420
<name>ieee802device</name>
14421
<full_name>\ieee802device</full_name>
14075
14422
<docblock line="30">
14076
14423
<description><![CDATA[Provides MAC addresses for hosts.]]></description>
14077
14424
<long-description><![CDATA[]]></long-description>
14175
14522
</method>
14176
14523
</class>
14177
14524
</file>
14178
<file path="lib/modules/puppetClient.inc" hash="f0c03e0ac09f399945720f4d0a77b08c" package="modules">
14525
<file path="lib/modules/puppetClient.inc" hash="e58bff948676091c09a3137bedc249c5" package="modules">
14179
14526
<docblock line="25">
14180
14527
<description><![CDATA[Manages Puppet configuration options.]]></description>
14181
14528
<long-description><![CDATA[]]></long-description>
14313
14660
</tag>
14314
14661
</docblock>
14315
14662
</method>
14316
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="458" package="modules">
14663
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="455" package="modules">
14317
14664
<name>get_profileOptions</name>
14318
14665
<full_name>get_profileOptions</full_name>
14319
<docblock line="443">
14666
<docblock line="440">
14320
14667
<description><![CDATA[This function defines what attributes will be used in the account profiles and their appearance in the profile editor.]]></description>
14321
14668
<long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
14322
14669
<br>
14324
14671
The field name are used as keywords to load
14325
14672
and save profiles. We recommend to use the module name as prefix for them
14326
14673
(e.g. posixAccount_homeDirectory) to avoid naming conflicts.</p>]]></long-description>
14327
<tag line="443" name="return" description="meta HTML object" type="\htmlElement">
14674
<tag line="440" name="return" description="meta HTML object" type="\htmlElement">
14328
14675
<type by_reference="false">\htmlElement</type>
14329
14676
</tag>
14330
<tag line="443" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
14331
<tag line="443" name="see" description="\global\htmlElement" refers="\global\htmlElement"/>
14677
<tag line="440" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
14678
<tag line="440" name="see" description="\global\htmlElement" refers="\global\htmlElement"/>
14332
14679
</docblock>
14333
14680
</method>
14334
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="472" package="modules">
14681
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="469" package="modules">
14335
14682
<name>load_profile</name>
14336
14683
<full_name>load_profile</full_name>
14337
<docblock line="467">
14684
<docblock line="464">
14338
14685
<description><![CDATA[Loads the values of an account profile into internal variables.]]></description>
14339
14686
<long-description><![CDATA[]]></long-description>
14340
<tag line="467" name="param" description="hash array with profile values (identifier => value)" type="array" variable="$profile">
14687
<tag line="464" name="param" description="hash array with profile values (identifier => value)" type="array" variable="$profile">
14341
14688
<type by_reference="false">array</type>
14342
14689
</tag>
14343
14690
</docblock>
14344
<argument line="472">
14691
<argument line="469">
14345
14692
<name>$profile</name>
14346
14693
<default><![CDATA[]]></default>
14347
14694
<type/>
14348
14695
</argument>
14349
14696
</method>
14350
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="500" package="modules">
14697
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="497" package="modules">
14351
14698
<name>getPossibleParentNodes</name>
14352
14699
<full_name>getPossibleParentNodes</full_name>
14353
<docblock line="495">
14700
<docblock line="492">
14354
14701
<description><![CDATA[Reurns a list of valid parent nodes for this node.]]></description>
14355
14702
<long-description><![CDATA[]]></long-description>
14356
<tag line="495" name="return" description="parent nodes (e.g. array('node1', 'node2'))" type="array">
14357
<type by_reference="false">array</type>
14358
</tag>
14359
</docblock>
14360
</method>
14361
</class>
14362
</file>
14363
<file path="lib/modules/posixGroup.inc" hash="6edd070232a97b3da33d42e819393ff2" package="modules">
14703
<tag line="492" name="return" description="parent nodes (e.g. array('node1', 'node2'))" type="array">
14704
<type by_reference="false">array</type>
14705
</tag>
14706
</docblock>
14707
</method>
14708
</class>
14709
</file>
14710
<file path="lib/modules/windowsHost.inc" hash="df1c33c3581f4c43bb5845b55b7911c1" package="modules">
14711
<docblock line="23">
14712
<description><![CDATA[Manages Windows AD (e.g.]]></description>
14713
<long-description><![CDATA[<p>Samba 4) hosts.</p>]]></long-description>
14714
<tag line="23" name="package" description="modules"/>
14715
<tag line="23" name="author" description="Roland Gruber"/>
14716
</docblock>
14717
<class final="false" abstract="false" namespace="global" line="35" package="modules">
14718
<extends>\baseModule</extends>
14719
<name>windowsHost</name>
14720
<full_name>\windowsHost</full_name>
14721
<docblock line="30">
14722
<description><![CDATA[Manages Windows AD (e.g.]]></description>
14723
<long-description><![CDATA[<p>Samba 4) hosts.</p>]]></long-description>
14724
<tag line="30" name="package" description="modules"/>
14725
</docblock>
14726
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="44" package="modules">
14727
<name>get_metaData</name>
14728
<full_name>get_metaData</full_name>
14729
<docblock line="37">
14730
<description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
14731
<long-description><![CDATA[]]></long-description>
14732
<tag line="37" name="return" description="array with meta data" type="array">
14733
<type by_reference="false">array</type>
14734
</tag>
14735
<tag line="37" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
14736
</docblock>
14737
</method>
14738
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="123" package="modules">
14739
<name>load_Messages</name>
14740
<full_name>load_Messages</full_name>
14741
<docblock line="120">
14742
<description><![CDATA[This function fills the $messages variable with output messages from this module.]]></description>
14743
<long-description><![CDATA[]]></long-description>
14744
</docblock>
14745
</method>
14746
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="133" package="modules">
14747
<name>display_html_attributes</name>
14748
<full_name>display_html_attributes</full_name>
14749
<docblock line="128">
14750
<description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
14751
<long-description><![CDATA[]]></long-description>
14752
<tag line="128" name="return" description="HTML meta data" type="\htmlElement">
14753
<type by_reference="false">\htmlElement</type>
14754
</tag>
14755
</docblock>
14756
</method>
14757
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="163" package="modules">
14758
<name>process_attributes</name>
14759
<full_name>process_attributes</full_name>
14760
<docblock line="157">
14761
<description><![CDATA[Processes user input of the primary module page.]]></description>
14762
<long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
14763
<tag line="157" name="return" description="list of info/error messages" type="array">
14764
<type by_reference="false">array</type>
14765
</tag>
14766
</docblock>
14767
</method>
14768
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="190" package="modules">
14769
<name>display_html_managedBy</name>
14770
<full_name>display_html_managedBy</full_name>
14771
<docblock line="185">
14772
<description><![CDATA[This function will create the meta HTML code to show a page to change the member attribute.]]></description>
14773
<long-description><![CDATA[]]></long-description>
14774
<tag line="185" name="return" description="HTML meta data" type="\htmlElement">
14775
<type by_reference="false">\htmlElement</type>
14776
</tag>
14777
</docblock>
14778
</method>
14779
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="230" package="modules">
14780
<name>process_managedBy</name>
14781
<full_name>process_managedBy</full_name>
14782
<docblock line="224">
14783
<description><![CDATA[Processes user input of the members page.]]></description>
14784
<long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
14785
<tag line="224" name="return" description="list of info/error messages" type="array">
14786
<type by_reference="false">array</type>
14787
</tag>
14788
</docblock>
14789
</method>
14790
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="247" package="modules">
14791
<name>build_uploadAccounts</name>
14792
<full_name>build_uploadAccounts</full_name>
14793
<docblock line="238">
14794
<description><![CDATA[In this function the LDAP account is built up.]]></description>
14795
<long-description><![CDATA[]]></long-description>
14796
<tag line="238" name="param" description="list of hash arrays (name => value) from user input" type="array" variable="$rawAccounts">
14797
<type by_reference="false">array</type>
14798
</tag>
14799
<tag line="238" name="param" description="list of IDs for column position (e.g. "posixAccount_uid" => 5)" type="array" variable="$ids">
14800
<type by_reference="false">array</type>
14801
</tag>
14802
<tag line="238" name="param" description="list of hash arrays (name => value) which are later added to LDAP" type="array" variable="$partialAccounts">
14803
<type by_reference="false">array</type>
14804
</tag>
14805
<tag line="238" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
14806
<type by_reference="false">array</type>
14807
</tag>
14808
<tag line="238" name="return" description="list of error messages if any" type="array">
14809
<type by_reference="false">array</type>
14810
</tag>
14811
</docblock>
14812
<argument line="247">
14813
<name>$rawAccounts</name>
14814
<default><![CDATA[]]></default>
14815
<type/>
14816
</argument>
14817
<argument line="247">
14818
<name>$ids</name>
14819
<default><![CDATA[]]></default>
14820
<type/>
14821
</argument>
14822
<argument line="247">
14823
<name>$partialAccounts</name>
14824
<default><![CDATA[]]></default>
14825
<type/>
14826
</argument>
14827
<argument line="247">
14828
<name>$selectedModules</name>
14829
<default><![CDATA[]]></default>
14830
<type/>
14831
</argument>
14832
</method>
14833
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="285" package="modules">
14834
<name>get_pdfEntries</name>
14835
<full_name>get_pdfEntries</full_name>
14836
<docblock line="282">
14837
<description><![CDATA[Returns a list of PDF entries]]></description>
14838
<long-description><![CDATA[]]></long-description>
14839
</docblock>
14840
</method>
14841
</class>
14842
</file>
14843
<file path="lib/modules/posixGroup.inc" hash="067998c892e4919040ba34c75cc0413a" package="modules">
14364
14844
<docblock line="25">
14365
14845
<description><![CDATA[Manages Unix accounts for groups.]]></description>
14366
14846
<long-description><![CDATA[]]></long-description>
14504
14984
</tag>
14505
14985
</docblock>
14506
14986
</method>
14507
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="289" package="modules">
14987
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="319" package="modules">
14508
14988
<name>get_metaData</name>
14509
14989
<full_name>get_metaData</full_name>
14510
<docblock line="284">
14990
<docblock line="314">
14511
14991
<description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
14512
14992
<long-description><![CDATA[]]></long-description>
14513
<tag line="284" name="return" description="array with meta data" type="array">
14993
<tag line="314" name="return" description="array with meta data" type="array">
14514
14994
<type by_reference="false">array</type>
14515
14995
</tag>
14516
14996
</docblock>
14517
14997
</method>
14518
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="449" package="modules">
14998
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="484" package="modules">
14519
14999
<name>get_configOptions</name>
14520
15000
<full_name>get_configOptions</full_name>
14521
<docblock line="442">
15001
<docblock line="477">
14522
15002
<description><![CDATA[Returns a list of elements for the configuration.]]></description>
14523
15003
<long-description><![CDATA[]]></long-description>
14524
<tag line="442" name="param" description="account types (user, group, host)" type="array" variable="$scopes">
14525
<type by_reference="false">array</type>
14526
</tag>
14527
<tag line="442" name="param" description="list of all modules and active scopes" type="array" variable="$allScopes">
14528
<type by_reference="false">array</type>
14529
</tag>
14530
<tag line="442" name="return" description="configuration elements" type="array">
15004
<tag line="477" name="param" description="account types (user, group, host)" type="array" variable="$scopes">
15005
<type by_reference="false">array</type>
15006
</tag>
15007
<tag line="477" name="param" description="list of all modules and active scopes" type="array" variable="$allScopes">
15008
<type by_reference="false">array</type>
15009
</tag>
15010
<tag line="477" name="return" description="configuration elements" type="array">
14531
15011
<type by_reference="false">array</type>
14532
15012
</tag>
14533
15013
</docblock>
14534
<argument line="449">
15014
<argument line="484">
14535
15015
<name>$scopes</name>
14536
15016
<default><![CDATA[]]></default>
14537
15017
<type/>
14538
15018
</argument>
14539
<argument line="449">
15019
<argument line="484">
14540
15020
<name>$allScopes</name>
14541
15021
<default><![CDATA[]]></default>
14542
15022
<type/>
14543
15023
</argument>
14544
15024
</method>
14545
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="463" package="modules">
15025
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="498" package="modules">
14546
15026
<name>get_pdfEntries</name>
14547
15027
<full_name>get_pdfEntries</full_name>
14548
<docblock line="458">
15028
<docblock line="493">
14549
15029
<description><![CDATA[Returns the PDF entries for this module.]]></description>
14550
15030
<long-description><![CDATA[]]></long-description>
14551
<tag line="458" name="return" description="list of possible PDF entries" type="array">
15031
<tag line="493" name="return" description="list of possible PDF entries" type="array">
14552
15032
<type by_reference="false">array</type>
14553
15033
</tag>
14554
15034
</docblock>
14555
15035
</method>
14556
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="482" package="modules">
15036
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="518" package="modules">
14557
15037
<name>init</name>
14558
15038
<full_name>init</full_name>
14559
<docblock line="477">
15039
<docblock line="513">
14560
15040
<description><![CDATA[This functin will be called when the module will be loaded]]></description>
14561
15041
<long-description><![CDATA[]]></long-description>
14562
<tag line="477" name="param" description="the name of the {@link accountContainer} object ($_SESSION[$base])" type="String" variable="$base">
15042
<tag line="513" name="param" description="the name of the {@link accountContainer} object ($_SESSION[$base])" type="String" variable="$base">
14563
15043
<type by_reference="false">String</type>
14564
15044
</tag>
14565
15045
</docblock>
14566
<argument line="482">
15046
<argument line="518">
14567
15047
<name>$base</name>
14568
15048
<default><![CDATA[]]></default>
14569
15049
<type/>
14570
15050
</argument>
14571
15051
</method>
14572
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="492" package="modules">
15052
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="528" package="modules">
14573
15053
<name>load_Messages</name>
14574
15054
<full_name>load_Messages</full_name>
14575
<docblock line="489">
15055
<docblock line="525">
14576
15056
<description><![CDATA[This function fills the $messages variable with output messages from this module.]]></description>
14577
15057
<long-description><![CDATA[]]></long-description>
14578
15058
</docblock>
14579
15059
</method>
14580
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="517" package="modules">
15060
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="553" package="modules">
14581
15061
<name>module_complete</name>
14582
15062
<full_name>module_complete</full_name>
14583
<docblock line="512">
15063
<docblock line="548">
14584
15064
<description><![CDATA[This functions is used to check if all settings for this module have been made.]]></description>
14585
15065
<long-description><![CDATA[]]></long-description>
14586
<tag line="512" name="return" description="true, if settings are complete" type="boolean">
15066
<tag line="548" name="return" description="true, if settings are complete" type="boolean">
14587
15067
<type by_reference="false">boolean</type>
14588
15068
</tag>
14589
15069
</docblock>
14590
15070
</method>
14591
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="536" package="modules">
15071
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="572" package="modules">
14592
15072
<name>getButtonStatus</name>
14593
15073
<full_name>getButtonStatus</full_name>
14594
<docblock line="531">
15074
<docblock line="567">
14595
15075
<description><![CDATA[Controls if the module button the account page is visible and activated.]]></description>
14596
15076
<long-description><![CDATA[]]></long-description>
14597
<tag line="531" name="return" description="status ("enabled", "disabled", "hidden")" type="string">
15077
<tag line="567" name="return" description="status ("enabled", "disabled", "hidden")" type="string">
14598
15078
<type by_reference="false">string</type>
14599
15079
</tag>
14600
15080
</docblock>
14601
15081
</method>
14602
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="554" package="modules">
15082
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="590" package="modules">
14603
15083
<name>process_attributes</name>
14604
15084
<full_name>process_attributes</full_name>
14605
<docblock line="548">
15085
<docblock line="584">
14606
15086
<description><![CDATA[Processes user input of the primary module page.]]></description>
14607
15087
<long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
14608
<tag line="548" name="return" description="list of info/error messages" type="array">
15088
<tag line="584" name="return" description="list of info/error messages" type="array">
14609
15089
<type by_reference="false">array</type>
14610
15090
</tag>
14611
15091
</docblock>
14612
15092
</method>
14613
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="682" package="modules">
15093
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="718" package="modules">
14614
15094
<name>process_user</name>
14615
15095
<full_name>process_user</full_name>
14616
<docblock line="676">
15096
<docblock line="712">
14617
15097
<description><![CDATA[Processes user input of the user selection page.]]></description>
14618
15098
<long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
14619
<tag line="676" name="return" description="list of info/error messages" type="array">
15099
<tag line="712" name="return" description="list of info/error messages" type="array">
14620
15100
<type by_reference="false">array</type>
14621
15101
</tag>
14622
15102
</docblock>
14623
15103
</method>
14624
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="707" package="modules">
15104
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="743" package="modules">
14625
15105
<name>save_attributes</name>
14626
15106
<full_name>save_attributes</full_name>
14627
<docblock line="695">
15107
<docblock line="731">
14628
15108
<description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
14629
15109
<long-description><![CDATA[]]></long-description>
14630
<tag line="695" name="return" description="list of modifications <br>This function returns an array with 3 entries: <br>array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) <br>DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) <br>"add" are attributes which have to be added to LDAP entry <br>"remove" are attributes which have to be removed from LDAP entry <br>"modify" are attributes which have to been modified in LDAP entry <br>"info" are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
15110
<tag line="731" name="return" description="list of modifications <br>This function returns an array with 3 entries: <br>array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) <br>DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) <br>"add" are attributes which have to be added to LDAP entry <br>"remove" are attributes which have to be removed from LDAP entry <br>"modify" are attributes which have to been modified in LDAP entry <br>"info" are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
14631
15111
<type by_reference="false">array</type>
14632
15112
</tag>
14633
15113
</docblock>
14634
15114
</method>
14635
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="740" package="modules">
15115
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="776" package="modules">
14636
15116
<name>check_configOptions</name>
14637
15117
<full_name>check_configOptions</full_name>
14638
<docblock line="726">
15118
<docblock line="762">
14639
15119
<description><![CDATA[Checks input values of module settings.]]></description>
14640
15120
<long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
14641
15121
<br>
14642
15122
If the input data is invalid the return value is an array that contains subarrays to build StatusMessages ('message type', 'message head', 'message text').
14643
15123
<br>If no errors occured the function returns an empty array.</p>]]></long-description>
14644
<tag line="726" name="param" description="list of account types which are used" type="array" variable="$scopes">
14645
<type by_reference="false">array</type>
14646
</tag>
14647
<tag line="726" name="param" description="hash array (option name => value) that contains the input. The option values are all arrays containing one or more elements." type="array" variable="$options">
14648
<type by_reference="false">array</type>
14649
</tag>
14650
<tag line="726" name="return" description="list of error messages" type="array">
14651
<type by_reference="false">array</type>
14652
</tag>
14653
<tag line="726" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
15124
<tag line="762" name="param" description="list of account types which are used" type="array" variable="$scopes">
15125
<type by_reference="false">array</type>
15126
</tag>
15127
<tag line="762" name="param" description="hash array (option name => value) that contains the input. The option values are all arrays containing one or more elements." type="array" variable="$options">
15128
<type by_reference="false">array</type>
15129
</tag>
15130
<tag line="762" name="return" description="list of error messages" type="array">
15131
<type by_reference="false">array</type>
15132
</tag>
15133
<tag line="762" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
14654
15134
</docblock>
14655
<argument line="740">
15135
<argument line="776">
14656
15136
<name>$scopes</name>
14657
15137
<default><![CDATA[]]></default>
14658
15138
<type/>
14659
15139
</argument>
14660
<argument line="740">
15140
<argument line="776">
14661
15141
<name>$options</name>
14662
15142
<default><![CDATA[]]></default>
14663
15143
<type/>
14664
15144
</argument>
14665
15145
</method>
14666
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="778" package="modules">
15146
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="814" package="modules">
14667
15147
<name>getNextGIDs</name>
14668
15148
<full_name>getNextGIDs</full_name>
14669
<docblock line="771">
15149
<docblock line="807">
14670
15150
<description><![CDATA[Returns one or more free GID numbers.]]></description>
14671
15151
<long-description><![CDATA[]]></long-description>
14672
<tag line="771" name="param" description="Number of needed free GIDs." type="integer" variable="$count">
15152
<tag line="807" name="param" description="Number of needed free GIDs." type="integer" variable="$count">
14673
15153
<type by_reference="false">integer</type>
14674
15154
</tag>
14675
<tag line="771" name="param" description="list of error messages where errors can be added" type="array" variable="$errors">
15155
<tag line="807" name="param" description="list of error messages where errors can be added" type="array" variable="$errors">
14676
15156
<type by_reference="false">array</type>
14677
15157
</tag>
14678
<tag line="771" name="return" description="Null if no GIDs are free else an array of free GIDs." type="mixed">
15158
<tag line="807" name="return" description="Null if no GIDs are free else an array of free GIDs." type="mixed">
14679
15159
<type by_reference="false">mixed</type>
14680
15160
</tag>
14681
15161
</docblock>
14682
<argument line="778">
15162
<argument line="814">
14683
15163
<name>$count</name>
14684
15164
<default><![CDATA[]]></default>
14685
15165
<type/>
14686
15166
</argument>
14687
<argument line="778">
15167
<argument line="814">
14688
15168
<name>$errors</name>
14689
15169
<default><![CDATA[]]></default>
14690
15170
<type/>
14691
15171
</argument>
14692
15172
</method>
14693
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="836" package="modules">
15173
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="872" package="modules">
14694
15174
<name>getNextSambaPoolGIDs</name>
14695
15175
<full_name>getNextSambaPoolGIDs</full_name>
14696
<docblock line="829">
15176
<docblock line="865">
14697
15177
<description><![CDATA[Gets the free GID numbers from an Samba pool entry in LDAP.]]></description>
14698
15178
<long-description><![CDATA[]]></long-description>
14699
<tag line="829" name="param" description="number of needed free GIDs." type="integer" variable="$count">
15179
<tag line="865" name="param" description="number of needed free GIDs." type="integer" variable="$count">
14700
15180
<type by_reference="false">integer</type>
14701
15181
</tag>
14702
<tag line="829" name="param" description="list of error messages where errors can be added" type="array" variable="$errors">
15182
<tag line="865" name="param" description="list of error messages where errors can be added" type="array" variable="$errors">
14703
15183
<type by_reference="false">array</type>
14704
15184
</tag>
14705
<tag line="829" name="return" description="null if no GIDs are free else an array of free GIDs" type="mixed">
15185
<tag line="865" name="return" description="null if no GIDs are free else an array of free GIDs" type="mixed">
14706
15186
<type by_reference="false">mixed</type>
14707
15187
</tag>
14708
15188
</docblock>
14709
<argument line="836">
15189
<argument line="872">
14710
15190
<name>$count</name>
14711
15191
<default><![CDATA[]]></default>
14712
15192
<type/>
14713
15193
</argument>
14714
<argument line="836">
15194
<argument line="872">
14715
15195
<name>$errors</name>
14716
15196
<default><![CDATA[]]></default>
14717
15197
<type/>
14718
15198
</argument>
14719
15199
</method>
14720
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="863" package="modules">
15200
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="899" package="modules">
14721
15201
<name>managesPasswordAttributes</name>
14722
15202
<full_name>managesPasswordAttributes</full_name>
14723
<docblock line="857">
15203
<docblock line="893">
14724
15204
<description><![CDATA[This method specifies if a module manages password attributes.]]></description>
14725
15205
<long-description><![CDATA[]]></long-description>
14726
<tag line="857" name="see" description="\global\passwordService::managesPasswordAttributes" refers="\global\passwordService::managesPasswordAttributes"/>
14727
<tag line="857" name="return" description="true if this module manages password attributes" type="boolean">
15206
<tag line="893" name="see" description="\global\passwordService::managesPasswordAttributes" refers="\global\passwordService::managesPasswordAttributes"/>
15207
<tag line="893" name="return" description="true if this module manages password attributes" type="boolean">
14728
15208
<type by_reference="false">boolean</type>
14729
15209
</tag>
14730
15210
</docblock>
14731
15211
</method>
14732
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="872" package="modules">
15212
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="908" package="modules">
14733
15213
<name>supportsForcePasswordChange</name>
14734
15214
<full_name>supportsForcePasswordChange</full_name>
14735
<docblock line="867">
15215
<docblock line="903">
14736
15216
<description><![CDATA[Specifies if this module supports to force that a user must change his password on next login.]]></description>
14737
15217
<long-description><![CDATA[]]></long-description>
14738
<tag line="867" name="return" description="force password change supported" type="boolean">
15218
<tag line="903" name="return" description="force password change supported" type="boolean">
14739
15219
<type by_reference="false">boolean</type>
14740
15220
</tag>
14741
15221
</docblock>
14742
15222
</method>
14743
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="887" package="modules">
15223
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="923" package="modules">
14744
15224
<name>passwordChangeRequested</name>
14745
15225
<full_name>passwordChangeRequested</full_name>
14746
<docblock line="876">
15226
<docblock line="912">
14747
15227
<description><![CDATA[This function is called whenever the password should be changed.]]></description>
14748
15228
<long-description><![CDATA[<p>Account modules
14749
15229
must change their password attributes only if the modules list contains their module name.</p>]]></long-description>
14750
<tag line="876" name="param" description="new password" type="String" variable="$password">
15230
<tag line="912" name="param" description="new password" type="String" variable="$password">
14751
15231
<type by_reference="false">String</type>
14752
15232
</tag>
14753
<tag line="876" name="param" description="list of modules for which the password should be changed" type="\$modules" variable="$modules">
15233
<tag line="912" name="param" description="list of modules for which the password should be changed" type="\$modules" variable="$modules">
14754
15234
<type by_reference="false">\$modules</type>
14755
15235
</tag>
14756
<tag line="876" name="param" description="force the user to change his password at next login" type="boolean" variable="$forcePasswordChange">
15236
<tag line="912" name="param" description="force the user to change his password at next login" type="boolean" variable="$forcePasswordChange">
14757
15237
<type by_reference="false">boolean</type>
14758
15238
</tag>
14759
<tag line="876" name="return" description="list of error messages if any as parameter array for StatusMessage e.g. return arrray(array('ERROR', 'Password change failed.'))" type="array">
15239
<tag line="912" name="return" description="list of error messages if any as parameter array for StatusMessage e.g. return arrray(array('ERROR', 'Password change failed.'))" type="array">
14760
15240
<type by_reference="false">array</type>
14761
15241
</tag>
14762
<tag line="876" name="see" description="\global\passwordService::passwordChangeRequested" refers="\global\passwordService::passwordChangeRequested"/>
15242
<tag line="912" name="see" description="\global\passwordService::passwordChangeRequested" refers="\global\passwordService::passwordChangeRequested"/>
14763
15243
</docblock>
14764
<argument line="887">
15244
<argument line="923">
14765
15245
<name>$password</name>
14766
15246
<default><![CDATA[]]></default>
14767
15247
<type/>
14768
15248
</argument>
14769
<argument line="887">
15249
<argument line="923">
14770
15250
<name>$modules</name>
14771
15251
<default><![CDATA[]]></default>
14772
15252
<type/>
14773
15253
</argument>
14774
<argument line="887">
15254
<argument line="923">
14775
15255
<name>$forcePasswordChange</name>
14776
15256
<default><![CDATA[]]></default>
14777
15257
<type/>
14778
15258
</argument>
14779
15259
</method>
14780
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="900" package="modules">
15260
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="936" package="modules">
14781
15261
<name>getGIDs</name>
14782
15262
<full_name>getGIDs</full_name>
14783
<docblock line="895">
15263
<docblock line="931">
14784
15264
<description><![CDATA[Returns a list of existing GID numbers.]]></description>
14785
15265
<long-description><![CDATA[]]></long-description>
14786
<tag line="895" name="return" description="list of GID numbers" type="array">
15266
<tag line="931" name="return" description="list of GID numbers" type="array">
14787
15267
<type by_reference="false">array</type>
14788
15268
</tag>
14789
15269
</docblock>
14790
15270
</method>
14791
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="924" package="modules">
14792
<name>getUserAndGIDs</name>
14793
<full_name>getUserAndGIDs</full_name>
14794
<docblock line="919">
14795
<description><![CDATA[Returns a list of existing users and their GID numbers.]]></description>
15271
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="960" package="modules">
15272
<name>getUsers</name>
15273
<full_name>getUsers</full_name>
15274
<docblock line="955">
15275
<description><![CDATA[Returns a list of existing users and their GID numbers and cn.]]></description>
14796
15276
<long-description><![CDATA[]]></long-description>
14797
<tag line="919" name="return" description="list in format array(uid => gidNumber)" type="array">
15277
<tag line="955" name="return" description="list in format array(uid => array('gid' => 123, 'cn' => 'Some user'))" type="array">
14798
15278
<type by_reference="false">array</type>
14799
15279
</tag>
14800
15280
</docblock>
14801
15281
</method>
14802
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="942" package="modules">
15282
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="979" package="modules">
14803
15283
<name>groupNameExists</name>
14804
15284
<full_name>groupNameExists</full_name>
14805
<docblock line="936">
15285
<docblock line="973">
14806
15286
<description><![CDATA[Checks if the given group name already exists in LDAP.]]></description>
14807
15287
<long-description><![CDATA[]]></long-description>
14808
<tag line="936" name="param" description="group name" type="String" variable="$groupName">
15288
<tag line="973" name="param" description="group name" type="String" variable="$groupName">
14809
15289
<type by_reference="false">String</type>
14810
15290
</tag>
14811
<tag line="936" name="return" description="true if already exists" type="boolean">
15291
<tag line="973" name="return" description="true if already exists" type="boolean">
14812
15292
<type by_reference="false">boolean</type>
14813
15293
</tag>
14814
15294
</docblock>
14815
<argument line="942">
15295
<argument line="979">
14816
15296
<name>$groupName</name>
14817
15297
<default><![CDATA[]]></default>
14818
15298
<type/>
14819
15299
</argument>
14820
15300
</method>
14821
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="951" package="modules">
15301
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="988" package="modules">
14822
15302
<name>getGroupNames</name>
14823
15303
<full_name>getGroupNames</full_name>
14824
<docblock line="946">
15304
<docblock line="983">
14825
15305
<description><![CDATA[Returns a list of all group names in LDAP.]]></description>
14826
15306
<long-description><![CDATA[]]></long-description>
14827
<tag line="946" name="return" description="group names" type="array">
15307
<tag line="983" name="return" description="group names" type="array">
14828
15308
<type by_reference="false">array</type>
14829
15309
</tag>
14830
15310
</docblock>
14831
15311
</method>
14832
15312
</class>
14833
15313
</file>
14834
<file path="lib/modules/dhcp_settings.inc" hash="728df564528b5b22dd9ab9dbf9468bff" package="modules">
15314
<file path="lib/modules/dhcp_settings.inc" hash="357a383d085725c1722f1b74b82fc50e" package="modules">
14835
15315
<docblock line="25">
14836
15316
<description><![CDATA[Manages DHCP entries.]]></description>
14837
15317
<long-description><![CDATA[]]></long-description>
15021
15501
</tag>
15022
15502
</docblock>
15023
15503
</method>
15024
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="650" package="modules">
15504
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="651" package="modules">
15025
15505
<name>getDHCPOption</name>
15026
15506
<full_name>getDHCPOption</full_name>
15027
<docblock line="644">
15507
<docblock line="645">
15028
15508
<description><![CDATA[Returns a DHCP option.]]></description>
15029
15509
<long-description><![CDATA[]]></long-description>
15030
<tag line="644" name="param" description="option name" type="String" variable="$name">
15510
<tag line="645" name="param" description="option name" type="String" variable="$name">
15031
15511
<type by_reference="false">String</type>
15032
15512
</tag>
15033
<tag line="644" name="return" description="value" type="String">
15513
<tag line="645" name="return" description="value" type="String">
15034
15514
<type by_reference="false">String</type>
15035
15515
</tag>
15036
15516
</docblock>
15037
<argument line="650">
15517
<argument line="651">
15038
15518
<name>$name</name>
15039
15519
<default><![CDATA[]]></default>
15040
15520
<type/>
15041
15521
</argument>
15042
15522
</method>
15043
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="670" package="modules">
15523
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="671" package="modules">
15044
15524
<name>setDHCPOption</name>
15045
15525
<full_name>setDHCPOption</full_name>
15046
<docblock line="664">
15526
<docblock line="665">
15047
15527
<description><![CDATA[Sets a DHCP option.]]></description>
15048
15528
<long-description><![CDATA[]]></long-description>
15049
<tag line="664" name="param" description="option name" type="String" variable="$name">
15529
<tag line="665" name="param" description="option name" type="String" variable="$name">
15050
15530
<type by_reference="false">String</type>
15051
15531
</tag>
15052
<tag line="664" name="param" description="option value" type="String" variable="$value">
15532
<tag line="665" name="param" description="option value" type="String" variable="$value">
15053
15533
<type by_reference="false">String</type>
15054
15534
</tag>
15055
15535
</docblock>
15056
<argument line="670">
15536
<argument line="671">
15057
15537
<name>$name</name>
15058
15538
<default><![CDATA[]]></default>
15059
15539
<type/>
15060
15540
</argument>
15061
<argument line="670">
15541
<argument line="671">
15062
15542
<name>$value</name>
15063
15543
<default><![CDATA[]]></default>
15064
15544
<type/>
15065
15545
</argument>
15066
15546
</method>
15067
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="690" package="modules">
15547
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="691" package="modules">
15068
15548
<name>getDefaultLeaseTime</name>
15069
15549
<full_name>getDefaultLeaseTime</full_name>
15070
<docblock line="685">
15550
<docblock line="686">
15071
15551
<description><![CDATA[Returns the default lease time.]]></description>
15072
15552
<long-description><![CDATA[]]></long-description>
15073
<tag line="685" name="return" description="time" type="String">
15553
<tag line="686" name="return" description="time" type="String">
15074
15554
<type by_reference="false">String</type>
15075
15555
</tag>
15076
15556
</docblock>
15077
15557
</method>
15078
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="708" package="modules">
15558
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="709" package="modules">
15079
15559
<name>setDefaultLeaseTime</name>
15080
15560
<full_name>setDefaultLeaseTime</full_name>
15081
<docblock line="703">
15561
<docblock line="704">
15082
15562
<description><![CDATA[Sets the default lease time.]]></description>
15083
15563
<long-description><![CDATA[]]></long-description>
15084
<tag line="703" name="param" description="time" type="String" variable="$time">
15564
<tag line="704" name="param" description="time" type="String" variable="$time">
15085
15565
<type by_reference="false">String</type>
15086
15566
</tag>
15087
15567
</docblock>
15088
<argument line="708">
15568
<argument line="709">
15089
15569
<name>$time</name>
15090
15570
<default><![CDATA[]]></default>
15091
15571
<type/>
15092
15572
</argument>
15093
15573
</method>
15094
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="728" package="modules">
15574
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="729" package="modules">
15095
15575
<name>getMaxLeaseTime</name>
15096
15576
<full_name>getMaxLeaseTime</full_name>
15097
<docblock line="723">
15577
<docblock line="724">
15098
15578
<description><![CDATA[Returns the maximum lease time.]]></description>
15099
15579
<long-description><![CDATA[]]></long-description>
15100
<tag line="723" name="return" description="time" type="String">
15580
<tag line="724" name="return" description="time" type="String">
15101
15581
<type by_reference="false">String</type>
15102
15582
</tag>
15103
15583
</docblock>
15104
15584
</method>
15105
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="746" package="modules">
15585
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="747" package="modules">
15106
15586
<name>setMaxLeaseTime</name>
15107
15587
<full_name>setMaxLeaseTime</full_name>
15108
<docblock line="741">
15588
<docblock line="742">
15109
15589
<description><![CDATA[Sets the maximum lease time.]]></description>
15110
15590
<long-description><![CDATA[]]></long-description>
15111
<tag line="741" name="param" description="time" type="String" variable="$time">
15591
<tag line="742" name="param" description="time" type="String" variable="$time">
15112
15592
<type by_reference="false">String</type>
15113
15593
</tag>
15114
15594
</docblock>
15115
<argument line="746">
15595
<argument line="747">
15116
15596
<name>$time</name>
15117
15597
<default><![CDATA[]]></default>
15118
15598
<type/>
15119
15599
</argument>
15120
15600
</method>
15121
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="770" package="modules">
15601
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="771" package="modules">
15122
15602
<name>build_uploadAccounts</name>
15123
15603
<full_name>build_uploadAccounts</full_name>
15124
<docblock line="761">
15604
<docblock line="762">
15125
15605
<description><![CDATA[In this function the LDAP account is built up.]]></description>
15126
15606
<long-description><![CDATA[]]></long-description>
15127
<tag line="761" name="param" description="list of hash arrays (name => value) from user input" type="array" variable="$rawAccounts">
15128
<type by_reference="false">array</type>
15129
</tag>
15130
<tag line="761" name="param" description="list of IDs for column position (e.g. "posixAccount_uid" => 5)" type="array" variable="$ids">
15131
<type by_reference="false">array</type>
15132
</tag>
15133
<tag line="761" name="param" description="list of hash arrays (name => value) which are later added to LDAP" type="array" variable="$partialAccounts">
15134
<type by_reference="false">array</type>
15135
</tag>
15136
<tag line="761" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
15137
<type by_reference="false">array</type>
15138
</tag>
15139
<tag line="761" name="return" description="list of error messages if any" type="array">
15607
<tag line="762" name="param" description="list of hash arrays (name => value) from user input" type="array" variable="$rawAccounts">
15608
<type by_reference="false">array</type>
15609
</tag>
15610
<tag line="762" name="param" description="list of IDs for column position (e.g. "posixAccount_uid" => 5)" type="array" variable="$ids">
15611
<type by_reference="false">array</type>
15612
</tag>
15613
<tag line="762" name="param" description="list of hash arrays (name => value) which are later added to LDAP" type="array" variable="$partialAccounts">
15614
<type by_reference="false">array</type>
15615
</tag>
15616
<tag line="762" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
15617
<type by_reference="false">array</type>
15618
</tag>
15619
<tag line="762" name="return" description="list of error messages if any" type="array">
15140
15620
<type by_reference="false">array</type>
15141
15621
</tag>
15142
15622
</docblock>
15143
<argument line="770">
15623
<argument line="771">
15144
15624
<name>$rawAccounts</name>
15145
15625
<default><![CDATA[]]></default>
15146
15626
<type/>
15147
15627
</argument>
15148
<argument line="770">
15628
<argument line="771">
15149
15629
<name>$ids</name>
15150
15630
<default><![CDATA[]]></default>
15151
15631
<type/>
15152
15632
</argument>
15153
<argument line="770">
15633
<argument line="771">
15154
15634
<name>$partialAccounts</name>
15155
15635
<default><![CDATA[]]></default>
15156
15636
<type/>
15157
15637
</argument>
15158
<argument line="770">
15638
<argument line="771">
15159
15639
<name>$selectedModules</name>
15160
15640
<default><![CDATA[]]></default>
15161
15641
<type/>
15163
15643
</method>
15164
15644
</class>
15165
15645
</file>
15166
<file path="lib/modules/eduPerson.inc" hash="6dde0dccf497f1b74f869db9ed9c4a34" package="modules">
15646
<file path="lib/modules/eduPerson.inc" hash="b6ca5797f002a3063775333f7d2f8ed6" package="modules">
15167
15647
<docblock line="23">
15168
15648
<description><![CDATA[Manages the eduPerson extension for user accounts.]]></description>
15169
15649
<long-description><![CDATA[]]></long-description>
15328
15808
</method>
15329
15809
</class>
15330
15810
</file>
15331
<file path="lib/modules/quota.inc" hash="a42df34981dd4a86e32ad986256bf517" package="modules">
15811
<file path="lib/modules/quota.inc" hash="f6b0ad7fd6f30235d33f60389089a624" package="modules">
15332
15812
<docblock line="25">
15333
15813
<description><![CDATA[Manages quotas for users and groups.]]></description>
15334
15814
<long-description><![CDATA[]]></long-description>
15511
15991
</tag>
15512
15992
</docblock>
15513
15993
</method>
15514
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="544" package="modules">
15994
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="545" package="modules">
15515
15995
<name>check_profileOptions</name>
15516
15996
<full_name>check_profileOptions</full_name>
15517
<docblock line="538">
15997
<docblock line="539">
15518
15998
<description><![CDATA[Checks input values of account profiles.]]></description>
15519
15999
<long-description><![CDATA[]]></long-description>
15520
<tag line="538" name="param" description="a hash array (name => value) containing the options" type="array" variable="$options">
16000
<tag line="539" name="param" description="a hash array (name => value) containing the options" type="array" variable="$options">
15521
16001
<type by_reference="false">array</type>
15522
16002
</tag>
15523
<tag line="538" name="return" description="list of error messages (array(type, title, text)) to generate StatusMessages, if any" type="array">
16003
<tag line="539" name="return" description="list of error messages (array(type, title, text)) to generate StatusMessages, if any" type="array">
15524
16004
<type by_reference="false">array</type>
15525
16005
</tag>
15526
16006
</docblock>
15527
<argument line="544">
16007
<argument line="545">
15528
16008
<name>$options</name>
15529
16009
<default><![CDATA[]]></default>
15530
16010
<type/>
15531
16011
</argument>
15532
16012
</method>
15533
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="585" package="modules">
16013
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="586" package="modules">
15534
16014
<name>load_profile</name>
15535
16015
<full_name>load_profile</full_name>
15536
<docblock line="580">
16016
<docblock line="581">
15537
16017
<description><![CDATA[Loads the values of an account profile into internal variables.]]></description>
15538
16018
<long-description><![CDATA[]]></long-description>
15539
<tag line="580" name="param" description="hash array with profile values (identifier => value)" type="array" variable="$profile">
16019
<tag line="581" name="param" description="hash array with profile values (identifier => value)" type="array" variable="$profile">
15540
16020
<type by_reference="false">array</type>
15541
16021
</tag>
15542
16022
</docblock>
15543
<argument line="585">
16023
<argument line="586">
15544
16024
<name>$profile</name>
15545
16025
<default><![CDATA[]]></default>
15546
16026
<type/>
15547
16027
</argument>
15548
16028
</method>
15549
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="607" package="modules">
16029
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="608" package="modules">
15550
16030
<name>get_pdfEntries</name>
15551
16031
<full_name>get_pdfEntries</full_name>
15552
<docblock line="602">
16032
<docblock line="603">
15553
16033
<description><![CDATA[Returns the PDF entries for this module.]]></description>
15554
16034
<long-description><![CDATA[]]></long-description>
15555
<tag line="602" name="return" description="list of possible PDF entries" type="array">
16035
<tag line="603" name="return" description="list of possible PDF entries" type="array">
15556
16036
<type by_reference="false">array</type>
15557
16037
</tag>
15558
16038
</docblock>
15559
16039
</method>
15560
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="662" package="modules">
16040
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="663" package="modules">
15561
16041
<name>get_uploadColumns</name>
15562
16042
<full_name>get_uploadColumns</full_name>
15563
<docblock line="647">
16043
<docblock line="648">
15564
16044
<description><![CDATA[Returns an array containing all input columns for the file upload.]]></description>
15565
16045
<long-description><![CDATA[<p>Syntax:
15566
16046
<br> array(
15570
16050
<br> string: example, // example value
15571
16051
<br> boolean: required // true, if user must set a value for this column
15572
16052
<br> )</p>]]></long-description>
15573
<tag line="647" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
16053
<tag line="648" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
15574
16054
<type by_reference="false">array</type>
15575
16055
</tag>
15576
<tag line="647" name="return" description="column list" type="array">
16056
<tag line="648" name="return" description="column list" type="array">
15577
16057
<type by_reference="false">array</type>
15578
16058
</tag>
15579
16059
</docblock>
15580
<argument line="662">
16060
<argument line="663">
15581
16061
<name>$selectedModules</name>
15582
16062
<default><![CDATA[]]></default>
15583
16063
<type/>
15584
16064
</argument>
15585
16065
</method>
15586
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="714" package="modules">
16066
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="715" package="modules">
15587
16067
<name>doUploadPostActions</name>
15588
16068
<full_name>doUploadPostActions</full_name>
15589
<docblock line="699">
16069
<docblock line="700">
15590
16070
<description><![CDATA[This function executes one post upload action.]]></description>
15591
16071
<long-description><![CDATA[]]></long-description>
15592
<tag line="699" name="param" description="array containing one account in each element" type="array" variable="$data">
15593
<type by_reference="false">array</type>
15594
</tag>
15595
<tag line="699" name="param" description="array(<column_name> => <column number>)" type="array" variable="$ids">
15596
<type by_reference="false">array</type>
15597
</tag>
15598
<tag line="699" name="param" description="list of accounts which were not created successfully" type="array" variable="$failed">
15599
<type by_reference="false">array</type>
15600
</tag>
15601
<tag line="699" name="param" description="variable to store temporary data between two post actions" type="array" variable="$temp">
15602
<type by_reference="false">array</type>
15603
</tag>
15604
<tag line="699" name="param" description="list of LDAP entries" type="array" variable="$accounts">
15605
<type by_reference="false">array</type>
15606
</tag>
15607
<tag line="699" name="return" description="current status <br> array ( <br> 'status' => 'finished' | 'inProgress' <br> 'progress' => 0..100 <br> 'errors' => array (<array of parameters for StatusMessage>) <br> )" type="array">
16072
<tag line="700" name="param" description="array containing one account in each element" type="array" variable="$data">
16073
<type by_reference="false">array</type>
16074
</tag>
16075
<tag line="700" name="param" description="array(<column_name> => <column number>)" type="array" variable="$ids">
16076
<type by_reference="false">array</type>
16077
</tag>
16078
<tag line="700" name="param" description="list of accounts which were not created successfully" type="array" variable="$failed">
16079
<type by_reference="false">array</type>
16080
</tag>
16081
<tag line="700" name="param" description="variable to store temporary data between two post actions" type="array" variable="$temp">
16082
<type by_reference="false">array</type>
16083
</tag>
16084
<tag line="700" name="param" description="list of LDAP entries" type="array" variable="$accounts">
16085
<type by_reference="false">array</type>
16086
</tag>
16087
<tag line="700" name="return" description="current status <br> array ( <br> 'status' => 'finished' | 'inProgress' <br> 'progress' => 0..100 <br> 'errors' => array (<array of parameters for StatusMessage>) <br> )" type="array">
15608
16088
<type by_reference="false">array</type>
15609
16089
</tag>
15610
16090
</docblock>
15611
<argument line="714">
16091
<argument line="715">
15612
16092
<name>$data</name>
15613
16093
<default><![CDATA[]]></default>
15614
16094
<type/>
15615
16095
</argument>
15616
<argument line="714">
16096
<argument line="715">
15617
16097
<name>$ids</name>
15618
16098
<default><![CDATA[]]></default>
15619
16099
<type/>
15620
16100
</argument>
15621
<argument line="714">
16101
<argument line="715">
15622
16102
<name>$failed</name>
15623
16103
<default><![CDATA[]]></default>
15624
16104
<type/>
15625
16105
</argument>
15626
<argument line="714">
16106
<argument line="715">
15627
16107
<name>$temp</name>
15628
16108
<default><![CDATA[]]></default>
15629
16109
<type/>
15630
16110
</argument>
15631
<argument line="714">
16111
<argument line="715">
15632
16112
<name>$accounts</name>
15633
16113
<default><![CDATA[]]></default>
15634
16114
<type/>
15636
16116
</method>
15637
16117
</class>
15638
16118
</file>
15639
<file path="lib/modules/sambaSamAccount.inc" hash="82c75eabeec835e538f8ab2371f9b16c" package="modules">
16119
<file path="lib/modules/sambaSamAccount.inc" hash="bc6d1ef8463289c23f4f6a62181b9973" package="modules">
15640
16120
<docblock line="24">
15641
16121
<description><![CDATA[Manages Samba 3 accounts for users and hosts.]]></description>
15642
16122
<long-description><![CDATA[]]></long-description>
16022
16502
</tag>
16023
16503
</docblock>
16024
16504
</method>
16025
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1975" package="modules">
16505
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1959" package="modules">
16026
16506
<name>build_uploadAccounts</name>
16027
16507
<full_name>build_uploadAccounts</full_name>
16028
<docblock line="1966">
16508
<docblock line="1950">
16029
16509
<description><![CDATA[In this function the LDAP account is built up.]]></description>
16030
16510
<long-description><![CDATA[]]></long-description>
16031
<tag line="1966" name="param" description="list of hash arrays (name => value) from user input" type="array" variable="$rawAccounts">
16032
<type by_reference="false">array</type>
16033
</tag>
16034
<tag line="1966" name="param" description="list of IDs for column position (e.g. "posixAccount_uid" => 5)" type="array" variable="$ids">
16035
<type by_reference="false">array</type>
16036
</tag>
16037
<tag line="1966" name="param" description="list of hash arrays (name => value) which are later added to LDAP" type="array" variable="$partialAccounts">
16038
<type by_reference="false">array</type>
16039
</tag>
16040
<tag line="1966" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
16041
<type by_reference="false">array</type>
16042
</tag>
16043
<tag line="1966" name="return" description="list of error messages if any" type="array">
16511
<tag line="1950" name="param" description="list of hash arrays (name => value) from user input" type="array" variable="$rawAccounts">
16512
<type by_reference="false">array</type>
16513
</tag>
16514
<tag line="1950" name="param" description="list of IDs for column position (e.g. "posixAccount_uid" => 5)" type="array" variable="$ids">
16515
<type by_reference="false">array</type>
16516
</tag>
16517
<tag line="1950" name="param" description="list of hash arrays (name => value) which are later added to LDAP" type="array" variable="$partialAccounts">
16518
<type by_reference="false">array</type>
16519
</tag>
16520
<tag line="1950" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
16521
<type by_reference="false">array</type>
16522
</tag>
16523
<tag line="1950" name="return" description="list of error messages if any" type="array">
16044
16524
<type by_reference="false">array</type>
16045
16525
</tag>
16046
16526
</docblock>
16047
<argument line="1975">
16527
<argument line="1959">
16048
16528
<name>$rawAccounts</name>
16049
16529
<default><![CDATA[]]></default>
16050
16530
<type/>
16051
16531
</argument>
16052
<argument line="1975">
16532
<argument line="1959">
16053
16533
<name>$ids</name>
16054
16534
<default><![CDATA[]]></default>
16055
16535
<type/>
16056
16536
</argument>
16057
<argument line="1975">
16537
<argument line="1959">
16058
16538
<name>$partialAccounts</name>
16059
16539
<default><![CDATA[]]></default>
16060
16540
<type/>
16061
16541
</argument>
16062
<argument line="1975">
16542
<argument line="1959">
16063
16543
<name>$selectedModules</name>
16064
16544
<default><![CDATA[]]></default>
16065
16545
<type/>
16066
16546
</argument>
16067
16547
</method>
16068
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2295" package="modules">
16548
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2279" package="modules">
16069
16549
<name>getSelfServiceOptions</name>
16070
16550
<full_name>getSelfServiceOptions</full_name>
16071
<docblock line="2284">
16551
<docblock line="2268">
16072
16552
<description><![CDATA[Returns the meta HTML code for each input field.]]></description>
16073
16553
<long-description><![CDATA[<p>format: array(<field1> => array(<META HTML>), ...)
16074
16554
It is not possible to display help links.</p>]]></long-description>
16075
<tag line="2284" name="param" description="list of active fields" type="array" variable="$fields">
16076
<type by_reference="false">array</type>
16077
</tag>
16078
<tag line="2284" name="param" description="attributes of LDAP account" type="array" variable="$attributes">
16079
<type by_reference="false">array</type>
16080
</tag>
16081
<tag line="2284" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
16555
<tag line="2268" name="param" description="list of active fields" type="array" variable="$fields">
16556
<type by_reference="false">array</type>
16557
</tag>
16558
<tag line="2268" name="param" description="attributes of LDAP account" type="array" variable="$attributes">
16559
<type by_reference="false">array</type>
16560
</tag>
16561
<tag line="2268" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
16082
16562
<type by_reference="false">boolean</type>
16083
16563
</tag>
16084
<tag line="2284" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
16564
<tag line="2268" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
16085
16565
<type by_reference="false">array</type>
16086
16566
</tag>
16087
<tag line="2284" name="return" description="list of meta HTML elements (field name => htmlTableRow)" type="array">
16567
<tag line="2268" name="return" description="list of meta HTML elements (field name => htmlTableRow)" type="array">
16088
16568
<type by_reference="false">array</type>
16089
16569
</tag>
16090
16570
</docblock>
16091
<argument line="2295">
16571
<argument line="2279">
16092
16572
<name>$fields</name>
16093
16573
<default><![CDATA[]]></default>
16094
16574
<type/>
16095
16575
</argument>
16096
<argument line="2295">
16576
<argument line="2279">
16097
16577
<name>$attributes</name>
16098
16578
<default><![CDATA[]]></default>
16099
16579
<type/>
16100
16580
</argument>
16101
<argument line="2295">
16581
<argument line="2279">
16102
16582
<name>$passwordChangeOnly</name>
16103
16583
<default><![CDATA[]]></default>
16104
16584
<type/>
16105
16585
</argument>
16106
<argument line="2295">
16586
<argument line="2279">
16107
16587
<name>$readOnlyFields</name>
16108
16588
<default><![CDATA[]]></default>
16109
16589
<type/>
16110
16590
</argument>
16111
16591
</method>
16112
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2336" package="modules">
16592
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2320" package="modules">
16113
16593
<name>checkSelfServiceOptions</name>
16114
16594
<full_name>checkSelfServiceOptions</full_name>
16115
<docblock line="2319">
16595
<docblock line="2303">
16116
16596
<description><![CDATA[Checks if all input values are correct and returns the LDAP attributes which should be changed.]]></description>
16117
16597
<long-description><![CDATA[<p><br>Return values:
16118
16598
<br>messages: array of parameters to create status messages
16122
16602
<br>info: array of values with informational value (e.g. to be used later by pre/postModify actions)</p>
16123
16603
16124
16604
<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
16125
<tag line="2319" name="param" description="input fields" type="string" variable="$fields">
16605
<tag line="2303" name="param" description="input fields" type="string" variable="$fields">
16126
16606
<type by_reference="false">string</type>
16127
16607
</tag>
16128
<tag line="2319" name="param" description="LDAP attributes" type="array" variable="$attributes">
16608
<tag line="2303" name="param" description="LDAP attributes" type="array" variable="$attributes">
16129
16609
<type by_reference="false">array</type>
16130
16610
</tag>
16131
<tag line="2319" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
16611
<tag line="2303" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
16132
16612
<type by_reference="false">boolean</type>
16133
16613
</tag>
16134
<tag line="2319" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
16614
<tag line="2303" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
16135
16615
<type by_reference="false">array</type>
16136
16616
</tag>
16137
<tag line="2319" name="return" description="messages and attributes (array('messages' => array(), 'add' => array('mail' => array('test@test.com')), 'del' => array(), 'mod' => array(), 'info' => array()))" type="array">
16617
<tag line="2303" name="return" description="messages and attributes (array('messages' => array(), 'add' => array('mail' => array('test@test.com')), 'del' => array(), 'mod' => array(), 'info' => array()))" type="array">
16138
16618
<type by_reference="false">array</type>
16139
16619
</tag>
16140
16620
</docblock>
16141
<argument line="2336">
16621
<argument line="2320">
16142
16622
<name>$fields</name>
16143
16623
<default><![CDATA[]]></default>
16144
16624
<type/>
16145
16625
</argument>
16146
<argument line="2336">
16626
<argument line="2320">
16147
16627
<name>$attributes</name>
16148
16628
<default><![CDATA[]]></default>
16149
16629
<type/>
16150
16630
</argument>
16151
<argument line="2336">
16631
<argument line="2320">
16152
16632
<name>$passwordChangeOnly</name>
16153
16633
<default><![CDATA[]]></default>
16154
16634
<type/>
16155
16635
</argument>
16156
<argument line="2336">
16636
<argument line="2320">
16157
16637
<name>$readOnlyFields</name>
16158
16638
<default><![CDATA[]]></default>
16159
16639
<type/>
16160
16640
</argument>
16161
16641
</method>
16162
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2404" package="modules">
16642
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2388" package="modules">
16163
16643
<name>managesPasswordAttributes</name>
16164
16644
<full_name>managesPasswordAttributes</full_name>
16165
<docblock line="2398">
16645
<docblock line="2382">
16166
16646
<description><![CDATA[This method specifies if a module manages password attributes.]]></description>
16167
16647
<long-description><![CDATA[]]></long-description>
16168
<tag line="2398" name="see" description="\global\passwordService::managesPasswordAttributes" refers="\global\passwordService::managesPasswordAttributes"/>
16169
<tag line="2398" name="return" description="true if this module manages password attributes" type="boolean">
16648
<tag line="2382" name="see" description="\global\passwordService::managesPasswordAttributes" refers="\global\passwordService::managesPasswordAttributes"/>
16649
<tag line="2382" name="return" description="true if this module manages password attributes" type="boolean">
16170
16650
<type by_reference="false">boolean</type>
16171
16651
</tag>
16172
16652
</docblock>
16173
16653
</method>
16174
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2415" package="modules">
16654
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2399" package="modules">
16175
16655
<name>supportsForcePasswordChange</name>
16176
16656
<full_name>supportsForcePasswordChange</full_name>
16177
<docblock line="2410">
16657
<docblock line="2394">
16178
16658
<description><![CDATA[Specifies if this module supports to force that a user must change his password on next login.]]></description>
16179
16659
<long-description><![CDATA[]]></long-description>
16180
<tag line="2410" name="return" description="force password change supported" type="boolean">
16660
<tag line="2394" name="return" description="force password change supported" type="boolean">
16181
16661
<type by_reference="false">boolean</type>
16182
16662
</tag>
16183
16663
</docblock>
16184
16664
</method>
16185
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2430" package="modules">
16665
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2414" package="modules">
16186
16666
<name>passwordChangeRequested</name>
16187
16667
<full_name>passwordChangeRequested</full_name>
16188
<docblock line="2419">
16668
<docblock line="2403">
16189
16669
<description><![CDATA[This function is called whenever the password should be changed.]]></description>
16190
16670
<long-description><![CDATA[<p>Account modules
16191
16671
must change their password attributes only if the modules list contains their module name.</p>]]></long-description>
16192
<tag line="2419" name="param" description="new password" type="String" variable="$password">
16672
<tag line="2403" name="param" description="new password" type="String" variable="$password">
16193
16673
<type by_reference="false">String</type>
16194
16674
</tag>
16195
<tag line="2419" name="param" description="list of modules for which the password should be changed" type="\$modules" variable="$modules">
16675
<tag line="2403" name="param" description="list of modules for which the password should be changed" type="\$modules" variable="$modules">
16196
16676
<type by_reference="false">\$modules</type>
16197
16677
</tag>
16198
<tag line="2419" name="param" description="force the user to change his password at next login" type="boolean" variable="$forcePasswordChange">
16678
<tag line="2403" name="param" description="force the user to change his password at next login" type="boolean" variable="$forcePasswordChange">
16199
16679
<type by_reference="false">boolean</type>
16200
16680
</tag>
16201
<tag line="2419" name="return" description="list of error messages if any as parameter array for StatusMessage e.g. return arrray(array('ERROR', 'Password change failed.'))" type="array">
16681
<tag line="2403" name="return" description="list of error messages if any as parameter array for StatusMessage e.g. return arrray(array('ERROR', 'Password change failed.'))" type="array">
16202
16682
<type by_reference="false">array</type>
16203
16683
</tag>
16204
<tag line="2419" name="see" description="\global\passwordService::passwordChangeRequested" refers="\global\passwordService::passwordChangeRequested"/>
16684
<tag line="2403" name="see" description="\global\passwordService::passwordChangeRequested" refers="\global\passwordService::passwordChangeRequested"/>
16205
16685
</docblock>
16206
<argument line="2430">
16686
<argument line="2414">
16207
16687
<name>$password</name>
16208
16688
<default><![CDATA[]]></default>
16209
16689
<type/>
16210
16690
</argument>
16211
<argument line="2430">
16691
<argument line="2414">
16212
16692
<name>$modules</name>
16213
16693
<default><![CDATA[]]></default>
16214
16694
<type/>
16215
16695
</argument>
16216
<argument line="2430">
16696
<argument line="2414">
16217
16697
<name>$forcePasswordChange</name>
16218
16698
<default><![CDATA[]]></default>
16219
16699
<type/>
16220
16700
</argument>
16221
16701
</method>
16222
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2451" package="modules">
16702
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2435" package="modules">
16223
16703
<name>getGroupName</name>
16224
16704
<full_name>getGroupName</full_name>
16225
<docblock line="2445">
16705
<docblock line="2429">
16226
16706
<description><![CDATA[Returns the group name of the group with the given group ID.]]></description>
16227
16707
<long-description><![CDATA[]]></long-description>
16228
<tag line="2445" name="param" description="group ID" type="String" variable="$groupID">
16708
<tag line="2429" name="param" description="group ID" type="String" variable="$groupID">
16229
16709
<type by_reference="false">String</type>
16230
16710
</tag>
16231
<tag line="2445" name="return" description="group name" type="String">
16711
<tag line="2429" name="return" description="group name" type="String">
16232
16712
<type by_reference="false">String</type>
16233
16713
</tag>
16234
16714
</docblock>
16235
<argument line="2451">
16715
<argument line="2435">
16236
16716
<name>$groupID</name>
16237
16717
<default><![CDATA[]]></default>
16238
16718
<type/>
16239
16719
</argument>
16240
16720
</method>
16241
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2465" package="modules">
16721
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2449" package="modules">
16242
16722
<name>getPasswordMustChangeTime</name>
16243
16723
<full_name>getPasswordMustChangeTime</full_name>
16244
<docblock line="2459">
16724
<docblock line="2443">
16245
16725
<description><![CDATA[Returns the time when the user needs to change his password.]]></description>
16246
16726
<long-description><![CDATA[]]></long-description>
16247
<tag line="2459" name="param" description="list of domain objects" type="array" variable="$domains">
16727
<tag line="2443" name="param" description="list of domain objects" type="array" variable="$domains">
16248
16728
<type by_reference="false">array</type>
16249
16729
</tag>
16250
<tag line="2459" name="param" description="selected domain name" type="String" variable="$selectedDomain">
16730
<tag line="2443" name="param" description="selected domain name" type="String" variable="$selectedDomain">
16251
16731
<type by_reference="false">String</type>
16252
16732
</tag>
16253
16733
</docblock>
16254
<argument line="2465">
16734
<argument line="2449">
16255
16735
<name>$domains</name>
16256
16736
<default><![CDATA[]]></default>
16257
16737
<type/>
16258
16738
</argument>
16259
<argument line="2465">
16739
<argument line="2449">
16260
16740
<name>$selectedDomain</name>
16261
16741
<default><![CDATA[]]></default>
16262
16742
<type/>
16263
16743
</argument>
16264
16744
</method>
16265
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2497" package="modules">
16745
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2481" package="modules">
16266
16746
<name>getPasswordCanChangeTime</name>
16267
16747
<full_name>getPasswordCanChangeTime</full_name>
16268
<docblock line="2491">
16748
<docblock line="2475">
16269
16749
<description><![CDATA[Returns the time when the user can change his password.]]></description>
16270
16750
<long-description><![CDATA[]]></long-description>
16271
<tag line="2491" name="param" description="list of domain objects" type="array" variable="$domains">
16751
<tag line="2475" name="param" description="list of domain objects" type="array" variable="$domains">
16272
16752
<type by_reference="false">array</type>
16273
16753
</tag>
16274
<tag line="2491" name="param" description="selected domain name" type="String" variable="$selectedDomain">
16754
<tag line="2475" name="param" description="selected domain name" type="String" variable="$selectedDomain">
16275
16755
<type by_reference="false">String</type>
16276
16756
</tag>
16277
16757
</docblock>
16278
<argument line="2497">
16758
<argument line="2481">
16279
16759
<name>$domains</name>
16280
16760
<default><![CDATA[]]></default>
16281
16761
<type/>
16282
16762
</argument>
16283
<argument line="2497">
16763
<argument line="2481">
16284
16764
<name>$selectedDomain</name>
16285
16765
<default><![CDATA[]]></default>
16286
16766
<type/>
16287
16767
</argument>
16288
16768
</method>
16769
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2508" package="modules">
16770
<name>getHostList</name>
16771
<full_name>getHostList</full_name>
16772
<docblock line="2503">
16773
<description><![CDATA[Returns a list of existing hosts.]]></description>
16774
<long-description><![CDATA[]]></long-description>
16775
<tag line="2503" name="return" description="host names" type="array">
16776
<type by_reference="false">array</type>
16777
</tag>
16778
</docblock>
16779
</method>
16289
16780
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2524" package="modules">
16290
<name>getHostList</name>
16291
<full_name>getHostList</full_name>
16781
<name>getGroupSIDList</name>
16782
<full_name>getGroupSIDList</full_name>
16292
16783
<docblock line="2519">
16293
16784
<description><![CDATA[Returns a list of existing hosts.]]></description>
16294
16785
<long-description><![CDATA[]]></long-description>
16297
16788
</tag>
16298
16789
</docblock>
16299
16790
</method>
16300
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2540" package="modules">
16301
<name>getGroupSIDList</name>
16302
<full_name>getGroupSIDList</full_name>
16303
<docblock line="2535">
16304
<description><![CDATA[Returns a list of existing hosts.]]></description>
16305
<long-description><![CDATA[]]></long-description>
16306
<tag line="2535" name="return" description="host names" type="array">
16307
<type by_reference="false">array</type>
16308
</tag>
16309
</docblock>
16310
</method>
16311
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2559" package="modules">
16791
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2543" package="modules">
16312
16792
<name>getDomains</name>
16313
16793
<full_name>getDomains</full_name>
16314
<docblock line="2554">
16794
<docblock line="2538">
16315
16795
<description><![CDATA[Returns a list of existing Samba 3 domains.]]></description>
16316
16796
<long-description><![CDATA[]]></long-description>
16317
<tag line="2554" name="return" description="list of samba3domain objects" type="array">
16797
<tag line="2538" name="return" description="list of samba3domain objects" type="array">
16318
16798
<type by_reference="false">array</type>
16319
16799
</tag>
16320
16800
</docblock>
16321
16801
</method>
16322
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2575" package="modules">
16802
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2559" package="modules">
16323
16803
<name>setExpirationDate</name>
16324
16804
<full_name>setExpirationDate</full_name>
16325
<docblock line="2567">
16805
<docblock line="2551">
16326
16806
<description><![CDATA[Sets the expiration date of this account.]]></description>
16327
16807
<long-description><![CDATA[<p>If all parameters are null the expiration date will be removed.</p>]]></long-description>
16328
<tag line="2567" name="param" description="year (e.g. 2040)" type="String" variable="$year">
16329
<type by_reference="false">String</type>
16330
</tag>
16331
<tag line="2567" name="param" description="month (e.g. 8)" type="String" variable="$month">
16332
<type by_reference="false">String</type>
16333
</tag>
16334
<tag line="2567" name="param" description="day (e.g. 27)" type="String" variable="$day">
16808
<tag line="2551" name="param" description="year (e.g. 2040)" type="String" variable="$year">
16809
<type by_reference="false">String</type>
16810
</tag>
16811
<tag line="2551" name="param" description="month (e.g. 8)" type="String" variable="$month">
16812
<type by_reference="false">String</type>
16813
</tag>
16814
<tag line="2551" name="param" description="day (e.g. 27)" type="String" variable="$day">
16335
16815
<type by_reference="false">String</type>
16336
16816
</tag>
16337
16817
</docblock>
16338
<argument line="2575">
16818
<argument line="2559">
16339
16819
<name>$year</name>
16340
16820
<default><![CDATA[]]></default>
16341
16821
<type/>
16342
16822
</argument>
16343
<argument line="2575">
16823
<argument line="2559">
16344
16824
<name>$month</name>
16345
16825
<default><![CDATA[]]></default>
16346
16826
<type/>
16347
16827
</argument>
16348
<argument line="2575">
16828
<argument line="2559">
16349
16829
<name>$day</name>
16350
16830
<default><![CDATA[]]></default>
16351
16831
<type/>
16352
16832
</argument>
16353
16833
</method>
16354
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2589" package="modules">
16834
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2573" package="modules">
16355
16835
<name>isExtensionEnabled</name>
16356
16836
<full_name>isExtensionEnabled</full_name>
16357
<docblock line="2584">
16837
<docblock line="2568">
16358
16838
<description><![CDATA[Returns if the Samba extension is enabled.]]></description>
16359
16839
<long-description><![CDATA[]]></long-description>
16360
<tag line="2584" name="return" description="Samba extension is active" type="boolean">
16840
<tag line="2568" name="return" description="Samba extension is active" type="boolean">
16361
16841
<type by_reference="false">boolean</type>
16362
16842
</tag>
16363
16843
</docblock>
16364
16844
</method>
16365
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2598" package="modules">
16845
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2582" package="modules">
16366
16846
<name>isDeactivated</name>
16367
16847
<full_name>isDeactivated</full_name>
16368
<docblock line="2593">
16848
<docblock line="2577">
16369
16849
<description><![CDATA[Returns if the Samba part of the current account is deactivated.]]></description>
16370
16850
<long-description><![CDATA[]]></long-description>
16371
<tag line="2593" name="return" description="account is locked" type="boolean">
16851
<tag line="2577" name="return" description="account is locked" type="boolean">
16372
16852
<type by_reference="false">boolean</type>
16373
16853
</tag>
16374
16854
</docblock>
16375
16855
</method>
16376
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2605" package="modules">
16856
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2589" package="modules">
16377
16857
<name>deactivate</name>
16378
16858
<full_name>deactivate</full_name>
16379
<docblock line="2602">
16859
<docblock line="2586">
16380
16860
<description><![CDATA[Deactivates this account.]]></description>
16381
16861
<long-description><![CDATA[]]></long-description>
16382
16862
</docblock>
16383
16863
</method>
16384
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2617" package="modules">
16864
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2601" package="modules">
16385
16865
<name>activate</name>
16386
16866
<full_name>activate</full_name>
16387
<docblock line="2614">
16867
<docblock line="2598">
16388
16868
<description><![CDATA[Activates this account.]]></description>
16389
16869
<long-description><![CDATA[]]></long-description>
16390
16870
</docblock>
16391
16871
</method>
16392
16872
</class>
16393
16873
</file>
16394
<file path="lib/modules/posixAccount.inc" hash="b575c7c63de18ea707997ed4700c41e8" package="modules">
16874
<file path="lib/modules/posixAccount.inc" hash="72f224c418fbf9ea457dcc8e53cbaf6a" package="modules">
16395
16875
<docblock line="24">
16396
16876
<description><![CDATA[Manages Unix accounts for users and hosts.]]></description>
16397
16877
<long-description><![CDATA[]]></long-description>
16499
16979
<long-description><![CDATA[]]></long-description>
16500
16980
</docblock>
16501
16981
</property>
16502
<property final="false" static="false" visibility="protected" line="70" namespace="global" package="main">
16503
<name>$SUGGEST_LONG_USER_NAME</name>
16504
<default><![CDATA[false]]></default>
16505
<docblock line="69">
16506
<description><![CDATA[if set to true the suggested user name for John Doe will be john.doe instead of jdoe]]></description>
16982
<property final="false" static="false" visibility="private" line="71" namespace="global" package="main">
16983
<name>$umlautReplacements</name>
16984
<default><![CDATA[array('ä' => 'ae', 'Ä' => 'Ae', 'ö' => 'oe', 'Ö' => 'Oe', 'ü' => 'ue', 'Ü' => 'Ue', 'ß' => 'ss', 'é' => 'e', 'è' => 'e', 'ô' => 'o', 'ç' => 'c')]]></default>
16985
<docblock line="70">
16986
<description><![CDATA[replacements for common umlauts]]></description>
16507
16987
<long-description><![CDATA[]]></long-description>
16508
16988
</docblock>
16509
16989
</property>
16510
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="75" package="modules">
16990
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="79" package="modules">
16511
16991
<name>load_Messages</name>
16512
16992
<full_name>load_Messages</full_name>
16513
<docblock line="72">
16993
<docblock line="76">
16514
16994
<description><![CDATA[This function fills the error message array with messages.]]></description>
16515
16995
<long-description><![CDATA[]]></long-description>
16516
16996
</docblock>
16517
16997
</method>
16518
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="125" package="modules">
16998
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="129" package="modules">
16519
16999
<name>get_metaData</name>
16520
17000
<full_name>get_metaData</full_name>
16521
<docblock line="118">
17001
<docblock line="122">
16522
17002
<description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
16523
17003
<long-description><![CDATA[]]></long-description>
16524
<tag line="118" name="return" description="array with meta data" type="array">
17004
<tag line="122" name="return" description="array with meta data" type="array">
16525
17005
<type by_reference="false">array</type>
16526
17006
</tag>
16527
<tag line="118" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
17007
<tag line="122" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
16528
17008
</docblock>
16529
17009
</method>
16530
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="496" package="modules">
17010
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="540" package="modules">
16531
17011
<name>init</name>
16532
17012
<full_name>init</full_name>
16533
<docblock line="491">
17013
<docblock line="535">
16534
17014
<description><![CDATA[Initializes the module after it became part of an accountContainer]]></description>
16535
17015
<long-description><![CDATA[]]></long-description>
16536
<tag line="491" name="param" description="the name of the accountContainer object ($_SESSION[$base])" type="string" variable="$base">
17016
<tag line="535" name="param" description="the name of the accountContainer object ($_SESSION[$base])" type="string" variable="$base">
16537
17017
<type by_reference="false">string</type>
16538
17018
</tag>
16539
17019
</docblock>
16540
<argument line="496">
17020
<argument line="540">
16541
17021
<name>$base</name>
16542
17022
<default><![CDATA[]]></default>
16543
17023
<type/>
16544
17024
</argument>
16545
17025
</method>
16546
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="515" package="modules">
17026
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="559" package="modules">
16547
17027
<name>module_complete</name>
16548
17028
<full_name>module_complete</full_name>
16549
<docblock line="510">
17029
<docblock line="554">
16550
17030
<description><![CDATA[This functions is used to check if all settings for this module have been made.]]></description>
16551
17031
<long-description><![CDATA[]]></long-description>
16552
<tag line="510" name="return" description="true, if settings are complete" type="boolean">
17032
<tag line="554" name="return" description="true, if settings are complete" type="boolean">
16553
17033
<type by_reference="false">boolean</type>
16554
17034
</tag>
16555
17035
</docblock>
16556
17036
</method>
16557
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="529" package="modules">
17037
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="573" package="modules">
16558
17038
<name>load_attributes</name>
16559
17039
<full_name>load_attributes</full_name>
16560
<docblock line="524">
17040
<docblock line="568">
16561
17041
<description><![CDATA[This function loads all needed LDAP attributes.]]></description>
16562
17042
<long-description><![CDATA[]]></long-description>
16563
<tag line="524" name="param" description="list of attributes" type="array" variable="$attr">
17043
<tag line="568" name="param" description="list of attributes" type="array" variable="$attr">
16564
17044
<type by_reference="false">array</type>
16565
17045
</tag>
16566
17046
</docblock>
16567
<argument line="529">
17047
<argument line="573">
16568
17048
<name>$attr</name>
16569
17049
<default><![CDATA[]]></default>
16570
17050
<type/>
16571
17051
</argument>
16572
17052
</method>
16573
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="563" package="modules">
17053
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="608" package="modules">
16574
17054
<name>save_attributes</name>
16575
17055
<full_name>save_attributes</full_name>
16576
<docblock line="551">
17056
<docblock line="596">
16577
17057
<description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
16578
17058
<long-description><![CDATA[]]></long-description>
16579
<tag line="551" name="return" description="list of modifications <br>This function returns an array with 3 entries: <br>array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) <br>DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) <br>"add" are attributes which have to be added to LDAP entry <br>"remove" are attributes which have to be removed from LDAP entry <br>"modify" are attributes which have to been modified in LDAP entry <br>"info" are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
17059
<tag line="596" name="return" description="list of modifications <br>This function returns an array with 3 entries: <br>array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) <br>DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) <br>"add" are attributes which have to be added to LDAP entry <br>"remove" are attributes which have to be removed from LDAP entry <br>"modify" are attributes which have to been modified in LDAP entry <br>"info" are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
16580
17060
<type by_reference="false">array</type>
16581
17061
</tag>
16582
17062
</docblock>
16583
17063
</method>
16584
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="637" package="modules">
17064
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="682" package="modules">
16585
17065
<name>postModifyActions</name>
16586
17066
<full_name>postModifyActions</full_name>
16587
<docblock line="628">
17067
<docblock line="673">
16588
17068
<description><![CDATA[Runs the postmodify actions.]]></description>
16589
17069
<long-description><![CDATA[]]></long-description>
16590
<tag line="628" name="see" description="\global\baseModule::postModifyActions()" refers="\global\baseModule::postModifyActions()"/>
16591
<tag line="628" name="param" description="" type="boolean" variable="$newAccount">
17070
<tag line="673" name="see" description="\global\baseModule::postModifyActions()" refers="\global\baseModule::postModifyActions()"/>
17071
<tag line="673" name="param" description="" type="boolean" variable="$newAccount">
16592
17072
<type by_reference="false">boolean</type>
16593
17073
</tag>
16594
<tag line="628" name="param" description="LDAP attributes of this entry" type="array" variable="$attributes">
17074
<tag line="673" name="param" description="LDAP attributes of this entry" type="array" variable="$attributes">
16595
17075
<type by_reference="false">array</type>
16596
17076
</tag>
16597
<tag line="628" name="return" description="array which contains status messages. Each entry is an array containing the status message parameters." type="array">
17077
<tag line="673" name="return" description="array which contains status messages. Each entry is an array containing the status message parameters." type="array">
16598
17078
<type by_reference="false">array</type>
16599
17079
</tag>
16600
17080
</docblock>
16601
<argument line="637">
17081
<argument line="682">
16602
17082
<name>$newAccount</name>
16603
17083
<default><![CDATA[]]></default>
16604
17084
<type/>
16605
17085
</argument>
16606
<argument line="637">
17086
<argument line="682">
16607
17087
<name>$attributes</name>
16608
17088
<default><![CDATA[]]></default>
16609
17089
<type/>
16610
17090
</argument>
16611
17091
</method>
16612
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="745" package="modules">
17092
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="830" package="modules">
16613
17093
<name>delete_attributes</name>
16614
17094
<full_name>delete_attributes</full_name>
16615
<docblock line="740">
17095
<docblock line="825">
16616
17096
<description><![CDATA[Additional LDAP operations on delete.]]></description>
16617
17097
<long-description><![CDATA[]]></long-description>
16618
<tag line="740" name="return" description="of LDAP operations, same as for save_attributes()" type="\List">
17098
<tag line="825" name="return" description="of LDAP operations, same as for save_attributes()" type="\List">
16619
17099
<type by_reference="false">\List</type>
16620
17100
</tag>
16621
17101
</docblock>
16622
17102
</method>
16623
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="776" package="modules">
17103
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="861" package="modules">
16624
17104
<name>preDeleteActions</name>
16625
17105
<full_name>preDeleteActions</full_name>
16626
<docblock line="771">
17106
<docblock line="856">
16627
17107
<description><![CDATA[Allows the module to run commands before the LDAP entry is deleted.]]></description>
16628
17108
<long-description><![CDATA[]]></long-description>
16629
<tag line="771" name="return" description="Array which contains status messages. Each entry is an array containing the status message parameters." type="array">
17109
<tag line="856" name="return" description="Array which contains status messages. Each entry is an array containing the status message parameters." type="array">
16630
17110
<type by_reference="false">array</type>
16631
17111
</tag>
16632
17112
</docblock>
16633
17113
</method>
16634
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="821" package="modules">
17114
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="906" package="modules">
16635
17115
<name>process_attributes</name>
16636
17116
<full_name>process_attributes</full_name>
16637
<docblock line="815">
17117
<docblock line="900">
16638
17118
<description><![CDATA[Processes user input of the primary module page.]]></description>
16639
17119
<long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
16640
<tag line="815" name="return" description="list of info/error messages" type="array">
17120
<tag line="900" name="return" description="list of info/error messages" type="array">
16641
17121
<type by_reference="false">array</type>
16642
17122
</tag>
16643
17123
</docblock>
16644
17124
</method>
16645
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="990" package="modules">
17125
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1089" package="modules">
16646
17126
<name>checkASCII</name>
16647
17127
<full_name>checkASCII</full_name>
16648
<docblock line="984">
17128
<docblock line="1083">
16649
17129
<description><![CDATA[Checks if an attribute contains only ASCII charaters and replaces invalid characters.]]></description>
16650
17130
<long-description><![CDATA[]]></long-description>
16651
<tag line="984" name="param" description="attribute value" type="string" variable="$attribute">
17131
<tag line="1083" name="param" description="attribute value" type="string" variable="$attribute">
16652
17132
<type by_reference="false">string</type>
16653
17133
</tag>
16654
<tag line="984" name="return" description="attribute value with replaced non-ASCII characters" type="string">
17134
<tag line="1083" name="return" description="attribute value with replaced non-ASCII characters" type="string">
16655
17135
<type by_reference="false">string</type>
16656
17136
</tag>
16657
17137
</docblock>
16658
<argument line="990">
17138
<argument line="1089">
16659
17139
<name>$attribute</name>
16660
17140
<default><![CDATA[]]></default>
16661
17141
<type/>
16662
17142
</argument>
16663
17143
</method>
16664
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1015" package="modules">
17144
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1111" package="modules">
16665
17145
<name>process_group</name>
16666
17146
<full_name>process_group</full_name>
16667
<docblock line="1009">
17147
<docblock line="1105">
16668
17148
<description><![CDATA[Processes user input of the group selection page.]]></description>
16669
17149
<long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
16670
<tag line="1009" name="return" description="list of info/error messages" type="array">
17150
<tag line="1105" name="return" description="list of info/error messages" type="array">
16671
17151
<type by_reference="false">array</type>
16672
17152
</tag>
16673
17153
</docblock>
16674
17154
</method>
16675
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1043" package="modules">
17155
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1141" package="modules">
16676
17156
<name>process_homedir</name>
16677
17157
<full_name>process_homedir</full_name>
16678
<docblock line="1037">
17158
<docblock line="1135">
16679
17159
<description><![CDATA[Processes user input of the homedir check page.]]></description>
16680
17160
<long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
16681
<tag line="1037" name="return" description="list of info/error messages" type="array">
17161
<tag line="1135" name="return" description="list of info/error messages" type="array">
16682
17162
<type by_reference="false">array</type>
16683
17163
</tag>
16684
17164
</docblock>
16685
17165
</method>
16686
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1110" package="modules">
17166
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1208" package="modules">
16687
17167
<name>display_html_attributes</name>
16688
17168
<full_name>display_html_attributes</full_name>
16689
<docblock line="1105">
17169
<docblock line="1203">
16690
17170
<description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
16691
17171
<long-description><![CDATA[]]></long-description>
16692
<tag line="1105" name="return" description="HTML meta data" type="\htmlElement">
17172
<tag line="1203" name="return" description="HTML meta data" type="\htmlElement">
16693
17173
<type by_reference="false">\htmlElement</type>
16694
17174
</tag>
16695
17175
</docblock>
16696
17176
</method>
16697
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1244" package="modules">
17177
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1346" package="modules">
16698
17178
<name>display_html_delete</name>
16699
17179
<full_name>display_html_delete</full_name>
16700
<docblock line="1239">
17180
<docblock line="1341">
16701
17181
<description><![CDATA[Displays the delete homedir option for the delete page.]]></description>
16702
17182
<long-description><![CDATA[]]></long-description>
16703
<tag line="1239" name="return" description="meta HTML code" type="\htmlElement">
17183
<tag line="1341" name="return" description="meta HTML code" type="\htmlElement">
16704
17184
<type by_reference="false">\htmlElement</type>
16705
17185
</tag>
16706
17186
</docblock>
16707
17187
</method>
16708
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1258" package="modules">
17188
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1360" package="modules">
16709
17189
<name>display_html_group</name>
16710
17190
<full_name>display_html_group</full_name>
16711
<docblock line="1253">
17191
<docblock line="1355">
16712
17192
<description><![CDATA[Displays the group selection.]]></description>
16713
17193
<long-description><![CDATA[]]></long-description>
16714
<tag line="1253" name="return" description="meta HTML code" type="\htmlElement">
17194
<tag line="1355" name="return" description="meta HTML code" type="\htmlElement">
16715
17195
<type by_reference="false">\htmlElement</type>
16716
17196
</tag>
16717
17197
</docblock>
16718
17198
</method>
16719
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1356" package="modules">
17199
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1465" package="modules">
16720
17200
<name>display_html_homedir</name>
16721
17201
<full_name>display_html_homedir</full_name>
16722
<docblock line="1351">
17202
<docblock line="1460">
16723
17203
<description><![CDATA[Displays the delete homedir option for the homedir page.]]></description>
16724
17204
<long-description><![CDATA[]]></long-description>
16725
<tag line="1351" name="return" description="meta HTML code" type="\htmlElement">
17205
<tag line="1460" name="return" description="meta HTML code" type="\htmlElement">
16726
17206
<type by_reference="false">\htmlElement</type>
16727
17207
</tag>
16728
17208
</docblock>
16729
17209
</method>
16730
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1428" package="modules">
17210
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1537" package="modules">
16731
17211
<name>get_profileOptions</name>
16732
17212
<full_name>get_profileOptions</full_name>
16733
<docblock line="1423">
17213
<docblock line="1532">
16734
17214
<description><![CDATA[Returns a list of elements for the account profiles.]]></description>
16735
17215
<long-description><![CDATA[]]></long-description>
16736
<tag line="1423" name="return" description="elements" type="\profile">
17216
<tag line="1532" name="return" description="elements" type="\profile">
16737
17217
<type by_reference="false">\profile</type>
16738
17218
</tag>
16739
17219
</docblock>
16740
17220
</method>
16741
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1494" package="modules">
17221
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1603" package="modules">
16742
17222
<name>load_profile</name>
16743
17223
<full_name>load_profile</full_name>
16744
<docblock line="1489">
17224
<docblock line="1598">
16745
17225
<description><![CDATA[Loads the values of an account profile into internal variables.]]></description>
16746
17226
<long-description><![CDATA[]]></long-description>
16747
<tag line="1489" name="param" description="hash array with profile values (identifier => value)" type="array" variable="$profile">
17227
<tag line="1598" name="param" description="hash array with profile values (identifier => value)" type="array" variable="$profile">
16748
17228
<type by_reference="false">array</type>
16749
17229
</tag>
16750
17230
</docblock>
16751
<argument line="1494">
17231
<argument line="1603">
16752
17232
<name>$profile</name>
16753
17233
<default><![CDATA[]]></default>
16754
17234
<type/>
16755
17235
</argument>
16756
17236
</method>
16757
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1535" package="modules">
17237
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1644" package="modules">
16758
17238
<name>get_pdfEntries</name>
16759
17239
<full_name>get_pdfEntries</full_name>
16760
<docblock line="1530">
17240
<docblock line="1639">
16761
17241
<description><![CDATA[Returns the PDF entries for this module.]]></description>
16762
17242
<long-description><![CDATA[]]></long-description>
16763
<tag line="1530" name="return" description="list of possible PDF entries" type="array">
17243
<tag line="1639" name="return" description="list of possible PDF entries" type="array">
16764
17244
<type by_reference="false">array</type>
16765
17245
</tag>
16766
17246
</docblock>
16767
17247
</method>
16768
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1579" package="modules">
17248
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1686" package="modules">
16769
17249
<name>check_configOptions</name>
16770
17250
<full_name>check_configOptions</full_name>
16771
<docblock line="1572">
17251
<docblock line="1679">
16772
17252
<description><![CDATA[Checks input values of module settings.]]></description>
16773
17253
<long-description><![CDATA[]]></long-description>
16774
<tag line="1572" name="param" description="list of account types which are used" type="array" variable="$scopes">
16775
<type by_reference="false">array</type>
16776
</tag>
16777
<tag line="1572" name="param" description="hash array containing the settings (array('option' => array('value')))" type="array" variable="$options">
16778
<type by_reference="false">array</type>
16779
</tag>
16780
<tag line="1572" name="return" description="list of error messages" type="array">
17254
<tag line="1679" name="param" description="list of account types which are used" type="array" variable="$scopes">
17255
<type by_reference="false">array</type>
17256
</tag>
17257
<tag line="1679" name="param" description="hash array containing the settings (array('option' => array('value')))" type="array" variable="$options">
17258
<type by_reference="false">array</type>
17259
</tag>
17260
<tag line="1679" name="return" description="list of error messages" type="array">
16781
17261
<type by_reference="false">array</type>
16782
17262
</tag>
16783
17263
</docblock>
16784
<argument line="1579">
17264
<argument line="1686">
16785
17265
<name>$scopes</name>
16786
17266
<default><![CDATA[]]></default>
16787
17267
<type/>
16788
17268
</argument>
16789
<argument line="1579">
17269
<argument line="1686">
16790
17270
<name>$options</name>
16791
17271
<default><![CDATA[]]></default>
16792
17272
<type/>
16793
17273
</argument>
16794
17274
</method>
16795
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1654" package="modules">
17275
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1761" package="modules">
16796
17276
<name>build_uploadAccounts</name>
16797
17277
<full_name>build_uploadAccounts</full_name>
16798
<docblock line="1645">
17278
<docblock line="1752">
16799
17279
<description><![CDATA[In this function the LDAP account is built up.]]></description>
16800
17280
<long-description><![CDATA[]]></long-description>
16801
<tag line="1645" name="param" description="list of hash arrays (name => value) from user input" type="array" variable="$rawAccounts">
16802
<type by_reference="false">array</type>
16803
</tag>
16804
<tag line="1645" name="param" description="list of IDs for column position (e.g. "posixAccount_uid" => 5)" type="array" variable="$ids">
16805
<type by_reference="false">array</type>
16806
</tag>
16807
<tag line="1645" name="param" description="list of hash arrays (name => value) which are later added to LDAP" type="array" variable="$partialAccounts">
16808
<type by_reference="false">array</type>
16809
</tag>
16810
<tag line="1645" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
16811
<type by_reference="false">array</type>
16812
</tag>
16813
<tag line="1645" name="return" description="list of error messages if any" type="array">
17281
<tag line="1752" name="param" description="list of hash arrays (name => value) from user input" type="array" variable="$rawAccounts">
17282
<type by_reference="false">array</type>
17283
</tag>
17284
<tag line="1752" name="param" description="list of IDs for column position (e.g. "posixAccount_uid" => 5)" type="array" variable="$ids">
17285
<type by_reference="false">array</type>
17286
</tag>
17287
<tag line="1752" name="param" description="list of hash arrays (name => value) which are later added to LDAP" type="array" variable="$partialAccounts">
17288
<type by_reference="false">array</type>
17289
</tag>
17290
<tag line="1752" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
17291
<type by_reference="false">array</type>
17292
</tag>
17293
<tag line="1752" name="return" description="list of error messages if any" type="array">
16814
17294
<type by_reference="false">array</type>
16815
17295
</tag>
16816
17296
</docblock>
16817
<argument line="1654">
17297
<argument line="1761">
16818
17298
<name>$rawAccounts</name>
16819
17299
<default><![CDATA[]]></default>
16820
17300
<type/>
16821
17301
</argument>
16822
<argument line="1654">
17302
<argument line="1761">
16823
17303
<name>$ids</name>
16824
17304
<default><![CDATA[]]></default>
16825
17305
<type/>
16826
17306
</argument>
16827
<argument line="1654">
17307
<argument line="1761">
16828
17308
<name>$partialAccounts</name>
16829
17309
<default><![CDATA[]]></default>
16830
17310
<type/>
16831
17311
</argument>
16832
<argument line="1654">
17312
<argument line="1761">
16833
17313
<name>$selectedModules</name>
16834
17314
<default><![CDATA[]]></default>
16835
17315
<type/>
16836
17316
</argument>
16837
17317
</method>
16838
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1930" package="modules">
17318
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2039" package="modules">
16839
17319
<name>doUploadPostActions</name>
16840
17320
<full_name>doUploadPostActions</full_name>
16841
<docblock line="1915">
17321
<docblock line="2024">
16842
17322
<description><![CDATA[This function executes one post upload action.]]></description>
16843
17323
<long-description><![CDATA[]]></long-description>
16844
<tag line="1915" name="param" description="array containing one account in each element" type="array" variable="$data">
16845
<type by_reference="false">array</type>
16846
</tag>
16847
<tag line="1915" name="param" description="array(<column_name> => <column number>)" type="array" variable="$ids">
16848
<type by_reference="false">array</type>
16849
</tag>
16850
<tag line="1915" name="param" description="list of accounts which were not created successfully" type="array" variable="$failed">
16851
<type by_reference="false">array</type>
16852
</tag>
16853
<tag line="1915" name="param" description="variable to store temporary data between two post actions" type="array" variable="$temp">
16854
<type by_reference="false">array</type>
16855
</tag>
16856
<tag line="1915" name="param" description="list of LDAP entries" type="array" variable="$accounts">
16857
<type by_reference="false">array</type>
16858
</tag>
16859
<tag line="1915" name="return" description="current status <br> array ( <br> 'status' => 'finished' | 'inProgress' <br> 'progress' => 0..100 <br> 'errors' => array (<array of parameters for StatusMessage>) <br> )" type="array">
17324
<tag line="2024" name="param" description="array containing one account in each element" type="array" variable="$data">
17325
<type by_reference="false">array</type>
17326
</tag>
17327
<tag line="2024" name="param" description="array(<column_name> => <column number>)" type="array" variable="$ids">
17328
<type by_reference="false">array</type>
17329
</tag>
17330
<tag line="2024" name="param" description="list of accounts which were not created successfully" type="array" variable="$failed">
17331
<type by_reference="false">array</type>
17332
</tag>
17333
<tag line="2024" name="param" description="variable to store temporary data between two post actions" type="array" variable="$temp">
17334
<type by_reference="false">array</type>
17335
</tag>
17336
<tag line="2024" name="param" description="list of LDAP entries" type="array" variable="$accounts">
17337
<type by_reference="false">array</type>
17338
</tag>
17339
<tag line="2024" name="return" description="current status <br> array ( <br> 'status' => 'finished' | 'inProgress' <br> 'progress' => 0..100 <br> 'errors' => array (<array of parameters for StatusMessage>) <br> )" type="array">
16860
17340
<type by_reference="false">array</type>
16861
17341
</tag>
16862
17342
</docblock>
16863
<argument line="1930">
17343
<argument line="2039">
16864
17344
<name>$data</name>
16865
17345
<default><![CDATA[]]></default>
16866
17346
<type/>
16867
17347
</argument>
16868
<argument line="1930">
17348
<argument line="2039">
16869
17349
<name>$ids</name>
16870
17350
<default><![CDATA[]]></default>
16871
17351
<type/>
16872
17352
</argument>
16873
<argument line="1930">
17353
<argument line="2039">
16874
17354
<name>$failed</name>
16875
17355
<default><![CDATA[]]></default>
16876
17356
<type/>
16877
17357
</argument>
16878
<argument line="1930">
17358
<argument line="2039">
16879
17359
<name>$temp</name>
16880
17360
<default><![CDATA[]]></default>
16881
17361
<type/>
16882
17362
</argument>
16883
<argument line="1930">
17363
<argument line="2039">
16884
17364
<name>$accounts</name>
16885
17365
<default><![CDATA[]]></default>
16886
17366
<type/>
16887
17367
</argument>
16888
17368
</method>
16889
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2111" package="modules">
17369
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2220" package="modules">
16890
17370
<name>getNextUIDs</name>
16891
17371
<full_name>getNextUIDs</full_name>
16892
<docblock line="2104">
17372
<docblock line="2213">
16893
17373
<description><![CDATA[Returns one or more free UID numbers.]]></description>
16894
17374
<long-description><![CDATA[]]></long-description>
16895
<tag line="2104" name="param" description="Number of needed free UIDs." type="integer" variable="$count">
17375
<tag line="2213" name="param" description="Number of needed free UIDs." type="integer" variable="$count">
16896
17376
<type by_reference="false">integer</type>
16897
17377
</tag>
16898
<tag line="2104" name="param" description="list of error messages where errors can be added" type="array" variable="$errors">
17378
<tag line="2213" name="param" description="list of error messages where errors can be added" type="array" variable="$errors">
16899
17379
<type by_reference="false">array</type>
16900
17380
</tag>
16901
<tag line="2104" name="return" description="Null if no UIDs are free else an array of free UIDs." type="mixed">
17381
<tag line="2213" name="return" description="Null if no UIDs are free else an array of free UIDs." type="mixed">
16902
17382
<type by_reference="false">mixed</type>
16903
17383
</tag>
16904
17384
</docblock>
16905
<argument line="2111">
17385
<argument line="2220">
16906
17386
<name>$count</name>
16907
17387
<default><![CDATA[]]></default>
16908
17388
<type/>
16909
17389
</argument>
16910
<argument line="2111">
17390
<argument line="2220">
16911
17391
<name>$errors</name>
16912
17392
<default><![CDATA[]]></default>
16913
17393
<type/>
16914
17394
</argument>
16915
17395
</method>
16916
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2178" package="modules">
17396
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2287" package="modules">
16917
17397
<name>getNextSambaPoolUIDs</name>
16918
17398
<full_name>getNextSambaPoolUIDs</full_name>
16919
<docblock line="2171">
17399
<docblock line="2280">
16920
17400
<description><![CDATA[Gets the free UID numbers from an Samba pool entry in LDAP.]]></description>
16921
17401
<long-description><![CDATA[]]></long-description>
16922
<tag line="2171" name="param" description="number of needed free UIDs." type="integer" variable="$count">
17402
<tag line="2280" name="param" description="number of needed free UIDs." type="integer" variable="$count">
16923
17403
<type by_reference="false">integer</type>
16924
17404
</tag>
16925
<tag line="2171" name="param" description="list of error messages where errors can be added" type="array" variable="$errors">
17405
<tag line="2280" name="param" description="list of error messages where errors can be added" type="array" variable="$errors">
16926
17406
<type by_reference="false">array</type>
16927
17407
</tag>
16928
<tag line="2171" name="return" description="null if no UIDs are free else an array of free UIDs" type="mixed">
17408
<tag line="2280" name="return" description="null if no UIDs are free else an array of free UIDs" type="mixed">
16929
17409
<type by_reference="false">mixed</type>
16930
17410
</tag>
16931
17411
</docblock>
16932
<argument line="2178">
17412
<argument line="2287">
16933
17413
<name>$count</name>
16934
17414
<default><![CDATA[]]></default>
16935
17415
<type/>
16936
17416
</argument>
16937
<argument line="2178">
17417
<argument line="2287">
16938
17418
<name>$errors</name>
16939
17419
<default><![CDATA[]]></default>
16940
17420
<type/>
16941
17421
</argument>
16942
17422
</method>
16943
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2215" package="modules">
17423
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2324" package="modules">
16944
17424
<name>getSelfServiceOptions</name>
16945
17425
<full_name>getSelfServiceOptions</full_name>
16946
<docblock line="2204">
17426
<docblock line="2313">
16947
17427
<description><![CDATA[Returns the meta HTML code for each input field.]]></description>
16948
17428
<long-description><![CDATA[<p>format: array(<field1> => array(<META HTML>), ...)
16949
17429
It is not possible to display help links.</p>]]></long-description>
16950
<tag line="2204" name="param" description="list of active fields" type="array" variable="$fields">
16951
<type by_reference="false">array</type>
16952
</tag>
16953
<tag line="2204" name="param" description="attributes of LDAP account" type="array" variable="$attributes">
16954
<type by_reference="false">array</type>
16955
</tag>
16956
<tag line="2204" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
17430
<tag line="2313" name="param" description="list of active fields" type="array" variable="$fields">
17431
<type by_reference="false">array</type>
17432
</tag>
17433
<tag line="2313" name="param" description="attributes of LDAP account" type="array" variable="$attributes">
17434
<type by_reference="false">array</type>
17435
</tag>
17436
<tag line="2313" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
16957
17437
<type by_reference="false">boolean</type>
16958
17438
</tag>
16959
<tag line="2204" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
17439
<tag line="2313" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
16960
17440
<type by_reference="false">array</type>
16961
17441
</tag>
16962
<tag line="2204" name="return" description="list of meta HTML elements (field name => htmlTableRow)" type="array">
17442
<tag line="2313" name="return" description="list of meta HTML elements (field name => htmlTableRow)" type="array">
16963
17443
<type by_reference="false">array</type>
16964
17444
</tag>
16965
17445
</docblock>
16966
<argument line="2215">
17446
<argument line="2324">
16967
17447
<name>$fields</name>
16968
17448
<default><![CDATA[]]></default>
16969
17449
<type/>
16970
17450
</argument>
16971
<argument line="2215">
17451
<argument line="2324">
16972
17452
<name>$attributes</name>
16973
17453
<default><![CDATA[]]></default>
16974
17454
<type/>
16975
17455
</argument>
16976
<argument line="2215">
17456
<argument line="2324">
16977
17457
<name>$passwordChangeOnly</name>
16978
17458
<default><![CDATA[]]></default>
16979
17459
<type/>
16980
17460
</argument>
16981
<argument line="2215">
17461
<argument line="2324">
16982
17462
<name>$readOnlyFields</name>
16983
17463
<default><![CDATA[]]></default>
16984
17464
<type/>
16985
17465
</argument>
16986
17466
</method>
16987
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2276" package="modules">
17467
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2385" package="modules">
16988
17468
<name>checkSelfServiceOptions</name>
16989
17469
<full_name>checkSelfServiceOptions</full_name>
16990
<docblock line="2259">
17470
<docblock line="2368">
16991
17471
<description><![CDATA[Checks if all input values are correct and returns the LDAP attributes which should be changed.]]></description>
16992
17472
<long-description><![CDATA[<p><br>Return values:
16993
17473
<br>messages: array of parameters to create status messages
16997
17477
<br>"info" are values with informational value (e.g. to be used later by pre/postModify actions)</p>
16998
17478
16999
17479
<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
17000
<tag line="2259" name="param" description="input fields" type="string" variable="$fields">
17480
<tag line="2368" name="param" description="input fields" type="string" variable="$fields">
17001
17481
<type by_reference="false">string</type>
17002
17482
</tag>
17003
<tag line="2259" name="param" description="LDAP attributes" type="array" variable="$attributes">
17483
<tag line="2368" name="param" description="LDAP attributes" type="array" variable="$attributes">
17004
17484
<type by_reference="false">array</type>
17005
17485
</tag>
17006
<tag line="2259" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
17486
<tag line="2368" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
17007
17487
<type by_reference="false">boolean</type>
17008
17488
</tag>
17009
<tag line="2259" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
17489
<tag line="2368" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
17010
17490
<type by_reference="false">array</type>
17011
17491
</tag>
17012
<tag line="2259" name="return" description="messages and attributes (array('messages' => array(), 'add' => array('mail' => array('test@test.com')), 'del' => array(), 'mod' => array(), 'info' => array()))" type="array">
17492
<tag line="2368" name="return" description="messages and attributes (array('messages' => array(), 'add' => array('mail' => array('test@test.com')), 'del' => array(), 'mod' => array(), 'info' => array()))" type="array">
17013
17493
<type by_reference="false">array</type>
17014
17494
</tag>
17015
17495
</docblock>
17016
<argument line="2276">
17496
<argument line="2385">
17017
17497
<name>$fields</name>
17018
17498
<default><![CDATA[]]></default>
17019
17499
<type/>
17020
17500
</argument>
17021
<argument line="2276">
17501
<argument line="2385">
17022
17502
<name>$attributes</name>
17023
17503
<default><![CDATA[]]></default>
17024
17504
<type/>
17025
17505
</argument>
17026
<argument line="2276">
17506
<argument line="2385">
17027
17507
<name>$passwordChangeOnly</name>
17028
17508
<default><![CDATA[]]></default>
17029
17509
<type/>
17030
17510
</argument>
17031
<argument line="2276">
17511
<argument line="2385">
17032
17512
<name>$readOnlyFields</name>
17033
17513
<default><![CDATA[]]></default>
17034
17514
<type/>
17035
17515
</argument>
17036
17516
</method>
17037
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2336" package="modules">
17517
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2445" package="modules">
17038
17518
<name>managesPasswordAttributes</name>
17039
17519
<full_name>managesPasswordAttributes</full_name>
17040
<docblock line="2330">
17520
<docblock line="2439">
17041
17521
<description><![CDATA[This method specifies if a module manages password attributes.]]></description>
17042
17522
<long-description><![CDATA[]]></long-description>
17043
<tag line="2330" name="see" description="\global\passwordService::managesPasswordAttributes" refers="\global\passwordService::managesPasswordAttributes"/>
17044
<tag line="2330" name="return" description="true if this module manages password attributes" type="boolean">
17523
<tag line="2439" name="see" description="\global\passwordService::managesPasswordAttributes" refers="\global\passwordService::managesPasswordAttributes"/>
17524
<tag line="2439" name="return" description="true if this module manages password attributes" type="boolean">
17045
17525
<type by_reference="false">boolean</type>
17046
17526
</tag>
17047
17527
</docblock>
17048
17528
</method>
17049
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2345" package="modules">
17529
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2454" package="modules">
17050
17530
<name>supportsForcePasswordChange</name>
17051
17531
<full_name>supportsForcePasswordChange</full_name>
17052
<docblock line="2340">
17532
<docblock line="2449">
17053
17533
<description><![CDATA[Specifies if this module supports to force that a user must change his password on next login.]]></description>
17054
17534
<long-description><![CDATA[]]></long-description>
17055
<tag line="2340" name="return" description="force password change supported" type="boolean">
17535
<tag line="2449" name="return" description="force password change supported" type="boolean">
17056
17536
<type by_reference="false">boolean</type>
17057
17537
</tag>
17058
17538
</docblock>
17059
17539
</method>
17060
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2360" package="modules">
17540
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2469" package="modules">
17061
17541
<name>passwordChangeRequested</name>
17062
17542
<full_name>passwordChangeRequested</full_name>
17063
<docblock line="2349">
17543
<docblock line="2458">
17064
17544
<description><![CDATA[This function is called whenever the password should be changed.]]></description>
17065
17545
<long-description><![CDATA[<p>Account modules
17066
17546
must change their password attributes only if the modules list contains their module name.</p>]]></long-description>
17067
<tag line="2349" name="param" description="new password" type="String" variable="$password">
17547
<tag line="2458" name="param" description="new password" type="String" variable="$password">
17068
17548
<type by_reference="false">String</type>
17069
17549
</tag>
17070
<tag line="2349" name="param" description="list of modules for which the password should be changed" type="\$modules" variable="$modules">
17550
<tag line="2458" name="param" description="list of modules for which the password should be changed" type="\$modules" variable="$modules">
17071
17551
<type by_reference="false">\$modules</type>
17072
17552
</tag>
17073
<tag line="2349" name="param" description="force the user to change his password at next login" type="boolean" variable="$forcePasswordChange">
17553
<tag line="2458" name="param" description="force the user to change his password at next login" type="boolean" variable="$forcePasswordChange">
17074
17554
<type by_reference="false">boolean</type>
17075
17555
</tag>
17076
<tag line="2349" name="return" description="list of error messages if any as parameter array for StatusMessage e.g. return arrray(array('ERROR', 'Password change failed.'))" type="array">
17556
<tag line="2458" name="return" description="list of error messages if any as parameter array for StatusMessage e.g. return arrray(array('ERROR', 'Password change failed.'))" type="array">
17077
17557
<type by_reference="false">array</type>
17078
17558
</tag>
17079
<tag line="2349" name="see" description="\global\passwordService::passwordChangeRequested" refers="\global\passwordService::passwordChangeRequested"/>
17559
<tag line="2458" name="see" description="\global\passwordService::passwordChangeRequested" refers="\global\passwordService::passwordChangeRequested"/>
17080
17560
</docblock>
17081
<argument line="2360">
17561
<argument line="2469">
17082
17562
<name>$password</name>
17083
17563
<default><![CDATA[]]></default>
17084
17564
<type/>
17085
17565
</argument>
17086
<argument line="2360">
17566
<argument line="2469">
17087
17567
<name>$modules</name>
17088
17568
<default><![CDATA[]]></default>
17089
17569
<type/>
17090
17570
</argument>
17091
<argument line="2360">
17571
<argument line="2469">
17092
17572
<name>$forcePasswordChange</name>
17093
17573
<default><![CDATA[]]></default>
17094
17574
<type/>
17095
17575
</argument>
17096
17576
</method>
17097
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2375" package="modules">
17577
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2484" package="modules">
17098
17578
<name>getGID</name>
17099
17579
<full_name>getGID</full_name>
17100
<docblock line="2369">
17580
<docblock line="2478">
17101
17581
<description><![CDATA[Returns the group ID of the given group.]]></description>
17102
17582
<long-description><![CDATA[]]></long-description>
17103
<tag line="2369" name="param" description="group name" type="String" variable="$groupname">
17583
<tag line="2478" name="param" description="group name" type="String" variable="$groupname">
17104
17584
<type by_reference="false">String</type>
17105
17585
</tag>
17106
<tag line="2369" name="return" description="GID" type="String">
17586
<tag line="2478" name="return" description="GID" type="String">
17107
17587
<type by_reference="false">String</type>
17108
17588
</tag>
17109
17589
</docblock>
17110
<argument line="2375">
17590
<argument line="2484">
17111
17591
<name>$groupname</name>
17112
17592
<default><![CDATA[]]></default>
17113
17593
<type/>
17114
17594
</argument>
17115
17595
</method>
17116
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2389" package="modules">
17596
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2498" package="modules">
17117
17597
<name>getGroupName</name>
17118
17598
<full_name>getGroupName</full_name>
17119
<docblock line="2383">
17599
<docblock line="2492">
17120
17600
<description><![CDATA[Returns the group name of the group with the given group ID.]]></description>
17121
17601
<long-description><![CDATA[]]></long-description>
17122
<tag line="2383" name="param" description="group ID" type="String" variable="$groupID">
17602
<tag line="2492" name="param" description="group ID" type="String" variable="$groupID">
17123
17603
<type by_reference="false">String</type>
17124
17604
</tag>
17125
<tag line="2383" name="return" description="group name" type="String">
17605
<tag line="2492" name="return" description="group name" type="String">
17126
17606
<type by_reference="false">String</type>
17127
17607
</tag>
17128
17608
</docblock>
17129
<argument line="2389">
17609
<argument line="2498">
17130
17610
<name>$groupID</name>
17131
17611
<default><![CDATA[]]></default>
17132
17612
<type/>
17133
17613
</argument>
17134
17614
</method>
17135
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2403" package="modules">
17615
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2512" package="modules">
17136
17616
<name>getGroupDN</name>
17137
17617
<full_name>getGroupDN</full_name>
17138
<docblock line="2397">
17618
<docblock line="2506">
17139
17619
<description><![CDATA[Returns the group DN of the given group.]]></description>
17140
17620
<long-description><![CDATA[]]></long-description>
17141
<tag line="2397" name="param" description="group name" type="String" variable="$groupname">
17621
<tag line="2506" name="param" description="group name" type="String" variable="$groupname">
17142
17622
<type by_reference="false">String</type>
17143
17623
</tag>
17144
<tag line="2397" name="return" description="DN" type="String">
17624
<tag line="2506" name="return" description="DN" type="String">
17145
17625
<type by_reference="false">String</type>
17146
17626
</tag>
17147
17627
</docblock>
17148
<argument line="2403">
17628
<argument line="2512">
17149
17629
<name>$groupname</name>
17150
17630
<default><![CDATA[]]></default>
17151
17631
<type/>
17152
17632
</argument>
17153
17633
</method>
17154
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2416" package="modules">
17634
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2525" package="modules">
17155
17635
<name>findGroups</name>
17156
17636
<full_name>findGroups</full_name>
17157
<docblock line="2411">
17637
<docblock line="2520">
17158
17638
<description><![CDATA[Finds all existing LDAP groups.]]></description>
17159
17639
<long-description><![CDATA[]]></long-description>
17160
<tag line="2411" name="return" description="groups array(array(gidnumber, cn), array(gidnumber, cn), ...)" type="array">
17640
<tag line="2520" name="return" description="groups array(array(gidnumber, cn), array(gidnumber, cn), ...)" type="array">
17161
17641
<type by_reference="false">array</type>
17162
17642
</tag>
17163
17643
</docblock>
17164
17644
</method>
17165
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2436" package="modules">
17645
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2545" package="modules">
17166
17646
<name>findGroupOfNames</name>
17167
17647
<full_name>findGroupOfNames</full_name>
17168
<docblock line="2431">
17648
<docblock line="2540">
17169
17649
<description><![CDATA[Finds all existing LDAP group of names.]]></description>
17170
17650
<long-description><![CDATA[]]></long-description>
17171
<tag line="2431" name="return" description="groups array(dn => array('cn' => array('groupName'), 'objectClass' => array('top', 'groupOfNames')))" type="array">
17651
<tag line="2540" name="return" description="groups array(dn => array('cn' => array('groupName'), 'objectClass' => array('top', 'groupOfNames')))" type="array">
17172
17652
<type by_reference="false">array</type>
17173
17653
</tag>
17174
17654
</docblock>
17175
17655
</method>
17176
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2465" package="modules">
17656
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2574" package="modules">
17177
17657
<name>getUIDs</name>
17178
17658
<full_name>getUIDs</full_name>
17179
<docblock line="2460">
17659
<docblock line="2569">
17180
17660
<description><![CDATA[Returns a list of existing UID numbers.]]></description>
17181
17661
<long-description><![CDATA[]]></long-description>
17182
<tag line="2460" name="return" description="list of UID numbers" type="array">
17662
<tag line="2569" name="return" description="list of UID numbers" type="array">
17183
17663
<type by_reference="false">array</type>
17184
17664
</tag>
17185
17665
</docblock>
17186
17666
</method>
17187
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2507" package="modules">
17667
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2616" package="modules">
17188
17668
<name>userNameExists</name>
17189
17669
<full_name>userNameExists</full_name>
17190
<docblock line="2501">
17670
<docblock line="2610">
17191
17671
<description><![CDATA[Checks if the given user name already exists in LDAP.]]></description>
17192
17672
<long-description><![CDATA[]]></long-description>
17193
<tag line="2501" name="param" description="user name" type="String" variable="$userName">
17673
<tag line="2610" name="param" description="user name" type="String" variable="$userName">
17194
17674
<type by_reference="false">String</type>
17195
17675
</tag>
17196
<tag line="2501" name="return" description="true if already exists" type="boolean">
17676
<tag line="2610" name="return" description="true if already exists" type="boolean">
17197
17677
<type by_reference="false">boolean</type>
17198
17678
</tag>
17199
17679
</docblock>
17200
<argument line="2507">
17680
<argument line="2616">
17201
17681
<name>$userName</name>
17202
17682
<default><![CDATA[]]></default>
17203
17683
<type/>
17204
17684
</argument>
17205
17685
</method>
17206
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2516" package="modules">
17686
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2625" package="modules">
17207
17687
<name>getUserNames</name>
17208
17688
<full_name>getUserNames</full_name>
17209
<docblock line="2511">
17689
<docblock line="2620">
17210
17690
<description><![CDATA[Returns a list of all user names in LDAP.]]></description>
17211
17691
<long-description><![CDATA[]]></long-description>
17212
<tag line="2511" name="return" description="user names" type="array">
17692
<tag line="2620" name="return" description="user names" type="array">
17213
17693
<type by_reference="false">array</type>
17214
17694
</tag>
17215
17695
</docblock>
17216
17696
</method>
17217
<method final="false" abstract="false" static="true" visibility="public" namespace="global" line="2556" package="modules">
17697
<method final="false" abstract="false" static="true" visibility="public" namespace="global" line="2665" package="modules">
17218
17698
<name>areGroupOfNamesActive</name>
17219
17699
<full_name>areGroupOfNamesActive</full_name>
17220
<docblock line="2551">
17700
<docblock line="2660">
17221
17701
<description><![CDATA[Returns if LAM manages group of names entries.]]></description>
17222
17702
<long-description><![CDATA[]]></long-description>
17223
<tag line="2551" name="return" description="group of names are active" type="boolean">
17703
<tag line="2660" name="return" description="group of names are active" type="boolean">
17224
17704
<type by_reference="false">boolean</type>
17225
17705
</tag>
17226
17706
</docblock>
17227
17707
</method>
17228
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2582" package="modules">
17708
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2691" package="modules">
17229
17709
<name>getUserNameSuggestion</name>
17230
17710
<full_name>getUserNameSuggestion</full_name>
17231
<docblock line="2575">
17711
<docblock line="2684">
17232
17712
<description><![CDATA[Returns a suggestion for the user name.]]></description>
17233
17713
<long-description><![CDATA[<p>By deafult this wil be the first character of the first name plus the last name.</p>]]></long-description>
17234
<tag line="2575" name="param" description="LDAP attributes" type="array" variable="$attrs">
17714
<tag line="2684" name="param" description="LDAP attributes" type="array" variable="$attrs">
17235
17715
<type by_reference="false">array</type>
17236
17716
</tag>
17237
<tag line="2575" name="return" description="user name" type="String">
17717
<tag line="2684" name="return" description="user name" type="String">
17238
17718
<type by_reference="false">String</type>
17239
17719
</tag>
17240
17720
</docblock>
17241
<argument line="2582">
17721
<argument line="2691">
17242
17722
<name>$attrs</name>
17243
17723
<default><![CDATA[]]></default>
17244
17724
<type/>
17245
17725
</argument>
17246
17726
</method>
17247
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2603" package="modules">
17727
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2728" package="modules">
17248
17728
<name>isLockable</name>
17249
17729
<full_name>isLockable</full_name>
17250
<docblock line="2599">
17730
<docblock line="2724">
17251
17731
<description><![CDATA[Returns if this account can be locked.]]></description>
17252
17732
<long-description><![CDATA[<p>This is the case if a hashed password is set ("{" at the beginning).</p>]]></long-description>
17253
17733
</docblock>
17254
17734
</method>
17255
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2615" package="modules">
17735
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2740" package="modules">
17256
17736
<name>isLocked</name>
17257
17737
<full_name>isLocked</full_name>
17258
<docblock line="2610">
17738
<docblock line="2735">
17259
17739
<description><![CDATA[Returns if the Unix part of the current account is locked.]]></description>
17260
17740
<long-description><![CDATA[]]></long-description>
17261
<tag line="2610" name="return" description="password is locked" type="boolean">
17741
<tag line="2735" name="return" description="password is locked" type="boolean">
17262
17742
<type by_reference="false">boolean</type>
17263
17743
</tag>
17264
17744
</docblock>
17265
17745
</method>
17266
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2622" package="modules">
17746
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2747" package="modules">
17267
17747
<name>lock</name>
17268
17748
<full_name>lock</full_name>
17269
<docblock line="2619">
17749
<docblock line="2744">
17270
17750
<description><![CDATA[Locks the user password of this account.]]></description>
17271
17751
<long-description><![CDATA[]]></long-description>
17272
17752
</docblock>
17273
17753
</method>
17274
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2631" package="modules">
17754
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2756" package="modules">
17275
17755
<name>unlock</name>
17276
17756
<full_name>unlock</full_name>
17277
<docblock line="2628">
17757
<docblock line="2753">
17278
17758
<description><![CDATA[Unlocks the user password of this account.]]></description>
17279
17759
<long-description><![CDATA[]]></long-description>
17280
17760
</docblock>
17281
17761
</method>
17282
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2640" package="modules">
17762
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2765" package="modules">
17283
17763
<name>removeFromUnixGroups</name>
17284
17764
<full_name>removeFromUnixGroups</full_name>
17285
<docblock line="2637">
17765
<docblock line="2762">
17286
17766
<description><![CDATA[Removes all Unix group memberships from this user.]]></description>
17287
17767
<long-description><![CDATA[]]></long-description>
17288
17768
</docblock>
17289
17769
</method>
17290
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2647" package="modules">
17770
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2772" package="modules">
17291
17771
<name>removeFromGONGroups</name>
17292
17772
<full_name>removeFromGONGroups</full_name>
17293
<docblock line="2644">
17773
<docblock line="2769">
17294
17774
<description><![CDATA[Removes all group of names memberships from this user.]]></description>
17295
17775
<long-description><![CDATA[]]></long-description>
17296
17776
</docblock>
17297
17777
</method>
17298
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2661" package="modules">
17778
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="2786" package="modules">
17299
17779
<name>getNextUserName</name>
17300
17780
<full_name>getNextUserName</full_name>
17301
<docblock line="2651">
17781
<docblock line="2776">
17302
17782
<description><![CDATA[Returns the next possible user name based on the given one.]]></description>
17303
17783
<long-description><![CDATA[<p>If the user name does not end with a number then a "2" is added.
17304
17784
User names with numbers at the end are simply increased by one.
17305
17785
<br>
17306
17786
<br>Attention: This user name might still be in use. This needs to be checked separately.</p>]]></long-description>
17307
<tag line="2651" name="param" description="user name" type="String" variable="$userName">
17787
<tag line="2776" name="param" description="user name" type="String" variable="$userName">
17308
17788
<type by_reference="false">String</type>
17309
17789
</tag>
17310
<tag line="2651" name="return" description="new user name" type="String">
17790
<tag line="2776" name="return" description="new user name" type="String">
17311
17791
<type by_reference="false">String</type>
17312
17792
</tag>
17313
17793
</docblock>
17314
<argument line="2661">
17794
<argument line="2786">
17315
17795
<name>$userName</name>
17316
17796
<default><![CDATA[]]></default>
17317
17797
<type/>
17318
17798
</argument>
17319
17799
</method>
17320
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2714" package="modules">
17800
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2839" package="modules">
17321
17801
<name>getShells</name>
17322
17802
<full_name>getShells</full_name>
17323
<docblock line="2709">
17803
<docblock line="2834">
17324
17804
<description><![CDATA[Returns the list of possible login shells.]]></description>
17325
17805
<long-description><![CDATA[]]></long-description>
17326
<tag line="2709" name="return" description="login shells" type="array">
17327
<type by_reference="false">array</type>
17328
</tag>
17329
</docblock>
17330
</method>
17331
</class>
17332
</file>
17333
<file path="lib/modules/kolabUser.inc" hash="ed21ffc30534b8160821ded99c546501" package="modules">
17806
<tag line="2834" name="return" description="login shells" type="array">
17807
<type by_reference="false">array</type>
17808
</tag>
17809
</docblock>
17810
</method>
17811
</class>
17812
</file>
17813
<file path="lib/modules/windowsUser.inc" hash="0f8ca37abc9d4d1d0c81bbcebf518e09" package="modules">
17814
<docblock line="23">
17815
<description><![CDATA[Manages Windows AD (e.g.]]></description>
17816
<long-description><![CDATA[<p>Samba 4) users.</p>]]></long-description>
17817
<tag line="23" name="package" description="modules"/>
17818
<tag line="23" name="author" description="Roland Gruber"/>
17819
</docblock>
17820
<class final="false" abstract="false" namespace="global" line="35" package="modules">
17821
<extends>\baseModule</extends>
17822
<implements>\passwordService</implements>
17823
<name>windowsUser</name>
17824
<full_name>\windowsUser</full_name>
17825
<docblock line="30">
17826
<description><![CDATA[Manages Windows AD (e.g.]]></description>
17827
<long-description><![CDATA[<p>Samba 4) users.</p>]]></long-description>
17828
<tag line="30" name="package" description="modules"/>
17829
</docblock>
17830
<constant namespace="global" line="38" package="modules">
17831
<name>DEFAULT_ACCOUNT_CONTROL</name>
17832
<full_name>DEFAULT_ACCOUNT_CONTROL</full_name>
17833
<value><![CDATA[512]]></value>
17834
<docblock line="37">
17835
<description><![CDATA[initial account flags]]></description>
17836
<long-description><![CDATA[]]></long-description>
17837
</docblock>
17838
</constant>
17839
<constant namespace="global" line="40" package="modules">
17840
<name>AC_PWD_NEVER_EXPIRES</name>
17841
<full_name>AC_PWD_NEVER_EXPIRES</full_name>
17842
<value><![CDATA[65536]]></value>
17843
<docblock line="39">
17844
<description><![CDATA[password never expires]]></description>
17845
<long-description><![CDATA[]]></long-description>
17846
</docblock>
17847
</constant>
17848
<constant namespace="global" line="42" package="modules">
17849
<name>AC_SMARTCARD_REQUIRED</name>
17850
<full_name>AC_SMARTCARD_REQUIRED</full_name>
17851
<value><![CDATA[262144]]></value>
17852
<docblock line="41">
17853
<description><![CDATA[login requires smartcard]]></description>
17854
<long-description><![CDATA[]]></long-description>
17855
</docblock>
17856
</constant>
17857
<constant namespace="global" line="44" package="modules">
17858
<name>AC_ACCOUNT_DISABLED</name>
17859
<full_name>AC_ACCOUNT_DISABLED</full_name>
17860
<value><![CDATA[2]]></value>
17861
<docblock line="43">
17862
<description><![CDATA[account is disabled]]></description>
17863
<long-description><![CDATA[]]></long-description>
17864
</docblock>
17865
</constant>
17866
<constant namespace="global" line="46" package="modules">
17867
<name>AC_LOCKED_OUT</name>
17868
<full_name>AC_LOCKED_OUT</full_name>
17869
<value><![CDATA[16]]></value>
17870
<docblock line="45">
17871
<description><![CDATA[currently locked out, read only flag]]></description>
17872
<long-description><![CDATA[]]></long-description>
17873
</docblock>
17874
</constant>
17875
<property final="false" static="false" visibility="private" line="49" namespace="global" package="main">
17876
<name>$groupList</name>
17877
<default><![CDATA[array()]]></default>
17878
<docblock line="48">
17879
<description><![CDATA[current group of names list]]></description>
17880
<long-description><![CDATA[]]></long-description>
17881
</docblock>
17882
</property>
17883
<property final="false" static="false" visibility="private" line="51" namespace="global" package="main">
17884
<name>$groupList_orig</name>
17885
<default><![CDATA[array()]]></default>
17886
<docblock line="50">
17887
<description><![CDATA[original group of names list]]></description>
17888
<long-description><![CDATA[]]></long-description>
17889
</docblock>
17890
</property>
17891
<property final="false" static="false" visibility="private" line="53" namespace="global" package="main">
17892
<name>$groupCache</name>
17893
<default><![CDATA[null]]></default>
17894
<docblock line="52">
17895
<description><![CDATA[cache for groups]]></description>
17896
<long-description><![CDATA[]]></long-description>
17897
</docblock>
17898
</property>
17899
<property final="false" static="false" visibility="private" line="55" namespace="global" package="main">
17900
<name>$pwdLastSet</name>
17901
<default><![CDATA[null]]></default>
17902
<docblock line="54">
17903
<description><![CDATA[option for forcing password change, used in postModifyActions]]></description>
17904
<long-description><![CDATA[]]></long-description>
17905
</docblock>
17906
</property>
17907
<property final="false" static="false" visibility="private" line="57" namespace="global" package="main">
17908
<name>$clearTextPassword</name>
17909
<default><![CDATA[]]></default>
17910
<docblock line="56">
17911
<description><![CDATA[clear text password]]></description>
17912
<long-description><![CDATA[]]></long-description>
17913
</docblock>
17914
</property>
17915
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="67" package="modules">
17916
<name>get_metaData</name>
17917
<full_name>get_metaData</full_name>
17918
<docblock line="60">
17919
<description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
17920
<long-description><![CDATA[]]></long-description>
17921
<tag line="60" name="return" description="array with meta data" type="array">
17922
<type by_reference="false">array</type>
17923
</tag>
17924
<tag line="60" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
17925
</docblock>
17926
</method>
17927
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="432" package="modules">
17928
<name>init</name>
17929
<full_name>init</full_name>
17930
<docblock line="427">
17931
<description><![CDATA[Initializes the module after it became part of an accountContainer]]></description>
17932
<long-description><![CDATA[]]></long-description>
17933
<tag line="427" name="param" description="the name of the accountContainer object ($_SESSION[$base])" type="string" variable="$base">
17934
<type by_reference="false">string</type>
17935
</tag>
17936
</docblock>
17937
<argument line="432">
17938
<name>$base</name>
17939
<default><![CDATA[]]></default>
17940
<type/>
17941
</argument>
17942
</method>
17943
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="442" package="modules">
17944
<name>load_Messages</name>
17945
<full_name>load_Messages</full_name>
17946
<docblock line="439">
17947
<description><![CDATA[This function fills the $messages variable with output messages from this module.]]></description>
17948
<long-description><![CDATA[]]></long-description>
17949
</docblock>
17950
</method>
17951
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="474" package="modules">
17952
<name>load_attributes</name>
17953
<full_name>load_attributes</full_name>
17954
<docblock line="469">
17955
<description><![CDATA[This function loads all needed LDAP attributes.]]></description>
17956
<long-description><![CDATA[]]></long-description>
17957
<tag line="469" name="param" description="list of attributes" type="array" variable="$attr">
17958
<type by_reference="false">array</type>
17959
</tag>
17960
</docblock>
17961
<argument line="474">
17962
<name>$attr</name>
17963
<default><![CDATA[]]></default>
17964
<type/>
17965
</argument>
17966
</method>
17967
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="500" package="modules">
17968
<name>save_attributes</name>
17969
<full_name>save_attributes</full_name>
17970
<docblock line="488">
17971
<description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
17972
<long-description><![CDATA[]]></long-description>
17973
<tag line="488" name="return" description="list of modifications <br>This function returns an array with 3 entries: <br>array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) <br>DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) <br>"add" are attributes which have to be added to LDAP entry <br>"remove" are attributes which have to be removed from LDAP entry <br>"modify" are attributes which have to been modified in LDAP entry <br>"info" are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
17974
<type by_reference="false">array</type>
17975
</tag>
17976
</docblock>
17977
</method>
17978
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="512" package="modules">
17979
<name>display_html_attributes</name>
17980
<full_name>display_html_attributes</full_name>
17981
<docblock line="507">
17982
<description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
17983
<long-description><![CDATA[]]></long-description>
17984
<tag line="507" name="return" description="HTML meta data" type="\htmlElement">
17985
<type by_reference="false">\htmlElement</type>
17986
</tag>
17987
</docblock>
17988
</method>
17989
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="609" package="modules">
17990
<name>process_attributes</name>
17991
<full_name>process_attributes</full_name>
17992
<docblock line="603">
17993
<description><![CDATA[Processes user input of the primary module page.]]></description>
17994
<long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
17995
<tag line="603" name="return" description="list of info/error messages" type="array">
17996
<type by_reference="false">array</type>
17997
</tag>
17998
</docblock>
17999
</method>
18000
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="717" package="modules">
18001
<name>display_html_group</name>
18002
<full_name>display_html_group</full_name>
18003
<docblock line="712">
18004
<description><![CDATA[Displays the group selection.]]></description>
18005
<long-description><![CDATA[]]></long-description>
18006
<tag line="712" name="return" description="meta HTML code" type="\htmlElement">
18007
<type by_reference="false">\htmlElement</type>
18008
</tag>
18009
</docblock>
18010
</method>
18011
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="784" package="modules">
18012
<name>process_group</name>
18013
<full_name>process_group</full_name>
18014
<docblock line="778">
18015
<description><![CDATA[Processes user input of the group selection page.]]></description>
18016
<long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
18017
<tag line="778" name="return" description="list of info/error messages" type="array">
18018
<type by_reference="false">array</type>
18019
</tag>
18020
</docblock>
18021
</method>
18022
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="804" package="modules">
18023
<name>postModifyActions</name>
18024
<full_name>postModifyActions</full_name>
18025
<docblock line="795">
18026
<description><![CDATA[Runs the postmodify actions.]]></description>
18027
<long-description><![CDATA[]]></long-description>
18028
<tag line="795" name="see" description="\global\baseModule::postModifyActions()" refers="\global\baseModule::postModifyActions()"/>
18029
<tag line="795" name="param" description="" type="boolean" variable="$newAccount">
18030
<type by_reference="false">boolean</type>
18031
</tag>
18032
<tag line="795" name="param" description="LDAP attributes of this entry" type="array" variable="$attributes">
18033
<type by_reference="false">array</type>
18034
</tag>
18035
<tag line="795" name="return" description="array which contains status messages. Each entry is an array containing the status message parameters." type="array">
18036
<type by_reference="false">array</type>
18037
</tag>
18038
</docblock>
18039
<argument line="804">
18040
<name>$newAccount</name>
18041
<default><![CDATA[]]></default>
18042
<type/>
18043
</argument>
18044
<argument line="804">
18045
<name>$attributes</name>
18046
<default><![CDATA[]]></default>
18047
<type/>
18048
</argument>
18049
</method>
18050
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="860" package="modules">
18051
<name>build_uploadAccounts</name>
18052
<full_name>build_uploadAccounts</full_name>
18053
<docblock line="851">
18054
<description><![CDATA[In this function the LDAP account is built up.]]></description>
18055
<long-description><![CDATA[]]></long-description>
18056
<tag line="851" name="param" description="list of hash arrays (name => value) from user input" type="array" variable="$rawAccounts">
18057
<type by_reference="false">array</type>
18058
</tag>
18059
<tag line="851" name="param" description="list of IDs for column position (e.g. "posixAccount_uid" => 5)" type="array" variable="$ids">
18060
<type by_reference="false">array</type>
18061
</tag>
18062
<tag line="851" name="param" description="list of hash arrays (name => value) which are later added to LDAP" type="array" variable="$partialAccounts">
18063
<type by_reference="false">array</type>
18064
</tag>
18065
<tag line="851" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
18066
<type by_reference="false">array</type>
18067
</tag>
18068
<tag line="851" name="return" description="list of error messages if any" type="array">
18069
<type by_reference="false">array</type>
18070
</tag>
18071
</docblock>
18072
<argument line="860">
18073
<name>$rawAccounts</name>
18074
<default><![CDATA[]]></default>
18075
<type/>
18076
</argument>
18077
<argument line="860">
18078
<name>$ids</name>
18079
<default><![CDATA[]]></default>
18080
<type/>
18081
</argument>
18082
<argument line="860">
18083
<name>$partialAccounts</name>
18084
<default><![CDATA[]]></default>
18085
<type/>
18086
</argument>
18087
<argument line="860">
18088
<name>$selectedModules</name>
18089
<default><![CDATA[]]></default>
18090
<type/>
18091
</argument>
18092
</method>
18093
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1110" package="modules">
18094
<name>doUploadPostActions</name>
18095
<full_name>doUploadPostActions</full_name>
18096
<docblock line="1095">
18097
<description><![CDATA[This function executes one post upload action.]]></description>
18098
<long-description><![CDATA[]]></long-description>
18099
<tag line="1095" name="param" description="array containing one account in each element" type="array" variable="$data">
18100
<type by_reference="false">array</type>
18101
</tag>
18102
<tag line="1095" name="param" description="array(<column_name> => <column number>)" type="array" variable="$ids">
18103
<type by_reference="false">array</type>
18104
</tag>
18105
<tag line="1095" name="param" description="list of accounts which were not created successfully" type="array" variable="$failed">
18106
<type by_reference="false">array</type>
18107
</tag>
18108
<tag line="1095" name="param" description="variable to store temporary data between two post actions" type="array" variable="$temp">
18109
<type by_reference="false">array</type>
18110
</tag>
18111
<tag line="1095" name="param" description="list of LDAP entries" type="array" variable="$accounts">
18112
<type by_reference="false">array</type>
18113
</tag>
18114
<tag line="1095" name="return" description="current status <br> array ( <br> 'status' => 'finished' | 'inProgress' <br> 'progress' => 0..100 <br> 'errors' => array (<array of parameters for StatusMessage>) <br> )" type="array">
18115
<type by_reference="false">array</type>
18116
</tag>
18117
</docblock>
18118
<argument line="1110">
18119
<name>$data</name>
18120
<default><![CDATA[]]></default>
18121
<type/>
18122
</argument>
18123
<argument line="1110">
18124
<name>$ids</name>
18125
<default><![CDATA[]]></default>
18126
<type/>
18127
</argument>
18128
<argument line="1110">
18129
<name>$failed</name>
18130
<default><![CDATA[]]></default>
18131
<type/>
18132
</argument>
18133
<argument line="1110">
18134
<name>$temp</name>
18135
<default><![CDATA[]]></default>
18136
<type/>
18137
</argument>
18138
<argument line="1110">
18139
<name>$accounts</name>
18140
<default><![CDATA[]]></default>
18141
<type/>
18142
</argument>
18143
</method>
18144
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1213" package="modules">
18145
<name>get_pdfEntries</name>
18146
<full_name>get_pdfEntries</full_name>
18147
<docblock line="1210">
18148
<description><![CDATA[Returns a list of PDF entries]]></description>
18149
<long-description><![CDATA[]]></long-description>
18150
</docblock>
18151
</method>
18152
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1275" package="modules">
18153
<name>get_profileOptions</name>
18154
<full_name>get_profileOptions</full_name>
18155
<docblock line="1270">
18156
<description><![CDATA[Returns a list of elements for the account profiles.]]></description>
18157
<long-description><![CDATA[]]></long-description>
18158
<tag line="1270" name="return" description="profile elements" type="\htmlElement">
18159
<type by_reference="false">\htmlElement</type>
18160
</tag>
18161
</docblock>
18162
</method>
18163
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1294" package="modules">
18164
<name>load_profile</name>
18165
<full_name>load_profile</full_name>
18166
<docblock line="1289">
18167
<description><![CDATA[Loads the values of an account profile into internal variables.]]></description>
18168
<long-description><![CDATA[]]></long-description>
18169
<tag line="1289" name="param" description="hash array with profile values (identifier => value)" type="array" variable="$profile">
18170
<type by_reference="false">array</type>
18171
</tag>
18172
</docblock>
18173
<argument line="1294">
18174
<name>$profile</name>
18175
<default><![CDATA[]]></default>
18176
<type/>
18177
</argument>
18178
</method>
18179
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1314" package="modules">
18180
<name>getSelfServiceOptions</name>
18181
<full_name>getSelfServiceOptions</full_name>
18182
<docblock line="1303">
18183
<description><![CDATA[Returns the meta HTML code for each input field.]]></description>
18184
<long-description><![CDATA[<p>format: array(<field1> => array(<META HTML>), ...)
18185
It is not possible to display help links.</p>]]></long-description>
18186
<tag line="1303" name="param" description="list of active fields" type="array" variable="$fields">
18187
<type by_reference="false">array</type>
18188
</tag>
18189
<tag line="1303" name="param" description="attributes of LDAP account" type="array" variable="$attributes">
18190
<type by_reference="false">array</type>
18191
</tag>
18192
<tag line="1303" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
18193
<type by_reference="false">boolean</type>
18194
</tag>
18195
<tag line="1303" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
18196
<type by_reference="false">array</type>
18197
</tag>
18198
<tag line="1303" name="return" description="list of meta HTML elements (field name => htmlTableRow)" type="array">
18199
<type by_reference="false">array</type>
18200
</tag>
18201
</docblock>
18202
<argument line="1314">
18203
<name>$fields</name>
18204
<default><![CDATA[]]></default>
18205
<type/>
18206
</argument>
18207
<argument line="1314">
18208
<name>$attributes</name>
18209
<default><![CDATA[]]></default>
18210
<type/>
18211
</argument>
18212
<argument line="1314">
18213
<name>$passwordChangeOnly</name>
18214
<default><![CDATA[]]></default>
18215
<type/>
18216
</argument>
18217
<argument line="1314">
18218
<name>$readOnlyFields</name>
18219
<default><![CDATA[]]></default>
18220
<type/>
18221
</argument>
18222
</method>
18223
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1364" package="modules">
18224
<name>checkSelfServiceOptions</name>
18225
<full_name>checkSelfServiceOptions</full_name>
18226
<docblock line="1347">
18227
<description><![CDATA[Checks if all input values are correct and returns the LDAP attributes which should be changed.]]></description>
18228
<long-description><![CDATA[<p><br>Return values:
18229
<br>messages: array of parameters to create status messages
18230
<br>add: array of attributes to add
18231
<br>del: array of attributes to remove
18232
<br>mod: array of attributes to modify
18233
<br>info: array of values with informational value (e.g. to be used later by pre/postModify actions)</p>
18234
18235
<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
18236
<tag line="1347" name="param" description="input fields" type="string" variable="$fields">
18237
<type by_reference="false">string</type>
18238
</tag>
18239
<tag line="1347" name="param" description="LDAP attributes" type="array" variable="$attributes">
18240
<type by_reference="false">array</type>
18241
</tag>
18242
<tag line="1347" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
18243
<type by_reference="false">boolean</type>
18244
</tag>
18245
<tag line="1347" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
18246
<type by_reference="false">array</type>
18247
</tag>
18248
<tag line="1347" name="return" description="messages and attributes (array('messages' => array(), 'add' => array('mail' => array('test@test.com')), 'del' => array(), 'mod' => array(), 'info' => array()))" type="array">
18249
<type by_reference="false">array</type>
18250
</tag>
18251
</docblock>
18252
<argument line="1364">
18253
<name>$fields</name>
18254
<default><![CDATA[]]></default>
18255
<type/>
18256
</argument>
18257
<argument line="1364">
18258
<name>$attributes</name>
18259
<default><![CDATA[]]></default>
18260
<type/>
18261
</argument>
18262
<argument line="1364">
18263
<name>$passwordChangeOnly</name>
18264
<default><![CDATA[]]></default>
18265
<type/>
18266
</argument>
18267
<argument line="1364">
18268
<name>$readOnlyFields</name>
18269
<default><![CDATA[]]></default>
18270
<type/>
18271
</argument>
18272
</method>
18273
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1414" package="modules">
18274
<name>setSelfServicePassword</name>
18275
<full_name>setSelfServicePassword</full_name>
18276
<docblock line="1406">
18277
<description><![CDATA[Sets the user password in self service.]]></description>
18278
<long-description><![CDATA[<p>Since the change requires the old password we need to run ldapmodify for this task.</p>
18279
18280
<p>Enter description here ...</p>]]></long-description>
18281
<tag line="1406" name="param" description="return value for checkSelfServiceOptions() (used to add message if any)" type="array" variable="$return">
18282
<type by_reference="false">array</type>
18283
</tag>
18284
<tag line="1406" name="param" description="LDAP attributes" type="array" variable="$attributes">
18285
<type by_reference="false">array</type>
18286
</tag>
18287
</docblock>
18288
<argument line="1414">
18289
<name>$return</name>
18290
<default><![CDATA[]]></default>
18291
<type/>
18292
</argument>
18293
<argument line="1414">
18294
<name>$attributes</name>
18295
<default><![CDATA[]]></default>
18296
<type/>
18297
</argument>
18298
</method>
18299
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1483" package="modules">
18300
<name>managesPasswordAttributes</name>
18301
<full_name>managesPasswordAttributes</full_name>
18302
<docblock line="1476">
18303
<description><![CDATA[This method specifies if a module manages password attributes.]]></description>
18304
<long-description><![CDATA[<p>The module alias will
18305
then appear as option in the GUI.
18306
<br>If the module only wants to get notified about password changes then return false.</p>]]></long-description>
18307
<tag line="1476" name="return" description="true if this module manages password attributes" type="boolean">
18308
<type by_reference="false">boolean</type>
18309
</tag>
18310
</docblock>
18311
</method>
18312
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1492" package="modules">
18313
<name>supportsForcePasswordChange</name>
18314
<full_name>supportsForcePasswordChange</full_name>
18315
<docblock line="1487">
18316
<description><![CDATA[Specifies if this module supports to force that a user must change his password on next login.]]></description>
18317
<long-description><![CDATA[]]></long-description>
18318
<tag line="1487" name="return" description="force password change supported" type="boolean">
18319
<type by_reference="false">boolean</type>
18320
</tag>
18321
</docblock>
18322
</method>
18323
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1506" package="modules">
18324
<name>passwordChangeRequested</name>
18325
<full_name>passwordChangeRequested</full_name>
18326
<docblock line="1496">
18327
<description><![CDATA[This function is called whenever the password should be changed.]]></description>
18328
<long-description><![CDATA[<p>Account modules
18329
must change their password attributes only if the modules list contains their module name.</p>]]></long-description>
18330
<tag line="1496" name="param" description="new password" type="String" variable="$password">
18331
<type by_reference="false">String</type>
18332
</tag>
18333
<tag line="1496" name="param" description="list of modules for which the password should be changed" type="array" variable="$modules">
18334
<type by_reference="false">array</type>
18335
</tag>
18336
<tag line="1496" name="param" description="force the user to change his password at next login" type="boolean" variable="$forcePasswordChange">
18337
<type by_reference="false">boolean</type>
18338
</tag>
18339
<tag line="1496" name="return" description="list of error messages if any as parameter array for StatusMessage e.g. return arrray(array('ERROR', 'Password change failed.'))" type="array">
18340
<type by_reference="false">array</type>
18341
</tag>
18342
</docblock>
18343
<argument line="1506">
18344
<name>$password</name>
18345
<default><![CDATA[]]></default>
18346
<type/>
18347
</argument>
18348
<argument line="1506">
18349
<name>$modules</name>
18350
<default><![CDATA[]]></default>
18351
<type/>
18352
</argument>
18353
<argument line="1506">
18354
<name>$forcePasswordChange</name>
18355
<default><![CDATA[]]></default>
18356
<type/>
18357
</argument>
18358
</method>
18359
<method final="false" abstract="false" static="true" visibility="public" namespace="global" line="1526" package="modules">
18360
<name>pwdAttributeValue</name>
18361
<full_name>pwdAttributeValue</full_name>
18362
<docblock line="1521">
18363
<description><![CDATA[Creates the LDAP password value.]]></description>
18364
<long-description><![CDATA[]]></long-description>
18365
<tag line="1521" name="param" description="password" type="String" variable="$password">
18366
<type by_reference="false">String</type>
18367
</tag>
18368
</docblock>
18369
<argument line="1526">
18370
<name>$password</name>
18371
<default><![CDATA[]]></default>
18372
<type/>
18373
</argument>
18374
</method>
18375
<method final="false" abstract="false" static="true" visibility="public" namespace="global" line="1536" package="modules">
18376
<name>isDeactivated</name>
18377
<full_name>isDeactivated</full_name>
18378
<docblock line="1530">
18379
<description><![CDATA[Returns if the account is currently deactivated.]]></description>
18380
<long-description><![CDATA[]]></long-description>
18381
<tag line="1530" name="param" description="LDAP attributes" type="array" variable="$attrs">
18382
<type by_reference="false">array</type>
18383
</tag>
18384
<tag line="1530" name="return" description="is deactivated" type="boolean">
18385
<type by_reference="false">boolean</type>
18386
</tag>
18387
</docblock>
18388
<argument line="1536">
18389
<name>$attrs</name>
18390
<default><![CDATA[]]></default>
18391
<type/>
18392
</argument>
18393
</method>
18394
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1550" package="modules">
18395
<name>setIsDeactivated</name>
18396
<full_name>setIsDeactivated</full_name>
18397
<docblock line="1544">
18398
<description><![CDATA[Sets if the account is currently deactivated.]]></description>
18399
<long-description><![CDATA[]]></long-description>
18400
<tag line="1544" name="param" description="is deactivated" type="boolean" variable="$deactivated">
18401
<type by_reference="false">boolean</type>
18402
</tag>
18403
<tag line="1544" name="param" description="LDAP attributes to modify (default $this->attributes)" type="array" variable="$attrs">
18404
<type by_reference="false">array</type>
18405
</tag>
18406
</docblock>
18407
<argument line="1550">
18408
<name>$deactivated</name>
18409
<default><![CDATA[]]></default>
18410
<type/>
18411
</argument>
18412
<argument line="1550">
18413
<name>$attrs</name>
18414
<default><![CDATA[null]]></default>
18415
<type/>
18416
</argument>
18417
</method>
18418
<method final="false" abstract="false" static="true" visibility="private" namespace="global" line="1574" package="modules">
18419
<name>isLockedOut</name>
18420
<full_name>isLockedOut</full_name>
18421
<docblock line="1568">
18422
<description><![CDATA[Returns if the account is currently locked out.]]></description>
18423
<long-description><![CDATA[]]></long-description>
18424
<tag line="1568" name="param" description="LDAP attributes" type="array" variable="$attrs">
18425
<type by_reference="false">array</type>
18426
</tag>
18427
<tag line="1568" name="return" description="is locked out" type="boolean">
18428
<type by_reference="false">boolean</type>
18429
</tag>
18430
</docblock>
18431
<argument line="1574">
18432
<name>$attrs</name>
18433
<default><![CDATA[]]></default>
18434
<type/>
18435
</argument>
18436
</method>
18437
<method final="false" abstract="false" static="true" visibility="public" namespace="global" line="1587" package="modules">
18438
<name>unlock</name>
18439
<full_name>unlock</full_name>
18440
<docblock line="1582">
18441
<description><![CDATA[Unlocks the account.]]></description>
18442
<long-description><![CDATA[]]></long-description>
18443
<tag line="1582" name="param" description="LDAP attributes to modify" type="array" variable="$attrs">
18444
<type by_reference="false">array</type>
18445
</tag>
18446
</docblock>
18447
<argument line="1587">
18448
<name>$attrs</name>
18449
<default><![CDATA[]]></default>
18450
<type/>
18451
</argument>
18452
</method>
18453
<method final="false" abstract="false" static="true" visibility="public" namespace="global" line="1603" package="modules">
18454
<name>isSmartCardRequired</name>
18455
<full_name>isSmartCardRequired</full_name>
18456
<docblock line="1597">
18457
<description><![CDATA[Returns if the account requires a smartcard to login.]]></description>
18458
<long-description><![CDATA[]]></long-description>
18459
<tag line="1597" name="param" description="LDAP attributes" type="array" variable="$attrs">
18460
<type by_reference="false">array</type>
18461
</tag>
18462
<tag line="1597" name="return" description="requires a smartcard" type="boolean">
18463
<type by_reference="false">boolean</type>
18464
</tag>
18465
</docblock>
18466
<argument line="1603">
18467
<name>$attrs</name>
18468
<default><![CDATA[]]></default>
18469
<type/>
18470
</argument>
18471
</method>
18472
<method final="false" abstract="false" static="true" visibility="public" namespace="global" line="1617" package="modules">
18473
<name>setIsSmartCardRequired</name>
18474
<full_name>setIsSmartCardRequired</full_name>
18475
<docblock line="1611">
18476
<description><![CDATA[Sets if the account requires a smartcard to login.]]></description>
18477
<long-description><![CDATA[]]></long-description>
18478
<tag line="1611" name="param" description="LDAP attributes to modify" type="array" variable="$attrs">
18479
<type by_reference="false">array</type>
18480
</tag>
18481
<tag line="1611" name="param" description="requires a smartcard" type="boolean" variable="$requireCard">
18482
<type by_reference="false">boolean</type>
18483
</tag>
18484
</docblock>
18485
<argument line="1617">
18486
<name>$attrs</name>
18487
<default><![CDATA[]]></default>
18488
<type/>
18489
</argument>
18490
<argument line="1617">
18491
<name>$requireCard</name>
18492
<default><![CDATA[]]></default>
18493
<type/>
18494
</argument>
18495
</method>
18496
<method final="false" abstract="false" static="true" visibility="public" namespace="global" line="1638" package="modules">
18497
<name>isNeverExpiring</name>
18498
<full_name>isNeverExpiring</full_name>
18499
<docblock line="1632">
18500
<description><![CDATA[Returns if the account never expires.]]></description>
18501
<long-description><![CDATA[]]></long-description>
18502
<tag line="1632" name="param" description="LDAP attributes" type="array" variable="$attrs">
18503
<type by_reference="false">array</type>
18504
</tag>
18505
<tag line="1632" name="return" description="never expires" type="boolean">
18506
<type by_reference="false">boolean</type>
18507
</tag>
18508
</docblock>
18509
<argument line="1638">
18510
<name>$attrs</name>
18511
<default><![CDATA[]]></default>
18512
<type/>
18513
</argument>
18514
</method>
18515
<method final="false" abstract="false" static="true" visibility="public" namespace="global" line="1652" package="modules">
18516
<name>setIsNeverExpiring</name>
18517
<full_name>setIsNeverExpiring</full_name>
18518
<docblock line="1646">
18519
<description><![CDATA[Sets if the account never expires.]]></description>
18520
<long-description><![CDATA[]]></long-description>
18521
<tag line="1646" name="param" description="LDAP attributes to modify" type="array" variable="$attrs">
18522
<type by_reference="false">array</type>
18523
</tag>
18524
<tag line="1646" name="param" description="never expires" type="boolean" variable="$neverExpires">
18525
<type by_reference="false">boolean</type>
18526
</tag>
18527
</docblock>
18528
<argument line="1652">
18529
<name>$attrs</name>
18530
<default><![CDATA[]]></default>
18531
<type/>
18532
</argument>
18533
<argument line="1652">
18534
<name>$neverExpires</name>
18535
<default><![CDATA[]]></default>
18536
<type/>
18537
</argument>
18538
</method>
18539
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1672" package="modules">
18540
<name>findGroups</name>
18541
<full_name>findGroups</full_name>
18542
<docblock line="1667">
18543
<description><![CDATA[Finds all existing groups.]]></description>
18544
<long-description><![CDATA[]]></long-description>
18545
<tag line="1667" name="return" description="group DNs" type="array">
18546
<type by_reference="false">array</type>
18547
</tag>
18548
</docblock>
18549
</method>
18550
</class>
18551
<markers>
18552
<todo line="1335">remove this workaround when self service allows to specify the list of active modules</todo>
18553
<todo line="1391">remove this workaround when self service allows to specify the list of active modules</todo>
18554
</markers>
18555
</file>
18556
<file path="lib/modules/kolabUser.inc" hash="f61764131dc1e2a17dbdd2d2e31d5d7e" package="modules">
17334
18557
<docblock line="23">
17335
18558
<description><![CDATA[Manages Kolab user accounts.]]></description>
17336
18559
<long-description><![CDATA[]]></long-description>
17507
18730
</tag>
17508
18731
</docblock>
17509
18732
</method>
17510
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="668" package="modules">
18733
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="659" package="modules">
17511
18734
<name>getSelfServiceOptions</name>
17512
18735
<full_name>getSelfServiceOptions</full_name>
17513
<docblock line="657">
18736
<docblock line="648">
17514
18737
<description><![CDATA[Returns the meta HTML code for each input field.]]></description>
17515
18738
<long-description><![CDATA[<p>format: array(<field1> => array(<META HTML>), ...)
17516
18739
It is not possible to display help links.</p>]]></long-description>
17517
<tag line="657" name="param" description="list of active fields" type="array" variable="$fields">
17518
<type by_reference="false">array</type>
17519
</tag>
17520
<tag line="657" name="param" description="attributes of LDAP account" type="array" variable="$attributes">
17521
<type by_reference="false">array</type>
17522
</tag>
17523
<tag line="657" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
18740
<tag line="648" name="param" description="list of active fields" type="array" variable="$fields">
18741
<type by_reference="false">array</type>
18742
</tag>
18743
<tag line="648" name="param" description="attributes of LDAP account" type="array" variable="$attributes">
18744
<type by_reference="false">array</type>
18745
</tag>
18746
<tag line="648" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
17524
18747
<type by_reference="false">boolean</type>
17525
18748
</tag>
17526
<tag line="657" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
18749
<tag line="648" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
17527
18750
<type by_reference="false">array</type>
17528
18751
</tag>
17529
<tag line="657" name="return" description="list of meta HTML elements (field name => htmlTableRow)" type="array">
18752
<tag line="648" name="return" description="list of meta HTML elements (field name => htmlTableRow)" type="array">
17530
18753
<type by_reference="false">array</type>
17531
18754
</tag>
17532
18755
</docblock>
17533
<argument line="668">
18756
<argument line="659">
17534
18757
<name>$fields</name>
17535
18758
<default><![CDATA[]]></default>
17536
18759
<type/>
17537
18760
</argument>
17538
<argument line="668">
18761
<argument line="659">
17539
18762
<name>$attributes</name>
17540
18763
<default><![CDATA[]]></default>
17541
18764
<type/>
17542
18765
</argument>
17543
<argument line="668">
18766
<argument line="659">
17544
18767
<name>$passwordChangeOnly</name>
17545
18768
<default><![CDATA[]]></default>
17546
18769
<type/>
17547
18770
</argument>
17548
<argument line="668">
18771
<argument line="659">
17549
18772
<name>$readOnlyFields</name>
17550
18773
<default><![CDATA[]]></default>
17551
18774
<type/>
17552
18775
</argument>
17553
18776
</method>
17554
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="792" package="modules">
18777
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="783" package="modules">
17555
18778
<name>checkSelfServiceOptions</name>
17556
18779
<full_name>checkSelfServiceOptions</full_name>
17557
<docblock line="775">
18780
<docblock line="766">
17558
18781
<description><![CDATA[Checks if all input values are correct and returns the LDAP attributes which should be changed.]]></description>
17559
18782
<long-description><![CDATA[<p><br>Return values:
17560
18783
<br>messages: array of parameters to create status messages
17564
18787
<br>info: array of values with informational value (e.g. to be used later by pre/postModify actions)</p>
17565
18788
17566
18789
<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
17567
<tag line="775" name="param" description="input fields" type="string" variable="$fields">
18790
<tag line="766" name="param" description="input fields" type="string" variable="$fields">
17568
18791
<type by_reference="false">string</type>
17569
18792
</tag>
17570
<tag line="775" name="param" description="LDAP attributes" type="array" variable="$attributes">
18793
<tag line="766" name="param" description="LDAP attributes" type="array" variable="$attributes">
17571
18794
<type by_reference="false">array</type>
17572
18795
</tag>
17573
<tag line="775" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
18796
<tag line="766" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
17574
18797
<type by_reference="false">boolean</type>
17575
18798
</tag>
17576
<tag line="775" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
18799
<tag line="766" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
17577
18800
<type by_reference="false">array</type>
17578
18801
</tag>
17579
<tag line="775" name="return" description="messages and attributes (array('messages' => array(), 'add' => array('mail' => array('test@test.com')), 'del' => array(), 'mod' => array(), 'info' => array()))" type="array">
18802
<tag line="766" name="return" description="messages and attributes (array('messages' => array(), 'add' => array('mail' => array('test@test.com')), 'del' => array(), 'mod' => array(), 'info' => array()))" type="array">
17580
18803
<type by_reference="false">array</type>
17581
18804
</tag>
17582
18805
</docblock>
17583
<argument line="792">
18806
<argument line="783">
17584
18807
<name>$fields</name>
17585
18808
<default><![CDATA[]]></default>
17586
18809
<type/>
17587
18810
</argument>
17588
<argument line="792">
18811
<argument line="783">
17589
18812
<name>$attributes</name>
17590
18813
<default><![CDATA[]]></default>
17591
18814
<type/>
17592
18815
</argument>
17593
<argument line="792">
18816
<argument line="783">
17594
18817
<name>$passwordChangeOnly</name>
17595
18818
<default><![CDATA[]]></default>
17596
18819
<type/>
17597
18820
</argument>
17598
<argument line="792">
18821
<argument line="783">
17599
18822
<name>$readOnlyFields</name>
17600
18823
<default><![CDATA[]]></default>
17601
18824
<type/>
17603
18826
</method>
17604
18827
</class>
17605
18828
</file>
17606
<file path="lib/modules/range.inc" hash="79f4cfc381db5712dd63f9e0255cb98c" package="modules">
18829
<file path="lib/modules/range.inc" hash="ae04380e14c433b88895200069581ed0" package="modules">
17607
18830
<docblock line="26">
17608
18831
<description><![CDATA[Manages DHCP ranges for DHCP server.]]></description>
17609
18832
<long-description><![CDATA[]]></long-description>
18194
19417
</method>
18195
19418
</class>
18196
19419
</file>
18197
<file path="lib/modules/sambaGroupMapping.inc" hash="35acd3df76c324fd046f445081fc887d" package="modules">
19420
<file path="lib/modules/sambaGroupMapping.inc" hash="df3115bc4fd4e70a211e3bc58ad805c9" package="modules">
18198
19421
<docblock line="25">
18199
19422
<description><![CDATA[Manages Samba 3 accounts for groups.]]></description>
18200
19423
<long-description><![CDATA[]]></long-description>
18252
19475
<type/>
18253
19476
</argument>
18254
19477
</method>
18255
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="87" package="modules">
19478
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="83" package="modules">
18256
19479
<name>getGID</name>
18257
19480
<full_name>getGID</full_name>
18258
<docblock line="82">
19481
<docblock line="78">
18259
19482
<description><![CDATA[Gets the GID number from the Unix group module.]]></description>
18260
19483
<long-description><![CDATA[]]></long-description>
18261
<tag line="82" name="return" description="GID number" type="String">
19484
<tag line="78" name="return" description="GID number" type="String">
18262
19485
<type by_reference="false">String</type>
18263
19486
</tag>
18264
19487
</docblock>
18265
19488
</method>
18266
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="105" package="modules">
19489
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="101" package="modules">
18267
19490
<name>getCn</name>
18268
19491
<full_name>getCn</full_name>
18269
<docblock line="100">
19492
<docblock line="96">
18270
19493
<description><![CDATA[Gets the cn from the Unix group module.]]></description>
18271
19494
<long-description><![CDATA[]]></long-description>
18272
<tag line="100" name="return" description="cn attribute" type="String">
19495
<tag line="96" name="return" description="cn attribute" type="String">
18273
19496
<type by_reference="false">String</type>
18274
19497
</tag>
18275
19498
</docblock>
18276
19499
</method>
18277
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="142" package="modules">
19500
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="138" package="modules">
18278
19501
<name>get_uploadColumns</name>
18279
19502
<full_name>get_uploadColumns</full_name>
18280
<docblock line="118">
19503
<docblock line="114">
18281
19504
<description><![CDATA[Returns an array containing all input columns for the file upload.]]></description>
18282
19505
<long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
18283
19506
<br>
18294
19517
<br> boolean: required // true, if user must set a value for this column
18295
19518
<br> boolean: unique // true if all values of this column must be different values (optional, default: "false")
18296
19519
<br> )</p>]]></long-description>
18297
<tag line="118" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
18298
<type by_reference="false">array</type>
18299
</tag>
18300
<tag line="118" name="return" description="column list" type="array">
18301
<type by_reference="false">array</type>
18302
</tag>
18303
<tag line="118" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
19520
<tag line="114" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
19521
<type by_reference="false">array</type>
19522
</tag>
19523
<tag line="114" name="return" description="column list" type="array">
19524
<type by_reference="false">array</type>
19525
</tag>
19526
<tag line="114" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
18304
19527
</docblock>
18305
<argument line="142">
19528
<argument line="138">
18306
19529
<name>$selectedModules</name>
18307
19530
<default><![CDATA[]]></default>
18308
19531
<type/>
18309
19532
</argument>
18310
19533
</method>
18311
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="167" package="modules">
19534
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="163" package="modules">
18312
19535
<name>build_uploadAccounts</name>
18313
19536
<full_name>build_uploadAccounts</full_name>
18314
<docblock line="158">
19537
<docblock line="154">
18315
19538
<description><![CDATA[In this function the LDAP account is built up.]]></description>
18316
19539
<long-description><![CDATA[]]></long-description>
18317
<tag line="158" name="param" description="list of hash arrays (name => value) from user input" type="array" variable="$rawAccounts">
18318
<type by_reference="false">array</type>
18319
</tag>
18320
<tag line="158" name="param" description="list of IDs for column position (e.g. "posixAccount_uid" => 5)" type="array" variable="$ids">
18321
<type by_reference="false">array</type>
18322
</tag>
18323
<tag line="158" name="param" description="list of hash arrays (name => value) which are later added to LDAP" type="array" variable="$partialAccounts">
18324
<type by_reference="false">array</type>
18325
</tag>
18326
<tag line="158" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
18327
<type by_reference="false">array</type>
18328
</tag>
18329
<tag line="158" name="return" description="list of error messages if any" type="array">
19540
<tag line="154" name="param" description="list of hash arrays (name => value) from user input" type="array" variable="$rawAccounts">
19541
<type by_reference="false">array</type>
19542
</tag>
19543
<tag line="154" name="param" description="list of IDs for column position (e.g. "posixAccount_uid" => 5)" type="array" variable="$ids">
19544
<type by_reference="false">array</type>
19545
</tag>
19546
<tag line="154" name="param" description="list of hash arrays (name => value) which are later added to LDAP" type="array" variable="$partialAccounts">
19547
<type by_reference="false">array</type>
19548
</tag>
19549
<tag line="154" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
19550
<type by_reference="false">array</type>
19551
</tag>
19552
<tag line="154" name="return" description="list of error messages if any" type="array">
18330
19553
<type by_reference="false">array</type>
18331
19554
</tag>
18332
19555
</docblock>
18333
<argument line="167">
19556
<argument line="163">
18334
19557
<name>$rawAccounts</name>
18335
19558
<default><![CDATA[]]></default>
18336
19559
<type/>
18337
19560
</argument>
18338
<argument line="167">
19561
<argument line="163">
18339
19562
<name>$ids</name>
18340
19563
<default><![CDATA[]]></default>
18341
19564
<type/>
18342
19565
</argument>
18343
<argument line="167">
19566
<argument line="163">
18344
19567
<name>$partialAccounts</name>
18345
19568
<default><![CDATA[]]></default>
18346
19569
<type/>
18347
19570
</argument>
18348
<argument line="167">
19571
<argument line="163">
18349
19572
<name>$selectedModules</name>
18350
19573
<default><![CDATA[]]></default>
18351
19574
<type/>
18352
19575
</argument>
18353
19576
</method>
18354
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="237" package="modules">
19577
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="233" package="modules">
18355
19578
<name>display_html_attributes</name>
18356
19579
<full_name>display_html_attributes</full_name>
18357
<docblock line="232">
19580
<docblock line="228">
18358
19581
<description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
18359
19582
<long-description><![CDATA[]]></long-description>
18360
<tag line="232" name="return" description="HTML meta data" type="\htmlElement">
19583
<tag line="228" name="return" description="HTML meta data" type="\htmlElement">
18361
19584
<type by_reference="false">\htmlElement</type>
18362
19585
</tag>
18363
19586
</docblock>
18364
19587
</method>
18365
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="305" package="modules">
19588
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="301" package="modules">
18366
19589
<name>get_metaData</name>
18367
19590
<full_name>get_metaData</full_name>
18368
<docblock line="298">
19591
<docblock line="294">
18369
19592
<description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
18370
19593
<long-description><![CDATA[]]></long-description>
18371
<tag line="298" name="return" description="array with meta data" type="array">
19594
<tag line="294" name="return" description="array with meta data" type="array">
18372
19595
<type by_reference="false">array</type>
18373
19596
</tag>
18374
<tag line="298" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
19597
<tag line="294" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
18375
19598
</docblock>
18376
19599
</method>
18377
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="386" package="modules">
19600
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="382" package="modules">
18378
19601
<name>get_pdfEntries</name>
18379
19602
<full_name>get_pdfEntries</full_name>
18380
<docblock line="381">
19603
<docblock line="377">
18381
19604
<description><![CDATA[Returns the PDF entries for this module.]]></description>
18382
19605
<long-description><![CDATA[]]></long-description>
18383
<tag line="381" name="return" description="list of possible PDF entries" type="array">
19606
<tag line="377" name="return" description="list of possible PDF entries" type="array">
18384
19607
<type by_reference="false">array</type>
18385
19608
</tag>
18386
19609
</docblock>
18387
19610
</method>
18388
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="404" package="modules">
19611
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="398" package="modules">
18389
19612
<name>get_profileOptions</name>
18390
19613
<full_name>get_profileOptions</full_name>
18391
<docblock line="399">
19614
<docblock line="393">
18392
19615
<description><![CDATA[Returns a list of elements for the account profiles.]]></description>
18393
19616
<long-description><![CDATA[]]></long-description>
18394
<tag line="399" name="return" description="profile elements" type="\htmlElement">
19617
<tag line="393" name="return" description="profile elements" type="\htmlElement">
18395
19618
<type by_reference="false">\htmlElement</type>
18396
19619
</tag>
18397
19620
</docblock>
18398
19621
</method>
18399
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="424" package="modules">
19622
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="418" package="modules">
18400
19623
<name>load_profile</name>
18401
19624
<full_name>load_profile</full_name>
18402
<docblock line="419">
19625
<docblock line="413">
18403
19626
<description><![CDATA[Loads the values of an account profile into internal variables.]]></description>
18404
19627
<long-description><![CDATA[]]></long-description>
18405
<tag line="419" name="param" description="hash array with profile values (identifier => value)" type="array" variable="$profile">
19628
<tag line="413" name="param" description="hash array with profile values (identifier => value)" type="array" variable="$profile">
18406
19629
<type by_reference="false">array</type>
18407
19630
</tag>
18408
19631
</docblock>
18409
<argument line="424">
19632
<argument line="418">
18410
19633
<name>$profile</name>
18411
19634
<default><![CDATA[]]></default>
18412
19635
<type/>
18413
19636
</argument>
18414
19637
</method>
18415
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="439" package="modules">
19638
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="433" package="modules">
18416
19639
<name>load_Messages</name>
18417
19640
<full_name>load_Messages</full_name>
18418
<docblock line="437">
19641
<docblock line="431">
18419
19642
<description><![CDATA[this functin fills the error message array with messages]]></description>
18420
19643
<long-description><![CDATA[]]></long-description>
18421
19644
</docblock>
18422
19645
</method>
18423
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="452" package="modules">
19646
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="446" package="modules">
18424
19647
<name>module_ready</name>
18425
19648
<full_name>module_ready</full_name>
18426
<docblock line="446">
19649
<docblock line="440">
18427
19650
<description><![CDATA[This function is used to check if this module page can be displayed.]]></description>
18428
19651
<long-description><![CDATA[<p>It returns false if a module depends on data from other modules which was not yet entered.</p>]]></long-description>
18429
<tag line="446" name="return" description="true, if page can be displayed" type="boolean">
19652
<tag line="440" name="return" description="true, if page can be displayed" type="boolean">
18430
19653
<type by_reference="false">boolean</type>
18431
19654
</tag>
18432
19655
</docblock>
18433
19656
</method>
18434
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="466" package="modules">
19657
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="460" package="modules">
18435
19658
<name>module_complete</name>
18436
19659
<full_name>module_complete</full_name>
18437
<docblock line="459">
19660
<docblock line="453">
18438
19661
<description><![CDATA[This function is used to check if all settings for this module have been made.]]></description>
18439
19662
<long-description><![CDATA[]]></long-description>
18440
<tag line="459" name="see" description="\global\baseModule::module_complete" refers="\global\baseModule::module_complete"/>
18441
<tag line="459" name="return" description="true, if settings are complete" type="boolean">
19663
<tag line="453" name="see" description="\global\baseModule::module_complete" refers="\global\baseModule::module_complete"/>
19664
<tag line="453" name="return" description="true, if settings are complete" type="boolean">
18442
19665
<type by_reference="false">boolean</type>
18443
19666
</tag>
18444
19667
</docblock>
18445
19668
</method>
18446
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="482" package="modules">
19669
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="476" package="modules">
18447
19670
<name>process_attributes</name>
18448
19671
<full_name>process_attributes</full_name>
18449
<docblock line="476">
19672
<docblock line="470">
18450
19673
<description><![CDATA[Processes user input of the primary module page.]]></description>
18451
19674
<long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
18452
<tag line="476" name="return" description="list of info/error messages" type="array">
19675
<tag line="470" name="return" description="list of info/error messages" type="array">
18453
19676
<type by_reference="false">array</type>
18454
19677
</tag>
18455
19678
</docblock>
18456
19679
</method>
18457
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="543" package="modules">
19680
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="537" package="modules">
18458
19681
<name>save_attributes</name>
18459
19682
<full_name>save_attributes</full_name>
18460
<docblock line="531">
19683
<docblock line="525">
18461
19684
<description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
18462
19685
<long-description><![CDATA[]]></long-description>
18463
<tag line="531" name="return" description="list of modifications <br>This function returns an array with 3 entries: <br>array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) <br>DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) <br>"add" are attributes which have to be added to LDAP entry <br>"remove" are attributes which have to be removed from LDAP entry <br>"modify" are attributes which have to been modified in LDAP entry <br>"info" are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
19686
<tag line="525" name="return" description="list of modifications <br>This function returns an array with 3 entries: <br>array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) <br>DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) <br>"add" are attributes which have to be added to LDAP entry <br>"remove" are attributes which have to be removed from LDAP entry <br>"modify" are attributes which have to been modified in LDAP entry <br>"info" are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
18464
19687
<type by_reference="false">array</type>
18465
19688
</tag>
18466
19689
</docblock>
18467
19690
</method>
18468
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="555" package="modules">
19691
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="549" package="modules">
18469
19692
<name>getDomains</name>
18470
19693
<full_name>getDomains</full_name>
18471
<docblock line="550">
19694
<docblock line="544">
18472
19695
<description><![CDATA[Returns a list of existing Samba 3 domains.]]></description>
18473
19696
<long-description><![CDATA[]]></long-description>
18474
<tag line="550" name="return" description="list of samba3domain objects" type="array">
19697
<tag line="544" name="return" description="list of samba3domain objects" type="array">
18475
19698
<type by_reference="false">array</type>
18476
19699
</tag>
18477
19700
</docblock>
18478
19701
</method>
18479
19702
</class>
18480
19703
</file>
18481
<file path="lib/modules/shadowAccount.inc" hash="06d73db710d036ad5c9106ed1132935e" package="modules">
19704
<file path="lib/modules/shadowAccount.inc" hash="6c95a9c15d9937a63083cca46de2757f" package="modules">
18482
19705
<docblock line="24">
18483
19706
<description><![CDATA[Manages Unix shadow accounts for users.]]></description>
18484
19707
<long-description><![CDATA[]]></long-description>
18533
19756
<tag line="70" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
18534
19757
</docblock>
18535
19758
</method>
18536
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="244" package="modules">
19759
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="246" package="modules">
18537
19760
<name>save_attributes</name>
18538
19761
<full_name>save_attributes</full_name>
18539
<docblock line="232">
19762
<docblock line="234">
18540
19763
<description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
18541
19764
<long-description><![CDATA[]]></long-description>
18542
<tag line="232" name="return" description="list of modifications <br>This function returns an array with 3 entries: <br>array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) <br>DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) <br>"add" are attributes which have to be added to LDAP entry <br>"remove" are attributes which have to be removed from LDAP entry <br>"modify" are attributes which have to been modified in LDAP entry <br>"info" are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
19765
<tag line="234" name="return" description="list of modifications <br>This function returns an array with 3 entries: <br>array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) <br>DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) <br>"add" are attributes which have to be added to LDAP entry <br>"remove" are attributes which have to be removed from LDAP entry <br>"modify" are attributes which have to been modified in LDAP entry <br>"info" are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
18543
19766
<type by_reference="false">array</type>
18544
19767
</tag>
18545
19768
</docblock>
18546
19769
</method>
18547
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="258" package="modules">
19770
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="260" package="modules">
18548
19771
<name>process_attributes</name>
18549
19772
<full_name>process_attributes</full_name>
18550
<docblock line="252">
19773
<docblock line="254">
18551
19774
<description><![CDATA[Processes user input of the primary module page.]]></description>
18552
19775
<long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
18553
<tag line="252" name="return" description="list of info/error messages" type="array">
19776
<tag line="254" name="return" description="list of info/error messages" type="array">
18554
19777
<type by_reference="false">array</type>
18555
19778
</tag>
18556
19779
</docblock>
18557
19780
</method>
18558
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="295" package="modules">
19781
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="297" package="modules">
18559
19782
<name>display_html_attributes</name>
18560
19783
<full_name>display_html_attributes</full_name>
18561
<docblock line="290">
19784
<docblock line="292">
18562
19785
<description><![CDATA[This function will create the meta HTML code to show a page with all attributes.]]></description>
18563
19786
<long-description><![CDATA[]]></long-description>
18564
<tag line="290" name="return" description="meta HTML code" type="array">
19787
<tag line="292" name="return" description="meta HTML code" type="array">
18565
19788
<type by_reference="false">array</type>
18566
19789
</tag>
18567
19790
</docblock>
18568
19791
</method>
18569
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="380" package="modules">
19792
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="382" package="modules">
18570
19793
<name>process_expire</name>
18571
19794
<full_name>process_expire</full_name>
18572
<docblock line="374">
19795
<docblock line="376">
18573
19796
<description><![CDATA[Processes user input of the expiration page.]]></description>
18574
19797
<long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
18575
<tag line="374" name="return" description="list of info/error messages" type="array">
19798
<tag line="376" name="return" description="list of info/error messages" type="array">
18576
19799
<type by_reference="false">array</type>
18577
19800
</tag>
18578
19801
</docblock>
18579
19802
</method>
18580
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="432" package="modules">
19803
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="434" package="modules">
18581
19804
<name>display_html_expire</name>
18582
19805
<full_name>display_html_expire</full_name>
18583
<docblock line="427">
19806
<docblock line="429">
18584
19807
<description><![CDATA[This function will create the meta HTML code to show a page with the expiration date.]]></description>
18585
19808
<long-description><![CDATA[]]></long-description>
18586
<tag line="427" name="return" description="meta HTML code" type="array">
19809
<tag line="429" name="return" description="meta HTML code" type="array">
18587
19810
<type by_reference="false">array</type>
18588
19811
</tag>
18589
19812
</docblock>
18590
19813
</method>
18591
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="478" package="modules">
19814
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="480" package="modules">
18592
19815
<name>get_pdfEntries</name>
18593
19816
<full_name>get_pdfEntries</full_name>
18594
<docblock line="473">
19817
<docblock line="475">
18595
19818
<description><![CDATA[Returns the PDF entries for this module.]]></description>
18596
19819
<long-description><![CDATA[]]></long-description>
18597
<tag line="473" name="return" description="list of possible PDF entries" type="array">
19820
<tag line="475" name="return" description="list of possible PDF entries" type="array">
18598
19821
<type by_reference="false">array</type>
18599
19822
</tag>
18600
19823
</docblock>
18601
19824
</method>
18602
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="521" package="modules">
19825
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="508" package="modules">
18603
19826
<name>build_uploadAccounts</name>
18604
19827
<full_name>build_uploadAccounts</full_name>
18605
<docblock line="512">
19828
<docblock line="499">
18606
19829
<description><![CDATA[In this function the LDAP account is built up.]]></description>
18607
19830
<long-description><![CDATA[]]></long-description>
18608
<tag line="512" name="param" description="list of hash arrays (name => value) from user input" type="array" variable="$rawAccounts">
18609
<type by_reference="false">array</type>
18610
</tag>
18611
<tag line="512" name="param" description="list of IDs for column position (e.g. "posixAccount_uid" => 5)" type="array" variable="$ids">
18612
<type by_reference="false">array</type>
18613
</tag>
18614
<tag line="512" name="param" description="list of hash arrays (name => value) which are later added to LDAP" type="array" variable="$partialAccounts">
18615
<type by_reference="false">array</type>
18616
</tag>
18617
<tag line="512" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
18618
<type by_reference="false">array</type>
18619
</tag>
18620
<tag line="512" name="return" description="list of error messages if any" type="array">
19831
<tag line="499" name="param" description="list of hash arrays (name => value) from user input" type="array" variable="$rawAccounts">
19832
<type by_reference="false">array</type>
19833
</tag>
19834
<tag line="499" name="param" description="list of IDs for column position (e.g. "posixAccount_uid" => 5)" type="array" variable="$ids">
19835
<type by_reference="false">array</type>
19836
</tag>
19837
<tag line="499" name="param" description="list of hash arrays (name => value) which are later added to LDAP" type="array" variable="$partialAccounts">
19838
<type by_reference="false">array</type>
19839
</tag>
19840
<tag line="499" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
19841
<type by_reference="false">array</type>
19842
</tag>
19843
<tag line="499" name="return" description="list of error messages if any" type="array">
18621
19844
<type by_reference="false">array</type>
18622
19845
</tag>
18623
19846
</docblock>
18624
<argument line="521">
19847
<argument line="508">
18625
19848
<name>$rawAccounts</name>
18626
19849
<default><![CDATA[]]></default>
18627
19850
<type/>
18628
19851
</argument>
18629
<argument line="521">
19852
<argument line="508">
18630
19853
<name>$ids</name>
18631
19854
<default><![CDATA[]]></default>
18632
19855
<type/>
18633
19856
</argument>
18634
<argument line="521">
19857
<argument line="508">
18635
19858
<name>$partialAccounts</name>
18636
19859
<default><![CDATA[]]></default>
18637
19860
<type/>
18638
19861
</argument>
18639
<argument line="521">
19862
<argument line="508">
18640
19863
<name>$selectedModules</name>
18641
19864
<default><![CDATA[]]></default>
18642
19865
<type/>
18643
19866
</argument>
18644
19867
</method>
18645
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="601" package="modules">
19868
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="588" package="modules">
18646
19869
<name>load_profile</name>
18647
19870
<full_name>load_profile</full_name>
18648
<docblock line="596">
19871
<docblock line="583">
18649
19872
<description><![CDATA[Loads the values of an account profile into internal variables.]]></description>
18650
19873
<long-description><![CDATA[]]></long-description>
18651
<tag line="596" name="param" description="hash array with profile values (identifier => value)" type="array" variable="$profile">
19874
<tag line="583" name="param" description="hash array with profile values (identifier => value)" type="array" variable="$profile">
18652
19875
<type by_reference="false">array</type>
18653
19876
</tag>
18654
19877
</docblock>
18655
<argument line="601">
19878
<argument line="588">
18656
19879
<name>$profile</name>
18657
19880
<default><![CDATA[]]></default>
18658
19881
<type/>
18659
19882
</argument>
18660
19883
</method>
18661
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="625" package="modules">
19884
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="612" package="modules">
18662
19885
<name>managesPasswordAttributes</name>
18663
19886
<full_name>managesPasswordAttributes</full_name>
18664
<docblock line="619">
19887
<docblock line="606">
18665
19888
<description><![CDATA[This method specifies if a module manages password attributes.]]></description>
18666
19889
<long-description><![CDATA[]]></long-description>
18667
<tag line="619" name="see" description="\global\passwordService::managesPasswordAttributes" refers="\global\passwordService::managesPasswordAttributes"/>
18668
<tag line="619" name="return" description="true if this module manages password attributes" type="boolean">
19890
<tag line="606" name="see" description="\global\passwordService::managesPasswordAttributes" refers="\global\passwordService::managesPasswordAttributes"/>
19891
<tag line="606" name="return" description="true if this module manages password attributes" type="boolean">
18669
19892
<type by_reference="false">boolean</type>
18670
19893
</tag>
18671
19894
</docblock>
18672
19895
</method>
18673
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="635" package="modules">
19896
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="622" package="modules">
18674
19897
<name>supportsForcePasswordChange</name>
18675
19898
<full_name>supportsForcePasswordChange</full_name>
18676
<docblock line="630">
19899
<docblock line="617">
18677
19900
<description><![CDATA[Specifies if this module supports to force that a user must change his password on next login.]]></description>
18678
19901
<long-description><![CDATA[]]></long-description>
18679
<tag line="630" name="return" description="force password change supported" type="boolean">
19902
<tag line="617" name="return" description="force password change supported" type="boolean">
18680
19903
<type by_reference="false">boolean</type>
18681
19904
</tag>
18682
19905
</docblock>
18683
19906
</method>
18684
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="650" package="modules">
19907
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="637" package="modules">
18685
19908
<name>passwordChangeRequested</name>
18686
19909
<full_name>passwordChangeRequested</full_name>
18687
<docblock line="639">
19910
<docblock line="626">
18688
19911
<description><![CDATA[This function is called whenever the password should be changed.]]></description>
18689
19912
<long-description><![CDATA[<p>Account modules
18690
19913
must change their password attributes only if the modules list contains their module name.</p>]]></long-description>
18691
<tag line="639" name="param" description="new password" type="String" variable="$password">
19914
<tag line="626" name="param" description="new password" type="String" variable="$password">
18692
19915
<type by_reference="false">String</type>
18693
19916
</tag>
18694
<tag line="639" name="param" description="list of modules for which the password should be changed" type="\$modules" variable="$modules">
19917
<tag line="626" name="param" description="list of modules for which the password should be changed" type="\$modules" variable="$modules">
18695
19918
<type by_reference="false">\$modules</type>
18696
19919
</tag>
18697
<tag line="639" name="param" description="force the user to change his password at next login" type="boolean" variable="$forcePasswordChange">
19920
<tag line="626" name="param" description="force the user to change his password at next login" type="boolean" variable="$forcePasswordChange">
18698
19921
<type by_reference="false">boolean</type>
18699
19922
</tag>
18700
<tag line="639" name="return" description="list of error messages if any as parameter array for StatusMessage e.g. return arrray(array('ERROR', 'Password change failed.'))" type="array">
19923
<tag line="626" name="return" description="list of error messages if any as parameter array for StatusMessage e.g. return arrray(array('ERROR', 'Password change failed.'))" type="array">
18701
19924
<type by_reference="false">array</type>
18702
19925
</tag>
18703
<tag line="639" name="see" description="\global\passwordService::passwordChangeRequested" refers="\global\passwordService::passwordChangeRequested"/>
19926
<tag line="626" name="see" description="\global\passwordService::passwordChangeRequested" refers="\global\passwordService::passwordChangeRequested"/>
18704
19927
</docblock>
18705
<argument line="650">
19928
<argument line="637">
18706
19929
<name>$password</name>
18707
19930
<default><![CDATA[]]></default>
18708
19931
<type/>
18709
19932
</argument>
18710
<argument line="650">
19933
<argument line="637">
18711
19934
<name>$modules</name>
18712
19935
<default><![CDATA[]]></default>
18713
19936
<type/>
18714
19937
</argument>
18715
<argument line="650">
19938
<argument line="637">
18716
19939
<name>$forcePasswordChange</name>
18717
19940
<default><![CDATA[]]></default>
18718
19941
<type/>
18719
19942
</argument>
18720
19943
</method>
18721
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="672" package="modules">
19944
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="659" package="modules">
18722
19945
<name>setExpirationDate</name>
18723
19946
<full_name>setExpirationDate</full_name>
18724
<docblock line="664">
19947
<docblock line="651">
18725
19948
<description><![CDATA[Sets the expiration date of this account.]]></description>
18726
19949
<long-description><![CDATA[<p>If all parameters are null the expiration date will be removed.</p>]]></long-description>
18727
<tag line="664" name="param" description="year (e.g. 2040)" type="String" variable="$year">
18728
<type by_reference="false">String</type>
18729
</tag>
18730
<tag line="664" name="param" description="month (e.g. 8)" type="String" variable="$month">
18731
<type by_reference="false">String</type>
18732
</tag>
18733
<tag line="664" name="param" description="day (e.g. 27)" type="String" variable="$day">
19950
<tag line="651" name="param" description="year (e.g. 2040)" type="String" variable="$year">
19951
<type by_reference="false">String</type>
19952
</tag>
19953
<tag line="651" name="param" description="month (e.g. 8)" type="String" variable="$month">
19954
<type by_reference="false">String</type>
19955
</tag>
19956
<tag line="651" name="param" description="day (e.g. 27)" type="String" variable="$day">
18734
19957
<type by_reference="false">String</type>
18735
19958
</tag>
18736
19959
</docblock>
18737
<argument line="672">
19960
<argument line="659">
18738
19961
<name>$year</name>
18739
19962
<default><![CDATA[]]></default>
18740
19963
<type/>
18741
19964
</argument>
18742
<argument line="672">
19965
<argument line="659">
18743
19966
<name>$month</name>
18744
19967
<default><![CDATA[]]></default>
18745
19968
<type/>
18746
19969
</argument>
18747
<argument line="672">
19970
<argument line="659">
18748
19971
<name>$day</name>
18749
19972
<default><![CDATA[]]></default>
18750
19973
<type/>
18950
20173
</method>
18951
20174
</class>
18952
20175
</file>
18953
<file path="lib/modules/nisnetgroup.inc" hash="979876950103a803cd79d5a3400f8514" package="modules">
20176
<file path="lib/modules/nisnetgroup.inc" hash="d2d3fc0b586fb829e99182d9a501c9a5" package="modules">
18954
20177
<docblock line="24">
18955
20178
<description><![CDATA[Manages entries based on the object class nisNetgroup.]]></description>
18956
20179
<long-description><![CDATA[]]></long-description>
19149
20372
<long-description><![CDATA[]]></long-description>
19150
20373
</docblock>
19151
20374
</method>
19152
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="608" package="modules">
20375
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="603" package="modules">
19153
20376
<name>getGroupList</name>
19154
20377
<full_name>getGroupList</full_name>
19155
<docblock line="603">
20378
<docblock line="598">
19156
20379
<description><![CDATA[Returns a list of existing NIS net groups.]]></description>
19157
20380
<long-description><![CDATA[]]></long-description>
19158
<tag line="603" name="return" description="group names" type="array">
20381
<tag line="598" name="return" description="group names" type="array">
19159
20382
<type by_reference="false">array</type>
19160
20383
</tag>
19161
20384
</docblock>
19162
20385
</method>
19163
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="624" package="modules">
20386
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="619" package="modules">
19164
20387
<name>getUserList</name>
19165
20388
<full_name>getUserList</full_name>
19166
<docblock line="619">
20389
<docblock line="614">
19167
20390
<description><![CDATA[Returns a list of existing users.]]></description>
19168
20391
<long-description><![CDATA[]]></long-description>
19169
<tag line="619" name="return" description="user names" type="array">
20392
<tag line="614" name="return" description="user names" type="array">
19170
20393
<type by_reference="false">array</type>
19171
20394
</tag>
19172
20395
</docblock>
19173
20396
</method>
19174
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="640" package="modules">
20397
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="635" package="modules">
19175
20398
<name>getHostList</name>
19176
20399
<full_name>getHostList</full_name>
19177
<docblock line="635">
20400
<docblock line="630">
19178
20401
<description><![CDATA[Returns a list of existing hosts.]]></description>
19179
20402
<long-description><![CDATA[]]></long-description>
19180
<tag line="635" name="return" description="host names" type="array">
20403
<tag line="630" name="return" description="host names" type="array">
19181
20404
<type by_reference="false">array</type>
19182
20405
</tag>
19183
20406
</docblock>
19184
20407
</method>
19185
20408
</class>
19186
20409
</file>
19187
<file path="lib/modules/sambaDomain.inc" hash="afd25c9aa8c33ca8c727320a4928bc07" package="modules">
20410
<file path="lib/modules/sambaDomain.inc" hash="98e02c6f4de894f57f2bc7b767919c15" package="modules">
19188
20411
<docblock line="23">
19189
20412
<description><![CDATA[Manages Samba 3 domain entries.]]></description>
19190
20413
<long-description><![CDATA[]]></long-description>
19298
20521
</method>
19299
20522
</class>
19300
20523
</file>
19301
<file path="lib/modules/inetOrgPerson.inc" hash="5d4797075e17824c1f65507eac81e61c" package="modules">
20524
<file path="lib/modules/inetOrgPerson.inc" hash="93d23946c092dadec75502ba52c366a5" package="modules">
19302
20525
<docblock line="24">
19303
20526
<description><![CDATA[Manages the atrributes of object class inetOrgPerson.]]></description>
19304
20527
<long-description><![CDATA[]]></long-description>
19317
20540
<long-description><![CDATA[<p>name and address).</p>]]></long-description>
19318
20541
<tag line="33" name="package" description="modules"/>
19319
20542
</docblock>
20543
<constant namespace="global" line="58" package="modules">
20544
<name>SESS_CERTIFICATES_LIST</name>
20545
<full_name>SESS_CERTIFICATES_LIST</full_name>
20546
<value><![CDATA['inetOrgPerson_certificatesList']]></value>
20547
<docblock line="57">
20548
<description><![CDATA[session variable for existing user certificates in self service]]></description>
20549
<long-description><![CDATA[]]></long-description>
20550
</docblock>
20551
</constant>
19320
20552
<property final="false" static="false" visibility="private" line="41" namespace="global" package="main">
19321
20553
<name>$cachedManagers</name>
19322
20554
<default><![CDATA[null]]></default>
19333
20565
<long-description><![CDATA[]]></long-description>
19334
20566
</docblock>
19335
20567
</property>
19336
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="48" package="modules">
20568
<property final="false" static="false" visibility="private" line="45" namespace="global" package="main">
20569
<name>$departmentCache</name>
20570
<default><![CDATA[null]]></default>
20571
<docblock line="44">
20572
<description><![CDATA[cache for departments]]></description>
20573
<long-description><![CDATA[]]></long-description>
20574
</docblock>
20575
</property>
20576
<property final="false" static="false" visibility="private" line="47" namespace="global" package="main">
20577
<name>$oCache</name>
20578
<default><![CDATA[null]]></default>
20579
<docblock line="46">
20580
<description><![CDATA[organization cache]]></description>
20581
<long-description><![CDATA[]]></long-description>
20582
</docblock>
20583
</property>
20584
<property final="false" static="false" visibility="private" line="49" namespace="global" package="main">
20585
<name>$ouCache</name>
20586
<default><![CDATA[null]]></default>
20587
<docblock line="48">
20588
<description><![CDATA[organizational unit cache]]></description>
20589
<long-description><![CDATA[]]></long-description>
20590
</docblock>
20591
</property>
20592
<property final="false" static="false" visibility="private" line="51" namespace="global" package="main">
20593
<name>$titleCache</name>
20594
<default><![CDATA[null]]></default>
20595
<docblock line="50">
20596
<description><![CDATA[title cache]]></description>
20597
<long-description><![CDATA[]]></long-description>
20598
</docblock>
20599
</property>
20600
<property final="false" static="false" visibility="private" line="53" namespace="global" package="main">
20601
<name>$employeeTypeCache</name>
20602
<default><![CDATA[null]]></default>
20603
<docblock line="52">
20604
<description><![CDATA[employee type cache]]></description>
20605
<long-description><![CDATA[]]></long-description>
20606
</docblock>
20607
</property>
20608
<property final="false" static="false" visibility="private" line="55" namespace="global" package="main">
20609
<name>$businessCategoryCache</name>
20610
<default><![CDATA[null]]></default>
20611
<docblock line="54">
20612
<description><![CDATA[business category cache]]></description>
20613
<long-description><![CDATA[]]></long-description>
20614
</docblock>
20615
</property>
20616
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="63" package="modules">
19337
20617
<name>load_Messages</name>
19338
20618
<full_name>load_Messages</full_name>
19339
<docblock line="45">
20619
<docblock line="60">
19340
20620
<description><![CDATA[This function fills the message array.]]></description>
19341
20621
<long-description><![CDATA[]]></long-description>
19342
20622
</docblock>
19343
20623
</method>
19344
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="94" package="modules">
20624
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="110" package="modules">
19345
20625
<name>get_metaData</name>
19346
20626
<full_name>get_metaData</full_name>
19347
<docblock line="87">
20627
<docblock line="103">
19348
20628
<description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
19349
20629
<long-description><![CDATA[]]></long-description>
19350
<tag line="87" name="return" description="array with meta data" type="array">
20630
<tag line="103" name="return" description="array with meta data" type="array">
19351
20631
<type by_reference="false">array</type>
19352
20632
</tag>
19353
<tag line="87" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
20633
<tag line="103" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
19354
20634
</docblock>
19355
20635
</method>
19356
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="887" package="modules">
20636
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="924" package="modules">
19357
20637
<name>module_complete</name>
19358
20638
<full_name>module_complete</full_name>
19359
<docblock line="882">
20639
<docblock line="919">
19360
20640
<description><![CDATA[This functions return true if all needed settings are done.]]></description>
19361
20641
<long-description><![CDATA[]]></long-description>
19362
<tag line="882" name="return" description="true, if all is ok" type="boolean">
20642
<tag line="919" name="return" description="true, if all is ok" type="boolean">
19363
20643
<type by_reference="false">boolean</type>
19364
20644
</tag>
19365
20645
</docblock>
19366
20646
</method>
19367
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="910" package="modules">
20647
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="947" package="modules">
19368
20648
<name>getButtonStatus</name>
19369
20649
<full_name>getButtonStatus</full_name>
19370
<docblock line="905">
20650
<docblock line="942">
19371
20651
<description><![CDATA[Controls if the module button the account page is visible and activated.]]></description>
19372
20652
<long-description><![CDATA[]]></long-description>
19373
<tag line="905" name="return" description="status ("enabled", "disabled", "hidden")" type="string">
20653
<tag line="942" name="return" description="status ("enabled", "disabled", "hidden")" type="string">
19374
20654
<type by_reference="false">string</type>
19375
20655
</tag>
19376
20656
</docblock>
19377
20657
</method>
19378
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="933" package="modules">
20658
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="970" package="modules">
19379
20659
<name>save_attributes</name>
19380
20660
<full_name>save_attributes</full_name>
19381
<docblock line="921">
20661
<docblock line="958">
19382
20662
<description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
19383
20663
<long-description><![CDATA[]]></long-description>
19384
<tag line="921" name="return" description="list of modifications <br>This function returns an array with 3 entries: <br>array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) <br>DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) <br>"add" are attributes which have to be added to LDAP entry <br>"remove" are attributes which have to be removed from LDAP entry <br>"modify" are attributes which have to been modified in LDAP entry <br>"info" are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
20664
<tag line="958" name="return" description="list of modifications <br>This function returns an array with 3 entries: <br>array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) <br>DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) <br>"add" are attributes which have to be added to LDAP entry <br>"remove" are attributes which have to be removed from LDAP entry <br>"modify" are attributes which have to been modified in LDAP entry <br>"info" are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
19385
20665
<type by_reference="false">array</type>
19386
20666
</tag>
19387
20667
</docblock>
19388
20668
</method>
19389
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="974" package="modules">
20669
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1011" package="modules">
19390
20670
<name>process_attributes</name>
19391
20671
<full_name>process_attributes</full_name>
19392
<docblock line="968">
20672
<docblock line="1005">
19393
20673
<description><![CDATA[Processes user input of the primary module page.]]></description>
19394
20674
<long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
19395
<tag line="968" name="return" description="list of info/error messages" type="array">
20675
<tag line="1005" name="return" description="list of info/error messages" type="array">
19396
20676
<type by_reference="false">array</type>
19397
20677
</tag>
19398
20678
</docblock>
19399
20679
</method>
19400
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1357" package="modules">
20680
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1394" package="modules">
19401
20681
<name>display_html_attributes</name>
19402
20682
<full_name>display_html_attributes</full_name>
19403
<docblock line="1352">
20683
<docblock line="1389">
19404
20684
<description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
19405
20685
<long-description><![CDATA[]]></long-description>
19406
<tag line="1352" name="return" description="HTML meta data" type="array">
20686
<tag line="1389" name="return" description="HTML meta data" type="array">
19407
20687
<type by_reference="false">array</type>
19408
20688
</tag>
19409
20689
</docblock>
19410
20690
</method>
19411
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2037" package="modules">
20691
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2118" package="modules">
19412
20692
<name>process_photo</name>
19413
20693
<full_name>process_photo</full_name>
19414
<docblock line="2034">
20694
<docblock line="2115">
19415
20695
<description><![CDATA[Sets a new photo.]]></description>
19416
20696
<long-description><![CDATA[]]></long-description>
19417
20697
</docblock>
19418
20698
</method>
19419
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2059" package="modules">
20699
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2140" package="modules">
19420
20700
<name>display_html_photo</name>
19421
20701
<full_name>display_html_photo</full_name>
19422
<docblock line="2054">
20702
<docblock line="2135">
19423
20703
<description><![CDATA[Displays the photo upload page.]]></description>
19424
20704
<long-description><![CDATA[]]></long-description>
19425
<tag line="2054" name="return" description="meta HTML code" type="array">
20705
<tag line="2135" name="return" description="meta HTML code" type="array">
19426
20706
<type by_reference="false">array</type>
19427
20707
</tag>
19428
20708
</docblock>
19429
20709
</method>
19430
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2074" package="modules">
20710
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2155" package="modules">
19431
20711
<name>display_html_manager</name>
19432
20712
<full_name>display_html_manager</full_name>
19433
<docblock line="2069">
20713
<docblock line="2150">
19434
20714
<description><![CDATA[This function will create the meta HTML code to show a page to change the manager attribute.]]></description>
19435
20715
<long-description><![CDATA[]]></long-description>
19436
<tag line="2069" name="return" description="HTML meta data" type="\htmlElement">
20716
<tag line="2150" name="return" description="HTML meta data" type="\htmlElement">
19437
20717
<type by_reference="false">\htmlElement</type>
19438
20718
</tag>
19439
20719
</docblock>
19440
20720
</method>
19441
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2151" package="modules">
20721
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2232" package="modules">
19442
20722
<name>process_manager</name>
19443
20723
<full_name>process_manager</full_name>
19444
<docblock line="2145">
20724
<docblock line="2226">
19445
20725
<description><![CDATA[Processes user input of the manager page.]]></description>
19446
20726
<long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
19447
<tag line="2145" name="return" description="list of info/error messages" type="array">
20727
<tag line="2226" name="return" description="list of info/error messages" type="array">
19448
20728
<type by_reference="false">array</type>
19449
20729
</tag>
19450
20730
</docblock>
19451
20731
</method>
19452
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2176" package="modules">
20732
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2257" package="modules">
19453
20733
<name>display_html_userCertificate</name>
19454
20734
<full_name>display_html_userCertificate</full_name>
19455
<docblock line="2171">
20735
<docblock line="2252">
19456
20736
<description><![CDATA[Displays the certificate upload page.]]></description>
19457
20737
<long-description><![CDATA[]]></long-description>
19458
<tag line="2171" name="return" description="meta HTML code" type="array">
20738
<tag line="2252" name="return" description="meta HTML code" type="array">
19459
20739
<type by_reference="false">array</type>
19460
20740
</tag>
19461
20741
</docblock>
19462
20742
</method>
19463
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2232" package="modules">
20743
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2313" package="modules">
19464
20744
<name>process_userCertificate</name>
19465
20745
<full_name>process_userCertificate</full_name>
19466
<docblock line="2229">
20746
<docblock line="2310">
19467
20747
<description><![CDATA[Sets a new certificate or deletes old ones.]]></description>
19468
20748
<long-description><![CDATA[]]></long-description>
19469
20749
</docblock>
19470
20750
</method>
19471
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2273" package="modules">
20751
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2354" package="modules">
19472
20752
<name>get_pdfEntries</name>
19473
20753
<full_name>get_pdfEntries</full_name>
19474
<docblock line="2268">
20754
<docblock line="2349">
19475
20755
<description><![CDATA[Returns the PDF entries for this module.]]></description>
19476
20756
<long-description><![CDATA[]]></long-description>
19477
<tag line="2268" name="return" description="list of possible PDF entries" type="array">
20757
<tag line="2349" name="return" description="list of possible PDF entries" type="array">
19478
20758
<type by_reference="false">array</type>
19479
20759
</tag>
19480
20760
</docblock>
19481
20761
</method>
19482
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2427" package="modules">
20762
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2394" package="modules">
19483
20763
<name>load_profile</name>
19484
20764
<full_name>load_profile</full_name>
19485
<docblock line="2422">
20765
<docblock line="2389">
19486
20766
<description><![CDATA[Loads the values of an account profile into internal variables.]]></description>
19487
20767
<long-description><![CDATA[]]></long-description>
19488
<tag line="2422" name="param" description="hash array with profile values (identifier => value)" type="array" variable="$profile">
20768
<tag line="2389" name="param" description="hash array with profile values (identifier => value)" type="array" variable="$profile">
19489
20769
<type by_reference="false">array</type>
19490
20770
</tag>
19491
20771
</docblock>
19492
<argument line="2427">
20772
<argument line="2394">
19493
20773
<name>$profile</name>
19494
20774
<default><![CDATA[]]></default>
19495
20775
<type/>
19496
20776
</argument>
19497
20777
</method>
19498
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2490" package="modules">
20778
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2457" package="modules">
19499
20779
<name>check_profileOptions</name>
19500
20780
<full_name>check_profileOptions</full_name>
19501
<docblock line="2484">
20781
<docblock line="2451">
19502
20782
<description><![CDATA[Checks input values of account profiles.]]></description>
19503
20783
<long-description><![CDATA[]]></long-description>
19504
<tag line="2484" name="param" description="a hash array (name => value) containing the options" type="array" variable="$options">
20784
<tag line="2451" name="param" description="a hash array (name => value) containing the options" type="array" variable="$options">
19505
20785
<type by_reference="false">array</type>
19506
20786
</tag>
19507
<tag line="2484" name="return" description="list of error messages (array(type, title, text)) to generate StatusMessages, if any" type="array">
20787
<tag line="2451" name="return" description="list of error messages (array(type, title, text)) to generate StatusMessages, if any" type="array">
19508
20788
<type by_reference="false">array</type>
19509
20789
</tag>
19510
20790
</docblock>
19511
<argument line="2490">
20791
<argument line="2457">
19512
20792
<name>$options</name>
19513
20793
<default><![CDATA[]]></default>
19514
20794
<type/>
19515
20795
</argument>
19516
20796
</method>
19517
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2528" package="modules">
20797
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2495" package="modules">
19518
20798
<name>get_uploadColumns</name>
19519
20799
<full_name>get_uploadColumns</full_name>
19520
<docblock line="2513">
20800
<docblock line="2480">
19521
20801
<description><![CDATA[Returns an array containing all input columns for the file upload.]]></description>
19522
20802
<long-description><![CDATA[<p>Syntax:
19523
20803
<br> array(
19527
20807
<br> string: example, // example value
19528
20808
<br> boolean: required // true, if user must set a value for this column
19529
20809
<br> )</p>]]></long-description>
19530
<tag line="2513" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
20810
<tag line="2480" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
19531
20811
<type by_reference="false">array</type>
19532
20812
</tag>
19533
<tag line="2513" name="return" description="column list" type="array">
20813
<tag line="2480" name="return" description="column list" type="array">
19534
20814
<type by_reference="false">array</type>
19535
20815
</tag>
19536
20816
</docblock>
19537
<argument line="2528">
20817
<argument line="2495">
19538
20818
<name>$selectedModules</name>
19539
20819
<default><![CDATA[]]></default>
19540
20820
<type/>
19541
20821
</argument>
19542
20822
</method>
19543
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2568" package="modules">
20823
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2535" package="modules">
19544
20824
<name>build_uploadAccounts</name>
19545
20825
<full_name>build_uploadAccounts</full_name>
19546
<docblock line="2559">
20826
<docblock line="2526">
19547
20827
<description><![CDATA[In this function the LDAP account is built up.]]></description>
19548
20828
<long-description><![CDATA[]]></long-description>
19549
<tag line="2559" name="param" description="list of hash arrays (name => value) from user input" type="array" variable="$rawAccounts">
19550
<type by_reference="false">array</type>
19551
</tag>
19552
<tag line="2559" name="param" description="list of IDs for column position (e.g. "posixAccount_uid" => 5)" type="array" variable="$ids">
19553
<type by_reference="false">array</type>
19554
</tag>
19555
<tag line="2559" name="param" description="list of hash arrays (name => value) which are later added to LDAP" type="array" variable="$partialAccounts">
19556
<type by_reference="false">array</type>
19557
</tag>
19558
<tag line="2559" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
19559
<type by_reference="false">array</type>
19560
</tag>
19561
<tag line="2559" name="return" description="list of error messages if any" type="array">
20829
<tag line="2526" name="param" description="list of hash arrays (name => value) from user input" type="array" variable="$rawAccounts">
20830
<type by_reference="false">array</type>
20831
</tag>
20832
<tag line="2526" name="param" description="list of IDs for column position (e.g. "posixAccount_uid" => 5)" type="array" variable="$ids">
20833
<type by_reference="false">array</type>
20834
</tag>
20835
<tag line="2526" name="param" description="list of hash arrays (name => value) which are later added to LDAP" type="array" variable="$partialAccounts">
20836
<type by_reference="false">array</type>
20837
</tag>
20838
<tag line="2526" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
20839
<type by_reference="false">array</type>
20840
</tag>
20841
<tag line="2526" name="return" description="list of error messages if any" type="array">
19562
20842
<type by_reference="false">array</type>
19563
20843
</tag>
19564
20844
</docblock>
19565
<argument line="2568">
20845
<argument line="2535">
19566
20846
<name>$rawAccounts</name>
19567
20847
<default><![CDATA[]]></default>
19568
20848
<type/>
19569
20849
</argument>
19570
<argument line="2568">
20850
<argument line="2535">
19571
20851
<name>$ids</name>
19572
20852
<default><![CDATA[]]></default>
19573
20853
<type/>
19574
20854
</argument>
19575
<argument line="2568">
20855
<argument line="2535">
19576
20856
<name>$partialAccounts</name>
19577
20857
<default><![CDATA[]]></default>
19578
20858
<type/>
19579
20859
</argument>
19580
<argument line="2568">
20860
<argument line="2535">
19581
20861
<name>$selectedModules</name>
19582
20862
<default><![CDATA[]]></default>
19583
20863
<type/>
19584
20864
</argument>
19585
20865
</method>
19586
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2877" package="modules">
20866
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2855" package="modules">
20867
<name>doUploadPostActions</name>
20868
<full_name>doUploadPostActions</full_name>
20869
<docblock line="2840">
20870
<description><![CDATA[This function executes one post upload action.]]></description>
20871
<long-description><![CDATA[]]></long-description>
20872
<tag line="2840" name="param" description="array containing one account in each element" type="array" variable="$data">
20873
<type by_reference="false">array</type>
20874
</tag>
20875
<tag line="2840" name="param" description="array(<column_name> => <column number>)" type="array" variable="$ids">
20876
<type by_reference="false">array</type>
20877
</tag>
20878
<tag line="2840" name="param" description="list of accounts which were not created successfully" type="array" variable="$failed">
20879
<type by_reference="false">array</type>
20880
</tag>
20881
<tag line="2840" name="param" description="variable to store temporary data between two post actions" type="array" variable="$temp">
20882
<type by_reference="false">array</type>
20883
</tag>
20884
<tag line="2840" name="param" description="list of LDAP entries" type="array" variable="$accounts">
20885
<type by_reference="false">array</type>
20886
</tag>
20887
<tag line="2840" name="return" description="current status <br> array ( <br> 'status' => 'finished' | 'inProgress' <br> 'progress' => 0..100 <br> 'errors' => array (<array of parameters for StatusMessage>) <br> )" type="array">
20888
<type by_reference="false">array</type>
20889
</tag>
20890
</docblock>
20891
<argument line="2855">
20892
<name>$data</name>
20893
<default><![CDATA[]]></default>
20894
<type/>
20895
</argument>
20896
<argument line="2855">
20897
<name>$ids</name>
20898
<default><![CDATA[]]></default>
20899
<type/>
20900
</argument>
20901
<argument line="2855">
20902
<name>$failed</name>
20903
<default><![CDATA[]]></default>
20904
<type/>
20905
</argument>
20906
<argument line="2855">
20907
<name>$temp</name>
20908
<default><![CDATA[]]></default>
20909
<type/>
20910
</argument>
20911
<argument line="2855">
20912
<name>$accounts</name>
20913
<default><![CDATA[]]></default>
20914
<type/>
20915
</argument>
20916
</method>
20917
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2910" package="modules">
19587
20918
<name>getSelfServiceOptions</name>
19588
20919
<full_name>getSelfServiceOptions</full_name>
19589
<docblock line="2866">
20920
<docblock line="2899">
19590
20921
<description><![CDATA[Returns the meta HTML code for each input field.]]></description>
19591
20922
<long-description><![CDATA[<p>format: array(<field1> => array(<META HTML>), ...)
19592
20923
It is not possible to display help links.</p>]]></long-description>
19593
<tag line="2866" name="param" description="list of active fields" type="array" variable="$fields">
19594
<type by_reference="false">array</type>
19595
</tag>
19596
<tag line="2866" name="param" description="attributes of LDAP account" type="array" variable="$attributes">
19597
<type by_reference="false">array</type>
19598
</tag>
19599
<tag line="2866" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
20924
<tag line="2899" name="param" description="list of active fields" type="array" variable="$fields">
20925
<type by_reference="false">array</type>
20926
</tag>
20927
<tag line="2899" name="param" description="attributes of LDAP account" type="array" variable="$attributes">
20928
<type by_reference="false">array</type>
20929
</tag>
20930
<tag line="2899" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
19600
20931
<type by_reference="false">boolean</type>
19601
20932
</tag>
19602
<tag line="2866" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
20933
<tag line="2899" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
19603
20934
<type by_reference="false">array</type>
19604
20935
</tag>
19605
<tag line="2866" name="return" description="list of meta HTML elements (field name => htmlTableRow)" type="array">
20936
<tag line="2899" name="return" description="list of meta HTML elements (field name => htmlTableRow)" type="array">
19606
20937
<type by_reference="false">array</type>
19607
20938
</tag>
19608
20939
</docblock>
19609
<argument line="2877">
20940
<argument line="2910">
19610
20941
<name>$fields</name>
19611
20942
<default><![CDATA[]]></default>
19612
20943
<type/>
19613
20944
</argument>
19614
<argument line="2877">
20945
<argument line="2910">
19615
20946
<name>$attributes</name>
19616
20947
<default><![CDATA[]]></default>
19617
20948
<type/>
19618
20949
</argument>
19619
<argument line="2877">
20950
<argument line="2910">
19620
20951
<name>$passwordChangeOnly</name>
19621
20952
<default><![CDATA[]]></default>
19622
20953
<type/>
19623
20954
</argument>
19624
<argument line="2877">
20955
<argument line="2910">
19625
20956
<name>$readOnlyFields</name>
19626
20957
<default><![CDATA[]]></default>
19627
20958
<type/>
19628
20959
</argument>
19629
20960
</method>
19630
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3171" package="modules">
20961
<method final="false" abstract="false" static="true" visibility="private" namespace="global" line="3223" package="modules">
20962
<name>getSelfServiceUserCertificates</name>
20963
<full_name>getSelfServiceUserCertificates</full_name>
20964
<docblock line="3217">
20965
<description><![CDATA[Returns the meta HTML code to display the certificate area.]]></description>
20966
<long-description><![CDATA[<p>This also includes the file upload.</p>]]></long-description>
20967
<tag line="3217" name="return" description="certificate content" type="\htmlTable">
20968
<type by_reference="false">\htmlTable</type>
20969
</tag>
20970
</docblock>
20971
</method>
20972
<method final="false" abstract="false" static="true" visibility="private" namespace="global" line="3271" package="modules">
20973
<name>getSelfServiceUserCertificatesJSBlock</name>
20974
<full_name>getSelfServiceUserCertificatesJSBlock</full_name>
20975
<docblock line="3266">
20976
<description><![CDATA[Returns the Java Script functions to manage the certificates.]]></description>
20977
<long-description><![CDATA[]]></long-description>
20978
<tag line="3266" name="return" description="JS block" type="\htmlJavaScript">
20979
<type by_reference="false">\htmlJavaScript</type>
20980
</tag>
20981
</docblock>
20982
</method>
20983
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3339" package="modules">
19631
20984
<name>checkSelfServiceOptions</name>
19632
20985
<full_name>checkSelfServiceOptions</full_name>
19633
<docblock line="3154">
20986
<docblock line="3322">
19634
20987
<description><![CDATA[Checks if all input values are correct and returns the LDAP attributes which should be changed.]]></description>
19635
20988
<long-description><![CDATA[<p><br>Return values:
19636
20989
<br>messages: array of parameters to create status messages
19640
20993
<br>info: array of values with informational value (e.g. to be used later by pre/postModify actions)</p>
19641
20994
19642
20995
<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
19643
<tag line="3154" name="param" description="input fields" type="string" variable="$fields">
20996
<tag line="3322" name="param" description="input fields" type="string" variable="$fields">
19644
20997
<type by_reference="false">string</type>
19645
20998
</tag>
19646
<tag line="3154" name="param" description="LDAP attributes" type="array" variable="$attributes">
20999
<tag line="3322" name="param" description="LDAP attributes" type="array" variable="$attributes">
19647
21000
<type by_reference="false">array</type>
19648
21001
</tag>
19649
<tag line="3154" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
21002
<tag line="3322" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
19650
21003
<type by_reference="false">boolean</type>
19651
21004
</tag>
19652
<tag line="3154" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
21005
<tag line="3322" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
19653
21006
<type by_reference="false">array</type>
19654
21007
</tag>
19655
<tag line="3154" name="return" description="messages and attributes (array('messages' => array(), 'add' => array('mail' => array('test@test.com')), 'del' => array(), 'mod' => array(), 'info' => array()))" type="array">
21008
<tag line="3322" name="return" description="messages and attributes (array('messages' => array(), 'add' => array('mail' => array('test@test.com')), 'del' => array(), 'mod' => array(), 'info' => array()))" type="array">
19656
21009
<type by_reference="false">array</type>
19657
21010
</tag>
19658
21011
</docblock>
19659
<argument line="3171">
21012
<argument line="3339">
19660
21013
<name>$fields</name>
19661
21014
<default><![CDATA[]]></default>
19662
21015
<type/>
19663
21016
</argument>
19664
<argument line="3171">
21017
<argument line="3339">
19665
21018
<name>$attributes</name>
19666
21019
<default><![CDATA[]]></default>
19667
21020
<type/>
19668
21021
</argument>
19669
<argument line="3171">
21022
<argument line="3339">
19670
21023
<name>$passwordChangeOnly</name>
19671
21024
<default><![CDATA[]]></default>
19672
21025
<type/>
19673
21026
</argument>
19674
<argument line="3171">
21027
<argument line="3339">
19675
21028
<name>$readOnlyFields</name>
19676
21029
<default><![CDATA[]]></default>
19677
21030
<type/>
19678
21031
</argument>
19679
21032
</method>
19680
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3427" package="modules">
21033
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3608" package="modules">
21034
<name>handleAjaxRequest</name>
21035
<full_name>handleAjaxRequest</full_name>
21036
<docblock line="3604">
21037
<description><![CDATA[Manages AJAX requests.]]></description>
21038
<long-description><![CDATA[<p>This function may be called with or without an account container.</p>]]></long-description>
21039
</docblock>
21040
</method>
21041
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="3627" package="modules">
21042
<name>ajaxUpload</name>
21043
<full_name>ajaxUpload</full_name>
21044
<docblock line="3624">
21045
<description><![CDATA[Handles an AJAX file upload and prints the JSON result.]]></description>
21046
<long-description><![CDATA[]]></long-description>
21047
</docblock>
21048
</method>
21049
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="3666" package="modules">
21050
<name>ajaxDeleteSelfServiceUserCertificate</name>
21051
<full_name>ajaxDeleteSelfServiceUserCertificate</full_name>
21052
<docblock line="3661">
21053
<description><![CDATA[Manages the deletion of a certificate.]]></description>
21054
<long-description><![CDATA[]]></long-description>
21055
<tag line="3661" name="param" description="JSON data" type="array" variable="$data">
21056
<type by_reference="false">array</type>
21057
</tag>
21058
</docblock>
21059
<argument line="3666">
21060
<name>$data</name>
21061
<default><![CDATA[]]></default>
21062
<type/>
21063
</argument>
21064
</method>
21065
<method final="false" abstract="false" static="true" visibility="public" namespace="global" line="3694" package="modules">
21066
<name>invalidAjaxRequest</name>
21067
<full_name>invalidAjaxRequest</full_name>
21068
<docblock line="3689">
21069
<description><![CDATA[Invalid AJAX request received.]]></description>
21070
<long-description><![CDATA[]]></long-description>
21071
<tag line="3689" name="param" description="error message" type="String" variable="$message">
21072
<type by_reference="false">String</type>
21073
</tag>
21074
</docblock>
21075
<argument line="3694">
21076
<name>$message</name>
21077
<default><![CDATA[null]]></default>
21078
<type/>
21079
</argument>
21080
</method>
21081
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3707" package="modules">
19681
21082
<name>managesPasswordAttributes</name>
19682
21083
<full_name>managesPasswordAttributes</full_name>
19683
<docblock line="3421">
21084
<docblock line="3701">
19684
21085
<description><![CDATA[This method specifies if a module manages password attributes.]]></description>
19685
21086
<long-description><![CDATA[]]></long-description>
19686
<tag line="3421" name="see" description="\global\passwordService::managesPasswordAttributes" refers="\global\passwordService::managesPasswordAttributes"/>
19687
<tag line="3421" name="return" description="true if this module manages password attributes" type="boolean">
21087
<tag line="3701" name="see" description="\global\passwordService::managesPasswordAttributes" refers="\global\passwordService::managesPasswordAttributes"/>
21088
<tag line="3701" name="return" description="true if this module manages password attributes" type="boolean">
19688
21089
<type by_reference="false">boolean</type>
19689
21090
</tag>
19690
21091
</docblock>
19691
21092
</method>
19692
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3440" package="modules">
21093
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3720" package="modules">
19693
21094
<name>supportsForcePasswordChange</name>
19694
21095
<full_name>supportsForcePasswordChange</full_name>
19695
<docblock line="3435">
21096
<docblock line="3715">
19696
21097
<description><![CDATA[Specifies if this module supports to force that a user must change his password on next login.]]></description>
19697
21098
<long-description><![CDATA[]]></long-description>
19698
<tag line="3435" name="return" description="force password change supported" type="boolean">
21099
<tag line="3715" name="return" description="force password change supported" type="boolean">
19699
21100
<type by_reference="false">boolean</type>
19700
21101
</tag>
19701
21102
</docblock>
19702
21103
</method>
19703
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3455" package="modules">
21104
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="3735" package="modules">
19704
21105
<name>passwordChangeRequested</name>
19705
21106
<full_name>passwordChangeRequested</full_name>
19706
<docblock line="3444">
21107
<docblock line="3724">
19707
21108
<description><![CDATA[This function is called whenever the password should be changed.]]></description>
19708
21109
<long-description><![CDATA[<p>Account modules
19709
21110
must change their password attributes only if the modules list contains their module name.</p>]]></long-description>
19710
<tag line="3444" name="param" description="new password" type="String" variable="$password">
21111
<tag line="3724" name="param" description="new password" type="String" variable="$password">
19711
21112
<type by_reference="false">String</type>
19712
21113
</tag>
19713
<tag line="3444" name="param" description="list of modules for which the password should be changed" type="\$modules" variable="$modules">
21114
<tag line="3724" name="param" description="list of modules for which the password should be changed" type="\$modules" variable="$modules">
19714
21115
<type by_reference="false">\$modules</type>
19715
21116
</tag>
19716
<tag line="3444" name="param" description="force the user to change his password at next login" type="boolean" variable="$forcePasswordChange">
21117
<tag line="3724" name="param" description="force the user to change his password at next login" type="boolean" variable="$forcePasswordChange">
19717
21118
<type by_reference="false">boolean</type>
19718
21119
</tag>
19719
<tag line="3444" name="return" description="list of error messages if any as parameter array for StatusMessage e.g. return arrray(array('ERROR', 'Password change failed.'))" type="array">
21120
<tag line="3724" name="return" description="list of error messages if any as parameter array for StatusMessage e.g. return arrray(array('ERROR', 'Password change failed.'))" type="array">
19720
21121
<type by_reference="false">array</type>
19721
21122
</tag>
19722
<tag line="3444" name="see" description="\global\passwordService::passwordChangeRequested" refers="\global\passwordService::passwordChangeRequested"/>
21123
<tag line="3724" name="see" description="\global\passwordService::passwordChangeRequested" refers="\global\passwordService::passwordChangeRequested"/>
19723
21124
</docblock>
19724
<argument line="3455">
21125
<argument line="3735">
19725
21126
<name>$password</name>
19726
21127
<default><![CDATA[]]></default>
19727
21128
<type/>
19728
21129
</argument>
19729
<argument line="3455">
21130
<argument line="3735">
19730
21131
<name>$modules</name>
19731
21132
<default><![CDATA[]]></default>
19732
21133
<type/>
19733
21134
</argument>
19734
<argument line="3455">
21135
<argument line="3735">
19735
21136
<name>$forcePasswordChange</name>
19736
21137
<default><![CDATA[]]></default>
19737
21138
<type/>
19738
21139
</argument>
19739
21140
</method>
19740
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="3469" package="modules">
21141
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="3749" package="modules">
19741
21142
<name>getManagers</name>
19742
21143
<full_name>getManagers</full_name>
19743
<docblock line="3464">
21144
<docblock line="3744">
19744
21145
<description><![CDATA[Returns a list of possible managers.]]></description>
19745
21146
<long-description><![CDATA[]]></long-description>
19746
<tag line="3464" name="return" description="list of format array(abstract DN => DN)" type="array">
21147
<tag line="3744" name="return" description="list of format array(abstract DN => DN)" type="array">
19747
21148
<type by_reference="false">array</type>
19748
21149
</tag>
19749
21150
</docblock>
19750
21151
</method>
21152
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="3769" package="modules">
21153
<name>initCache</name>
21154
<full_name>initCache</full_name>
21155
<docblock line="3766">
21156
<description><![CDATA[Loads cached data from LDAP such as departmets etc.]]></description>
21157
<long-description><![CDATA[]]></long-description>
21158
</docblock>
21159
</method>
19751
21160
</class>
19752
21161
</file>
19753
21162
<file path="lib/modules/systemQuotas.inc" hash="e82d9463ec00ed5b5fe39fd29ebccb75" package="modules">
19955
21364
</method>
19956
21365
</class>
19957
21366
</file>
19958
<file path="lib/modules/freeRadius.inc" hash="d29cb95e2f4c233f2dd565ff3a03f4ed" package="modules">
21367
<file path="lib/modules/freeRadius.inc" hash="e3c1425abc51704bd88107052e40440e" package="modules">
19959
21368
<docblock line="23">
19960
21369
<description><![CDATA[Manages FreeRadius accounts.]]></description>
19961
21370
<long-description><![CDATA[]]></long-description>
20113
21522
</tag>
20114
21523
</docblock>
20115
21524
</method>
20116
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="643" package="modules">
21525
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="633" package="modules">
20117
21526
<name>check_profileOptions</name>
20118
21527
<full_name>check_profileOptions</full_name>
20119
<docblock line="637">
21528
<docblock line="627">
20120
21529
<description><![CDATA[Checks input values of account profiles.]]></description>
20121
21530
<long-description><![CDATA[]]></long-description>
20122
<tag line="637" name="param" description="a hash array (name => value) containing the options" type="array" variable="$options">
21531
<tag line="627" name="param" description="a hash array (name => value) containing the options" type="array" variable="$options">
20123
21532
<type by_reference="false">array</type>
20124
21533
</tag>
20125
<tag line="637" name="return" description="list of error messages (array(type, title, text)) to generate StatusMessages, if any" type="array">
21534
<tag line="627" name="return" description="list of error messages (array(type, title, text)) to generate StatusMessages, if any" type="array">
20126
21535
<type by_reference="false">array</type>
20127
21536
</tag>
20128
21537
</docblock>
20129
<argument line="643">
21538
<argument line="633">
20130
21539
<name>$options</name>
20131
21540
<default><![CDATA[]]></default>
20132
21541
<type/>
20133
21542
</argument>
20134
21543
</method>
20135
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="665" package="modules">
21544
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="655" package="modules">
20136
21545
<name>load_profile</name>
20137
21546
<full_name>load_profile</full_name>
20138
<docblock line="660">
21547
<docblock line="650">
20139
21548
<description><![CDATA[Loads the values of an account profile into internal variables.]]></description>
20140
21549
<long-description><![CDATA[]]></long-description>
20141
<tag line="660" name="param" description="hash array with profile values (identifier => value)" type="array" variable="$profile">
21550
<tag line="650" name="param" description="hash array with profile values (identifier => value)" type="array" variable="$profile">
20142
21551
<type by_reference="false">array</type>
20143
21552
</tag>
20144
21553
</docblock>
20145
<argument line="665">
21554
<argument line="655">
20146
21555
<name>$profile</name>
20147
21556
<default><![CDATA[]]></default>
20148
21557
<type/>
20149
21558
</argument>
20150
21559
</method>
20151
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="681" package="modules">
21560
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="671" package="modules">
20152
21561
<name>formatExpirationDate</name>
20153
21562
<full_name>formatExpirationDate</full_name>
20154
<docblock line="676">
21563
<docblock line="666">
20155
21564
<description><![CDATA[Formats the expiration date attribute.]]></description>
20156
21565
<long-description><![CDATA[]]></long-description>
20157
<tag line="676" name="param" description="date value" type="String" variable="$date">
21566
<tag line="666" name="param" description="date value" type="String" variable="$date">
20158
21567
<type by_reference="false">String</type>
20159
21568
</tag>
20160
21569
</docblock>
20161
<argument line="681">
21570
<argument line="671">
20162
21571
<name>$date</name>
20163
21572
<default><![CDATA[]]></default>
20164
21573
<type/>
20166
21575
</method>
20167
21576
</class>
20168
21577
</file>
20169
<file path="lib/modules/asteriskExtension.inc" hash="11884afd9164a6f7ca60962d6e2598d1" package="modules">
21578
<file path="lib/modules/asteriskExtension.inc" hash="1d215ec460a6b35281289779d79675fc" package="modules">
20170
21579
<docblock line="27">
20171
21580
<description><![CDATA[Manages Asterisk extensions.]]></description>
20172
21581
<long-description><![CDATA[]]></long-description>
20579
21988
<long-description><![CDATA[]]></long-description>
20580
21989
</docblock>
20581
21990
</method>
20582
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="850" package="modules">
21991
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="844" package="modules">
20583
21992
<name>build_uploadAccounts</name>
20584
21993
<full_name>build_uploadAccounts</full_name>
20585
<docblock line="841">
21994
<docblock line="835">
20586
21995
<description><![CDATA[In this function the LDAP account is built up.]]></description>
20587
21996
<long-description><![CDATA[]]></long-description>
20588
<tag line="841" name="param" description="list of hash arrays (name => value) from user input" type="array" variable="$rawAccounts">
20589
<type by_reference="false">array</type>
20590
</tag>
20591
<tag line="841" name="param" description="list of IDs for column position (e.g. "posixAccount_uid" => 5)" type="array" variable="$ids">
20592
<type by_reference="false">array</type>
20593
</tag>
20594
<tag line="841" name="param" description="list of hash arrays (name => value) which are later added to LDAP" type="array" variable="$partialAccounts">
20595
<type by_reference="false">array</type>
20596
</tag>
20597
<tag line="841" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
20598
<type by_reference="false">array</type>
20599
</tag>
20600
<tag line="841" name="return" description="list of error messages if any" type="array">
21997
<tag line="835" name="param" description="list of hash arrays (name => value) from user input" type="array" variable="$rawAccounts">
21998
<type by_reference="false">array</type>
21999
</tag>
22000
<tag line="835" name="param" description="list of IDs for column position (e.g. "posixAccount_uid" => 5)" type="array" variable="$ids">
22001
<type by_reference="false">array</type>
22002
</tag>
22003
<tag line="835" name="param" description="list of hash arrays (name => value) which are later added to LDAP" type="array" variable="$partialAccounts">
22004
<type by_reference="false">array</type>
22005
</tag>
22006
<tag line="835" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
22007
<type by_reference="false">array</type>
22008
</tag>
22009
<tag line="835" name="return" description="list of error messages if any" type="array">
20601
22010
<type by_reference="false">array</type>
20602
22011
</tag>
20603
22012
</docblock>
20604
<argument line="850">
22013
<argument line="844">
20605
22014
<name>$rawAccounts</name>
20606
22015
<default><![CDATA[]]></default>
20607
22016
<type/>
20608
22017
</argument>
20609
<argument line="850">
22018
<argument line="844">
20610
22019
<name>$ids</name>
20611
22020
<default><![CDATA[]]></default>
20612
22021
<type/>
20613
22022
</argument>
20614
<argument line="850">
22023
<argument line="844">
20615
22024
<name>$partialAccounts</name>
20616
22025
<default><![CDATA[]]></default>
20617
22026
<type/>
20618
22027
</argument>
20619
<argument line="850">
22028
<argument line="844">
20620
22029
<name>$selectedModules</name>
20621
22030
<default><![CDATA[]]></default>
20622
22031
<type/>
20623
22032
</argument>
20624
22033
</method>
20625
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="902" package="modules">
22034
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="896" package="modules">
20626
22035
<name>moveExtentionToNewSuffix</name>
20627
22036
<full_name>moveExtentionToNewSuffix</full_name>
20628
<docblock line="896">
22037
<docblock line="890">
20629
22038
<description><![CDATA[Get list of all applications for given extension and move it into new suffix.]]></description>
20630
22039
<long-description><![CDATA[]]></long-description>
20631
<tag line="896" name="param" description="attributes of original extension" type="array" variable="$rowOrig">
22040
<tag line="890" name="param" description="attributes of original extension" type="array" variable="$rowOrig">
20632
22041
<type by_reference="false">array</type>
20633
22042
</tag>
20634
<tag line="896" name="return" description="list of error messages" type="array">
22043
<tag line="890" name="return" description="list of error messages" type="array">
20635
22044
<type by_reference="false">array</type>
20636
22045
</tag>
20637
22046
</docblock>
20638
<argument line="902">
22047
<argument line="896">
20639
22048
<name>$rowOrig</name>
20640
22049
<default><![CDATA[]]></default>
20641
22050
<type/>
20642
22051
</argument>
20643
22052
</method>
20644
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="936" package="modules">
22053
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="930" package="modules">
20645
22054
<name>save_attributes</name>
20646
22055
<full_name>save_attributes</full_name>
20647
<docblock line="916">
22056
<docblock line="910">
20648
22057
<description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
20649
22058
<long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.<br>
20650
22059
<br></p>
20660
22069
<br><b>"info"</b> values with informational value (e.g. to be used later by pre/postModify actions)
20661
22070
<br>
20662
22071
<br>This builds the required comands from $this-attributes and $this->orig.</p>]]></long-description>
20663
<tag line="916" name="return" description="list of modifications" type="array">
22072
<tag line="910" name="return" description="list of modifications" type="array">
20664
22073
<type by_reference="false">array</type>
20665
22074
</tag>
20666
22075
</docblock>
20667
22076
</method>
20668
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="995" package="modules">
22077
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="989" package="modules">
20669
22078
<name>postDeleteActions</name>
20670
22079
<full_name>postDeleteActions</full_name>
20671
<docblock line="989">
22080
<docblock line="983">
20672
22081
<description><![CDATA[Runs ufter main deltete procedure was done and do postmorten for other parts of extension
20673
22082
wtith priority > 1.]]></description>
20674
22083
<long-description><![CDATA[]]></long-description>
20675
<tag line="989" name="return" description="error messages" type="array">
22084
<tag line="983" name="return" description="error messages" type="array">
20676
22085
<type by_reference="false">array</type>
20677
22086
</tag>
20678
22087
</docblock>
21230
22639
<error line="603" code="50015">Argument $checked is missing from the Docblock of setCtxMaxIdleTimeF()</error>
21231
22640
</parse_markers>
21232
22641
</file>
21233
<file path="lib/modules/asteriskVoicemail.inc" hash="88951da0dadedaeb620d2ba5b1e64e9d" package="modules">
22642
<file path="lib/modules/asteriskVoicemail.inc" hash="eb4b8e848006e8ded07bbc6b4f857d5e" package="modules">
21234
22643
<docblock line="26">
21235
22644
<description><![CDATA[Manages the Asterisk extension of user accounts.]]></description>
21236
22645
<long-description><![CDATA[]]></long-description>
21310
22719
<long-description><![CDATA[]]></long-description>
21311
22720
</docblock>
21312
22721
</method>
21313
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="427" package="modules">
22722
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="407" package="modules">
21314
22723
<name>build_uploadAccounts</name>
21315
22724
<full_name>build_uploadAccounts</full_name>
21316
<docblock line="418">
22725
<docblock line="398">
21317
22726
<description><![CDATA[In this function the LDAP account is built up.]]></description>
21318
22727
<long-description><![CDATA[]]></long-description>
21319
<tag line="418" name="param" description="list of hash arrays (name => value) from user input" type="array" variable="$rawAccounts">
21320
<type by_reference="false">array</type>
21321
</tag>
21322
<tag line="418" name="param" description="list of IDs for column position (e.g. "posixAccount_uid" => 5)" type="array" variable="$ids">
21323
<type by_reference="false">array</type>
21324
</tag>
21325
<tag line="418" name="param" description="list of hash arrays (name => value) which are later added to LDAP" type="array" variable="$partialAccounts">
21326
<type by_reference="false">array</type>
21327
</tag>
21328
<tag line="418" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
21329
<type by_reference="false">array</type>
21330
</tag>
21331
<tag line="418" name="return" description="list of error messages if any" type="array">
22728
<tag line="398" name="param" description="list of hash arrays (name => value) from user input" type="array" variable="$rawAccounts">
22729
<type by_reference="false">array</type>
22730
</tag>
22731
<tag line="398" name="param" description="list of IDs for column position (e.g. "posixAccount_uid" => 5)" type="array" variable="$ids">
22732
<type by_reference="false">array</type>
22733
</tag>
22734
<tag line="398" name="param" description="list of hash arrays (name => value) which are later added to LDAP" type="array" variable="$partialAccounts">
22735
<type by_reference="false">array</type>
22736
</tag>
22737
<tag line="398" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
22738
<type by_reference="false">array</type>
22739
</tag>
22740
<tag line="398" name="return" description="list of error messages if any" type="array">
21332
22741
<type by_reference="false">array</type>
21333
22742
</tag>
21334
22743
</docblock>
21335
<argument line="427">
22744
<argument line="407">
21336
22745
<name>$rawAccounts</name>
21337
22746
<default><![CDATA[]]></default>
21338
22747
<type/>
21339
22748
</argument>
21340
<argument line="427">
22749
<argument line="407">
21341
22750
<name>$ids</name>
21342
22751
<default><![CDATA[]]></default>
21343
22752
<type/>
21344
22753
</argument>
21345
<argument line="427">
22754
<argument line="407">
21346
22755
<name>$partialAccounts</name>
21347
22756
<default><![CDATA[]]></default>
21348
22757
<type/>
21349
22758
</argument>
21350
<argument line="427">
22759
<argument line="407">
21351
22760
<name>$selectedModules</name>
21352
22761
<default><![CDATA[]]></default>
21353
22762
<type/>
21354
22763
</argument>
21355
22764
</method>
21356
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="507" package="modules">
22765
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="487" package="modules">
21357
22766
<name>module_complete</name>
21358
22767
<full_name>module_complete</full_name>
21359
<docblock line="502">
22768
<docblock line="482">
21360
22769
<description><![CDATA[This functions returns true if all needed settings are done.]]></description>
21361
22770
<long-description><![CDATA[]]></long-description>
21362
<tag line="502" name="return" description="true if LDAP operation can be done" type="boolean">
22771
<tag line="482" name="return" description="true if LDAP operation can be done" type="boolean">
21363
22772
<type by_reference="false">boolean</type>
21364
22773
</tag>
21365
22774
</docblock>
21366
22775
</method>
21367
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="528" package="modules">
22776
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="508" package="modules">
21368
22777
<name>save_attributes</name>
21369
22778
<full_name>save_attributes</full_name>
21370
<docblock line="516">
22779
<docblock line="496">
21371
22780
<description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
21372
22781
<long-description><![CDATA[]]></long-description>
21373
<tag line="516" name="return" description="list of modifications <br>This function returns an array with 3 entries: <br>array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) <br>DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) <br>"add" are attributes which have to be added to LDAP entry <br>"remove" are attributes which have to be removed from LDAP entry <br>"modify" are attributes which have to been modified in LDAP entry <br>"info" are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
22782
<tag line="496" name="return" description="list of modifications <br>This function returns an array with 3 entries: <br>array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) <br>DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) <br>"add" are attributes which have to be added to LDAP entry <br>"remove" are attributes which have to be removed from LDAP entry <br>"modify" are attributes which have to been modified in LDAP entry <br>"info" are values with informational value (e.g. to be used later by pre/postModify actions)" type="array">
21374
22783
<type by_reference="false">array</type>
21375
22784
</tag>
21376
22785
</docblock>
21377
22786
</method>
21378
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="542" package="modules">
22787
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="522" package="modules">
21379
22788
<name>managesPasswordAttributes</name>
21380
22789
<full_name>managesPasswordAttributes</full_name>
21381
<docblock line="536">
22790
<docblock line="516">
21382
22791
<description><![CDATA[This method specifies if a module manages password attributes.]]></description>
21383
22792
<long-description><![CDATA[]]></long-description>
21384
<tag line="536" name="see" description="\global\passwordService::managesPasswordAttributes" refers="\global\passwordService::managesPasswordAttributes"/>
21385
<tag line="536" name="return" description="true if this module manages password attributes" type="boolean">
22793
<tag line="516" name="see" description="\global\passwordService::managesPasswordAttributes" refers="\global\passwordService::managesPasswordAttributes"/>
22794
<tag line="516" name="return" description="true if this module manages password attributes" type="boolean">
21386
22795
<type by_reference="false">boolean</type>
21387
22796
</tag>
21388
22797
</docblock>
21389
22798
</method>
21390
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="554" package="modules">
22799
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="534" package="modules">
21391
22800
<name>supportsForcePasswordChange</name>
21392
22801
<full_name>supportsForcePasswordChange</full_name>
21393
<docblock line="549">
22802
<docblock line="529">
21394
22803
<description><![CDATA[Specifies if this module supports to force that a user must change his password on next login.]]></description>
21395
22804
<long-description><![CDATA[]]></long-description>
21396
<tag line="549" name="return" description="force password change supported" type="boolean">
22805
<tag line="529" name="return" description="force password change supported" type="boolean">
21397
22806
<type by_reference="false">boolean</type>
21398
22807
</tag>
21399
22808
</docblock>
21400
22809
</method>
21401
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="569" package="modules">
22810
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="549" package="modules">
21402
22811
<name>passwordChangeRequested</name>
21403
22812
<full_name>passwordChangeRequested</full_name>
21404
<docblock line="558">
22813
<docblock line="538">
21405
22814
<description><![CDATA[This function is called whenever the password should be changed.]]></description>
21406
22815
<long-description><![CDATA[<p>Account modules
21407
22816
must change their password attributes only if the modules list contains their module name.</p>]]></long-description>
21408
<tag line="558" name="param" description="new password" type="String" variable="$password">
22817
<tag line="538" name="param" description="new password" type="String" variable="$password">
21409
22818
<type by_reference="false">String</type>
21410
22819
</tag>
21411
<tag line="558" name="param" description="list of modules for which the password should be changed" type="\$modules" variable="$modules">
22820
<tag line="538" name="param" description="list of modules for which the password should be changed" type="\$modules" variable="$modules">
21412
22821
<type by_reference="false">\$modules</type>
21413
22822
</tag>
21414
<tag line="558" name="param" description="force the user to change his password at next login" type="boolean" variable="$forcePasswordChange">
22823
<tag line="538" name="param" description="force the user to change his password at next login" type="boolean" variable="$forcePasswordChange">
21415
22824
<type by_reference="false">boolean</type>
21416
22825
</tag>
21417
<tag line="558" name="return" description="list of error messages if any as parameter array for StatusMessage e.g. return arrray(array('ERROR', 'Password change failed.'))" type="array">
22826
<tag line="538" name="return" description="list of error messages if any as parameter array for StatusMessage e.g. return arrray(array('ERROR', 'Password change failed.'))" type="array">
21418
22827
<type by_reference="false">array</type>
21419
22828
</tag>
21420
<tag line="558" name="see" description="\global\passwordService::passwordChangeRequested" refers="\global\passwordService::passwordChangeRequested"/>
22829
<tag line="538" name="see" description="\global\passwordService::passwordChangeRequested" refers="\global\passwordService::passwordChangeRequested"/>
21421
22830
</docblock>
21422
<argument line="569">
22831
<argument line="549">
21423
22832
<name>$password</name>
21424
22833
<default><![CDATA[]]></default>
21425
22834
<type/>
21426
22835
</argument>
21427
<argument line="569">
22836
<argument line="549">
21428
22837
<name>$modules</name>
21429
22838
<default><![CDATA[]]></default>
21430
22839
<type/>
21431
22840
</argument>
21432
<argument line="569">
22841
<argument line="549">
21433
22842
<name>$forcePasswordChange</name>
21434
22843
<default><![CDATA[]]></default>
21435
22844
<type/>
21436
22845
</argument>
21437
22846
</method>
21438
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="594" package="modules">
22847
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="574" package="modules">
21439
22848
<name>checkSelfServiceOptions</name>
21440
22849
<full_name>checkSelfServiceOptions</full_name>
21441
<docblock line="577">
22850
<docblock line="557">
21442
22851
<description><![CDATA[Checks if all input values are correct and returns the LDAP attributes which should be changed.]]></description>
21443
22852
<long-description><![CDATA[<p><br>Return values:
21444
22853
<br>messages: array of parameters to create status messages
21448
22857
<br>info: array of values with informational value (e.g. to be used later by pre/postModify actions)</p>
21449
22858
21450
22859
<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
21451
<tag line="577" name="param" description="input fields" type="string" variable="$fields">
22860
<tag line="557" name="param" description="input fields" type="string" variable="$fields">
21452
22861
<type by_reference="false">string</type>
21453
22862
</tag>
21454
<tag line="577" name="param" description="LDAP attributes" type="array" variable="$attributes">
22863
<tag line="557" name="param" description="LDAP attributes" type="array" variable="$attributes">
21455
22864
<type by_reference="false">array</type>
21456
22865
</tag>
21457
<tag line="577" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
22866
<tag line="557" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
21458
22867
<type by_reference="false">boolean</type>
21459
22868
</tag>
21460
<tag line="577" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
22869
<tag line="557" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
21461
22870
<type by_reference="false">array</type>
21462
22871
</tag>
21463
<tag line="577" name="return" description="messages and attributes (array('messages' => array(), 'add' => array('mail' => array('test@test.com')), 'del' => array(), 'mod' => array(), 'info' => array()))" type="array">
22872
<tag line="557" name="return" description="messages and attributes (array('messages' => array(), 'add' => array('mail' => array('test@test.com')), 'del' => array(), 'mod' => array(), 'info' => array()))" type="array">
21464
22873
<type by_reference="false">array</type>
21465
22874
</tag>
21466
22875
</docblock>
21467
<argument line="594">
22876
<argument line="574">
21468
22877
<name>$fields</name>
21469
22878
<default><![CDATA[]]></default>
21470
22879
<type/>
21471
22880
</argument>
21472
<argument line="594">
22881
<argument line="574">
21473
22882
<name>$attributes</name>
21474
22883
<default><![CDATA[]]></default>
21475
22884
<type/>
21476
22885
</argument>
21477
<argument line="594">
22886
<argument line="574">
21478
22887
<name>$passwordChangeOnly</name>
21479
22888
<default><![CDATA[]]></default>
21480
22889
<type/>
21481
22890
</argument>
21482
<argument line="594">
22891
<argument line="574">
21483
22892
<name>$readOnlyFields</name>
21484
22893
<default><![CDATA[]]></default>
21485
22894
<type/>
21487
22896
</method>
21488
22897
</class>
21489
22898
</file>
21490
<file path="lib/modules/inetLocalMailRecipient.inc" hash="2b3a6ccba9f0b30d18e520138fa2cda9" package="modules">
22899
<file path="lib/modules/inetLocalMailRecipient.inc" hash="82b354e711be7ce61bac356400191607" package="modules">
21491
22900
<docblock line="23">
21492
22901
<description><![CDATA[Provides mail routing for user accounts.]]></description>
21493
22902
<long-description><![CDATA[]]></long-description>
22041
23450
</method>
22042
23451
</class>
22043
23452
</file>
22044
<file path="lib/modules/authorizedServiceObject.inc" hash="0c23210cdd62776a72daee5e32d8d387" package="modules">
23453
<file path="lib/modules/authorizedServiceObject.inc" hash="6fbebe7dba16b5c1a524b6275b0be83c" package="modules">
22045
23454
<docblock line="26">
22046
23455
<description><![CDATA[Provides Authorized Service for accounts.]]></description>
22047
23456
<long-description><![CDATA[]]></long-description>
22197
23606
</method>
22198
23607
</class>
22199
23608
</file>
22200
<file path="lib/modules/nisMailAlias.inc" hash="c4ae456bca13437fee4d4a39177211ed" package="modules">
23609
<file path="lib/modules/windowsGroup.inc" hash="474c9218a68328c640eb0d925af5b9cd" package="modules">
23610
<docblock line="23">
23611
<description><![CDATA[Manages Windows AD (e.g.]]></description>
23612
<long-description><![CDATA[<p>Samba 4) groups.</p>]]></long-description>
23613
<tag line="23" name="package" description="modules"/>
23614
<tag line="23" name="author" description="Roland Gruber"/>
23615
</docblock>
23616
<class final="false" abstract="false" namespace="global" line="35" package="modules">
23617
<extends>\baseModule</extends>
23618
<name>windowsGroup</name>
23619
<full_name>\windowsGroup</full_name>
23620
<docblock line="30">
23621
<description><![CDATA[Manages Windows AD (e.g.]]></description>
23622
<long-description><![CDATA[<p>Samba 4) groups.</p>]]></long-description>
23623
<tag line="30" name="package" description="modules"/>
23624
</docblock>
23625
<constant namespace="global" line="43" package="modules">
23626
<name>TYPE_SECURITY</name>
23627
<full_name>TYPE_SECURITY</full_name>
23628
<value><![CDATA['security']]></value>
23629
<docblock line="42">
23630
<description><![CDATA[security group]]></description>
23631
<long-description><![CDATA[]]></long-description>
23632
</docblock>
23633
</constant>
23634
<constant namespace="global" line="45" package="modules">
23635
<name>TYPE_DISTRIBUTION</name>
23636
<full_name>TYPE_DISTRIBUTION</full_name>
23637
<value><![CDATA['distribution']]></value>
23638
<docblock line="44">
23639
<description><![CDATA[email list]]></description>
23640
<long-description><![CDATA[]]></long-description>
23641
</docblock>
23642
</constant>
23643
<constant namespace="global" line="47" package="modules">
23644
<name>SCOPE_DOMAIN_LOCAL</name>
23645
<full_name>SCOPE_DOMAIN_LOCAL</full_name>
23646
<value><![CDATA['domain']]></value>
23647
<docblock line="46">
23648
<description><![CDATA[domain local group]]></description>
23649
<long-description><![CDATA[]]></long-description>
23650
</docblock>
23651
</constant>
23652
<constant namespace="global" line="49" package="modules">
23653
<name>SCOPE_GLOBAL</name>
23654
<full_name>SCOPE_GLOBAL</full_name>
23655
<value><![CDATA['global']]></value>
23656
<docblock line="48">
23657
<description><![CDATA[global group]]></description>
23658
<long-description><![CDATA[]]></long-description>
23659
</docblock>
23660
</constant>
23661
<constant namespace="global" line="51" package="modules">
23662
<name>SCOPE_UNIVERSAL</name>
23663
<full_name>SCOPE_UNIVERSAL</full_name>
23664
<value><![CDATA['universal']]></value>
23665
<docblock line="50">
23666
<description><![CDATA[universal group]]></description>
23667
<long-description><![CDATA[]]></long-description>
23668
</docblock>
23669
</constant>
23670
<property final="false" static="false" visibility="private" line="38" namespace="global" package="main">
23671
<name>$groupTypes</name>
23672
<default><![CDATA[]]></default>
23673
<docblock line="37">
23674
<description><![CDATA[possible group types (e.g.]]></description>
23675
<long-description><![CDATA[<p>distribution)</p>]]></long-description>
23676
</docblock>
23677
</property>
23678
<property final="false" static="false" visibility="private" line="40" namespace="global" package="main">
23679
<name>$groupScopes</name>
23680
<default><![CDATA[]]></default>
23681
<docblock line="39">
23682
<description><![CDATA[possible group scopes (e.g.]]></description>
23683
<long-description><![CDATA[<p>universal)</p>]]></long-description>
23684
</docblock>
23685
</property>
23686
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="58" package="modules">
23687
<name>__construct</name>
23688
<full_name>__construct</full_name>
23689
<docblock line="53">
23690
<description><![CDATA[Creates a new module for Samba 3 groups.]]></description>
23691
<long-description><![CDATA[]]></long-description>
23692
<tag line="53" name="param" description="account type" type="string" variable="$scope">
23693
<type by_reference="false">string</type>
23694
</tag>
23695
</docblock>
23696
<argument line="58">
23697
<name>$scope</name>
23698
<default><![CDATA[]]></default>
23699
<type/>
23700
</argument>
23701
</method>
23702
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="79" package="modules">
23703
<name>get_metaData</name>
23704
<full_name>get_metaData</full_name>
23705
<docblock line="72">
23706
<description><![CDATA[Returns meta data that is interpreted by parent class]]></description>
23707
<long-description><![CDATA[]]></long-description>
23708
<tag line="72" name="return" description="array with meta data" type="array">
23709
<type by_reference="false">array</type>
23710
</tag>
23711
<tag line="72" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
23712
</docblock>
23713
</method>
23714
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="239" package="modules">
23715
<name>load_Messages</name>
23716
<full_name>load_Messages</full_name>
23717
<docblock line="236">
23718
<description><![CDATA[This function fills the $messages variable with output messages from this module.]]></description>
23719
<long-description><![CDATA[]]></long-description>
23720
</docblock>
23721
</method>
23722
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="255" package="modules">
23723
<name>display_html_attributes</name>
23724
<full_name>display_html_attributes</full_name>
23725
<docblock line="250">
23726
<description><![CDATA[Returns the HTML meta data for the main account page.]]></description>
23727
<long-description><![CDATA[]]></long-description>
23728
<tag line="250" name="return" description="HTML meta data" type="\htmlElement">
23729
<type by_reference="false">\htmlElement</type>
23730
</tag>
23731
</docblock>
23732
</method>
23733
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="342" package="modules">
23734
<name>process_attributes</name>
23735
<full_name>process_attributes</full_name>
23736
<docblock line="336">
23737
<description><![CDATA[Processes user input of the primary module page.]]></description>
23738
<long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
23739
<tag line="336" name="return" description="list of info/error messages" type="array">
23740
<type by_reference="false">array</type>
23741
</tag>
23742
</docblock>
23743
</method>
23744
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="389" package="modules">
23745
<name>display_html_user</name>
23746
<full_name>display_html_user</full_name>
23747
<docblock line="384">
23748
<description><![CDATA[This function will create the meta HTML code to show a page to change the member attribute.]]></description>
23749
<long-description><![CDATA[]]></long-description>
23750
<tag line="384" name="return" description="HTML meta data" type="\htmlElement">
23751
<type by_reference="false">\htmlElement</type>
23752
</tag>
23753
</docblock>
23754
</method>
23755
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="476" package="modules">
23756
<name>process_user</name>
23757
<full_name>process_user</full_name>
23758
<docblock line="470">
23759
<description><![CDATA[Processes user input of the members page.]]></description>
23760
<long-description><![CDATA[<p>It checks if all input values are correct and updates the associated LDAP attributes.</p>]]></long-description>
23761
<tag line="470" name="return" description="list of info/error messages" type="array">
23762
<type by_reference="false">array</type>
23763
</tag>
23764
</docblock>
23765
</method>
23766
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="513" package="modules">
23767
<name>build_uploadAccounts</name>
23768
<full_name>build_uploadAccounts</full_name>
23769
<docblock line="504">
23770
<description><![CDATA[In this function the LDAP account is built up.]]></description>
23771
<long-description><![CDATA[]]></long-description>
23772
<tag line="504" name="param" description="list of hash arrays (name => value) from user input" type="array" variable="$rawAccounts">
23773
<type by_reference="false">array</type>
23774
</tag>
23775
<tag line="504" name="param" description="list of IDs for column position (e.g. "posixAccount_uid" => 5)" type="array" variable="$ids">
23776
<type by_reference="false">array</type>
23777
</tag>
23778
<tag line="504" name="param" description="list of hash arrays (name => value) which are later added to LDAP" type="array" variable="$partialAccounts">
23779
<type by_reference="false">array</type>
23780
</tag>
23781
<tag line="504" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
23782
<type by_reference="false">array</type>
23783
</tag>
23784
<tag line="504" name="return" description="list of error messages if any" type="array">
23785
<type by_reference="false">array</type>
23786
</tag>
23787
</docblock>
23788
<argument line="513">
23789
<name>$rawAccounts</name>
23790
<default><![CDATA[]]></default>
23791
<type/>
23792
</argument>
23793
<argument line="513">
23794
<name>$ids</name>
23795
<default><![CDATA[]]></default>
23796
<type/>
23797
</argument>
23798
<argument line="513">
23799
<name>$partialAccounts</name>
23800
<default><![CDATA[]]></default>
23801
<type/>
23802
</argument>
23803
<argument line="513">
23804
<name>$selectedModules</name>
23805
<default><![CDATA[]]></default>
23806
<type/>
23807
</argument>
23808
</method>
23809
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="613" package="modules">
23810
<name>get_pdfEntries</name>
23811
<full_name>get_pdfEntries</full_name>
23812
<docblock line="610">
23813
<description><![CDATA[Returns a list of PDF entries]]></description>
23814
<long-description><![CDATA[]]></long-description>
23815
</docblock>
23816
</method>
23817
</class>
23818
</file>
23819
<file path="lib/modules/nisMailAlias.inc" hash="badb27f599275f53195926fefa9023ac" package="modules">
22201
23820
<docblock line="23">
22202
23821
<description><![CDATA[Provides NIS mail alias management.]]></description>
22203
23822
<long-description><![CDATA[]]></long-description>
22361
23980
</tag>
22362
23981
</docblock>
22363
23982
</method>
22364
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="391" package="modules">
23983
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="387" package="modules">
22365
23984
<name>getMailList</name>
22366
23985
<full_name>getMailList</full_name>
22367
<docblock line="386">
23986
<docblock line="382">
22368
23987
<description><![CDATA[Returns a list of existing email addresses.]]></description>
22369
23988
<long-description><![CDATA[]]></long-description>
22370
<tag line="386" name="return" description="email addresses" type="array">
23989
<tag line="382" name="return" description="email addresses" type="array">
22371
23990
<type by_reference="false">array</type>
22372
23991
</tag>
22373
23992
</docblock>
22374
23993
</method>
22375
23994
</class>
22376
23995
</file>
22377
<file path="lib/modules/hostObject.inc" hash="70c6d245d1614dd941fe285847fb6559" package="modules">
23996
<file path="lib/modules/hostObject.inc" hash="083f59c9ea1de48c9401d778b875207a" package="modules">
22378
23997
<docblock line="23">
22379
23998
<description><![CDATA[Manages the hosts to which a user may login.]]></description>
22380
23999
<long-description><![CDATA[]]></long-description>
22513
24132
</tag>
22514
24133
</docblock>
22515
24134
</method>
22516
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="266" package="modules">
24135
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="264" package="modules">
22517
24136
<name>load_profile</name>
22518
24137
<full_name>load_profile</full_name>
22519
<docblock line="261">
24138
<docblock line="259">
22520
24139
<description><![CDATA[Loads the values of an account profile into internal variables.]]></description>
22521
24140
<long-description><![CDATA[]]></long-description>
22522
<tag line="261" name="param" description="hash array with profile values (identifier => value)" type="array" variable="$profile">
24141
<tag line="259" name="param" description="hash array with profile values (identifier => value)" type="array" variable="$profile">
22523
24142
<type by_reference="false">array</type>
22524
24143
</tag>
22525
24144
</docblock>
22526
<argument line="266">
24145
<argument line="264">
22527
24146
<name>$profile</name>
22528
24147
<default><![CDATA[]]></default>
22529
24148
<type/>
22585
24204
</method>
22586
24205
</class>
22587
24206
</file>
22588
<file path="lib/baseType.inc" hash="40f03c0c41eaad38a59decbe73cbc76e" package="types">
24207
<file path="lib/baseType.inc" hash="69ce5e350b3bc35ee96baa70e7c285f0" package="types">
22589
24208
<docblock line="24">
22590
24209
<description><![CDATA[This is the parent class of all account types.]]></description>
22591
24210
<long-description><![CDATA[]]></long-description>
22740
24359
</tag>
22741
24360
</docblock>
22742
24361
</method>
22743
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="170" package="types">
24362
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="178" package="types">
22744
24363
<name>runEditPagePostAction</name>
22745
24364
<full_name>runEditPagePostAction</full_name>
22746
<docblock line="164">
24365
<docblock line="172">
22747
24366
<description><![CDATA[This function is called after the edit page is processed and before the page content is generated.]]></description>
22748
24367
<long-description><![CDATA[<p>This can be used to run custom handlers after each page processing.</p>]]></long-description>
22749
<tag line="164" name="param" description="account container" type="\accountContainer" variable="$container">
24368
<tag line="172" name="param" description="account container" type="\accountContainer" variable="$container">
22750
24369
<type by_reference="false">\accountContainer</type>
22751
24370
</tag>
22752
24371
</docblock>
22753
<argument line="170">
24372
<argument line="178">
22754
24373
<name>$container</name>
22755
24374
<default><![CDATA[]]></default>
22756
24375
<type/>
22958
24577
</argument>
22959
24578
</function>
22960
24579
</file>
22961
<file path="lib/lists.inc" hash="a58c1d029ab5e507a505aa83424df541" package="lists">
24580
<file path="lib/lists.inc" hash="40f71c66da243d3297b9f3af4846fa30" package="lists">
22962
24581
<docblock line="25">
22963
24582
<description><![CDATA[This file includes functions to manage the list views.]]></description>
22964
24583
<long-description><![CDATA[]]></long-description>
22986
24605
<long-description><![CDATA[]]></long-description>
22987
24606
</docblock>
22988
24607
</include>
22989
<include line="784" type="Include" package="main">
24608
<include line="809" type="Include" package="main">
22990
24609
<name>../main_header.php</name>
22991
24610
</include>
22992
<include line="803" type="Include" package="main">
24611
<include line="828" type="Include" package="main">
22993
24612
<name>../main_footer.php</name>
22994
24613
</include>
22995
24614
<class final="false" abstract="false" namespace="global" line="47" package="lists">
23002
24621
<tag line="40" name="package" description="lists"/>
23003
24622
<tag line="40" name="author" description="Roland Gruber"/>
23004
24623
</docblock>
23005
<constant namespace="global" line="95" package="lists">
24624
<constant namespace="global" line="98" package="lists">
23006
24625
<name>LIST_SIZE_OPTION_NAME</name>
23007
24626
<full_name>LIST_SIZE_OPTION_NAME</full_name>
23008
24627
<value><![CDATA["L_SIZE"]]></value>
23009
<docblock line="94">
24628
<docblock line="97">
23010
24629
<description><![CDATA[ID for list size config option]]></description>
23011
24630
<long-description><![CDATA[]]></long-description>
23012
24631
</docblock>
23013
24632
</constant>
23014
<constant namespace="global" line="98" package="lists">
24633
<constant namespace="global" line="101" package="lists">
23015
24634
<name>VIRTUAL_ATTRIBUTE_PREFIX</name>
23016
24635
<full_name>VIRTUAL_ATTRIBUTE_PREFIX</full_name>
23017
24636
<value><![CDATA['lam_virtual_']]></value>
23018
<docblock line="97">
24637
<docblock line="100">
23019
24638
<description><![CDATA[prefix for virtual (non-LDAP) attributes]]></description>
23020
24639
<long-description><![CDATA[]]></long-description>
23021
24640
</docblock>
23101
24720
</docblock>
23102
24721
</property>
23103
24722
<property final="false" static="false" visibility="protected" line="80" namespace="global" package="main">
24723
<name>$sortMapping</name>
24724
<default><![CDATA[]]></default>
24725
<docblock line="79">
24726
<description><![CDATA[sort mapping for entries array(original index => sorted index)]]></description>
24727
<long-description><![CDATA[]]></long-description>
24728
</docblock>
24729
</property>
24730
<property final="false" static="false" visibility="protected" line="83" namespace="global" package="main">
23104
24731
<name>$filters</name>
23105
24732
<default><![CDATA[array()]]></default>
23106
<docblock line="79">
24733
<docblock line="82">
23107
24734
<description><![CDATA[list of filters (attribute name => filter input)]]></description>
23108
24735
<long-description><![CDATA[]]></long-description>
23109
24736
</docblock>
23110
24737
</property>
23111
<property final="false" static="false" visibility="protected" line="83" namespace="global" package="main">
24738
<property final="false" static="false" visibility="protected" line="86" namespace="global" package="main">
23112
24739
<name>$possibleSuffixes</name>
23113
24740
<default><![CDATA[]]></default>
23114
<docblock line="82">
24741
<docblock line="85">
23115
24742
<description><![CDATA[list of possible LDAP suffixes(organizational units)]]></description>
23116
24743
<long-description><![CDATA[]]></long-description>
23117
24744
</docblock>
23118
24745
</property>
23119
<property final="false" static="false" visibility="protected" line="86" namespace="global" package="main">
24746
<property final="false" static="false" visibility="protected" line="89" namespace="global" package="main">
23120
24747
<name>$labels</name>
23121
24748
<default><![CDATA[]]></default>
23122
<docblock line="85">
24749
<docblock line="88">
23123
24750
<description><![CDATA[list of account specific labels]]></description>
23124
24751
<long-description><![CDATA[]]></long-description>
23125
24752
</docblock>
23126
24753
</property>
23127
<property final="false" static="false" visibility="private" line="89" namespace="global" package="main">
24754
<property final="false" static="false" visibility="private" line="92" namespace="global" package="main">
23128
24755
<name>$configOptions</name>
23129
24756
<default><![CDATA[]]></default>
23130
<docblock line="88">
24757
<docblock line="91">
23131
24758
<description><![CDATA[configuration options]]></description>
23132
24759
<long-description><![CDATA[]]></long-description>
23133
24760
</docblock>
23134
24761
</property>
23135
<property final="false" static="false" visibility="protected" line="92" namespace="global" package="main">
24762
<property final="false" static="false" visibility="protected" line="95" namespace="global" package="main">
23136
24763
<name>$tabindex</name>
23137
24764
<default><![CDATA[1]]></default>
23138
<docblock line="91">
24765
<docblock line="94">
23139
24766
<description><![CDATA[tabindex for GUI elements]]></description>
23140
24767
<long-description><![CDATA[]]></long-description>
23141
24768
</docblock>
23142
24769
</property>
23143
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="106" package="lists">
24770
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="109" package="lists">
23144
24771
<name>__construct</name>
23145
24772
<full_name>__construct</full_name>
23146
<docblock line="100">
24773
<docblock line="103">
23147
24774
<description><![CDATA[Constructor]]></description>
23148
24775
<long-description><![CDATA[]]></long-description>
23149
<tag line="100" name="param" description="account type" type="string" variable="$type">
24776
<tag line="103" name="param" description="account type" type="string" variable="$type">
23150
24777
<type by_reference="false">string</type>
23151
24778
</tag>
23152
<tag line="100" name="return" description="list object" type="\lamList">
24779
<tag line="103" name="return" description="list object" type="\lamList">
23153
24780
<type by_reference="false">\lamList</type>
23154
24781
</tag>
23155
24782
</docblock>
23156
<argument line="106">
24783
<argument line="109">
23157
24784
<name>$type</name>
23158
24785
<default><![CDATA[]]></default>
23159
24786
<type/>
23160
24787
</argument>
23161
24788
</method>
23162
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="120" package="lists">
24789
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="123" package="lists">
23163
24790
<name>listReadOptionsFromCookie</name>
23164
24791
<full_name>listReadOptionsFromCookie</full_name>
23165
<docblock line="117">
24792
<docblock line="120">
23166
24793
<description><![CDATA[Reads the list options from the cookie value.]]></description>
23167
24794
<long-description><![CDATA[]]></long-description>
23168
24795
</docblock>
23169
24796
</method>
23170
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="146" package="lists">
24797
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="149" package="lists">
23171
24798
<name>showPage</name>
23172
24799
<full_name>showPage</full_name>
23173
<docblock line="143">
24800
<docblock line="146">
23174
24801
<description><![CDATA[Prints the HTML code to display the list view.]]></description>
23175
24802
<long-description><![CDATA[]]></long-description>
23176
24803
</docblock>
23177
24804
</method>
23178
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="205" package="lists">
24805
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="208" package="lists">
23179
24806
<name>listBuildFilter</name>
23180
24807
<full_name>listBuildFilter</full_name>
23181
<docblock line="202">
24808
<docblock line="205">
23182
24809
<description><![CDATA[Builds the regular expressions from the filter values.]]></description>
23183
24810
<long-description><![CDATA[]]></long-description>
23184
24811
</docblock>
23185
24812
</method>
23186
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="238" package="lists">
23187
<name>listSort</name>
23188
<full_name>listSort</full_name>
23189
<docblock line="233">
23190
<description><![CDATA[Sorts an account list by a given attribute]]></description>
23191
<long-description><![CDATA[]]></long-description>
23192
<tag line="233" name="param" description="the account list" type="array" variable="$info">
24813
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="242" package="lists">
24814
<name>listCreateSortMapping</name>
24815
<full_name>listCreateSortMapping</full_name>
24816
<docblock line="236">
24817
<description><![CDATA[Determines the sort mapping and stores it in $this->sortMapping.]]></description>
24818
<long-description><![CDATA[<p>The sort mapping is used to display the right rows when the account table is created.</p>]]></long-description>
24819
<tag line="236" name="param" description="the account list" type="array" variable="$info">
23193
24820
<type by_reference="false">array</type>
23194
24821
</tag>
23195
24822
</docblock>
23196
<argument line="238">
24823
<argument line="242">
23197
24824
<name>$info</name>
23198
24825
<default><![CDATA[]]></default>
23199
24826
<type/>
23200
24827
</argument>
23201
24828
</method>
23202
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="256" package="lists">
23203
<name>cmp_array</name>
23204
<full_name>cmp_array</full_name>
23205
<docblock line="246">
23206
<description><![CDATA[Compare function used for usort-method]]></description>
23207
<long-description><![CDATA[<p>Rows are sorted with the first attribute entry of the sort column.
23208
If objects have attributes with multiple values only the first is used for sorting.</p>]]></long-description>
23209
<tag line="246" name="param" description="first row which is compared" type="array" variable="$a">
23210
<type by_reference="false">array</type>
23211
</tag>
23212
<tag line="246" name="param" description="second row which is compared" type="array" variable="$b">
23213
<type by_reference="false">array</type>
23214
</tag>
23215
<tag line="246" name="return" description="0 if both are equal, 1 if $a is greater, -1 if $b is greater" type="integer">
23216
<type by_reference="false">integer</type>
23217
</tag>
23218
</docblock>
23219
<argument line="256">
23220
<name>$a</name>
23221
<default><![CDATA[]]></default>
23222
<type/>
23223
</argument>
23224
<argument line="256">
23225
<name>$b</name>
23226
<default><![CDATA[]]></default>
23227
<type/>
23228
</argument>
23229
</method>
23230
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="271" package="lists">
24829
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="281" package="lists">
23231
24830
<name>listDrawNavigationBar</name>
23232
24831
<full_name>listDrawNavigationBar</full_name>
23233
<docblock line="266">
24832
<docblock line="276">
23234
24833
<description><![CDATA[Draws a navigation bar to switch between pages]]></description>
23235
24834
<long-description><![CDATA[]]></long-description>
23236
<tag line="266" name="param" description="number of account entries" type="integer" variable="$count">
24835
<tag line="276" name="param" description="number of account entries" type="integer" variable="$count">
23237
24836
<type by_reference="false">integer</type>
23238
24837
</tag>
23239
24838
</docblock>
23240
<argument line="271">
24839
<argument line="281">
23241
24840
<name>$count</name>
23242
24841
<default><![CDATA[]]></default>
23243
24842
<type/>
23244
24843
</argument>
23245
24844
</method>
23246
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="326" package="lists">
24845
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="336" package="lists">
23247
24846
<name>getFilterAsTextForURL</name>
23248
24847
<full_name>getFilterAsTextForURL</full_name>
23249
<docblock line="321">
24848
<docblock line="331">
23250
24849
<description><![CDATA[Returns the filter as text to be used as URL parameter.]]></description>
23251
24850
<long-description><![CDATA[]]></long-description>
23252
<tag line="321" name="return" description="filter text" type="String">
24851
<tag line="331" name="return" description="filter text" type="String">
23253
24852
<type by_reference="false">String</type>
23254
24853
</tag>
23255
24854
</docblock>
23256
24855
</method>
23257
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="337" package="lists">
24856
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="347" package="lists">
23258
24857
<name>listPrintTableHeader</name>
23259
24858
<full_name>listPrintTableHeader</full_name>
23260
<docblock line="334">
24859
<docblock line="344">
23261
24860
<description><![CDATA[Prints the attribute and filter row at the account table head]]></description>
23262
24861
<long-description><![CDATA[]]></long-description>
23263
24862
</docblock>
23264
24863
</method>
23265
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="405" package="lists">
24864
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="415" package="lists">
23266
24865
<name>canBeFiltered</name>
23267
24866
<full_name>canBeFiltered</full_name>
23268
<docblock line="397">
24867
<docblock line="407">
23269
24868
<description><![CDATA[Returns if the given attribute can be filtered.]]></description>
23270
24869
<long-description><![CDATA[<p>If filtering is not possible then no filter box will be displayed.
23271
24870
By default all attributes can be filtered.</p>]]></long-description>
23272
<tag line="397" name="param" description="attribute name" type="String" variable="$attr">
24871
<tag line="407" name="param" description="attribute name" type="String" variable="$attr">
23273
24872
<type by_reference="false">String</type>
23274
24873
</tag>
23275
<tag line="397" name="return" description="filtering possible" type="boolean">
24874
<tag line="407" name="return" description="filtering possible" type="boolean">
23276
24875
<type by_reference="false">boolean</type>
23277
24876
</tag>
23278
24877
</docblock>
23279
<argument line="405">
24878
<argument line="415">
23280
24879
<name>$attr</name>
23281
24880
<default><![CDATA[]]></default>
23282
24881
<type/>
23283
24882
</argument>
23284
24883
</method>
23285
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="414" package="lists">
24884
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="424" package="lists">
23286
24885
<name>listPrintTableBody</name>
23287
24886
<full_name>listPrintTableBody</full_name>
23288
<docblock line="409">
24887
<docblock line="419">
23289
24888
<description><![CDATA[Prints the entry list]]></description>
23290
24889
<long-description><![CDATA[]]></long-description>
23291
<tag line="409" name="param" description="entries" type="array" variable="$info">
24890
<tag line="419" name="param" description="entries" type="array" variable="$info">
23292
24891
<type by_reference="false">array</type>
23293
24892
</tag>
23294
24893
</docblock>
23295
<argument line="414">
24894
<argument line="424">
23296
24895
<name>$info</name>
23297
24896
<default><![CDATA[]]></default>
23298
24897
<type/>
23299
24898
</argument>
23300
24899
</method>
23301
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="460" package="lists">
24900
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="480" package="lists">
23302
24901
<name>listPrintToolLinks</name>
23303
24902
<full_name>listPrintToolLinks</full_name>
23304
<docblock line="454">
24903
<docblock line="474">
23305
24904
<description><![CDATA[Prints the tool image links (e.g.]]></description>
23306
24905
<long-description><![CDATA[<p>edit and delete) for each account.</p>]]></long-description>
23307
<tag line="454" name="param" description="LDAP attributes" type="array" variable="$account">
24906
<tag line="474" name="param" description="LDAP attributes" type="array" variable="$account">
23308
24907
<type by_reference="false">array</type>
23309
24908
</tag>
23310
<tag line="454" name="param" description="account ID" type="String" variable="$id">
24909
<tag line="474" name="param" description="account ID" type="String" variable="$id">
23311
24910
<type by_reference="false">String</type>
23312
24911
</tag>
23313
24912
</docblock>
23314
<argument line="460">
24913
<argument line="480">
23315
24914
<name>$account</name>
23316
24915
<default><![CDATA[]]></default>
23317
24916
<type/>
23318
24917
</argument>
23319
<argument line="460">
24918
<argument line="480">
23320
24919
<name>$id</name>
23321
24920
<default><![CDATA[]]></default>
23322
24921
<type/>
23323
24922
</argument>
23324
24923
</method>
23325
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="500" package="lists">
24924
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="520" package="lists">
23326
24925
<name>listPrintTableCellContent</name>
23327
24926
<full_name>listPrintTableCellContent</full_name>
23328
<docblock line="494">
24927
<docblock line="514">
23329
24928
<description><![CDATA[Prints the content of a cell in the account list for a given LDAP entry and attribute.]]></description>
23330
24929
<long-description><![CDATA[]]></long-description>
23331
<tag line="494" name="param" description="LDAP attributes" type="array" variable="$entry">
24930
<tag line="514" name="param" description="LDAP attributes" type="array" variable="$entry">
23332
24931
<type by_reference="false">array</type>
23333
24932
</tag>
23334
<tag line="494" name="param" description="attribute name" type="string" variable="$attribute">
24933
<tag line="514" name="param" description="attribute name" type="string" variable="$attribute">
23335
24934
<type by_reference="false">string</type>
23336
24935
</tag>
23337
24936
</docblock>
23338
<argument line="500">
24937
<argument line="520">
23339
24938
<name>$entry</name>
23340
24939
<default><![CDATA[]]></default>
23341
24940
<type/>
23342
24941
</argument>
23343
<argument line="500">
24942
<argument line="520">
23344
24943
<name>$attribute</name>
23345
24944
<default><![CDATA[]]></default>
23346
24945
<type/>
23347
24946
</argument>
23348
24947
</method>
23349
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="519" package="lists">
24948
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="539" package="lists">
23350
24949
<name>listDoPost</name>
23351
24950
<full_name>listDoPost</full_name>
23352
<docblock line="514">
24951
<docblock line="534">
23353
24952
<description><![CDATA[Manages all POST actions (e.g.]]></description>
23354
24953
<long-description><![CDATA[<p>button pressed) for the account lists.</p>]]></long-description>
23355
<tag line="514" name="return" description="HTML fragment to insert into beginning of account list" type="String">
24954
<tag line="534" name="return" description="HTML fragment to insert into beginning of account list" type="String">
23356
24955
<type by_reference="false">String</type>
23357
24956
</tag>
23358
24957
</docblock>
23359
24958
</method>
23360
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="636" package="lists">
24959
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="657" package="lists">
23361
24960
<name>showPDFPage</name>
23362
24961
<full_name>showPDFPage</full_name>
23363
<docblock line="631">
24962
<docblock line="652">
23364
24963
<description><![CDATA[Shows the page where the user may select the PDF options.]]></description>
23365
24964
<long-description><![CDATA[]]></long-description>
23366
<tag line="631" name="param" description="account ID" type="String" variable="$id">
24965
<tag line="652" name="param" description="account ID" type="String" variable="$id">
23367
24966
<type by_reference="false">String</type>
23368
24967
</tag>
23369
24968
</docblock>
23370
<argument line="636">
24969
<argument line="657">
23371
24970
<name>$id</name>
23372
24971
<default><![CDATA[]]></default>
23373
24972
<type/>
23374
24973
</argument>
23375
24974
</method>
23376
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="701" package="lists">
24975
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="722" package="lists">
23377
24976
<name>listShowOUSelection</name>
23378
24977
<full_name>listShowOUSelection</full_name>
23379
<docblock line="696">
24978
<docblock line="717">
23380
24979
<description><![CDATA[Prints a combobox with possible sub-DNs.]]></description>
23381
24980
<long-description><![CDATA[]]></long-description>
23382
<tag line="696" name="return" description="OU selection (may be empty)" type="\htmlGroup">
24981
<tag line="717" name="return" description="OU selection (may be empty)" type="\htmlGroup">
23383
24982
<type by_reference="false">\htmlGroup</type>
23384
24983
</tag>
23385
24984
</docblock>
23386
24985
</method>
23387
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="725" package="lists">
24986
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="746" package="lists">
23388
24987
<name>listPrintButtons</name>
23389
24988
<full_name>listPrintButtons</full_name>
23390
<docblock line="719">
24989
<docblock line="740">
23391
24990
<description><![CDATA[Prints the create and delete buttons.]]></description>
23392
24991
<long-description><![CDATA[]]></long-description>
23393
<tag line="719" name="param" description="true if only the create button should be displayed" type="boolean" variable="$createOnly">
24992
<tag line="740" name="param" description="true if only the create button should be displayed" type="boolean" variable="$createOnly">
23394
24993
<type by_reference="false">boolean</type>
23395
24994
</tag>
23396
<tag line="719" name="param" description="HTML tabindex counter" type="int" variable="$tabindex">
24995
<tag line="740" name="param" description="HTML tabindex counter" type="int" variable="$tabindex">
23397
24996
<type by_reference="false">int</type>
23398
24997
</tag>
23399
24998
</docblock>
23400
<argument line="725">
24999
<argument line="746">
23401
25000
<name>$createOnly</name>
23402
25001
<default><![CDATA[]]></default>
23403
25002
<type/>
23404
25003
</argument>
23405
25004
</method>
23406
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="776" package="lists">
25005
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="801" package="lists">
23407
25006
<name>addExtraInputElementsToTopArea</name>
23408
25007
<full_name>addExtraInputElementsToTopArea</full_name>
23409
<docblock line="770">
25008
<docblock line="795">
23410
25009
<description><![CDATA[Can be used by subclasses to add e.g.]]></description>
23411
25010
<long-description><![CDATA[<p>additional buttons to the top area.</p>]]></long-description>
23412
<tag line="770" name="param" description="left part" type="\htmlGroup" variable="$left">
25011
<tag line="795" name="param" description="left part" type="\htmlGroup" variable="$left">
23413
25012
<type by_reference="false">\htmlGroup</type>
23414
25013
</tag>
23415
<tag line="770" name="param" description="right part" type="\htmlGroup" variable="$right">
25014
<tag line="795" name="param" description="right part" type="\htmlGroup" variable="$right">
23416
25015
<type by_reference="false">\htmlGroup</type>
23417
25016
</tag>
23418
25017
</docblock>
23419
<argument line="776">
25018
<argument line="801">
23420
25019
<name>$left</name>
23421
25020
<default><![CDATA[]]></default>
23422
25021
<type/>
23423
25022
</argument>
23424
<argument line="776">
25023
<argument line="801">
23425
25024
<name>$right</name>
23426
25025
<default><![CDATA[]]></default>
23427
25026
<type/>
23428
25027
</argument>
23429
25028
</method>
23430
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="783" package="lists">
25029
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="808" package="lists">
23431
25030
<name>listPrintHeader</name>
23432
25031
<full_name>listPrintHeader</full_name>
23433
<docblock line="780">
25032
<docblock line="805">
23434
25033
<description><![CDATA[Prints the HTML header.]]></description>
23435
25034
<long-description><![CDATA[]]></long-description>
23436
25035
</docblock>
23437
25036
</method>
23438
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="790" package="lists">
25037
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="815" package="lists">
23439
25038
<name>listPrintFooter</name>
23440
25039
<full_name>listPrintFooter</full_name>
23441
<docblock line="787">
25040
<docblock line="812">
23442
25041
<description><![CDATA[Prints the HTML footer.]]></description>
23443
25042
<long-description><![CDATA[]]></long-description>
23444
25043
</docblock>
23445
25044
</method>
23446
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="812" package="lists">
25045
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="837" package="lists">
23447
25046
<name>listGetAttributeDescriptionList</name>
23448
25047
<full_name>listGetAttributeDescriptionList</full_name>
23449
<docblock line="806">
25048
<docblock line="831">
23450
25049
<description><![CDATA[Returns an hash array containing with all attributes to be shown and their descriptions.]]></description>
23451
25050
<long-description><![CDATA[<p>Format: array(attribute => description)</p>]]></long-description>
23452
<tag line="806" name="return" description="attribute list" type="array">
25051
<tag line="831" name="return" description="attribute list" type="array">
23453
25052
<type by_reference="false">array</type>
23454
25053
</tag>
23455
25054
</docblock>
23456
25055
</method>
23457
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="846" package="lists">
25056
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="871" package="lists">
23458
25057
<name>listGetParams</name>
23459
25058
<full_name>listGetParams</full_name>
23460
<docblock line="843">
25059
<docblock line="868">
23461
25060
<description><![CDATA[Sets some internal parameters.]]></description>
23462
25061
<long-description><![CDATA[]]></long-description>
23463
25062
</docblock>
23464
25063
</method>
23465
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="896" package="lists">
25064
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="921" package="lists">
23466
25065
<name>listRefreshData</name>
23467
25066
<full_name>listRefreshData</full_name>
23468
<docblock line="893">
25067
<docblock line="918">
23469
25068
<description><![CDATA[Rereads the entries from LDAP.]]></description>
23470
25069
<long-description><![CDATA[]]></long-description>
23471
25070
</docblock>
23472
25071
</method>
23473
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="934" package="lists">
25072
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="959" package="lists">
23474
25073
<name>buildLDAPAttributeFilter</name>
23475
25074
<full_name>buildLDAPAttributeFilter</full_name>
23476
<docblock line="929">
25075
<docblock line="954">
23477
25076
<description><![CDATA[Builds the LDAP filter based on the filter entries in the GUI.]]></description>
23478
25077
<long-description><![CDATA[]]></long-description>
23479
<tag line="929" name="return" description="LDAP filter" type="String">
25078
<tag line="954" name="return" description="LDAP filter" type="String">
23480
25079
<type by_reference="false">String</type>
23481
25080
</tag>
23482
25081
</docblock>
23483
25082
</method>
23484
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="946" package="lists">
25083
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="971" package="lists">
23485
25084
<name>forceRefresh</name>
23486
25085
<full_name>forceRefresh</full_name>
23487
<docblock line="942">
25086
<docblock line="967">
23488
25087
<description><![CDATA[Forces a refresh of the LDAP data.]]></description>
23489
25088
<long-description><![CDATA[<p>Function must be called before $this->refresh option is checked to load new LDAP data (e.g. in listGetParams).</p>]]></long-description>
23490
25089
</docblock>
23491
25090
</method>
23492
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="959" package="lists">
25091
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="984" package="lists">
23493
25092
<name>getAdditionalLDAPAttributesToRead</name>
23494
25093
<full_name>getAdditionalLDAPAttributesToRead</full_name>
23495
<docblock line="953">
25094
<docblock line="978">
23496
25095
<description><![CDATA[Returns a list of additional LDAP attributes that should be read.]]></description>
23497
25096
<long-description><![CDATA[<p>This can be used to show additional data even if the user selected other attributes to show in the list.</p>]]></long-description>
23498
<tag line="953" name="return" description="additional attribute names" type="array">
25097
<tag line="978" name="return" description="additional attribute names" type="array">
23499
25098
<type by_reference="false">array</type>
23500
25099
</tag>
23501
25100
</docblock>
23502
25101
</method>
23503
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="968" package="lists">
25102
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="993" package="lists">
23504
25103
<name>getAdditionalTools</name>
23505
25104
<full_name>getAdditionalTools</full_name>
23506
<docblock line="963">
25105
<docblock line="988">
23507
25106
<description><![CDATA[Returns a list of lamListTool objects to display next to the edit/delete buttons.]]></description>
23508
25107
<long-description><![CDATA[]]></long-description>
23509
<tag line="963" name="return" description="tools" type="\lamListTool[]">
25108
<tag line="988" name="return" description="tools" type="\lamListTool[]">
23510
25109
<type by_reference="false">\lamListTool[]</type>
23511
25110
</tag>
23512
25111
</docblock>
23513
25112
</method>
23514
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="977" package="lists">
25113
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1002" package="lists">
23515
25114
<name>listGetAllConfigOptions</name>
23516
25115
<full_name>listGetAllConfigOptions</full_name>
23517
<docblock line="972">
25116
<docblock line="997">
23518
25117
<description><![CDATA[Returns a list of possible configuration options.]]></description>
23519
25118
<long-description><![CDATA[]]></long-description>
23520
<tag line="972" name="return" description="list of lamListOption objects" type="array">
25119
<tag line="997" name="return" description="list of lamListOption objects" type="array">
23521
25120
<type by_reference="false">array</type>
23522
25121
</tag>
23523
25122
</docblock>
23524
25123
</method>
23525
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="987" package="lists">
25124
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1012" package="lists">
23526
25125
<name>listPrintConfigurationPage</name>
23527
25126
<full_name>listPrintConfigurationPage</full_name>
23528
<docblock line="984">
25127
<docblock line="1009">
23529
25128
<description><![CDATA[Prints the list configuration page.]]></description>
23530
25129
<long-description><![CDATA[]]></long-description>
23531
25130
</docblock>
23532
25131
</method>
23533
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1010" package="lists">
25132
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1035" package="lists">
23534
25133
<name>listGetConfigOptionByID</name>
23535
25134
<full_name>listGetConfigOptionByID</full_name>
23536
<docblock line="1005">
25135
<docblock line="1030">
23537
25136
<description><![CDATA[Returns the configuration option with the given ID.]]></description>
23538
25137
<long-description><![CDATA[]]></long-description>
23539
<tag line="1005" name="param" description="ID" type="String" variable="$ID">
25138
<tag line="1030" name="param" description="ID" type="String" variable="$ID">
23540
25139
<type by_reference="false">String</type>
23541
25140
</tag>
23542
25141
</docblock>
23543
<argument line="1010">
25142
<argument line="1035">
23544
25143
<name>$ID</name>
23545
25144
<default><![CDATA[]]></default>
23546
25145
<type/>
23547
25146
</argument>
23548
25147
</method>
23549
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1022" package="lists">
25148
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1047" package="lists">
23550
25149
<name>listConfigurationChanged</name>
23551
25150
<full_name>listConfigurationChanged</full_name>
23552
<docblock line="1019">
25151
<docblock line="1044">
23553
25152
<description><![CDATA[Called when the configuration options changed.]]></description>
23554
25153
<long-description><![CDATA[]]></long-description>
23555
25154
</docblock>
23556
25155
</method>
23557
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1033" package="lists">
25156
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1058" package="lists">
23558
25157
<name>listPrintRedirectMessages</name>
23559
25158
<full_name>listPrintRedirectMessages</full_name>
23560
<docblock line="1030">
25159
<docblock line="1055">
23561
25160
<description><![CDATA[Prints messages when another page (e.g.]]></description>
23562
25161
<long-description><![CDATA[<p>delete/upload) redirects to the list view.</p>]]></long-description>
23563
25162
</docblock>
23564
25163
</method>
23565
25164
</class>
23566
<class final="false" abstract="false" namespace="global" line="1059" package="lists">
25165
<class final="false" abstract="false" namespace="global" line="1084" package="lists">
23567
25166
<extends/>
23568
25167
<name>lamListTool</name>
23569
25168
<full_name>\lamListTool</full_name>
23570
<docblock line="1053">
25169
<docblock line="1078">
23571
25170
<description><![CDATA[Represents a tool which can be included in the account lists.]]></description>
23572
25171
<long-description><![CDATA[]]></long-description>
23573
<tag line="1053" name="package" description="lists"/>
23574
<tag line="1053" name="author" description="Roland Gruber"/>
25172
<tag line="1078" name="package" description="lists"/>
25173
<tag line="1078" name="author" description="Roland Gruber"/>
23575
25174
</docblock>
23576
<property final="false" static="false" visibility="private" line="1062" namespace="global" package="main">
25175
<property final="false" static="false" visibility="private" line="1087" namespace="global" package="main">
23577
25176
<name>$name</name>
23578
25177
<default><![CDATA[]]></default>
23579
<docblock line="1061">
25178
<docblock line="1086">
23580
25179
<description><![CDATA[tool name]]></description>
23581
25180
<long-description><![CDATA[]]></long-description>
23582
25181
</docblock>
23583
25182
</property>
23584
<property final="false" static="false" visibility="private" line="1064" namespace="global" package="main">
25183
<property final="false" static="false" visibility="private" line="1089" namespace="global" package="main">
23585
25184
<name>$image</name>
23586
25185
<default><![CDATA[]]></default>
23587
<docblock line="1063">
25186
<docblock line="1088">
23588
25187
<description><![CDATA[tool image]]></description>
23589
25188
<long-description><![CDATA[]]></long-description>
23590
25189
</docblock>
23591
25190
</property>
23592
<property final="false" static="false" visibility="private" line="1066" namespace="global" package="main">
25191
<property final="false" static="false" visibility="private" line="1091" namespace="global" package="main">
23593
25192
<name>$target</name>
23594
25193
<default><![CDATA[]]></default>
23595
<docblock line="1065">
25194
<docblock line="1090">
23596
25195
<description><![CDATA[link target]]></description>
23597
25196
<long-description><![CDATA[]]></long-description>
23598
25197
</docblock>
23599
25198
</property>
23600
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1076" package="lists">
25199
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1101" package="lists">
23601
25200
<name>__construct</name>
23602
25201
<full_name>__construct</full_name>
23603
<docblock line="1068">
25202
<docblock line="1093">
23604
25203
<description><![CDATA[Constructor]]></description>
23605
25204
<long-description><![CDATA[]]></long-description>
23606
<tag line="1068" name="param" description="tool name" type="String" variable="$name">
23607
<type by_reference="false">String</type>
23608
</tag>
23609
<tag line="1068" name="param" description="image file" type="String" variable="$image">
23610
<type by_reference="false">String</type>
23611
</tag>
23612
<tag line="1068" name="param" description="target page" type="String" variable="$target">
23613
<type by_reference="false">String</type>
23614
</tag>
23615
<tag line="1068" name="return" description="tool object" type="\lamListTool">
25205
<tag line="1093" name="param" description="tool name" type="String" variable="$name">
25206
<type by_reference="false">String</type>
25207
</tag>
25208
<tag line="1093" name="param" description="image file" type="String" variable="$image">
25209
<type by_reference="false">String</type>
25210
</tag>
25211
<tag line="1093" name="param" description="target page" type="String" variable="$target">
25212
<type by_reference="false">String</type>
25213
</tag>
25214
<tag line="1093" name="return" description="tool object" type="\lamListTool">
23616
25215
<type by_reference="false">\lamListTool</type>
23617
25216
</tag>
23618
25217
</docblock>
23619
<argument line="1076">
25218
<argument line="1101">
23620
25219
<name>$name</name>
23621
25220
<default><![CDATA[]]></default>
23622
25221
<type/>
23623
25222
</argument>
23624
<argument line="1076">
25223
<argument line="1101">
23625
25224
<name>$image</name>
23626
25225
<default><![CDATA[]]></default>
23627
25226
<type/>
23628
25227
</argument>
23629
<argument line="1076">
25228
<argument line="1101">
23630
25229
<name>$target</name>
23631
25230
<default><![CDATA[]]></default>
23632
25231
<type/>
23633
25232
</argument>
23634
25233
</method>
23635
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1088" package="lists">
25234
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1113" package="lists">
23636
25235
<name>getImage</name>
23637
25236
<full_name>getImage</full_name>
23638
<docblock line="1082">
25237
<docblock line="1107">
23639
25238
<description><![CDATA[Returns the name of the tool image.]]></description>
23640
25239
<long-description><![CDATA[<p>The image is returned without path (e.g. mytool.png). All images must reside in the graphics folder.</p>]]></long-description>
23641
<tag line="1082" name="return" description="image name" type="String">
25240
<tag line="1107" name="return" description="image name" type="String">
23642
25241
<type by_reference="false">String</type>
23643
25242
</tag>
23644
25243
</docblock>
23645
25244
</method>
23646
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1098" package="lists">
25245
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1123" package="lists">
23647
25246
<name>getName</name>
23648
25247
<full_name>getName</full_name>
23649
<docblock line="1092">
25248
<docblock line="1117">
23650
25249
<description><![CDATA[Returns the tool name.]]></description>
23651
25250
<long-description><![CDATA[<p>This is used for the tool tip.</p>]]></long-description>
23652
<tag line="1092" name="return" description="name" type="String">
25251
<tag line="1117" name="return" description="name" type="String">
23653
25252
<type by_reference="false">String</type>
23654
25253
</tag>
23655
25254
</docblock>
23656
25255
</method>
23657
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1108" package="lists">
25256
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1133" package="lists">
23658
25257
<name>getLinkTarget</name>
23659
25258
<full_name>getLinkTarget</full_name>
23660
<docblock line="1102">
25259
<docblock line="1127">
23661
25260
<description><![CDATA[Returns the PHP file (relative to 'templates/lists') which will be the target for this tool.]]></description>
23662
25261
<long-description><![CDATA[<p>The target page will be opened with two GET parameters: DN and type (e.g. user)</p>]]></long-description>
23663
<tag line="1102" name="return" description="page file (e.g. 'mytool.php')" type="String">
25262
<tag line="1127" name="return" description="page file (e.g. 'mytool.php')" type="String">
23664
25263
<type by_reference="false">String</type>
23665
25264
</tag>
23666
25265
</docblock>
23667
25266
</method>
23668
25267
</class>
23669
<class final="false" abstract="false" namespace="global" line="1120" package="lists">
25268
<class final="false" abstract="false" namespace="global" line="1145" package="lists">
23670
25269
<extends/>
23671
25270
<name>lamListOption</name>
23672
25271
<full_name>\lamListOption</full_name>
23673
<docblock line="1114">
25272
<docblock line="1139">
23674
25273
<description><![CDATA[Represents a list configuration option.]]></description>
23675
25274
<long-description><![CDATA[]]></long-description>
23676
<tag line="1114" name="package" description="lists"/>
23677
<tag line="1114" name="author" description="Roland Gruber"/>
25275
<tag line="1139" name="package" description="lists"/>
25276
<tag line="1139" name="author" description="Roland Gruber"/>
23678
25277
</docblock>
23679
<property final="false" static="false" visibility="private" line="1123" namespace="global" package="main">
25278
<property final="false" static="false" visibility="private" line="1148" namespace="global" package="main">
23680
25279
<name>$ID</name>
23681
25280
<default><![CDATA[]]></default>
23682
<docblock line="1122">
25281
<docblock line="1147">
23683
25282
<description><![CDATA[unique ID]]></description>
23684
25283
<long-description><![CDATA[]]></long-description>
23685
25284
</docblock>
23686
25285
</property>
23687
<property final="false" static="false" visibility="private" line="1125" namespace="global" package="main">
25286
<property final="false" static="false" visibility="private" line="1150" namespace="global" package="main">
23688
25287
<name>$value</name>
23689
25288
<default><![CDATA[]]></default>
23690
<docblock line="1124">
25289
<docblock line="1149">
23691
25290
<description><![CDATA[option value]]></description>
23692
25291
<long-description><![CDATA[]]></long-description>
23693
25292
</docblock>
23694
25293
</property>
23695
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1133" package="lists">
25294
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1158" package="lists">
23696
25295
<name>__construct</name>
23697
25296
<full_name>__construct</full_name>
23698
<docblock line="1127">
25297
<docblock line="1152">
23699
25298
<description><![CDATA[Creates a new config option.]]></description>
23700
25299
<long-description><![CDATA[]]></long-description>
23701
<tag line="1127" name="param" description="unique ID" type="String" variable="$ID">
25300
<tag line="1152" name="param" description="unique ID" type="String" variable="$ID">
23702
25301
<type by_reference="false">String</type>
23703
25302
</tag>
23704
<tag line="1127" name="return" description="config option" type="\lamConfigOption">
25303
<tag line="1152" name="return" description="config option" type="\lamConfigOption">
23705
25304
<type by_reference="false">\lamConfigOption</type>
23706
25305
</tag>
23707
25306
</docblock>
23708
<argument line="1133">
25307
<argument line="1158">
23709
25308
<name>$ID</name>
23710
25309
<default><![CDATA[]]></default>
23711
25310
<type/>
23712
25311
</argument>
23713
25312
</method>
23714
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1142" package="lists">
25313
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1167" package="lists">
23715
25314
<name>getID</name>
23716
25315
<full_name>getID</full_name>
23717
<docblock line="1137">
25316
<docblock line="1162">
23718
25317
<description><![CDATA[Returns the option ID.]]></description>
23719
25318
<long-description><![CDATA[]]></long-description>
23720
<tag line="1137" name="return" description="ID" type="String">
25319
<tag line="1162" name="return" description="ID" type="String">
23721
25320
<type by_reference="false">String</type>
23722
25321
</tag>
23723
25322
</docblock>
23724
25323
</method>
23725
<method final="false" abstract="true" static="false" visibility="public" namespace="global" line="1151" package="lists">
25324
<method final="false" abstract="true" static="false" visibility="public" namespace="global" line="1176" package="lists">
23726
25325
<name>fillFromPostData</name>
23727
25326
<full_name>fillFromPostData</full_name>
23728
<docblock line="1146">
25327
<docblock line="1171">
23729
25328
<description><![CDATA[Fills the config option from POST data.]]></description>
23730
25329
<long-description><![CDATA[]]></long-description>
23731
<tag line="1146" name="return" description="list of StatusMessages (array(<type>, <head line>, <body>))" type="array">
25330
<tag line="1171" name="return" description="list of StatusMessages (array(<type>, <head line>, <body>))" type="array">
23732
25331
<type by_reference="false">array</type>
23733
25332
</tag>
23734
25333
</docblock>
23735
25334
</method>
23736
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1158" package="lists">
25335
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1183" package="lists">
23737
25336
<name>getValue</name>
23738
25337
<full_name>getValue</full_name>
23739
<docblock line="1153">
25338
<docblock line="1178">
23740
25339
<description><![CDATA[Returns the option value.]]></description>
23741
25340
<long-description><![CDATA[<p>The value must not contain "=" and ";".</p>]]></long-description>
23742
<tag line="1153" name="return" description="value" type="String">
25341
<tag line="1178" name="return" description="value" type="String">
23743
25342
<type by_reference="false">String</type>
23744
25343
</tag>
23745
25344
</docblock>
23746
25345
</method>
23747
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1167" package="lists">
25346
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1192" package="lists">
23748
25347
<name>setValue</name>
23749
25348
<full_name>setValue</full_name>
23750
<docblock line="1162">
25349
<docblock line="1187">
23751
25350
<description><![CDATA[Sets the config option value.]]></description>
23752
25351
<long-description><![CDATA[<p>The value must not contain "=" and ";".</p>]]></long-description>
23753
<tag line="1162" name="param" description="" type="String" variable="$value">
25352
<tag line="1187" name="param" description="" type="String" variable="$value">
23754
25353
<type by_reference="false">String</type>
23755
25354
</tag>
23756
25355
</docblock>
23757
<argument line="1167">
25356
<argument line="1192">
23758
25357
<name>$value</name>
23759
25358
<default><![CDATA[]]></default>
23760
25359
<type/>
23761
25360
</argument>
23762
25361
</method>
23763
<method final="false" abstract="true" static="false" visibility="public" namespace="global" line="1179" package="lists">
25362
<method final="false" abstract="true" static="false" visibility="public" namespace="global" line="1204" package="lists">
23764
25363
<name>getMetaHTML</name>
23765
25364
<full_name>getMetaHTML</full_name>
23766
<docblock line="1174">
25365
<docblock line="1199">
23767
25366
<description><![CDATA[Returns the meta HTML data to display this option.]]></description>
23768
25367
<long-description><![CDATA[]]></long-description>
23769
<tag line="1174" name="return" description="meta HTML" type="\htmlTable">
25368
<tag line="1199" name="return" description="meta HTML" type="\htmlTable">
23770
25369
<type by_reference="false">\htmlTable</type>
23771
25370
</tag>
23772
25371
</docblock>
23773
25372
</method>
23774
25373
</class>
23775
<class final="false" abstract="false" namespace="global" line="1189" package="lists">
25374
<class final="false" abstract="false" namespace="global" line="1214" package="lists">
23776
25375
<extends>\lamListOption</extends>
23777
25376
<name>lamBooleanListOption</name>
23778
25377
<full_name>\lamBooleanListOption</full_name>
23779
<docblock line="1183">
25378
<docblock line="1208">
23780
25379
<description><![CDATA[Boolean option for list configuration.]]></description>
23781
25380
<long-description><![CDATA[]]></long-description>
23782
<tag line="1183" name="package" description="lists"/>
23783
<tag line="1183" name="author" description="Roland Gruber"/>
25381
<tag line="1208" name="package" description="lists"/>
25382
<tag line="1208" name="author" description="Roland Gruber"/>
23784
25383
</docblock>
23785
<property final="false" static="false" visibility="private" line="1192" namespace="global" package="main">
25384
<property final="false" static="false" visibility="private" line="1217" namespace="global" package="main">
23786
25385
<name>$name</name>
23787
25386
<default><![CDATA[]]></default>
23788
<docblock line="1191">
25387
<docblock line="1216">
23789
25388
<description><![CDATA[option name]]></description>
23790
25389
<long-description><![CDATA[]]></long-description>
23791
25390
</docblock>
23792
25391
</property>
23793
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1201" package="lists">
25392
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1226" package="lists">
23794
25393
<name>__construct</name>
23795
25394
<full_name>__construct</full_name>
23796
<docblock line="1194">
25395
<docblock line="1219">
23797
25396
<description><![CDATA[Creates a new boolean option.]]></description>
23798
25397
<long-description><![CDATA[]]></long-description>
23799
<tag line="1194" name="param" description="name to show on config page" type="String" variable="$name">
23800
<type by_reference="false">String</type>
23801
</tag>
23802
<tag line="1194" name="param" description="unique ID" type="String" variable="$ID">
23803
<type by_reference="false">String</type>
23804
</tag>
23805
<tag line="1194" name="return" description="config option" type="\lamBooleanListOption">
25398
<tag line="1219" name="param" description="name to show on config page" type="String" variable="$name">
25399
<type by_reference="false">String</type>
25400
</tag>
25401
<tag line="1219" name="param" description="unique ID" type="String" variable="$ID">
25402
<type by_reference="false">String</type>
25403
</tag>
25404
<tag line="1219" name="return" description="config option" type="\lamBooleanListOption">
23806
25405
<type by_reference="false">\lamBooleanListOption</type>
23807
25406
</tag>
23808
25407
</docblock>
23809
<argument line="1201">
25408
<argument line="1226">
23810
25409
<name>$name</name>
23811
25410
<default><![CDATA[]]></default>
23812
25411
<type/>
23813
25412
</argument>
23814
<argument line="1201">
25413
<argument line="1226">
23815
25414
<name>$ID</name>
23816
25415
<default><![CDATA[]]></default>
23817
25416
<type/>
23818
25417
</argument>
23819
25418
</method>
23820
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1211" package="lists">
25419
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1236" package="lists">
23821
25420
<name>isSelected</name>
23822
25421
<full_name>isSelected</full_name>
23823
<docblock line="1206">
25422
<docblock line="1231">
23824
25423
<description><![CDATA[Returns if this option is selected.]]></description>
23825
25424
<long-description><![CDATA[]]></long-description>
23826
<tag line="1206" name="return" description="true, if selected" type="boolean">
25425
<tag line="1231" name="return" description="true, if selected" type="boolean">
23827
25426
<type by_reference="false">boolean</type>
23828
25427
</tag>
23829
25428
</docblock>
23830
25429
</method>
23831
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1220" package="lists">
25430
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1245" package="lists">
23832
25431
<name>fillFromPostData</name>
23833
25432
<full_name>fillFromPostData</full_name>
23834
<docblock line="1215">
25433
<docblock line="1240">
23835
25434
<description><![CDATA[Fills the config option from POST data.]]></description>
23836
25435
<long-description><![CDATA[]]></long-description>
23837
<tag line="1215" name="return" description="list of StatusMessages (array(<type>, <head line>, <body>))" type="array">
25436
<tag line="1240" name="return" description="list of StatusMessages (array(<type>, <head line>, <body>))" type="array">
23838
25437
<type by_reference="false">array</type>
23839
25438
</tag>
23840
25439
</docblock>
23841
25440
</method>
23842
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1234" package="lists">
25441
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1259" package="lists">
23843
25442
<name>getMetaHTML</name>
23844
25443
<full_name>getMetaHTML</full_name>
23845
<docblock line="1229">
25444
<docblock line="1254">
23846
25445
<description><![CDATA[Returns the meta HTML data to display this option.]]></description>
23847
25446
<long-description><![CDATA[]]></long-description>
23848
<tag line="1229" name="return" description="meta HTML" type="\htmlTable">
25447
<tag line="1254" name="return" description="meta HTML" type="\htmlTable">
23849
25448
<type by_reference="false">\htmlTable</type>
23850
25449
</tag>
23851
25450
</docblock>
23852
25451
</method>
23853
25452
</class>
23854
<class final="false" abstract="false" namespace="global" line="1248" package="lists">
25453
<class final="false" abstract="false" namespace="global" line="1273" package="lists">
23855
25454
<extends>\lamListOption</extends>
23856
25455
<name>lamSelectListOption</name>
23857
25456
<full_name>\lamSelectListOption</full_name>
23858
<docblock line="1242">
25457
<docblock line="1267">
23859
25458
<description><![CDATA[Boolean option for list configuration.]]></description>
23860
25459
<long-description><![CDATA[]]></long-description>
23861
<tag line="1242" name="package" description="lists"/>
23862
<tag line="1242" name="author" description="Roland Gruber"/>
25460
<tag line="1267" name="package" description="lists"/>
25461
<tag line="1267" name="author" description="Roland Gruber"/>
23863
25462
</docblock>
23864
<property final="false" static="false" visibility="private" line="1251" namespace="global" package="main">
25463
<property final="false" static="false" visibility="private" line="1276" namespace="global" package="main">
23865
25464
<name>$name</name>
23866
25465
<default><![CDATA[]]></default>
23867
<docblock line="1250">
25466
<docblock line="1275">
23868
25467
<description><![CDATA[option name]]></description>
23869
25468
<long-description><![CDATA[]]></long-description>
23870
25469
</docblock>
23871
25470
</property>
23872
<property final="false" static="false" visibility="private" line="1253" namespace="global" package="main">
25471
<property final="false" static="false" visibility="private" line="1278" namespace="global" package="main">
23873
25472
<name>$options</name>
23874
25473
<default><![CDATA[]]></default>
23875
<docblock line="1252">
25474
<docblock line="1277">
23876
25475
<description><![CDATA[possible select options]]></description>
23877
25476
<long-description><![CDATA[]]></long-description>
23878
25477
</docblock>
23879
25478
</property>
23880
<property final="false" static="false" visibility="private" line="1255" namespace="global" package="main">
25479
<property final="false" static="false" visibility="private" line="1280" namespace="global" package="main">
23881
25480
<name>$helpID</name>
23882
25481
<default><![CDATA[]]></default>
23883
<docblock line="1254">
25482
<docblock line="1279">
23884
25483
<description><![CDATA[help ID]]></description>
23885
25484
<long-description><![CDATA[]]></long-description>
23886
25485
</docblock>
23887
25486
</property>
23888
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1265" package="lists">
25487
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1290" package="lists">
23889
25488
<name>__construct</name>
23890
25489
<full_name>__construct</full_name>
23891
<docblock line="1257">
25490
<docblock line="1282">
23892
25491
<description><![CDATA[Creates a new selection list option.]]></description>
23893
25492
<long-description><![CDATA[]]></long-description>
23894
<tag line="1257" name="param" description="name to show on config page" type="String" variable="$name">
25493
<tag line="1282" name="param" description="name to show on config page" type="String" variable="$name">
23895
25494
<type by_reference="false">String</type>
23896
25495
</tag>
23897
<tag line="1257" name="param" description="list of possible values" type="array" variable="$options">
25496
<tag line="1282" name="param" description="list of possible values" type="array" variable="$options">
23898
25497
<type by_reference="false">array</type>
23899
25498
</tag>
23900
<tag line="1257" name="param" description="unique ID" type="String" variable="$ID">
25499
<tag line="1282" name="param" description="unique ID" type="String" variable="$ID">
23901
25500
<type by_reference="false">String</type>
23902
25501
</tag>
23903
<tag line="1257" name="return" description="config option" type="\lamBooleanListOption">
25502
<tag line="1282" name="return" description="config option" type="\lamBooleanListOption">
23904
25503
<type by_reference="false">\lamBooleanListOption</type>
23905
25504
</tag>
23906
25505
</docblock>
23907
<argument line="1265">
25506
<argument line="1290">
23908
25507
<name>$name</name>
23909
25508
<default><![CDATA[]]></default>
23910
25509
<type/>
23911
25510
</argument>
23912
<argument line="1265">
25511
<argument line="1290">
23913
25512
<name>$options</name>
23914
25513
<default><![CDATA[]]></default>
23915
25514
<type/>
23916
25515
</argument>
23917
<argument line="1265">
25516
<argument line="1290">
23918
25517
<name>$ID</name>
23919
25518
<default><![CDATA[]]></default>
23920
25519
<type/>
23921
25520
</argument>
23922
25521
</method>
23923
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1276" package="lists">
25522
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1301" package="lists">
23924
25523
<name>setHelpID</name>
23925
25524
<full_name>setHelpID</full_name>
23926
<docblock line="1271">
25525
<docblock line="1296">
23927
25526
<description><![CDATA[Sets the help ID.]]></description>
23928
25527
<long-description><![CDATA[]]></long-description>
23929
<tag line="1271" name="param" description="help ID" type="\Strign" variable="$id">
25528
<tag line="1296" name="param" description="help ID" type="\Strign" variable="$id">
23930
25529
<type by_reference="false">\Strign</type>
23931
25530
</tag>
23932
25531
</docblock>
23933
<argument line="1276">
25532
<argument line="1301">
23934
25533
<name>$id</name>
23935
25534
<default><![CDATA[]]></default>
23936
25535
<type/>
23937
25536
</argument>
23938
25537
</method>
23939
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1285" package="lists">
25538
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1310" package="lists">
23940
25539
<name>fillFromPostData</name>
23941
25540
<full_name>fillFromPostData</full_name>
23942
<docblock line="1280">
25541
<docblock line="1305">
23943
25542
<description><![CDATA[Fills the config option from POST data.]]></description>
23944
25543
<long-description><![CDATA[]]></long-description>
23945
<tag line="1280" name="return" description="list of StatusMessages (array(<type>, <head line>, <body>))" type="array">
25544
<tag line="1305" name="return" description="list of StatusMessages (array(<type>, <head line>, <body>))" type="array">
23946
25545
<type by_reference="false">array</type>
23947
25546
</tag>
23948
25547
</docblock>
23949
25548
</method>
23950
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1299" package="lists">
25549
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1324" package="lists">
23951
25550
<name>getMetaHTML</name>
23952
25551
<full_name>getMetaHTML</full_name>
23953
<docblock line="1294">
25552
<docblock line="1319">
23954
25553
<description><![CDATA[Returns the meta HTML data to display this option.]]></description>
23955
25554
<long-description><![CDATA[]]></long-description>
23956
<tag line="1294" name="return" description="meta HTML" type="\htmlTable">
25555
<tag line="1319" name="return" description="meta HTML" type="\htmlTable">
23957
25556
<type by_reference="false">\htmlTable</type>
23958
25557
</tag>
23959
25558
</docblock>
23960
25559
</method>
23961
25560
</class>
23962
25561
<parse_markers>
23963
<notice line="719" code="50013">Parameter $tabindex could not be found in listPrintButtons()</notice>
25562
<notice line="740" code="50013">Parameter $tabindex could not be found in listPrintButtons()</notice>
23964
25563
</parse_markers>
23965
25564
</file>
23966
<file path="lib/pdf.inc" hash="4f806fd6845e724f5c840e2daa84d49e" package="PDF">
25565
<file path="lib/pdf.inc" hash="95bf0fd8e8546c6c80e87dd59891eb00" package="PDF">
23967
25566
<docblock line="24">
23968
25567
<description><![CDATA[LDAP Account Manager PDF printing library.]]></description>
23969
25568
<long-description><![CDATA[<p>It consists of lamPDF class,
24052
25651
<type/>
24053
25652
</argument>
24054
25653
</function>
24055
<function namespace="global" line="168" package="PDF">
25654
<function namespace="global" line="169" package="PDF">
24056
25655
<name>getSectionHeadline</name>
24057
25656
<full_name>\getSectionHeadline</full_name>
24058
<docblock line="161">
25657
<docblock line="162">
24059
25658
<description><![CDATA[Creates a section headline.]]></description>
24060
25659
<long-description><![CDATA[]]></long-description>
24061
<tag line="161" name="param" description="section name" type="string" variable="$line">
25660
<tag line="162" name="param" description="section name" type="string" variable="$line">
24062
25661
<type by_reference="false">string</type>
24063
25662
</tag>
24064
<tag line="161" name="return" description="XML code for headline" type="string">
25663
<tag line="162" name="return" description="XML code for headline" type="string">
24065
25664
<type by_reference="false">string</type>
24066
25665
</tag>
24067
25666
</docblock>
24068
<argument line="168">
25667
<argument line="169">
24069
25668
<name>$line</name>
24070
25669
<default><![CDATA[]]></default>
24071
25670
<type/>
24072
25671
</argument>
24073
25672
</function>
24074
<function namespace="global" line="188" package="PDF">
25673
<function namespace="global" line="189" package="PDF">
24075
25674
<name>processLine</name>
24076
25675
<full_name>\processLine</full_name>
24077
<docblock line="179">
25676
<docblock line="180">
24078
25677
<description><![CDATA[Creates the XML code for an PDF entry.]]></description>
24079
25678
<long-description><![CDATA[]]></long-description>
24080
<tag line="179" name="param" description="XML code of PDF entry" type="string" variable="$line">
25679
<tag line="180" name="param" description="XML code of PDF entry" type="string" variable="$line">
24081
25680
<type by_reference="false">string</type>
24082
25681
</tag>
24083
<tag line="179" name="param" description="True if this is the first column" type="boolean" variable="$first_td">
25682
<tag line="180" name="param" description="True if this is the first column" type="boolean" variable="$first_td">
24084
25683
<type by_reference="false">boolean</type>
24085
25684
</tag>
24086
<tag line="179" name="param" description="font name" type="String" variable="$fontName">
25685
<tag line="180" name="param" description="font name" type="String" variable="$fontName">
24087
25686
<type by_reference="false">String</type>
24088
25687
</tag>
24089
<tag line="179" name="return" description="XML codes" type="array">
25688
<tag line="180" name="return" description="XML codes" type="array">
24090
25689
<type by_reference="false">array</type>
24091
25690
</tag>
24092
25691
</docblock>
24093
<argument line="188">
25692
<argument line="189">
24094
25693
<name>$line</name>
24095
25694
<default><![CDATA[]]></default>
24096
25695
<type/>
24097
25696
</argument>
24098
<argument line="188">
25697
<argument line="189">
24099
25698
<name>$first_td</name>
24100
25699
<default><![CDATA[true]]></default>
24101
25700
<type/>
24102
25701
</argument>
24103
<argument line="188">
25702
<argument line="189">
24104
25703
<name>$fontName</name>
24105
25704
<default><![CDATA[]]></default>
24106
25705
<type/>
24107
25706
</argument>
24108
25707
</function>
24109
<function namespace="global" line="264" package="PDF">
25708
<function namespace="global" line="265" package="PDF">
24110
25709
<name>processFormatTags</name>
24111
25710
<full_name>\processFormatTags</full_name>
24112
<docblock line="256">
25711
<docblock line="257">
24113
25712
<description><![CDATA[Formats the XML code.]]></description>
24114
25713
<long-description><![CDATA[]]></long-description>
24115
<tag line="256" name="param" description="XML code of PDF entry" type="string" variable="$line">
24116
<type by_reference="false">string</type>
24117
</tag>
24118
<tag line="256" name="param" description="style commands" type="string" variable="$style">
24119
<type by_reference="false">string</type>
24120
</tag>
24121
<tag line="256" name="return" description="XML code" type="array">
25714
<tag line="257" name="param" description="XML code of PDF entry" type="string" variable="$line">
25715
<type by_reference="false">string</type>
25716
</tag>
25717
<tag line="257" name="param" description="style commands" type="string" variable="$style">
25718
<type by_reference="false">string</type>
25719
</tag>
25720
<tag line="257" name="return" description="XML code" type="array">
24122
25721
<type by_reference="false">array</type>
24123
25722
</tag>
24124
25723
</docblock>
24125
<argument line="264">
25724
<argument line="265">
24126
25725
<name>$line</name>
24127
25726
<default><![CDATA[]]></default>
24128
25727
<type/>
24129
25728
</argument>
24130
<argument line="264">
25729
<argument line="265">
24131
25730
<name>$style</name>
24132
25731
<default><![CDATA[]]></default>
24133
25732
<type/>
24134
25733
</argument>
24135
25734
</function>
24136
<function namespace="global" line="297" package="PDF">
25735
<function namespace="global" line="298" package="PDF">
24137
25736
<name>processAttributes</name>
24138
25737
<full_name>\processAttributes</full_name>
24139
<docblock line="289">
25738
<docblock line="290">
24140
25739
<description><![CDATA[Processes width, height and alignment attributes.]]></description>
24141
25740
<long-description><![CDATA[]]></long-description>
24142
<tag line="289" name="param" description="attributes" type="string" variable="$attrs">
25741
<tag line="290" name="param" description="attributes" type="string" variable="$attrs">
24143
25742
<type by_reference="false">string</type>
24144
25743
</tag>
24145
<tag line="289" name="param" description="XML code" type="array" variable="$return">
25744
<tag line="290" name="param" description="XML code" type="array" variable="$return">
24146
25745
<type by_reference="false">array</type>
24147
25746
</tag>
24148
<tag line="289" name="return" description="XML code" type="array">
25747
<tag line="290" name="return" description="XML code" type="array">
24149
25748
<type by_reference="false">array</type>
24150
25749
</tag>
24151
25750
</docblock>
24152
<argument line="297">
25751
<argument line="298">
24153
25752
<name>$attrs</name>
24154
25753
<default><![CDATA[]]></default>
24155
25754
<type/>
24156
25755
</argument>
24157
<argument line="297">
25756
<argument line="298">
24158
25757
<name>$return</name>
24159
25758
<default><![CDATA[array()]]></default>
24160
25759
<type/>
35248
36847
<error line="1324" code="50015">Argument $text is missing from the Docblock of _unpad()</error>
35249
36848
</parse_markers>
35250
36849
</file>
35251
<file path="lib/modules.inc" hash="f073e183279a66a1b016f3edf427681b" package="modules">
36850
<file path="lib/modules.inc" hash="985df084a1d469c7e693b4f1f8b041ac" package="modules">
35252
36851
<docblock line="25">
35253
36852
<description><![CDATA[Interface between modules and other parts of LAM.]]></description>
35254
36853
<long-description><![CDATA[]]></long-description>
35305
36904
<include line="368" type="Include" package="main">
35306
36905
<name/>
35307
36906
</include>
35308
<include line="1226" type="Include" package="main">
36907
<include line="1255" type="Include" package="main">
35309
36908
<name>../main_header.php</name>
35310
36909
</include>
35311
<include line="1240" type="Include" package="main">
36910
<include line="1269" type="Include" package="main">
35312
36911
<name>../main_footer.php</name>
35313
36912
</include>
35314
36913
<function namespace="global" line="65" package="modules">
35640
37239
<type/>
35641
37240
</argument>
35642
37241
</function>
35643
<function namespace="global" line="382" package="modules">
37242
<function namespace="global" line="385" package="modules">
35644
37243
<name>getAvailablePDFFields</name>
35645
37244
<full_name>\getAvailablePDFFields</full_name>
35646
<docblock line="376">
37245
<docblock line="379">
35647
37246
<description><![CDATA[Returns a list of available PDF entries.]]></description>
35648
37247
<long-description><![CDATA[]]></long-description>
35649
<tag line="376" name="param" description="account type (user, group, host)" type="string" variable="$scope">
37248
<tag line="379" name="param" description="account type (user, group, host)" type="string" variable="$scope">
35650
37249
<type by_reference="false">string</type>
35651
37250
</tag>
35652
<tag line="376" name="return" description="PDF entries (field ID => field label)" type="array">
37251
<tag line="379" name="return" description="PDF entries (field ID => field label)" type="array">
35653
37252
<type by_reference="false">array</type>
35654
37253
</tag>
35655
37254
</docblock>
35656
<argument line="382">
37255
<argument line="385">
35657
37256
<name>$scope</name>
35658
37257
<default><![CDATA[]]></default>
35659
37258
<type/>
35660
37259
</argument>
35661
37260
</function>
35662
<function namespace="global" line="421" package="modules">
37261
<function namespace="global" line="424" package="modules">
35663
37262
<name>getUploadColumns</name>
35664
37263
<full_name>\getUploadColumns</full_name>
35665
<docblock line="405">
37264
<docblock line="408">
35666
37265
<description><![CDATA[Returns an array containing all input columns for the file upload.]]></description>
35667
37266
<long-description><![CDATA[<p>Syntax:
35668
37267
<br> array(
35672
37271
<br> string: example, // example value
35673
37272
<br> boolean: required // true, if user must set a value for this column
35674
37273
<br> )</p>]]></long-description>
35675
<tag line="405" name="param" description="account type" type="string" variable="$scope">
37274
<tag line="408" name="param" description="account type" type="string" variable="$scope">
35676
37275
<type by_reference="false">string</type>
35677
37276
</tag>
35678
<tag line="405" name="param" description="selected account modules" type="array" variable="$selectedModules">
37277
<tag line="408" name="param" description="selected account modules" type="array" variable="$selectedModules">
35679
37278
<type by_reference="false">array</type>
35680
37279
</tag>
35681
<tag line="405" name="return" description="column list" type="array">
37280
<tag line="408" name="return" description="column list" type="array">
35682
37281
<type by_reference="false">array</type>
35683
37282
</tag>
35684
37283
</docblock>
35685
<argument line="421">
37284
<argument line="424">
35686
37285
<name>$scope</name>
35687
37286
<default><![CDATA[]]></default>
35688
37287
<type/>
35689
37288
</argument>
35690
<argument line="421">
37289
<argument line="424">
35691
37290
<name>$selectedModules</name>
35692
37291
<default><![CDATA[]]></default>
35693
37292
<type/>
35694
37293
</argument>
35695
37294
</function>
35696
<function namespace="global" line="441" package="modules">
37295
<function namespace="global" line="444" package="modules">
35697
37296
<name>buildUploadAccounts</name>
35698
37297
<full_name>\buildUploadAccounts</full_name>
35699
<docblock line="430">
37298
<docblock line="433">
35700
37299
<description><![CDATA[This function builds the LDAP accounts for the file upload.]]></description>
35701
37300
<long-description><![CDATA[<p>If there are problems status messages will be printed automatically.</p>]]></long-description>
35702
<tag line="430" name="param" description="account type" type="string" variable="$scope">
37301
<tag line="433" name="param" description="account type" type="string" variable="$scope">
35703
37302
<type by_reference="false">string</type>
35704
37303
</tag>
35705
<tag line="430" name="param" description="array containing one account in each element" type="array" variable="$data">
35706
<type by_reference="false">array</type>
35707
</tag>
35708
<tag line="430" name="param" description="array(<column_name> => <column number>)" type="array" variable="$ids">
35709
<type by_reference="false">array</type>
35710
</tag>
35711
<tag line="430" name="param" description="selected account modules" type="array" variable="$selectedModules">
35712
<type by_reference="false">array</type>
35713
</tag>
35714
<tag line="430" name="return" description="array including accounts or false if there were errors" type="mixed">
37304
<tag line="433" name="param" description="array containing one account in each element" type="array" variable="$data">
37305
<type by_reference="false">array</type>
37306
</tag>
37307
<tag line="433" name="param" description="array(<column_name> => <column number>)" type="array" variable="$ids">
37308
<type by_reference="false">array</type>
37309
</tag>
37310
<tag line="433" name="param" description="selected account modules" type="array" variable="$selectedModules">
37311
<type by_reference="false">array</type>
37312
</tag>
37313
<tag line="433" name="return" description="array including accounts or false if there were errors" type="mixed">
35715
37314
<type by_reference="false">mixed</type>
35716
37315
</tag>
35717
37316
</docblock>
35718
<argument line="441">
37317
<argument line="444">
35719
37318
<name>$scope</name>
35720
37319
<default><![CDATA[]]></default>
35721
37320
<type/>
35722
37321
</argument>
35723
<argument line="441">
37322
<argument line="444">
35724
37323
<name>$data</name>
35725
37324
<default><![CDATA[]]></default>
35726
37325
<type/>
35727
37326
</argument>
35728
<argument line="441">
37327
<argument line="444">
35729
37328
<name>$ids</name>
35730
37329
<default><![CDATA[]]></default>
35731
37330
<type/>
35732
37331
</argument>
35733
<argument line="441">
37332
<argument line="444">
35734
37333
<name>$selectedModules</name>
35735
37334
<default><![CDATA[]]></default>
35736
37335
<type/>
35737
37336
</argument>
35738
37337
</function>
35739
<function namespace="global" line="514" package="modules">
37338
<function namespace="global" line="517" package="modules">
35740
37339
<name>doUploadPreActions</name>
35741
37340
<full_name>\doUploadPreActions</full_name>
35742
<docblock line="506">
37341
<docblock line="509">
35743
37342
<description><![CDATA[Runs any actions that need to be done before an LDAP entry is created.]]></description>
35744
37343
<long-description><![CDATA[]]></long-description>
35745
<tag line="506" name="param" description="account type" type="String" variable="$scope">
37344
<tag line="509" name="param" description="account type" type="String" variable="$scope">
35746
37345
<type by_reference="false">String</type>
35747
37346
</tag>
35748
<tag line="506" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
35749
<type by_reference="false">array</type>
35750
</tag>
35751
<tag line="506" name="param" description="LDAP attributes of this entry (attributes are provided as reference, handle modifications of $attributes with care)" type="array" variable="$attributes">
35752
<type by_reference="false">array</type>
35753
</tag>
35754
<tag line="506" name="return" description="array which contains status messages. Each entry is an array containing the status message parameters." type="array">
37347
<tag line="509" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
37348
<type by_reference="false">array</type>
37349
</tag>
37350
<tag line="509" name="param" description="LDAP attributes of this entry (attributes are provided as reference, handle modifications of $attributes with care)" type="array" variable="$attributes">
37351
<type by_reference="false">array</type>
37352
</tag>
37353
<tag line="509" name="return" description="array which contains status messages. Each entry is an array containing the status message parameters." type="array">
35755
37354
<type by_reference="false">array</type>
35756
37355
</tag>
35757
37356
</docblock>
35758
<argument line="514">
37357
<argument line="517">
35759
37358
<name>$scope</name>
35760
37359
<default><![CDATA[]]></default>
35761
37360
<type/>
35762
37361
</argument>
35763
<argument line="514">
37362
<argument line="517">
35764
37363
<name>$selectedModules</name>
35765
37364
<default><![CDATA[]]></default>
35766
37365
<type/>
35767
37366
</argument>
35768
<argument line="514">
37367
<argument line="517">
35769
37368
<name>$attributes</name>
35770
37369
<default><![CDATA[]]></default>
35771
37370
<type/>
35772
37371
</argument>
35773
37372
</function>
35774
<function namespace="global" line="541" package="modules">
37373
<function namespace="global" line="544" package="modules">
35775
37374
<name>doUploadPostActions</name>
35776
37375
<full_name>\doUploadPostActions</full_name>
35777
<docblock line="524">
37376
<docblock line="527">
35778
37377
<description><![CDATA[This function executes one post upload action.]]></description>
35779
37378
<long-description><![CDATA[]]></long-description>
35780
<tag line="524" name="param" description="account type" type="string" variable="$scope">
37379
<tag line="527" name="param" description="account type" type="string" variable="$scope">
35781
37380
<type by_reference="false">string</type>
35782
37381
</tag>
35783
<tag line="524" name="param" description="array containing one account in each element" type="array" variable="$data">
35784
<type by_reference="false">array</type>
35785
</tag>
35786
<tag line="524" name="param" description="array(<column_name> => <column number>)" type="array" variable="$ids">
35787
<type by_reference="false">array</type>
35788
</tag>
35789
<tag line="524" name="param" description="list of accounts which were not created successfully" type="array" variable="$failed">
35790
<type by_reference="false">array</type>
35791
</tag>
35792
<tag line="524" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
35793
<type by_reference="false">array</type>
35794
</tag>
35795
<tag line="524" name="param" description="list of LDAP entries" type="array" variable="$accounts">
35796
<type by_reference="false">array</type>
35797
</tag>
35798
<tag line="524" name="return" description="current status <br> array ( <br> 'status' => 'finished' | 'inProgress' <br> 'module' => <name of active module> <br> 'progress' => 0..100 <br> 'errors' => array (<array of parameters for StatusMessage>) <br> )" type="array">
37382
<tag line="527" name="param" description="array containing one account in each element" type="array" variable="$data">
37383
<type by_reference="false">array</type>
37384
</tag>
37385
<tag line="527" name="param" description="array(<column_name> => <column number>)" type="array" variable="$ids">
37386
<type by_reference="false">array</type>
37387
</tag>
37388
<tag line="527" name="param" description="list of accounts which were not created successfully" type="array" variable="$failed">
37389
<type by_reference="false">array</type>
37390
</tag>
37391
<tag line="527" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
37392
<type by_reference="false">array</type>
37393
</tag>
37394
<tag line="527" name="param" description="list of LDAP entries" type="array" variable="$accounts">
37395
<type by_reference="false">array</type>
37396
</tag>
37397
<tag line="527" name="return" description="current status <br> array ( <br> 'status' => 'finished' | 'inProgress' <br> 'module' => <name of active module> <br> 'progress' => 0..100 <br> 'errors' => array (<array of parameters for StatusMessage>) <br> )" type="array">
35799
37398
<type by_reference="false">array</type>
35800
37399
</tag>
35801
37400
</docblock>
35802
<argument line="541">
37401
<argument line="544">
35803
37402
<name>$scope</name>
35804
37403
<default><![CDATA[]]></default>
35805
37404
<type/>
35806
37405
</argument>
35807
<argument line="541">
37406
<argument line="544">
35808
37407
<name>$data</name>
35809
37408
<default><![CDATA[]]></default>
35810
37409
<type/>
35811
37410
</argument>
35812
<argument line="541">
37411
<argument line="544">
35813
37412
<name>$ids</name>
35814
37413
<default><![CDATA[]]></default>
35815
37414
<type/>
35816
37415
</argument>
35817
<argument line="541">
37416
<argument line="544">
35818
37417
<name>$failed</name>
35819
37418
<default><![CDATA[]]></default>
35820
37419
<type/>
35821
37420
</argument>
35822
<argument line="541">
37421
<argument line="544">
35823
37422
<name>$selectedModules</name>
35824
37423
<default><![CDATA[]]></default>
35825
37424
<type/>
35826
37425
</argument>
35827
<argument line="541">
37426
<argument line="544">
35828
37427
<name>$accounts</name>
35829
37428
<default><![CDATA[]]></default>
35830
37429
<type/>
35831
37430
</argument>
35832
37431
</function>
35833
<function namespace="global" line="577" package="modules">
37432
<function namespace="global" line="580" package="modules">
35834
37433
<name>getRequiredExtensions</name>
35835
37434
<full_name>\getRequiredExtensions</full_name>
35836
<docblock line="572">
37435
<docblock line="575">
35837
37436
<description><![CDATA[Returns true if the module is a base module]]></description>
35838
37437
<long-description><![CDATA[]]></long-description>
35839
<tag line="572" name="return" description="required extensions" type="array">
37438
<tag line="575" name="return" description="required extensions" type="array">
35840
37439
<type by_reference="false">array</type>
35841
37440
</tag>
35842
37441
</docblock>
35843
37442
</function>
35844
<function namespace="global" line="607" package="modules">
37443
<function namespace="global" line="610" package="modules">
35845
37444
<name>parseHtml</name>
35846
37445
<full_name>\parseHtml</full_name>
35847
<docblock line="593">
37446
<docblock line="596">
35848
37447
<description><![CDATA[Takes a list of meta-HTML elements and prints the equivalent HTML output.]]></description>
35849
37448
<long-description><![CDATA[<p>The modules are not allowed to display HTML code directly but return
35850
37449
meta HTML code. This allows to have a common design for all module pages.</p>]]></long-description>
35851
<tag line="593" name="param" description="Name of account module" type="string" variable="$module">
37450
<tag line="596" name="param" description="Name of account module" type="string" variable="$module">
35852
37451
<type by_reference="false">string</type>
35853
37452
</tag>
35854
<tag line="593" name="param" description="htmlElement or array of htmlElement elements" type="mixed" variable="$input">
37453
<tag line="596" name="param" description="htmlElement or array of htmlElement elements" type="mixed" variable="$input">
35855
37454
<type by_reference="false">mixed</type>
35856
37455
</tag>
35857
<tag line="593" name="param" description="List of values which override the defaults in $input (name => value)" type="array" variable="$values">
37456
<tag line="596" name="param" description="List of values which override the defaults in $input (name => value)" type="array" variable="$values">
35858
37457
<type by_reference="false">array</type>
35859
37458
</tag>
35860
<tag line="593" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
37459
<tag line="596" name="param" description="If true then no buttons will be displayed" type="boolean" variable="$restricted">
35861
37460
<type by_reference="false">boolean</type>
35862
37461
</tag>
35863
<tag line="593" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
37462
<tag line="596" name="param" description="Start value of tabulator index for input fields" type="integer" variable="$tabindex">
35864
37463
<type by_reference="false">integer</type>
35865
37464
</tag>
35866
<tag line="593" name="param" description="Account type" type="string" variable="$scope">
37465
<tag line="596" name="param" description="Account type" type="string" variable="$scope">
35867
37466
<type by_reference="false">string</type>
35868
37467
</tag>
35869
<tag line="593" name="return" description="List of input field names and their type (name => type)" type="array">
37468
<tag line="596" name="return" description="List of input field names and their type (name => type)" type="array">
35870
37469
<type by_reference="false">array</type>
35871
37470
</tag>
35872
37471
</docblock>
35873
<argument line="607">
37472
<argument line="610">
35874
37473
<name>$module</name>
35875
37474
<default><![CDATA[]]></default>
35876
37475
<type/>
35877
37476
</argument>
35878
<argument line="607">
37477
<argument line="610">
35879
37478
<name>$input</name>
35880
37479
<default><![CDATA[]]></default>
35881
37480
<type/>
35882
37481
</argument>
35883
<argument line="607">
37482
<argument line="610">
35884
37483
<name>$values</name>
35885
37484
<default><![CDATA[]]></default>
35886
37485
<type/>
35887
37486
</argument>
35888
<argument line="607">
37487
<argument line="610">
35889
37488
<name>$restricted</name>
35890
37489
<default><![CDATA[]]></default>
35891
37490
<type/>
35892
37491
</argument>
35893
<argument line="607">
37492
<argument line="610">
35894
37493
<name>$tabindex</name>
35895
37494
<default><![CDATA[]]></default>
35896
37495
<type/>
35897
37496
</argument>
35898
<argument line="607">
37497
<argument line="610">
35899
37498
<name>$scope</name>
35900
37499
<default><![CDATA[]]></default>
35901
37500
<type/>
35902
37501
</argument>
35903
37502
</function>
35904
<function namespace="global" line="629" package="modules">
37503
<function namespace="global" line="632" package="modules">
35905
37504
<name>lamCompareDescriptiveOptions</name>
35906
37505
<full_name>\lamCompareDescriptiveOptions</full_name>
35907
<docblock line="621">
37506
<docblock line="624">
35908
37507
<description><![CDATA[Helper function to sort descriptive options in parseHTML().]]></description>
35909
37508
<long-description><![CDATA[<p>It compares the second entries of two arrays.</p>]]></long-description>
35910
<tag line="621" name="param" description="first array" type="array" variable="$a">
35911
<type by_reference="false">array</type>
35912
</tag>
35913
<tag line="621" name="param" description="second array" type="array" variable="$b">
35914
<type by_reference="false">array</type>
35915
</tag>
35916
<tag line="621" name="return" description="compare result" type="integer">
37509
<tag line="624" name="param" description="first array" type="array" variable="$a">
37510
<type by_reference="false">array</type>
37511
</tag>
37512
<tag line="624" name="param" description="second array" type="array" variable="$b">
37513
<type by_reference="false">array</type>
37514
</tag>
37515
<tag line="624" name="return" description="compare result" type="integer">
35917
37516
<type by_reference="false">integer</type>
35918
37517
</tag>
35919
37518
</docblock>
35920
<argument line="629">
37519
<argument line="632">
35921
37520
<name>$a</name>
35922
37521
<default><![CDATA[]]></default>
35923
37522
<type/>
35924
37523
</argument>
35925
<argument line="629">
37524
<argument line="632">
35926
37525
<name>$b</name>
35927
37526
<default><![CDATA[]]></default>
35928
37527
<type/>
35929
37528
</argument>
35930
37529
</function>
35931
<function namespace="global" line="645" package="modules">
37530
<function namespace="global" line="648" package="modules">
35932
37531
<name>printHelpLink</name>
35933
37532
<full_name>\printHelpLink</full_name>
35934
<docblock line="637">
37533
<docblock line="640">
35935
37534
<description><![CDATA[Prints a LAM help link.]]></description>
35936
37535
<long-description><![CDATA[]]></long-description>
35937
<tag line="637" name="param" description="help entry" type="array" variable="$entry">
37536
<tag line="640" name="param" description="help entry" type="array" variable="$entry">
35938
37537
<type by_reference="false">array</type>
35939
37538
</tag>
35940
<tag line="637" name="param" description="help number" type="String" variable="$number">
35941
<type by_reference="false">String</type>
35942
</tag>
35943
<tag line="637" name="param" description="module name" type="String" variable="$module">
35944
<type by_reference="false">String</type>
35945
</tag>
35946
<tag line="637" name="param" description="account scope" type="String" variable="$scope">
37539
<tag line="640" name="param" description="help number" type="String" variable="$number">
37540
<type by_reference="false">String</type>
37541
</tag>
37542
<tag line="640" name="param" description="module name" type="String" variable="$module">
37543
<type by_reference="false">String</type>
37544
</tag>
37545
<tag line="640" name="param" description="account scope" type="String" variable="$scope">
35947
37546
<type by_reference="false">String</type>
35948
37547
</tag>
35949
37548
</docblock>
35950
<argument line="645">
37549
<argument line="648">
35951
37550
<name>$entry</name>
35952
37551
<default><![CDATA[]]></default>
35953
37552
<type/>
35954
37553
</argument>
35955
<argument line="645">
37554
<argument line="648">
35956
37555
<name>$number</name>
35957
37556
<default><![CDATA[]]></default>
35958
37557
<type/>
35959
37558
</argument>
35960
<argument line="645">
37559
<argument line="648">
35961
37560
<name>$module</name>
35962
37561
<default><![CDATA['']]></default>
35963
37562
<type/>
35964
37563
</argument>
35965
<argument line="645">
37564
<argument line="648">
35966
37565
<name>$scope</name>
35967
37566
<default><![CDATA['']]></default>
35968
37567
<type/>
35969
37568
</argument>
35970
37569
</function>
35971
<interface namespace="global" line="2011" package="modules">
37570
<interface namespace="global" line="2043" package="modules">
35972
37571
<name>passwordService</name>
35973
37572
<full_name>\passwordService</full_name>
35974
<docblock line="2005">
37573
<docblock line="2037">
35975
37574
<description><![CDATA[This interface needs to be implemented by all account modules which manage passwords.]]></description>
35976
37575
<long-description><![CDATA[<p>It allows LAM to provide central password changes.</p>]]></long-description>
35977
<tag line="2005" name="package" description="modules"/>
37576
<tag line="2037" name="package" description="modules"/>
35978
37577
</docblock>
35979
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2020" package="modules">
37578
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2052" package="modules">
35980
37579
<name>managesPasswordAttributes</name>
35981
37580
<full_name>managesPasswordAttributes</full_name>
35982
<docblock line="2013">
37581
<docblock line="2045">
35983
37582
<description><![CDATA[This method specifies if a module manages password attributes.]]></description>
35984
37583
<long-description><![CDATA[<p>The module alias will
35985
37584
then appear as option in the GUI.
35986
37585
<br>If the module only wants to get notified about password changes then return false.</p>]]></long-description>
35987
<tag line="2013" name="return" description="true if this module manages password attributes" type="boolean">
37586
<tag line="2045" name="return" description="true if this module manages password attributes" type="boolean">
35988
37587
<type by_reference="false">boolean</type>
35989
37588
</tag>
35990
37589
</docblock>
35991
37590
</method>
35992
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2027" package="modules">
37591
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2059" package="modules">
35993
37592
<name>supportsForcePasswordChange</name>
35994
37593
<full_name>supportsForcePasswordChange</full_name>
35995
<docblock line="2022">
37594
<docblock line="2054">
35996
37595
<description><![CDATA[Specifies if this module supports to force that a user must change his password on next login.]]></description>
35997
37596
<long-description><![CDATA[]]></long-description>
35998
<tag line="2022" name="return" description="force password change supported" type="boolean">
37597
<tag line="2054" name="return" description="force password change supported" type="boolean">
35999
37598
<type by_reference="false">boolean</type>
36000
37599
</tag>
36001
37600
</docblock>
36002
37601
</method>
36003
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2039" package="modules">
37602
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2071" package="modules">
36004
37603
<name>passwordChangeRequested</name>
36005
37604
<full_name>passwordChangeRequested</full_name>
36006
<docblock line="2029">
37605
<docblock line="2061">
36007
37606
<description><![CDATA[This function is called whenever the password should be changed.]]></description>
36008
37607
<long-description><![CDATA[<p>Account modules
36009
37608
must change their password attributes only if the modules list contains their module name.</p>]]></long-description>
36010
<tag line="2029" name="param" description="new password" type="String" variable="$password">
37609
<tag line="2061" name="param" description="new password" type="String" variable="$password">
36011
37610
<type by_reference="false">String</type>
36012
37611
</tag>
36013
<tag line="2029" name="param" description="list of modules for which the password should be changed" type="array" variable="$modules">
37612
<tag line="2061" name="param" description="list of modules for which the password should be changed" type="array" variable="$modules">
36014
37613
<type by_reference="false">array</type>
36015
37614
</tag>
36016
<tag line="2029" name="param" description="force the user to change his password at next login" type="boolean" variable="$forcePasswordChange">
37615
<tag line="2061" name="param" description="force the user to change his password at next login" type="boolean" variable="$forcePasswordChange">
36017
37616
<type by_reference="false">boolean</type>
36018
37617
</tag>
36019
<tag line="2029" name="return" description="list of error messages if any as parameter array for StatusMessage e.g. return arrray(array('ERROR', 'Password change failed.'))" type="array">
37618
<tag line="2061" name="return" description="list of error messages if any as parameter array for StatusMessage e.g. return arrray(array('ERROR', 'Password change failed.'))" type="array">
36020
37619
<type by_reference="false">array</type>
36021
37620
</tag>
36022
37621
</docblock>
36023
<argument line="2039">
37622
<argument line="2071">
36024
37623
<name>$password</name>
36025
37624
<default><![CDATA[]]></default>
36026
37625
<type/>
36027
37626
</argument>
36028
<argument line="2039">
37627
<argument line="2071">
36029
37628
<name>$modules</name>
36030
37629
<default><![CDATA[]]></default>
36031
37630
<type/>
36032
37631
</argument>
36033
<argument line="2039">
37632
<argument line="2071">
36034
37633
<name>$forcePasswordChange</name>
36035
37634
<default><![CDATA[]]></default>
36036
37635
<type/>
36037
37636
</argument>
36038
37637
</method>
36039
37638
</interface>
36040
<class final="false" abstract="false" namespace="global" line="669" package="modules">
37639
<class final="false" abstract="false" namespace="global" line="674" package="modules">
36041
37640
<extends/>
36042
37641
<name>accountContainer</name>
36043
37642
<full_name>\accountContainer</full_name>
36044
<docblock line="664">
37643
<docblock line="669">
36045
37644
<description><![CDATA[This class includes all modules and attributes of an account.]]></description>
36046
37645
<long-description><![CDATA[]]></long-description>
36047
<tag line="664" name="package" description="modules"/>
37646
<tag line="669" name="package" description="modules"/>
36048
37647
</docblock>
36049
<property final="false" static="false" visibility="public" line="698" namespace="global" package="main">
37648
<property final="false" static="false" visibility="public" line="703" namespace="global" package="main">
36050
37649
<name>$attributes</name>
36051
37650
<default><![CDATA[]]></default>
36052
<docblock line="694">
37651
<docblock line="699">
36053
37652
<description><![CDATA[Array of all used attributes
36054
37653
Syntax is attribute => array ( objectClass => MUST or MAY, .]]></description>
36055
37654
<long-description><![CDATA[<p>..)</p>]]></long-description>
36056
37655
</docblock>
36057
37656
</property>
36058
<property final="false" static="false" visibility="private" line="704" namespace="global" package="main">
37657
<property final="false" static="false" visibility="private" line="709" namespace="global" package="main">
36059
37658
<name>$type</name>
36060
37659
<default><![CDATA[]]></default>
36061
<docblock line="700">
37660
<docblock line="705">
36062
37661
<description><![CDATA[This variale stores the account type.]]></description>
36063
37662
<long-description><![CDATA[<p>Currently "user", "group" and "host" are supported.</p>]]></long-description>
36064
37663
</docblock>
36065
37664
</property>
36066
<property final="false" static="false" visibility="private" line="707" namespace="global" package="main">
37665
<property final="false" static="false" visibility="private" line="712" namespace="global" package="main">
36067
37666
<name>$module</name>
36068
37667
<default><![CDATA[]]></default>
36069
<docblock line="706">
37668
<docblock line="711">
36070
37669
<description><![CDATA[This is an array with all module objects]]></description>
36071
37670
<long-description><![CDATA[]]></long-description>
36072
37671
</docblock>
36073
37672
</property>
36074
<property final="false" static="false" visibility="public" line="710" namespace="global" package="main">
37673
<property final="false" static="false" visibility="public" line="715" namespace="global" package="main">
36075
37674
<name>$dnSuffix</name>
36076
37675
<default><![CDATA[]]></default>
36077
<docblock line="709">
37676
<docblock line="714">
36078
37677
<description><![CDATA[DN suffix of the account]]></description>
36079
37678
<long-description><![CDATA[]]></long-description>
36080
37679
</docblock>
36081
37680
</property>
36082
<property final="false" static="false" visibility="public" line="713" namespace="global" package="main">
37681
<property final="false" static="false" visibility="public" line="718" namespace="global" package="main">
36083
37682
<name>$dn_orig</name>
36084
37683
<default><![CDATA[]]></default>
36085
<docblock line="712">
37684
<docblock line="717">
36086
37685
<description><![CDATA[DN of account when it was loaded]]></description>
36087
37686
<long-description><![CDATA[]]></long-description>
36088
37687
</docblock>
36089
37688
</property>
36090
<property final="false" static="false" visibility="public" line="716" namespace="global" package="main">
37689
<property final="false" static="false" visibility="public" line="721" namespace="global" package="main">
36091
37690
<name>$rdn</name>
36092
37691
<default><![CDATA[]]></default>
36093
<docblock line="715">
37692
<docblock line="720">
36094
37693
<description><![CDATA[RDN attribute of this account]]></description>
36095
37694
<long-description><![CDATA[]]></long-description>
36096
37695
</docblock>
36097
37696
</property>
36098
<property final="false" static="false" visibility="public" line="719" namespace="global" package="main">
37697
<property final="false" static="false" visibility="public" line="724" namespace="global" package="main">
36099
37698
<name>$finalDN</name>
36100
37699
<default><![CDATA[]]></default>
36101
<docblock line="718">
37700
<docblock line="723">
36102
37701
<description><![CDATA[DN of saved account]]></description>
36103
37702
<long-description><![CDATA[]]></long-description>
36104
37703
</docblock>
36105
37704
</property>
36106
<property final="false" static="false" visibility="public" line="722" namespace="global" package="main">
37705
<property final="false" static="false" visibility="public" line="727" namespace="global" package="main">
36107
37706
<name>$attributes_orig</name>
36108
37707
<default><![CDATA[]]></default>
36109
<docblock line="721">
37708
<docblock line="726">
36110
37709
<description><![CDATA[original LDAP attributes when account was loaded from LDAP]]></description>
36111
37710
<long-description><![CDATA[]]></long-description>
36112
37711
</docblock>
36113
37712
</property>
36114
<property final="false" static="false" visibility="private" line="725" namespace="global" package="main">
37713
<property final="false" static="false" visibility="private" line="730" namespace="global" package="main">
36115
37714
<name>$order</name>
36116
37715
<default><![CDATA[]]></default>
36117
<docblock line="724">
37716
<docblock line="729">
36118
37717
<description><![CDATA[Module order]]></description>
36119
37718
<long-description><![CDATA[]]></long-description>
36120
37719
</docblock>
36121
37720
</property>
36122
<property final="false" static="false" visibility="private" line="728" namespace="global" package="main">
37721
<property final="false" static="false" visibility="private" line="733" namespace="global" package="main">
36123
37722
<name>$base</name>
36124
37723
<default><![CDATA[]]></default>
36125
<docblock line="727">
37724
<docblock line="732">
36126
37725
<description><![CDATA[Name of accountContainer variable in session]]></description>
36127
37726
<long-description><![CDATA[]]></long-description>
36128
37727
</docblock>
36129
37728
</property>
36130
<property final="false" static="false" visibility="private" line="731" namespace="global" package="main">
37729
<property final="false" static="false" visibility="private" line="736" namespace="global" package="main">
36131
37730
<name>$current_page</name>
36132
37731
<default><![CDATA[0]]></default>
36133
<docblock line="730">
37732
<docblock line="735">
36134
37733
<description><![CDATA[This variable stores the page number of the currently displayed page]]></description>
36135
37734
<long-description><![CDATA[]]></long-description>
36136
37735
</docblock>
36137
37736
</property>
36138
<property final="false" static="false" visibility="private" line="734" namespace="global" package="main">
37737
<property final="false" static="false" visibility="private" line="739" namespace="global" package="main">
36139
37738
<name>$subpage</name>
36140
37739
<default><![CDATA[]]></default>
36141
<docblock line="733">
37740
<docblock line="738">
36142
37741
<description><![CDATA[This variable is set to the pagename of a subpage if it should be displayed]]></description>
36143
37742
<long-description><![CDATA[]]></long-description>
36144
37743
</docblock>
36145
37744
</property>
36146
<property final="false" static="false" visibility="public" line="737" namespace="global" package="main">
37745
<property final="false" static="false" visibility="public" line="742" namespace="global" package="main">
36147
37746
<name>$isNewAccount</name>
36148
37747
<default><![CDATA[]]></default>
36149
<docblock line="736">
37748
<docblock line="741">
36150
37749
<description><![CDATA[True if this is a newly created account]]></description>
36151
37750
<long-description><![CDATA[]]></long-description>
36152
37751
</docblock>
36153
37752
</property>
36154
<property final="false" static="false" visibility="private" line="740" namespace="global" package="main">
37753
<property final="false" static="false" visibility="private" line="745" namespace="global" package="main">
36155
37754
<name>$lastLoadedProfile</name>
36156
37755
<default><![CDATA['']]></default>
36157
<docblock line="739">
37756
<docblock line="744">
36158
37757
<description><![CDATA[name of last loaded account profile]]></description>
36159
37758
<long-description><![CDATA[]]></long-description>
36160
37759
</docblock>
36161
37760
</property>
36162
<property final="false" static="false" visibility="private" line="743" namespace="global" package="main">
37761
<property final="false" static="false" visibility="private" line="748" namespace="global" package="main">
36163
37762
<name>$cachedOUs</name>
36164
37763
<default><![CDATA[null]]></default>
36165
<docblock line="742">
37764
<docblock line="747">
36166
37765
<description><![CDATA[cache for existing OUs]]></description>
36167
37766
<long-description><![CDATA[]]></long-description>
36168
37767
</docblock>
36169
37768
</property>
36170
<property final="false" static="false" visibility="private" line="746" namespace="global" package="main">
37769
<property final="false" static="false" visibility="private" line="751" namespace="global" package="main">
36171
37770
<name>$titleBarTitle</name>
36172
37771
<default><![CDATA[null]]></default>
36173
<docblock line="745">
37772
<docblock line="750">
36174
37773
<description><![CDATA[main title in title bar]]></description>
36175
37774
<long-description><![CDATA[]]></long-description>
36176
37775
</docblock>
36177
37776
</property>
36178
<property final="false" static="false" visibility="private" line="748" namespace="global" package="main">
37777
<property final="false" static="false" visibility="private" line="753" namespace="global" package="main">
36179
37778
<name>$titleBarSubtitle</name>
36180
37779
<default><![CDATA[null]]></default>
36181
<docblock line="747">
37780
<docblock line="752">
36182
37781
<description><![CDATA[subtitle in title bar]]></description>
36183
37782
<long-description><![CDATA[]]></long-description>
36184
37783
</docblock>
36185
37784
</property>
36186
<property final="false" static="false" visibility="private" line="750" namespace="global" package="main">
37785
<property final="false" static="false" visibility="private" line="755" namespace="global" package="main">
36187
37786
<name>$sendPasswordViaMail</name>
36188
37787
<default><![CDATA[null]]></default>
36189
<docblock line="749">
37788
<docblock line="754">
36190
37789
<description><![CDATA[send password via mail]]></description>
36191
37790
<long-description><![CDATA[]]></long-description>
36192
37791
</docblock>
36193
37792
</property>
36194
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="677" package="modules">
37793
<property final="false" static="false" visibility="private" line="757" namespace="global" package="main">
37794
<name>$sendPasswordViaMailAlternateAddress</name>
37795
<default><![CDATA[null]]></default>
37796
<docblock line="756">
37797
<description><![CDATA[send password via mail to this alternate address]]></description>
37798
<long-description><![CDATA[]]></long-description>
37799
</docblock>
37800
</property>
37801
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="682" package="modules">
36195
37802
<name>__construct</name>
36196
37803
<full_name>__construct</full_name>
36197
<docblock line="671">
37804
<docblock line="676">
36198
37805
<description><![CDATA[Constructor]]></description>
36199
37806
<long-description><![CDATA[]]></long-description>
36200
<tag line="671" name="param" description="account type" type="string" variable="$type">
37807
<tag line="676" name="param" description="account type" type="string" variable="$type">
36201
37808
<type by_reference="false">string</type>
36202
37809
</tag>
36203
<tag line="671" name="param" description="key in $_SESSION where this object is saved" type="string" variable="$base">
37810
<tag line="676" name="param" description="key in $_SESSION where this object is saved" type="string" variable="$base">
36204
37811
<type by_reference="false">string</type>
36205
37812
</tag>
36206
37813
</docblock>
36207
<argument line="677">
37814
<argument line="682">
36208
37815
<name>$type</name>
36209
37816
<default><![CDATA[]]></default>
36210
37817
<type/>
36211
37818
</argument>
36212
<argument line="677">
37819
<argument line="682">
36213
37820
<name>$base</name>
36214
37821
<default><![CDATA[]]></default>
36215
37822
<type/>
36216
37823
</argument>
36217
37824
</method>
36218
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="758" package="modules">
37825
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="765" package="modules">
36219
37826
<name>getAccountModule</name>
36220
37827
<full_name>getAccountModule</full_name>
36221
<docblock line="752">
37828
<docblock line="759">
36222
37829
<description><![CDATA[Returns the account module with the given class name]]></description>
36223
37830
<long-description><![CDATA[]]></long-description>
36224
<tag line="752" name="param" description="class name (e.g. posixAccount)" type="string" variable="$name">
37831
<tag line="759" name="param" description="class name (e.g. posixAccount)" type="string" variable="$name">
36225
37832
<type by_reference="false">string</type>
36226
37833
</tag>
36227
<tag line="752" name="return" description="account module" type="\baseModule">
37834
<tag line="759" name="return" description="account module" type="\baseModule">
36228
37835
<type by_reference="false">\baseModule</type>
36229
37836
</tag>
36230
37837
</docblock>
36231
<argument line="758">
37838
<argument line="765">
36232
37839
<name>$name</name>
36233
37840
<default><![CDATA[]]></default>
36234
37841
<type/>
36235
37842
</argument>
36236
37843
</method>
36237
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="772" package="modules">
37844
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="779" package="modules">
36238
37845
<name>getAccountModules</name>
36239
37846
<full_name>getAccountModules</full_name>
36240
<docblock line="767">
37847
<docblock line="774">
36241
37848
<description><![CDATA[Returns the included account modules.]]></description>
36242
37849
<long-description><![CDATA[]]></long-description>
36243
<tag line="767" name="return" description="modules" type="array">
37850
<tag line="774" name="return" description="modules" type="array">
36244
37851
<type by_reference="false">array</type>
36245
37852
</tag>
36246
37853
</docblock>
36247
37854
</method>
36248
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="781" package="modules">
37855
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="788" package="modules">
36249
37856
<name>get_type</name>
36250
37857
<full_name>get_type</full_name>
36251
<docblock line="776">
37858
<docblock line="783">
36252
37859
<description><![CDATA[Returns the accout type of this object (e.g.]]></description>
36253
37860
<long-description><![CDATA[<p>user, group, host).</p>]]></long-description>
36254
<tag line="776" name="return" description="account type" type="string">
37861
<tag line="783" name="return" description="account type" type="string">
36255
37862
<type by_reference="false">string</type>
36256
37863
</tag>
36257
37864
</docblock>
36258
37865
</method>
36259
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="789" package="modules">
37866
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="796" package="modules">
36260
37867
<name>continue_main</name>
36261
37868
<full_name>continue_main</full_name>
36262
<docblock line="785">
37869
<docblock line="792">
36263
37870
<description><![CDATA[This function is called when the user clicks on any button on the account pages.]]></description>
36264
37871
<long-description><![CDATA[<p>It prints the HTML code of each account page.</p>]]></long-description>
36265
37872
</docblock>
36266
37873
</method>
36267
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="934" package="modules">
37874
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="955" package="modules">
36268
37875
<name>printModuleContent</name>
36269
37876
<full_name>printModuleContent</full_name>
36270
<docblock line="928">
37877
<docblock line="949">
36271
37878
<description><![CDATA[Prints the content part provided by the current module.]]></description>
36272
37879
<long-description><![CDATA[]]></long-description>
36273
<tag line="928" name="param" description="list of messages" type="array" variable="$result">
37880
<tag line="949" name="param" description="list of messages" type="array" variable="$result">
36274
37881
<type by_reference="false">array</type>
36275
37882
</tag>
36276
<tag line="928" name="param" description="true if page should end after displaying the messages" type="boolean" variable="$stopProcessing">
37883
<tag line="949" name="param" description="true if page should end after displaying the messages" type="boolean" variable="$stopProcessing">
36277
37884
<type by_reference="false">boolean</type>
36278
37885
</tag>
36279
37886
</docblock>
36280
<argument line="934">
37887
<argument line="955">
36281
37888
<name>$result</name>
36282
37889
<default><![CDATA[]]></default>
36283
37890
<type/>
36284
37891
</argument>
36285
<argument line="934">
37892
<argument line="955">
36286
37893
<name>$stopProcessing</name>
36287
37894
<default><![CDATA[]]></default>
36288
37895
<type/>
36289
37896
</argument>
36290
37897
</method>
36291
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1015" package="modules">
37898
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1034" package="modules">
36292
37899
<name>printPasswordPromt</name>
36293
37900
<full_name>printPasswordPromt</full_name>
36294
<docblock line="1012">
37901
<docblock line="1031">
36295
37902
<description><![CDATA[Prints the input fields of the central password service.]]></description>
36296
37903
<long-description><![CDATA[]]></long-description>
36297
37904
</docblock>
36298
37905
</method>
36299
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1075" package="modules">
37906
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1097" package="modules">
36300
37907
<name>setNewPassword</name>
36301
37908
<full_name>setNewPassword</full_name>
36302
<docblock line="1070">
37909
<docblock line="1092">
36303
37910
<description><![CDATA[Sets the new password in all selected account modules.]]></description>
36304
37911
<long-description><![CDATA[]]></long-description>
36305
<tag line="1070" name="param" description="input parameters" type="array" variable="$input">
37912
<tag line="1092" name="param" description="input parameters" type="array" variable="$input">
36306
37913
<type by_reference="false">array</type>
36307
37914
</tag>
36308
37915
</docblock>
36309
<argument line="1075">
37916
<argument line="1097">
36310
37917
<name>$input</name>
36311
37918
<default><![CDATA[]]></default>
36312
37919
<type/>
36313
37920
</argument>
36314
37921
</method>
36315
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1150" package="modules">
37922
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1179" package="modules">
36316
37923
<name>printCommonControls</name>
36317
37924
<full_name>printCommonControls</full_name>
36318
<docblock line="1145">
37925
<docblock line="1174">
36319
37926
<description><![CDATA[Prints common controls like the save button and the ou selection.]]></description>
36320
37927
<long-description><![CDATA[]]></long-description>
36321
<tag line="1145" name="param" description="tabindex for GUI elements" type="int" variable="$tabindex">
37928
<tag line="1174" name="param" description="tabindex for GUI elements" type="int" variable="$tabindex">
36322
37929
<type by_reference="false">int</type>
36323
37930
</tag>
36324
37931
</docblock>
36325
<argument line="1150">
37932
<argument line="1179">
36326
37933
<name>$tabindex</name>
36327
37934
<default><![CDATA[]]></default>
36328
37935
<type/>
36329
37936
</argument>
36330
37937
</method>
36331
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1213" package="modules">
37938
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1242" package="modules">
36332
37939
<name>showSetPasswordButton</name>
36333
37940
<full_name>showSetPasswordButton</full_name>
36334
<docblock line="1208">
37941
<docblock line="1237">
36335
37942
<description><![CDATA[Returns if the page should show a button to set the password.]]></description>
36336
37943
<long-description><![CDATA[]]></long-description>
36337
<tag line="1208" name="return" description="show or hide button" type="boolean">
37944
<tag line="1237" name="return" description="show or hide button" type="boolean">
36338
37945
<type by_reference="false">boolean</type>
36339
37946
</tag>
36340
37947
</docblock>
36341
37948
</method>
36342
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1225" package="modules">
37949
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1254" package="modules">
36343
37950
<name>printPageHeader</name>
36344
37951
<full_name>printPageHeader</full_name>
36345
<docblock line="1222">
37952
<docblock line="1251">
36346
37953
<description><![CDATA[Prints the header of the account pages.]]></description>
36347
37954
<long-description><![CDATA[]]></long-description>
36348
37955
</docblock>
36349
37956
</method>
36350
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1238" package="modules">
37957
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1267" package="modules">
36351
37958
<name>printPageFooter</name>
36352
37959
<full_name>printPageFooter</full_name>
36353
<docblock line="1235">
37960
<docblock line="1264">
36354
37961
<description><![CDATA[Prints the footer of the account pages.]]></description>
36355
37962
<long-description><![CDATA[]]></long-description>
36356
37963
</docblock>
36357
37964
</method>
36358
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1248" package="modules">
37965
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1277" package="modules">
36359
37966
<name>printSuccessPage</name>
36360
37967
<full_name>printSuccessPage</full_name>
36361
<docblock line="1243">
37968
<docblock line="1272">
36362
37969
<description><![CDATA[Prints the HTML code to notify the user about the successful saving.]]></description>
36363
37970
<long-description><![CDATA[]]></long-description>
36364
<tag line="1243" name="param" description="array which contains status messages. Each entry is an array containing the status message parameters." type="array" variable="$messages">
37971
<tag line="1272" name="param" description="array which contains status messages. Each entry is an array containing the status message parameters." type="array" variable="$messages">
36365
37972
<type by_reference="false">array</type>
36366
37973
</tag>
36367
37974
</docblock>
36368
<argument line="1248">
37975
<argument line="1277">
36369
37976
<name>$messages</name>
36370
37977
<default><![CDATA[]]></default>
36371
37978
<type/>
36372
37979
</argument>
36373
37980
</method>
36374
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1309" package="modules">
37981
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1340" package="modules">
36375
37982
<name>loadProfileIfRequested</name>
36376
37983
<full_name>loadProfileIfRequested</full_name>
36377
<docblock line="1304">
37984
<docblock line="1335">
36378
37985
<description><![CDATA[Checks if the user requested to load a profile.]]></description>
36379
37986
<long-description><![CDATA[]]></long-description>
36380
<tag line="1304" name="return" description="true, if profile was loaded" type="boolean">
37987
<tag line="1335" name="return" description="true, if profile was loaded" type="boolean">
36381
37988
<type by_reference="false">boolean</type>
36382
37989
</tag>
36383
37990
</docblock>
36384
37991
</method>
36385
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1332" package="modules">
37992
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1363" package="modules">
36386
37993
<name>printModuleTabs</name>
36387
37994
<full_name>printModuleTabs</full_name>
36388
<docblock line="1329">
37995
<docblock line="1360">
36389
37996
<description><![CDATA[Prints the HTML code of the module tabs.]]></description>
36390
37997
<long-description><![CDATA[]]></long-description>
36391
37998
</docblock>
36392
37999
</method>
36393
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1371" package="modules">
38000
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1402" package="modules">
36394
38001
<name>save_module_attributes</name>
36395
38002
<full_name>save_module_attributes</full_name>
36396
<docblock line="1364">
38003
<docblock line="1395">
36397
38004
<description><![CDATA[This function checks which LDAP attributes have changed while the account was edited.]]></description>
36398
38005
<long-description><![CDATA[]]></long-description>
36399
<tag line="1364" name="param" description="list of current LDAP attributes" type="array" variable="$attributes">
36400
<type by_reference="false">array</type>
36401
</tag>
36402
<tag line="1364" name="param" description="list of old attributes when account was loaded" type="array" variable="$orig">
36403
<type by_reference="false">array</type>
36404
</tag>
36405
<tag line="1364" name="return" description="an array which can be passed to $this->saveAccount()" type="array">
38006
<tag line="1395" name="param" description="list of current LDAP attributes" type="array" variable="$attributes">
38007
<type by_reference="false">array</type>
38008
</tag>
38009
<tag line="1395" name="param" description="list of old attributes when account was loaded" type="array" variable="$orig">
38010
<type by_reference="false">array</type>
38011
</tag>
38012
<tag line="1395" name="return" description="an array which can be passed to $this->saveAccount()" type="array">
36406
38013
<type by_reference="false">array</type>
36407
38014
</tag>
36408
38015
</docblock>
36409
<argument line="1371">
38016
<argument line="1402">
36410
38017
<name>$attributes</name>
36411
38018
<default><![CDATA[]]></default>
36412
38019
<type/>
36413
38020
</argument>
36414
<argument line="1371">
38021
<argument line="1402">
36415
38022
<name>$orig</name>
36416
38023
<default><![CDATA[]]></default>
36417
38024
<type/>
36418
38025
</argument>
36419
38026
</method>
36420
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1452" package="modules">
38027
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1483" package="modules">
36421
38028
<name>load_account</name>
36422
38029
<full_name>load_account</full_name>
36423
<docblock line="1444">
38030
<docblock line="1475">
36424
38031
<description><![CDATA[Loads an LDAP account with the given DN.]]></description>
36425
38032
<long-description><![CDATA[]]></long-description>
36426
<tag line="1444" name="param" description="the DN of the account" type="string" variable="$dn">
38033
<tag line="1475" name="param" description="the DN of the account" type="string" variable="$dn">
36427
38034
<type by_reference="false">string</type>
36428
38035
</tag>
36429
<tag line="1444" name="param" description="list of additional informational attributes that are added to the LDAP attributes E.g. this is used to inject the clear text password in the file upload. Informational attribute names must start with "INFO."." type="array" variable="$infoAttributes">
38036
<tag line="1475" name="param" description="list of additional informational attributes that are added to the LDAP attributes E.g. this is used to inject the clear text password in the file upload. Informational attribute names must start with "INFO."." type="array" variable="$infoAttributes">
36430
38037
<type by_reference="false">array</type>
36431
38038
</tag>
36432
<tag line="1444" name="return" description="error messages" type="array">
38039
<tag line="1475" name="return" description="error messages" type="array">
36433
38040
<type by_reference="false">array</type>
36434
38041
</tag>
36435
38042
</docblock>
36436
<argument line="1452">
38043
<argument line="1483">
36437
38044
<name>$dn</name>
36438
38045
<default><![CDATA[]]></default>
36439
38046
<type/>
36440
38047
</argument>
36441
<argument line="1452">
38048
<argument line="1483">
36442
38049
<name>$infoAttributes</name>
36443
38050
<default><![CDATA[array()]]></default>
36444
38051
<type/>
36445
38052
</argument>
36446
38053
</method>
36447
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1515" package="modules">
38054
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1546" package="modules">
36448
38055
<name>fixLDAPAttributes</name>
36449
38056
<full_name>fixLDAPAttributes</full_name>
36450
<docblock line="1508">
38057
<docblock line="1539">
36451
38058
<description><![CDATA[Fixes spelling errors in the attribute names.]]></description>
36452
38059
<long-description><![CDATA[]]></long-description>
36453
<tag line="1508" name="param" description="LDAP attributes" type="array" variable="$attributes">
36454
<type by_reference="false">array</type>
36455
</tag>
36456
<tag line="1508" name="param" description="list of active modules" type="array" variable="$modules">
36457
<type by_reference="false">array</type>
36458
</tag>
36459
<tag line="1508" name="return" description="fixed attributes" type="array">
38060
<tag line="1539" name="param" description="LDAP attributes" type="array" variable="$attributes">
38061
<type by_reference="false">array</type>
38062
</tag>
38063
<tag line="1539" name="param" description="list of active modules" type="array" variable="$modules">
38064
<type by_reference="false">array</type>
38065
</tag>
38066
<tag line="1539" name="return" description="fixed attributes" type="array">
36460
38067
<type by_reference="false">array</type>
36461
38068
</tag>
36462
38069
</docblock>
36463
<argument line="1515">
38070
<argument line="1546">
36464
38071
<name>$attributes</name>
36465
38072
<default><![CDATA[]]></default>
36466
38073
<type/>
36467
38074
</argument>
36468
<argument line="1515">
38075
<argument line="1546">
36469
38076
<name>$modules</name>
36470
38077
<default><![CDATA[]]></default>
36471
38078
<type/>
36472
38079
</argument>
36473
38080
</method>
36474
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1588" package="modules">
38081
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1619" package="modules">
36475
38082
<name>new_account</name>
36476
38083
<full_name>new_account</full_name>
36477
<docblock line="1585">
38084
<docblock line="1616">
36478
38085
<description><![CDATA[This function will prepare the object for a new account.]]></description>
36479
38086
<long-description><![CDATA[]]></long-description>
36480
38087
</docblock>
36481
38088
</method>
36482
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1623" package="modules">
38089
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1654" package="modules">
36483
38090
<name>save_account</name>
36484
38091
<full_name>save_account</full_name>
36485
<docblock line="1618">
38092
<docblock line="1649">
36486
38093
<description><![CDATA[This function will save an account to the LDAP database.]]></description>
36487
38094
<long-description><![CDATA[]]></long-description>
36488
<tag line="1618" name="return" description="list of status messages" type="array">
38095
<tag line="1649" name="return" description="list of status messages" type="array">
36489
38096
<type by_reference="false">array</type>
36490
38097
</tag>
36491
38098
</docblock>
36492
38099
</method>
36493
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1849" package="modules">
38100
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1881" package="modules">
36494
38101
<name>get_pdfEntries</name>
36495
38102
<full_name>get_pdfEntries</full_name>
36496
<docblock line="1844">
38103
<docblock line="1876">
36497
38104
<description><![CDATA[Returns a list of possible PDF entries for this account.]]></description>
36498
38105
<long-description><![CDATA[]]></long-description>
36499
<tag line="1844" name="return" description="of PDF entries (array(<name> => <PDF lines>))" type="\list">
38106
<tag line="1876" name="return" description="of PDF entries (array(<name> => <PDF lines>))" type="\list">
36500
38107
<type by_reference="false">\list</type>
36501
38108
</tag>
36502
38109
</docblock>
36503
38110
</method>
36504
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1866" package="modules">
38111
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1898" package="modules">
36505
38112
<name>sortModules</name>
36506
38113
<full_name>sortModules</full_name>
36507
<docblock line="1863">
38114
<docblock line="1895">
36508
38115
<description><![CDATA[Sorts the module buttons for the account page.]]></description>
36509
38116
<long-description><![CDATA[]]></long-description>
36510
38117
</docblock>
36511
38118
</method>
36512
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1947" package="modules">
38119
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1979" package="modules">
36513
38120
<name>getRDN</name>
36514
38121
<full_name>getRDN</full_name>
36515
<docblock line="1941">
38122
<docblock line="1973">
36516
38123
<description><![CDATA[Returns the RDN part of a given DN.]]></description>
36517
38124
<long-description><![CDATA[]]></long-description>
36518
<tag line="1941" name="param" description="DN" type="String" variable="$dn">
38125
<tag line="1973" name="param" description="DN" type="String" variable="$dn">
36519
38126
<type by_reference="false">String</type>
36520
38127
</tag>
36521
<tag line="1941" name="return" description="RDN" type="String">
38128
<tag line="1973" name="return" description="RDN" type="String">
36522
38129
<type by_reference="false">String</type>
36523
38130
</tag>
36524
38131
</docblock>
36525
<argument line="1947">
38132
<argument line="1979">
36526
38133
<name>$dn</name>
36527
38134
<default><![CDATA[]]></default>
36528
38135
<type/>
36529
38136
</argument>
36530
38137
</method>
36531
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1959" package="modules">
38138
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1991" package="modules">
36532
38139
<name>getParentDN</name>
36533
38140
<full_name>getParentDN</full_name>
36534
<docblock line="1953">
38141
<docblock line="1985">
36535
38142
<description><![CDATA[Returns the parent DN of a given DN.]]></description>
36536
38143
<long-description><![CDATA[]]></long-description>
36537
<tag line="1953" name="param" description="DN" type="String" variable="$dn">
38144
<tag line="1985" name="param" description="DN" type="String" variable="$dn">
36538
38145
<type by_reference="false">String</type>
36539
38146
</tag>
36540
<tag line="1953" name="return" description="DN" type="String">
38147
<tag line="1985" name="return" description="DN" type="String">
36541
38148
<type by_reference="false">String</type>
36542
38149
</tag>
36543
38150
</docblock>
36544
<argument line="1959">
38151
<argument line="1991">
36545
38152
<name>$dn</name>
36546
38153
<default><![CDATA[]]></default>
36547
38154
<type/>
36548
38155
</argument>
36549
38156
</method>
36550
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="1970" package="modules">
38157
<method final="false" abstract="false" static="false" visibility="private" namespace="global" line="2002" package="modules">
36551
38158
<name>getOUs</name>
36552
38159
<full_name>getOUs</full_name>
36553
<docblock line="1965">
38160
<docblock line="1997">
36554
38161
<description><![CDATA[Returns a list of OUs that exist for this account type.]]></description>
36555
38162
<long-description><![CDATA[]]></long-description>
36556
<tag line="1965" name="return" description="OU list" type="array">
38163
<tag line="1997" name="return" description="OU list" type="array">
36557
38164
<type by_reference="false">array</type>
36558
38165
</tag>
36559
38166
</docblock>
36560
38167
</method>
36561
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1984" package="modules">
38168
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2016" package="modules">
36562
38169
<name>__sleep</name>
36563
38170
<full_name>__sleep</full_name>
36564
<docblock line="1979">
38171
<docblock line="2011">
36565
38172
<description><![CDATA[Encrypts sensitive data before storing in session.]]></description>
36566
38173
<long-description><![CDATA[]]></long-description>
36567
<tag line="1979" name="return" description="list of attributes which are serialized" type="array">
38174
<tag line="2011" name="return" description="list of attributes which are serialized" type="array">
36568
38175
<type by_reference="false">array</type>
36569
38176
</tag>
36570
38177
</docblock>
36571
38178
</method>
36572
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1996" package="modules">
38179
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="2028" package="modules">
36573
38180
<name>__wakeup</name>
36574
38181
<full_name>__wakeup</full_name>
36575
<docblock line="1993">
38182
<docblock line="2025">
36576
38183
<description><![CDATA[Decrypts sensitive data after accountContainer was loaded from session.]]></description>
36577
38184
<long-description><![CDATA[]]></long-description>
36578
38185
</docblock>
36910
38517
<error line="355" code="50015">Argument $b is missing from the Docblock of unsigned_shift_r()</error>
36911
38518
</parse_markers>
36912
38519
</file>
36913
<file path="lib/security.inc" hash="6001916fe6767f738eab8f51a8b26584" package="lib">
38520
<file path="lib/security.inc" hash="e7e863524766db1ff2af425d16bfbfc8" package="lib">
36914
38521
<docblock line="24">
36915
38522
<description><![CDATA[This file includes functions to perform several security checks on each page load.]]></description>
36916
38523
<long-description><![CDATA[]]></long-description>
37012
38619
</tag>
37013
38620
</docblock>
37014
38621
</function>
37015
<function namespace="global" line="252" package="lib">
38622
<function namespace="global" line="253" package="lib">
38623
<name>checkIfNewEntriesAreAllowed</name>
38624
<full_name>\checkIfNewEntriesAreAllowed</full_name>
38625
<docblock line="246">
38626
<description><![CDATA[Checks if it is allowed to create new LDAP entries of the given type.]]></description>
38627
<long-description><![CDATA[<p>This also checks if general write access is enabled.</p>]]></long-description>
38628
<tag line="246" name="param" description="account type (e.g. 'user')" type="String" variable="$scope">
38629
<type by_reference="false">String</type>
38630
</tag>
38631
<tag line="246" name="return" description="true, if new entries are allowed" type="boolean">
38632
<type by_reference="false">boolean</type>
38633
</tag>
38634
</docblock>
38635
<argument line="253">
38636
<name>$scope</name>
38637
<default><![CDATA[]]></default>
38638
<type/>
38639
</argument>
38640
</function>
38641
<function namespace="global" line="273" package="lib">
38642
<name>checkIfDeleteEntriesIsAllowed</name>
38643
<full_name>\checkIfDeleteEntriesIsAllowed</full_name>
38644
<docblock line="267">
38645
<description><![CDATA[Checks if it is allowed to delete LDAP entries of the given type.]]></description>
38646
<long-description><![CDATA[]]></long-description>
38647
<tag line="267" name="param" description="account type (e.g. 'user')" type="String" variable="$scope">
38648
<type by_reference="false">String</type>
38649
</tag>
38650
<tag line="267" name="return" description="true, if entries may be deleted" type="boolean">
38651
<type by_reference="false">boolean</type>
38652
</tag>
38653
</docblock>
38654
<argument line="273">
38655
<name>$scope</name>
38656
<default><![CDATA[]]></default>
38657
<type/>
38658
</argument>
38659
</function>
38660
<function namespace="global" line="293" package="lib">
37016
38661
<name>checkPasswordStrength</name>
37017
38662
<full_name>\checkPasswordStrength</full_name>
37018
<docblock line="246">
38663
<docblock line="287">
37019
38664
<description><![CDATA[Checks if the password fulfills the password policies.]]></description>
37020
38665
<long-description><![CDATA[]]></long-description>
37021
<tag line="246" name="param" description="password" type="string" variable="$password">
38666
<tag line="287" name="param" description="password" type="string" variable="$password">
37022
38667
<type by_reference="false">string</type>
37023
38668
</tag>
37024
<tag line="246" name="return" description="true if ok, string with error message if not valid" type="mixed">
38669
<tag line="287" name="return" description="true if ok, string with error message if not valid" type="mixed">
37025
38670
<type by_reference="false">mixed</type>
37026
38671
</tag>
37027
38672
</docblock>
37028
<argument line="252">
38673
<argument line="293">
37029
38674
<name>$password</name>
37030
38675
<default><![CDATA[]]></default>
37031
38676
<type/>
37032
38677
</argument>
37033
38678
</function>
37034
<function namespace="global" line="323" package="lib">
38679
<function namespace="global" line="364" package="lib">
37035
38680
<name>checkIfToolIsActive</name>
37036
38681
<full_name>\checkIfToolIsActive</full_name>
37037
<docblock line="317">
38682
<docblock line="358">
37038
38683
<description><![CDATA[Checks if the given tool is active.]]></description>
37039
38684
<long-description><![CDATA[<p>Otherwise, an error message is logged and the execution is stopped (die()).</p>]]></long-description>
37040
<tag line="317" name="param" description="tool class name (e.g. toolFileUpload)" type="String" variable="$tool">
38685
<tag line="358" name="param" description="tool class name (e.g. toolFileUpload)" type="String" variable="$tool">
37041
38686
<type by_reference="false">String</type>
37042
38687
</tag>
37043
38688
</docblock>
37044
<argument line="323">
38689
<argument line="364">
37045
38690
<name>$tool</name>
37046
38691
<default><![CDATA[]]></default>
37047
38692
<type/>
37048
38693
</argument>
37049
38694
</function>
37050
38695
</file>
37051
<file path="lib/baseModule.inc" hash="6f08a4fb617e8f74df48218b56e5a39c" package="modules">
38696
<file path="lib/baseModule.inc" hash="f5ba716d6e15503157d73332c2063501" package="modules">
37052
38697
<docblock line="25">
37053
38698
<description><![CDATA[This is the parent class for all account modules.]]></description>
37054
38699
<long-description><![CDATA[<p>It implements the complete module interface and uses meta-data
37738
39383
<tag line="827" name="param" description="attribute name (default: =$name)" type="String" variable="$attrName">
37739
39384
<type by_reference="false">String</type>
37740
39385
</tag>
37741
<tag line="827" name="param" description="delimiter if multiple attribute values exist" type="String" variable="$delimiter">
39386
<tag line="827" name="param" description="delimiter if multiple attribute values exist (default: ", ")" type="String" variable="$delimiter">
37742
39387
<type by_reference="false">String</type>
37743
39388
</tag>
37744
39389
</docblock>
37768
39413
<type/>
37769
39414
</argument>
37770
39415
</method>
37771
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="871" package="modules">
39416
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="878" package="modules">
37772
39417
<name>get_uploadColumns</name>
37773
39418
<full_name>get_uploadColumns</full_name>
37774
<docblock line="847">
39419
<docblock line="854">
37775
39420
<description><![CDATA[Returns an array containing all input columns for the file upload.]]></description>
37776
39421
<long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
37777
39422
<br>
37788
39433
<br> boolean: required // true, if user must set a value for this column
37789
39434
<br> boolean: unique // true if all values of this column must be different values (optional, default: "false")
37790
39435
<br> )</p>]]></long-description>
37791
<tag line="847" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
37792
<type by_reference="false">array</type>
37793
</tag>
37794
<tag line="847" name="return" description="column list" type="array">
37795
<type by_reference="false">array</type>
37796
</tag>
37797
<tag line="847" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
39436
<tag line="854" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
39437
<type by_reference="false">array</type>
39438
</tag>
39439
<tag line="854" name="return" description="column list" type="array">
39440
<type by_reference="false">array</type>
39441
</tag>
39442
<tag line="854" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
37798
39443
</docblock>
37799
<argument line="871">
39444
<argument line="878">
37800
39445
<name>$selectedModules</name>
37801
39446
<default><![CDATA[]]></default>
37802
39447
<type/>
37803
39448
</argument>
37804
39449
</method>
37805
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="887" package="modules">
39450
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="894" package="modules">
37806
39451
<name>get_uploadPreDepends</name>
37807
39452
<full_name>get_uploadPreDepends</full_name>
37808
<docblock line="876">
39453
<docblock line="883">
37809
39454
<description><![CDATA[Returns a list of module names which must be processed in building the account befor this module.]]></description>
37810
39455
<long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
37811
39456
<br>
37812
39457
The named modules may not be active, LAM will check this automatically.</p>]]></long-description>
37813
<tag line="876" name="return" description="list of module names" type="array">
39458
<tag line="883" name="return" description="list of module names" type="array">
37814
39459
<type by_reference="false">array</type>
37815
39460
</tag>
37816
<tag line="876" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
39461
<tag line="883" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
37817
39462
</docblock>
37818
39463
</method>
37819
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="905" package="modules">
39464
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="912" package="modules">
37820
39465
<name>build_uploadAccounts</name>
37821
39466
<full_name>build_uploadAccounts</full_name>
37822
<docblock line="892">
39467
<docblock line="899">
37823
39468
<description><![CDATA[In this function the LDAP accounts are built.]]></description>
37824
39469
<long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
37825
39470
<br>
37826
39471
Returns an array which contains subarrays to generate StatusMessages if any errors occured.</p>]]></long-description>
37827
<tag line="892" name="param" description="the user input data, contains one subarray for each account." type="array" variable="$rawAccounts">
37828
<type by_reference="false">array</type>
37829
</tag>
37830
<tag line="892" name="param" description="list of IDs for column position (e.g. "posixAccount_uid" => 5)" type="array" variable="$ids">
37831
<type by_reference="false">array</type>
37832
</tag>
37833
<tag line="892" name="param" description="list of hash arrays (name => value) which are later added to LDAP" type="array" variable="$partialAccounts">
37834
<type by_reference="false">array</type>
37835
</tag>
37836
<tag line="892" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
37837
<type by_reference="false">array</type>
37838
</tag>
37839
<tag line="892" name="return" description="list of error messages if any" type="array">
39472
<tag line="899" name="param" description="the user input data, contains one subarray for each account." type="array" variable="$rawAccounts">
39473
<type by_reference="false">array</type>
39474
</tag>
39475
<tag line="899" name="param" description="list of IDs for column position (e.g. "posixAccount_uid" => 5)" type="array" variable="$ids">
39476
<type by_reference="false">array</type>
39477
</tag>
39478
<tag line="899" name="param" description="list of hash arrays (name => value) which are later added to LDAP" type="array" variable="$partialAccounts">
39479
<type by_reference="false">array</type>
39480
</tag>
39481
<tag line="899" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
39482
<type by_reference="false">array</type>
39483
</tag>
39484
<tag line="899" name="return" description="list of error messages if any" type="array">
37840
39485
<type by_reference="false">array</type>
37841
39486
</tag>
37842
39487
</docblock>
37843
<argument line="905">
39488
<argument line="912">
37844
39489
<name>$rawAccounts</name>
37845
39490
<default><![CDATA[]]></default>
37846
39491
<type/>
37847
39492
</argument>
37848
<argument line="905">
39493
<argument line="912">
37849
39494
<name>$ids</name>
37850
39495
<default><![CDATA[]]></default>
37851
39496
<type/>
37852
39497
</argument>
37853
<argument line="905">
39498
<argument line="912">
37854
39499
<name>$partialAccounts</name>
37855
39500
<default><![CDATA[]]></default>
37856
39501
<type/>
37857
39502
</argument>
37858
<argument line="905">
39503
<argument line="912">
37859
39504
<name>$selectedModules</name>
37860
39505
<default><![CDATA[]]></default>
37861
39506
<type/>
37862
39507
</argument>
37863
39508
</method>
37864
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="935" package="modules">
39509
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="942" package="modules">
37865
39510
<name>get_help</name>
37866
39511
<full_name>get_help</full_name>
37867
<docblock line="910">
39512
<docblock line="917">
37868
39513
<description><![CDATA[This function returns the help entry array for a specific help id.]]></description>
37869
39514
<long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
37870
39515
<br>
37884
39529
<b>Example:</b><br>
37885
39530
<br>
37886
39531
array('Headline' => 'This is the head line', 'Text' => 'Help content', 'SeeAlso' => array('text' => 'LAM homepage', 'link' => 'http://www.ldap-account-manager.org/'))</p>]]></long-description>
37887
<tag line="910" name="param" description="The id string for the help entry needed." type="string" variable="$id">
39532
<tag line="917" name="param" description="The id string for the help entry needed." type="string" variable="$id">
37888
39533
<type by_reference="false">string</type>
37889
39534
</tag>
37890
<tag line="910" name="return" description="The desired help entry." type="array">
39535
<tag line="917" name="return" description="The desired help entry." type="array">
37891
39536
<type by_reference="false">array</type>
37892
39537
</tag>
37893
<tag line="910" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
39538
<tag line="917" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
37894
39539
</docblock>
37895
<argument line="935">
39540
<argument line="942">
37896
39541
<name>$id</name>
37897
39542
<default><![CDATA[]]></default>
37898
39543
<type/>
37899
39544
</argument>
37900
39545
</method>
37901
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="959" package="modules">
39546
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="966" package="modules">
37902
39547
<name>module_ready</name>
37903
39548
<full_name>module_ready</full_name>
37904
<docblock line="947">
39549
<docblock line="954">
37905
39550
<description><![CDATA[This function is used to check if this module page can be displayed.]]></description>
37906
39551
<long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.<br>
37907
39552
<br>
37909
39554
can change to your module page or not. The return value is true if your module accepts
37910
39555
input, otherwise false.<br>
37911
39556
This method's return value defaults to true.</p>]]></long-description>
37912
<tag line="947" name="return" description="true, if page can be displayed" type="boolean">
39557
<tag line="954" name="return" description="true, if page can be displayed" type="boolean">
37913
39558
<type by_reference="false">boolean</type>
37914
39559
</tag>
37915
39560
</docblock>
37916
39561
</method>
37917
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="975" package="modules">
39562
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="982" package="modules">
37918
39563
<name>module_complete</name>
37919
39564
<full_name>module_complete</full_name>
37920
<docblock line="963">
39565
<docblock line="970">
37921
39566
<description><![CDATA[This function is used to check if all settings for this module have been made.]]></description>
37922
39567
<long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.<br>
37923
39568
<br>
37925
39570
additional input then set this to false. The user will be notified that your module needs
37926
39571
more input.<br>
37927
39572
This method's return value defaults to true.</p>]]></long-description>
37928
<tag line="963" name="return" description="true, if settings are complete" type="boolean">
39573
<tag line="970" name="return" description="true, if settings are complete" type="boolean">
37929
39574
<type by_reference="false">boolean</type>
37930
39575
</tag>
37931
39576
</docblock>
37932
39577
</method>
37933
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="993" package="modules">
39578
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1000" package="modules">
37934
39579
<name>getButtonStatus</name>
37935
39580
<full_name>getButtonStatus</full_name>
37936
<docblock line="979">
39581
<docblock line="986">
37937
39582
<description><![CDATA[Controls if the module button the account page is visible and activated.]]></description>
37938
39583
<long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.<br>
37939
39584
<br>
37944
39589
<li><b>disabled:</b> button is visible and deactivated (greyed)</li>
37945
39590
<li><b>hidden:</b> no button will be shown</li>
37946
39591
</ul>]]></long-description>
37947
<tag line="979" name="return" description="status ("enabled", "disabled", "hidden")" type="string">
39592
<tag line="986" name="return" description="status ("enabled", "disabled", "hidden")" type="string">
37948
39593
<type by_reference="false">string</type>
37949
39594
</tag>
37950
39595
</docblock>
37951
39596
</method>
37952
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1003" package="modules">
39597
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1010" package="modules">
37953
39598
<name>doUploadPreActions</name>
37954
39599
<full_name>doUploadPreActions</full_name>
37955
<docblock line="997">
39600
<docblock line="1004">
37956
39601
<description><![CDATA[Runs any actions that need to be done before an LDAP entry is created.]]></description>
37957
39602
<long-description><![CDATA[]]></long-description>
37958
<tag line="997" name="param" description="LDAP attributes of this entry (attributes are provided as reference, handle modifications of $attributes with care)" type="array" variable="$attributes">
39603
<tag line="1004" name="param" description="LDAP attributes of this entry (attributes are provided as reference, handle modifications of $attributes with care)" type="array" variable="$attributes">
37959
39604
<type by_reference="false">array</type>
37960
39605
</tag>
37961
<tag line="997" name="return" description="array which contains status messages. Each entry is an array containing the status message parameters." type="array">
39606
<tag line="1004" name="return" description="array which contains status messages. Each entry is an array containing the status message parameters." type="array">
37962
39607
<type by_reference="false">array</type>
37963
39608
</tag>
37964
39609
</docblock>
37965
<argument line="1003">
39610
<argument line="1010">
37966
39611
<name>$attributes</name>
37967
39612
<default><![CDATA[]]></default>
37968
39613
<type/>
37969
39614
</argument>
37970
39615
</method>
37971
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1029" package="modules">
39616
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1036" package="modules">
37972
39617
<name>doUploadPostActions</name>
37973
39618
<full_name>doUploadPostActions</full_name>
37974
<docblock line="1007">
39619
<docblock line="1014">
37975
39620
<description><![CDATA[This function is responsible to do additional tasks after the account has been created in LDAP (e.g.]]></description>
37976
39621
<long-description><![CDATA[<p>modifying group memberships, adding Quota etc..).</p>
37977
39622
37981
39626
that one function call lasts no longer than 3-4 seconds. Otherwise the upload may fail
37982
39627
because the time limit is exceeded. You should not make more than one LDAP operation in
37983
39628
each call.</p>]]></long-description>
37984
<tag line="1007" name="param" description="array containing one account in each element" type="array" variable="$data">
37985
<type by_reference="false">array</type>
37986
</tag>
37987
<tag line="1007" name="param" description="maps the column names to keys for the sub arrays (array(<column_name> => <column number>))" type="array" variable="$ids">
37988
<type by_reference="false">array</type>
37989
</tag>
37990
<tag line="1007" name="param" description="list of account numbers which could not be successfully uploaded to LDAP" type="array" variable="$failed">
37991
<type by_reference="false">array</type>
37992
</tag>
37993
<tag line="1007" name="param" description="variable to store temporary data between two post actions" type="array" variable="$temp">
37994
<type by_reference="false">array</type>
37995
</tag>
37996
<tag line="1007" name="param" description="list of LDAP entries" type="array" variable="$accounts">
37997
<type by_reference="false">array</type>
37998
</tag>
37999
<tag line="1007" name="return" description="current status <br> array ( <br> 'status' => 'finished' | 'inProgress' // defines if all operations are complete <br> 'progress' => 0..100 // the progress of the operations in percent <br> 'errors' => array // list of arrays which are used to generate StatusMessages <br> )" type="array">
39629
<tag line="1014" name="param" description="array containing one account in each element" type="array" variable="$data">
39630
<type by_reference="false">array</type>
39631
</tag>
39632
<tag line="1014" name="param" description="maps the column names to keys for the sub arrays (array(<column_name> => <column number>))" type="array" variable="$ids">
39633
<type by_reference="false">array</type>
39634
</tag>
39635
<tag line="1014" name="param" description="list of account numbers which could not be successfully uploaded to LDAP" type="array" variable="$failed">
39636
<type by_reference="false">array</type>
39637
</tag>
39638
<tag line="1014" name="param" description="variable to store temporary data between two post actions" type="array" variable="$temp">
39639
<type by_reference="false">array</type>
39640
</tag>
39641
<tag line="1014" name="param" description="list of LDAP entries" type="array" variable="$accounts">
39642
<type by_reference="false">array</type>
39643
</tag>
39644
<tag line="1014" name="return" description="current status <br> array ( <br> 'status' => 'finished' | 'inProgress' // defines if all operations are complete <br> 'progress' => 0..100 // the progress of the operations in percent <br> 'errors' => array // list of arrays which are used to generate StatusMessages <br> )" type="array">
38000
39645
<type by_reference="false">array</type>
38001
39646
</tag>
38002
39647
</docblock>
38003
<argument line="1029">
39648
<argument line="1036">
38004
39649
<name>$data</name>
38005
39650
<default><![CDATA[]]></default>
38006
39651
<type/>
38007
39652
</argument>
38008
<argument line="1029">
39653
<argument line="1036">
38009
39654
<name>$ids</name>
38010
39655
<default><![CDATA[]]></default>
38011
39656
<type/>
38012
39657
</argument>
38013
<argument line="1029">
39658
<argument line="1036">
38014
39659
<name>$failed</name>
38015
39660
<default><![CDATA[]]></default>
38016
39661
<type/>
38017
39662
</argument>
38018
<argument line="1029">
39663
<argument line="1036">
38019
39664
<name>$temp</name>
38020
39665
<default><![CDATA[]]></default>
38021
39666
<type/>
38022
39667
</argument>
38023
<argument line="1029">
39668
<argument line="1036">
38024
39669
<name>$accounts</name>
38025
39670
<default><![CDATA[]]></default>
38026
39671
<type/>
38027
39672
</argument>
38028
39673
</method>
38029
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1057" package="modules">
39674
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1064" package="modules">
38030
39675
<name>save_attributes</name>
38031
39676
<full_name>save_attributes</full_name>
38032
<docblock line="1037">
39677
<docblock line="1044">
38033
39678
<description><![CDATA[Returns a list of modifications which have to be made to the LDAP account.]]></description>
38034
39679
<long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.<br>
38035
39680
<br></p>
38045
39690
<br><b>"info"</b> values with informational value (e.g. to be used later by pre/postModify actions)
38046
39691
<br>
38047
39692
<br>This builds the required comands from $this-attributes and $this->orig.</p>]]></long-description>
38048
<tag line="1037" name="return" description="list of modifications" type="array">
39693
<tag line="1044" name="return" description="list of modifications" type="array">
38049
39694
<type by_reference="false">array</type>
38050
39695
</tag>
38051
39696
</docblock>
38052
39697
</method>
38053
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1072" package="modules">
39698
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1079" package="modules">
38054
39699
<name>preModifyActions</name>
38055
39700
<full_name>preModifyActions</full_name>
38056
<docblock line="1061">
39701
<docblock line="1068">
38057
39702
<description><![CDATA[Allows the module to run commands before the LDAP entry is changed or created.]]></description>
38058
39703
<long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.<br>
38059
39704
<br>
38060
39705
The modification is aborted if an error message is returned.</p>]]></long-description>
38061
<tag line="1061" name="param" description="new account" type="boolean" variable="$newAccount">
39706
<tag line="1068" name="param" description="new account" type="boolean" variable="$newAccount">
38062
39707
<type by_reference="false">boolean</type>
38063
39708
</tag>
38064
<tag line="1061" name="param" description="LDAP attributes of this entry (added/modified attributes are provided as reference, handle modifications of $attributes with care)" type="array" variable="$attributes">
39709
<tag line="1068" name="param" description="LDAP attributes of this entry (added/modified attributes are provided as reference, handle modifications of $attributes with care)" type="array" variable="$attributes">
38065
39710
<type by_reference="false">array</type>
38066
39711
</tag>
38067
<tag line="1061" name="return" description="array which contains status messages. Each entry is an array containing the status message parameters." type="array">
39712
<tag line="1068" name="return" description="array which contains status messages. Each entry is an array containing the status message parameters." type="array">
38068
39713
<type by_reference="false">array</type>
38069
39714
</tag>
38070
39715
</docblock>
38071
<argument line="1072">
39716
<argument line="1079">
38072
39717
<name>$newAccount</name>
38073
39718
<default><![CDATA[]]></default>
38074
39719
<type/>
38075
39720
</argument>
38076
<argument line="1072">
39721
<argument line="1079">
38077
39722
<name>$attributes</name>
38078
39723
<default><![CDATA[]]></default>
38079
39724
<type/>
38080
39725
</argument>
38081
39726
</method>
38082
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1085" package="modules">
39727
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1092" package="modules">
38083
39728
<name>postModifyActions</name>
38084
39729
<full_name>postModifyActions</full_name>
38085
<docblock line="1076">
39730
<docblock line="1083">
38086
39731
<description><![CDATA[Allows the module to run commands after the LDAP entry is changed or created.]]></description>
38087
39732
<long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
38088
<tag line="1076" name="param" description="new account" type="boolean" variable="$newAccount">
39733
<tag line="1083" name="param" description="new account" type="boolean" variable="$newAccount">
38089
39734
<type by_reference="false">boolean</type>
38090
39735
</tag>
38091
<tag line="1076" name="param" description="LDAP attributes of this entry" type="array" variable="$attributes">
39736
<tag line="1083" name="param" description="LDAP attributes of this entry" type="array" variable="$attributes">
38092
39737
<type by_reference="false">array</type>
38093
39738
</tag>
38094
<tag line="1076" name="return" description="array which contains status messages. Each entry is an array containing the status message parameters." type="array">
39739
<tag line="1083" name="return" description="array which contains status messages. Each entry is an array containing the status message parameters." type="array">
38095
39740
<type by_reference="false">array</type>
38096
39741
</tag>
38097
39742
</docblock>
38098
<argument line="1085">
39743
<argument line="1092">
38099
39744
<name>$newAccount</name>
38100
39745
<default><![CDATA[]]></default>
38101
39746
<type/>
38102
39747
</argument>
38103
<argument line="1085">
39748
<argument line="1092">
38104
39749
<name>$attributes</name>
38105
39750
<default><![CDATA[]]></default>
38106
39751
<type/>
38107
39752
</argument>
38108
39753
</method>
38109
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1096" package="modules">
39754
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1103" package="modules">
38110
39755
<name>preDeleteActions</name>
38111
39756
<full_name>preDeleteActions</full_name>
38112
<docblock line="1089">
39757
<docblock line="1096">
38113
39758
<description><![CDATA[Allows the module to run commands before the LDAP entry is deleted.]]></description>
38114
39759
<long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.<br></p>]]></long-description>
38115
<tag line="1089" name="return" description="Array which contains status messages. Each entry is an array containing the status message parameters." type="array">
39760
<tag line="1096" name="return" description="Array which contains status messages. Each entry is an array containing the status message parameters." type="array">
38116
39761
<type by_reference="false">array</type>
38117
39762
</tag>
38118
39763
</docblock>
38119
39764
</method>
38120
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1107" package="modules">
39765
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1114" package="modules">
38121
39766
<name>postDeleteActions</name>
38122
39767
<full_name>postDeleteActions</full_name>
38123
<docblock line="1100">
39768
<docblock line="1107">
38124
39769
<description><![CDATA[Allows the module to run commands after the LDAP entry is deleted.]]></description>
38125
39770
<long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
38126
<tag line="1100" name="return" description="Array which contains status messages. Each entry is an array containing the status message parameters." type="array">
39771
<tag line="1107" name="return" description="Array which contains status messages. Each entry is an array containing the status message parameters." type="array">
38127
39772
<type by_reference="false">array</type>
38128
39773
</tag>
38129
39774
</docblock>
38130
39775
</method>
38131
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1120" package="modules">
39776
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1127" package="modules">
38132
39777
<name>delete_attributes</name>
38133
39778
<full_name>delete_attributes</full_name>
38134
<docblock line="1111">
39779
<docblock line="1118">
38135
39780
<description><![CDATA[This function returns an array with the same syntax as save_attributes().]]></description>
38136
39781
<long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.<br>
38137
39782
<br>
38138
39783
It allows additional LDAP changes when an account is deleted.</p>]]></long-description>
38139
<tag line="1111" name="return" description="of LDAP operations, same as for save_attributes()" type="\List">
39784
<tag line="1118" name="return" description="of LDAP operations, same as for save_attributes()" type="\List">
38140
39785
<type by_reference="false">\List</type>
38141
39786
</tag>
38142
39787
</docblock>
38143
39788
</method>
38144
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1135" package="modules">
39789
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1142" package="modules">
38145
39790
<name>display_html_delete</name>
38146
39791
<full_name>display_html_delete</full_name>
38147
<docblock line="1124">
39792
<docblock line="1131">
38148
39793
<description><![CDATA[This function creates meta HTML code which will be displayed when an account should be deleted.]]></description>
38149
39794
<long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.<br>
38150
39795
<br>
38151
39796
This can be used to interact with the user, e.g. should the home directory be deleted? The output
38152
39797
of all modules is displayed on a single page.</p>]]></long-description>
38153
<tag line="1124" name="return" description="meta HTML object" type="\htmlElement">
39798
<tag line="1131" name="return" description="meta HTML object" type="\htmlElement">
38154
39799
<type by_reference="false">\htmlElement</type>
38155
39800
</tag>
38156
<tag line="1124" name="see" description="\global\htmlElement" refers="\global\htmlElement"/>
39801
<tag line="1131" name="see" description="\global\htmlElement" refers="\global\htmlElement"/>
38157
39802
</docblock>
38158
39803
</method>
38159
<method final="false" abstract="true" static="false" visibility="public" namespace="global" line="1150" package="modules">
39804
<method final="false" abstract="true" static="false" visibility="public" namespace="global" line="1157" package="modules">
38160
39805
<name>process_attributes</name>
38161
39806
<full_name>process_attributes</full_name>
38162
<docblock line="1139">
39807
<docblock line="1146">
38163
39808
<description><![CDATA[This function processes user input.]]></description>
38164
39809
<long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.<br>
38165
39810
<br>
38166
39811
It checks the user input and saves changes in the module's data structures.<br>
38167
39812
<br>
38168
39813
<b>Example:</b> return array(array('ERROR', 'Invalid input!', 'This is not allowed here.'));</p>]]></long-description>
38169
<tag line="1139" name="return" description="Array which contains status messages. Each entry is an array containing the status message parameters." type="array">
39814
<tag line="1146" name="return" description="Array which contains status messages. Each entry is an array containing the status message parameters." type="array">
38170
39815
<type by_reference="false">array</type>
38171
39816
</tag>
38172
39817
</docblock>
38173
39818
</method>
38174
<method final="false" abstract="true" static="false" visibility="public" namespace="global" line="1161" package="modules">
39819
<method final="false" abstract="true" static="false" visibility="public" namespace="global" line="1168" package="modules">
38175
39820
<name>display_html_attributes</name>
38176
39821
<full_name>display_html_attributes</full_name>
38177
<docblock line="1152">
39822
<docblock line="1159">
38178
39823
<description><![CDATA[This function creates meta HTML code to display the module page.]]></description>
38179
39824
<long-description><![CDATA[<p>Calling this method requires the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
38180
<tag line="1152" name="return" description="meta HTML object" type="\htmlElement">
39825
<tag line="1159" name="return" description="meta HTML object" type="\htmlElement">
38181
39826
<type by_reference="false">\htmlElement</type>
38182
39827
</tag>
38183
<tag line="1152" name="see" description="\global\htmlElement" refers="\global\htmlElement"/>
39828
<tag line="1159" name="see" description="\global\htmlElement" refers="\global\htmlElement"/>
38184
39829
</docblock>
38185
39830
</method>
38186
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1174" package="modules">
39831
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1182" package="modules">
38187
39832
<name>addSimpleInputTextField</name>
38188
39833
<full_name>addSimpleInputTextField</full_name>
38189
<docblock line="1163">
39834
<docblock line="1170">
38190
39835
<description><![CDATA[Adds a simple text input field to the given htmlTable.]]></description>
38191
39836
<long-description><![CDATA[<p>The field name will be the same as the attribute name. There must also be a help entry with the attribute name as ID.
38192
39837
A new line will also be added after this entry so multiple calls will show the fields one below the other.</p>]]></long-description>
38193
<tag line="1163" name="param" description="parent container" type="\htmlTable" variable="$container">
38194
<type by_reference="false">\htmlTable</type>
38195
</tag>
38196
<tag line="1163" name="param" description="attribute name" type="String" variable="$attrName">
38197
<type by_reference="false">String</type>
38198
</tag>
38199
<tag line="1163" name="param" description="label name" type="String" variable="$label">
38200
<type by_reference="false">String</type>
38201
</tag>
38202
<tag line="1163" name="param" description="this is a required field (default false)" type="boolean" variable="$required">
38203
<type by_reference="false">boolean</type>
38204
</tag>
38205
<tag line="1163" name="param" description="field length" type="integer" variable="$length">
38206
<type by_reference="false">integer</type>
38207
</tag>
38208
</docblock>
38209
<argument line="1174">
38210
<name>$container</name>
38211
<default><![CDATA[]]></default>
38212
<type/>
38213
</argument>
38214
<argument line="1174">
38215
<name>$attrName</name>
38216
<default><![CDATA[]]></default>
38217
<type/>
38218
</argument>
38219
<argument line="1174">
38220
<name>$label</name>
38221
<default><![CDATA[]]></default>
38222
<type/>
38223
</argument>
38224
<argument line="1174">
38225
<name>$required</name>
38226
<default><![CDATA[false]]></default>
38227
<type/>
38228
</argument>
38229
<argument line="1174">
38230
<name>$length</name>
38231
<default><![CDATA[null]]></default>
38232
<type/>
38233
</argument>
38234
</method>
38235
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1200" package="modules">
39838
<tag line="1170" name="param" description="parent container" type="\htmlTable" variable="$container">
39839
<type by_reference="false">\htmlTable</type>
39840
</tag>
39841
<tag line="1170" name="param" description="attribute name" type="String" variable="$attrName">
39842
<type by_reference="false">String</type>
39843
</tag>
39844
<tag line="1170" name="param" description="label name" type="String" variable="$label">
39845
<type by_reference="false">String</type>
39846
</tag>
39847
<tag line="1170" name="param" description="this is a required field (default false)" type="boolean" variable="$required">
39848
<type by_reference="false">boolean</type>
39849
</tag>
39850
<tag line="1170" name="param" description="field length" type="integer" variable="$length">
39851
<type by_reference="false">integer</type>
39852
</tag>
39853
<tag line="1170" name="param" description="show as text area (default false)" type="boolean" variable="$isTextArea">
39854
<type by_reference="false">boolean</type>
39855
</tag>
39856
</docblock>
39857
<argument line="1182">
39858
<name>$container</name>
39859
<default><![CDATA[]]></default>
39860
<type/>
39861
</argument>
39862
<argument line="1182">
39863
<name>$attrName</name>
39864
<default><![CDATA[]]></default>
39865
<type/>
39866
</argument>
39867
<argument line="1182">
39868
<name>$label</name>
39869
<default><![CDATA[]]></default>
39870
<type/>
39871
</argument>
39872
<argument line="1182">
39873
<name>$required</name>
39874
<default><![CDATA[false]]></default>
39875
<type/>
39876
</argument>
39877
<argument line="1182">
39878
<name>$length</name>
39879
<default><![CDATA[null]]></default>
39880
<type/>
39881
</argument>
39882
<argument line="1182">
39883
<name>$isTextArea</name>
39884
<default><![CDATA[false]]></default>
39885
<type/>
39886
</argument>
39887
</method>
39888
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1217" package="modules">
39889
<name>addMultiValueInputTextField</name>
39890
<full_name>addMultiValueInputTextField</full_name>
39891
<docblock line="1204">
39892
<description><![CDATA[Adds a text input field that may contain multiple values to the given htmlTable.]]></description>
39893
<long-description><![CDATA[<p>The field name will be the same as the attribute name plus a counting number (e.g. street_0).
39894
The last field will be followed by a button to add a new value. This is named add_{attribute name} (e.g. add_street).
39895
There must be a help entry with the attribute name as ID.
39896
A new line will also be added after this entry so multiple calls will show the fields one below the other.</p>]]></long-description>
39897
<tag line="1204" name="param" description="parent container" type="\htmlTable" variable="$container">
39898
<type by_reference="false">\htmlTable</type>
39899
</tag>
39900
<tag line="1204" name="param" description="attribute name" type="String" variable="$attrName">
39901
<type by_reference="false">String</type>
39902
</tag>
39903
<tag line="1204" name="param" description="label name" type="String" variable="$label">
39904
<type by_reference="false">String</type>
39905
</tag>
39906
<tag line="1204" name="param" description="this is a required field (default false)" type="boolean" variable="$required">
39907
<type by_reference="false">boolean</type>
39908
</tag>
39909
<tag line="1204" name="param" description="field length" type="integer" variable="$length">
39910
<type by_reference="false">integer</type>
39911
</tag>
39912
</docblock>
39913
<argument line="1217">
39914
<name>$container</name>
39915
<default><![CDATA[]]></default>
39916
<type/>
39917
</argument>
39918
<argument line="1217">
39919
<name>$attrName</name>
39920
<default><![CDATA[]]></default>
39921
<type/>
39922
</argument>
39923
<argument line="1217">
39924
<name>$label</name>
39925
<default><![CDATA[]]></default>
39926
<type/>
39927
</argument>
39928
<argument line="1217">
39929
<name>$required</name>
39930
<default><![CDATA[false]]></default>
39931
<type/>
39932
</argument>
39933
<argument line="1217">
39934
<name>$length</name>
39935
<default><![CDATA[null]]></default>
39936
<type/>
39937
</argument>
39938
</method>
39939
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1253" package="modules">
39940
<name>processMultiValueInputTextField</name>
39941
<full_name>processMultiValueInputTextField</full_name>
39942
<docblock line="1244">
39943
<description><![CDATA[Validates a multi-value text field.]]></description>
39944
<long-description><![CDATA[<p>The input fields must be created with function addMultiValueInputTextField().
39945
If validation is used then there must exist a message named [{attribute name}][0] (e.g. $this->messages['street'][0]).</p>]]></long-description>
39946
<tag line="1244" name="param" description="attribute name" type="String" variable="$attrName">
39947
<type by_reference="false">String</type>
39948
</tag>
39949
<tag line="1244" name="param" description="errors array where to put validation errors" type="array" variable="$errors">
39950
<type by_reference="false">array</type>
39951
</tag>
39952
<tag line="1244" name="param" description="validation ID for function get_preg() (default: null, null means no validation)" type="String" variable="$validationID">
39953
<type by_reference="false">String</type>
39954
</tag>
39955
</docblock>
39956
<argument line="1253">
39957
<name>$attrName</name>
39958
<default><![CDATA[]]></default>
39959
<type/>
39960
</argument>
39961
<argument line="1253">
39962
<name>$errors</name>
39963
<default><![CDATA[]]></default>
39964
<type/>
39965
</argument>
39966
<argument line="1253">
39967
<name>$validationID</name>
39968
<default><![CDATA[null]]></default>
39969
<type/>
39970
</argument>
39971
</method>
39972
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1284" package="modules">
39973
<name>addSimpleSelfServiceTextField</name>
39974
<full_name>addSimpleSelfServiceTextField</full_name>
39975
<docblock line="1271">
39976
<description><![CDATA[Adds a simple text input field for the self service.]]></description>
39977
<long-description><![CDATA[<p>The field name will be the same as the class name plus "_" plus attribute name (e.g. posixAccount_cn).</p>]]></long-description>
39978
<tag line="1271" name="param" description="array that is used as return value for getSelfServiceOptions()" type="array" variable="$container">
39979
<type by_reference="false">array</type>
39980
</tag>
39981
<tag line="1271" name="param" description="attribute name (== field name)" type="String" variable="$name">
39982
<type by_reference="false">String</type>
39983
</tag>
39984
<tag line="1271" name="param" description="label to display in front of input field" type="String" variable="$label">
39985
<type by_reference="false">String</type>
39986
</tag>
39987
<tag line="1271" name="param" description="list of active fields" type="array" variable="$fields">
39988
<type by_reference="false">array</type>
39989
</tag>
39990
<tag line="1271" name="param" description="attributes of LDAP account" type="array" variable="$attributes">
39991
<type by_reference="false">array</type>
39992
</tag>
39993
<tag line="1271" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
39994
<type by_reference="false">array</type>
39995
</tag>
39996
<tag line="1271" name="param" description="field is required" type="boolean" variable="$required">
39997
<type by_reference="false">boolean</type>
39998
</tag>
39999
<tag line="1271" name="param" description="display as text area" type="boolean" variable="$isTextArea">
40000
<type by_reference="false">boolean</type>
40001
</tag>
40002
</docblock>
40003
<argument line="1284">
40004
<name>$container</name>
40005
<default><![CDATA[]]></default>
40006
<type/>
40007
</argument>
40008
<argument line="1284">
40009
<name>$name</name>
40010
<default><![CDATA[]]></default>
40011
<type/>
40012
</argument>
40013
<argument line="1284">
40014
<name>$label</name>
40015
<default><![CDATA[]]></default>
40016
<type/>
40017
</argument>
40018
<argument line="1284">
40019
<name>$fields</name>
40020
<default><![CDATA[]]></default>
40021
<type/>
40022
</argument>
40023
<argument line="1284">
40024
<name>$attributes</name>
40025
<default><![CDATA[]]></default>
40026
<type/>
40027
</argument>
40028
<argument line="1284">
40029
<name>$readOnlyFields</name>
40030
<default><![CDATA[]]></default>
40031
<type/>
40032
</argument>
40033
<argument line="1284">
40034
<name>$required</name>
40035
<default><![CDATA[false]]></default>
40036
<type/>
40037
</argument>
40038
<argument line="1284">
40039
<name>$isTextArea</name>
40040
<default><![CDATA[false]]></default>
40041
<type/>
40042
</argument>
40043
</method>
40044
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1323" package="modules">
40045
<name>checkSimpleSelfServiceTextField</name>
40046
<full_name>checkSimpleSelfServiceTextField</full_name>
40047
<docblock line="1311">
40048
<description><![CDATA[Checks the input value of a self service text field.]]></description>
40049
<long-description><![CDATA[<p>The field name must be the same as the class name plus "_" plus attribute name (e.g. posixAccount_cn).
40050
If validation is used then there must exist a message named [{attribute name}][0] (e.g. $this->messages['street'][0]).</p>]]></long-description>
40051
<tag line="1311" name="param" description="return value of checkSelfServiceOptions()" type="array" variable="$container">
40052
<type by_reference="false">array</type>
40053
</tag>
40054
<tag line="1311" name="param" description="attribute name" type="String" variable="$name">
40055
<type by_reference="false">String</type>
40056
</tag>
40057
<tag line="1311" name="param" description="LDAP attributes" type="array" variable="$attributes">
40058
<type by_reference="false">array</type>
40059
</tag>
40060
<tag line="1311" name="param" description="input fields" type="string" variable="$fields">
40061
<type by_reference="false">string</type>
40062
</tag>
40063
<tag line="1311" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
40064
<type by_reference="false">array</type>
40065
</tag>
40066
<tag line="1311" name="param" description="validation ID for get_preg()" type="String" variable="$validationID">
40067
<type by_reference="false">String</type>
40068
</tag>
40069
</docblock>
40070
<argument line="1323">
40071
<name>$container</name>
40072
<default><![CDATA[]]></default>
40073
<type/>
40074
</argument>
40075
<argument line="1323">
40076
<name>$name</name>
40077
<default><![CDATA[]]></default>
40078
<type/>
40079
</argument>
40080
<argument line="1323">
40081
<name>$attributes</name>
40082
<default><![CDATA[]]></default>
40083
<type/>
40084
</argument>
40085
<argument line="1323">
40086
<name>$fields</name>
40087
<default><![CDATA[]]></default>
40088
<type/>
40089
</argument>
40090
<argument line="1323">
40091
<name>$readOnlyFields</name>
40092
<default><![CDATA[]]></default>
40093
<type/>
40094
</argument>
40095
<argument line="1323">
40096
<name>$validationID</name>
40097
<default><![CDATA[null]]></default>
40098
<type/>
40099
</argument>
40100
</method>
40101
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1358" package="modules">
38236
40102
<name>getManagedObjectClasses</name>
38237
40103
<full_name>getManagedObjectClasses</full_name>
38238
<docblock line="1187">
40104
<docblock line="1345">
38239
40105
<description><![CDATA[Returns a list of managed object classes for this module.]]></description>
38240
40106
<long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
38241
40107
<br>
38242
40108
This is used to fix spelling errors in LDAP-Entries (e.g. if "posixACCOUNT" is read instead of "posixAccount" from LDAP).<br>
38243
40109
<br>
38244
40110
<b>Example:</b> return array('posixAccount')</p>]]></long-description>
38245
<tag line="1187" name="return" description="list of object classes" type="array">
40111
<tag line="1345" name="return" description="list of object classes" type="array">
38246
40112
<type by_reference="false">array</type>
38247
40113
</tag>
38248
<tag line="1187" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
40114
<tag line="1345" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
38249
40115
</docblock>
38250
40116
</method>
38251
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1216" package="modules">
40117
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1374" package="modules">
38252
40118
<name>getLDAPAliases</name>
38253
40119
<full_name>getLDAPAliases</full_name>
38254
<docblock line="1205">
40120
<docblock line="1363">
38255
40121
<description><![CDATA[Returns a list of aliases for LDAP attributes.]]></description>
38256
40122
<long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
38257
40123
<br>
38258
40124
All alias attributes will be renamed to the given attribute names.</p>]]></long-description>
38259
<tag line="1205" name="return" description="list of aliases like array("alias name" => "attribute name")" type="array">
40125
<tag line="1363" name="return" description="list of aliases like array("alias name" => "attribute name")" type="array">
38260
40126
<type by_reference="false">array</type>
38261
40127
</tag>
38262
<tag line="1205" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
40128
<tag line="1363" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
38263
40129
</docblock>
38264
40130
</method>
38265
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1229" package="modules">
40131
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1387" package="modules">
38266
40132
<name>getManagedAttributes</name>
38267
40133
<full_name>getManagedAttributes</full_name>
38268
<docblock line="1221">
40134
<docblock line="1379">
38269
40135
<description><![CDATA[Returns a list of LDAP attributes which are managed by this module.]]></description>
38270
40136
<long-description><![CDATA[<p>All attribute names will be renamed to match the given spelling.</p>]]></long-description>
38271
<tag line="1221" name="return" description="list of attributes" type="array">
40137
<tag line="1379" name="return" description="list of attributes" type="array">
38272
40138
<type by_reference="false">array</type>
38273
40139
</tag>
38274
<tag line="1221" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
40140
<tag line="1379" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
38275
40141
</docblock>
38276
40142
</method>
38277
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1243" package="modules">
40143
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1401" package="modules">
38278
40144
<name>getRequiredExtensions</name>
38279
40145
<full_name>getRequiredExtensions</full_name>
38280
<docblock line="1234">
40146
<docblock line="1392">
38281
40147
<description><![CDATA[This function returns a list of PHP extensions (e.g.]]></description>
38282
40148
<long-description><![CDATA[<p>hash) which are needed by this module.</p>
38283
40149
38284
40150
<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
38285
<tag line="1234" name="return" description="extensions" type="array">
40151
<tag line="1392" name="return" description="extensions" type="array">
38286
40152
<type by_reference="false">array</type>
38287
40153
</tag>
38288
<tag line="1234" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
40154
<tag line="1392" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
38289
40155
</docblock>
38290
40156
</method>
38291
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1257" package="modules">
40157
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1415" package="modules">
38292
40158
<name>getSelfServiceSearchAttributes</name>
38293
40159
<full_name>getSelfServiceSearchAttributes</full_name>
38294
<docblock line="1248">
40160
<docblock line="1406">
38295
40161
<description><![CDATA[This function returns a list of possible LDAP attributes (e.g.]]></description>
38296
40162
<long-description><![CDATA[<p>uid, cn, ...) which can be used to search for LDAP objects.</p>
38297
40163
38298
40164
<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
38299
<tag line="1248" name="return" description="attributes" type="array">
40165
<tag line="1406" name="return" description="attributes" type="array">
38300
40166
<type by_reference="false">array</type>
38301
40167
</tag>
38302
<tag line="1248" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
40168
<tag line="1406" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
38303
40169
</docblock>
38304
40170
</method>
38305
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1273" package="modules">
40171
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1431" package="modules">
38306
40172
<name>getSelfServiceFields</name>
38307
40173
<full_name>getSelfServiceFields</full_name>
38308
<docblock line="1262">
40174
<docblock line="1420">
38309
40175
<description><![CDATA[Returns a list of possible input fields and their descriptions.]]></description>
38310
40176
<long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
38311
40177
<br>
38312
40178
<b>Format:</b> array(<field identifier> => <field description>)</p>]]></long-description>
38313
<tag line="1262" name="return" description="fields" type="array">
40179
<tag line="1420" name="return" description="fields" type="array">
38314
40180
<type by_reference="false">array</type>
38315
40181
</tag>
38316
<tag line="1262" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
40182
<tag line="1420" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
38317
40183
</docblock>
38318
40184
</method>
38319
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1284" package="modules">
40185
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1442" package="modules">
38320
40186
<name>canSelfServiceFieldBeReadOnly</name>
38321
40187
<full_name>canSelfServiceFieldBeReadOnly</full_name>
38322
<docblock line="1278">
40188
<docblock line="1436">
38323
40189
<description><![CDATA[Returns if a given self service field can be set in read-only mode.]]></description>
38324
40190
<long-description><![CDATA[]]></long-description>
38325
<tag line="1278" name="param" description="field identifier" type="String" variable="$fieldID">
40191
<tag line="1436" name="param" description="field identifier" type="String" variable="$fieldID">
38326
40192
<type by_reference="false">String</type>
38327
40193
</tag>
38328
<tag line="1278" name="param" description="currently edited profile" type="\selfServiceProfile" variable="$profile">
40194
<tag line="1436" name="param" description="currently edited profile" type="\selfServiceProfile" variable="$profile">
38329
40195
<type by_reference="false">\selfServiceProfile</type>
38330
40196
</tag>
38331
40197
</docblock>
38332
<argument line="1284">
40198
<argument line="1442">
38333
40199
<name>$fieldID</name>
38334
40200
<default><![CDATA[]]></default>
38335
40201
<type/>
38336
40202
</argument>
38337
<argument line="1284">
40203
<argument line="1442">
38338
40204
<name>$profile</name>
38339
40205
<default><![CDATA[]]></default>
38340
40206
<type/>
38341
40207
</argument>
38342
40208
</method>
38343
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1306" package="modules">
40209
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1464" package="modules">
38344
40210
<name>getSelfServiceOptions</name>
38345
40211
<full_name>getSelfServiceOptions</full_name>
38346
<docblock line="1291">
40212
<docblock line="1449">
38347
40213
<description><![CDATA[Returns the meta HTML code for each input field.]]></description>
38348
40214
<long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
38349
40215
<br>
38350
40216
It is not possible to display help links.</p>]]></long-description>
38351
<tag line="1291" name="param" description="list of active fields" type="array" variable="$fields">
38352
<type by_reference="false">array</type>
38353
</tag>
38354
<tag line="1291" name="param" description="attributes of LDAP account" type="array" variable="$attributes">
38355
<type by_reference="false">array</type>
38356
</tag>
38357
<tag line="1291" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
40217
<tag line="1449" name="param" description="list of active fields" type="array" variable="$fields">
40218
<type by_reference="false">array</type>
40219
</tag>
40220
<tag line="1449" name="param" description="attributes of LDAP account" type="array" variable="$attributes">
40221
<type by_reference="false">array</type>
40222
</tag>
40223
<tag line="1449" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
38358
40224
<type by_reference="false">boolean</type>
38359
40225
</tag>
38360
<tag line="1291" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
38361
<type by_reference="false">array</type>
38362
</tag>
38363
<tag line="1291" name="return" description="list of meta HTML elements (field name => htmlTableRow)" type="array">
38364
<type by_reference="false">array</type>
38365
</tag>
38366
<tag line="1291" name="see" description="\global\htmlElement" refers="\global\htmlElement"/>
40226
<tag line="1449" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
40227
<type by_reference="false">array</type>
40228
</tag>
40229
<tag line="1449" name="return" description="list of meta HTML elements (field name => htmlTableRow)" type="array">
40230
<type by_reference="false">array</type>
40231
</tag>
40232
<tag line="1449" name="see" description="\global\htmlElement" refers="\global\htmlElement"/>
38367
40233
</docblock>
38368
<argument line="1306">
40234
<argument line="1464">
38369
40235
<name>$fields</name>
38370
40236
<default><![CDATA[]]></default>
38371
40237
<type/>
38372
40238
</argument>
38373
<argument line="1306">
40239
<argument line="1464">
38374
40240
<name>$attributes</name>
38375
40241
<default><![CDATA[]]></default>
38376
40242
<type/>
38377
40243
</argument>
38378
<argument line="1306">
40244
<argument line="1464">
38379
40245
<name>$passwordChangeOnly</name>
38380
40246
<default><![CDATA[]]></default>
38381
40247
<type/>
38382
40248
</argument>
38383
<argument line="1306">
40249
<argument line="1464">
38384
40250
<name>$readOnlyFields</name>
38385
40251
<default><![CDATA[]]></default>
38386
40252
<type/>
38387
40253
</argument>
38388
40254
</method>
38389
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1328" package="modules">
40255
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1486" package="modules">
38390
40256
<name>checkSelfServiceOptions</name>
38391
40257
<full_name>checkSelfServiceOptions</full_name>
38392
<docblock line="1311">
40258
<docblock line="1469">
38393
40259
<description><![CDATA[Checks if all input values are correct and returns the LDAP attributes which should be changed.]]></description>
38394
40260
<long-description><![CDATA[<p><br>Return values:
38395
40261
<br>messages: array of parameters to create status messages
38399
40265
<br>info: array of values with informational value (e.g. to be used later by pre/postModify actions)</p>
38400
40266
38401
40267
<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.</p>]]></long-description>
38402
<tag line="1311" name="param" description="input fields" type="string" variable="$fields">
40268
<tag line="1469" name="param" description="input fields" type="string" variable="$fields">
38403
40269
<type by_reference="false">string</type>
38404
40270
</tag>
38405
<tag line="1311" name="param" description="LDAP attributes" type="array" variable="$attributes">
40271
<tag line="1469" name="param" description="LDAP attributes" type="array" variable="$attributes">
38406
40272
<type by_reference="false">array</type>
38407
40273
</tag>
38408
<tag line="1311" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
40274
<tag line="1469" name="param" description="indicates that the user is only allowed to change his password and no LDAP content is readable" type="boolean" variable="$passwordChangeOnly">
38409
40275
<type by_reference="false">boolean</type>
38410
40276
</tag>
38411
<tag line="1311" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
40277
<tag line="1469" name="param" description="list of read-only fields" type="array" variable="$readOnlyFields">
38412
40278
<type by_reference="false">array</type>
38413
40279
</tag>
38414
<tag line="1311" name="return" description="messages and attributes (array('messages' => array(), 'add' => array('mail' => array('test@test.com')), 'del' => array(), 'mod' => array(), 'info' => array()))" type="array">
40280
<tag line="1469" name="return" description="messages and attributes (array('messages' => array(), 'add' => array('mail' => array('test@test.com')), 'del' => array(), 'mod' => array(), 'info' => array()))" type="array">
38415
40281
<type by_reference="false">array</type>
38416
40282
</tag>
38417
40283
</docblock>
38418
<argument line="1328">
40284
<argument line="1486">
38419
40285
<name>$fields</name>
38420
40286
<default><![CDATA[]]></default>
38421
40287
<type/>
38422
40288
</argument>
38423
<argument line="1328">
40289
<argument line="1486">
38424
40290
<name>$attributes</name>
38425
40291
<default><![CDATA[]]></default>
38426
40292
<type/>
38427
40293
</argument>
38428
<argument line="1328">
40294
<argument line="1486">
38429
40295
<name>$passwordChangeOnly</name>
38430
40296
<default><![CDATA[]]></default>
38431
40297
<type/>
38432
40298
</argument>
38433
<argument line="1328">
40299
<argument line="1486">
38434
40300
<name>$readOnlyFields</name>
38435
40301
<default><![CDATA[]]></default>
38436
40302
<type/>
38437
40303
</argument>
38438
40304
</method>
38439
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1348" package="modules">
40305
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1506" package="modules">
38440
40306
<name>getSelfServiceSettings</name>
38441
40307
<full_name>getSelfServiceSettings</full_name>
38442
<docblock line="1333">
40308
<docblock line="1491">
38443
40309
<description><![CDATA[Returns a list of self service configuration settings.]]></description>
38444
40310
<long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
38445
40311
<br>
38446
40312
The name attributes are used as keywords to load
38447
40313
and save settings. We recommend to use the module name as prefix for them
38448
40314
(e.g. posixAccount_homeDirectory) to avoid naming conflicts.</p>]]></long-description>
38449
<tag line="1333" name="param" description="currently edited profile" type="\selfServiceProfile" variable="$profile">
40315
<tag line="1491" name="param" description="currently edited profile" type="\selfServiceProfile" variable="$profile">
38450
40316
<type by_reference="false">\selfServiceProfile</type>
38451
40317
</tag>
38452
<tag line="1333" name="return" description="meta HTML object" type="\htmlElement">
40318
<tag line="1491" name="return" description="meta HTML object" type="\htmlElement">
38453
40319
<type by_reference="false">\htmlElement</type>
38454
40320
</tag>
38455
<tag line="1333" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
38456
<tag line="1333" name="see" description="\global\htmlElement" refers="\global\htmlElement"/>
40321
<tag line="1491" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
40322
<tag line="1491" name="see" description="\global\htmlElement" refers="\global\htmlElement"/>
38457
40323
</docblock>
38458
<argument line="1348">
40324
<argument line="1506">
38459
40325
<name>$profile</name>
38460
40326
<default><![CDATA[]]></default>
38461
40327
<type/>
38462
40328
</argument>
38463
40329
</method>
38464
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1370" package="modules">
40330
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1528" package="modules">
38465
40331
<name>checkSelfServiceSettings</name>
38466
40332
<full_name>checkSelfServiceSettings</full_name>
38467
<docblock line="1357">
40333
<docblock line="1515">
38468
40334
<description><![CDATA[Checks if the self service settings are valid.]]></description>
38469
40335
<long-description><![CDATA[<p>Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
38470
40336
<br>
38471
40337
If the input data is invalid the return value is an array that contains arrays
38472
40338
to build StatusMessages (message type, message head, message text). If no errors
38473
40339
occured the function returns an empty array.</p>]]></long-description>
38474
<tag line="1357" name="param" description="hash array (option name => value) that contains the input. The option values are all arrays containing one or more elements." type="array" variable="$options">
40340
<tag line="1515" name="param" description="hash array (option name => value) that contains the input. The option values are all arrays containing one or more elements." type="array" variable="$options">
38475
40341
<type by_reference="false">array</type>
38476
40342
</tag>
38477
<tag line="1357" name="param" description="self service profile" type="\selfServiceProfile" variable="$profile">
40343
<tag line="1515" name="param" description="self service profile" type="\selfServiceProfile" variable="$profile">
38478
40344
<type by_reference="false">\selfServiceProfile</type>
38479
40345
</tag>
38480
<tag line="1357" name="return" description="error messages" type="array">
40346
<tag line="1515" name="return" description="error messages" type="array">
38481
40347
<type by_reference="false">array</type>
38482
40348
</tag>
38483
40349
</docblock>
38484
<argument line="1370">
40350
<argument line="1528">
38485
40351
<name>$options</name>
38486
40352
<default><![CDATA[]]></default>
38487
40353
<type/>
38488
40354
</argument>
38489
<argument line="1370">
40355
<argument line="1528">
38490
40356
<name>$profile</name>
38491
40357
<default><![CDATA[]]></default>
38492
40358
<type/>
38493
40359
</argument>
38494
40360
</method>
38495
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1383" package="modules">
40361
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1541" package="modules">
38496
40362
<name>preModifySelfService</name>
38497
40363
<full_name>preModifySelfService</full_name>
38498
<docblock line="1375">
40364
<docblock line="1533">
38499
40365
<description><![CDATA[Allows the module to run commands before the LDAP entry is changed or created.]]></description>
38500
40366
<long-description><![CDATA[<p>An error message should be printed if the function returns false.</p>]]></long-description>
38501
<tag line="1375" name="param" description="LDAP attributes of this entry" type="array" variable="$attributes">
40367
<tag line="1533" name="param" description="LDAP attributes of this entry" type="array" variable="$attributes">
38502
40368
<type by_reference="false">array</type>
38503
40369
</tag>
38504
<tag line="1375" name="return" description="true, if no problems occured" type="boolean">
40370
<tag line="1533" name="return" description="true, if no problems occured" type="boolean">
38505
40371
<type by_reference="false">boolean</type>
38506
40372
</tag>
38507
40373
</docblock>
38508
<argument line="1383">
40374
<argument line="1541">
38509
40375
<name>$attributes</name>
38510
40376
<default><![CDATA[]]></default>
38511
40377
<type/>
38512
40378
</argument>
38513
40379
</method>
38514
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1393" package="modules">
40380
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1551" package="modules">
38515
40381
<name>postModifySelfService</name>
38516
40382
<full_name>postModifySelfService</full_name>
38517
<docblock line="1387">
40383
<docblock line="1545">
38518
40384
<description><![CDATA[Allows the module to run commands after the LDAP entry is changed or created.]]></description>
38519
40385
<long-description><![CDATA[]]></long-description>
38520
<tag line="1387" name="param" description="LDAP attributes of this entry" type="array" variable="$attributes">
40386
<tag line="1545" name="param" description="LDAP attributes of this entry" type="array" variable="$attributes">
38521
40387
<type by_reference="false">array</type>
38522
40388
</tag>
38523
<tag line="1387" name="return" description="true, if no problems occured" type="boolean">
40389
<tag line="1545" name="return" description="true, if no problems occured" type="boolean">
38524
40390
<type by_reference="false">boolean</type>
38525
40391
</tag>
38526
40392
</docblock>
38527
<argument line="1393">
40393
<argument line="1551">
38528
40394
<name>$attributes</name>
38529
40395
<default><![CDATA[]]></default>
38530
40396
<type/>
38531
40397
</argument>
38532
40398
</method>
38533
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1406" package="modules">
40399
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1564" package="modules">
38534
40400
<name>getLinkToSpecialSelfServicePage</name>
38535
40401
<full_name>getLinkToSpecialSelfServicePage</full_name>
38536
<docblock line="1397">
40402
<docblock line="1555">
38537
40403
<description><![CDATA[This allows modules to create a link to a module specific page
38538
40404
for the self service.]]></description>
38539
40405
<long-description><![CDATA[<p>The link is shown on the login page of the self service. You
38540
40406
can use this to provide e.g. a page to reset passwords.</p>]]></long-description>
38541
<tag line="1397" name="param" description="self service settings" type="array" variable="$settings">
40407
<tag line="1555" name="param" description="self service settings" type="array" variable="$settings">
38542
40408
<type by_reference="false">array</type>
38543
40409
</tag>
38544
<tag line="1397" name="return" description="link text (null if no special page used)" type="String">
40410
<tag line="1555" name="return" description="link text (null if no special page used)" type="String">
38545
40411
<type by_reference="false">String</type>
38546
40412
</tag>
38547
40413
</docblock>
38548
<argument line="1406">
40414
<argument line="1564">
38549
40415
<name>$settings</name>
38550
40416
<default><![CDATA[]]></default>
38551
40417
<type/>
38552
40418
</argument>
38553
40419
</method>
38554
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1419" package="modules">
40420
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1577" package="modules">
38555
40421
<name>displaySpecialSelfServicePage</name>
38556
40422
<full_name>displaySpecialSelfServicePage</full_name>
38557
<docblock line="1410">
40423
<docblock line="1568">
38558
40424
<description><![CDATA[This function creates meta HTML code to display the module specific page
38559
40425
for the self service.]]></description>
38560
40426
<long-description><![CDATA[]]></long-description>
38561
<tag line="1410" name="param" description="self service settings" type="\selfServiceProfile" variable="$profile">
40427
<tag line="1568" name="param" description="self service settings" type="\selfServiceProfile" variable="$profile">
38562
40428
<type by_reference="false">\selfServiceProfile</type>
38563
40429
</tag>
38564
<tag line="1410" name="return" description="meta HTML object" type="\htmlElement">
40430
<tag line="1568" name="return" description="meta HTML object" type="\htmlElement">
38565
40431
<type by_reference="false">\htmlElement</type>
38566
40432
</tag>
38567
<tag line="1410" name="see" description="\global\htmlElement" refers="\global\htmlElement"/>
40433
<tag line="1568" name="see" description="\global\htmlElement" refers="\global\htmlElement"/>
38568
40434
</docblock>
38569
<argument line="1419">
40435
<argument line="1577">
38570
40436
<name>$profile</name>
38571
40437
<default><![CDATA[]]></default>
38572
40438
<type/>
38573
40439
</argument>
38574
40440
</method>
38575
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1430" package="modules">
40441
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1588" package="modules">
38576
40442
<name>getAccountContainer</name>
38577
40443
<full_name>getAccountContainer</full_name>
38578
<docblock line="1423">
40444
<docblock line="1581">
38579
40445
<description><![CDATA[Returns the {@link accountContainer} object.]]></description>
38580
40446
<long-description><![CDATA[]]></long-description>
38581
<tag line="1423" name="return" description="accountContainer object" type="\accountContainer">
40447
<tag line="1581" name="return" description="accountContainer object" type="\accountContainer">
38582
40448
<type by_reference="false">\accountContainer</type>
38583
40449
</tag>
38584
<tag line="1423" name="see" description="\global\accountContainer" refers="\global\accountContainer"/>
40450
<tag line="1581" name="see" description="\global\accountContainer" refers="\global\accountContainer"/>
38585
40451
</docblock>
38586
40452
</method>
38587
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1444" package="modules">
40453
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1602" package="modules">
38588
40454
<name>getAttributes</name>
38589
40455
<full_name>getAttributes</full_name>
38590
<docblock line="1439">
40456
<docblock line="1597">
38591
40457
<description><![CDATA[Returns the LDAP attributes which are managed in this module.]]></description>
38592
40458
<long-description><![CDATA[]]></long-description>
38593
<tag line="1439" name="return" description="attributes" type="array">
40459
<tag line="1597" name="return" description="attributes" type="array">
38594
40460
<type by_reference="false">array</type>
38595
40461
</tag>
38596
40462
</docblock>
38597
40463
</method>
38598
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1453" package="modules">
40464
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1611" package="modules">
38599
40465
<name>getOriginalAttributes</name>
38600
40466
<full_name>getOriginalAttributes</full_name>
38601
<docblock line="1448">
40467
<docblock line="1606">
38602
40468
<description><![CDATA[Returns the LDAP attributes which are managed in this module (with unchanged values).]]></description>
38603
40469
<long-description><![CDATA[]]></long-description>
38604
<tag line="1448" name="return" description="attributes" type="array">
40470
<tag line="1606" name="return" description="attributes" type="array">
38605
40471
<type by_reference="false">array</type>
38606
40472
</tag>
38607
40473
</docblock>
38608
40474
</method>
38609
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1466" package="modules">
40475
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1624" package="modules">
38610
40476
<name>getIcon</name>
38611
40477
<full_name>getIcon</full_name>
38612
<docblock line="1457">
40478
<docblock line="1615">
38613
40479
<description><![CDATA[Returns the path to the module icon.]]></description>
38614
40480
<long-description><![CDATA[<p>The path must be releative to graphics (e.g. key.png). You can also set $this->meta['icon'].
38615
40481
The preferred size is 32x32px.</p>]]></long-description>
38616
<tag line="1457" name="return" description="" type="\unknown">
40482
<tag line="1615" name="return" description="" type="\unknown">
38617
40483
<type by_reference="false">\unknown</type>
38618
40484
</tag>
38619
<tag line="1457" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
40485
<tag line="1615" name="see" description="\global\baseModule::get_metaData()" refers="\global\baseModule::get_metaData()"/>
38620
40486
</docblock>
38621
40487
</method>
38622
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1477" package="modules">
40488
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1635" package="modules">
38623
40489
<name>handleAjaxRequest</name>
38624
40490
<full_name>handleAjaxRequest</full_name>
38625
<docblock line="1473">
40491
<docblock line="1631">
38626
40492
<description><![CDATA[Manages AJAX requests.]]></description>
38627
40493
<long-description><![CDATA[<p>This function may be called with or without an account container.</p>]]></long-description>
38628
40494
</docblock>
38629
40495
</method>
38630
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1489" package="modules">
40496
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1647" package="modules">
38631
40497
<name>supportsAdminInterface</name>
38632
40498
<full_name>supportsAdminInterface</full_name>
38633
<docblock line="1481">
40499
<docblock line="1639">
38634
40500
<description><![CDATA[Specifies if this module supports the LAM admin interface.]]></description>
38635
40501
<long-description><![CDATA[<p>The LAM admin interface are the pages that allow to manage e.g. users and groups.
38636
40502
In contrast there is also the LAM self service interface. Most modules support
38637
40503
the admin interface.</p>]]></long-description>
38638
<tag line="1481" name="return" description="support admin interface" type="boolean">
40504
<tag line="1639" name="return" description="support admin interface" type="boolean">
38639
40505
<type by_reference="false">boolean</type>
38640
40506
</tag>
38641
40507
</docblock>
38642
40508
</method>
38643
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1504" package="modules">
40509
<method final="false" abstract="false" static="false" visibility="protected" namespace="global" line="1662" package="modules">
38644
40510
<name>isBooleanConfigOptionSet</name>
38645
40511
<full_name>isBooleanConfigOptionSet</full_name>
38646
<docblock line="1497">
40512
<docblock line="1655">
38647
40513
<description><![CDATA[Returns if the given configuration option is set.]]></description>
38648
40514
<long-description><![CDATA[<p>This function returns false if the configuration options cannot be read.</p>]]></long-description>
38649
<tag line="1497" name="param" description="name of the option" type="String" variable="$optionName">
40515
<tag line="1655" name="param" description="name of the option" type="String" variable="$optionName">
38650
40516
<type by_reference="false">String</type>
38651
40517
</tag>
38652
<tag line="1497" name="return" description="true if option is set" type="boolean">
40518
<tag line="1655" name="return" description="true if option is set" type="boolean">
38653
40519
<type by_reference="false">boolean</type>
38654
40520
</tag>
38655
40521
</docblock>
38656
<argument line="1504">
40522
<argument line="1662">
38657
40523
<name>$optionName</name>
38658
40524
<default><![CDATA[]]></default>
38659
40525
<type/>
38660
40526
</argument>
38661
40527
</method>
38662
40528
</class>
40529
<markers>
40530
<todo line="844">workarounds for PDF parser, remove when migrated to other PDF library</todo>
40531
<todo line="848">workaround for UFPDF, remove when migrated to other PDF library</todo>
40532
</markers>
38663
40533
</file>
38664
<file path="lib/status.inc" hash="54f6a4dcfed0df82eb36d8922377fda4" package="lib">
40534
<file path="lib/status.inc" hash="1f334ac451e6f05079f32908146704cf" package="lib">
38665
40535
<docblock line="24">
38666
40536
<description><![CDATA[LDAP Account Manager status messages.]]></description>
38667
40537
<long-description><![CDATA[]]></long-description>
38726
40596
<type/>
38727
40597
</argument>
38728
40598
</function>
38729
<function namespace="global" line="116" package="lib">
40599
<function namespace="global" line="118" package="lib">
38730
40600
<name>parseMessageString</name>
38731
40601
<full_name>\parseMessageString</full_name>
38732
<docblock line="107">
40602
<docblock line="109">
38733
40603
<description><![CDATA[Use the three replace functions on the submitted Text.]]></description>
38734
40604
<long-description><![CDATA[]]></long-description>
38735
<tag line="107" name="access" description="private"/>
38736
<tag line="107" name="param" description="The text that is used to search for replaceable strings." type="string" variable="$MessageString">
40605
<tag line="109" name="access" description="private"/>
40606
<tag line="109" name="param" description="The text that is used to search for replaceable strings." type="string" variable="$MessageString">
38737
40607
<type by_reference="false">string</type>
38738
40608
</tag>
38739
<tag line="107" name="return" description="The processed text." type="string">
40609
<tag line="109" name="return" description="The processed text." type="string">
38740
40610
<type by_reference="false">string</type>
38741
40611
</tag>
38742
40612
</docblock>
38743
<argument line="116">
40613
<argument line="118">
38744
40614
<name>$MessageString</name>
38745
40615
<default><![CDATA[]]></default>
38746
40616
<type/>
38747
40617
</argument>
38748
40618
</function>
38749
<function namespace="global" line="130" package="lib">
40619
<function namespace="global" line="132" package="lib">
38750
40620
<name>boldText</name>
38751
40621
<full_name>\boldText</full_name>
38752
<docblock line="120">
40622
<docblock line="122">
38753
40623
<description><![CDATA[Replace {bold} and {endbold} with <b> and </b> HTML-Tags.]]></description>
38754
40624
<long-description><![CDATA[]]></long-description>
38755
<tag line="120" name="access" description="private"/>
38756
<tag line="120" name="param" description="The text that is used to search for {bold} and {endbold} tags." type="string" variable="$text">
40625
<tag line="122" name="access" description="private"/>
40626
<tag line="122" name="param" description="The text that is used to search for {bold} and {endbold} tags." type="string" variable="$text">
38757
40627
<type by_reference="false">string</type>
38758
40628
</tag>
38759
<tag line="120" name="return" description="The submitted text with {bold} and {endbold} replaced with the appropriate HTML tages <b> and </b>" type="string">
40629
<tag line="122" name="return" description="The submitted text with {bold} and {endbold} replaced with the appropriate HTML tages <b> and </b>" type="string">
38760
40630
<type by_reference="false">string</type>
38761
40631
</tag>
38762
40632
</docblock>
38763
<argument line="130">
40633
<argument line="132">
38764
40634
<name>$text</name>
38765
40635
<default><![CDATA[]]></default>
38766
40636
<type/>
38767
40637
</argument>
38768
40638
</function>
38769
<function namespace="global" line="145" package="lib">
40639
<function namespace="global" line="147" package="lib">
38770
40640
<name>colorText</name>
38771
40641
<full_name>\colorText</full_name>
38772
<docblock line="136">
40642
<docblock line="138">
38773
40643
<description><![CDATA[Replace {color=#[HEX-Value]} or {color=[HEX-Value]} and {endcolor} with <font color="#[HEX-Value]"> and </font> HTML-Tags.]]></description>
38774
40644
<long-description><![CDATA[]]></long-description>
38775
<tag line="136" name="access" description="private"/>
38776
<tag line="136" name="param" description="The text that is used to search for {color} and {endcolor} tags." type="string" variable="$text">
40645
<tag line="138" name="access" description="private"/>
40646
<tag line="138" name="param" description="The text that is used to search for {color} and {endcolor} tags." type="string" variable="$text">
38777
40647
<type by_reference="false">string</type>
38778
40648
</tag>
38779
<tag line="136" name="return" description="Input string with HTML-formatted color tags" type="string">
40649
<tag line="138" name="return" description="Input string with HTML-formatted color tags" type="string">
38780
40650
<type by_reference="false">string</type>
38781
40651
</tag>
38782
40652
</docblock>
38783
<argument line="145">
40653
<argument line="147">
38784
40654
<name>$text</name>
38785
40655
<default><![CDATA[]]></default>
38786
40656
<type/>
38787
40657
</argument>
38788
40658
</function>
38789
<function namespace="global" line="160" package="lib">
40659
<function namespace="global" line="162" package="lib">
38790
40660
<name>linkText</name>
38791
40661
<full_name>\linkText</full_name>
38792
<docblock line="151">
40662
<docblock line="153">
38793
40663
<description><![CDATA[Replace {link=[Link-Target]} and {endlink} with <a href="[Link-Target]" target="_blank"> and </a> HTML-Tags.]]></description>
38794
40664
<long-description><![CDATA[]]></long-description>
38795
<tag line="151" name="access" description="private"/>
38796
<tag line="151" name="param" description="The text that is used to search for {link} and {endlink} tags." type="string" variable="$text">
40665
<tag line="153" name="access" description="private"/>
40666
<tag line="153" name="param" description="The text that is used to search for {link} and {endlink} tags." type="string" variable="$text">
38797
40667
<type by_reference="false">string</type>
38798
40668
</tag>
38799
<tag line="151" name="return" description="Input string with HTML-formatted link tags" type="string">
40669
<tag line="153" name="return" description="Input string with HTML-formatted link tags" type="string">
38800
40670
<type by_reference="false">string</type>
38801
40671
</tag>
38802
40672
</docblock>
38803
<argument line="160">
40673
<argument line="162">
38804
40674
<name>$text</name>
38805
40675
<default><![CDATA[]]></default>
38806
40676
<type/>
38847
40717
</argument>
38848
40718
</function>
38849
40719
</file>
38850
<file path="lib/schema.inc" hash="6903fdd872a60ca8e351f015ad8afe23" package="lib">
40720
<file path="lib/schema.inc" hash="295d59fcfa633bec6a970f3682162638" package="lib">
38851
40721
<docblock line="24">
38852
40722
<description><![CDATA[Classes and functions for fetching and parsing schema from an LDAP server.]]></description>
38853
40723
<long-description><![CDATA[]]></long-description>
38860
40730
<full_name>\SCHEMA_SESSION_CACHE_ENABLED</full_name>
38861
40731
<value><![CDATA[1]]></value>
38862
40732
</constant>
38863
<function namespace="global" line="1267" package="lib">
40733
<function namespace="global" line="1284" package="lib">
38864
40734
<name>_get_schema_dn</name>
38865
40735
<full_name>\_get_schema_dn</full_name>
38866
<docblock line="1254">
40736
<docblock line="1271">
38867
40737
<description><![CDATA[Helper for _get_raw_schema() which fetches the DN of the schema object
38868
40738
in an LDAP server based on a DN.]]></description>
38869
40739
<long-description><![CDATA[<p>Entries should set the subSchemaSubEntry
38870
40740
attribute pointing to the DN of the server schema. You can specify the
38871
40741
DN whose subSchemaSubEntry you wish to retrieve of specify an empty string
38872
40742
to fetch the subScehamSubEntry from the Root DSE.</p>]]></long-description>
38873
<tag line="1254" name="param" description="The DN (may be null) which houses the subschemaSubEntry attribute which this function can use to determine the schema entry's DN." type="string" variable="$dn">
40743
<tag line="1271" name="param" description="The DN (may be null) which houses the subschemaSubEntry attribute which this function can use to determine the schema entry's DN." type="string" variable="$dn">
38874
40744
<type by_reference="false">string</type>
38875
40745
</tag>
38876
<tag line="1254" name="param" description="Switch to true to see some nice and copious output. :)" type="bool" variable="$debug">
40746
<tag line="1271" name="param" description="Switch to true to see some nice and copious output. :)" type="bool" variable="$debug">
38877
40747
<type by_reference="false">bool</type>
38878
40748
</tag>
38879
<tag line="1254" name="return" description="The DN of the entry which houses this LDAP server's schema." type="string">
40749
<tag line="1271" name="return" description="The DN of the entry which houses this LDAP server's schema." type="string">
38880
40750
<type by_reference="false">string</type>
38881
40751
</tag>
38882
40752
</docblock>
38883
<argument line="1267">
40753
<argument line="1284">
38884
40754
<name>$dn</name>
38885
40755
<default><![CDATA[]]></default>
38886
40756
<type/>
38887
40757
</argument>
38888
<argument line="1267">
40758
<argument line="1284">
38889
40759
<name>$debug</name>
38890
40760
<default><![CDATA[false]]></default>
38891
40761
<type/>
38892
40762
</argument>
38893
40763
</function>
38894
<function namespace="global" line="1334" package="lib">
40764
<function namespace="global" line="1351" package="lib">
38895
40765
<name>_get_raw_schema</name>
38896
40766
<full_name>\_get_raw_schema</full_name>
38897
<docblock line="1311">
40767
<docblock line="1328">
38898
40768
<description><![CDATA[Fetches the raw schema array for the subschemaSubentry of the server.]]></description>
38899
40769
<long-description><![CDATA[<p>Note,
38900
40770
this function has grown many hairs to accomodate more LDAP servers. It is
38901
40771
needfully complicated as it now supports many popular LDAP servers that
38902
40772
don't necessarily expose their schema "the right way".</p>]]></long-description>
38903
<tag line="1311" name="param" description="- A string indicating which type of schema to fetch. Five valid values: 'objectclasses', 'attributetypes', 'ldapsyntaxes', 'matchingruleuse', or 'matchingrules'. Case insensitive." type="\$schema_to_fetch" variable="$schema_to_fetch">
40773
<tag line="1328" name="param" description="- A string indicating which type of schema to fetch. Five valid values: 'objectclasses', 'attributetypes', 'ldapsyntaxes', 'matchingruleuse', or 'matchingrules'. Case insensitive." type="\$schema_to_fetch" variable="$schema_to_fetch">
38904
40774
<type by_reference="false">\$schema_to_fetch</type>
38905
40775
</tag>
38906
<tag line="1311" name="param" description="(optional) This paremeter is the DN of the entry whose schema you would like to fetch. Entries have the option of specifying their own subschemaSubentry that points to the DN of the system schema entry which applies to this attribute. If unspecified, this will try to retrieve the schema from the RootDSE subschemaSubentry. Failing that, we use some commonly known schema DNs. Default value is the Root DSE DN (zero-length string)" type="\$dn" variable="$dn">
40776
<tag line="1328" name="param" description="(optional) This paremeter is the DN of the entry whose schema you would like to fetch. Entries have the option of specifying their own subschemaSubentry that points to the DN of the system schema entry which applies to this attribute. If unspecified, this will try to retrieve the schema from the RootDSE subschemaSubentry. Failing that, we use some commonly known schema DNs. Default value is the Root DSE DN (zero-length string)" type="\$dn" variable="$dn">
38907
40777
<type by_reference="false">\$dn</type>
38908
40778
</tag>
38909
<tag line="1311" name="return" description="array of strings of this form: Array ( [0] => "( 1.3.6.1.4.1.7165.1.2.2.4 NAME 'gidPool' DESC 'Pool ... [1] => "( 1.3.6.1.4.1.7165.2.2.3 NAME 'sambaAccount' DESC 'Sa ... etc." type="\an">
40779
<tag line="1328" name="return" description="array of strings of this form: Array ( [0] => "( 1.3.6.1.4.1.7165.1.2.2.4 NAME 'gidPool' DESC 'Pool ... [1] => "( 1.3.6.1.4.1.7165.2.2.3 NAME 'sambaAccount' DESC 'Sa ... etc." type="\an">
38910
40780
<type by_reference="false">\an</type>
38911
40781
</tag>
38912
40782
</docblock>
38913
<argument line="1334">
40783
<argument line="1351">
38914
40784
<name>$schema_to_fetch</name>
38915
40785
<default><![CDATA[]]></default>
38916
40786
<type/>
38917
40787
</argument>
38918
<argument line="1334">
40788
<argument line="1351">
38919
40789
<name>$dn</name>
38920
40790
<default><![CDATA['']]></default>
38921
40791
<type/>
38922
40792
</argument>
38923
40793
</function>
38924
<function namespace="global" line="1525" package="lib">
40794
<function namespace="global" line="1542" package="lib">
38925
40795
<name>get_schema_objectclasses</name>
38926
40796
<full_name>\get_schema_objectclasses</full_name>
38927
<docblock line="1512">
40797
<docblock line="1529">
38928
40798
<description><![CDATA[Gets an associative array of ObjectClass objects for the specified
38929
40799
server.]]></description>
38930
40800
<long-description><![CDATA[<p>Each array entry's key is the name of the objectClass
38931
40801
in lower-case and the value is an ObjectClass object.</p>]]></long-description>
38932
<tag line="1512" name="param" description="(optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should)." type="string" variable="$dn">
40802
<tag line="1529" name="param" description="(optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should)." type="string" variable="$dn">
38933
40803
<type by_reference="false">string</type>
38934
40804
</tag>
38935
<tag line="1512" name="return" description="An array of ObjectClass objects." type="array">
40805
<tag line="1529" name="return" description="An array of ObjectClass objects." type="array">
38936
40806
<type by_reference="false">array</type>
38937
40807
</tag>
38938
<tag line="1512" name="see" description="\global\ObjectClass" refers="\global\ObjectClass"/>
38939
<tag line="1512" name="see" description="\global\get_schema_objectclass" refers="\global\get_schema_objectclass"/>
40808
<tag line="1529" name="see" description="\global\ObjectClass" refers="\global\ObjectClass"/>
40809
<tag line="1529" name="see" description="\global\get_schema_objectclass" refers="\global\get_schema_objectclass"/>
38940
40810
</docblock>
38941
<argument line="1525">
40811
<argument line="1542">
38942
40812
<name>$dn</name>
38943
40813
<default><![CDATA[null]]></default>
38944
40814
<type/>
38945
40815
</argument>
38946
<argument line="1525">
40816
<argument line="1542">
38947
40817
<name>$use_cache</name>
38948
40818
<default><![CDATA[true]]></default>
38949
40819
<type/>
38950
40820
</argument>
38951
40821
</function>
38952
<function namespace="global" line="1565" package="lib">
40822
<function namespace="global" line="1582" package="lib">
38953
40823
<name>get_schema_objectclass</name>
38954
40824
<full_name>\get_schema_objectclass</full_name>
38955
<docblock line="1553">
40825
<docblock line="1570">
38956
40826
<description><![CDATA[Gets a single ObjectClass object specified by name.]]></description>
38957
40827
<long-description><![CDATA[]]></long-description>
38958
<tag line="1553" name="param" description="The name of the objectClass to fetch." type="string" variable="$oclass_name">
38959
<type by_reference="false">string</type>
38960
</tag>
38961
<tag line="1553" name="param" description="(optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should)." type="string" variable="$dn">
38962
<type by_reference="false">string</type>
38963
</tag>
38964
<tag line="1553" name="return" description="The specified ObjectClass object or false on error." type="\ObjectClass">
40828
<tag line="1570" name="param" description="The name of the objectClass to fetch." type="string" variable="$oclass_name">
40829
<type by_reference="false">string</type>
40830
</tag>
40831
<tag line="1570" name="param" description="(optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should)." type="string" variable="$dn">
40832
<type by_reference="false">string</type>
40833
</tag>
40834
<tag line="1570" name="return" description="The specified ObjectClass object or false on error." type="\ObjectClass">
38965
40835
<type by_reference="false">\ObjectClass</type>
38966
40836
</tag>
38967
<tag line="1553" name="see" description="\global\ObjectClass" refers="\global\ObjectClass"/>
38968
<tag line="1553" name="see" description="\global\get_schema_objectclasses" refers="\global\get_schema_objectclasses"/>
40837
<tag line="1570" name="see" description="\global\ObjectClass" refers="\global\ObjectClass"/>
40838
<tag line="1570" name="see" description="\global\get_schema_objectclasses" refers="\global\get_schema_objectclasses"/>
38969
40839
</docblock>
38970
<argument line="1565">
40840
<argument line="1582">
38971
40841
<name>$oclass_name</name>
38972
40842
<default><![CDATA[]]></default>
38973
40843
<type/>
38974
40844
</argument>
38975
<argument line="1565">
40845
<argument line="1582">
38976
40846
<name>$dn</name>
38977
40847
<default><![CDATA[null]]></default>
38978
40848
<type/>
38979
40849
</argument>
38980
<argument line="1565">
40850
<argument line="1582">
38981
40851
<name>$use_cache</name>
38982
40852
<default><![CDATA[true]]></default>
38983
40853
<type/>
38984
40854
</argument>
38985
40855
</function>
38986
<function namespace="global" line="1589" package="lib">
40856
<function namespace="global" line="1606" package="lib">
38987
40857
<name>get_schema_attribute</name>
38988
40858
<full_name>\get_schema_attribute</full_name>
38989
<docblock line="1577">
40859
<docblock line="1594">
38990
40860
<description><![CDATA[Gets a single AttributeType object specified by name.]]></description>
38991
40861
<long-description><![CDATA[]]></long-description>
38992
<tag line="1577" name="param" description="The name of the AttributeType to fetch." type="string" variable="$oclass_name">
38993
<type by_reference="false">string</type>
38994
</tag>
38995
<tag line="1577" name="param" description="(optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should)." type="string" variable="$dn">
38996
<type by_reference="false">string</type>
38997
</tag>
38998
<tag line="1577" name="return" description="The specified AttributeType object or false on error." type="\AttributeType">
40862
<tag line="1594" name="param" description="The name of the AttributeType to fetch." type="string" variable="$oclass_name">
40863
<type by_reference="false">string</type>
40864
</tag>
40865
<tag line="1594" name="param" description="(optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should)." type="string" variable="$dn">
40866
<type by_reference="false">string</type>
40867
</tag>
40868
<tag line="1594" name="return" description="The specified AttributeType object or false on error." type="\AttributeType">
38999
40869
<type by_reference="false">\AttributeType</type>
39000
40870
</tag>
39001
<tag line="1577" name="see" description="\global\AttributeType" refers="\global\AttributeType"/>
39002
<tag line="1577" name="see" description="\global\get_schema_attributes" refers="\global\get_schema_attributes"/>
40871
<tag line="1594" name="see" description="\global\AttributeType" refers="\global\AttributeType"/>
40872
<tag line="1594" name="see" description="\global\get_schema_attributes" refers="\global\get_schema_attributes"/>
39003
40873
</docblock>
39004
<argument line="1589">
40874
<argument line="1606">
39005
40875
<name>$attr_name</name>
39006
40876
<default><![CDATA[]]></default>
39007
40877
<type/>
39008
40878
</argument>
39009
<argument line="1589">
40879
<argument line="1606">
39010
40880
<name>$dn</name>
39011
40881
<default><![CDATA[null]]></default>
39012
40882
<type/>
39013
40883
</argument>
39014
<argument line="1589">
40884
<argument line="1606">
39015
40885
<name>$use_cache</name>
39016
40886
<default><![CDATA[true]]></default>
39017
40887
<type/>
39018
40888
</argument>
39019
40889
</function>
39020
<function namespace="global" line="1610" package="lib">
40890
<function namespace="global" line="1627" package="lib">
39021
40891
<name>get_schema_attributes</name>
39022
40892
<full_name>\get_schema_attributes</full_name>
39023
<docblock line="1600">
40893
<docblock line="1617">
39024
40894
<description><![CDATA[Gets an associative array of AttributeType objects for the specified
39025
40895
server.]]></description>
39026
40896
<long-description><![CDATA[<p>Each array entry's key is the name of the attributeType
39027
40897
in lower-case and the value is an AttributeType object.</p>]]></long-description>
39028
<tag line="1600" name="param" description="(optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should)." type="string" variable="$dn">
40898
<tag line="1617" name="param" description="(optional) It is easier to fetch schema if a DN is provided which defines the subschemaSubEntry attribute (all entries should)." type="string" variable="$dn">
39029
40899
<type by_reference="false">string</type>
39030
40900
</tag>
39031
<tag line="1600" name="return" description="An array of AttributeType objects." type="array">
40901
<tag line="1617" name="return" description="An array of AttributeType objects." type="array">
39032
40902
<type by_reference="false">array</type>
39033
40903
</tag>
39034
40904
</docblock>
39035
<argument line="1610">
40905
<argument line="1627">
39036
40906
<name>$dn</name>
39037
40907
<default><![CDATA[null]]></default>
39038
40908
<type/>
39039
40909
</argument>
39040
<argument line="1610">
40910
<argument line="1627">
39041
40911
<name>$use_cache</name>
39042
40912
<default><![CDATA[true]]></default>
39043
40913
<type/>
39044
40914
</argument>
39045
40915
</function>
39046
<function namespace="global" line="1702" package="lib">
40916
<function namespace="global" line="1719" package="lib">
39047
40917
<name>add_aliases_to_attrs</name>
39048
40918
<full_name>\add_aliases_to_attrs</full_name>
39049
<docblock line="1697">
40919
<docblock line="1714">
39050
40920
<description><![CDATA[For each attribute that has multiple names, this function adds unique entries to
39051
40921
the attrs array for those names.]]></description>
39052
40922
<long-description><![CDATA[<p>Ie, attributeType has name 'gn' and 'givenName'.
39053
40923
This function will create a unique entry for 'gn' and 'givenName'.</p>]]></long-description>
39054
40924
</docblock>
39055
<argument line="1702">
40925
<argument line="1719">
39056
40926
<name>$attrs</name>
39057
40927
<default><![CDATA[]]></default>
39058
40928
<type/>
39059
40929
</argument>
39060
40930
</function>
39061
<function namespace="global" line="1729" package="lib">
40931
<function namespace="global" line="1746" package="lib">
39062
40932
<name>add_sup_to_attrs</name>
39063
40933
<full_name>\add_sup_to_attrs</full_name>
39064
<docblock line="1724">
40934
<docblock line="1741">
39065
40935
<description><![CDATA[Adds inherited values to each attributeType specified by the SUP directive.]]></description>
39066
40936
<long-description><![CDATA[<p>Supports infinite levels of inheritance.
39067
40937
Bug 856832: require a second paramter that has all attributes indexed by OID</p>]]></long-description>
39068
40938
</docblock>
39069
<argument line="1729">
40939
<argument line="1746">
39070
40940
<name>$attrs</name>
39071
40941
<default><![CDATA[]]></default>
39072
40942
<type/>
39073
40943
</argument>
39074
<argument line="1729">
40944
<argument line="1746">
39075
40945
<name>$attrs_oid</name>
39076
40946
<default><![CDATA[]]></default>
39077
40947
<type/>
39078
40948
</argument>
39079
40949
</function>
39080
<function namespace="global" line="1843" package="lib">
40950
<function namespace="global" line="1860" package="lib">
39081
40951
<name>get_schema_matching_rules</name>
39082
40952
<full_name>\get_schema_matching_rules</full_name>
39083
<docblock line="1839">
40953
<docblock line="1856">
39084
40954
<description><![CDATA[Returns an array of MatchingRule objects for the specified server.]]></description>
39085
40955
<long-description><![CDATA[<p>The key of each entry is the OID of the matching rule.</p>]]></long-description>
39086
40956
</docblock>
39087
<argument line="1843">
40957
<argument line="1860">
39088
40958
<name>$dn</name>
39089
40959
<default><![CDATA[null]]></default>
39090
40960
<type/>
39091
40961
</argument>
39092
<argument line="1843">
40962
<argument line="1860">
39093
40963
<name>$use_cache</name>
39094
40964
<default><![CDATA[true]]></default>
39095
40965
<type/>
39096
40966
</argument>
39097
40967
</function>
39098
<function namespace="global" line="1897" package="lib">
40968
<function namespace="global" line="1914" package="lib">
39099
40969
<name>get_schema_syntaxes</name>
39100
40970
<full_name>\get_schema_syntaxes</full_name>
39101
<docblock line="1893">
40971
<docblock line="1910">
39102
40972
<description><![CDATA[Returns an array of Syntax objects that this LDAP server uses mapped to
39103
40973
their descriptions.]]></description>
39104
40974
<long-description><![CDATA[<p>The key of each entry is the OID of the Syntax.</p>]]></long-description>
39105
40975
</docblock>
39106
<argument line="1897">
40976
<argument line="1914">
39107
40977
<name>$dn</name>
39108
40978
<default><![CDATA[null]]></default>
39109
40979
<type/>
39110
40980
</argument>
39111
<argument line="1897">
40981
<argument line="1914">
39112
40982
<name>$use_cache</name>
39113
40983
<default><![CDATA[true]]></default>
39114
40984
<type/>
39115
40985
</argument>
39116
40986
</function>
39117
<function namespace="global" line="1938" package="lib">
40987
<function namespace="global" line="1955" package="lib">
39118
40988
<name>cached_schema_available</name>
39119
40989
<full_name>\cached_schema_available</full_name>
39120
<docblock line="1928">
40990
<docblock line="1945">
39121
40991
<description><![CDATA[Returns true if the schema for $schema_type has been cached and
39122
40992
is availble.]]></description>
39123
40993
<long-description><![CDATA[<p>$schema_type may be one of (lowercase) the following:
39128
40998
matchingruleuse
39129
40999
Note that _get_raw_schema() takes a similar parameter.</p>]]></long-description>
39130
41000
</docblock>
39131
<argument line="1938">
41001
<argument line="1955">
39132
41002
<name>$schema_type</name>
39133
41003
<default><![CDATA[]]></default>
39134
41004
<type/>
39135
41005
</argument>
39136
41006
</function>
39137
<function namespace="global" line="1975" package="lib">
41007
<function namespace="global" line="1992" package="lib">
39138
41008
<name>get_cached_schema</name>
39139
41009
<full_name>\get_cached_schema</full_name>
39140
<docblock line="1964">
41010
<docblock line="1981">
39141
41011
<description><![CDATA[Returns the cached array of schemaitem objects for the specified
39142
41012
$schema_type.]]></description>
39143
41013
<long-description><![CDATA[<p>For list of valid $schema_type values, see above
39149
41019
39150
41020
<p>Returns an array of SchemaItem objects on success or false on failure.</p>]]></long-description>
39151
41021
</docblock>
39152
<argument line="1975">
41022
<argument line="1992">
39153
41023
<name>$schema_type</name>
39154
41024
<default><![CDATA[]]></default>
39155
41025
<type/>
39156
41026
</argument>
39157
41027
</function>
39158
<function namespace="global" line="2006" package="lib">
41028
<function namespace="global" line="2023" package="lib">
39159
41029
<name>set_cached_schema</name>
39160
41030
<full_name>\set_cached_schema</full_name>
39161
<docblock line="1998">
41031
<docblock line="2015">
39162
41032
<description><![CDATA[Caches the specified $schema_type.]]></description>
39163
41033
<long-description><![CDATA[<p>$schema_items should be an array of SchemaItem instances (ie,
39164
41034
an array of ObjectClass, AttributeType, LDAPSyntax, MatchingRuleUse,
39166
41036
39167
41037
<p>Returns true on success of false on failure.</p>]]></long-description>
39168
41038
</docblock>
39169
<argument line="2006">
41039
<argument line="2023">
39170
41040
<name>$schema_type</name>
39171
41041
<default><![CDATA[]]></default>
39172
41042
<type/>
39173
41043
</argument>
39174
<argument line="2006">
41044
<argument line="2023">
39175
41045
<name>$schema_items</name>
39176
41046
<default><![CDATA[]]></default>
39177
41047
<type/>
39178
41048
</argument>
39179
41049
</function>
39180
<function namespace="global" line="2035" package="lib">
41050
<function namespace="global" line="2052" package="lib">
39181
41051
<name>set_schema_cache_unavailable</name>
39182
41052
<full_name>\set_schema_cache_unavailable</full_name>
39183
<docblock line="2030">
41053
<docblock line="2047">
39184
41054
<description><![CDATA[Sets the schema entry for the server_id to be "unavailable" so that we realize
39185
41055
that we tried to get the schema but could not, so quit trying next time to
39186
41056
fetch it from the server.]]></description>
39345
41215
<type/>
39346
41216
</argument>
39347
41217
</method>
39348
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="269" package="lib">
41218
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="286" package="lib">
39349
41219
<name>getMustAttrs</name>
39350
41220
<full_name>getMustAttrs</full_name>
39351
<docblock line="255">
41221
<docblock line="272">
39352
41222
<description><![CDATA[Gets an array of AttributeType objects that entries of this ObjectClass must define.]]></description>
39353
41223
<long-description><![CDATA[<p>This differs from getMustAttrNames in that it returns an array of AttributeType objects</p>]]></long-description>
39354
<tag line="255" name="param" description="An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass requires." type="array" variable="$oclasses">
39355
<type by_reference="false">array</type>
39356
</tag>
39357
<tag line="255" name="return" description="The array of required AttributeType objects." type="array">
39358
<type by_reference="false">array</type>
39359
</tag>
39360
<tag line="255" name="see" description="\global\getMustAttrNames" refers="\global\getMustAttrNames"/>
39361
<tag line="255" name="see" description="\global\getMayAttrs" refers="\global\getMayAttrs"/>
39362
<tag line="255" name="see" description="\global\getMayAttrNames" refers="\global\getMayAttrNames"/>
41224
<tag line="272" name="param" description="An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass requires." type="array" variable="$oclasses">
41225
<type by_reference="false">array</type>
41226
</tag>
41227
<tag line="272" name="return" description="The array of required AttributeType objects." type="array">
41228
<type by_reference="false">array</type>
41229
</tag>
41230
<tag line="272" name="see" description="\global\getMustAttrNames" refers="\global\getMustAttrNames"/>
41231
<tag line="272" name="see" description="\global\getMayAttrs" refers="\global\getMayAttrs"/>
41232
<tag line="272" name="see" description="\global\getMayAttrNames" refers="\global\getMayAttrNames"/>
39363
41233
</docblock>
39364
<argument line="269">
41234
<argument line="286">
39365
41235
<name>$oclasses</name>
39366
41236
<default><![CDATA[NULL]]></default>
39367
41237
<type/>
39368
41238
</argument>
39369
41239
</method>
39370
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="303" package="lib">
41240
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="320" package="lib">
39371
41241
<name>getMayAttrs</name>
39372
41242
<full_name>getMayAttrs</full_name>
39373
<docblock line="288">
41243
<docblock line="305">
39374
41244
<description><![CDATA[Gets an array of AttributeType objects that entries of this ObjectClass may define.]]></description>
39375
41245
<long-description><![CDATA[<p>This differs from getMayAttrNames in that it returns an array of AttributeType objects</p>]]></long-description>
39376
<tag line="288" name="param" description="An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass provides." type="array" variable="$oclasses">
39377
<type by_reference="false">array</type>
39378
</tag>
39379
<tag line="288" name="return" description="The array of allowed AttributeType objects." type="array">
39380
<type by_reference="false">array</type>
39381
</tag>
39382
<tag line="288" name="see" description="\global\getMustAttrNames" refers="\global\getMustAttrNames"/>
39383
<tag line="288" name="see" description="\global\getMustAttrs" refers="\global\getMustAttrs"/>
39384
<tag line="288" name="see" description="\global\getMayAttrNames" refers="\global\getMayAttrNames"/>
39385
<tag line="288" name="see" description="\global\AttributeType" refers="\global\AttributeType"/>
41246
<tag line="305" name="param" description="An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass provides." type="array" variable="$oclasses">
41247
<type by_reference="false">array</type>
41248
</tag>
41249
<tag line="305" name="return" description="The array of allowed AttributeType objects." type="array">
41250
<type by_reference="false">array</type>
41251
</tag>
41252
<tag line="305" name="see" description="\global\getMustAttrNames" refers="\global\getMustAttrNames"/>
41253
<tag line="305" name="see" description="\global\getMustAttrs" refers="\global\getMustAttrs"/>
41254
<tag line="305" name="see" description="\global\getMayAttrNames" refers="\global\getMayAttrNames"/>
41255
<tag line="305" name="see" description="\global\AttributeType" refers="\global\AttributeType"/>
39386
41256
</docblock>
39387
<argument line="303">
41257
<argument line="320">
39388
41258
<name>$oclasses</name>
39389
41259
<default><![CDATA[NULL]]></default>
39390
41260
<type/>
39391
41261
</argument>
39392
41262
</method>
39393
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="337" package="lib">
41263
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="354" package="lib">
39394
41264
<name>getMustAttrNames</name>
39395
41265
<full_name>getMustAttrNames</full_name>
39396
<docblock line="322">
41266
<docblock line="339">
39397
41267
<description><![CDATA[Gets an array of attribute names (strings) that entries of this ObjectClass must define.]]></description>
39398
41268
<long-description><![CDATA[<p>This differs from getMustAttrs in that it returns an array of strings rather than
39399
41269
array of AttributeType objects</p>]]></long-description>
39400
<tag line="322" name="param" description="An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass provides." type="array" variable="$oclasses">
39401
<type by_reference="false">array</type>
39402
</tag>
39403
<tag line="322" name="return" description="The array of allowed attribute names (strings)." type="array">
39404
<type by_reference="false">array</type>
39405
</tag>
39406
<tag line="322" name="see" description="\global\getMustAttrs" refers="\global\getMustAttrs"/>
39407
<tag line="322" name="see" description="\global\getMayAttrs" refers="\global\getMayAttrs"/>
39408
<tag line="322" name="see" description="\global\getMayAttrNames" refers="\global\getMayAttrNames"/>
41270
<tag line="339" name="param" description="An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass provides." type="array" variable="$oclasses">
41271
<type by_reference="false">array</type>
41272
</tag>
41273
<tag line="339" name="return" description="The array of allowed attribute names (strings)." type="array">
41274
<type by_reference="false">array</type>
41275
</tag>
41276
<tag line="339" name="see" description="\global\getMustAttrs" refers="\global\getMustAttrs"/>
41277
<tag line="339" name="see" description="\global\getMayAttrs" refers="\global\getMayAttrs"/>
41278
<tag line="339" name="see" description="\global\getMayAttrNames" refers="\global\getMayAttrNames"/>
39409
41279
</docblock>
39410
<argument line="337">
41280
<argument line="354">
39411
41281
<name>$oclasses</name>
39412
41282
<default><![CDATA[null]]></default>
39413
41283
<type/>
39414
41284
</argument>
39415
41285
</method>
39416
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="361" package="lib">
41286
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="378" package="lib">
39417
41287
<name>getMayAttrNames</name>
39418
41288
<full_name>getMayAttrNames</full_name>
39419
<docblock line="346">
41289
<docblock line="363">
39420
41290
<description><![CDATA[Gets an array of attribute names (strings) that entries of this ObjectClass must define.]]></description>
39421
41291
<long-description><![CDATA[<p>This differs from getMayAttrs in that it returns an array of strings rather than
39422
41292
array of AttributeType objects</p>]]></long-description>
39423
<tag line="346" name="param" description="An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass provides." type="array" variable="$oclasses">
39424
<type by_reference="false">array</type>
39425
</tag>
39426
<tag line="346" name="return" description="The array of allowed attribute names (strings)." type="array">
39427
<type by_reference="false">array</type>
39428
</tag>
39429
<tag line="346" name="see" description="\global\getMustAttrs" refers="\global\getMustAttrs"/>
39430
<tag line="346" name="see" description="\global\getMayAttrs" refers="\global\getMayAttrs"/>
39431
<tag line="346" name="see" description="\global\getMustAttrNames" refers="\global\getMustAttrNames"/>
41293
<tag line="363" name="param" description="An array of ObjectClass objects to use when traversing the inheritance tree. This presents some what of a bootstrapping problem as we must fetch all objectClasses to determine through inheritance which attributes this objectClass provides." type="array" variable="$oclasses">
41294
<type by_reference="false">array</type>
41295
</tag>
41296
<tag line="363" name="return" description="The array of allowed attribute names (strings)." type="array">
41297
<type by_reference="false">array</type>
41298
</tag>
41299
<tag line="363" name="see" description="\global\getMustAttrs" refers="\global\getMustAttrs"/>
41300
<tag line="363" name="see" description="\global\getMayAttrs" refers="\global\getMayAttrs"/>
41301
<tag line="363" name="see" description="\global\getMustAttrNames" refers="\global\getMustAttrNames"/>
39432
41302
</docblock>
39433
<argument line="361">
41303
<argument line="378">
39434
41304
<name>$oclasses</name>
39435
41305
<default><![CDATA[null]]></default>
39436
41306
<type/>
39437
41307
</argument>
39438
41308
</method>
39439
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="376" package="lib">
41309
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="393" package="lib">
39440
41310
<name>addChildObjectClass</name>
39441
41311
<full_name>addChildObjectClass</full_name>
39442
<docblock line="370">
41312
<docblock line="387">
39443
41313
<description><![CDATA[Adds an objectClass to the list of objectClasses that inherit
39444
41314
from this objectClass.]]></description>
39445
41315
<long-description><![CDATA[]]></long-description>
39446
<tag line="370" name="param" description="The name of the objectClass to add" type="String" variable="$object_class_name">
41316
<tag line="387" name="param" description="The name of the objectClass to add" type="String" variable="$object_class_name">
39447
41317
<type by_reference="false">String</type>
39448
41318
</tag>
39449
<tag line="370" name="return" description="Returns true on success or false on failure (objectclass already existed for example)" type="bool">
41319
<tag line="387" name="return" description="Returns true on success or false on failure (objectclass already existed for example)" type="bool">
39450
41320
<type by_reference="false">bool</type>
39451
41321
</tag>
39452
41322
</docblock>
39453
<argument line="376">
41323
<argument line="393">
39454
41324
<name>$object_class_name</name>
39455
41325
<default><![CDATA[]]></default>
39456
41326
<type/>
39457
41327
</argument>
39458
41328
</method>
39459
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="392" package="lib">
41329
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="409" package="lib">
39460
41330
<name>getChildObjectClasses</name>
39461
41331
<full_name>getChildObjectClasses</full_name>
39462
<docblock line="388">
41332
<docblock line="405">
39463
41333
<description><![CDATA[Returns the array of objectClass names which inherit from this objectClass.]]></description>
39464
41334
<long-description><![CDATA[]]></long-description>
39465
<tag line="388" name="return" description="Names of objectClasses which inherit from this objectClass." type="Array">
41335
<tag line="405" name="return" description="Names of objectClasses which inherit from this objectClass." type="Array">
39466
41336
<type by_reference="false">Array</type>
39467
41337
</tag>
39468
41338
</docblock>
39469
41339
</method>
39470
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="401" package="lib">
41340
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="418" package="lib">
39471
41341
<name>getName</name>
39472
41342
<full_name>getName</full_name>
39473
<docblock line="397">
41343
<docblock line="414">
39474
41344
<description><![CDATA[Gets the name of this objectClass (ie, "inetOrgPerson")]]></description>
39475
41345
<long-description><![CDATA[]]></long-description>
39476
<tag line="397" name="return" description="The name of the objectClass" type="string">
41346
<tag line="414" name="return" description="The name of the objectClass" type="string">
39477
41347
<type by_reference="false">string</type>
39478
41348
</tag>
39479
41349
</docblock>
39480
41350
</method>
39481
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="411" package="lib">
41351
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="428" package="lib">
39482
41352
<name>getSupClasses</name>
39483
41353
<full_name>getSupClasses</full_name>
39484
<docblock line="406">
41354
<docblock line="423">
39485
41355
<description><![CDATA[Gets the objectClass names from which this objectClass inherits.]]></description>
39486
41356
<long-description><![CDATA[]]></long-description>
39487
<tag line="406" name="return" description="An array of objectClass names (strings)" type="array">
41357
<tag line="423" name="return" description="An array of objectClass names (strings)" type="array">
39488
41358
<type by_reference="false">array</type>
39489
41359
</tag>
39490
41360
</docblock>
39491
41361
</method>
39492
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="419" package="lib">
41362
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="436" package="lib">
39493
41363
<name>getType</name>
39494
41364
<full_name>getType</full_name>
39495
<docblock line="416">
41365
<docblock line="433">
39496
41366
<description><![CDATA[Gets the type of this objectClass: STRUCTURAL, ABSTRACT, or AUXILIARY.]]></description>
39497
41367
<long-description><![CDATA[]]></long-description>
39498
41368
</docblock>
39499
41369
</method>
39500
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="427" package="lib">
41370
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="444" package="lib">
39501
41371
<name>getIsObsolete</name>
39502
41372
<full_name>getIsObsolete</full_name>
39503
<docblock line="424">
41373
<docblock line="441">
39504
41374
<description><![CDATA[Gets whether this objectClass is flagged as obsolete by the LDAP server.]]></description>
39505
41375
<long-description><![CDATA[]]></long-description>
39506
41376
</docblock>
39507
41377
</method>
39508
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="439" package="lib">
41378
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="456" package="lib">
39509
41379
<name>addMustAttrs</name>
39510
41380
<full_name>addMustAttrs</full_name>
39511
<docblock line="432">
41381
<docblock line="449">
39512
41382
<description><![CDATA[Adds the specified array of attributes to this objectClass' list of
39513
41383
MUST attributes.]]></description>
39514
41384
<long-description><![CDATA[<p>The resulting array of must attributes will contain
39515
41385
unique members.</p>]]></long-description>
39516
<tag line="432" name="param" description="An array of attribute names (strings) to add." type="array" variable="$new_must_attrs">
41386
<tag line="449" name="param" description="An array of attribute names (strings) to add." type="array" variable="$new_must_attrs">
39517
41387
<type by_reference="false">array</type>
39518
41388
</tag>
39519
41389
</docblock>
39520
<argument line="439">
41390
<argument line="456">
39521
41391
<name>$new_must_attrs</name>
39522
41392
<default><![CDATA[]]></default>
39523
41393
<type/>
39524
41394
</argument>
39525
41395
</method>
39526
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="454" package="lib">
41396
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="471" package="lib">
39527
41397
<name>addMayAttrs</name>
39528
41398
<full_name>addMayAttrs</full_name>
39529
<docblock line="448">
41399
<docblock line="465">
39530
41400
<description><![CDATA[Behaves identically to addMustAttrs, but it operates on the MAY
39531
41401
attributes of this objectClass.]]></description>
39532
41402
<long-description><![CDATA[]]></long-description>
39533
<tag line="448" name="param" description="An array of attribute names (strings) to add." type="array" variable="$new_may_attrs">
41403
<tag line="465" name="param" description="An array of attribute names (strings) to add." type="array" variable="$new_may_attrs">
39534
41404
<type by_reference="false">array</type>
39535
41405
</tag>
39536
41406
</docblock>
39537
<argument line="454">
41407
<argument line="471">
39538
41408
<name>$new_may_attrs</name>
39539
41409
<default><![CDATA[]]></default>
39540
41410
<type/>
39541
41411
</argument>
39542
41412
</method>
39543
41413
</class>
39544
<class final="false" abstract="false" namespace="global" line="476" package="lib">
41414
<class final="false" abstract="false" namespace="global" line="493" package="lib">
39545
41415
<extends/>
39546
41416
<name>ObjectClassAttribute</name>
39547
41417
<full_name>\ObjectClassAttribute</full_name>
39548
<docblock line="464">
41418
<docblock line="481">
39549
41419
<description><![CDATA[A simple class for representing AttributeTypes used only by the ObjectClass class.]]></description>
39550
41420
<long-description><![CDATA[<p>Users should never instantiate this class. It represents an attribute internal to
39551
41421
an ObjectClass. If PHP supported inner-classes and variable permissions, this would
39554
41424
a "source" objectClass, meaning that it keeps track of which objectClass originally
39555
41425
specified it. This class is therefore used by the class ObjectClass to determine
39556
41426
inheritance.</p>]]></long-description>
39557
<tag line="464" name="package" description="lib"/>
41427
<tag line="481" name="package" description="lib"/>
39558
41428
</docblock>
39559
<property final="false" static="false" visibility="public" line="479" namespace="global" package="main">
41429
<property final="false" static="false" visibility="public" line="496" namespace="global" package="main">
39560
41430
<name>$name</name>
39561
41431
<default><![CDATA[]]></default>
39562
<docblock line="478">
41432
<docblock line="495">
39563
41433
<description><![CDATA[This Attribute's name]]></description>
39564
41434
<long-description><![CDATA[]]></long-description>
39565
41435
</docblock>
39566
41436
</property>
39567
<property final="false" static="false" visibility="public" line="481" namespace="global" package="main">
41437
<property final="false" static="false" visibility="public" line="498" namespace="global" package="main">
39568
41438
<name>$source</name>
39569
41439
<default><![CDATA[]]></default>
39570
<docblock line="480">
41440
<docblock line="497">
39571
41441
<description><![CDATA[This Attribute's root]]></description>
39572
41442
<long-description><![CDATA[]]></long-description>
39573
41443
</docblock>
39574
41444
</property>
39575
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="489" package="lib">
41445
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="506" package="lib">
39576
41446
<name>ObjectClassAttribute</name>
39577
41447
<full_name>ObjectClassAttribute</full_name>
39578
<docblock line="483">
41448
<docblock line="500">
39579
41449
<description><![CDATA[Creates a new ObjectClassAttribute with specified name and source objectClass.]]></description>
39580
41450
<long-description><![CDATA[]]></long-description>
39581
<tag line="483" name="param" description="the name of the new attribute." type="string" variable="$name">
41451
<tag line="500" name="param" description="the name of the new attribute." type="string" variable="$name">
39582
41452
<type by_reference="false">string</type>
39583
41453
</tag>
39584
<tag line="483" name="param" description="the name of the ObjectClass which specifies this attribute." type="string" variable="$source">
41454
<tag line="500" name="param" description="the name of the ObjectClass which specifies this attribute." type="string" variable="$source">
39585
41455
<type by_reference="false">string</type>
39586
41456
</tag>
39587
41457
</docblock>
39588
<argument line="489">
41458
<argument line="506">
39589
41459
<name>$name</name>
39590
41460
<default><![CDATA[]]></default>
39591
41461
<type/>
39592
41462
</argument>
39593
<argument line="489">
41463
<argument line="506">
39594
41464
<name>$source</name>
39595
41465
<default><![CDATA[]]></default>
39596
41466
<type/>
39597
41467
</argument>
39598
41468
</method>
39599
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="496" package="lib">
41469
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="513" package="lib">
39600
41470
<name>getName</name>
39601
41471
<full_name>getName</full_name>
39602
<docblock line="495">
41472
<docblock line="512">
39603
41473
<description><![CDATA[Gets this attribute's name]]></description>
39604
41474
<long-description><![CDATA[]]></long-description>
39605
41475
</docblock>
39606
41476
</method>
39607
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="502" package="lib">
41477
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="519" package="lib">
39608
41478
<name>getSource</name>
39609
41479
<full_name>getSource</full_name>
39610
<docblock line="501">
41480
<docblock line="518">
39611
41481
<description><![CDATA[Gets the name of the ObjectClass which originally specified this attribute.]]></description>
39612
41482
<long-description><![CDATA[]]></long-description>
39613
41483
</docblock>
39614
41484
</method>
39615
41485
</class>
39616
<class final="false" abstract="false" namespace="global" line="514" package="lib">
41486
<class final="false" abstract="false" namespace="global" line="531" package="lib">
39617
41487
<extends>\SchemaItem</extends>
39618
41488
<name>AttributeType</name>
39619
41489
<full_name>\AttributeType</full_name>
39620
<docblock line="509">
41490
<docblock line="526">
39621
41491
<description><![CDATA[Represents an LDAP AttributeType]]></description>
39622
41492
<long-description><![CDATA[]]></long-description>
39623
<tag line="509" name="package" description="lib"/>
41493
<tag line="526" name="package" description="lib"/>
39624
41494
</docblock>
39625
<property final="false" static="false" visibility="public" line="517" namespace="global" package="main">
41495
<property final="false" static="false" visibility="public" line="534" namespace="global" package="main">
39626
41496
<name>$name</name>
39627
41497
<default><![CDATA[]]></default>
39628
<docblock line="516">
41498
<docblock line="533">
39629
41499
<description><![CDATA[The name of this attributeType]]></description>
39630
41500
<long-description><![CDATA[]]></long-description>
39631
41501
</docblock>
39632
41502
</property>
39633
<property final="false" static="false" visibility="public" line="519" namespace="global" package="main">
41503
<property final="false" static="false" visibility="public" line="536" namespace="global" package="main">
39634
41504
<name>$is_obsolete</name>
39635
41505
<default><![CDATA[]]></default>
39636
<docblock line="518">
41506
<docblock line="535">
39637
41507
<description><![CDATA[string: the description]]></description>
39638
41508
<long-description><![CDATA[]]></long-description>
39639
41509
</docblock>
39640
41510
</property>
39641
<property final="false" static="false" visibility="public" line="521" namespace="global" package="main">
41511
<property final="false" static="false" visibility="public" line="538" namespace="global" package="main">
39642
41512
<name>$sup_attribute</name>
39643
41513
<default><![CDATA[]]></default>
39644
<docblock line="520">
41514
<docblock line="537">
39645
41515
<description><![CDATA[The attribute from which this attribute inherits (if any)]]></description>
39646
41516
<long-description><![CDATA[]]></long-description>
39647
41517
</docblock>
39648
41518
</property>
39649
<property final="false" static="false" visibility="public" line="523" namespace="global" package="main">
41519
<property final="false" static="false" visibility="public" line="540" namespace="global" package="main">
39650
41520
<name>$equality</name>
39651
41521
<default><![CDATA[]]></default>
39652
<docblock line="522">
41522
<docblock line="539">
39653
41523
<description><![CDATA[The equality rule used]]></description>
39654
41524
<long-description><![CDATA[]]></long-description>
39655
41525
</docblock>
39656
41526
</property>
39657
<property final="false" static="false" visibility="public" line="525" namespace="global" package="main">
41527
<property final="false" static="false" visibility="public" line="542" namespace="global" package="main">
39658
41528
<name>$ordering</name>
39659
41529
<default><![CDATA[]]></default>
39660
<docblock line="524">
41530
<docblock line="541">
39661
41531
<description><![CDATA[The ordering of the attributeType]]></description>
39662
41532
<long-description><![CDATA[]]></long-description>
39663
41533
</docblock>
39664
41534
</property>
39665
<property final="false" static="false" visibility="public" line="527" namespace="global" package="main">
41535
<property final="false" static="false" visibility="public" line="544" namespace="global" package="main">
39666
41536
<name>$sub_str</name>
39667
41537
<default><![CDATA[]]></default>
39668
<docblock line="526">
41538
<docblock line="543">
39669
41539
<description><![CDATA[Boolean: supports substring matching?]]></description>
39670
41540
<long-description><![CDATA[]]></long-description>
39671
41541
</docblock>
39672
41542
</property>
39673
<property final="false" static="false" visibility="public" line="529" namespace="global" package="main">
41543
<property final="false" static="false" visibility="public" line="546" namespace="global" package="main">
39674
41544
<name>$syntax</name>
39675
41545
<default><![CDATA[]]></default>
39676
<docblock line="528">
41546
<docblock line="545">
39677
41547
<description><![CDATA[The full syntax string, ie 1.2.3.4{16}]]></description>
39678
41548
<long-description><![CDATA[]]></long-description>
39679
41549
</docblock>
39680
41550
</property>
39681
<property final="false" static="false" visibility="public" line="531" namespace="global" package="main">
41551
<property final="false" static="false" visibility="public" line="548" namespace="global" package="main">
39682
41552
<name>$is_single_value</name>
39683
41553
<default><![CDATA[]]></default>
39684
<docblock line="530">
41554
<docblock line="547">
39685
41555
<description><![CDATA[boolean: is single valued only?]]></description>
39686
41556
<long-description><![CDATA[]]></long-description>
39687
41557
</docblock>
39688
41558
</property>
39689
<property final="false" static="false" visibility="public" line="533" namespace="global" package="main">
41559
<property final="false" static="false" visibility="public" line="550" namespace="global" package="main">
39690
41560
<name>$is_collective</name>
39691
41561
<default><![CDATA[]]></default>
39692
<docblock line="532">
41562
<docblock line="549">
39693
41563
<description><![CDATA[boolean: is collective?]]></description>
39694
41564
<long-description><![CDATA[]]></long-description>
39695
41565
</docblock>
39696
41566
</property>
39697
<property final="false" static="false" visibility="public" line="535" namespace="global" package="main">
41567
<property final="false" static="false" visibility="public" line="552" namespace="global" package="main">
39698
41568
<name>$is_no_user_modification</name>
39699
41569
<default><![CDATA[]]></default>
39700
<docblock line="534">
41570
<docblock line="551">
39701
41571
<description><![CDATA[boolean: can use modify?]]></description>
39702
41572
<long-description><![CDATA[]]></long-description>
39703
41573
</docblock>
39704
41574
</property>
39705
<property final="false" static="false" visibility="public" line="537" namespace="global" package="main">
41575
<property final="false" static="false" visibility="public" line="554" namespace="global" package="main">
39706
41576
<name>$usage</name>
39707
41577
<default><![CDATA[]]></default>
39708
<docblock line="536">
41578
<docblock line="553">
39709
41579
<description><![CDATA[The usage string set by the LDAP schema]]></description>
39710
41580
<long-description><![CDATA[]]></long-description>
39711
41581
</docblock>
39712
41582
</property>
39713
<property final="false" static="false" visibility="public" line="539" namespace="global" package="main">
41583
<property final="false" static="false" visibility="public" line="556" namespace="global" package="main">
39714
41584
<name>$aliases</name>
39715
41585
<default><![CDATA[]]></default>
39716
<docblock line="538">
41586
<docblock line="555">
39717
41587
<description><![CDATA[An array of alias attribute names, strings]]></description>
39718
41588
<long-description><![CDATA[]]></long-description>
39719
41589
</docblock>
39720
41590
</property>
39721
<property final="false" static="false" visibility="public" line="541" namespace="global" package="main">
41591
<property final="false" static="false" visibility="public" line="558" namespace="global" package="main">
39722
41592
<name>$max_length</name>
39723
41593
<default><![CDATA[]]></default>
39724
<docblock line="540">
41594
<docblock line="557">
39725
41595
<description><![CDATA[The max number of characters this attribute can be]]></description>
39726
41596
<long-description><![CDATA[]]></long-description>
39727
41597
</docblock>
39728
41598
</property>
39729
<property final="false" static="false" visibility="public" line="543" namespace="global" package="main">
41599
<property final="false" static="false" visibility="public" line="560" namespace="global" package="main">
39730
41600
<name>$type</name>
39731
41601
<default><![CDATA[]]></default>
39732
<docblock line="542">
41602
<docblock line="559">
39733
41603
<description><![CDATA[A string description of the syntax type (taken from the LDAPSyntaxes)]]></description>
39734
41604
<long-description><![CDATA[]]></long-description>
39735
41605
</docblock>
39736
41606
</property>
39737
<property final="false" static="false" visibility="public" line="545" namespace="global" package="main">
41607
<property final="false" static="false" visibility="public" line="562" namespace="global" package="main">
39738
41608
<name>$used_in_object_classes</name>
39739
41609
<default><![CDATA[]]></default>
39740
<docblock line="544">
41610
<docblock line="561">
39741
41611
<description><![CDATA[An array of objectClasses which use this attributeType (must be set by caller)]]></description>
39742
41612
<long-description><![CDATA[]]></long-description>
39743
41613
</docblock>
39744
41614
</property>
39745
<property final="false" static="false" visibility="public" line="547" namespace="global" package="main">
41615
<property final="false" static="false" visibility="public" line="564" namespace="global" package="main">
39746
41616
<name>$required_by_object_classes</name>
39747
41617
<default><![CDATA[array()]]></default>
39748
<docblock line="546">
41618
<docblock line="563">
39749
41619
<description><![CDATA[A list of object class names that require this attribute type.]]></description>
39750
41620
<long-description><![CDATA[]]></long-description>
39751
41621
</docblock>
39752
41622
</property>
39753
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="552" package="lib">
41623
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="569" package="lib">
39754
41624
<name>initVars</name>
39755
41625
<full_name>initVars</full_name>
39756
<docblock line="549">
41626
<docblock line="566">
39757
41627
<description><![CDATA[Initialize the class' member variables]]></description>
39758
41628
<long-description><![CDATA[]]></long-description>
39759
41629
</docblock>
39760
41630
</method>
39761
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="579" package="lib">
41631
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="596" package="lib">
39762
41632
<name>AttributeType</name>
39763
41633
<full_name>AttributeType</full_name>
39764
<docblock line="576">
41634
<docblock line="593">
39765
41635
<description><![CDATA[Creates a new AttributeType objcet from a raw LDAP AttributeType string.]]></description>
39766
41636
<long-description><![CDATA[]]></long-description>
39767
41637
</docblock>
39768
<argument line="579">
41638
<argument line="596">
39769
41639
<name>$raw_ldap_attr_string</name>
39770
41640
<default><![CDATA[]]></default>
39771
41641
<type/>
39772
41642
</argument>
39773
41643
</method>
39774
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="696" package="lib">
41644
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="713" package="lib">
39775
41645
<name>getName</name>
39776
41646
<full_name>getName</full_name>
39777
<docblock line="692">
41647
<docblock line="709">
39778
41648
<description><![CDATA[Gets this attribute's name]]></description>
39779
41649
<long-description><![CDATA[]]></long-description>
39780
<tag line="692" name="return" description="" type="string">
41650
<tag line="709" name="return" description="" type="string">
39781
41651
<type by_reference="false">string</type>
39782
41652
</tag>
39783
41653
</docblock>
39784
41654
</method>
39785
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="705" package="lib">
41655
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="722" package="lib">
39786
41656
<name>getIsObsolete</name>
39787
41657
<full_name>getIsObsolete</full_name>
39788
<docblock line="701">
41658
<docblock line="718">
39789
41659
<description><![CDATA[Gets whether this attribute has been flagged as obsolete by the LDAP server]]></description>
39790
41660
<long-description><![CDATA[]]></long-description>
39791
<tag line="701" name="return" description="" type="bool">
41661
<tag line="718" name="return" description="" type="bool">
39792
41662
<type by_reference="false">bool</type>
39793
41663
</tag>
39794
41664
</docblock>
39795
41665
</method>
39796
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="714" package="lib">
41666
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="731" package="lib">
39797
41667
<name>getUsage</name>
39798
41668
<full_name>getUsage</full_name>
39799
<docblock line="710">
41669
<docblock line="727">
39800
41670
<description><![CDATA[Gets this attribute's usage string as defined by the LDAP server]]></description>
39801
41671
<long-description><![CDATA[]]></long-description>
39802
<tag line="710" name="return" description="" type="string">
41672
<tag line="727" name="return" description="" type="string">
39803
41673
<type by_reference="false">string</type>
39804
41674
</tag>
39805
41675
</docblock>
39806
41676
</method>
39807
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="724" package="lib">
41677
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="741" package="lib">
39808
41678
<name>getSupAttribute</name>
39809
41679
<full_name>getSupAttribute</full_name>
39810
<docblock line="719">
41680
<docblock line="736">
39811
41681
<description><![CDATA[Gets this attribute's parent attribute (if any).]]></description>
39812
41682
<long-description><![CDATA[<p>If this attribute does not
39813
41683
inherit from another attribute, null is returned.</p>]]></long-description>
39814
<tag line="719" name="return" description="" type="string">
41684
<tag line="736" name="return" description="" type="string">
39815
41685
<type by_reference="false">string</type>
39816
41686
</tag>
39817
41687
</docblock>
39818
41688
</method>
39819
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="733" package="lib">
41689
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="750" package="lib">
39820
41690
<name>getEquality</name>
39821
41691
<full_name>getEquality</full_name>
39822
<docblock line="729">
41692
<docblock line="746">
39823
41693
<description><![CDATA[Gets this attribute's equality string]]></description>
39824
41694
<long-description><![CDATA[]]></long-description>
39825
<tag line="729" name="return" description="" type="string">
41695
<tag line="746" name="return" description="" type="string">
39826
41696
<type by_reference="false">string</type>
39827
41697
</tag>
39828
41698
</docblock>
39829
41699
</method>
39830
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="742" package="lib">
41700
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="759" package="lib">
39831
41701
<name>getOrdering</name>
39832
41702
<full_name>getOrdering</full_name>
39833
<docblock line="738">
41703
<docblock line="755">
39834
41704
<description><![CDATA[Gets this attribute's ordering specification.]]></description>
39835
41705
<long-description><![CDATA[]]></long-description>
39836
<tag line="738" name="return" description="" type="string">
41706
<tag line="755" name="return" description="" type="string">
39837
41707
<type by_reference="false">string</type>
39838
41708
</tag>
39839
41709
</docblock>
39840
41710
</method>
39841
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="751" package="lib">
41711
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="768" package="lib">
39842
41712
<name>getSubstr</name>
39843
41713
<full_name>getSubstr</full_name>
39844
<docblock line="747">
41714
<docblock line="764">
39845
41715
<description><![CDATA[Gets this attribute's substring matching specification]]></description>
39846
41716
<long-description><![CDATA[]]></long-description>
39847
<tag line="747" name="return" description="" type="string">
41717
<tag line="764" name="return" description="" type="string">
39848
41718
<type by_reference="false">string</type>
39849
41719
</tag>
39850
41720
</docblock>
39851
41721
</method>
39852
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="761" package="lib">
41722
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="778" package="lib">
39853
41723
<name>getAliases</name>
39854
41724
<full_name>getAliases</full_name>
39855
<docblock line="756">
41725
<docblock line="773">
39856
41726
<description><![CDATA[Gets the names of attributes that are an alias for this attribute (if any).]]></description>
39857
41727
<long-description><![CDATA[]]></long-description>
39858
<tag line="756" name="return" description="An array of names of attributes which alias this attribute or an empty array if no attribute aliases this object." type="array">
41728
<tag line="773" name="return" description="An array of names of attributes which alias this attribute or an empty array if no attribute aliases this object." type="array">
39859
41729
<type by_reference="false">array</type>
39860
41730
</tag>
39861
41731
</docblock>
39862
41732
</method>
39863
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="771" package="lib">
41733
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="788" package="lib">
39864
41734
<name>isAliasFor</name>
39865
41735
<full_name>isAliasFor</full_name>
39866
<docblock line="766">
41736
<docblock line="783">
39867
41737
<description><![CDATA[Returns whether the specified attribute is an alias for this one (based on this attribute's alias list).]]></description>
39868
41738
<long-description><![CDATA[]]></long-description>
39869
<tag line="766" name="param" description="The name of the attribute to check." type="string" variable="$attr_name">
41739
<tag line="783" name="param" description="The name of the attribute to check." type="string" variable="$attr_name">
39870
41740
<type by_reference="false">string</type>
39871
41741
</tag>
39872
<tag line="766" name="return" description="True if the specified attribute is an alias for this one, or false otherwise." type="bool">
41742
<tag line="783" name="return" description="True if the specified attribute is an alias for this one, or false otherwise." type="bool">
39873
41743
<type by_reference="false">bool</type>
39874
41744
</tag>
39875
41745
</docblock>
39876
<argument line="771">
41746
<argument line="788">
39877
41747
<name>$attr_name</name>
39878
41748
<default><![CDATA[]]></default>
39879
41749
<type/>
39880
41750
</argument>
39881
41751
</method>
39882
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="784" package="lib">
41752
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="801" package="lib">
39883
41753
<name>getSyntaxString</name>
39884
41754
<full_name>getSyntaxString</full_name>
39885
<docblock line="780">
41755
<docblock line="797">
39886
41756
<description><![CDATA[Gets this attribute's raw syntax string (ie: "1.2.3.4{16}").]]></description>
39887
41757
<long-description><![CDATA[]]></long-description>
39888
<tag line="780" name="return" description="The raw syntax string" type="string">
41758
<tag line="797" name="return" description="The raw syntax string" type="string">
39889
41759
<type by_reference="false">string</type>
39890
41760
</tag>
39891
41761
</docblock>
39892
41762
</method>
39893
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="796" package="lib">
41763
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="813" package="lib">
39894
41764
<name>getSyntaxOID</name>
39895
41765
<full_name>getSyntaxOID</full_name>
39896
<docblock line="789">
41766
<docblock line="806">
39897
41767
<description><![CDATA[Gets this attribute's syntax OID.]]></description>
39898
41768
<long-description><![CDATA[<p>Differs from getSyntaxString() in that this
39899
41769
function only returns the actual OID with any length specification removed.
39900
41770
Ie, if the syntax string is "1.2.3.4{16}", this function only retruns
39901
41771
"1.2.3.4".</p>]]></long-description>
39902
<tag line="789" name="return" description="The syntax OID string." type="string">
41772
<tag line="806" name="return" description="The syntax OID string." type="string">
39903
41773
<type by_reference="false">string</type>
39904
41774
</tag>
39905
41775
</docblock>
39906
41776
</method>
39907
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="805" package="lib">
41777
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="822" package="lib">
39908
41778
<name>getMaxLength</name>
39909
41779
<full_name>getMaxLength</full_name>
39910
<docblock line="801">
41780
<docblock line="818">
39911
41781
<description><![CDATA[Gets this attribute's the maximum length.]]></description>
39912
41782
<long-description><![CDATA[<p>If no maximum is defined by the LDAP server, null is returned.</p>]]></long-description>
39913
<tag line="801" name="return" description="The maximum length (in characters) of this attribute or null if no maximum is specified." type="int">
41783
<tag line="818" name="return" description="The maximum length (in characters) of this attribute or null if no maximum is specified." type="int">
39914
41784
<type by_reference="false">int</type>
39915
41785
</tag>
39916
41786
</docblock>
39917
41787
</method>
39918
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="815" package="lib">
41788
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="832" package="lib">
39919
41789
<name>getIsSingleValue</name>
39920
41790
<full_name>getIsSingleValue</full_name>
39921
<docblock line="810">
41791
<docblock line="827">
39922
41792
<description><![CDATA[Gets whether this attribute is single-valued.]]></description>
39923
41793
<long-description><![CDATA[<p>If this attribute only supports single values, true
39924
41794
is returned. If this attribute supports multiple values, false is returned.</p>]]></long-description>
39925
<tag line="810" name="return" description="Returns true if this attribute is single-valued or false otherwise." type="bool">
41795
<tag line="827" name="return" description="Returns true if this attribute is single-valued or false otherwise." type="bool">
39926
41796
<type by_reference="false">bool</type>
39927
41797
</tag>
39928
41798
</docblock>
39929
41799
</method>
39930
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="824" package="lib">
41800
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="841" package="lib">
39931
41801
<name>setIsSingleValue</name>
39932
41802
<full_name>setIsSingleValue</full_name>
39933
<docblock line="820">
41803
<docblock line="837">
39934
41804
<description><![CDATA[Sets whether this attribute is single-valued.]]></description>
39935
41805
<long-description><![CDATA[]]></long-description>
39936
<tag line="820" name="param" description="" type="bool" variable="$is_single_value">
41806
<tag line="837" name="param" description="" type="bool" variable="$is_single_value">
39937
41807
<type by_reference="false">bool</type>
39938
41808
</tag>
39939
41809
</docblock>
39940
<argument line="824">
41810
<argument line="841">
39941
41811
<name>$is_single_value</name>
39942
41812
<default><![CDATA[]]></default>
39943
41813
<type/>
39944
41814
</argument>
39945
41815
</method>
39946
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="833" package="lib">
41816
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="850" package="lib">
39947
41817
<name>getIsCollective</name>
39948
41818
<full_name>getIsCollective</full_name>
39949
<docblock line="829">
41819
<docblock line="846">
39950
41820
<description><![CDATA[Gets whether this attribute is collective.]]></description>
39951
41821
<long-description><![CDATA[]]></long-description>
39952
<tag line="829" name="return" description="Returns true if this attribute is collective and false otherwise." type="bool">
41822
<tag line="846" name="return" description="Returns true if this attribute is collective and false otherwise." type="bool">
39953
41823
<type by_reference="false">bool</type>
39954
41824
</tag>
39955
41825
</docblock>
39956
41826
</method>
39957
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="842" package="lib">
41827
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="859" package="lib">
39958
41828
<name>getIsNoUserModification</name>
39959
41829
<full_name>getIsNoUserModification</full_name>
39960
<docblock line="838">
41830
<docblock line="855">
39961
41831
<description><![CDATA[Gets whether this attribute is not modifiable by users.]]></description>
39962
41832
<long-description><![CDATA[]]></long-description>
39963
<tag line="838" name="return" description="Returns true if this attribute is not modifiable by users." type="bool">
41833
<tag line="855" name="return" description="Returns true if this attribute is not modifiable by users." type="bool">
39964
41834
<type by_reference="false">bool</type>
39965
41835
</tag>
39966
41836
</docblock>
39967
41837
</method>
39968
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="851" package="lib">
41838
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="868" package="lib">
39969
41839
<name>getType</name>
39970
41840
<full_name>getType</full_name>
39971
<docblock line="847">
41841
<docblock line="864">
39972
41842
<description><![CDATA[Gets this attribute's type]]></description>
39973
41843
<long-description><![CDATA[]]></long-description>
39974
<tag line="847" name="return" description="The attribute's type." type="string">
41844
<tag line="864" name="return" description="The attribute's type." type="string">
39975
41845
<type by_reference="false">string</type>
39976
41846
</tag>
39977
41847
</docblock>
39978
41848
</method>
39979
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="862" package="lib">
41849
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="879" package="lib">
39980
41850
<name>removeAlias</name>
39981
41851
<full_name>removeAlias</full_name>
39982
<docblock line="856">
41852
<docblock line="873">
39983
41853
<description><![CDATA[Removes an attribute name from this attribute's alias array.]]></description>
39984
41854
<long-description><![CDATA[]]></long-description>
39985
<tag line="856" name="param" description="The name of the attribute to remove." type="string" variable="$remove_alias_name">
41855
<tag line="873" name="param" description="The name of the attribute to remove." type="string" variable="$remove_alias_name">
39986
41856
<type by_reference="false">string</type>
39987
41857
</tag>
39988
<tag line="856" name="return" description="true on success or false on failure (ie, if the specified attribute name is not found in this attribute's list of aliases)" type="bool">
41858
<tag line="873" name="return" description="true on success or false on failure (ie, if the specified attribute name is not found in this attribute's list of aliases)" type="bool">
39989
41859
<type by_reference="false">bool</type>
39990
41860
</tag>
39991
41861
</docblock>
39992
<argument line="862">
41862
<argument line="879">
39993
41863
<name>$remove_alias_name</name>
39994
41864
<default><![CDATA[]]></default>
39995
41865
<type/>
39996
41866
</argument>
39997
41867
</method>
39998
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="878" package="lib">
41868
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="895" package="lib">
39999
41869
<name>addAlias</name>
40000
41870
<full_name>addAlias</full_name>
40001
<docblock line="874">
41871
<docblock line="891">
40002
41872
<description><![CDATA[Adds an attribute name to the alias array.]]></description>
40003
41873
<long-description><![CDATA[]]></long-description>
40004
<tag line="874" name="param" description="The name of a new attribute to add to this attribute's list of aliases." type="string" variable="$new_alias_name">
41874
<tag line="891" name="param" description="The name of a new attribute to add to this attribute's list of aliases." type="string" variable="$new_alias_name">
40005
41875
<type by_reference="false">string</type>
40006
41876
</tag>
40007
41877
</docblock>
40008
<argument line="878">
41878
<argument line="895">
40009
41879
<name>$new_alias_name</name>
40010
41880
<default><![CDATA[]]></default>
40011
41881
<type/>
40012
41882
</argument>
40013
41883
</method>
40014
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="887" package="lib">
41884
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="904" package="lib">
40015
41885
<name>setName</name>
40016
41886
<full_name>setName</full_name>
40017
<docblock line="883">
41887
<docblock line="900">
40018
41888
<description><![CDATA[Sets this attriute's name.]]></description>
40019
41889
<long-description><![CDATA[]]></long-description>
40020
<tag line="883" name="param" description="The new name to give this attribute." type="string" variable="$new_name">
41890
<tag line="900" name="param" description="The new name to give this attribute." type="string" variable="$new_name">
40021
41891
<type by_reference="false">string</type>
40022
41892
</tag>
40023
41893
</docblock>
40024
<argument line="887">
41894
<argument line="904">
40025
41895
<name>$new_name</name>
40026
41896
<default><![CDATA[]]></default>
40027
41897
<type/>
40028
41898
</argument>
40029
41899
</method>
40030
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="896" package="lib">
41900
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="913" package="lib">
40031
41901
<name>setSupAttribute</name>
40032
41902
<full_name>setSupAttribute</full_name>
40033
<docblock line="892">
41903
<docblock line="909">
40034
41904
<description><![CDATA[Sets this attriute's SUP attribute (ie, the attribute from which this attribute inherits).]]></description>
40035
41905
<long-description><![CDATA[]]></long-description>
40036
<tag line="892" name="param" description="The name of the new parent (SUP) attribute" type="string" variable="$new_sup_attr">
41906
<tag line="909" name="param" description="The name of the new parent (SUP) attribute" type="string" variable="$new_sup_attr">
40037
41907
<type by_reference="false">string</type>
40038
41908
</tag>
40039
41909
</docblock>
40040
<argument line="896">
41910
<argument line="913">
40041
41911
<name>$new_sup_attr</name>
40042
41912
<default><![CDATA[]]></default>
40043
41913
<type/>
40044
41914
</argument>
40045
41915
</method>
40046
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="905" package="lib">
41916
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="922" package="lib">
40047
41917
<name>setAliases</name>
40048
41918
<full_name>setAliases</full_name>
40049
<docblock line="901">
41919
<docblock line="918">
40050
41920
<description><![CDATA[Sets this attribute's list of aliases.]]></description>
40051
41921
<long-description><![CDATA[]]></long-description>
40052
<tag line="901" name="param" description="The array of alias names (strings)" type="array" variable="$new_aliases">
41922
<tag line="918" name="param" description="The array of alias names (strings)" type="array" variable="$new_aliases">
40053
41923
<type by_reference="false">array</type>
40054
41924
</tag>
40055
41925
</docblock>
40056
<argument line="905">
41926
<argument line="922">
40057
41927
<name>$new_aliases</name>
40058
41928
<default><![CDATA[]]></default>
40059
41929
<type/>
40060
41930
</argument>
40061
41931
</method>
40062
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="914" package="lib">
41932
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="931" package="lib">
40063
41933
<name>setType</name>
40064
41934
<full_name>setType</full_name>
40065
<docblock line="910">
41935
<docblock line="927">
40066
41936
<description><![CDATA[Sets this attribute's type.]]></description>
40067
41937
<long-description><![CDATA[]]></long-description>
40068
<tag line="910" name="param" description="The new type." type="string" variable="$new_type">
41938
<tag line="927" name="param" description="The new type." type="string" variable="$new_type">
40069
41939
<type by_reference="false">string</type>
40070
41940
</tag>
40071
41941
</docblock>
40072
<argument line="914">
41942
<argument line="931">
40073
41943
<name>$new_type</name>
40074
41944
<default><![CDATA[]]></default>
40075
41945
<type/>
40076
41946
</argument>
40077
41947
</method>
40078
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="924" package="lib">
41948
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="941" package="lib">
40079
41949
<name>addUsedInObjectClass</name>
40080
41950
<full_name>addUsedInObjectClass</full_name>
40081
<docblock line="919">
41951
<docblock line="936">
40082
41952
<description><![CDATA[Adds an objectClass name to this attribute's list of "used in" objectClasses,
40083
41953
that is the list of objectClasses which provide this attribute.]]></description>
40084
41954
<long-description><![CDATA[]]></long-description>
40085
<tag line="919" name="param" description="The name of the objectClass to add." type="string" variable="$object_class_name">
41955
<tag line="936" name="param" description="The name of the objectClass to add." type="string" variable="$object_class_name">
40086
41956
<type by_reference="false">string</type>
40087
41957
</tag>
40088
41958
</docblock>
40089
<argument line="924">
41959
<argument line="941">
40090
41960
<name>$object_class_name</name>
40091
41961
<default><![CDATA[]]></default>
40092
41962
<type/>
40093
41963
</argument>
40094
41964
</method>
40095
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="938" package="lib">
41965
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="955" package="lib">
40096
41966
<name>getUsedInObjectClasses</name>
40097
41967
<full_name>getUsedInObjectClasses</full_name>
40098
<docblock line="933">
41968
<docblock line="950">
40099
41969
<description><![CDATA[Gets the list of "used in" objectClasses, that is the list of objectClasses
40100
41970
which provide this attribute.]]></description>
40101
41971
<long-description><![CDATA[]]></long-description>
40102
<tag line="933" name="return" description="An array of names of objectclasses (strings) which provide this attribute" type="array">
41972
<tag line="950" name="return" description="An array of names of objectclasses (strings) which provide this attribute" type="array">
40103
41973
<type by_reference="false">array</type>
40104
41974
</tag>
40105
41975
</docblock>
40106
41976
</method>
40107
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="948" package="lib">
41977
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="965" package="lib">
40108
41978
<name>addRequiredByObjectClass</name>
40109
41979
<full_name>addRequiredByObjectClass</full_name>
40110
<docblock line="943">
41980
<docblock line="960">
40111
41981
<description><![CDATA[Adds an objectClass name to this attribute's list of "required by" objectClasses,
40112
41982
that is the list of objectClasses which must have this attribute.]]></description>
40113
41983
<long-description><![CDATA[]]></long-description>
40114
<tag line="943" name="param" description="The name of the objectClass to add." type="string" variable="$object_class_name">
41984
<tag line="960" name="param" description="The name of the objectClass to add." type="string" variable="$object_class_name">
40115
41985
<type by_reference="false">string</type>
40116
41986
</tag>
40117
41987
</docblock>
40118
<argument line="948">
41988
<argument line="965">
40119
41989
<name>$object_class_name</name>
40120
41990
<default><![CDATA[]]></default>
40121
41991
<type/>
40122
41992
</argument>
40123
41993
</method>
40124
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="962" package="lib">
41994
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="979" package="lib">
40125
41995
<name>getRequiredByObjectClasses</name>
40126
41996
<full_name>getRequiredByObjectClasses</full_name>
40127
<docblock line="957">
41997
<docblock line="974">
40128
41998
<description><![CDATA[Gets the list of "required by" objectClasses, that is the list of objectClasses
40129
41999
which provide must have attribute.]]></description>
40130
42000
<long-description><![CDATA[]]></long-description>
40131
<tag line="957" name="return" description="An array of names of objectclasses (strings) which provide this attribute" type="array">
42001
<tag line="974" name="return" description="An array of names of objectclasses (strings) which provide this attribute" type="array">
40132
42002
<type by_reference="false">array</type>
40133
42003
</tag>
40134
42004
</docblock>
40135
42005
</method>
40136
42006
</class>
40137
<class final="false" abstract="false" namespace="global" line="973" package="lib">
42007
<class final="false" abstract="false" namespace="global" line="990" package="lib">
40138
42008
<extends>\SchemaItem</extends>
40139
42009
<name>Syntax</name>
40140
42010
<full_name>\Syntax</full_name>
40141
<docblock line="968">
42011
<docblock line="985">
40142
42012
<description><![CDATA[Represents an LDAP Syntax]]></description>
40143
42013
<long-description><![CDATA[]]></long-description>
40144
<tag line="968" name="package" description="lib"/>
42014
<tag line="985" name="package" description="lib"/>
40145
42015
</docblock>
40146
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="976" package="lib">
42016
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="993" package="lib">
40147
42017
<name>initVars</name>
40148
42018
<full_name>initVars</full_name>
40149
<docblock line="975">
42019
<docblock line="992">
40150
42020
<description><![CDATA[Initializes the class' member variables]]></description>
40151
42021
<long-description><![CDATA[]]></long-description>
40152
42022
</docblock>
40153
42023
</method>
40154
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="986" package="lib">
42024
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1003" package="lib">
40155
42025
<name>Syntax</name>
40156
42026
<full_name>Syntax</full_name>
40157
<docblock line="983">
42027
<docblock line="1000">
40158
42028
<description><![CDATA[Creates a new Syntax object from a raw LDAP syntax string.]]></description>
40159
42029
<long-description><![CDATA[]]></long-description>
40160
42030
</docblock>
40161
<argument line="986">
42031
<argument line="1003">
40162
42032
<name>$raw_ldap_syntax_string</name>
40163
42033
<default><![CDATA[]]></default>
40164
42034
<type/>
40165
42035
</argument>
40166
42036
</method>
40167
42037
</class>
40168
<class final="false" abstract="false" namespace="global" line="1019" package="lib">
42038
<class final="false" abstract="false" namespace="global" line="1036" package="lib">
40169
42039
<extends>\SchemaItem</extends>
40170
42040
<name>MatchingRule</name>
40171
42041
<full_name>\MatchingRule</full_name>
40172
<docblock line="1014">
42042
<docblock line="1031">
40173
42043
<description><![CDATA[Represents an LDAP MatchingRule]]></description>
40174
42044
<long-description><![CDATA[]]></long-description>
40175
<tag line="1014" name="package" description="lib"/>
42045
<tag line="1031" name="package" description="lib"/>
40176
42046
</docblock>
40177
<property final="false" static="false" visibility="public" line="1022" namespace="global" package="main">
42047
<property final="false" static="false" visibility="public" line="1039" namespace="global" package="main">
40178
42048
<name>$name</name>
40179
42049
<default><![CDATA[]]></default>
40180
<docblock line="1021">
42050
<docblock line="1038">
40181
42051
<description><![CDATA[This rule's name]]></description>
40182
42052
<long-description><![CDATA[]]></long-description>
40183
42053
</docblock>
40184
42054
</property>
40185
<property final="false" static="false" visibility="public" line="1024" namespace="global" package="main">
42055
<property final="false" static="false" visibility="public" line="1041" namespace="global" package="main">
40186
42056
<name>$syntax</name>
40187
42057
<default><![CDATA[]]></default>
40188
<docblock line="1023">
42058
<docblock line="1040">
40189
42059
<description><![CDATA[This rule's syntax OID]]></description>
40190
42060
<long-description><![CDATA[]]></long-description>
40191
42061
</docblock>
40192
42062
</property>
40193
<property final="false" static="false" visibility="public" line="1026" namespace="global" package="main">
42063
<property final="false" static="false" visibility="public" line="1043" namespace="global" package="main">
40194
42064
<name>$is_obsolete</name>
40195
42065
<default><![CDATA[]]></default>
40196
<docblock line="1025">
42066
<docblock line="1042">
40197
42067
<description><![CDATA[Boolean value indicating whether this MatchingRule is obsolete]]></description>
40198
42068
<long-description><![CDATA[]]></long-description>
40199
42069
</docblock>
40200
42070
</property>
40201
<property final="false" static="false" visibility="public" line="1028" namespace="global" package="main">
42071
<property final="false" static="false" visibility="public" line="1045" namespace="global" package="main">
40202
42072
<name>$used_by_attrs</name>
40203
42073
<default><![CDATA[]]></default>
40204
<docblock line="1027">
42074
<docblock line="1044">
40205
42075
<description><![CDATA[An array of attribute names who use this MatchingRule]]></description>
40206
42076
<long-description><![CDATA[]]></long-description>
40207
42077
</docblock>
40208
42078
</property>
40209
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1031" package="lib">
42079
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1048" package="lib">
40210
42080
<name>initVars</name>
40211
42081
<full_name>initVars</full_name>
40212
<docblock line="1030">
42082
<docblock line="1047">
40213
42083
<description><![CDATA[Initialize the class' member variables]]></description>
40214
42084
<long-description><![CDATA[]]></long-description>
40215
42085
</docblock>
40216
42086
</method>
40217
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1045" package="lib">
42087
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1062" package="lib">
40218
42088
<name>MatchingRule</name>
40219
42089
<full_name>MatchingRule</full_name>
40220
<docblock line="1042">
42090
<docblock line="1059">
40221
42091
<description><![CDATA[Creates a new MatchingRule object from a raw LDAP MatchingRule string.]]></description>
40222
42092
<long-description><![CDATA[]]></long-description>
40223
42093
</docblock>
40224
<argument line="1045">
42094
<argument line="1062">
40225
42095
<name>$raw_ldap_matching_rule_string</name>
40226
42096
<default><![CDATA[]]></default>
40227
42097
<type/>
40228
42098
</argument>
40229
42099
</method>
40230
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1106" package="lib">
42100
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1123" package="lib">
40231
42101
<name>setUsedByAttrs</name>
40232
42102
<full_name>setUsedByAttrs</full_name>
40233
<docblock line="1102">
42103
<docblock line="1119">
40234
42104
<description><![CDATA[Sets the list of used_by_attrs to the array specified by $attrs;]]></description>
40235
42105
<long-description><![CDATA[]]></long-description>
40236
<tag line="1102" name="param" description="The array of attribute names (strings) which use this MatchingRule" type="array" variable="$attrs">
42106
<tag line="1119" name="param" description="The array of attribute names (strings) which use this MatchingRule" type="array" variable="$attrs">
40237
42107
<type by_reference="false">array</type>
40238
42108
</tag>
40239
42109
</docblock>
40240
<argument line="1106">
42110
<argument line="1123">
40241
42111
<name>$attrs</name>
40242
42112
<default><![CDATA[]]></default>
40243
42113
<type/>
40244
42114
</argument>
40245
42115
</method>
40246
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1115" package="lib">
42116
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1132" package="lib">
40247
42117
<name>addUsedByAttr</name>
40248
42118
<full_name>addUsedByAttr</full_name>
40249
<docblock line="1111">
42119
<docblock line="1128">
40250
42120
<description><![CDATA[Adds an attribute name to the list of attributes who use this MatchingRule]]></description>
40251
42121
<long-description><![CDATA[]]></long-description>
40252
<tag line="1111" name="return" description="if the attribute was added and false otherwise (already in the list)" type="true">
42122
<tag line="1128" name="return" description="if the attribute was added and false otherwise (already in the list)" type="true">
40253
42123
<type by_reference="false">true</type>
40254
42124
</tag>
40255
42125
</docblock>
40256
<argument line="1115">
42126
<argument line="1132">
40257
42127
<name>$new_attr_name</name>
40258
42128
<default><![CDATA[]]></default>
40259
42129
<type/>
40260
42130
</argument>
40261
42131
</method>
40262
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1128" package="lib">
42132
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1145" package="lib">
40263
42133
<name>getName</name>
40264
42134
<full_name>getName</full_name>
40265
<docblock line="1124">
42135
<docblock line="1141">
40266
42136
<description><![CDATA[Gets this MatchingRule's name.]]></description>
40267
42137
<long-description><![CDATA[]]></long-description>
40268
<tag line="1124" name="return" description="The name." type="string">
42138
<tag line="1141" name="return" description="The name." type="string">
40269
42139
<type by_reference="false">string</type>
40270
42140
</tag>
40271
42141
</docblock>
40272
42142
</method>
40273
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1137" package="lib">
42143
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1154" package="lib">
40274
42144
<name>getIsObsolete</name>
40275
42145
<full_name>getIsObsolete</full_name>
40276
<docblock line="1133">
42146
<docblock line="1150">
40277
42147
<description><![CDATA[Gets whether this MatchingRule is flagged as obsolete by the LDAP server.]]></description>
40278
42148
<long-description><![CDATA[]]></long-description>
40279
<tag line="1133" name="return" description="True if this MatchingRule is obsolete and false otherwise." type="bool">
42149
<tag line="1150" name="return" description="True if this MatchingRule is obsolete and false otherwise." type="bool">
40280
42150
<type by_reference="false">bool</type>
40281
42151
</tag>
40282
42152
</docblock>
40283
42153
</method>
40284
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1146" package="lib">
42154
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1163" package="lib">
40285
42155
<name>getUsedByAttrs</name>
40286
42156
<full_name>getUsedByAttrs</full_name>
40287
<docblock line="1142">
42157
<docblock line="1159">
40288
42158
<description><![CDATA[Gets an array of attribute names (strings) which use this MatchingRule]]></description>
40289
42159
<long-description><![CDATA[]]></long-description>
40290
<tag line="1142" name="return" description="The array of attribute names (strings)." type="array">
42160
<tag line="1159" name="return" description="The array of attribute names (strings)." type="array">
40291
42161
<type by_reference="false">array</type>
40292
42162
</tag>
40293
42163
</docblock>
40294
42164
</method>
40295
42165
</class>
40296
<class final="false" abstract="false" namespace="global" line="1157" package="lib">
42166
<class final="false" abstract="false" namespace="global" line="1174" package="lib">
40297
42167
<extends>\SchemaItem</extends>
40298
42168
<name>MatchingRuleUse</name>
40299
42169
<full_name>\MatchingRuleUse</full_name>
40300
<docblock line="1152">
42170
<docblock line="1169">
40301
42171
<description><![CDATA[Represents an LDAP schema matchingRuleUse entry]]></description>
40302
42172
<long-description><![CDATA[]]></long-description>
40303
<tag line="1152" name="package" description="lib"/>
42173
<tag line="1169" name="package" description="lib"/>
40304
42174
</docblock>
40305
<property final="false" static="false" visibility="public" line="1160" namespace="global" package="main">
42175
<property final="false" static="false" visibility="public" line="1177" namespace="global" package="main">
40306
42176
<name>$name</name>
40307
42177
<default><![CDATA[]]></default>
40308
<docblock line="1159">
42178
<docblock line="1176">
40309
42179
<description><![CDATA[The name of the MathingRule this applies to]]></description>
40310
42180
<long-description><![CDATA[]]></long-description>
40311
42181
</docblock>
40312
42182
</property>
40313
<property final="false" static="false" visibility="public" line="1163" namespace="global" package="main">
42183
<property final="false" static="false" visibility="public" line="1180" namespace="global" package="main">
40314
42184
<name>$used_by_attrs</name>
40315
42185
<default><![CDATA[]]></default>
40316
<docblock line="1161">
42186
<docblock line="1178">
40317
42187
<description><![CDATA[An array of attributeType names who make use of the mathingRule
40318
42188
identified by $this->oid and $this->name]]></description>
40319
42189
<long-description><![CDATA[]]></long-description>
40320
42190
</docblock>
40321
42191
</property>
40322
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1166" package="lib">
42192
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1183" package="lib">
40323
42193
<name>initVars</name>
40324
42194
<full_name>initVars</full_name>
40325
<docblock line="1165">
42195
<docblock line="1182">
40326
42196
<description><![CDATA[Initialize the class' member variables]]></description>
40327
42197
<long-description><![CDATA[]]></long-description>
40328
42198
</docblock>
40329
42199
</method>
40330
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1174" package="lib">
42200
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1191" package="lib">
40331
42201
<name>MatchingRuleUse</name>
40332
42202
<full_name>MatchingRuleUse</full_name>
40333
<argument line="1174">
42203
<argument line="1191">
40334
42204
<name>$raw_matching_rule_use_string</name>
40335
42205
<default><![CDATA[]]></default>
40336
42206
<type/>
40337
42207
</argument>
40338
42208
</method>
40339
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1239" package="lib">
42209
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1256" package="lib">
40340
42210
<name>getName</name>
40341
42211
<full_name>getName</full_name>
40342
<docblock line="1235">
42212
<docblock line="1252">
40343
42213
<description><![CDATA[Gets this MatchingRuleUse's name]]></description>
40344
42214
<long-description><![CDATA[]]></long-description>
40345
<tag line="1235" name="return" description="The name" type="string">
42215
<tag line="1252" name="return" description="The name" type="string">
40346
42216
<type by_reference="false">string</type>
40347
42217
</tag>
40348
42218
</docblock>
40349
42219
</method>
40350
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1248" package="lib">
42220
<method final="false" abstract="false" static="false" visibility="public" namespace="global" line="1265" package="lib">
40351
42221
<name>getUsedByAttrs</name>
40352
42222
<full_name>getUsedByAttrs</full_name>
40353
<docblock line="1244">
42223
<docblock line="1261">
40354
42224
<description><![CDATA[Gets an array of attribute names (strings) which use this MatchingRuleUse object.]]></description>
40355
42225
<long-description><![CDATA[]]></long-description>
40356
<tag line="1244" name="return" description="The array of attribute names (strings)." type="array">
42226
<tag line="1261" name="return" description="The array of attribute names (strings)." type="array">
40357
42227
<type by_reference="false">array</type>
40358
42228
</tag>
40359
42229
</docblock>
40360
42230
</method>
40361
42231
</class>
40362
42232
<parse_markers>
40363
<error line="1512" code="50015">Argument $use_cache is missing from the Docblock of \get_schema_objectclasses()</error>
40364
<error line="1553" code="50015">Argument $use_cache is missing from the Docblock of \get_schema_objectclass()</error>
40365
<error line="1577" code="50014">Name of argument $attr_name does not match with the DocBlock's name $oclass_name in \get_schema_attribute()</error>
40366
<error line="1577" code="50015">Argument $use_cache is missing from the Docblock of \get_schema_attribute()</error>
40367
<notice line="1577" code="50013">Parameter $oclass_name could not be found in \get_schema_attribute()</notice>
40368
<error line="1600" code="50015">Argument $use_cache is missing from the Docblock of \get_schema_attributes()</error>
40369
<error line="1697" code="50015">Argument $attrs is missing from the Docblock of \add_aliases_to_attrs()</error>
40370
<error line="1724" code="50015">Argument $attrs is missing from the Docblock of \add_sup_to_attrs()</error>
40371
<error line="1724" code="50015">Argument $attrs_oid is missing from the Docblock of \add_sup_to_attrs()</error>
40372
<error line="1839" code="50015">Argument $dn is missing from the Docblock of \get_schema_matching_rules()</error>
40373
<error line="1839" code="50015">Argument $use_cache is missing from the Docblock of \get_schema_matching_rules()</error>
40374
<error line="1893" code="50015">Argument $dn is missing from the Docblock of \get_schema_syntaxes()</error>
40375
<error line="1893" code="50015">Argument $use_cache is missing from the Docblock of \get_schema_syntaxes()</error>
40376
<error line="1928" code="50015">Argument $schema_type is missing from the Docblock of \cached_schema_available()</error>
40377
<error line="1964" code="50015">Argument $schema_type is missing from the Docblock of \get_cached_schema()</error>
40378
<error line="1998" code="50015">Argument $schema_type is missing from the Docblock of \set_cached_schema()</error>
40379
<error line="1998" code="50015">Argument $schema_items is missing from the Docblock of \set_cached_schema()</error>
42233
<error line="1529" code="50015">Argument $use_cache is missing from the Docblock of \get_schema_objectclasses()</error>
42234
<error line="1570" code="50015">Argument $use_cache is missing from the Docblock of \get_schema_objectclass()</error>
42235
<error line="1594" code="50014">Name of argument $attr_name does not match with the DocBlock's name $oclass_name in \get_schema_attribute()</error>
42236
<error line="1594" code="50015">Argument $use_cache is missing from the Docblock of \get_schema_attribute()</error>
42237
<notice line="1594" code="50013">Parameter $oclass_name could not be found in \get_schema_attribute()</notice>
42238
<error line="1617" code="50015">Argument $use_cache is missing from the Docblock of \get_schema_attributes()</error>
42239
<error line="1714" code="50015">Argument $attrs is missing from the Docblock of \add_aliases_to_attrs()</error>
42240
<error line="1741" code="50015">Argument $attrs is missing from the Docblock of \add_sup_to_attrs()</error>
42241
<error line="1741" code="50015">Argument $attrs_oid is missing from the Docblock of \add_sup_to_attrs()</error>
42242
<error line="1856" code="50015">Argument $dn is missing from the Docblock of \get_schema_matching_rules()</error>
42243
<error line="1856" code="50015">Argument $use_cache is missing from the Docblock of \get_schema_matching_rules()</error>
42244
<error line="1910" code="50015">Argument $dn is missing from the Docblock of \get_schema_syntaxes()</error>
42245
<error line="1910" code="50015">Argument $use_cache is missing from the Docblock of \get_schema_syntaxes()</error>
42246
<error line="1945" code="50015">Argument $schema_type is missing from the Docblock of \cached_schema_available()</error>
42247
<error line="1981" code="50015">Argument $schema_type is missing from the Docblock of \get_cached_schema()</error>
42248
<error line="2015" code="50015">Argument $schema_type is missing from the Docblock of \set_cached_schema()</error>
42249
<error line="2015" code="50015">Argument $schema_items is missing from the Docblock of \set_cached_schema()</error>
40380
42250
<error line="65" code="50010">No DocBlock was found for method setOID()</error>
40381
42251
<error line="70" code="50010">No DocBlock was found for method setDescription()</error>
40382
42252
<error line="75" code="50010">No DocBlock was found for method getOID()</error>
40383
42253
<error line="80" code="50010">No DocBlock was found for method getDescription()</error>
40384
42254
<error line="123" code="50015">Argument $raw_ldap_schema_string is missing from the Docblock of ObjectClass()</error>
40385
<error line="576" code="50015">Argument $raw_ldap_attr_string is missing from the Docblock of AttributeType()</error>
40386
<error line="983" code="50015">Argument $raw_ldap_syntax_string is missing from the Docblock of Syntax()</error>
40387
<error line="1042" code="50015">Argument $raw_ldap_matching_rule_string is missing from the Docblock of MatchingRule()</error>
40388
<error line="1111" code="50015">Argument $new_attr_name is missing from the Docblock of addUsedByAttr()</error>
40389
<error line="1174" code="50010">No DocBlock was found for method MatchingRuleUse()</error>
42255
<error line="593" code="50015">Argument $raw_ldap_attr_string is missing from the Docblock of AttributeType()</error>
42256
<error line="1000" code="50015">Argument $raw_ldap_syntax_string is missing from the Docblock of Syntax()</error>
42257
<error line="1059" code="50015">Argument $raw_ldap_matching_rule_string is missing from the Docblock of MatchingRule()</error>
42258
<error line="1128" code="50015">Argument $new_attr_name is missing from the Docblock of addUsedByAttr()</error>
42259
<error line="1191" code="50010">No DocBlock was found for method MatchingRuleUse()</error>
40390
42260
</parse_markers>
40391
42261
</file>
40392
<file path="help/help.inc" hash="0846c54c48995060f08143ce53afd1fc" package="Help">
42262
<file path="help/help.inc" hash="e640ddd7c1c2314aa702532b6da0743e" package="Help">
40393
42263
<docblock line="27">
40394
42264
<description><![CDATA[LDAP Account Manager help entries.]]></description>
40395
42265
<long-description><![CDATA[]]></long-description>
41013
42883
</docblock>
41014
42884
</include>
41015
42885
</file>
41016
<file path="templates/login.php" hash="d09be8e1bb5e03f49b2401cc973f2fb9" package="main">
42886
<file path="templates/login.php" hash="efce3b7aadb0120e6e386c47ea997fbd" package="main">
41017
42887
<docblock line="25">
41018
42888
<description><![CDATA[Login form of LDAP Account Manager.]]></description>
41019
42889
<long-description><![CDATA[]]></long-description>
41063
42933
<long-description><![CDATA[]]></long-description>
41064
42934
</docblock>
41065
42935
</include>
41066
<include line="506" type="Include Once" package="main">
42936
<include line="515" type="Include Once" package="main">
41067
42937
<name>../lib/ldap.inc</name>
41068
42938
</include>
41069
42939
<function namespace="global" line="120" package="main">
41083
42953
</argument>
41084
42954
</function>
41085
42955
</file>
41086
<file path="templates/massDoUpload.php" hash="59be298273b66956e38914208ea52100" package="tools">
42956
<file path="templates/massDoUpload.php" hash="fe1788c160e2af0ba1be4c17ac48a2e8" package="tools">
41087
42957
<docblock line="24">
41088
42958
<description><![CDATA[Creates LDAP accounts for file upload.]]></description>
41089
42959
<long-description><![CDATA[]]></long-description>
41135
43005
<include line="63" type="Include" package="main">
41136
43006
<name>main_header.php</name>
41137
43007
</include>
41138
<include line="269" type="Include" package="main">
43008
<include line="273" type="Include" package="main">
41139
43009
<name>main_footer.php</name>
41140
43010
</include>
41141
43011
</file>
41142
<file path="templates/masscreate.php" hash="56c826823778fd3315a4ff4306f9f17b" package="tools">
43012
<file path="templates/masscreate.php" hash="ff29855dc0f64f764af857aaeb8b8556" package="tools">
41143
43013
<docblock line="24">
41144
43014
<description><![CDATA[Start page of file upload]]></description>
41145
43015
<long-description><![CDATA[]]></long-description>
41184
43054
<include line="77" type="Include" package="main">
41185
43055
<name>main_header.php</name>
41186
43056
</include>
41187
<include line="219" type="Include" package="main">
41188
<name>main_footer.php</name>
41189
</include>
41190
<include line="469" type="Include" package="main">
41191
<name>main_footer.php</name>
41192
</include>
41193
<function namespace="global" line="227" package="tools">
43057
<include line="220" type="Include" package="main">
43058
<name>main_footer.php</name>
43059
</include>
43060
<include line="470" type="Include" package="main">
43061
<name>main_footer.php</name>
43062
</include>
43063
<function namespace="global" line="228" package="tools">
41194
43064
<name>showMainPage</name>
41195
43065
<full_name>\showMainPage</full_name>
41196
<docblock line="221">
43066
<docblock line="222">
41197
43067
<description><![CDATA[Displays the acount type specific main page of the upload.]]></description>
41198
43068
<long-description><![CDATA[]]></long-description>
41199
<tag line="221" name="param" description="account type" type="string" variable="$scope">
43069
<tag line="222" name="param" description="account type" type="string" variable="$scope">
41200
43070
<type by_reference="false">string</type>
41201
43071
</tag>
41202
<tag line="221" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
43072
<tag line="222" name="param" description="list of selected account modules" type="array" variable="$selectedModules">
41203
43073
<type by_reference="false">array</type>
41204
43074
</tag>
41205
43075
</docblock>
41206
<argument line="227">
43076
<argument line="228">
41207
43077
<name>$scope</name>
41208
43078
<default><![CDATA[]]></default>
41209
43079
<type/>
41210
43080
</argument>
41211
<argument line="227">
43081
<argument line="228">
41212
43082
<name>$selectedModules</name>
41213
43083
<default><![CDATA[]]></default>
41214
43084
<type/>
41262
43132
<name>mainlogin.php</name>
41263
43133
</include>
41264
43134
</file>
41265
<file path="templates/config/confmodules.php" hash="817ad4140ce9d0c55ccf0eb7a268f256" package="configuration">
43135
<file path="templates/config/confmodules.php" hash="35204ee6b19bdae093047b992a1b86d5" package="configuration">
41266
43136
<docblock line="25">
41267
43137
<description><![CDATA[confmodules lets the user select the account modules]]></description>
41268
43138
<long-description><![CDATA[]]></long-description>
41385
43255
</docblock>
41386
43256
</include>
41387
43257
</file>
41388
<file path="templates/config/confmain.php" hash="83378730a32d8e7f11f2f6d712c87b60" package="configuration">
43258
<file path="templates/config/confmain.php" hash="6bcbf89c56a5f08698a234a53af2eb14" package="configuration">
41389
43259
<docblock line="25">
41390
43260
<description><![CDATA[Main page of configuration]]></description>
41391
43261
<long-description><![CDATA[]]></long-description>
41426
43296
</docblock>
41427
43297
</function>
41428
43298
</file>
41429
<file path="templates/config/moduleSettings.php" hash="99dc7bc0cbdcd0bd3fcd0ced6328e7ba" package="configuration">
43299
<file path="templates/config/moduleSettings.php" hash="c27ea6605e052c06af4ea164b26e3c16" package="configuration">
41430
43300
<docblock line="25">
41431
43301
<description><![CDATA[Here the user can edit the module settings.]]></description>
41432
43302
<long-description><![CDATA[]]></long-description>
41466
43336
</docblock>
41467
43337
</function>
41468
43338
</file>
41469
<file path="templates/config/conftypes.php" hash="545a4b8f4479c4f6c773c7987e5a4927" package="configuration">
43339
<file path="templates/config/conftypes.php" hash="b94602b97ff49e82b99eda6d1adb338a" package="configuration">
41470
43340
<docblock line="25">
41471
43341
<description><![CDATA[Here the user can select the account types.]]></description>
41472
43342
<long-description><![CDATA[]]></long-description>
41494
43364
<long-description><![CDATA[]]></long-description>
41495
43365
</docblock>
41496
43366
</include>
41497
<function namespace="global" line="333" package="configuration">
43367
<function namespace="global" line="337" package="configuration">
41498
43368
<name>checkInput</name>
41499
43369
<full_name>\checkInput</full_name>
41500
<docblock line="328">
43370
<docblock line="332">
41501
43371
<description><![CDATA[Checks user input and saves the entered settings.]]></description>
41502
43372
<long-description><![CDATA[]]></long-description>
41503
<tag line="328" name="return" description="list of errors" type="array">
43373
<tag line="332" name="return" description="list of errors" type="array">
41504
43374
<type by_reference="false">array</type>
41505
43375
</tag>
41506
43376
</docblock>
41555
43425
<error line="0" code="50007">No page-level DocBlock was found in file templates/main_footer.php</error>
41556
43426
</parse_markers>
41557
43427
</file>
41558
<file path="templates/account/edit.php" hash="905e6713999d85df7abb05c72bc1788b" package="modules">
43428
<file path="templates/account/edit.php" hash="e301e625697fec2a04ab68e13e7af795" package="modules">
41559
43429
<docblock line="27">
41560
43430
<description><![CDATA[Displays the account detail page.]]></description>
41561
43431
<long-description><![CDATA[]]></long-description>
41801
43671
<name>../main_footer.php</name>
41802
43672
</include>
41803
43673
</file>
41804
<file path="templates/delete.php" hash="943cc17bb3426c8d3b071159183e1982" package="main">
43674
<file path="templates/delete.php" hash="11678cacdadf2e5a1031a7cf3e502c9e" package="main">
41805
43675
<docblock line="25">
41806
43676
<description><![CDATA[Used to delete accounts from LDAP tree.]]></description>
41807
43677
<long-description><![CDATA[]]></long-description>
41858
43728
<long-description><![CDATA[]]></long-description>
41859
43729
</docblock>
41860
43730
</include>
41861
<include line="85" type="Include" package="main">
41862
<name>main_header.php</name>
41863
</include>
41864
<include line="128" type="Include" package="main">
41865
<name>main_footer.php</name>
41866
</include>
41867
<include line="142" type="Include" package="main">
41868
<name>main_header.php</name>
41869
</include>
41870
<include line="298" type="Include" package="main">
41871
<name>main_footer.php</name>
41872
</include>
41873
<function namespace="global" line="308" package="main">
43731
<include line="89" type="Include" package="main">
43732
<name>main_header.php</name>
43733
</include>
43734
<include line="132" type="Include" package="main">
43735
<name>main_footer.php</name>
43736
</include>
43737
<include line="150" type="Include" package="main">
43738
<name>main_header.php</name>
43739
</include>
43740
<include line="306" type="Include" package="main">
43741
<name>main_footer.php</name>
43742
</include>
43743
<function namespace="global" line="316" package="main">
41874
43744
<name>getChildCount</name>
41875
43745
<full_name>\getChildCount</full_name>
41876
<docblock line="302">
43746
<docblock line="310">
41877
43747
<description><![CDATA[Returns the number of child entries of a DN.]]></description>
41878
43748
<long-description><![CDATA[]]></long-description>
41879
<tag line="302" name="param" description="DN of parent" type="string" variable="$dn">
43749
<tag line="310" name="param" description="DN of parent" type="string" variable="$dn">
41880
43750
<type by_reference="false">string</type>
41881
43751
</tag>
41882
<tag line="302" name="return" description="number of childs" type="\interger">
43752
<tag line="310" name="return" description="number of childs" type="\interger">
41883
43753
<type by_reference="false">\interger</type>
41884
43754
</tag>
41885
43755
</docblock>
41886
<argument line="308">
43756
<argument line="316">
41887
43757
<name>$dn</name>
41888
43758
<default><![CDATA[]]></default>
41889
43759
<type/>
41890
43760
</argument>
41891
43761
</function>
41892
<function namespace="global" line="319" package="main">
43762
<function namespace="global" line="327" package="main">
41893
43763
<name>deleteDN</name>
41894
43764
<full_name>\deleteDN</full_name>
41895
<docblock line="313">
43765
<docblock line="321">
41896
43766
<description><![CDATA[Deletes a DN and all child entries.]]></description>
41897
43767
<long-description><![CDATA[]]></long-description>
41898
<tag line="313" name="param" description="DN to delete" type="string" variable="$dn">
43768
<tag line="321" name="param" description="DN to delete" type="string" variable="$dn">
41899
43769
<type by_reference="false">string</type>
41900
43770
</tag>
41901
<tag line="313" name="return" description="error messages" type="array">
43771
<tag line="321" name="return" description="error messages" type="array">
41902
43772
<type by_reference="false">array</type>
41903
43773
</tag>
41904
43774
</docblock>
41905
<argument line="319">
43775
<argument line="327">
41906
43776
<name>$dn</name>
41907
43777
<default><![CDATA[]]></default>
41908
43778
<type/>
53558
55428
<error line="2267" code="50015">Argument $dn is missing from the Docblock of userIsAllowedLogin()</error>
53559
55429
</parse_markers>
53560
55430
</file>
53561
<file path="templates/3rdParty/pla/lib/common.php" hash="ffb734576c9501fa8bd99e054e4aad11" package="phpLDAPadmin">
55431
<file path="templates/3rdParty/pla/lib/common.php" hash="567c07393a4d9b23bd6041b0fb1ae6d4" package="phpLDAPadmin">
53562
55432
<docblock line="2">
53563
55433
<description><![CDATA[Contains code to be executed at the top of each application page.]]></description>
53564
55434
<long-description><![CDATA[<p>include this file at the top of every PHP file.</p>
53573
55443
<tag line="2" name="author" description="The phpLDAPadmin development team"/>
53574
55444
<tag line="2" name="package" description="phpLDAPadmin"/>
53575
55445
</docblock>
53576
<include line="122" type="Require Once" package="main">
53577
<name/>
53578
</include>
53579
<include line="148" type="Require Once" package="main">
53580
<name/>
53581
</include>
53582
<include line="151" type="Require Once" package="main">
53583
<name/>
53584
</include>
53585
<include line="174" type="Require Once" package="main">
53586
<name/>
53587
</include>
53588
<include line="251" type="Require" package="main">
55446
<include line="123" type="Require Once" package="main">
55447
<name/>
55448
</include>
55449
<include line="149" type="Require Once" package="main">
55450
<name/>
55451
</include>
55452
<include line="152" type="Require Once" package="main">
55453
<name/>
55454
</include>
55455
<include line="175" type="Require Once" package="main">
55456
<name/>
55457
</include>
55458
<include line="252" type="Require" package="main">
53589
55459
<name/>
53590
55460
</include>
53591
55461
<constant namespace="global" line="29" package="phpLDAPadmin">
53593
55463
<full_name>\APPCONFIG</full_name>
53594
55464
<value><![CDATA['plaConfig']]></value>
53595
55465
</constant>
53596
<constant namespace="global" line="114" package="phpLDAPadmin">
55466
<constant namespace="global" line="115" package="phpLDAPadmin">
53597
55467
<name>LIBDIR</name>
53598
55468
<full_name>\LIBDIR</full_name>
53599
55469
<value><![CDATA['../lib/']]></value>
53600
55470
</constant>
53601
<constant namespace="global" line="118" package="phpLDAPadmin">
55471
<constant namespace="global" line="119" package="phpLDAPadmin">
53602
55472
<name>E_STRICT</name>
53603
55473
<full_name>\E_STRICT</full_name>
53604
55474
<value><![CDATA[2048]]></value>
53605
55475
</constant>
53606
<constant namespace="global" line="169" package="phpLDAPadmin">
55476
<constant namespace="global" line="170" package="phpLDAPadmin">
53607
55477
<name>CSSDIR</name>
53608
55478
<full_name>\CSSDIR</full_name>
53609
55479
<value><![CDATA[sprintf('css/%s', $app['theme'])]]></value>
53610
55480
</constant>
53611
<constant namespace="global" line="170" package="phpLDAPadmin">
55481
<constant namespace="global" line="171" package="phpLDAPadmin">
53612
55482
<name>IMGDIR</name>
53613
55483
<full_name>\IMGDIR</full_name>
53614
55484
<value><![CDATA[sprintf('images/%s', $app['theme'])]]></value>
53615
55485
</constant>
53616
<constant namespace="global" line="204" package="phpLDAPadmin">
55486
<constant namespace="global" line="205" package="phpLDAPadmin">
53617
55487
<name>DEBUG_ENABLED</name>
53618
55488
<full_name>\DEBUG_ENABLED</full_name>
53619
55489
<value><![CDATA[0]]></value>
53620
55490
</constant>
53621
<function namespace="global" line="86" package="phpLDAPadmin">
55491
<function namespace="global" line="87" package="phpLDAPadmin">
53622
55492
<name>stopwatch</name>
53623
55493
<full_name>\stopwatch</full_name>
53624
55494
</function>
53625
55495
<parse_markers>
53626
<error line="86" code="50009">No DocBlock was found for function \stopwatch()</error>
55496
<error line="87" code="50009">No DocBlock was found for function \stopwatch()</error>
53627
55497
</parse_markers>
53628
55498
</file>
53629
55499
<file path="templates/3rdParty/pla/lib/MassRender.php" hash="ae2063510c5064c07f9dc6ece2a9d307" package="phpLDAPadmin">
55882
57752
</docblock>
55883
57753
</include>
55884
57754
</file>
55885
<file path="templates/initsuff.php" hash="ed92cefbfccf268376a888b2a58588f0" package="main">
57755
<file path="templates/initsuff.php" hash="177999e54375ea8fa5b2f0b9d7c64223" package="main">
55886
57756
<docblock line="24">
55887
57757
<description><![CDATA[Creates main suffixes if they are missing.]]></description>
55888
57758
<long-description><![CDATA[]]></long-description>
55917
57787
<long-description><![CDATA[]]></long-description>
55918
57788
</docblock>
55919
57789
</include>
55920
<include line="145" type="Include" package="main">
55921
<name>main_header.php</name>
55922
</include>
55923
<include line="153" type="Include" package="main">
55924
<name>main_footer.php</name>
55925
</include>
55926
<include line="158" type="Include" package="main">
55927
<name>main_footer.php</name>
55928
</include>
55929
<include line="164" type="Include" package="main">
55930
<name>main_footer.php</name>
55931
</include>
55932
<include line="175" type="Include" package="main">
55933
<name>main_header.php</name>
55934
</include>
55935
<include line="198" type="Include" package="main">
57790
<include line="146" type="Include" package="main">
57791
<name>main_header.php</name>
57792
</include>
57793
<include line="154" type="Include" package="main">
57794
<name>main_footer.php</name>
57795
</include>
57796
<include line="159" type="Include" package="main">
57797
<name>main_footer.php</name>
57798
</include>
57799
<include line="165" type="Include" package="main">
57800
<name>main_footer.php</name>
57801
</include>
57802
<include line="176" type="Include" package="main">
57803
<name>main_header.php</name>
57804
</include>
57805
<include line="200" type="Include" package="main">
55936
57806
<name>main_footer.php</name>
55937
57807
</include>
55938
57808
</file>
55939
<file path="templates/massBuildAccounts.php" hash="ec2991b7a62ae0f3fe5fcb86ecb79ef3" package="tools">
57809
<file path="templates/massBuildAccounts.php" hash="50f685f95393d6776bb4b9adc98a2477" package="tools">
55940
57810
<docblock line="24">
55941
57811
<description><![CDATA[Creates the accounts by parsing the uploaded file.]]></description>
55942
57812
<long-description><![CDATA[]]></long-description>
55974
57844
<include line="92" type="Include" package="main">
55975
57845
<name>main_header.php</name>
55976
57846
</include>
55977
<include line="262" type="Include" package="main">
57847
<include line="266" type="Include" package="main">
55978
57848
<name>main_footer.php</name>
55979
57849
</include>
55980
<function namespace="global" line="271" package="tools">
57850
<function namespace="global" line="275" package="tools">
55981
57851
<name>massPrintBackButton</name>
55982
57852
<full_name>\massPrintBackButton</full_name>
55983
<docblock line="264">
57853
<docblock line="268">
55984
57854
<description><![CDATA[Prints a back button to the page where the user enters a file to upload.]]></description>
55985
57855
<long-description><![CDATA[]]></long-description>
55986
<tag line="264" name="param" description="account type (e.g. user)" type="String" variable="$scope">
57856
<tag line="268" name="param" description="account type (e.g. user)" type="String" variable="$scope">
55987
57857
<type by_reference="false">String</type>
55988
57858
</tag>
55989
<tag line="264" name="param" description="selected modules for upload" type="array" variable="$selectedModules">
57859
<tag line="268" name="param" description="selected modules for upload" type="array" variable="$selectedModules">
55990
57860
<type by_reference="false">array</type>
55991
57861
</tag>
55992
<tag line="264" name="param" description="table container" type="\htmlTable" variable="$container">
57862
<tag line="268" name="param" description="table container" type="\htmlTable" variable="$container">
55993
57863
<type by_reference="false">\htmlTable</type>
55994
57864
</tag>
55995
57865
</docblock>
55996
<argument line="271">
57866
<argument line="275">
55997
57867
<name>$scope</name>
55998
57868
<default><![CDATA[]]></default>
55999
57869
<type/>
56000
57870
</argument>
56001
<argument line="271">
57871
<argument line="275">
56002
57872
<name>$selectedModules</name>
56003
57873
<default><![CDATA[]]></default>
56004
57874
<type/>
56005
57875
</argument>
56006
<argument line="271">
57876
<argument line="275">
56007
57877
<name>$container</name>
56008
57878
<default><![CDATA[]]></default>
56009
57879
<type/>
56144
58014
<package name="tools" full_name="tools"/>
56145
58015
<package name="types" full_name="types"/>
56146
58016
<namespace name="global" full_name="global"/>
56147
<marker count="11">todo</marker>
58017
<marker count="15">todo</marker>
56148
58018
<marker count="0">fixme</marker>
56149
58019
<deprecated count="0"/>
56150
58020
</project>
Loggerhead is a web-based interface for Breezy
Version: 2.0.1