50
50
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
51
51
Reports <b class="caret"></b></a><ul class="dropdown-menu">
52
52
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
53
<span class="label label-info">1051</span></a></li>
53
<span class="label label-info">1055</span></a></li>
54
54
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
56
<span class="label label-info">11</span>
56
<span class="label label-info">15</span>
57
57
</li></ul></a></li>
58
58
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
59
59
<span class="label label-info">0</span></a></li>
143
143
<li class="method public "><a href="#save_attributes" title="save_attributes :: Returns a list of modifications which have to be made to the LDAP account."><span class="description">Returns a list of modifications which have to be made to the LDAP account.</span><pre>save_attributes()</pre></a></li>
144
144
<li class="method public inherited"><a href="#supportsAdminInterface" title="supportsAdminInterface :: Specifies if this module supports the LAM admin interface."><span class="description">Specifies if this module supports the LAM admin interface.</span><pre>supportsAdminInterface()</pre></a></li>
145
145
<li class="nav-header protected">» Protected</li>
146
<li class="method protected inherited"><a href="#addMultiValueInputTextField" title="addMultiValueInputTextField :: Adds a text input field that may contain multiple values to the given htmlTable."><span class="description">Adds a text input field that may contain multiple values to the given htmlTable.</span><pre>addMultiValueInputTextField()</pre></a></li>
146
147
<li class="method protected inherited"><a href="#addSimpleInputTextField" title="addSimpleInputTextField :: Adds a simple text input field to the given htmlTable."><span class="description">Adds a simple text input field to the given htmlTable.</span><pre>addSimpleInputTextField()</pre></a></li>
147
148
<li class="method protected inherited"><a href="#addSimplePDFField" title="addSimplePDFField :: Adds a simple PDF entry to the given array."><span class="description">Adds a simple PDF entry to the given array.</span><pre>addSimplePDFField()</pre></a></li>
149
<li class="method protected inherited"><a href="#addSimpleSelfServiceTextField" title="addSimpleSelfServiceTextField :: Adds a simple text input field for the self service."><span class="description">Adds a simple text input field for the self service.</span><pre>addSimpleSelfServiceTextField()</pre></a></li>
150
<li class="method protected inherited"><a href="#checkSimpleSelfServiceTextField" title="checkSimpleSelfServiceTextField :: Checks the input value of a self service text field."><span class="description">Checks the input value of a self service text field.</span><pre>checkSimpleSelfServiceTextField()</pre></a></li>
148
151
<li class="method protected inherited"><a href="#getAccountContainer" title="getAccountContainer :: Returns the {@link accountContainer} object."><span class="description">Returns the {@link accountContainer} object.</span><pre>getAccountContainer()</pre></a></li>
149
152
<li class="method protected inherited"><a href="#isBooleanConfigOptionSet" title="isBooleanConfigOptionSet :: Returns if the given configuration option is set."><span class="description">Returns if the given configuration option is set.</span><pre>isBooleanConfigOptionSet()</pre></a></li>
153
<li class="method protected inherited"><a href="#processMultiValueInputTextField" title="processMultiValueInputTextField :: Validates a multi-value text field."><span class="description">Validates a multi-value text field.</span><pre>processMultiValueInputTextField()</pre></a></li>
150
154
<li class="nav-header private">» Private</li>
151
155
<li class="method private "><a href="#calculateSubnet" title="calculateSubnet :: Calculates the subnet for a given IP and netmask."><span class="description">Calculates the subnet for a given IP and netmask.</span><pre>calculateSubnet()</pre></a></li>
152
156
<li class="nav-header">
1819
1823
<code>boolean</code>support admin interface</div>
1826
<a name="addMultiValueInputTextField" id="addMultiValueInputTextField"></a><div class="element clickable method protected addMultiValueInputTextField" data-toggle="collapse" data-target=".addMultiValueInputTextField .collapse">
1827
<h2>Adds a text input field that may contain multiple values to the given htmlTable.</h2>
1828
<pre>addMultiValueInputTextField(<a href="../classes/htmlTable.html">\htmlTable</a> $container, String $attrName, String $label, boolean $required, integer $length) </pre>
1829
<div class="labels"><span class="label">Inherited</span></div>
1830
<div class="row collapse"><div class="detail-description">
1831
<p class="long_description"><p>The field name will be the same as the attribute name plus a counting number (e.g. street_0).
1832
The last field will be followed by a button to add a new value. This is named add_{attribute name} (e.g. add_street).
1833
There must be a help entry with the attribute name as ID.
1834
A new line will also be added after this entry so multiple calls will show the fields one below the other.</p></p>
1835
<table class="table table-bordered"><tr>
1836
<th>inherited_from</th>
1837
<td>\baseModule::addMultiValueInputTextField()</td>
1840
<div class="subelement argument">
1842
<code><a href="../classes/htmlTable.html">\htmlTable</a></code><p>parent container</p></div>
1843
<div class="subelement argument">
1845
<code>String</code><p>attribute name</p></div>
1846
<div class="subelement argument">
1848
<code>String</code><p>label name</p></div>
1849
<div class="subelement argument">
1851
<code>boolean</code><p>this is a required field (default false)</p>
1853
<div class="subelement argument">
1855
<code>integer</code><p>field length</p></div>
1822
1858
<a name="addSimpleInputTextField" id="addSimpleInputTextField"></a><div class="element clickable method protected addSimpleInputTextField" data-toggle="collapse" data-target=".addSimpleInputTextField .collapse">
1823
1859
<h2>Adds a simple text input field to the given htmlTable.</h2>
1824
<pre>addSimpleInputTextField(<a href="../classes/htmlTable.html">\htmlTable</a> $container, String $attrName, String $label, boolean $required, integer $length) </pre>
1860
<pre>addSimpleInputTextField(<a href="../classes/htmlTable.html">\htmlTable</a> $container, String $attrName, String $label, boolean $required, integer $length, boolean $isTextArea) </pre>
1825
1861
<div class="labels"><span class="label">Inherited</span></div>
1826
1862
<div class="row collapse"><div class="detail-description">
1827
1863
<p class="long_description"><p>The field name will be the same as the attribute name. There must also be a help entry with the attribute name as ID.
1877
1917
<div class="subelement argument">
1878
1918
<h4>$delimiter</h4>
1879
<code>String</code><p>delimiter if multiple attribute values exist</p></div>
1919
<code>String</code><p>delimiter if multiple attribute values exist (default: ", ")</p>
1923
<a name="addSimpleSelfServiceTextField" id="addSimpleSelfServiceTextField"></a><div class="element clickable method protected addSimpleSelfServiceTextField" data-toggle="collapse" data-target=".addSimpleSelfServiceTextField .collapse">
1924
<h2>Adds a simple text input field for the self service.</h2>
1925
<pre>addSimpleSelfServiceTextField(array $container, String $name, String $label, array $fields, array $attributes, array $readOnlyFields, boolean $required, boolean $isTextArea) </pre>
1926
<div class="labels"><span class="label">Inherited</span></div>
1927
<div class="row collapse"><div class="detail-description">
1928
<p class="long_description"><p>The field name will be the same as the class name plus "_" plus attribute name (e.g. posixAccount_cn).</p></p>
1929
<table class="table table-bordered"><tr>
1930
<th>inherited_from</th>
1931
<td>\baseModule::addSimpleSelfServiceTextField()</td>
1934
<div class="subelement argument">
1936
<code>array</code><p>array that is used as return value for getSelfServiceOptions()</p>
1938
<div class="subelement argument">
1940
<code>String</code><p>attribute name (== field name)</p>
1942
<div class="subelement argument">
1944
<code>String</code><p>label to display in front of input field</p></div>
1945
<div class="subelement argument">
1947
<code>array</code><p>list of active fields</p></div>
1948
<div class="subelement argument">
1949
<h4>$attributes</h4>
1950
<code>array</code><p>attributes of LDAP account</p></div>
1951
<div class="subelement argument">
1952
<h4>$readOnlyFields</h4>
1953
<code>array</code><p>list of read-only fields</p>
1955
<div class="subelement argument">
1957
<code>boolean</code><p>field is required</p></div>
1958
<div class="subelement argument">
1959
<h4>$isTextArea</h4>
1960
<code>boolean</code><p>display as text area</p></div>
1963
<a name="checkSimpleSelfServiceTextField" id="checkSimpleSelfServiceTextField"></a><div class="element clickable method protected checkSimpleSelfServiceTextField" data-toggle="collapse" data-target=".checkSimpleSelfServiceTextField .collapse">
1964
<h2>Checks the input value of a self service text field.</h2>
1965
<pre>checkSimpleSelfServiceTextField(array $container, String $name, array $attributes, string $fields, array $readOnlyFields, String $validationID) </pre>
1966
<div class="labels"><span class="label">Inherited</span></div>
1967
<div class="row collapse"><div class="detail-description">
1968
<p class="long_description"><p>The field name must be the same as the class name plus "_" plus attribute name (e.g. posixAccount_cn).
1969
If validation is used then there must exist a message named [{attribute name}][0] (e.g. $this->messages['street'][0]).</p></p>
1970
<table class="table table-bordered"><tr>
1971
<th>inherited_from</th>
1972
<td>\baseModule::checkSimpleSelfServiceTextField()</td>
1975
<div class="subelement argument">
1977
<code>array</code><p>return value of checkSelfServiceOptions()</p>
1979
<div class="subelement argument">
1981
<code>String</code><p>attribute name</p></div>
1982
<div class="subelement argument">
1983
<h4>$attributes</h4>
1984
<code>array</code><p>LDAP attributes</p></div>
1985
<div class="subelement argument">
1987
<code>string</code><p>input fields</p></div>
1988
<div class="subelement argument">
1989
<h4>$readOnlyFields</h4>
1990
<code>array</code><p>list of read-only fields</p>
1992
<div class="subelement argument">
1993
<h4>$validationID</h4>
1994
<code>String</code><p>validation ID for get_preg()</p>
1882
1998
<a name="getAccountContainer" id="getAccountContainer"></a><div class="element clickable method protected getAccountContainer" data-toggle="collapse" data-target=".getAccountContainer .collapse">
1919
2035
<code>boolean</code>true if option is set</div>
2038
<a name="processMultiValueInputTextField" id="processMultiValueInputTextField"></a><div class="element clickable method protected processMultiValueInputTextField" data-toggle="collapse" data-target=".processMultiValueInputTextField .collapse">
2039
<h2>Validates a multi-value text field.</h2>
2040
<pre>processMultiValueInputTextField(String $attrName, array $errors, String $validationID) </pre>
2041
<div class="labels"><span class="label">Inherited</span></div>
2042
<div class="row collapse"><div class="detail-description">
2043
<p class="long_description"><p>The input fields must be created with function addMultiValueInputTextField().
2044
If validation is used then there must exist a message named [{attribute name}][0] (e.g. $this->messages['street'][0]).</p></p>
2045
<table class="table table-bordered"><tr>
2046
<th>inherited_from</th>
2047
<td>\baseModule::processMultiValueInputTextField()</td>
2050
<div class="subelement argument">
2052
<code>String</code><p>attribute name</p></div>
2053
<div class="subelement argument">
2055
<code>array</code><p>errors array where to put validation errors</p></div>
2056
<div class="subelement argument">
2057
<h4>$validationID</h4>
2058
<code>String</code><p>validation ID for function get_preg() (default: null, null means no validation)</p>
1922
2062
<a name="calculateSubnet" id="calculateSubnet"></a><div class="element clickable method private calculateSubnet" data-toggle="collapse" data-target=".calculateSubnet .collapse">
1923
2063
<h2>Calculates the subnet for a given IP and netmask.</h2>
1924
2064
<pre>calculateSubnet(String $ip, String $mask) </pre>