source: Doc/Backend/PHPDoc/default/Application.html @ 301

Last change on this file since 301 was 301, checked in by jkraaijeveld, 13 years ago

Added new PHPDoc :D

File size: 14.8 KB
Line 
1<?xml version="1.0" encoding="iso-8859-1"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3  <html xmlns="http://www.w3.org/1999/xhtml">
4                <head>
5                        <!-- template designed by Marco Von Ballmoos -->
6                        <title>Docs For Class Application</title>
7                        <link rel="stylesheet" href="../media/stylesheet.css" />
8                        <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9                </head>
10                <body>
11                        <div class="page-body">                 
12<h2 class="class-name"><img src="../media/images/Class_logo.png"
13                                                                                                                alt=" Class"
14                                                                                                                title=" Class"
15                                                                                                                style="vertical-align: middle"> Application</h2>
16
17<a name="sec-description"></a>
18<div class="info-box">
19        <div class="info-box-title">Description</div>
20        <div class="nav-bar">
21                                        <span class="disabled">Description</span> |
22                                                                                                        <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
23                                                |                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
24                                               
25                                        </div>
26        <div class="info-box-body">
27                        <!-- ========== Info from phpDoc block ========= -->
28<p class="short-description">Description of Application</p>
29        <ul class="tags">
30                                <li><span class="field">author:</span> jkraaijeveld</li>
31                        </ul>
32                <p class="notes">
33                        Located in <a class="field" href="_models---Application.php.html">/models/Application.php</a> (line <span class="field">11</span>)
34                </p>
35               
36                               
37                <pre><a href="../default/ResearchToolObject.html">ResearchToolObject</a>
38   |
39   --Application</pre>
40       
41                        </div>
42</div>
43
44
45
46        <a name="sec-var-summary"></a>
47        <div class="info-box">
48                <div class="info-box-title">Variable Summary</span></div>
49                <div class="nav-bar">
50                        <a href="#sec-description">Description</a> |
51                                                <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
52                                                        |
53                                                                        <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
54                                                       
55                                                                </div>
56                <div class="info-box-body">
57                        <div class="var-summary">
58                                                                                                                                                                <div class="var-title">
59                                        <img src="../media/images/StaticVariable.png" alt=" " />
60                                        static <span class="var-type">mixed</span>
61                                        <a href="#$filename" title="details" class="var-name">$filename</a>
62                                </div>
63                                                                                                                                                                                                                                                                                                <div class="var-title">
64                                        <img src="../media/images/Variable.png" alt=" " />
65                                        <span class="var-type">mixed</span>
66                                        <a href="#$description" title="details" class="var-name">$description</a>
67                                </div>
68                                                                                                                                                                                                <div class="var-title">
69                                        <img src="../media/images/Variable.png" alt=" " />
70                                        <span class="var-type">mixed</span>
71                                        <a href="#$style" title="details" class="var-name">$style</a>
72                                </div>
73                                                                                                                                <div class="var-title">
74                                        <img src="../media/images/Variable.png" alt=" " />
75                                        <span class="var-type">mixed</span>
76                                        <a href="#$title" title="details" class="var-name">$title</a>
77                                </div>
78                                                                                        </div>
79                </div>
80        </div>
81
82        <a name="sec-method-summary"></a>
83        <div class="info-box">
84                <div class="info-box-title">Method Summary</span></div>
85                <div class="nav-bar">
86                        <a href="#sec-description">Description</a> |
87                                                                                                                                                <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
88                                 
89                                |
90                                                <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
91                </div>
92                <div class="info-box-body">                     
93                        <div class="method-summary">
94                                                                                                                                                                <div class="method-definition">
95                                        <img src="../media/images/StaticMethod.png" alt=" "/>
96                                                                                        static <span class="method-result">void</span>
97                                                                                <a href="#create" title="details" class="method-name">create</a>
98                                                                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$obj</span>)
99                                                                        </div>
100                                                                                                                                <div class="method-definition">
101                                        <img src="../media/images/StaticMethod.png" alt=" "/>
102                                                                                        static <span class="method-result">void</span>
103                                                                                <a href="#get" title="details" class="method-name">get</a>
104                                                                                        (<span class="var-type">type</span>&nbsp;<span class="var-name">$arguments</span>)
105                                                                        </div>
106                                                                                                                                                                                                                                <div class="method-definition">
107                                        <img src="../media/images/Constructor.png" alt=" "/>
108                                                                                        <span class="method-result">Application</span>
109                                                                                <a href="#__construct" title="details" class="method-name">__construct</a>
110                                                                                        ([<span class="var-type">type</span>&nbsp;<span class="var-name">$uid</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$title</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$description</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$style</span> = <span class="var-default">null</span>], <span class="var-type">type</span>&nbsp;<span class="var-name">$title:</span>, <span class="var-type">type</span>&nbsp;<span class="var-name">$description:</span>, <span class="var-type">type</span>&nbsp;<span class="var-name">$style:</span>)
111                                                                        </div>
112                                                                                                                                                                                                                                                                <div class="method-definition">
113                                        <img src="../media/images/Method.png" alt=" "/>
114                                                                                        <span class="method-result">void</span>
115                                                                                <a href="#save" title="details" class="method-name">save</a>
116                                                                                ()
117                                                                        </div>
118                                                                                        </div>
119                </div>
120        </div>         
121
122        <a name="sec-vars"></a>
123        <div class="info-box">
124                <div class="info-box-title">Variables</div>
125                <div class="nav-bar">
126                        <a href="#sec-description">Description</a> |
127                                                                                <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
128                                               
129                       
130                                                                                |
131                                                                        <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
132                                                       
133                                        </div>
134                <div class="info-box-body">
135                        <a name="var$filename" id="$filename"><!-- --></A>
136<div class="evenrow">
137
138        <div class="var-header">
139                <img src="../media/images/Variable.png" />
140                <span class="var-title">
141                        static <span class="var-type">mixed</span>
142                        <span class="var-name">$filename</span>
143                         = <span class="var-default"> 'data/applications/applications.rdf'</span>                       (line <span class="line-number">13</span>)
144                </span>
145        </div>
146
147        <!-- ========== Info from phpDoc block ========= -->
148        <ul class="tags">
149                                <li><span class="field">access:</span> public</li>
150                        </ul>
151       
152       
153               
154               
155
156</div>
157
158<a name="var$description" id="$description"><!-- --></A>
159<div class="oddrow">
160
161        <div class="var-header">
162                <img src="../media/images/Variable.png" />
163                <span class="var-title">
164                        <span class="var-type">mixed</span>
165                        <span class="var-name">$description</span>
166                                                (line <span class="line-number">16</span>)
167                </span>
168        </div>
169
170        <!-- ========== Info from phpDoc block ========= -->
171        <ul class="tags">
172                                <li><span class="field">access:</span> public</li>
173                        </ul>
174       
175       
176               
177               
178
179</div>
180<a name="var$style" id="$style"><!-- --></A>
181<div class="evenrow">
182
183        <div class="var-header">
184                <img src="../media/images/Variable.png" />
185                <span class="var-title">
186                        <span class="var-type">mixed</span>
187                        <span class="var-name">$style</span>
188                                                (line <span class="line-number">17</span>)
189                </span>
190        </div>
191
192        <!-- ========== Info from phpDoc block ========= -->
193        <ul class="tags">
194                                <li><span class="field">access:</span> public</li>
195                        </ul>
196       
197       
198               
199               
200
201</div>
202<a name="var$title" id="$title"><!-- --></A>
203<div class="oddrow">
204
205        <div class="var-header">
206                <img src="../media/images/Variable.png" />
207                <span class="var-title">
208                        <span class="var-type">mixed</span>
209                        <span class="var-name">$title</span>
210                                                (line <span class="line-number">15</span>)
211                </span>
212        </div>
213
214        <!-- ========== Info from phpDoc block ========= -->
215        <ul class="tags">
216                                <li><span class="field">access:</span> public</li>
217                        </ul>
218       
219       
220               
221               
222
223</div>
224                                                        <h4>Inherited Variables</h4>
225                                <A NAME='inherited_vars'><!-- --></A>
226                                                                        <p>Inherited from <span class="classname"><a href="../default/ResearchToolObject.html">ResearchToolObject</a></span></p>
227                                        <blockquote>
228                                                                                                        <img src="../media/images/Variable.png" />
229                                                        <span class="var-title">
230                                                                <span class="var-name"><a href="../default/ResearchToolObject.html#var$uid">ResearchToolObject::$uid</a></span><br>
231                                                        </span>
232                                                                                        </blockquote>
233                                                                               
234                </div>
235        </div>
236       
237        <a name="sec-methods"></a>
238        <div class="info-box">
239                <div class="info-box-title">Methods</div>
240                <div class="nav-bar">
241                        <a href="#sec-description">Description</a> |
242                                                                                                                        <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
243                                                                                                                <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
244                                               
245                </div>
246                <div class="info-box-body">
247                        <A NAME='method_detail'></A>
248<a name="methodcreate" id="create"><!-- --></a>
249<div class="evenrow">
250       
251        <div class="method-header">
252                <img src="../media/images/StaticMethod.png" />
253                <span class="method-title">static create</span> (line <span class="line-number">116</span>)
254        </div>
255       
256        <!-- ========== Info from phpDoc block ========= -->
257        <ul class="tags">
258                                <li><span class="field">access:</span> public</li>
259                        </ul>
260       
261        <div class="method-signature">
262                <span class="method-result">void</span>
263                <span class="method-name">
264                        create
265                </span>
266                                        (<span class="var-type"></span>&nbsp;<span class="var-name">$obj</span>)
267                        </div>
268       
269                        <ul class="parameters">
270                                        <li>
271                                <span class="var-type"></span>
272                                <span class="var-name">$obj</span>                      </li>
273                                </ul>
274               
275                       
276        </div>
277<a name="methodget" id="get"><!-- --></a>
278<div class="oddrow">
279       
280        <div class="method-header">
281                <img src="../media/images/StaticMethod.png" />
282                <span class="method-title">static get</span> (line <span class="line-number">84</span>)
283        </div>
284       
285        <!-- ========== Info from phpDoc block ========= -->
286<p class="short-description">static function get($arguments)  Gets the array of Application objects belonging to arguments supplied.</p>
287        <ul class="tags">
288                                <li><span class="field">access:</span> public</li>
289                        </ul>
290       
291        <div class="method-signature">
292                <span class="method-result">void</span>
293                <span class="method-name">
294                        get
295                </span>
296                                        (<span class="var-type">type</span>&nbsp;<span class="var-name">$arguments</span>)
297                        </div>
298       
299                        <ul class="parameters">
300                                        <li>
301                                <span class="var-type">type</span>
302                                <span class="var-name">$arguments</span><span class="var-description">: : An array containing zero or more of the following keys:                              'uid', 'title', 'description', 'style'</span>                    </li>
303                                </ul>
304               
305                       
306        </div>
307<a name="method__construct" id="__construct"><!-- --></a>
308<div class="evenrow">
309       
310        <div class="method-header">
311                <img src="../media/images/Constructor.png" />
312                <span class="method-title">Constructor __construct</span> (line <span class="line-number">26</span>)
313        </div>
314       
315        <!-- ========== Info from phpDoc block ========= -->
316<p class="short-description">Constructor for an Application object</p>
317        <ul class="tags">
318                                <li><span class="field">access:</span> public</li>
319                        </ul>
320       
321        <div class="method-signature">
322                <span class="method-result">Application</span>
323                <span class="method-name">
324                        __construct
325                </span>
326                                        ([<span class="var-type">type</span>&nbsp;<span class="var-name">$uid</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$title</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$description</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$style</span> = <span class="var-default">null</span>], <span class="var-type">type</span>&nbsp;<span class="var-name">$title:</span>, <span class="var-type">type</span>&nbsp;<span class="var-name">$description:</span>, <span class="var-type">type</span>&nbsp;<span class="var-name">$style:</span>)
327                        </div>
328       
329                        <ul class="parameters">
330                                        <li>
331                                <span class="var-type">type</span>
332                                <span class="var-name">$uid</span><span class="var-description">: : The uid of the Application object.</span>                   </li>
333                                        <li>
334                                <span class="var-type">type</span>
335                                <span class="var-name">$title:</span><span class="var-description">: The title of the Application.</span>                       </li>
336                                        <li>
337                                <span class="var-type">type</span>
338                                <span class="var-name">$description:</span><span class="var-description">: The description of the Application.</span>                   </li>
339                                        <li>
340                                <span class="var-type">type</span>
341                                <span class="var-name">$style:</span><span class="var-description">: The style of the Application.</span>                       </li>
342                                        <li>
343                                <span class="var-type"></span>
344                                <span class="var-name">$title</span>                    </li>
345                                        <li>
346                                <span class="var-type"></span>
347                                <span class="var-name">$description</span>                      </li>
348                                        <li>
349                                <span class="var-type"></span>
350                                <span class="var-name">$style</span>                    </li>
351                                </ul>
352               
353                       
354        </div>
355<a name="methodsave" id="save"><!-- --></a>
356<div class="oddrow">
357       
358        <div class="method-header">
359                <img src="../media/images/Method.png" />
360                <span class="method-title">save</span> (line <span class="line-number">42</span>)
361        </div>
362       
363        <!-- ========== Info from phpDoc block ========= -->
364<p class="short-description">function save()  Saves the current object into the database.</p>
365        <ul class="tags">
366                                <li><span class="field">access:</span> public</li>
367                        </ul>
368       
369        <div class="method-signature">
370                <span class="method-result">void</span>
371                <span class="method-name">
372                        save
373                </span>
374                                ()
375                        </div>
376       
377               
378                       
379        </div>
380                                                        <h4>Inherited Methods</h4>
381                                <a name='inherited_methods'><!-- --></a>       
382                                                                        <!-- =========== Summary =========== -->
383                                        <p>Inherited From <span class="classname"><a href="../default/ResearchToolObject.html">ResearchToolObject</a></span></p>
384                                        <blockquote>
385                                                                                                        <img src="../media/images/Method.png" alt=" "/>
386                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodcreateArguments">ResearchToolObject::createArguments()</a></span><br>
387                                                                                                        <img src="../media/images/Method.png" alt=" "/>
388                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodevaluate">ResearchToolObject::evaluate()</a></span><br>
389                                                                                                        <img src="../media/images/Method.png" alt=" "/>
390                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodgetUid">ResearchToolObject::getUid()</a></span><br>
391                                                                                                        <img src="../media/images/Method.png" alt=" "/>
392                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodload">ResearchToolObject::load()</a></span><br>
393                                                                                                        <img src="../media/images/Method.png" alt=" "/>
394                                                        <span class="method-name"><a href="../default/ResearchToolObject.html#methodstripUri">ResearchToolObject::stripUri()</a></span><br>
395                                                                                        </blockquote>
396                                                                               
397                </div>
398        </div>
399
400       
401        <p class="notes" id="credit">
402                Documentation generated on Thu, 01 Mar 2012 15:13:51 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
403        </p>
404        </div></body>
405</html>
Note: See TracBrowser for help on using the repository browser.