source: Doc/Backend/PHPDoc/default/DatabaseInterface.html @ 160

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

Updated documentation
Added PHPDoc

File size: 6.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 DatabaseInterface</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">Class DatabaseInterface</h2>
13
14<a name="sec-description"></a>
15<div class="info-box">
16        <div class="info-box-title">Description</div>
17        <div class="nav-bar">
18                                        <span class="disabled">Description</span> |
19                                                                                                                        <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
20                                               
21                                        </div>
22        <div class="info-box-body">
23                        <!-- ========== Info from phpDoc block ========= -->
24<p class="short-description">Description of DatabaseInterface</p>
25<p class="description"><p>Initializes all the connectors, serves as only entrance and exit point  for the frontend</p></p>
26        <ul class="tags">
27                                <li><span class="field">author:</span> jkraaijeveld</li>
28                        </ul>
29                <p class="notes">
30                        Located in <a class="field" href="_DatabaseInterface.php.html">/DatabaseInterface.php</a> (line <span class="field">14</span>)
31                </p>
32               
33                               
34                <pre></pre>
35       
36                        </div>
37</div>
38
39
40
41
42        <a name="sec-method-summary"></a>
43        <div class="info-box">
44                <div class="info-box-title">Method Summary</span></div>
45                <div class="nav-bar">
46                        <a href="#sec-description">Description</a> |
47                                                                                                <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
48                </div>
49                <div class="info-box-body">                     
50                        <div class="method-summary">
51                                                                                                                                                                                                                                                                                               
52                                                                                                <div class="method-definition">
53                                                                                        <span class="method-result">DatabaseInterface</span>
54                                                                                <a href="#__construct" title="details" class="method-name">__construct</a>
55                                                                                ()
56                                                                        </div>
57                                                                                                                                <div class="method-definition">
58                                                                                        <span class="method-result">void</span>
59                                                                                <a href="#batchSet" title="details" class="method-name">batchSet</a>
60                                                                                        (<span class="var-type">type</span>&nbsp;<span class="var-name">$rToolObjects</span>)
61                                                                        </div>
62                                                                                                                                <div class="method-definition">
63                                                                                        <span class="method-result">type</span>
64                                                                                <a href="#get" title="details" class="method-name">get</a>
65                                                                                        (<span class="var-type">type</span>&nbsp;<span class="var-name">$type</span>, [<span class="var-type">type</span>&nbsp;<span class="var-name">$arguments</span> = <span class="var-default">array()</span>])
66                                                                        </div>
67                                                                                                                                <div class="method-definition">
68                                                                                        <span class="method-result">void</span>
69                                                                                <a href="#set" title="details" class="method-name">set</a>
70                                                                                        (<span class="var-type">type</span>&nbsp;<span class="var-name">$rToolObject</span>)
71                                                                        </div>
72                                                                </div>
73                </div>
74        </div>         
75
76       
77        <a name="sec-methods"></a>
78        <div class="info-box">
79                <div class="info-box-title">Methods</div>
80                <div class="nav-bar">
81                        <a href="#sec-description">Description</a> |
82                                                                                                                                <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
83                                               
84                </div>
85                <div class="info-box-body">
86                        <A NAME='method_detail'></A>
87
88<a name="method__construct" id="__construct"><!-- --></a>
89<div class="evenrow">
90       
91        <div class="method-header">
92                <span class="method-title">Constructor __construct</span> (line <span class="line-number">32</span>)
93        </div>
94       
95        <!-- ========== Info from phpDoc block ========= -->
96<p class="short-description">Constructor for DatabaseInterface.</p>
97<p class="description"><p>Initializes all the connectors.</p></p>
98        <ul class="tags">
99                                <li><span class="field">access:</span> public</li>
100                        </ul>
101       
102        <div class="method-signature">
103                <span class="method-result">DatabaseInterface</span>
104                <span class="method-name">
105                        __construct
106                </span>
107                                ()
108                        </div>
109       
110               
111                       
112        </div>
113<a name="methodbatchSet" id="batchSet"><!-- --></a>
114<div class="oddrow">
115       
116        <div class="method-header">
117                <span class="method-title">batchSet</span> (line <span class="line-number">120</span>)
118        </div>
119       
120        <!-- ========== Info from phpDoc block ========= -->
121<p class="short-description">Saves all the objects in the given array, assuming they are  valid ResearchToolObjects.</p>
122        <ul class="tags">
123                                <li><span class="field">access:</span> public</li>
124                        </ul>
125       
126        <div class="method-signature">
127                <span class="method-result">void</span>
128                <span class="method-name">
129                        batchSet
130                </span>
131                                        (<span class="var-type">type</span>&nbsp;<span class="var-name">$rToolObjects</span>)
132                        </div>
133       
134                        <ul class="parameters">
135                                        <li>
136                                <span class="var-type">type</span>
137                                <span class="var-name">$rToolObjects</span>                     </li>
138                                </ul>
139               
140                       
141        </div>
142<a name="methodget" id="get"><!-- --></a>
143<div class="evenrow">
144       
145        <div class="method-header">
146                <span class="method-title">get</span> (line <span class="line-number">49</span>)
147        </div>
148       
149        <!-- ========== Info from phpDoc block ========= -->
150<p class="short-description">Get the data corresponding to the given type and arguments</p>
151        <ul class="tags">
152                                <li><span class="field">access:</span> public</li>
153                        </ul>
154       
155        <div class="method-signature">
156                <span class="method-result">type</span>
157                <span class="method-name">
158                        get
159                </span>
160                                        (<span class="var-type">type</span>&nbsp;<span class="var-name">$type</span>, [<span class="var-type">type</span>&nbsp;<span class="var-name">$arguments</span> = <span class="var-default">array()</span>])
161                        </div>
162       
163                        <ul class="parameters">
164                                        <li>
165                                <span class="var-type">type</span>
166                                <span class="var-name">$type</span>                     </li>
167                                        <li>
168                                <span class="var-type">type</span>
169                                <span class="var-name">$arguments</span>                        </li>
170                                </ul>
171               
172                       
173        </div>
174<a name="methodset" id="set"><!-- --></a>
175<div class="oddrow">
176       
177        <div class="method-header">
178                <span class="method-title">set</span> (line <span class="line-number">84</span>)
179        </div>
180       
181        <!-- ========== Info from phpDoc block ========= -->
182<p class="short-description">Saves the given object based on its class.</p>
183        <ul class="tags">
184                                <li><span class="field">access:</span> public</li>
185                        </ul>
186       
187        <div class="method-signature">
188                <span class="method-result">void</span>
189                <span class="method-name">
190                        set
191                </span>
192                                        (<span class="var-type">type</span>&nbsp;<span class="var-name">$rToolObject</span>)
193                        </div>
194       
195                        <ul class="parameters">
196                                        <li>
197                                <span class="var-type">type</span>
198                                <span class="var-name">$rToolObject</span>                      </li>
199                                </ul>
200               
201                       
202        </div>
203                                               
204                </div>
205        </div>
206
207
208        <p class="notes" id="credit">
209                Documentation generated on Fri, 18 Nov 2011 12:57:06 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
210        </p>
211        </div></body>
212</html>
Note: See TracBrowser for help on using the repository browser.