1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>LDAP Account Manager » \toolFileUpload</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<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">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<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">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/Crypt.html"><i class="icon-folder-open"></i> Crypt</a></li>
<li><a href="../packages/Help.html"><i class="icon-folder-open"></i> Help</a></li>
<li><a href="../packages/LDAP.html"><i class="icon-folder-open"></i> LDAP</a></li>
<li><a href="../packages/Math.html"><i class="icon-folder-open"></i> Math</a></li>
<li><a href="../packages/Net.html"><i class="icon-folder-open"></i> Net</a></li>
<li><a href="../packages/PDF.html"><i class="icon-folder-open"></i> PDF</a></li>
<li><a href="../packages/PHP.html"><i class="icon-folder-open"></i> PHP</a></li>
<li><a href="../packages/configuration.html"><i class="icon-folder-open"></i> configuration</a></li>
<li><a href="../packages/horde.html"><i class="icon-folder-open"></i> horde</a></li>
<li><a href="../packages/lam.html"><i class="icon-folder-open"></i> lam</a></li>
<li><a href="../packages/lib.html"><i class="icon-folder-open"></i> lib</a></li>
<li><a href="../packages/lists.html"><i class="icon-folder-open"></i> lists</a></li>
<li><a href="../packages/main.html"><i class="icon-folder-open"></i> main</a></li>
<li><a href="../packages/metaHTML.html"><i class="icon-folder-open"></i> metaHTML</a></li>
<li><a href="../packages/modules.html"><i class="icon-folder-open"></i> modules</a></li>
<li><a href="../packages/phpLDAPadmin.html"><i class="icon-folder-open"></i> phpLDAPadmin</a></li>
<li><a href="../packages/profiles.html"><i class="icon-folder-open"></i> profiles</a></li>
<li><a href="../packages/selfService.html"><i class="icon-folder-open"></i> selfService</a></li>
<li><a href="../packages/tools.html"><i class="icon-folder-open"></i> tools</a></li>
<li><a href="../packages/types.html"><i class="icon-folder-open"></i> types</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
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>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
<span class="label label-info">1055</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
<ul><li>todo
<span class="label label-info">15</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
<span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
Javascript is disabled; several features are only available
if Javascript is enabled.
</div></noscript>
<div class="row">
<div class="span4">
<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">
<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>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#getDescription" title="getDescription :: returns a description text for the tool."><span class="description">returns a description text for the tool.</span><pre>getDescription()</pre></a></li>
<li class="method public "><a href="#getImageLink" title="getImageLink :: Returns the link to the tool image (relative to graphics/)"><span class="description">Returns the link to the tool image (relative to graphics/)</span><pre>getImageLink()</pre></a></li>
<li class="method public "><a href="#getLink" title="getLink :: Returns a link to the tool page (relative to templates/)."><span class="description">Returns a link to the tool page (relative to templates/).</span><pre>getLink()</pre></a></li>
<li class="method public "><a href="#getName" title="getName :: Returns the name of the tool."><span class="description">Returns the name of the tool.</span><pre>getName()</pre></a></li>
<li class="method public "><a href="#getPosition" title="getPosition :: Returns the prefered position of this tool on the tools page."><span class="description">Returns the prefered position of this tool on the tools page.</span><pre>getPosition()</pre></a></li>
<li class="method public "><a href="#getRequiresPasswordChangeRights" title="getRequiresPasswordChangeRights :: Returns if the tool requires password change rights."><span class="description">Returns if the tool requires password change rights.</span><pre>getRequiresPasswordChangeRights()</pre></a></li>
<li class="method public "><a href="#getRequiresWriteAccess" title="getRequiresWriteAccess :: Returns if the tool requires write access to LDAP."><span class="description">Returns if the tool requires write access to LDAP.</span><pre>getRequiresWriteAccess()</pre></a></li>
<li class="method public "><a href="#getSubTools" title="getSubTools :: Returns a list of sub tools or an empty array."><span class="description">Returns a list of sub tools or an empty array.</span><pre>getSubTools()</pre></a></li>
<li class="method public "><a href="#isHideable" title="isHideable :: Returns if a tool may be hidden by configuration in the LAM server profile."><span class="description">Returns if a tool may be hidden by configuration in the LAM server profile.</span><pre>isHideable()</pre></a></li>
<li class="method public "><a href="#isVisible" title="isVisible :: Returns if the tool is visible in the menu."><span class="description">Returns if the tool is visible in the menu.</span><pre>isVisible()</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5CtoolFileUpload" id="\toolFileUpload"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li><a href="../namespaces/global.html">global</a></li>
<li class="active">
<span class="divider">\</span><a href="../classes/toolFileUpload.html">toolFileUpload</a>
</li>
</ul>
<div href="../classes/toolFileUpload.html" class="element class">
<p class="short_description">File upload</p>
<div class="details">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>package</th>
<td><a href="../packages/tools.html">tools</a></td>
</tr></table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="getDescription" id="getDescription"></a><div class="element clickable method public getDescription" data-toggle="collapse" data-target=".getDescription .collapse">
<h2>returns a description text for the tool.</h2>
<pre>getDescription() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>description</div>
</div></div>
</div>
<a name="getImageLink" id="getImageLink"></a><div class="element clickable method public getImageLink" data-toggle="collapse" data-target=".getImageLink .collapse">
<h2>Returns the link to the tool image (relative to graphics/)</h2>
<pre>getImageLink() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>image URL</div>
</div></div>
</div>
<a name="getLink" id="getLink"></a><div class="element clickable method public getLink" data-toggle="collapse" data-target=".getLink .collapse">
<h2>Returns a link to the tool page (relative to templates/).</h2>
<pre>getLink() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>link</div>
</div></div>
</div>
<a name="getName" id="getName"></a><div class="element clickable method public getName" data-toggle="collapse" data-target=".getName .collapse">
<h2>Returns the name of the tool.</h2>
<pre>getName() : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>name</div>
</div></div>
</div>
<a name="getPosition" id="getPosition"></a><div class="element clickable method public getPosition" data-toggle="collapse" data-target=".getPosition .collapse">
<h2>Returns the prefered position of this tool on the tools page.</h2>
<pre>getPosition() : int</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>The position may be between 0 and 1000. 0 is the top position.</p></p>
<h3>Returns</h3>
<div class="subelement response">
<code>int</code>prefered position</div>
</div></div>
</div>
<a name="getRequiresPasswordChangeRights" id="getRequiresPasswordChangeRights"></a><div class="element clickable method public getRequiresPasswordChangeRights" data-toggle="collapse" data-target=".getRequiresPasswordChangeRights .collapse">
<h2>Returns if the tool requires password change rights.</h2>
<pre>getRequiresPasswordChangeRights() : boolean</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>boolean</code>true if password change rights are needed</div>
</div></div>
</div>
<a name="getRequiresWriteAccess" id="getRequiresWriteAccess"></a><div class="element clickable method public getRequiresWriteAccess" data-toggle="collapse" data-target=".getRequiresWriteAccess .collapse">
<h2>Returns if the tool requires write access to LDAP.</h2>
<pre>getRequiresWriteAccess() : boolean</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>boolean</code>true if write access is needed</div>
</div></div>
</div>
<a name="getSubTools" id="getSubTools"></a><div class="element clickable method public getSubTools" data-toggle="collapse" data-target=".getSubTools .collapse">
<h2>Returns a list of sub tools or an empty array.</h2>
<pre>getSubTools() : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>list of subtools (LAMTool)</div>
</div></div>
</div>
<a name="isHideable" id="isHideable"></a><div class="element clickable method public isHideable" data-toggle="collapse" data-target=".isHideable .collapse">
<h2>Returns if a tool may be hidden by configuration in the LAM server profile.</h2>
<pre>isHideable() : boolean</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>boolean</code>hideable</div>
</div></div>
</div>
<a name="isVisible" id="isVisible"></a><div class="element clickable method public isVisible" data-toggle="collapse" data-target=".isVisible .collapse">
<h2>Returns if the tool is visible in the menu.</h2>
<pre>isVisible() : boolean</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>boolean</code>visible</div>
</div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
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>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
generated on 2013-06-17T21:08:41+02:00.<br></footer></div>
</div>
</body>
</html>
|