|
1.2.16
by Roland Gruber
Import upstream version 3.8 |
1 |
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en"> |
2 |
<head> |
|
3 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
|
4 |
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> |
|
5 |
<meta charset="utf-8"> |
|
6 |
<title>LDAP Account Manager » \lamDHCPList</title> |
|
7 |
<meta name="author" content="Mike van Riel"> |
|
8 |
<meta name="description" content=""> |
|
9 |
<link href="../css/template.css" rel="stylesheet" media="all"> |
|
10 |
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico"> |
|
11 |
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png"> |
|
12 |
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png"> |
|
13 |
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png"> |
|
14 |
</head> |
|
15 |
<body> |
|
16 |
<div class="navbar navbar-fixed-top"> |
|
17 |
<div class="navbar-inner"><div class="container"> |
|
18 |
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">LDAP Account Manager</a><div class="nav-collapse"><ul class="nav"> |
|
19 |
<li class="dropdown"> |
|
20 |
<a href="#api" class="dropdown-toggle" data-toggle="dropdown"> |
|
21 |
API Documentation <b class="caret"></b></a><ul class="dropdown-menu"> |
|
22 |
<li><a>Packages</a></li> |
|
23 |
<li><a href="../packages/Crypt.html"><i class="icon-folder-open"></i> Crypt</a></li> |
|
24 |
<li><a href="../packages/Help.html"><i class="icon-folder-open"></i> Help</a></li> |
|
25 |
<li><a href="../packages/LDAP.html"><i class="icon-folder-open"></i> LDAP</a></li> |
|
26 |
<li><a href="../packages/Math.html"><i class="icon-folder-open"></i> Math</a></li> |
|
27 |
<li><a href="../packages/Net.html"><i class="icon-folder-open"></i> Net</a></li> |
|
28 |
<li><a href="../packages/PDF.html"><i class="icon-folder-open"></i> PDF</a></li> |
|
29 |
<li><a href="../packages/PHP.html"><i class="icon-folder-open"></i> PHP</a></li> |
|
30 |
<li><a href="../packages/configuration.html"><i class="icon-folder-open"></i> configuration</a></li> |
|
31 |
<li><a href="../packages/horde.html"><i class="icon-folder-open"></i> horde</a></li> |
|
32 |
<li><a href="../packages/lam.html"><i class="icon-folder-open"></i> lam</a></li> |
|
33 |
<li><a href="../packages/lib.html"><i class="icon-folder-open"></i> lib</a></li> |
|
34 |
<li><a href="../packages/lists.html"><i class="icon-folder-open"></i> lists</a></li> |
|
35 |
<li><a href="../packages/main.html"><i class="icon-folder-open"></i> main</a></li> |
|
36 |
<li><a href="../packages/metaHTML.html"><i class="icon-folder-open"></i> metaHTML</a></li> |
|
37 |
<li><a href="../packages/modules.html"><i class="icon-folder-open"></i> modules</a></li> |
|
38 |
<li><a href="../packages/phpLDAPadmin.html"><i class="icon-folder-open"></i> phpLDAPadmin</a></li> |
|
39 |
<li><a href="../packages/profiles.html"><i class="icon-folder-open"></i> profiles</a></li> |
|
40 |
<li><a href="../packages/selfService.html"><i class="icon-folder-open"></i> selfService</a></li> |
|
41 |
<li><a href="../packages/tools.html"><i class="icon-folder-open"></i> tools</a></li> |
|
42 |
<li><a href="../packages/types.html"><i class="icon-folder-open"></i> types</a></li> |
|
43 |
</ul> |
|
44 |
</li> |
|
45 |
<li class="dropdown" id="charts-menu"> |
|
46 |
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown"> |
|
47 |
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul> |
|
48 |
</li> |
|
49 |
<li class="dropdown" id="reports-menu"> |
|
50 |
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> |
|
51 |
Reports <b class="caret"></b></a><ul class="dropdown-menu"> |
|
52 |
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors |
|
|
1.2.21
by Roland Gruber
Import upstream version 4.2.1 |
53 |
<span class="label label-info">1055</span></a></li> |
|
1.2.16
by Roland Gruber
Import upstream version 3.8 |
54 |
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers |
55 |
<ul><li>todo |
|
|
1.2.21
by Roland Gruber
Import upstream version 4.2.1 |
56 |
<span class="label label-info">15</span> |
|
1.2.16
by Roland Gruber
Import upstream version 3.8 |
57 |
</li></ul></a></li> |
58 |
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements |
|
59 |
<span class="label label-info">0</span></a></li> |
|
60 |
</ul> |
|
61 |
</li> |
|
62 |
</ul></div> |
|
63 |
</div></div> |
|
64 |
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div> |
|
65 |
</div> |
|
66 |
<div id="___" class="container"> |
|
67 |
<noscript><div class="alert alert-warning"> |
|
68 |
Javascript is disabled; several features are only available |
|
69 |
if Javascript is enabled. |
|
70 |
</div></noscript> |
|
71 |
<div class="row"> |
|
72 |
<div class="span4"> |
|
73 |
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio"> |
|
74 |
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button> |
|
75 |
</div> |
|
76 |
<ul class="side-nav nav nav-list"> |
|
77 |
<li class="nav-header"> |
|
78 |
<i class="icon-custom icon-method"></i> Methods</li> |
|
79 |
<li class="method public "><a href="#__construct" title="__construct :: Constructor"><span class="description">Constructor</span><pre>__construct()</pre></a></li> |
|
80 |
<li class="method public "><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> |
|
81 |
<li class="method public "><a href="#listPrintTableCellContent" title="listPrintTableCellContent :: Prints the content of a cell in the account list for a given LDAP entry and attribute."><span class="description">Prints the content of a cell in the account list for a given LDAP entry and attribute.</span><pre>listPrintTableCellContent()</pre></a></li> |
|
82 |
<li class="method public inherited"><a href="#showPage" title="showPage :: Prints the HTML code to display the list view."><span class="description">Prints the HTML code to display the list view.</span><pre>showPage()</pre></a></li> |
|
83 |
<li class="nav-header protected">» Protected</li> |
|
|
1.2.18
by Roland Gruber
Import upstream version 4.0 |
84 |
<li class="method protected "><a href="#addExtraInputElementsToTopArea" title="addExtraInputElementsToTopArea :: Add DCP main settings button."><span class="description">Add DCP main settings button.</span><pre>addExtraInputElementsToTopArea()</pre></a></li> |
|
1.2.20
by Roland Gruber
Import upstream version 4.1 |
85 |
<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> |
|
1.2.16
by Roland Gruber
Import upstream version 3.8 |
86 |
<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> |
|
1.2.20
by Roland Gruber
Import upstream version 4.1 |
87 |
<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> |
|
1.2.16
by Roland Gruber
Import upstream version 3.8 |
88 |
<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> |
89 |
<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> |
|
|
1.2.20
by Roland Gruber
Import upstream version 4.1 |
90 |
<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> |
|
1.2.16
by Roland Gruber
Import upstream version 3.8 |
91 |
<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> |
92 |
<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> |
|
|
1.2.21
by Roland Gruber
Import upstream version 4.2.1 |
93 |
<li class="method protected inherited"><a href="#listCreateSortMapping" title="listCreateSortMapping :: Determines the sort mapping and stores it in $this->sortMapping."><span class="description">Determines the sort mapping and stores it in $this->sortMapping.</span><pre>listCreateSortMapping()</pre></a></li> |
|
1.2.16
by Roland Gruber
Import upstream version 3.8 |
94 |
<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> |
95 |
<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> |
|
96 |
<li class="method protected inherited"><a href="#listGetAttributeDescriptionList" title="listGetAttributeDescriptionList :: Returns an hash array containing with all attributes to be shown and their descriptions."><span class="description">Returns an hash array containing with all attributes to be shown and their descriptions.</span><pre>listGetAttributeDescriptionList()</pre></a></li> |
|
97 |
<li class="method protected inherited"><a href="#listGetConfigOptionByID" title="listGetConfigOptionByID :: Returns the configuration option with the given ID."><span class="description">Returns the configuration option with the given ID.</span><pre>listGetConfigOptionByID()</pre></a></li> |
|
98 |
<li class="method protected inherited"><a href="#listGetParams" title="listGetParams :: Sets some internal parameters."><span class="description">Sets some internal parameters.</span><pre>listGetParams()</pre></a></li> |
|
|
1.2.18
by Roland Gruber
Import upstream version 4.0 |
99 |
<li class="method protected inherited"><a href="#listPrintButtons" title="listPrintButtons :: Prints the create and delete buttons."><span class="description">Prints the create and delete buttons.</span><pre>listPrintButtons()</pre></a></li> |
|
1.2.16
by Roland Gruber
Import upstream version 3.8 |
100 |
<li class="method protected inherited"><a href="#listPrintConfigurationPage" title="listPrintConfigurationPage :: Prints the list configuration page."><span class="description">Prints the list configuration page.</span><pre>listPrintConfigurationPage()</pre></a></li> |
101 |
<li class="method protected inherited"><a href="#listPrintFooter" title="listPrintFooter :: Prints the HTML footer."><span class="description">Prints the HTML footer.</span><pre>listPrintFooter()</pre></a></li> |
|
102 |
<li class="method protected inherited"><a href="#listPrintHeader" title="listPrintHeader :: Prints the HTML header."><span class="description">Prints the HTML header.</span><pre>listPrintHeader()</pre></a></li> |
|
103 |
<li class="method protected inherited"><a href="#listPrintRedirectMessages" title="listPrintRedirectMessages :: Prints messages when another page (e.g."><span class="description">Prints messages when another page (e.g.</span><pre>listPrintRedirectMessages()</pre></a></li> |
|
104 |
<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> |
|
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 |
<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 |
<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="nav-header private">» Private</li> |
|
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> |
|
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> |
|
111 |
<li class="method private inherited"><a href="#showPDFPage" title="showPDFPage :: Shows the page where the user may select the PDF options."><span class="description">Shows the page where the user may select the PDF options.</span><pre>showPDFPage()</pre></a></li> |
|
112 |
<li class="nav-header"> |
|
113 |
<i class="icon-custom icon-property"></i> Properties</li> |
|
114 |
<li class="nav-header protected">» Protected</li> |
|
115 |
<li class="property protected inherited"><a href="#%24attrArray" title="$attrArray :: list of LDAP attributes"><span class="description">list of LDAP attributes</span><pre>$attrArray</pre></a></li> |
|
116 |
<li class="property protected inherited"><a href="#%24descArray" title="$descArray :: list of attribute descriptions"><span class="description">list of attribute descriptions</span><pre>$descArray</pre></a></li> |
|
117 |
<li class="property protected inherited"><a href="#%24entries" title="$entries :: LDAP entries"><span class="description">LDAP entries</span><pre>$entries</pre></a></li> |
|
|
1.2.20
by Roland Gruber
Import upstream version 4.1 |
118 |
<li class="property protected inherited"><a href="#%24filters" title="$filters :: list of filters (attribute name => filter input)"><span class="description">list of filters (attribute name => filter input)</span><pre>$filters</pre></a></li> |
|
1.2.16
by Roland Gruber
Import upstream version 3.8 |
119 |
<li class="property protected inherited"><a href="#%24labels" title="$labels :: list of account specific labels"><span class="description">list of account specific labels</span><pre>$labels</pre></a></li> |
120 |
<li class="property protected inherited"><a href="#%24maxPageEntries" title="$maxPageEntries :: maximum count of entries per page"><span class="description">maximum count of entries per page</span><pre>$maxPageEntries</pre></a></li> |
|
121 |
<li class="property protected inherited"><a href="#%24page" title="$page :: current page number"><span class="description">current page number</span><pre>$page</pre></a></li> |
|
122 |
<li class="property protected inherited"><a href="#%24possibleSuffixes" title="$possibleSuffixes :: list of possible LDAP suffixes(organizational units)"><span class="description">list of possible LDAP suffixes(organizational units)</span><pre>$possibleSuffixes</pre></a></li> |
|
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> |
|
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> |
|
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> |
|
|
1.2.21
by Roland Gruber
Import upstream version 4.2.1 |
126 |
<li class="property protected inherited"><a href="#%24sortMapping" title="$sortMapping :: sort mapping for entries array(original index => sorted index)"><span class="description">sort mapping for entries array(original index => sorted index)</span><pre>$sortMapping</pre></a></li> |
|
1.2.16
by Roland Gruber
Import upstream version 3.8 |
127 |
<li class="property protected inherited"><a href="#%24suffix" title="$suffix :: LDAP suffix"><span class="description">LDAP suffix</span><pre>$suffix</pre></a></li> |
|
1.2.17
by Roland Gruber
Import upstream version 3.9 |
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> |
|
1.2.16
by Roland Gruber
Import upstream version 3.8 |
129 |
<li class="property protected inherited"><a href="#%24type" title="$type :: Account type"><span class="description">Account type</span><pre>$type</pre></a></li> |
130 |
<li class="nav-header private">» Private</li> |
|
131 |
<li class="property private inherited"><a href="#%24configOptions" title="$configOptions :: configuration options"><span class="description">configuration options</span><pre>$configOptions</pre></a></li> |
|
132 |
<li class="nav-header"> |
|
133 |
<i class="icon-custom icon-constant"></i> Constants</li> |
|
134 |
<li class="constant inherited"><a href="#LIST_SIZE_OPTION_NAME" title="LIST_SIZE_OPTION_NAME :: ID for list size config option"><span class="description">ID for list size config option</span><pre>LIST_SIZE_OPTION_NAME</pre></a></li> |
|
135 |
<li class="constant inherited"><a href="#VIRTUAL_ATTRIBUTE_PREFIX" title="VIRTUAL_ATTRIBUTE_PREFIX :: prefix for virtual (non-LDAP) attributes"><span class="description">prefix for virtual (non-LDAP) attributes</span><pre>VIRTUAL_ATTRIBUTE_PREFIX</pre></a></li> |
|
136 |
</ul> |
|
137 |
</div> |
|
138 |
<div class="span8"> |
|
139 |
<a name="%5ClamDHCPList" id="\lamDHCPList"></a><ul class="breadcrumb"> |
|
140 |
<li> |
|
141 |
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span> |
|
142 |
</li> |
|
143 |
<li><a href="../namespaces/global.html">global</a></li> |
|
144 |
<li class="active"> |
|
145 |
<span class="divider">\</span><a href="../classes/lamDHCPList.html">lamDHCPList</a> |
|
146 |
</li> |
|
147 |
</ul> |
|
148 |
<div href="../classes/lamDHCPList.html" class="element class"> |
|
149 |
<p class="short_description">Generates the list view.</p> |
|
150 |
<div class="details"> |
|
151 |
<p class="long_description"></p> |
|
152 |
<table class="table table-bordered"> |
|
153 |
<tr> |
|
154 |
<th>package</th> |
|
155 |
<td><a href="../packages/lists.html">lists</a></td> |
|
156 |
</tr> |
|
157 |
<tr> |
|
158 |
<th>author</th> |
|
159 |
<td><a href="">Thomas Manninger</a></td> |
|
160 |
</tr> |
|
161 |
</table> |
|
162 |
<h3> |
|
163 |
<i class="icon-custom icon-method"></i> Methods</h3> |
|
164 |
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse"> |
|
165 |
<h2>Constructor</h2> |
|
166 |
<pre>__construct(string $type) : <a href="../classes/lamList.html">\lamList</a></pre> |
|
167 |
<div class="labels"></div> |
|
168 |
<div class="row collapse"><div class="detail-description"> |
|
169 |
<p class="long_description"></p> |
|
170 |
<h3>Parameters</h3> |
|
171 |
<div class="subelement argument"> |
|
172 |
<h4>$type</h4> |
|
173 |
<code>string</code><p>account type</p></div> |
|
174 |
<h3>Returns</h3> |
|
175 |
<div class="subelement response"> |
|
176 |
<code><a href="../classes/lamList.html">\lamList</a></code>list object</div> |
|
177 |
</div></div> |
|
178 |
</div> |
|
179 |
<a name="listDoPost" id="listDoPost"></a><div class="element clickable method public listDoPost" data-toggle="collapse" data-target=".listDoPost .collapse"> |
|
180 |
<h2>Manages all POST actions (e.g.</h2> |
|
181 |
<pre>listDoPost() : String</pre> |
|
182 |
<div class="labels"></div> |
|
183 |
<div class="row collapse"><div class="detail-description"> |
|
184 |
<p class="long_description"><p>button pressed) for the account lists.</p></p> |
|
185 |
<h3>Returns</h3> |
|
186 |
<div class="subelement response"> |
|
187 |
<code>String</code>HTML fragment to insert into beginning of account list</div> |
|
188 |
</div></div> |
|
189 |
</div> |
|
190 |
<a name="listPrintTableCellContent" id="listPrintTableCellContent"></a><div class="element clickable method public listPrintTableCellContent" data-toggle="collapse" data-target=".listPrintTableCellContent .collapse"> |
|
191 |
<h2>Prints the content of a cell in the account list for a given LDAP entry and attribute.</h2> |
|
192 |
<pre>listPrintTableCellContent(array $entry, string $attribute) </pre> |
|
193 |
<div class="labels"></div> |
|
194 |
<div class="row collapse"><div class="detail-description"> |
|
195 |
<p class="long_description"></p> |
|
196 |
<h3>Parameters</h3> |
|
197 |
<div class="subelement argument"> |
|
198 |
<h4>$entry</h4> |
|
199 |
<code>array</code><p>LDAP attributes</p></div> |
|
200 |
<div class="subelement argument"> |
|
201 |
<h4>$attribute</h4> |
|
202 |
<code>string</code><p>attribute name</p></div> |
|
203 |
</div></div> |
|
204 |
</div> |
|
205 |
<a name="showPage" id="showPage"></a><div class="element clickable method public showPage" data-toggle="collapse" data-target=".showPage .collapse"> |
|
206 |
<h2>Prints the HTML code to display the list view.</h2> |
|
207 |
<pre>showPage() </pre> |
|
208 |
<div class="labels"><span class="label">Inherited</span></div> |
|
209 |
<div class="row collapse"><div class="detail-description"> |
|
210 |
<p class="long_description"></p> |
|
211 |
<table class="table table-bordered"><tr> |
|
212 |
<th>inherited_from</th> |
|
213 |
<td>\lamList::showPage()</td> |
|
214 |
</tr></table> |
|
215 |
</div></div> |
|
216 |
</div> |
|
|
1.2.18
by Roland Gruber
Import upstream version 4.0 |
217 |
<a name="addExtraInputElementsToTopArea" id="addExtraInputElementsToTopArea"></a><div class="element clickable method protected addExtraInputElementsToTopArea" data-toggle="collapse" data-target=".addExtraInputElementsToTopArea .collapse"> |
218 |
<h2>Add DCP main settings button.</h2> |
|
219 |
<pre>addExtraInputElementsToTopArea(<a href="../classes/htmlGroup.html">\htmlGroup</a> $left, <a href="../classes/htmlGroup.html">\htmlGroup</a> $right) </pre> |
|
220 |
<div class="labels"></div> |
|
221 |
<div class="row collapse"><div class="detail-description"> |
|
222 |
<p class="long_description"><p>additional buttons to the top area.</p></p> |
|
223 |
<h3>Parameters</h3> |
|
224 |
<div class="subelement argument"> |
|
225 |
<h4>$left</h4> |
|
226 |
<code><a href="../classes/htmlGroup.html">\htmlGroup</a></code><p>left part</p></div> |
|
227 |
<div class="subelement argument"> |
|
228 |
<h4>$right</h4> |
|
229 |
<code><a href="../classes/htmlGroup.html">\htmlGroup</a></code><p>right part</p></div> |
|
230 |
</div></div> |
|
231 |
</div> |
|
|
1.2.20
by Roland Gruber
Import upstream version 4.1 |
232 |
<a name="buildLDAPAttributeFilter" id="buildLDAPAttributeFilter"></a><div class="element clickable method protected buildLDAPAttributeFilter" data-toggle="collapse" data-target=".buildLDAPAttributeFilter .collapse"> |
233 |
<h2>Builds the LDAP filter based on the filter entries in the GUI.</h2> |
|
234 |
<pre>buildLDAPAttributeFilter() : String</pre> |
|
235 |
<div class="labels"><span class="label">Inherited</span></div> |
|
236 |
<div class="row collapse"><div class="detail-description"> |
|
237 |
<p class="long_description"></p> |
|
238 |
<table class="table table-bordered"><tr> |
|
239 |
<th>inherited_from</th> |
|
240 |
<td>\lamList::buildLDAPAttributeFilter()</td> |
|
241 |
</tr></table> |
|
242 |
<h3>Returns</h3> |
|
243 |
<div class="subelement response"> |
|
244 |
<code>String</code>LDAP filter</div> |
|
245 |
</div></div> |
|
246 |
</div> |
|
|
1.2.16
by Roland Gruber
Import upstream version 3.8 |
247 |
<a name="canBeFiltered" id="canBeFiltered"></a><div class="element clickable method protected canBeFiltered" data-toggle="collapse" data-target=".canBeFiltered .collapse"> |
248 |
<h2>Returns if the given attribute can be filtered.</h2> |
|
249 |
<pre>canBeFiltered(String $attr) : boolean</pre> |
|
250 |
<div class="labels"><span class="label">Inherited</span></div> |
|
251 |
<div class="row collapse"><div class="detail-description"> |
|
252 |
<p class="long_description"><p>If filtering is not possible then no filter box will be displayed. |
|
253 |
By default all attributes can be filtered.</p></p> |
|
254 |
<table class="table table-bordered"><tr> |
|
255 |
<th>inherited_from</th> |
|
256 |
<td>\lamList::canBeFiltered()</td> |
|
257 |
</tr></table> |
|
258 |
<h3>Parameters</h3> |
|
259 |
<div class="subelement argument"> |
|
260 |
<h4>$attr</h4> |
|
261 |
<code>String</code><p>attribute name</p></div> |
|
262 |
<h3>Returns</h3> |
|
263 |
<div class="subelement response"> |
|
264 |
<code>boolean</code>filtering possible</div> |
|
265 |
</div></div> |
|
266 |
</div> |
|
|
1.2.20
by Roland Gruber
Import upstream version 4.1 |
267 |
<a name="forceRefresh" id="forceRefresh"></a><div class="element clickable method protected forceRefresh" data-toggle="collapse" data-target=".forceRefresh .collapse"> |
268 |
<h2>Forces a refresh of the LDAP data.</h2> |
|
269 |
<pre>forceRefresh() </pre> |
|
270 |
<div class="labels"><span class="label">Inherited</span></div> |
|
271 |
<div class="row collapse"><div class="detail-description"> |
|
272 |
<p class="long_description"><p>Function must be called before $this->refresh option is checked to load new LDAP data (e.g. in listGetParams).</p></p> |
|
273 |
<table class="table table-bordered"><tr> |
|
274 |
<th>inherited_from</th> |
|
275 |
<td>\lamList::forceRefresh()</td> |
|
276 |
</tr></table> |
|
277 |
</div></div> |
|
278 |
</div> |
|
|
1.2.16
by Roland Gruber
Import upstream version 3.8 |
279 |
<a name="getAdditionalLDAPAttributesToRead" id="getAdditionalLDAPAttributesToRead"></a><div class="element clickable method protected getAdditionalLDAPAttributesToRead" data-toggle="collapse" data-target=".getAdditionalLDAPAttributesToRead .collapse"> |
280 |
<h2>Returns a list of additional LDAP attributes that should be read.</h2> |
|
281 |
<pre>getAdditionalLDAPAttributesToRead() : array</pre> |
|
282 |
<div class="labels"><span class="label">Inherited</span></div> |
|
283 |
<div class="row collapse"><div class="detail-description"> |
|
284 |
<p class="long_description"><p>This can be used to show additional data even if the user selected other attributes to show in the list.</p></p> |
|
285 |
<table class="table table-bordered"><tr> |
|
286 |
<th>inherited_from</th> |
|
287 |
<td>\lamList::getAdditionalLDAPAttributesToRead()</td> |
|
288 |
</tr></table> |
|
289 |
<h3>Returns</h3> |
|
290 |
<div class="subelement response"> |
|
291 |
<code>array</code>additional attribute names</div> |
|
292 |
</div></div> |
|
293 |
</div> |
|
294 |
<a name="getAdditionalTools" id="getAdditionalTools"></a><div class="element clickable method protected getAdditionalTools" data-toggle="collapse" data-target=".getAdditionalTools .collapse"> |
|
295 |
<h2>Returns a list of lamListTool objects to display next to the edit/delete buttons.</h2> |
|
296 |
<pre>getAdditionalTools() : <a href="lib.lists.inc.html#%5ClamListTool">\lamListTool[]</a></pre> |
|
297 |
<div class="labels"><span class="label">Inherited</span></div> |
|
298 |
<div class="row collapse"><div class="detail-description"> |
|
299 |
<p class="long_description"></p> |
|
300 |
<table class="table table-bordered"><tr> |
|
301 |
<th>inherited_from</th> |
|
302 |
<td>\lamList::getAdditionalTools()</td> |
|
303 |
</tr></table> |
|
304 |
<h3>Returns</h3> |
|
305 |
<div class="subelement response"> |
|
306 |
<code><a href="lib.lists.inc.html#%5ClamListTool">\lamListTool[]</a></code>tools</div> |
|
307 |
</div></div> |
|
308 |
</div> |
|
|
1.2.20
by Roland Gruber
Import upstream version 4.1 |
309 |
<a name="getFilterAsTextForURL" id="getFilterAsTextForURL"></a><div class="element clickable method protected getFilterAsTextForURL" data-toggle="collapse" data-target=".getFilterAsTextForURL .collapse"> |
310 |
<h2>Returns the filter as text to be used as URL parameter.</h2> |
|
311 |
<pre>getFilterAsTextForURL() : String</pre> |
|
312 |
<div class="labels"><span class="label">Inherited</span></div> |
|
313 |
<div class="row collapse"><div class="detail-description"> |
|
314 |
<p class="long_description"></p> |
|
315 |
<table class="table table-bordered"><tr> |
|
316 |
<th>inherited_from</th> |
|
317 |
<td>\lamList::getFilterAsTextForURL()</td> |
|
318 |
</tr></table> |
|
319 |
<h3>Returns</h3> |
|
320 |
<div class="subelement response"> |
|
321 |
<code>String</code>filter text</div> |
|
322 |
</div></div> |
|
323 |
</div> |
|
|
1.2.16
by Roland Gruber
Import upstream version 3.8 |
324 |
<a name="listBuildFilter" id="listBuildFilter"></a><div class="element clickable method protected listBuildFilter" data-toggle="collapse" data-target=".listBuildFilter .collapse"> |
325 |
<h2>Builds the regular expressions from the filter values.</h2> |
|
326 |
<pre>listBuildFilter() </pre> |
|
327 |
<div class="labels"><span class="label">Inherited</span></div> |
|
328 |
<div class="row collapse"><div class="detail-description"> |
|
329 |
<p class="long_description"></p> |
|
330 |
<table class="table table-bordered"><tr> |
|
331 |
<th>inherited_from</th> |
|
332 |
<td>\lamList::listBuildFilter()</td> |
|
333 |
</tr></table> |
|
334 |
</div></div> |
|
335 |
</div> |
|
336 |
<a name="listConfigurationChanged" id="listConfigurationChanged"></a><div class="element clickable method protected listConfigurationChanged" data-toggle="collapse" data-target=".listConfigurationChanged .collapse"> |
|
337 |
<h2>Called when the configuration options changed.</h2> |
|
338 |
<pre>listConfigurationChanged() </pre> |
|
339 |
<div class="labels"><span class="label">Inherited</span></div> |
|
340 |
<div class="row collapse"><div class="detail-description"> |
|
341 |
<p class="long_description"></p> |
|
342 |
<table class="table table-bordered"><tr> |
|
343 |
<th>inherited_from</th> |
|
344 |
<td>\lamList::listConfigurationChanged()</td> |
|
345 |
</tr></table> |
|
346 |
</div></div> |
|
347 |
</div> |
|
|
1.2.21
by Roland Gruber
Import upstream version 4.2.1 |
348 |
<a name="listCreateSortMapping" id="listCreateSortMapping"></a><div class="element clickable method protected listCreateSortMapping" data-toggle="collapse" data-target=".listCreateSortMapping .collapse"> |
349 |
<h2>Determines the sort mapping and stores it in $this->sortMapping.</h2> |
|
350 |
<pre>listCreateSortMapping(array $info) </pre> |
|
351 |
<div class="labels"><span class="label">Inherited</span></div> |
|
352 |
<div class="row collapse"><div class="detail-description"> |
|
353 |
<p class="long_description"><p>The sort mapping is used to display the right rows when the account table is created.</p></p> |
|
354 |
<table class="table table-bordered"><tr> |
|
355 |
<th>inherited_from</th> |
|
356 |
<td>\lamList::listCreateSortMapping()</td> |
|
357 |
</tr></table> |
|
358 |
<h3>Parameters</h3> |
|
359 |
<div class="subelement argument"> |
|
360 |
<h4>$info</h4> |
|
361 |
<code>array</code><p>the account list</p></div> |
|
362 |
</div></div> |
|
363 |
</div> |
|
|
1.2.16
by Roland Gruber
Import upstream version 3.8 |
364 |
<a name="listDrawNavigationBar" id="listDrawNavigationBar"></a><div class="element clickable method protected listDrawNavigationBar" data-toggle="collapse" data-target=".listDrawNavigationBar .collapse"> |
365 |
<h2>Draws a navigation bar to switch between pages</h2> |
|
366 |
<pre>listDrawNavigationBar(integer $count) </pre> |
|
367 |
<div class="labels"><span class="label">Inherited</span></div> |
|
368 |
<div class="row collapse"><div class="detail-description"> |
|
369 |
<p class="long_description"></p> |
|
370 |
<table class="table table-bordered"><tr> |
|
371 |
<th>inherited_from</th> |
|
372 |
<td>\lamList::listDrawNavigationBar()</td> |
|
373 |
</tr></table> |
|
374 |
<h3>Parameters</h3> |
|
375 |
<div class="subelement argument"> |
|
376 |
<h4>$count</h4> |
|
377 |
<code>integer</code><p>number of account entries</p></div> |
|
378 |
</div></div> |
|
379 |
</div> |
|
380 |
<a name="listGetAllConfigOptions" id="listGetAllConfigOptions"></a><div class="element clickable method protected listGetAllConfigOptions" data-toggle="collapse" data-target=".listGetAllConfigOptions .collapse"> |
|
381 |
<h2>Returns a list of possible configuration options.</h2> |
|
382 |
<pre>listGetAllConfigOptions() : array</pre> |
|
383 |
<div class="labels"><span class="label">Inherited</span></div> |
|
384 |
<div class="row collapse"><div class="detail-description"> |
|
385 |
<p class="long_description"></p> |
|
386 |
<table class="table table-bordered"><tr> |
|
387 |
<th>inherited_from</th> |
|
388 |
<td>\lamList::listGetAllConfigOptions()</td> |
|
389 |
</tr></table> |
|
390 |
<h3>Returns</h3> |
|
391 |
<div class="subelement response"> |
|
392 |
<code>array</code>list of lamListOption objects</div> |
|
393 |
</div></div> |
|
394 |
</div> |
|
395 |
<a name="listGetAttributeDescriptionList" id="listGetAttributeDescriptionList"></a><div class="element clickable method protected listGetAttributeDescriptionList" data-toggle="collapse" data-target=".listGetAttributeDescriptionList .collapse"> |
|
396 |
<h2>Returns an hash array containing with all attributes to be shown and their descriptions.</h2> |
|
397 |
<pre>listGetAttributeDescriptionList() : array</pre> |
|
398 |
<div class="labels"><span class="label">Inherited</span></div> |
|
399 |
<div class="row collapse"><div class="detail-description"> |
|
400 |
<p class="long_description"><p>Format: array(attribute => description)</p></p> |
|
401 |
<table class="table table-bordered"><tr> |
|
402 |
<th>inherited_from</th> |
|
403 |
<td>\lamList::listGetAttributeDescriptionList()</td> |
|
404 |
</tr></table> |
|
405 |
<h3>Returns</h3> |
|
406 |
<div class="subelement response"> |
|
407 |
<code>array</code>attribute list</div> |
|
408 |
</div></div> |
|
409 |
</div> |
|
410 |
<a name="listGetConfigOptionByID" id="listGetConfigOptionByID"></a><div class="element clickable method protected listGetConfigOptionByID" data-toggle="collapse" data-target=".listGetConfigOptionByID .collapse"> |
|
411 |
<h2>Returns the configuration option with the given ID.</h2> |
|
412 |
<pre>listGetConfigOptionByID(String $ID) </pre> |
|
413 |
<div class="labels"><span class="label">Inherited</span></div> |
|
414 |
<div class="row collapse"><div class="detail-description"> |
|
415 |
<p class="long_description"></p> |
|
416 |
<table class="table table-bordered"><tr> |
|
417 |
<th>inherited_from</th> |
|
418 |
<td>\lamList::listGetConfigOptionByID()</td> |
|
419 |
</tr></table> |
|
420 |
<h3>Parameters</h3> |
|
421 |
<div class="subelement argument"> |
|
422 |
<h4>$ID</h4> |
|
423 |
<code>String</code><p>ID</p></div> |
|
424 |
</div></div> |
|
425 |
</div> |
|
426 |
<a name="listGetParams" id="listGetParams"></a><div class="element clickable method protected listGetParams" data-toggle="collapse" data-target=".listGetParams .collapse"> |
|
427 |
<h2>Sets some internal parameters.</h2> |
|
428 |
<pre>listGetParams() </pre> |
|
429 |
<div class="labels"><span class="label">Inherited</span></div> |
|
430 |
<div class="row collapse"><div class="detail-description"> |
|
431 |
<p class="long_description"></p> |
|
432 |
<table class="table table-bordered"><tr> |
|
433 |
<th>inherited_from</th> |
|
434 |
<td>\lamList::listGetParams()</td> |
|
435 |
</tr></table> |
|
436 |
</div></div> |
|
437 |
</div> |
|
|
1.2.18
by Roland Gruber
Import upstream version 4.0 |
438 |
<a name="listPrintButtons" id="listPrintButtons"></a><div class="element clickable method protected listPrintButtons" data-toggle="collapse" data-target=".listPrintButtons .collapse"> |
439 |
<h2>Prints the create and delete buttons.</h2> |
|
440 |
<pre>listPrintButtons(boolean $createOnly) </pre> |
|
441 |
<div class="labels"><span class="label">Inherited</span></div> |
|
442 |
<div class="row collapse"><div class="detail-description"> |
|
443 |
<p class="long_description"></p> |
|
444 |
<table class="table table-bordered"><tr> |
|
445 |
<th>inherited_from</th> |
|
446 |
<td>\lamList::listPrintButtons()</td> |
|
447 |
</tr></table> |
|
448 |
<h3>Parameters</h3> |
|
449 |
<div class="subelement argument"> |
|
450 |
<h4>$createOnly</h4> |
|
451 |
<code>boolean</code><p>true if only the create button should be displayed</p></div> |
|
452 |
</div></div> |
|
453 |
</div> |
|
|
1.2.16
by Roland Gruber
Import upstream version 3.8 |
454 |
<a name="listPrintConfigurationPage" id="listPrintConfigurationPage"></a><div class="element clickable method protected listPrintConfigurationPage" data-toggle="collapse" data-target=".listPrintConfigurationPage .collapse"> |
455 |
<h2>Prints the list configuration page.</h2> |
|
456 |
<pre>listPrintConfigurationPage() </pre> |
|
457 |
<div class="labels"><span class="label">Inherited</span></div> |
|
458 |
<div class="row collapse"><div class="detail-description"> |
|
459 |
<p class="long_description"></p> |
|
460 |
<table class="table table-bordered"><tr> |
|
461 |
<th>inherited_from</th> |
|
462 |
<td>\lamList::listPrintConfigurationPage()</td> |
|
463 |
</tr></table> |
|
464 |
</div></div> |
|
465 |
</div> |
|
466 |
<a name="listPrintFooter" id="listPrintFooter"></a><div class="element clickable method protected listPrintFooter" data-toggle="collapse" data-target=".listPrintFooter .collapse"> |
|
467 |
<h2>Prints the HTML footer.</h2> |
|
468 |
<pre>listPrintFooter() </pre> |
|
469 |
<div class="labels"><span class="label">Inherited</span></div> |
|
470 |
<div class="row collapse"><div class="detail-description"> |
|
471 |
<p class="long_description"></p> |
|
472 |
<table class="table table-bordered"><tr> |
|
473 |
<th>inherited_from</th> |
|
474 |
<td>\lamList::listPrintFooter()</td> |
|
475 |
</tr></table> |
|
476 |
</div></div> |
|
477 |
</div> |
|
478 |
<a name="listPrintHeader" id="listPrintHeader"></a><div class="element clickable method protected listPrintHeader" data-toggle="collapse" data-target=".listPrintHeader .collapse"> |
|
479 |
<h2>Prints the HTML header.</h2> |
|
480 |
<pre>listPrintHeader() </pre> |
|
481 |
<div class="labels"><span class="label">Inherited</span></div> |
|
482 |
<div class="row collapse"><div class="detail-description"> |
|
483 |
<p class="long_description"></p> |
|
484 |
<table class="table table-bordered"><tr> |
|
485 |
<th>inherited_from</th> |
|
486 |
<td>\lamList::listPrintHeader()</td> |
|
487 |
</tr></table> |
|
488 |
</div></div> |
|
489 |
</div> |
|
490 |
<a name="listPrintRedirectMessages" id="listPrintRedirectMessages"></a><div class="element clickable method protected listPrintRedirectMessages" data-toggle="collapse" data-target=".listPrintRedirectMessages .collapse"> |
|
491 |
<h2>Prints messages when another page (e.g.</h2> |
|
492 |
<pre>listPrintRedirectMessages() </pre> |
|
493 |
<div class="labels"><span class="label">Inherited</span></div> |
|
494 |
<div class="row collapse"><div class="detail-description"> |
|
495 |
<p class="long_description"><p>delete/upload) redirects to the list view.</p></p> |
|
496 |
<table class="table table-bordered"><tr> |
|
497 |
<th>inherited_from</th> |
|
498 |
<td>\lamList::listPrintRedirectMessages()</td> |
|
499 |
</tr></table> |
|
500 |
</div></div> |
|
501 |
</div> |
|
502 |
<a name="listPrintTableBody" id="listPrintTableBody"></a><div class="element clickable method protected listPrintTableBody" data-toggle="collapse" data-target=".listPrintTableBody .collapse"> |
|
503 |
<h2>Prints the entry list</h2> |
|
504 |
<pre>listPrintTableBody(array $info) </pre> |
|
505 |
<div class="labels"><span class="label">Inherited</span></div> |
|
506 |
<div class="row collapse"><div class="detail-description"> |
|
507 |
<p class="long_description"></p> |
|
508 |
<table class="table table-bordered"><tr> |
|
509 |
<th>inherited_from</th> |
|
510 |
<td>\lamList::listPrintTableBody()</td> |
|
511 |
</tr></table> |
|
512 |
<h3>Parameters</h3> |
|
513 |
<div class="subelement argument"> |
|
514 |
<h4>$info</h4> |
|
515 |
<code>array</code><p>entries</p></div> |
|
516 |
</div></div> |
|
517 |
</div> |
|
518 |
<a name="listPrintTableHeader" id="listPrintTableHeader"></a><div class="element clickable method protected listPrintTableHeader" data-toggle="collapse" data-target=".listPrintTableHeader .collapse"> |
|
519 |
<h2>Prints the attribute and filter row at the account table head</h2> |
|
520 |
<pre>listPrintTableHeader() </pre> |
|
521 |
<div class="labels"><span class="label">Inherited</span></div> |
|
522 |
<div class="row collapse"><div class="detail-description"> |
|
523 |
<p class="long_description"></p> |
|
524 |
<table class="table table-bordered"><tr> |
|
525 |
<th>inherited_from</th> |
|
526 |
<td>\lamList::listPrintTableHeader()</td> |
|
527 |
</tr></table> |
|
528 |
</div></div> |
|
529 |
</div> |
|
530 |
<a name="listRefreshData" id="listRefreshData"></a><div class="element clickable method protected listRefreshData" data-toggle="collapse" data-target=".listRefreshData .collapse"> |
|
531 |
<h2>Rereads the entries from LDAP.</h2> |
|
532 |
<pre>listRefreshData() </pre> |
|
533 |
<div class="labels"><span class="label">Inherited</span></div> |
|
534 |
<div class="row collapse"><div class="detail-description"> |
|
535 |
<p class="long_description"></p> |
|
536 |
<table class="table table-bordered"><tr> |
|
537 |
<th>inherited_from</th> |
|
538 |
<td>\lamList::listRefreshData()</td> |
|
539 |
</tr></table> |
|
540 |
</div></div> |
|
541 |
</div> |
|
542 |
<a name="listShowOUSelection" id="listShowOUSelection"></a><div class="element clickable method protected listShowOUSelection" data-toggle="collapse" data-target=".listShowOUSelection .collapse"> |
|
543 |
<h2>Prints a combobox with possible sub-DNs.</h2> |
|
|
1.2.18
by Roland Gruber
Import upstream version 4.0 |
544 |
<pre>listShowOUSelection() : <a href="../classes/htmlGroup.html">\htmlGroup</a></pre> |
|
1.2.16
by Roland Gruber
Import upstream version 3.8 |
545 |
<div class="labels"><span class="label">Inherited</span></div> |
546 |
<div class="row collapse"><div class="detail-description"> |
|
547 |
<p class="long_description"></p> |
|
548 |
<table class="table table-bordered"><tr> |
|
549 |
<th>inherited_from</th> |
|
550 |
<td>\lamList::listShowOUSelection()</td> |
|
551 |
</tr></table> |
|
|
1.2.18
by Roland Gruber
Import upstream version 4.0 |
552 |
<h3>Returns</h3> |
553 |
<div class="subelement response"> |
|
554 |
<code><a href="../classes/htmlGroup.html">\htmlGroup</a></code>OU selection (may be empty)</div> |
|
|
1.2.16
by Roland Gruber
Import upstream version 3.8 |
555 |
</div></div> |
556 |
</div> |
|
557 |
<a name="listPrintToolLinks" id="listPrintToolLinks"></a><div class="element clickable method private listPrintToolLinks" data-toggle="collapse" data-target=".listPrintToolLinks .collapse"> |
|
558 |
<h2>Prints the tool image links (e.g.</h2> |
|
559 |
<pre>listPrintToolLinks(array $account, String $id) </pre> |
|
560 |
<div class="labels"><span class="label">Inherited</span></div> |
|
561 |
<div class="row collapse"><div class="detail-description"> |
|
562 |
<p class="long_description"><p>edit and delete) for each account.</p></p> |
|
563 |
<table class="table table-bordered"><tr> |
|
564 |
<th>inherited_from</th> |
|
565 |
<td>\lamList::listPrintToolLinks()</td> |
|
566 |
</tr></table> |
|
567 |
<h3>Parameters</h3> |
|
568 |
<div class="subelement argument"> |
|
569 |
<h4>$account</h4> |
|
570 |
<code>array</code><p>LDAP attributes</p></div> |
|
571 |
<div class="subelement argument"> |
|
572 |
<h4>$id</h4> |
|
573 |
<code>String</code><p>account ID</p></div> |
|
574 |
</div></div> |
|
575 |
</div> |
|
576 |
<a name="listReadOptionsFromCookie" id="listReadOptionsFromCookie"></a><div class="element clickable method private listReadOptionsFromCookie" data-toggle="collapse" data-target=".listReadOptionsFromCookie .collapse"> |
|
577 |
<h2>Reads the list options from the cookie value.</h2> |
|
578 |
<pre>listReadOptionsFromCookie() </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::listReadOptionsFromCookie()</td> |
|
585 |
</tr></table> |
|
586 |
</div></div> |
|
587 |
</div> |
|
588 |
<a name="showPDFPage" id="showPDFPage"></a><div class="element clickable method private showPDFPage" data-toggle="collapse" data-target=".showPDFPage .collapse"> |
|
589 |
<h2>Shows the page where the user may select the PDF options.</h2> |
|
590 |
<pre>showPDFPage(String $id) </pre> |
|
591 |
<div class="labels"><span class="label">Inherited</span></div> |
|
592 |
<div class="row collapse"><div class="detail-description"> |
|
593 |
<p class="long_description"></p> |
|
594 |
<table class="table table-bordered"><tr> |
|
595 |
<th>inherited_from</th> |
|
596 |
<td>\lamList::showPDFPage()</td> |
|
597 |
</tr></table> |
|
598 |
<h3>Parameters</h3> |
|
599 |
<div class="subelement argument"> |
|
600 |
<h4>$id</h4> |
|
601 |
<code>String</code><p>account ID</p></div> |
|
602 |
</div></div> |
|
603 |
</div> |
|
604 |
<h3> |
|
605 |
<i class="icon-custom icon-property"></i> Properties</h3> |
|
606 |
<a name="%24attrArray" id="$attrArray"> </a><div class="element clickable property protected $attrArray" data-toggle="collapse" data-target=".$attrArray .collapse"> |
|
607 |
<h2>list of LDAP attributes</h2> |
|
608 |
<pre>$attrArray </pre> |
|
609 |
<div class="labels"><span class="label">Inherited</span></div> |
|
610 |
<div class="row collapse"><div class="detail-description"> |
|
611 |
<p class="long_description"></p> |
|
612 |
<table class="table table-bordered"><tr> |
|
613 |
<th>inherited_from</th> |
|
614 |
<td>\lamList::$$attrArray</td> |
|
615 |
</tr></table> |
|
616 |
</div></div> |
|
617 |
</div> |
|
618 |
<a name="%24descArray" id="$descArray"> </a><div class="element clickable property protected $descArray" data-toggle="collapse" data-target=".$descArray .collapse"> |
|
619 |
<h2>list of attribute descriptions</h2> |
|
620 |
<pre>$descArray </pre> |
|
621 |
<div class="labels"><span class="label">Inherited</span></div> |
|
622 |
<div class="row collapse"><div class="detail-description"> |
|
623 |
<p class="long_description"></p> |
|
624 |
<table class="table table-bordered"><tr> |
|
625 |
<th>inherited_from</th> |
|
626 |
<td>\lamList::$$descArray</td> |
|
627 |
</tr></table> |
|
628 |
</div></div> |
|
629 |
</div> |
|
630 |
<a name="%24entries" id="$entries"> </a><div class="element clickable property protected $entries" data-toggle="collapse" data-target=".$entries .collapse"> |
|
631 |
<h2>LDAP entries</h2> |
|
632 |
<pre>$entries </pre> |
|
633 |
<div class="labels"><span class="label">Inherited</span></div> |
|
634 |
<div class="row collapse"><div class="detail-description"> |
|
635 |
<p class="long_description"></p> |
|
636 |
<table class="table table-bordered"><tr> |
|
637 |
<th>inherited_from</th> |
|
638 |
<td>\lamList::$$entries</td> |
|
639 |
</tr></table> |
|
640 |
</div></div> |
|
641 |
</div> |
|
|
1.2.20
by Roland Gruber
Import upstream version 4.1 |
642 |
<a name="%24filters" id="$filters"> </a><div class="element clickable property protected $filters" data-toggle="collapse" data-target=".$filters .collapse"> |
643 |
<h2>list of filters (attribute name => filter input)</h2> |
|
644 |
<pre>$filters </pre> |
|
645 |
<div class="labels"><span class="label">Inherited</span></div> |
|
646 |
<div class="row collapse"><div class="detail-description"> |
|
647 |
<p class="long_description"></p> |
|
648 |
<table class="table table-bordered"><tr> |
|
649 |
<th>inherited_from</th> |
|
650 |
<td>\lamList::$$filters</td> |
|
|
1.2.16
by Roland Gruber
Import upstream version 3.8 |
651 |
</tr></table> |
652 |
</div></div> |
|
653 |
</div> |
|
654 |
<a name="%24labels" id="$labels"> </a><div class="element clickable property protected $labels" data-toggle="collapse" data-target=".$labels .collapse"> |
|
655 |
<h2>list of account specific labels</h2> |
|
656 |
<pre>$labels </pre> |
|
657 |
<div class="labels"><span class="label">Inherited</span></div> |
|
658 |
<div class="row collapse"><div class="detail-description"> |
|
659 |
<p class="long_description"></p> |
|
660 |
<table class="table table-bordered"><tr> |
|
661 |
<th>inherited_from</th> |
|
662 |
<td>\lamList::$$labels</td> |
|
663 |
</tr></table> |
|
664 |
</div></div> |
|
665 |
</div> |
|
666 |
<a name="%24maxPageEntries" id="$maxPageEntries"> </a><div class="element clickable property protected $maxPageEntries" data-toggle="collapse" data-target=".$maxPageEntries .collapse"> |
|
667 |
<h2>maximum count of entries per page</h2> |
|
668 |
<pre>$maxPageEntries </pre> |
|
669 |
<div class="labels"><span class="label">Inherited</span></div> |
|
670 |
<div class="row collapse"><div class="detail-description"> |
|
671 |
<p class="long_description"></p> |
|
672 |
<table class="table table-bordered"><tr> |
|
673 |
<th>inherited_from</th> |
|
674 |
<td>\lamList::$$maxPageEntries</td> |
|
675 |
</tr></table> |
|
676 |
</div></div> |
|
677 |
</div> |
|
678 |
<a name="%24page" id="$page"> </a><div class="element clickable property protected $page" data-toggle="collapse" data-target=".$page .collapse"> |
|
679 |
<h2>current page number</h2> |
|
680 |
<pre>$page </pre> |
|
681 |
<div class="labels"><span class="label">Inherited</span></div> |
|
682 |
<div class="row collapse"><div class="detail-description"> |
|
683 |
<p class="long_description"></p> |
|
684 |
<table class="table table-bordered"><tr> |
|
685 |
<th>inherited_from</th> |
|
686 |
<td>\lamList::$$page</td> |
|
687 |
</tr></table> |
|
688 |
</div></div> |
|
689 |
</div> |
|
690 |
<a name="%24possibleSuffixes" id="$possibleSuffixes"> </a><div class="element clickable property protected $possibleSuffixes" data-toggle="collapse" data-target=".$possibleSuffixes .collapse"> |
|
691 |
<h2>list of possible LDAP suffixes(organizational units)</h2> |
|
692 |
<pre>$possibleSuffixes </pre> |
|
693 |
<div class="labels"><span class="label">Inherited</span></div> |
|
694 |
<div class="row collapse"><div class="detail-description"> |
|
695 |
<p class="long_description"></p> |
|
696 |
<table class="table table-bordered"><tr> |
|
697 |
<th>inherited_from</th> |
|
698 |
<td>\lamList::$$possibleSuffixes</td> |
|
699 |
</tr></table> |
|
700 |
</div></div> |
|
701 |
</div> |
|
702 |
<a name="%24refresh" id="$refresh"> </a><div class="element clickable property protected $refresh" data-toggle="collapse" data-target=".$refresh .collapse"> |
|
703 |
<h2>refresh page switch</h2> |
|
704 |
<pre>$refresh </pre> |
|
705 |
<div class="labels"><span class="label">Inherited</span></div> |
|
706 |
<div class="row collapse"><div class="detail-description"> |
|
707 |
<p class="long_description"></p> |
|
708 |
<table class="table table-bordered"><tr> |
|
709 |
<th>inherited_from</th> |
|
710 |
<td>\lamList::$$refresh</td> |
|
711 |
</tr></table> |
|
712 |
</div></div> |
|
713 |
</div> |
|
714 |
<a name="%24sortColumn" id="$sortColumn"> </a><div class="element clickable property protected $sortColumn" data-toggle="collapse" data-target=".$sortColumn .collapse"> |
|
715 |
<h2>sort column name</h2> |
|
716 |
<pre>$sortColumn </pre> |
|
717 |
<div class="labels"><span class="label">Inherited</span></div> |
|
718 |
<div class="row collapse"><div class="detail-description"> |
|
719 |
<p class="long_description"></p> |
|
720 |
<table class="table table-bordered"><tr> |
|
721 |
<th>inherited_from</th> |
|
722 |
<td>\lamList::$$sortColumn</td> |
|
723 |
</tr></table> |
|
724 |
</div></div> |
|
725 |
</div> |
|
726 |
<a name="%24sortDirection" id="$sortDirection"> </a><div class="element clickable property protected $sortDirection" data-toggle="collapse" data-target=".$sortDirection .collapse"> |
|
727 |
<h2>sort direction: 1 for ascending, -1 for descending</h2> |
|
728 |
<pre>$sortDirection </pre> |
|
729 |
<div class="labels"><span class="label">Inherited</span></div> |
|
730 |
<div class="row collapse"><div class="detail-description"> |
|
731 |
<p class="long_description"></p> |
|
732 |
<table class="table table-bordered"><tr> |
|
733 |
<th>inherited_from</th> |
|
734 |
<td>\lamList::$$sortDirection</td> |
|
735 |
</tr></table> |
|
736 |
</div></div> |
|
737 |
</div> |
|
|
1.2.21
by Roland Gruber
Import upstream version 4.2.1 |
738 |
<a name="%24sortMapping" id="$sortMapping"> </a><div class="element clickable property protected $sortMapping" data-toggle="collapse" data-target=".$sortMapping .collapse"> |
739 |
<h2>sort mapping for entries array(original index => sorted index)</h2> |
|
740 |
<pre>$sortMapping </pre> |
|
741 |
<div class="labels"><span class="label">Inherited</span></div> |
|
742 |
<div class="row collapse"><div class="detail-description"> |
|
743 |
<p class="long_description"></p> |
|
744 |
<table class="table table-bordered"><tr> |
|
745 |
<th>inherited_from</th> |
|
746 |
<td>\lamList::$$sortMapping</td> |
|
747 |
</tr></table> |
|
748 |
</div></div> |
|
749 |
</div> |
|
|
1.2.16
by Roland Gruber
Import upstream version 3.8 |
750 |
<a name="%24suffix" id="$suffix"> </a><div class="element clickable property protected $suffix" data-toggle="collapse" data-target=".$suffix .collapse"> |
751 |
<h2>LDAP suffix</h2> |
|
752 |
<pre>$suffix </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::$$suffix</td> |
|
759 |
</tr></table> |
|
760 |
</div></div> |
|
761 |
</div> |
|
|
1.2.17
by Roland Gruber
Import upstream version 3.9 |
762 |
<a name="%24tabindex" id="$tabindex"> </a><div class="element clickable property protected $tabindex" data-toggle="collapse" data-target=".$tabindex .collapse"> |
763 |
<h2>tabindex for GUI elements</h2> |
|
764 |
<pre>$tabindex </pre> |
|
765 |
<div class="labels"><span class="label">Inherited</span></div> |
|
766 |
<div class="row collapse"><div class="detail-description"> |
|
767 |
<p class="long_description"></p> |
|
768 |
<table class="table table-bordered"><tr> |
|
769 |
<th>inherited_from</th> |
|
770 |
<td>\lamList::$$tabindex</td> |
|
771 |
</tr></table> |
|
772 |
</div></div> |
|
773 |
</div> |
|
|
1.2.16
by Roland Gruber
Import upstream version 3.8 |
774 |
<a name="%24type" id="$type"> </a><div class="element clickable property protected $type" data-toggle="collapse" data-target=".$type .collapse"> |
775 |
<h2>Account type</h2> |
|
776 |
<pre>$type </pre> |
|
777 |
<div class="labels"><span class="label">Inherited</span></div> |
|
778 |
<div class="row collapse"><div class="detail-description"> |
|
779 |
<p class="long_description"></p> |
|
780 |
<table class="table table-bordered"><tr> |
|
781 |
<th>inherited_from</th> |
|
782 |
<td>\lamList::$$type</td> |
|
783 |
</tr></table> |
|
784 |
</div></div> |
|
785 |
</div> |
|
786 |
<a name="%24configOptions" id="$configOptions"> </a><div class="element clickable property private $configOptions" data-toggle="collapse" data-target=".$configOptions .collapse"> |
|
787 |
<h2>configuration options</h2> |
|
788 |
<pre>$configOptions </pre> |
|
789 |
<div class="labels"><span class="label">Inherited</span></div> |
|
790 |
<div class="row collapse"><div class="detail-description"> |
|
791 |
<p class="long_description"></p> |
|
792 |
<table class="table table-bordered"><tr> |
|
793 |
<th>inherited_from</th> |
|
794 |
<td>\lamList::$$configOptions</td> |
|
795 |
</tr></table> |
|
796 |
</div></div> |
|
797 |
</div> |
|
798 |
<h3> |
|
799 |
<i class="icon-custom icon-constant"></i> Constants</h3> |
|
800 |
<a name="LIST_SIZE_OPTION_NAME" id="LIST_SIZE_OPTION_NAME"> </a><div class="element clickable constant LIST_SIZE_OPTION_NAME" data-toggle="collapse" data-target=".LIST_SIZE_OPTION_NAME .collapse"> |
|
801 |
<h2>ID for list size config option</h2> |
|
802 |
<pre>LIST_SIZE_OPTION_NAME </pre> |
|
803 |
<div class="labels"><span class="label">Inherited</span></div> |
|
804 |
<div class="row collapse"><div class="detail-description"> |
|
805 |
<p class="long_description"></p> |
|
806 |
<table class="table table-bordered"><tr> |
|
807 |
<th>inherited_from</th> |
|
808 |
<td>\lamList::LIST_SIZE_OPTION_NAME</td> |
|
809 |
</tr></table> |
|
810 |
</div></div> |
|
811 |
</div> |
|
812 |
<a name="VIRTUAL_ATTRIBUTE_PREFIX" id="VIRTUAL_ATTRIBUTE_PREFIX"> </a><div class="element clickable constant VIRTUAL_ATTRIBUTE_PREFIX" data-toggle="collapse" data-target=".VIRTUAL_ATTRIBUTE_PREFIX .collapse"> |
|
813 |
<h2>prefix for virtual (non-LDAP) attributes</h2> |
|
814 |
<pre>VIRTUAL_ATTRIBUTE_PREFIX </pre> |
|
815 |
<div class="labels"><span class="label">Inherited</span></div> |
|
816 |
<div class="row collapse"><div class="detail-description"> |
|
817 |
<p class="long_description"></p> |
|
818 |
<table class="table table-bordered"><tr> |
|
819 |
<th>inherited_from</th> |
|
820 |
<td>\lamList::VIRTUAL_ATTRIBUTE_PREFIX</td> |
|
821 |
</tr></table> |
|
822 |
</div></div> |
|
823 |
</div> |
|
824 |
</div> |
|
825 |
</div> |
|
826 |
</div> |
|
827 |
</div> |
|
828 |
<div class="row"><footer class="span12"> |
|
829 |
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> |
|
|
1.2.17
by Roland Gruber
Import upstream version 3.9 |
830 |
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br> |
|
1.2.21
by Roland Gruber
Import upstream version 4.2.1 |
831 |
generated on 2013-06-17T21:08:42+02:00.<br></footer></div> |
|
1.2.16
by Roland Gruber
Import upstream version 3.8 |
832 |
</div> |
833 |
</body> |
|
834 |
</html> |