← Back to branch summary

~ubuntu-branches/ubuntu/trusty/ldap-account-manager/trusty-proposed

« back to all changes in this revision

Viewing changes to docs/devel/phpdoc/classes/dhcp_settings.html

  • 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
http://bugs.debian.org/669824
http://bugs.debian.org/711778
* 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)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/devel/phpdoc/classes/dhcp_settings.html
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 
55
55
                <ul><li>todo 
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>
139
139
<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>
140
140
<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>
141
141
<li class="nav-header protected">» Protected</li>
 
142
<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>
142
143
<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>
143
144
<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>
 
145
<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>
 
146
<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>
144
147
<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>
145
148
<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>
 
149
<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>
146
150
<li class="nav-header private">» Private</li>
147
151
<li class="method private "><a href="#calculateNetMask" title="calculateNetMask :: Calculates the net mask from the subnet."><span class="description">Calculates the net mask from the subnet.</span><pre>calculateNetMask()</pre></a></li>
148
152
<li class="method private "><a href="#checkSubnetMask" title="checkSubnetMask :: Checks if the subnet mask is valid."><span class="description">Checks if the subnet mask is valid.</span><pre>checkSubnetMask()</pre></a></li>
1746
1750
<code>boolean</code>support admin interface</div>
1747
1751
</div></div>
1748
1752
</div>
 
1753
<a name="addMultiValueInputTextField" id="addMultiValueInputTextField"></a><div class="element clickable method protected addMultiValueInputTextField" data-toggle="collapse" data-target=".addMultiValueInputTextField .collapse">
 
1754
<h2>Adds a text input field that may contain multiple values to the given htmlTable.</h2>
 
1755
<pre>addMultiValueInputTextField(<a href="../classes/htmlTable.html">\htmlTable</a> $container, String $attrName, String $label, boolean $required, integer $length) </pre>
 
1756
<div class="labels"><span class="label">Inherited</span></div>
 
1757
<div class="row collapse"><div class="detail-description">
 
1758
<p class="long_description"><p>The field name will be the same as the attribute name plus a counting number (e.g. street_0).
 
1759
The last field will be followed by a button to add a new value. This is named add_{attribute name} (e.g. add_street).
 
1760
There must be a help entry with the attribute name as ID.
 
1761
A new line will also be added after this entry so multiple calls will show the fields one below the other.</p></p>
 
1762
<table class="table table-bordered"><tr>
 
1763
<th>inherited_from</th>
 
1764
<td>\baseModule::addMultiValueInputTextField()</td>
 
1765
</tr></table>
 
1766
<h3>Parameters</h3>
 
1767
<div class="subelement argument">
 
1768
<h4>$container</h4>
 
1769
<code><a href="../classes/htmlTable.html">\htmlTable</a></code><p>parent container</p></div>
 
1770
<div class="subelement argument">
 
1771
<h4>$attrName</h4>
 
1772
<code>String</code><p>attribute name</p></div>
 
1773
<div class="subelement argument">
 
1774
<h4>$label</h4>
 
1775
<code>String</code><p>label name</p></div>
 
1776
<div class="subelement argument">
 
1777
<h4>$required</h4>
 
1778
<code>boolean</code><p>this is a required field (default false)</p>
 
1779
</div>
 
1780
<div class="subelement argument">
 
1781
<h4>$length</h4>
 
1782
<code>integer</code><p>field length</p></div>
 
1783
</div></div>
 
1784
</div>
1749
1785
<a name="addSimpleInputTextField" id="addSimpleInputTextField"></a><div class="element clickable method protected addSimpleInputTextField" data-toggle="collapse" data-target=".addSimpleInputTextField .collapse">
1750
1786
<h2>Adds a simple text input field to the given htmlTable.</h2>
1751
 
<pre>addSimpleInputTextField(<a href="../classes/htmlTable.html">\htmlTable</a> $container, String $attrName, String $label, boolean $required, integer $length) </pre>
 
1787
<pre>addSimpleInputTextField(<a href="../classes/htmlTable.html">\htmlTable</a> $container, String $attrName, String $label, boolean $required, integer $length, boolean $isTextArea) </pre>
1752
1788
<div class="labels"><span class="label">Inherited</span></div>
1753
1789
<div class="row collapse"><div class="detail-description">
1754
1790
<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.
1774
1810
<div class="subelement argument">
1775
1811
<h4>$length</h4>
1776
1812
<code>integer</code><p>field length</p></div>
 
1813
<div class="subelement argument">
 
1814
<h4>$isTextArea</h4>
 
1815
<code>boolean</code><p>show as text area (default false)</p>
 
1816
</div>
1777
1817
</div></div>
1778
1818
</div>
1779
1819
<a name="addSimplePDFField" id="addSimplePDFField"></a><div class="element clickable method protected addSimplePDFField" data-toggle="collapse" data-target=".addSimplePDFField .collapse">
1803
1843
</div>
1804
1844
<div class="subelement argument">
1805
1845
<h4>$delimiter</h4>
1806
 
<code>String</code><p>delimiter if multiple attribute values exist</p></div>
 
1846
<code>String</code><p>delimiter if multiple attribute values exist (default: ", ")</p>
 
1847
</div>
 
1848
</div></div>
 
1849
</div>
 
1850
<a name="addSimpleSelfServiceTextField" id="addSimpleSelfServiceTextField"></a><div class="element clickable method protected addSimpleSelfServiceTextField" data-toggle="collapse" data-target=".addSimpleSelfServiceTextField .collapse">
 
1851
<h2>Adds a simple text input field for the self service.</h2>
 
1852
<pre>addSimpleSelfServiceTextField(array $container, String $name, String $label, array $fields, array $attributes, array $readOnlyFields, boolean $required, boolean $isTextArea) </pre>
 
1853
<div class="labels"><span class="label">Inherited</span></div>
 
1854
<div class="row collapse"><div class="detail-description">
 
1855
<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>
 
1856
<table class="table table-bordered"><tr>
 
1857
<th>inherited_from</th>
 
1858
<td>\baseModule::addSimpleSelfServiceTextField()</td>
 
1859
</tr></table>
 
1860
<h3>Parameters</h3>
 
1861
<div class="subelement argument">
 
1862
<h4>$container</h4>
 
1863
<code>array</code><p>array that is used as return value for getSelfServiceOptions()</p>
 
1864
</div>
 
1865
<div class="subelement argument">
 
1866
<h4>$name</h4>
 
1867
<code>String</code><p>attribute name (== field name)</p>
 
1868
</div>
 
1869
<div class="subelement argument">
 
1870
<h4>$label</h4>
 
1871
<code>String</code><p>label to display in front of input field</p></div>
 
1872
<div class="subelement argument">
 
1873
<h4>$fields</h4>
 
1874
<code>array</code><p>list of active fields</p></div>
 
1875
<div class="subelement argument">
 
1876
<h4>$attributes</h4>
 
1877
<code>array</code><p>attributes of LDAP account</p></div>
 
1878
<div class="subelement argument">
 
1879
<h4>$readOnlyFields</h4>
 
1880
<code>array</code><p>list of read-only fields</p>
 
1881
</div>
 
1882
<div class="subelement argument">
 
1883
<h4>$required</h4>
 
1884
<code>boolean</code><p>field is required</p></div>
 
1885
<div class="subelement argument">
 
1886
<h4>$isTextArea</h4>
 
1887
<code>boolean</code><p>display as text area</p></div>
 
1888
</div></div>
 
1889
</div>
 
1890
<a name="checkSimpleSelfServiceTextField" id="checkSimpleSelfServiceTextField"></a><div class="element clickable method protected checkSimpleSelfServiceTextField" data-toggle="collapse" data-target=".checkSimpleSelfServiceTextField .collapse">
 
1891
<h2>Checks the input value of a self service text field.</h2>
 
1892
<pre>checkSimpleSelfServiceTextField(array $container, String $name, array $attributes, string $fields, array $readOnlyFields, String $validationID) </pre>
 
1893
<div class="labels"><span class="label">Inherited</span></div>
 
1894
<div class="row collapse"><div class="detail-description">
 
1895
<p class="long_description"><p>The field name must be the same as the class name plus "_" plus attribute name (e.g. posixAccount_cn).
 
1896
If validation is used then there must exist a message named [{attribute name}][0] (e.g. $this->messages['street'][0]).</p></p>
 
1897
<table class="table table-bordered"><tr>
 
1898
<th>inherited_from</th>
 
1899
<td>\baseModule::checkSimpleSelfServiceTextField()</td>
 
1900
</tr></table>
 
1901
<h3>Parameters</h3>
 
1902
<div class="subelement argument">
 
1903
<h4>$container</h4>
 
1904
<code>array</code><p>return value of checkSelfServiceOptions()</p>
 
1905
</div>
 
1906
<div class="subelement argument">
 
1907
<h4>$name</h4>
 
1908
<code>String</code><p>attribute name</p></div>
 
1909
<div class="subelement argument">
 
1910
<h4>$attributes</h4>
 
1911
<code>array</code><p>LDAP attributes</p></div>
 
1912
<div class="subelement argument">
 
1913
<h4>$fields</h4>
 
1914
<code>string</code><p>input fields</p></div>
 
1915
<div class="subelement argument">
 
1916
<h4>$readOnlyFields</h4>
 
1917
<code>array</code><p>list of read-only fields</p>
 
1918
</div>
 
1919
<div class="subelement argument">
 
1920
<h4>$validationID</h4>
 
1921
<code>String</code><p>validation ID for get_preg()</p>
 
1922
</div>
1807
1923
</div></div>
1808
1924
</div>
1809
1925
<a name="getAccountContainer" id="getAccountContainer"></a><div class="element clickable method protected getAccountContainer" data-toggle="collapse" data-target=".getAccountContainer .collapse">
1846
1962
<code>boolean</code>true if option is set</div>
1847
1963
</div></div>
1848
1964
</div>
 
1965
<a name="processMultiValueInputTextField" id="processMultiValueInputTextField"></a><div class="element clickable method protected processMultiValueInputTextField" data-toggle="collapse" data-target=".processMultiValueInputTextField .collapse">
 
1966
<h2>Validates a multi-value text field.</h2>
 
1967
<pre>processMultiValueInputTextField(String $attrName, array $errors, String $validationID) </pre>
 
1968
<div class="labels"><span class="label">Inherited</span></div>
 
1969
<div class="row collapse"><div class="detail-description">
 
1970
<p class="long_description"><p>The input fields must be created with function addMultiValueInputTextField().
 
1971
If validation is used then there must exist a message named [{attribute name}][0] (e.g. $this->messages['street'][0]).</p></p>
 
1972
<table class="table table-bordered"><tr>
 
1973
<th>inherited_from</th>
 
1974
<td>\baseModule::processMultiValueInputTextField()</td>
 
1975
</tr></table>
 
1976
<h3>Parameters</h3>
 
1977
<div class="subelement argument">
 
1978
<h4>$attrName</h4>
 
1979
<code>String</code><p>attribute name</p></div>
 
1980
<div class="subelement argument">
 
1981
<h4>$errors</h4>
 
1982
<code>array</code><p>errors array where to put validation errors</p></div>
 
1983
<div class="subelement argument">
 
1984
<h4>$validationID</h4>
 
1985
<code>String</code><p>validation ID for function get_preg() (default: null, null means no validation)</p>
 
1986
</div>
 
1987
</div></div>
 
1988
</div>
1849
1989
<a name="calculateNetMask" id="calculateNetMask"></a><div class="element clickable method private calculateNetMask" data-toggle="collapse" data-target=".calculateNetMask .collapse">
1850
1990
<h2>Calculates the net mask from the subnet.</h2>
1851
1991
<pre>calculateNetMask(String $subnet) : integer</pre>
2054
2194
<div class="row"><footer class="span12">
2055
2195
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
2056
2196
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
2057
 
            generated on 2013-03-18T20:12:53+01:00.<br></footer></div>
 
2197
            generated on 2013-06-17T21:08:47+02:00.<br></footer></div>
2058
2198
</div>
2059
2199
</body>
2060
2200
</html>