← Back to branch summary

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

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Roland Gruber
  • Date: 2013-07-21 11:15:58 UTC
  • mfrom: (1.1.27) (4.1.25 sid)
  • Revision ID: package-import@ubuntu.com-20130721111558-vrnk3kf6t2khyizx
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/asteriskAccount.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>
142
142
<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>
143
143
<li class="method public "><a href="#supportsForcePasswordChange" title="supportsForcePasswordChange :: Specifies if this module supports to force that a user must change his password on next login."><span class="description">Specifies if this module supports to force that a user must change his password on next login.</span><pre>supportsForcePasswordChange()</pre></a></li>
144
144
<li class="nav-header protected">» Protected</li>
 
145
<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>
145
146
<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>
146
147
<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>
 
148
<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>
 
149
<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>
147
150
<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>
148
151
<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>
 
152
<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>
149
153
<li class="nav-header private">» Private</li>
150
154
<li class="method private "><a href="#hashPassword" title="hashPassword :: Hashes a password value to Asterisk format."><span class="description">Hashes a password value to Asterisk format.</span><pre>hashPassword()</pre></a></li>
151
155
<li class="nav-header">
1816
1820
<code>boolean</code>force password change supported</div>
1817
1821
</div></div>
1818
1822
</div>
 
1823
<a name="addMultiValueInputTextField" id="addMultiValueInputTextField"></a><div class="element clickable method protected addMultiValueInputTextField" data-toggle="collapse" data-target=".addMultiValueInputTextField .collapse">
 
1824
<h2>Adds a text input field that may contain multiple values to the given htmlTable.</h2>
 
1825
<pre>addMultiValueInputTextField(<a href="../classes/htmlTable.html">\htmlTable</a> $container, String $attrName, String $label, boolean $required, integer $length) </pre>
 
1826
<div class="labels"><span class="label">Inherited</span></div>
 
1827
<div class="row collapse"><div class="detail-description">
 
1828
<p class="long_description"><p>The field name will be the same as the attribute name plus a counting number (e.g. street_0).
 
1829
The last field will be followed by a button to add a new value. This is named add_{attribute name} (e.g. add_street).
 
1830
There must be a help entry with the attribute name as ID.
 
1831
A new line will also be added after this entry so multiple calls will show the fields one below the other.</p></p>
 
1832
<table class="table table-bordered"><tr>
 
1833
<th>inherited_from</th>
 
1834
<td>\baseModule::addMultiValueInputTextField()</td>
 
1835
</tr></table>
 
1836
<h3>Parameters</h3>
 
1837
<div class="subelement argument">
 
1838
<h4>$container</h4>
 
1839
<code><a href="../classes/htmlTable.html">\htmlTable</a></code><p>parent container</p></div>
 
1840
<div class="subelement argument">
 
1841
<h4>$attrName</h4>
 
1842
<code>String</code><p>attribute name</p></div>
 
1843
<div class="subelement argument">
 
1844
<h4>$label</h4>
 
1845
<code>String</code><p>label name</p></div>
 
1846
<div class="subelement argument">
 
1847
<h4>$required</h4>
 
1848
<code>boolean</code><p>this is a required field (default false)</p>
 
1849
</div>
 
1850
<div class="subelement argument">
 
1851
<h4>$length</h4>
 
1852
<code>integer</code><p>field length</p></div>
 
1853
</div></div>
 
1854
</div>
1819
1855
<a name="addSimpleInputTextField" id="addSimpleInputTextField"></a><div class="element clickable method protected addSimpleInputTextField" data-toggle="collapse" data-target=".addSimpleInputTextField .collapse">
1820
1856
<h2>Adds a simple text input field to the given htmlTable.</h2>
1821
 
<pre>addSimpleInputTextField(<a href="../classes/htmlTable.html">\htmlTable</a> $container, String $attrName, String $label, boolean $required, integer $length) </pre>
 
1857
<pre>addSimpleInputTextField(<a href="../classes/htmlTable.html">\htmlTable</a> $container, String $attrName, String $label, boolean $required, integer $length, boolean $isTextArea) </pre>
1822
1858
<div class="labels"><span class="label">Inherited</span></div>
1823
1859
<div class="row collapse"><div class="detail-description">
1824
1860
<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.
1844
1880
<div class="subelement argument">
1845
1881
<h4>$length</h4>
1846
1882
<code>integer</code><p>field length</p></div>
 
1883
<div class="subelement argument">
 
1884
<h4>$isTextArea</h4>
 
1885
<code>boolean</code><p>show as text area (default false)</p>
 
1886
</div>
1847
1887
</div></div>
1848
1888
</div>
1849
1889
<a name="addSimplePDFField" id="addSimplePDFField"></a><div class="element clickable method protected addSimplePDFField" data-toggle="collapse" data-target=".addSimplePDFField .collapse">
1873
1913
</div>
1874
1914
<div class="subelement argument">
1875
1915
<h4>$delimiter</h4>
1876
 
<code>String</code><p>delimiter if multiple attribute values exist</p></div>
 
1916
<code>String</code><p>delimiter if multiple attribute values exist (default: ", ")</p>
 
1917
</div>
 
1918
</div></div>
 
1919
</div>
 
1920
<a name="addSimpleSelfServiceTextField" id="addSimpleSelfServiceTextField"></a><div class="element clickable method protected addSimpleSelfServiceTextField" data-toggle="collapse" data-target=".addSimpleSelfServiceTextField .collapse">
 
1921
<h2>Adds a simple text input field for the self service.</h2>
 
1922
<pre>addSimpleSelfServiceTextField(array $container, String $name, String $label, array $fields, array $attributes, array $readOnlyFields, boolean $required, boolean $isTextArea) </pre>
 
1923
<div class="labels"><span class="label">Inherited</span></div>
 
1924
<div class="row collapse"><div class="detail-description">
 
1925
<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>
 
1926
<table class="table table-bordered"><tr>
 
1927
<th>inherited_from</th>
 
1928
<td>\baseModule::addSimpleSelfServiceTextField()</td>
 
1929
</tr></table>
 
1930
<h3>Parameters</h3>
 
1931
<div class="subelement argument">
 
1932
<h4>$container</h4>
 
1933
<code>array</code><p>array that is used as return value for getSelfServiceOptions()</p>
 
1934
</div>
 
1935
<div class="subelement argument">
 
1936
<h4>$name</h4>
 
1937
<code>String</code><p>attribute name (== field name)</p>
 
1938
</div>
 
1939
<div class="subelement argument">
 
1940
<h4>$label</h4>
 
1941
<code>String</code><p>label to display in front of input field</p></div>
 
1942
<div class="subelement argument">
 
1943
<h4>$fields</h4>
 
1944
<code>array</code><p>list of active fields</p></div>
 
1945
<div class="subelement argument">
 
1946
<h4>$attributes</h4>
 
1947
<code>array</code><p>attributes of LDAP account</p></div>
 
1948
<div class="subelement argument">
 
1949
<h4>$readOnlyFields</h4>
 
1950
<code>array</code><p>list of read-only fields</p>
 
1951
</div>
 
1952
<div class="subelement argument">
 
1953
<h4>$required</h4>
 
1954
<code>boolean</code><p>field is required</p></div>
 
1955
<div class="subelement argument">
 
1956
<h4>$isTextArea</h4>
 
1957
<code>boolean</code><p>display as text area</p></div>
 
1958
</div></div>
 
1959
</div>
 
1960
<a name="checkSimpleSelfServiceTextField" id="checkSimpleSelfServiceTextField"></a><div class="element clickable method protected checkSimpleSelfServiceTextField" data-toggle="collapse" data-target=".checkSimpleSelfServiceTextField .collapse">
 
1961
<h2>Checks the input value of a self service text field.</h2>
 
1962
<pre>checkSimpleSelfServiceTextField(array $container, String $name, array $attributes, string $fields, array $readOnlyFields, String $validationID) </pre>
 
1963
<div class="labels"><span class="label">Inherited</span></div>
 
1964
<div class="row collapse"><div class="detail-description">
 
1965
<p class="long_description"><p>The field name must be the same as the class name plus "_" plus attribute name (e.g. posixAccount_cn).
 
1966
If validation is used then there must exist a message named [{attribute name}][0] (e.g. $this->messages['street'][0]).</p></p>
 
1967
<table class="table table-bordered"><tr>
 
1968
<th>inherited_from</th>
 
1969
<td>\baseModule::checkSimpleSelfServiceTextField()</td>
 
1970
</tr></table>
 
1971
<h3>Parameters</h3>
 
1972
<div class="subelement argument">
 
1973
<h4>$container</h4>
 
1974
<code>array</code><p>return value of checkSelfServiceOptions()</p>
 
1975
</div>
 
1976
<div class="subelement argument">
 
1977
<h4>$name</h4>
 
1978
<code>String</code><p>attribute name</p></div>
 
1979
<div class="subelement argument">
 
1980
<h4>$attributes</h4>
 
1981
<code>array</code><p>LDAP attributes</p></div>
 
1982
<div class="subelement argument">
 
1983
<h4>$fields</h4>
 
1984
<code>string</code><p>input fields</p></div>
 
1985
<div class="subelement argument">
 
1986
<h4>$readOnlyFields</h4>
 
1987
<code>array</code><p>list of read-only fields</p>
 
1988
</div>
 
1989
<div class="subelement argument">
 
1990
<h4>$validationID</h4>
 
1991
<code>String</code><p>validation ID for get_preg()</p>
 
1992
</div>
1877
1993
</div></div>
1878
1994
</div>
1879
1995
<a name="getAccountContainer" id="getAccountContainer"></a><div class="element clickable method protected getAccountContainer" data-toggle="collapse" data-target=".getAccountContainer .collapse">
1916
2032
<code>boolean</code>true if option is set</div>
1917
2033
</div></div>
1918
2034
</div>
 
2035
<a name="processMultiValueInputTextField" id="processMultiValueInputTextField"></a><div class="element clickable method protected processMultiValueInputTextField" data-toggle="collapse" data-target=".processMultiValueInputTextField .collapse">
 
2036
<h2>Validates a multi-value text field.</h2>
 
2037
<pre>processMultiValueInputTextField(String $attrName, array $errors, String $validationID) </pre>
 
2038
<div class="labels"><span class="label">Inherited</span></div>
 
2039
<div class="row collapse"><div class="detail-description">
 
2040
<p class="long_description"><p>The input fields must be created with function addMultiValueInputTextField().
 
2041
If validation is used then there must exist a message named [{attribute name}][0] (e.g. $this->messages['street'][0]).</p></p>
 
2042
<table class="table table-bordered"><tr>
 
2043
<th>inherited_from</th>
 
2044
<td>\baseModule::processMultiValueInputTextField()</td>
 
2045
</tr></table>
 
2046
<h3>Parameters</h3>
 
2047
<div class="subelement argument">
 
2048
<h4>$attrName</h4>
 
2049
<code>String</code><p>attribute name</p></div>
 
2050
<div class="subelement argument">
 
2051
<h4>$errors</h4>
 
2052
<code>array</code><p>errors array where to put validation errors</p></div>
 
2053
<div class="subelement argument">
 
2054
<h4>$validationID</h4>
 
2055
<code>String</code><p>validation ID for function get_preg() (default: null, null means no validation)</p>
 
2056
</div>
 
2057
</div></div>
 
2058
</div>
1919
2059
<a name="hashPassword" id="hashPassword"></a><div class="element clickable method private hashPassword" data-toggle="collapse" data-target=".hashPassword .collapse">
1920
2060
<h2>Hashes a password value to Asterisk format.</h2>
1921
2061
<pre>hashPassword(String $password) : String</pre>
2056
2196
<div class="row"><footer class="span12">
2057
2197
            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>
2058
2198
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
2059
 
            generated on 2013-03-18T20:12:52+01:00.<br></footer></div>
 
2199
            generated on 2013-06-17T21:08:46+02:00.<br></footer></div>
2060
2200
</div>
2061
2201
</body>
2062
2202
</html>