File: classIcingaApiSearchIdo.html

package info (click to toggle)
icinga 1.0.2-2%2Bsqueeze1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 33,952 kB
  • ctags: 13,294
  • sloc: xml: 154,821; ansic: 99,198; sh: 14,585; sql: 5,852; php: 5,126; perl: 2,838; makefile: 1,268
file content (261 lines) | stat: -rw-r--r-- 12,176 bytes parent folder | download | duplicates (2) 
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
 
<!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"/>
<title>ICINGA-API: IcingaApiSearchIdo Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;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><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>IcingaApiSearchIdo Class Reference</h1><!-- doxytag: class="IcingaApiSearchIdo" --><!-- doxytag: inherits="IcingaApiSearch" -->
<p>Inherits <a class="el" href="classIcingaApiSearch.html">IcingaApiSearch</a>.</p>
<div class="dynheader">
Collaboration diagram for IcingaApiSearchIdo:</div>
<div class="dynsection">
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classIcingaApiSearchIdo-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIcingaApiSearchIdo.html#aad5c7db474832563ca2e12ee850599de">__construct</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIcingaApiSearchIdo.html#a265a4b5e38dbd83fad682d8561f80318">setTablePrefix</a> ($prefix=null)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIcingaApiSearchIdo.html#a9360b188abe7028215eac7b68cd8e1b9">createQueryFilter</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIcingaApiSearchIdo.html#a6be87e551e361ff85af04780db0fd8a5">setResultColumns</a> ($columns)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIcingaApiSearchIdo.html#a65eedbc7db5c088e82bf9e050f6ed7ce">executeQuery</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIcingaApiSearchIdo.html#a4bb355c4579ceb4c2b10af0472ace95e">fetch</a> ()</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIcingaApiSearchIdo.html#a14c57ce9d736c5810c2d2b3d180975a3">getColumn</a> ($columnKey)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<dl class="author"><dt><b>Author:</b></dt><dd>Christian Doebler &lt;<a href="mailto:christian.doebler@netways.de">christian.doebler@netways.de</a>&gt; </dd></dl>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aad5c7db474832563ca2e12ee850599de"></a><!-- doxytag: member="IcingaApiSearchIdo::__construct" ref="aad5c7db474832563ca2e12ee850599de" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">IcingaApiSearchIdo::__construct </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>class constructor</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>void</em>&nbsp;</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>void </dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Christian Doebler &lt;<a href="mailto:christian.doebler@netways.de">christian.doebler@netways.de</a>&gt; </dd></dl>

<p>Reimplemented from <a class="el" href="classIcingaApiSearch.html#ae092226090cb5d603cab20d157167e43">IcingaApiSearch</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a9360b188abe7028215eac7b68cd8e1b9"></a><!-- doxytag: member="IcingaApiSearchIdo::createQueryFilter" ref="a9360b188abe7028215eac7b68cd8e1b9" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">IcingaApiSearchIdo::createQueryFilter </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>creates where statement for database query</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>void</em>&nbsp;</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>array associative array w/ where statement and corresponding values </dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Christian Doebler &lt;<a href="mailto:christian.doebler@netways.de">christian.doebler@netways.de</a>&gt; </dd></dl>

</div>
</div>
<a class="anchor" id="a65eedbc7db5c088e82bf9e050f6ed7ce"></a><!-- doxytag: member="IcingaApiSearchIdo::executeQuery" ref="a65eedbc7db5c088e82bf9e050f6ed7ce" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">IcingaApiSearchIdo::executeQuery </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>creates and executes database query</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>void</em>&nbsp;</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>boolean true on success otherwise false </dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Christian Doebler &lt;<a href="mailto:christian.doebler@netways.de">christian.doebler@netways.de</a>&gt; </dd></dl>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>

</div>
</div>
<a class="anchor" id="a4bb355c4579ceb4c2b10af0472ace95e"></a><!-- doxytag: member="IcingaApiSearchIdo::fetch" ref="a4bb355c4579ceb4c2b10af0472ace95e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">IcingaApiSearchIdo::fetch </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>(non-PHPdoc) </p>
<dl class="see"><dt><b>See also:</b></dt><dd>objects/search/IcingaApiSearch<a class="el" href="classIcingaApiSearchIdo.html#a4bb355c4579ceb4c2b10af0472ace95e">fetch()</a> </dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Christian Doebler &lt;<a href="mailto:christian.doebler@netways.de">christian.doebler@netways.de</a>&gt; </dd></dl>

<p>Reimplemented from <a class="el" href="classIcingaApiSearch.html#a80e2c1cfb8b2d707f7c57e94333b7362">IcingaApiSearch</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>

</div>
</div>
<a class="anchor" id="a14c57ce9d736c5810c2d2b3d180975a3"></a><!-- doxytag: member="IcingaApiSearchIdo::getColumn" ref="a14c57ce9d736c5810c2d2b3d180975a3" args="($columnKey)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">IcingaApiSearchIdo::getColumn </td>
          <td>(</td>
          <td class="paramtype">$&nbsp;</td>
          <td class="paramname"> <em>columnKey</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>creates a column to insert into query and pushes it onto the processed stack </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>string</em>&nbsp;</td><td>$columnKey key that identifies the current column </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>string processed column; boolean false on error </dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Christian Doebler &lt;<a href="mailto:christian.doebler@netways.de">christian.doebler@netways.de</a>&gt; </dd></dl>

</div>
</div>
<a class="anchor" id="a6be87e551e361ff85af04780db0fd8a5"></a><!-- doxytag: member="IcingaApiSearchIdo::setResultColumns" ref="a6be87e551e361ff85af04780db0fd8a5" args="($columns)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">IcingaApiSearchIdo::setResultColumns </td>
          <td>(</td>
          <td class="paramtype">$&nbsp;</td>
          <td class="paramname"> <em>columns</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>sets result columns for query</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>mixed</em>&nbsp;</td><td>$columns array of columns or column as string </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="interfaceIcingaApiSearchInterface.html">IcingaApiSearchInterface</a> </dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Christian Doebler &lt;<a href="mailto:christian.doebler@netways.de">christian.doebler@netways.de</a>&gt; </dd></dl>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>

</div>
</div>
<a class="anchor" id="a265a4b5e38dbd83fad682d8561f80318"></a><!-- doxytag: member="IcingaApiSearchIdo::setTablePrefix" ref="a265a4b5e38dbd83fad682d8561f80318" args="($prefix=null)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">IcingaApiSearchIdo::setTablePrefix </td>
          <td>(</td>
          <td class="paramtype">$&nbsp;</td>
          <td class="paramname"> <em>prefix</em> = <code>null</code></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>sets the table prefix</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>string</em>&nbsp;</td><td>$prefix table prefix </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>void </dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Christian Doebler &lt;<a href="mailto:christian.doebler@netways.de">christian.doebler@netways.de</a>&gt; </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/jefe/workspace_nw/icinga-api/objects/search/<a class="el" href="IcingaApiSearchIdo_8php.html">IcingaApiSearchIdo.php</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Thu Jan 14 15:06:46 2010 for ICINGA-API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>