-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclassTeams.html
314 lines (295 loc) · 15.4 KB
/
classTeams.html
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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Automatische Punkteauswertung des RoboSAX: Teams Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Automatische Punkteauswertung des RoboSAX
 <span id="projectnumber">0.0.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="classTeams-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Teams Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0947726259436eb7148f364f71d4dc4a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTeams.html#a0947726259436eb7148f364f71d4dc4a">__construct</a> ()</td></tr>
<tr class="memdesc:a0947726259436eb7148f364f71d4dc4a"><td class="mdescLeft"> </td><td class="mdescRight">Constructor of <a class="el" href="classTeams.html">Teams</a> objects. <a href="#a0947726259436eb7148f364f71d4dc4a">More...</a><br /></td></tr>
<tr class="separator:a0947726259436eb7148f364f71d4dc4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4865008c9cadaee4b981d9d4e9a9d1b6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTeams.html#a4865008c9cadaee4b981d9d4e9a9d1b6">add_team</a> ($nt)</td></tr>
<tr class="memdesc:a4865008c9cadaee4b981d9d4e9a9d1b6"><td class="mdescLeft"> </td><td class="mdescRight">Adds the transmitted object of type <a class="el" href="classTeam.html">Team</a> to tms. <a href="#a4865008c9cadaee4b981d9d4e9a9d1b6">More...</a><br /></td></tr>
<tr class="separator:a4865008c9cadaee4b981d9d4e9a9d1b6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9144c03cea178be60679e3ab578cbbf1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTeams.html#a9144c03cea178be60679e3ab578cbbf1">remove_team</a> ($id)</td></tr>
<tr class="memdesc:a9144c03cea178be60679e3ab578cbbf1"><td class="mdescLeft"> </td><td class="mdescRight">Removes the team object with the ID $id from $tms. <a href="#a9144c03cea178be60679e3ab578cbbf1">More...</a><br /></td></tr>
<tr class="separator:a9144c03cea178be60679e3ab578cbbf1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acf4a34305df633a3bd2e796dee39c2a0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTeams.html#acf4a34305df633a3bd2e796dee39c2a0">load_teams_from_db</a> ()</td></tr>
<tr class="memdesc:acf4a34305df633a3bd2e796dee39c2a0"><td class="mdescLeft"> </td><td class="mdescRight">Loads all teams from the database. <a href="#acf4a34305df633a3bd2e796dee39c2a0">More...</a><br /></td></tr>
<tr class="separator:acf4a34305df633a3bd2e796dee39c2a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a801ae4d1a9984060bd059c8ae8184358"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTeams.html#a801ae4d1a9984060bd059c8ae8184358">save_teams_to_db</a> ()</td></tr>
<tr class="memdesc:a801ae4d1a9984060bd059c8ae8184358"><td class="mdescLeft"> </td><td class="mdescRight">Saves the data inside $tms in the database. <a href="#a801ae4d1a9984060bd059c8ae8184358">More...</a><br /></td></tr>
<tr class="separator:a801ae4d1a9984060bd059c8ae8184358"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc836c638e05b2d6a24a064302eef510"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTeams.html#adc836c638e05b2d6a24a064302eef510">get_team_by_id</a> ($tmp)</td></tr>
<tr class="memdesc:adc836c638e05b2d6a24a064302eef510"><td class="mdescLeft"> </td><td class="mdescRight">Returns a <a class="el" href="classTeam.html">Team</a> object with the ID $tmp. <a href="#adc836c638e05b2d6a24a064302eef510">More...</a><br /></td></tr>
<tr class="separator:adc836c638e05b2d6a24a064302eef510"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b347e97585112c460bc76f3a014f2f3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTeams.html#a4b347e97585112c460bc76f3a014f2f3">order_teams_by_points</a> ()</td></tr>
<tr class="memdesc:a4b347e97585112c460bc76f3a014f2f3"><td class="mdescLeft"> </td><td class="mdescRight">Orders $tms [desc] by points of the <a class="el" href="classTeam.html">Team</a> objects. <a href="#a4b347e97585112c460bc76f3a014f2f3">More...</a><br /></td></tr>
<tr class="separator:a4b347e97585112c460bc76f3a014f2f3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3cf2868c98dc757efd408fca7a556fa1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTeams.html#a3cf2868c98dc757efd408fca7a556fa1">order_teams_by_id</a> ()</td></tr>
<tr class="memdesc:a3cf2868c98dc757efd408fca7a556fa1"><td class="mdescLeft"> </td><td class="mdescRight">Orders $tms [asc] by teamid of the <a class="el" href="classTeam.html">Team</a> objects. <a href="#a3cf2868c98dc757efd408fca7a556fa1">More...</a><br /></td></tr>
<tr class="separator:a3cf2868c98dc757efd408fca7a556fa1"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:aa09a5d7ceff280ccf3693c6a8bf2a32b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTeams.html#aa09a5d7ceff280ccf3693c6a8bf2a32b">$tms</a> = []</td></tr>
<tr class="separator:aa09a5d7ceff280ccf3693c6a8bf2a32b"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a0947726259436eb7148f364f71d4dc4a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Teams::__construct </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor of <a class="el" href="classTeams.html">Teams</a> objects. </p>
<p>Sets $tms to an empty array and $AnzTeams to 0. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a4865008c9cadaee4b981d9d4e9a9d1b6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Teams::add_team </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$nt</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds the transmitted object of type <a class="el" href="classTeam.html">Team</a> to tms. </p>
<p>Returns 'false' if one of the following events occures:</p><ul>
<li>$nt is not an object of class <a class="el" href="classTeam.html">Team</a>.</li>
<li>ID of $nt isn't unique in $tms.</li>
</ul>
<p>Returns 'true' if the integration of the transmitted object was successfully.</p>
<p>If the ID of $nt is zero, it will change automaticly to size of $tms + 1. </p>
</div>
</div>
<a class="anchor" id="adc836c638e05b2d6a24a064302eef510"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Teams::get_team_by_id </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$tmp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a <a class="el" href="classTeam.html">Team</a> object with the ID $tmp. </p>
<p>This function searches $tms for a <a class="el" href="classTeam.html">Team</a> object with the teamid $tmp and, if found, returns it.</p>
<p>Returns an empty <a class="el" href="classTeam.html">Team</a> object, if no <a class="el" href="classTeam.html">Team</a> object with the teamid $tmp exists in $tms. </p>
</div>
</div>
<a class="anchor" id="acf4a34305df633a3bd2e796dee39c2a0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Teams::load_teams_from_db </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads all teams from the database. </p>
<p>This function uses the load_team_from_db($id) function of a <a class="el" href="classTeam.html">Team</a> object, to load all teams from the database.</p>
<p>Returns 'false' if one of the following events occure:</p><ul>
<li>no data was found in the database.</li>
<li>load_team_from_db($id) returned false.</li>
</ul>
<p>Returns 'true' if all teams were loaded successfully. </p>
</div>
</div>
<a class="anchor" id="a3cf2868c98dc757efd408fca7a556fa1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Teams::order_teams_by_id </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Orders $tms [asc] by teamid of the <a class="el" href="classTeam.html">Team</a> objects. </p>
</div>
</div>
<a class="anchor" id="a4b347e97585112c460bc76f3a014f2f3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Teams::order_teams_by_points </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Orders $tms [desc] by points of the <a class="el" href="classTeam.html">Team</a> objects. </p>
</div>
</div>
<a class="anchor" id="a9144c03cea178be60679e3ab578cbbf1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Teams::remove_team </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes the team object with the ID $id from $tms. </p>
<p>Returns 'true' if an object was successfully deleted from $tms.</p>
<p>Returns 'false' if either:</p><ul>
<li>$id is not of type integer or</li>
<li>no object with the transmitted ID exists in $tms. </li>
</ul>
</div>
</div>
<a class="anchor" id="a801ae4d1a9984060bd059c8ae8184358"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Teams::save_teams_to_db </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Saves the data inside $tms in the database. </p>
<p>This function uses the save_team_to_db() function of a <a class="el" href="classTeam.html">Team</a> object in a loop to save the data inside of $tms.</p>
<p>Returns 'false' if save_team_to_db() returns false.</p>
<p>Returns 'true' if the data could be saved to the database successfully. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="aa09a5d7ceff280ccf3693c6a8bf2a32b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Teams::$tms = []</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="objects_8php.html">objects.php</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Mar 14 2021 23:16:52 for Automatische Punkteauswertung des RoboSAX by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>