← 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/generalInformation.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/generalInformation.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>
137
137
<li class="method public inherited"><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>
138
138
<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>
139
139
<li class="nav-header protected">» Protected</li>
 
140
<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>
140
141
<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>
141
142
<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>
 
143
<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>
 
144
<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>
142
145
<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>
143
146
<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>
144
147
<li class="method protected inherited"><a href="#load_Messages" title="load_Messages :: This function fills the $messages variable with output messages from this module."><span class="description">This function fills the $messages variable with output messages from this module.</span><pre>load_Messages()</pre></a></li>
 
148
<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>
145
149
<li class="nav-header">
146
150
<i class="icon-custom icon-property"></i> Properties</li>
147
151
<li class="nav-header protected">» Protected</li>
1745
1749
<code>boolean</code>support admin interface</div>
1746
1750
</div></div>
1747
1751
</div>
 
1752
<a name="addMultiValueInputTextField" id="addMultiValueInputTextField"></a><div class="element clickable method protected addMultiValueInputTextField" data-toggle="collapse" data-target=".addMultiValueInputTextField .collapse">
 
1753
<h2>Adds a text input field that may contain multiple values to the given htmlTable.</h2>
 
1754
<pre>addMultiValueInputTextField(<a href="../classes/htmlTable.html">\htmlTable</a> $container, String $attrName, String $label, boolean $required, integer $length) </pre>
 
1755
<div class="labels"><span class="label">Inherited</span></div>
 
1756
<div class="row collapse"><div class="detail-description">
 
1757
<p class="long_description"><p>The field name will be the same as the attribute name plus a counting number (e.g. street_0).
 
1758
The last field will be followed by a button to add a new value. This is named add_{attribute name} (e.g. add_street).
 
1759
There must be a help entry with the attribute name as ID.
 
1760
A new line will also be added after this entry so multiple calls will show the fields one below the other.</p></p>
 
1761
<table class="table table-bordered"><tr>
 
1762
<th>inherited_from</th>
 
1763
<td>\baseModule::addMultiValueInputTextField()</td>
 
1764
</tr></table>
 
1765
<h3>Parameters</h3>
 
1766
<div class="subelement argument">
 
1767
<h4>$container</h4>
 
1768
<code><a href="../classes/htmlTable.html">\htmlTable</a></code><p>parent container</p></div>
 
1769
<div class="subelement argument">
 
1770
<h4>$attrName</h4>
 
1771
<code>String</code><p>attribute name</p></div>
 
1772
<div class="subelement argument">
 
1773
<h4>$label</h4>
 
1774
<code>String</code><p>label name</p></div>
 
1775
<div class="subelement argument">
 
1776
<h4>$required</h4>
 
1777
<code>boolean</code><p>this is a required field (default false)</p>
 
1778
</div>
 
1779
<div class="subelement argument">
 
1780
<h4>$length</h4>
 
1781
<code>integer</code><p>field length</p></div>
 
1782
</div></div>
 
1783
</div>
1748
1784
<a name="addSimpleInputTextField" id="addSimpleInputTextField"></a><div class="element clickable method protected addSimpleInputTextField" data-toggle="collapse" data-target=".addSimpleInputTextField .collapse">
1749
1785
<h2>Adds a simple text input field to the given htmlTable.</h2>
1750
 
<pre>addSimpleInputTextField(<a href="../classes/htmlTable.html">\htmlTable</a> $container, String $attrName, String $label, boolean $required, integer $length) </pre>
 
1786
<pre>addSimpleInputTextField(<a href="../classes/htmlTable.html">\htmlTable</a> $container, String $attrName, String $label, boolean $required, integer $length, boolean $isTextArea) </pre>
1751
1787
<div class="labels"><span class="label">Inherited</span></div>
1752
1788
<div class="row collapse"><div class="detail-description">
1753
1789
<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.
1773
1809
<div class="subelement argument">
1774
1810
<h4>$length</h4>
1775
1811
<code>integer</code><p>field length</p></div>
 
1812
<div class="subelement argument">
 
1813
<h4>$isTextArea</h4>
 
1814
<code>boolean</code><p>show as text area (default false)</p>
 
1815
</div>
1776
1816
</div></div>
1777
1817
</div>
1778
1818
<a name="addSimplePDFField" id="addSimplePDFField"></a><div class="element clickable method protected addSimplePDFField" data-toggle="collapse" data-target=".addSimplePDFField .collapse">
1802
1842
</div>
1803
1843
<div class="subelement argument">
1804
1844
<h4>$delimiter</h4>
1805
 
<code>String</code><p>delimiter if multiple attribute values exist</p></div>
 
1845
<code>String</code><p>delimiter if multiple attribute values exist (default: ", ")</p>
 
1846
</div>
 
1847
</div></div>
 
1848
</div>
 
1849
<a name="addSimpleSelfServiceTextField" id="addSimpleSelfServiceTextField"></a><div class="element clickable method protected addSimpleSelfServiceTextField" data-toggle="collapse" data-target=".addSimpleSelfServiceTextField .collapse">
 
1850
<h2>Adds a simple text input field for the self service.</h2>
 
1851
<pre>addSimpleSelfServiceTextField(array $container, String $name, String $label, array $fields, array $attributes, array $readOnlyFields, boolean $required, boolean $isTextArea) </pre>
 
1852
<div class="labels"><span class="label">Inherited</span></div>
 
1853
<div class="row collapse"><div class="detail-description">
 
1854
<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>
 
1855
<table class="table table-bordered"><tr>
 
1856
<th>inherited_from</th>
 
1857
<td>\baseModule::addSimpleSelfServiceTextField()</td>
 
1858
</tr></table>
 
1859
<h3>Parameters</h3>
 
1860
<div class="subelement argument">
 
1861
<h4>$container</h4>
 
1862
<code>array</code><p>array that is used as return value for getSelfServiceOptions()</p>
 
1863
</div>
 
1864
<div class="subelement argument">
 
1865
<h4>$name</h4>
 
1866
<code>String</code><p>attribute name (== field name)</p>
 
1867
</div>
 
1868
<div class="subelement argument">
 
1869
<h4>$label</h4>
 
1870
<code>String</code><p>label to display in front of input field</p></div>
 
1871
<div class="subelement argument">
 
1872
<h4>$fields</h4>
 
1873
<code>array</code><p>list of active fields</p></div>
 
1874
<div class="subelement argument">
 
1875
<h4>$attributes</h4>
 
1876
<code>array</code><p>attributes of LDAP account</p></div>
 
1877
<div class="subelement argument">
 
1878
<h4>$readOnlyFields</h4>
 
1879
<code>array</code><p>list of read-only fields</p>
 
1880
</div>
 
1881
<div class="subelement argument">
 
1882
<h4>$required</h4>
 
1883
<code>boolean</code><p>field is required</p></div>
 
1884
<div class="subelement argument">
 
1885
<h4>$isTextArea</h4>
 
1886
<code>boolean</code><p>display as text area</p></div>
 
1887
</div></div>
 
1888
</div>
 
1889
<a name="checkSimpleSelfServiceTextField" id="checkSimpleSelfServiceTextField"></a><div class="element clickable method protected checkSimpleSelfServiceTextField" data-toggle="collapse" data-target=".checkSimpleSelfServiceTextField .collapse">
 
1890
<h2>Checks the input value of a self service text field.</h2>
 
1891
<pre>checkSimpleSelfServiceTextField(array $container, String $name, array $attributes, string $fields, array $readOnlyFields, String $validationID) </pre>
 
1892
<div class="labels"><span class="label">Inherited</span></div>
 
1893
<div class="row collapse"><div class="detail-description">
 
1894
<p class="long_description"><p>The field name must be the same as the class name plus "_" plus attribute name (e.g. posixAccount_cn).
 
1895
If validation is used then there must exist a message named [{attribute name}][0] (e.g. $this->messages['street'][0]).</p></p>
 
1896
<table class="table table-bordered"><tr>
 
1897
<th>inherited_from</th>
 
1898
<td>\baseModule::checkSimpleSelfServiceTextField()</td>
 
1899
</tr></table>
 
1900
<h3>Parameters</h3>
 
1901
<div class="subelement argument">
 
1902
<h4>$container</h4>
 
1903
<code>array</code><p>return value of checkSelfServiceOptions()</p>
 
1904
</div>
 
1905
<div class="subelement argument">
 
1906
<h4>$name</h4>
 
1907
<code>String</code><p>attribute name</p></div>
 
1908
<div class="subelement argument">
 
1909
<h4>$attributes</h4>
 
1910
<code>array</code><p>LDAP attributes</p></div>
 
1911
<div class="subelement argument">
 
1912
<h4>$fields</h4>
 
1913
<code>string</code><p>input fields</p></div>
 
1914
<div class="subelement argument">
 
1915
<h4>$readOnlyFields</h4>
 
1916
<code>array</code><p>list of read-only fields</p>
 
1917
</div>
 
1918
<div class="subelement argument">
 
1919
<h4>$validationID</h4>
 
1920
<code>String</code><p>validation ID for get_preg()</p>
 
1921
</div>
1806
1922
</div></div>
1807
1923
</div>
1808
1924
<a name="getAccountContainer" id="getAccountContainer"></a><div class="element clickable method protected getAccountContainer" data-toggle="collapse" data-target=".getAccountContainer .collapse">
1857
1973
</tr></table>
1858
1974
</div></div>
1859
1975
</div>
 
1976
<a name="processMultiValueInputTextField" id="processMultiValueInputTextField"></a><div class="element clickable method protected processMultiValueInputTextField" data-toggle="collapse" data-target=".processMultiValueInputTextField .collapse">
 
1977
<h2>Validates a multi-value text field.</h2>
 
1978
<pre>processMultiValueInputTextField(String $attrName, array $errors, String $validationID) </pre>
 
1979
<div class="labels"><span class="label">Inherited</span></div>
 
1980
<div class="row collapse"><div class="detail-description">
 
1981
<p class="long_description"><p>The input fields must be created with function addMultiValueInputTextField().
 
1982
If validation is used then there must exist a message named [{attribute name}][0] (e.g. $this->messages['street'][0]).</p></p>
 
1983
<table class="table table-bordered"><tr>
 
1984
<th>inherited_from</th>
 
1985
<td>\baseModule::processMultiValueInputTextField()</td>
 
1986
</tr></table>
 
1987
<h3>Parameters</h3>
 
1988
<div class="subelement argument">
 
1989
<h4>$attrName</h4>
 
1990
<code>String</code><p>attribute name</p></div>
 
1991
<div class="subelement argument">
 
1992
<h4>$errors</h4>
 
1993
<code>array</code><p>errors array where to put validation errors</p></div>
 
1994
<div class="subelement argument">
 
1995
<h4>$validationID</h4>
 
1996
<code>String</code><p>validation ID for function get_preg() (default: null, null means no validation)</p>
 
1997
</div>
 
1998
</div></div>
 
1999
</div>
1860
2000
<h3>
1861
2001
<i class="icon-custom icon-property"></i> Properties</h3>
1862
2002
<a name="%24attributes" id="$attributes"> </a><div class="element clickable property protected $attributes" data-toggle="collapse" data-target=".$attributes .collapse">
1974
2114
<div class="row"><footer class="span12">
1975
2115
            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>
1976
2116
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
1977
 
            generated on 2013-03-18T20:12:55+01:00.<br></footer></div>
 
2117
            generated on 2013-06-17T21:08:50+02:00.<br></footer></div>
1978
2118
</div>
1979
2119
</body>
1980
2120
</html>