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

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Roland Gruber
  • Date: 2012-12-17 19:41:29 UTC
  • mfrom: (1.2.18)
  • Revision ID: package-import@ubuntu.com-20121217194129-x6g7jgqxelr9o0mv
Tags: 4.0-1
new upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
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">1048</span></a></li>
 
53
                <span class="label label-info">1051</span></a></li>
54
54
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
55
55
                <ul><li>todo 
56
56
                <span class="label label-info">11</span>
97
97
<li class="method public "><a href="#display_html_terminalServer" title="display_html_terminalServer :: This function will create the HTML page to edit the terminal server options."><span class="description">This function will create the HTML page to edit the terminal server options.</span><pre>display_html_terminalServer()</pre></a></li>
98
98
<li class="method public "><a href="#display_html_time" title="display_html_time :: This function will create the meta HTML code to show a page to change time values."><span class="description">This function will create the meta HTML code to show a page to change time values.</span><pre>display_html_time()</pre></a></li>
99
99
<li class="method public inherited"><a href="#doUploadPostActions" title="doUploadPostActions :: This function is responsible to do additional tasks after the account has been created in LDAP (e.g."><span class="description">This function is responsible to do additional tasks after the account has been created in LDAP (e.g.</span><pre>doUploadPostActions()</pre></a></li>
 
100
<li class="method public inherited"><a href="#doUploadPreActions" title="doUploadPreActions :: Runs any actions that need to be done before an LDAP entry is created."><span class="description">Runs any actions that need to be done before an LDAP entry is created.</span><pre>doUploadPreActions()</pre></a></li>
100
101
<li class="method public inherited"><a href="#getAttributes" title="getAttributes :: Returns the LDAP attributes which are managed in this module."><span class="description">Returns the LDAP attributes which are managed in this module.</span><pre>getAttributes()</pre></a></li>
101
102
<li class="method public inherited"><a href="#getButtonStatus" title="getButtonStatus :: Controls if the module button the account page is visible and activated."><span class="description">Controls if the module button the account page is visible and activated.</span><pre>getButtonStatus()</pre></a></li>
102
103
<li class="method public inherited"><a href="#getIcon" title="getIcon :: Returns the path to the module icon."><span class="description">Returns the path to the module icon.</span><pre>getIcon()</pre></a></li>
179
180
<li class="property private "><a href="#%24cachedHostList" title="$cachedHostList :: host cache to reduce LDAP queries"><span class="description">host cache to reduce LDAP queries</span><pre>$cachedHostList</pre></a></li>
180
181
<li class="property private "><a href="#%24deactivated" title="$deactivated :: account deactivated?"><span class="description">account deactivated?</span><pre>$deactivated</pre></a></li>
181
182
<li class="property private "><a href="#%24expirePassword" title="$expirePassword :: specifies if the password should be expired"><span class="description">specifies if the password should be expired</span><pre>$expirePassword</pre></a></li>
 
183
<li class="property private "><a href="#%24groupRids" title="$groupRids :: array of well known group rids"><span class="description">array of well known group rids</span><pre>$groupRids</pre></a></li>
182
184
<li class="property private "><a href="#%24hex2bitstring" title="$hex2bitstring :: HEX to binary conversion table"><span class="description">HEX to binary conversion table</span><pre>$hex2bitstring</pre></a></li>
183
185
<li class="property private "><a href="#%24noexpire" title="$noexpire :: password does not expire?"><span class="description">password does not expire?</span><pre>$noexpire</pre></a></li>
184
186
<li class="property private "><a href="#%24nopwd" title="$nopwd :: use no password?"><span class="description">use no password?</span><pre>$nopwd</pre></a></li>
185
 
<li class="property private "><a href="#%24rids" title="$rids :: array of well known rids"><span class="description">array of well known rids</span><pre>$rids</pre></a></li>
186
187
<li class="property private inherited"><a href="#%24scope" title="$scope :: the account type of this module (user, group, host)"><span class="description">the account type of this module (user, group, host)</span><pre>$scope</pre></a></li>
 
188
<li class="property private "><a href="#%24userRids" title="$userRids :: array of well known user rids"><span class="description">array of well known user rids</span><pre>$userRids</pre></a></li>
187
189
</ul>
188
190
</div>
189
191
<div class="span8">
600
602
<code>array</code>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> )</div>
601
603
</div></div>
602
604
</div>
 
605
<a name="doUploadPreActions" id="doUploadPreActions"></a><div class="element clickable method public doUploadPreActions" data-toggle="collapse" data-target=".doUploadPreActions .collapse">
 
606
<h2>Runs any actions that need to be done before an LDAP entry is created.</h2>
 
607
<pre>doUploadPreActions(array $attributes) : array</pre>
 
608
<div class="labels"><span class="label">Inherited</span></div>
 
609
<div class="row collapse"><div class="detail-description">
 
610
<p class="long_description"></p>
 
611
<table class="table table-bordered"><tr>
 
612
<th>inherited_from</th>
 
613
<td>\baseModule::doUploadPreActions()</td>
 
614
</tr></table>
 
615
<h3>Parameters</h3>
 
616
<div class="subelement argument">
 
617
<h4>$attributes</h4>
 
618
<code>array</code><p>LDAP attributes of this entry (attributes are provided as reference, handle modifications of $attributes with care)</p>
 
619
</div>
 
620
<h3>Returns</h3>
 
621
<div class="subelement response">
 
622
<code>array</code>array which contains status messages. Each entry is an array containing the status message parameters.</div>
 
623
</div></div>
 
624
</div>
603
625
<a name="getAttributes" id="getAttributes"></a><div class="element clickable method public getAttributes" data-toggle="collapse" data-target=".getAttributes .collapse">
604
626
<h2>Returns the LDAP attributes which are managed in this module.</h2>
605
627
<pre>getAttributes() : array</pre>
1731
1753
<code>boolean</code><p>new account</p></div>
1732
1754
<div class="subelement argument">
1733
1755
<h4>$attributes</h4>
1734
 
<code>array</code><p>LDAP attributes of this entry</p></div>
 
1756
<code>array</code><p>LDAP attributes of this entry (added/modified attributes are provided as reference, handle modifications of $attributes with care)</p>
 
1757
</div>
1735
1758
<h3>Returns</h3>
1736
1759
<div class="subelement response">
1737
1760
<code>array</code>array which contains status messages. Each entry is an array containing the status message parameters.</div>
2130
2153
<div class="labels"></div>
2131
2154
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
2132
2155
</div>
 
2156
<a name="%24groupRids" id="$groupRids"> </a><div class="element clickable property private $groupRids" data-toggle="collapse" data-target=".$groupRids .collapse">
 
2157
<h2>array of well known group rids</h2>
 
2158
<pre>$groupRids </pre>
 
2159
<div class="labels"></div>
 
2160
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
 
2161
</div>
2133
2162
<a name="%24hex2bitstring" id="$hex2bitstring"> </a><div class="element clickable property private $hex2bitstring" data-toggle="collapse" data-target=".$hex2bitstring .collapse">
2134
2163
<h2>HEX to binary conversion table</h2>
2135
2164
<pre>$hex2bitstring </pre>
2148
2177
<div class="labels"></div>
2149
2178
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
2150
2179
</div>
2151
 
<a name="%24rids" id="$rids"> </a><div class="element clickable property private $rids" data-toggle="collapse" data-target=".$rids .collapse">
2152
 
<h2>array of well known rids</h2>
2153
 
<pre>$rids </pre>
2154
 
<div class="labels"></div>
2155
 
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
2156
 
</div>
2157
2180
<a name="%24scope" id="$scope"> </a><div class="element clickable property private $scope" data-toggle="collapse" data-target=".$scope .collapse">
2158
2181
<h2>the account type of this module (user, group, host)</h2>
2159
2182
<pre>$scope </pre>
2166
2189
</tr></table>
2167
2190
</div></div>
2168
2191
</div>
 
2192
<a name="%24userRids" id="$userRids"> </a><div class="element clickable property private $userRids" data-toggle="collapse" data-target=".$userRids .collapse">
 
2193
<h2>array of well known user rids</h2>
 
2194
<pre>$userRids </pre>
 
2195
<div class="labels"></div>
 
2196
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
 
2197
</div>
2169
2198
</div>
2170
2199
</div>
2171
2200
</div>
2173
2202
<div class="row"><footer class="span12">
2174
2203
            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>
2175
2204
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
2176
 
            generated on 2012-09-24T21:44:11+02:00.<br></footer></div>
 
2205
            generated on 2012-12-17T20:15:42+01:00.<br></footer></div>
2177
2206
</div>
2178
2207
</body>
2179
2208
</html>