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

« back to all changes in this revision

Viewing changes to docs/devel/phpdoc/classes/lamHostList.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
* 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:
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>
82
82
<li class="method protected inherited"><a href="#addExtraInputElementsToTopArea" title="addExtraInputElementsToTopArea :: Can be used by subclasses to add e.g."><span class="description">Can be used by subclasses to add e.g.</span><pre>addExtraInputElementsToTopArea()</pre></a></li>
83
83
<li class="method protected inherited"><a href="#buildLDAPAttributeFilter" title="buildLDAPAttributeFilter :: Builds the LDAP filter based on the filter entries in the GUI."><span class="description">Builds the LDAP filter based on the filter entries in the GUI.</span><pre>buildLDAPAttributeFilter()</pre></a></li>
84
84
<li class="method protected inherited"><a href="#canBeFiltered" title="canBeFiltered :: Returns if the given attribute can be filtered."><span class="description">Returns if the given attribute can be filtered.</span><pre>canBeFiltered()</pre></a></li>
85
 
<li class="method protected inherited"><a href="#cmp_array" title="cmp_array :: Compare function used for usort-method"><span class="description">Compare function used for usort-method</span><pre>cmp_array()</pre></a></li>
86
85
<li class="method protected inherited"><a href="#forceRefresh" title="forceRefresh :: Forces a refresh of the LDAP data."><span class="description">Forces a refresh of the LDAP data.</span><pre>forceRefresh()</pre></a></li>
87
86
<li class="method protected inherited"><a href="#getAdditionalLDAPAttributesToRead" title="getAdditionalLDAPAttributesToRead :: Returns a list of additional LDAP attributes that should be read."><span class="description">Returns a list of additional LDAP attributes that should be read.</span><pre>getAdditionalLDAPAttributesToRead()</pre></a></li>
88
87
<li class="method protected inherited"><a href="#getAdditionalTools" title="getAdditionalTools :: Returns a list of lamListTool objects to display next to the edit/delete buttons."><span class="description">Returns a list of lamListTool objects to display next to the edit/delete buttons.</span><pre>getAdditionalTools()</pre></a></li>
89
88
<li class="method protected inherited"><a href="#getFilterAsTextForURL" title="getFilterAsTextForURL :: Returns the filter as text to be used as URL parameter."><span class="description">Returns the filter as text to be used as URL parameter.</span><pre>getFilterAsTextForURL()</pre></a></li>
90
89
<li class="method protected inherited"><a href="#listBuildFilter" title="listBuildFilter :: Builds the regular expressions from the filter values."><span class="description">Builds the regular expressions from the filter values.</span><pre>listBuildFilter()</pre></a></li>
91
90
<li class="method protected inherited"><a href="#listConfigurationChanged" title="listConfigurationChanged :: Called when the configuration options changed."><span class="description">Called when the configuration options changed.</span><pre>listConfigurationChanged()</pre></a></li>
 
91
<li class="method protected inherited"><a href="#listCreateSortMapping" title="listCreateSortMapping :: Determines the sort mapping and stores it in $this-&gt;sortMapping."><span class="description">Determines the sort mapping and stores it in $this-&gt;sortMapping.</span><pre>listCreateSortMapping()</pre></a></li>
92
92
<li class="method protected inherited"><a href="#listDoPost" title="listDoPost :: Manages all POST actions (e.g."><span class="description">Manages all POST actions (e.g.</span><pre>listDoPost()</pre></a></li>
93
93
<li class="method protected inherited"><a href="#listDrawNavigationBar" title="listDrawNavigationBar :: Draws a navigation bar to switch between pages"><span class="description">Draws a navigation bar to switch between pages</span><pre>listDrawNavigationBar()</pre></a></li>
94
94
<li class="method protected inherited"><a href="#listGetAllConfigOptions" title="listGetAllConfigOptions :: Returns a list of possible configuration options."><span class="description">Returns a list of possible configuration options.</span><pre>listGetAllConfigOptions()</pre></a></li>
105
105
<li class="method protected inherited"><a href="#listPrintTableHeader" title="listPrintTableHeader :: Prints the attribute and filter row at the account table head"><span class="description">Prints the attribute and filter row at the account table head</span><pre>listPrintTableHeader()</pre></a></li>
106
106
<li class="method protected inherited"><a href="#listRefreshData" title="listRefreshData :: Rereads the entries from LDAP."><span class="description">Rereads the entries from LDAP.</span><pre>listRefreshData()</pre></a></li>
107
107
<li class="method protected inherited"><a href="#listShowOUSelection" title="listShowOUSelection :: Prints a combobox with possible sub-DNs."><span class="description">Prints a combobox with possible sub-DNs.</span><pre>listShowOUSelection()</pre></a></li>
108
 
<li class="method protected inherited"><a href="#listSort" title="listSort :: Sorts an account list by a given attribute"><span class="description">Sorts an account list by a given attribute</span><pre>listSort()</pre></a></li>
109
108
<li class="nav-header private">» Private</li>
110
109
<li class="method private inherited"><a href="#listPrintToolLinks" title="listPrintToolLinks :: Prints the tool image links (e.g."><span class="description">Prints the tool image links (e.g.</span><pre>listPrintToolLinks()</pre></a></li>
111
110
<li class="method private inherited"><a href="#listReadOptionsFromCookie" title="listReadOptionsFromCookie :: Reads the list options from the cookie value."><span class="description">Reads the list options from the cookie value.</span><pre>listReadOptionsFromCookie()</pre></a></li>
124
123
<li class="property protected inherited"><a href="#%24refresh" title="$refresh :: refresh page switch"><span class="description">refresh page switch</span><pre>$refresh</pre></a></li>
125
124
<li class="property protected inherited"><a href="#%24sortColumn" title="$sortColumn :: sort column name"><span class="description">sort column name</span><pre>$sortColumn</pre></a></li>
126
125
<li class="property protected inherited"><a href="#%24sortDirection" title="$sortDirection :: sort direction: 1 for ascending, -1 for descending"><span class="description">sort direction: 1 for ascending, -1 for descending</span><pre>$sortDirection</pre></a></li>
 
126
<li class="property protected inherited"><a href="#%24sortMapping" title="$sortMapping :: sort mapping for entries array(original index =&gt; sorted index)"><span class="description">sort mapping for entries array(original index =&gt; sorted index)</span><pre>$sortMapping</pre></a></li>
127
127
<li class="property protected inherited"><a href="#%24suffix" title="$suffix :: LDAP suffix"><span class="description">LDAP suffix</span><pre>$suffix</pre></a></li>
128
128
<li class="property protected inherited"><a href="#%24tabindex" title="$tabindex :: tabindex for GUI elements"><span class="description">tabindex for GUI elements</span><pre>$tabindex</pre></a></li>
129
129
<li class="property protected inherited"><a href="#%24type" title="$type :: Account type"><span class="description">Account type</span><pre>$type</pre></a></li>
242
242
<code>boolean</code>filtering possible</div>
243
243
</div></div>
244
244
</div>
245
 
<a name="cmp_array" id="cmp_array"></a><div class="element clickable method protected cmp_array" data-toggle="collapse" data-target=".cmp_array .collapse">
246
 
<h2>Compare function used for usort-method</h2>
247
 
<pre>cmp_array(array $a, array $b) : integer</pre>
248
 
<div class="labels"><span class="label">Inherited</span></div>
249
 
<div class="row collapse"><div class="detail-description">
250
 
<p class="long_description"><p>Rows are sorted with the first attribute entry of the sort column.
251
 
If objects have attributes with multiple values only the first is used for sorting.</p></p>
252
 
<table class="table table-bordered"><tr>
253
 
<th>inherited_from</th>
254
 
<td>\lamList::cmp_array()</td>
255
 
</tr></table>
256
 
<h3>Parameters</h3>
257
 
<div class="subelement argument">
258
 
<h4>$a</h4>
259
 
<code>array</code><p>first row which is compared</p></div>
260
 
<div class="subelement argument">
261
 
<h4>$b</h4>
262
 
<code>array</code><p>second row which is compared</p></div>
263
 
<h3>Returns</h3>
264
 
<div class="subelement response">
265
 
<code>integer</code>0 if both are equal, 1 if $a is greater, -1 if $b is greater</div>
266
 
</div></div>
267
 
</div>
268
245
<a name="forceRefresh" id="forceRefresh"></a><div class="element clickable method protected forceRefresh" data-toggle="collapse" data-target=".forceRefresh .collapse">
269
246
<h2>Forces a refresh of the LDAP data.</h2>
270
247
<pre>forceRefresh() </pre>
346
323
</tr></table>
347
324
</div></div>
348
325
</div>
 
326
<a name="listCreateSortMapping" id="listCreateSortMapping"></a><div class="element clickable method protected listCreateSortMapping" data-toggle="collapse" data-target=".listCreateSortMapping .collapse">
 
327
<h2>Determines the sort mapping and stores it in $this-&gt;sortMapping.</h2>
 
328
<pre>listCreateSortMapping(array $info) </pre>
 
329
<div class="labels"><span class="label">Inherited</span></div>
 
330
<div class="row collapse"><div class="detail-description">
 
331
<p class="long_description"><p>The sort mapping is used to display the right rows when the account table is created.</p></p>
 
332
<table class="table table-bordered"><tr>
 
333
<th>inherited_from</th>
 
334
<td>\lamList::listCreateSortMapping()</td>
 
335
</tr></table>
 
336
<h3>Parameters</h3>
 
337
<div class="subelement argument">
 
338
<h4>$info</h4>
 
339
<code>array</code><p>the account list</p></div>
 
340
</div></div>
 
341
</div>
349
342
<a name="listDoPost" id="listDoPost"></a><div class="element clickable method protected listDoPost" data-toggle="collapse" data-target=".listDoPost .collapse">
350
343
<h2>Manages all POST actions (e.g.</h2>
351
344
<pre>listDoPost() : String</pre>
573
566
<code><a href="../classes/htmlGroup.html">\htmlGroup</a></code>OU selection (may be empty)</div>
574
567
</div></div>
575
568
</div>
576
 
<a name="listSort" id="listSort"></a><div class="element clickable method protected listSort" data-toggle="collapse" data-target=".listSort .collapse">
577
 
<h2>Sorts an account list by a given attribute</h2>
578
 
<pre>listSort(array $info) </pre>
579
 
<div class="labels"><span class="label">Inherited</span></div>
580
 
<div class="row collapse"><div class="detail-description">
581
 
<p class="long_description"></p>
582
 
<table class="table table-bordered"><tr>
583
 
<th>inherited_from</th>
584
 
<td>\lamList::listSort()</td>
585
 
</tr></table>
586
 
<h3>Parameters</h3>
587
 
<div class="subelement argument">
588
 
<h4>$info</h4>
589
 
<code>array</code><p>the account list</p></div>
590
 
</div></div>
591
 
</div>
592
569
<a name="listPrintToolLinks" id="listPrintToolLinks"></a><div class="element clickable method private listPrintToolLinks" data-toggle="collapse" data-target=".listPrintToolLinks .collapse">
593
570
<h2>Prints the tool image links (e.g.</h2>
594
571
<pre>listPrintToolLinks(array $account, String $id) </pre>
770
747
</tr></table>
771
748
</div></div>
772
749
</div>
 
750
<a name="%24sortMapping" id="$sortMapping"> </a><div class="element clickable property protected $sortMapping" data-toggle="collapse" data-target=".$sortMapping .collapse">
 
751
<h2>sort mapping for entries array(original index =&gt; sorted index)</h2>
 
752
<pre>$sortMapping </pre>
 
753
<div class="labels"><span class="label">Inherited</span></div>
 
754
<div class="row collapse"><div class="detail-description">
 
755
<p class="long_description"></p>
 
756
<table class="table table-bordered"><tr>
 
757
<th>inherited_from</th>
 
758
<td>\lamList::$$sortMapping</td>
 
759
</tr></table>
 
760
</div></div>
 
761
</div>
773
762
<a name="%24suffix" id="$suffix"> </a><div class="element clickable property protected $suffix" data-toggle="collapse" data-target=".$suffix .collapse">
774
763
<h2>LDAP suffix</h2>
775
764
<pre>$suffix </pre>
851
840
<div class="row"><footer class="span12">
852
841
            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>
853
842
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
854
 
            generated on 2013-03-18T20:12:48+01:00.<br></footer></div>
 
843
            generated on 2013-06-17T21:08:42+02:00.<br></footer></div>
855
844
</div>
856
845
</body>
857
846
</html>