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

« back to all changes in this revision

Viewing changes to docs/devel/phpdoc/classes/lamGroupList.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>
86
86
<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>
87
87
<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>
88
88
<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>
89
 
<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>
90
89
<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>
91
90
<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>
92
91
<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>
93
92
<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>
94
93
<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>
95
94
<li class="method protected "><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>
 
95
<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>
96
96
<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>
97
97
<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>
98
98
<li class="method protected "><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>
106
106
<li class="method protected inherited"><a href="#listPrintTableBody" title="listPrintTableBody :: Prints the entry list"><span class="description">Prints the entry list</span><pre>listPrintTableBody()</pre></a></li>
107
107
<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>
108
108
<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>
109
 
<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>
110
109
<li class="nav-header private">» Private</li>
111
110
<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>
112
111
<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>
125
124
<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>
126
125
<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>
127
126
<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>
 
127
<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>
128
128
<li class="property protected inherited"><a href="#%24suffix" title="$suffix :: LDAP suffix"><span class="description">LDAP suffix</span><pre>$suffix</pre></a></li>
129
129
<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>
130
130
<li class="property protected inherited"><a href="#%24type" title="$type :: Account type"><span class="description">Account type</span><pre>$type</pre></a></li>
281
281
<code>boolean</code>filtering possible</div>
282
282
</div></div>
283
283
</div>
284
 
<a name="cmp_array" id="cmp_array"></a><div class="element clickable method protected cmp_array" data-toggle="collapse" data-target=".cmp_array .collapse">
285
 
<h2>Compare function used for usort-method</h2>
286
 
<pre>cmp_array(array $a, array $b) : integer</pre>
287
 
<div class="labels"><span class="label">Inherited</span></div>
288
 
<div class="row collapse"><div class="detail-description">
289
 
<p class="long_description"><p>Rows are sorted with the first attribute entry of the sort column.
290
 
If objects have attributes with multiple values only the first is used for sorting.</p></p>
291
 
<table class="table table-bordered"><tr>
292
 
<th>inherited_from</th>
293
 
<td>\lamList::cmp_array()</td>
294
 
</tr></table>
295
 
<h3>Parameters</h3>
296
 
<div class="subelement argument">
297
 
<h4>$a</h4>
298
 
<code>array</code><p>first row which is compared</p></div>
299
 
<div class="subelement argument">
300
 
<h4>$b</h4>
301
 
<code>array</code><p>second row which is compared</p></div>
302
 
<h3>Returns</h3>
303
 
<div class="subelement response">
304
 
<code>integer</code>0 if both are equal, 1 if $a is greater, -1 if $b is greater</div>
305
 
</div></div>
306
 
</div>
307
284
<a name="forceRefresh" id="forceRefresh"></a><div class="element clickable method protected forceRefresh" data-toggle="collapse" data-target=".forceRefresh .collapse">
308
285
<h2>Forces a refresh of the LDAP data.</h2>
309
286
<pre>forceRefresh() </pre>
379
356
<div class="labels"></div>
380
357
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
381
358
</div>
 
359
<a name="listCreateSortMapping" id="listCreateSortMapping"></a><div class="element clickable method protected listCreateSortMapping" data-toggle="collapse" data-target=".listCreateSortMapping .collapse">
 
360
<h2>Determines the sort mapping and stores it in $this-&gt;sortMapping.</h2>
 
361
<pre>listCreateSortMapping(array $info) </pre>
 
362
<div class="labels"><span class="label">Inherited</span></div>
 
363
<div class="row collapse"><div class="detail-description">
 
364
<p class="long_description"><p>The sort mapping is used to display the right rows when the account table is created.</p></p>
 
365
<table class="table table-bordered"><tr>
 
366
<th>inherited_from</th>
 
367
<td>\lamList::listCreateSortMapping()</td>
 
368
</tr></table>
 
369
<h3>Parameters</h3>
 
370
<div class="subelement argument">
 
371
<h4>$info</h4>
 
372
<code>array</code><p>the account list</p></div>
 
373
</div></div>
 
374
</div>
382
375
<a name="listDoPost" id="listDoPost"></a><div class="element clickable method protected listDoPost" data-toggle="collapse" data-target=".listDoPost .collapse">
383
376
<h2>Manages all POST actions (e.g.</h2>
384
377
<pre>listDoPost() : String</pre>
559
552
<code><a href="../classes/htmlGroup.html">\htmlGroup</a></code>OU selection (may be empty)</div>
560
553
</div></div>
561
554
</div>
562
 
<a name="listSort" id="listSort"></a><div class="element clickable method protected listSort" data-toggle="collapse" data-target=".listSort .collapse">
563
 
<h2>Sorts an account list by a given attribute</h2>
564
 
<pre>listSort(array $info) </pre>
565
 
<div class="labels"><span class="label">Inherited</span></div>
566
 
<div class="row collapse"><div class="detail-description">
567
 
<p class="long_description"></p>
568
 
<table class="table table-bordered"><tr>
569
 
<th>inherited_from</th>
570
 
<td>\lamList::listSort()</td>
571
 
</tr></table>
572
 
<h3>Parameters</h3>
573
 
<div class="subelement argument">
574
 
<h4>$info</h4>
575
 
<code>array</code><p>the account list</p></div>
576
 
</div></div>
577
 
</div>
578
555
<a name="listPrintToolLinks" id="listPrintToolLinks"></a><div class="element clickable method private listPrintToolLinks" data-toggle="collapse" data-target=".listPrintToolLinks .collapse">
579
556
<h2>Prints the tool image links (e.g.</h2>
580
557
<pre>listPrintToolLinks(array $account, String $id) </pre>
756
733
</tr></table>
757
734
</div></div>
758
735
</div>
 
736
<a name="%24sortMapping" id="$sortMapping"> </a><div class="element clickable property protected $sortMapping" data-toggle="collapse" data-target=".$sortMapping .collapse">
 
737
<h2>sort mapping for entries array(original index =&gt; sorted index)</h2>
 
738
<pre>$sortMapping </pre>
 
739
<div class="labels"><span class="label">Inherited</span></div>
 
740
<div class="row collapse"><div class="detail-description">
 
741
<p class="long_description"></p>
 
742
<table class="table table-bordered"><tr>
 
743
<th>inherited_from</th>
 
744
<td>\lamList::$$sortMapping</td>
 
745
</tr></table>
 
746
</div></div>
 
747
</div>
759
748
<a name="%24suffix" id="$suffix"> </a><div class="element clickable property protected $suffix" data-toggle="collapse" data-target=".$suffix .collapse">
760
749
<h2>LDAP suffix</h2>
761
750
<pre>$suffix </pre>
867
856
<div class="row"><footer class="span12">
868
857
            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>
869
858
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
870
 
            generated on 2013-03-18T20:12:48+01:00.<br></footer></div>
 
859
            generated on 2013-06-17T21:08:42+02:00.<br></footer></div>
871
860
</div>
872
861
</body>
873
862
</html>