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
|
<!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: IcingaApiSearchIdoInterface Interface 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 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 List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>IcingaApiSearchIdoInterface Interface Reference</h1><!-- doxytag: class="IcingaApiSearchIdoInterface" -->
<p>Inherited by <a class="el" href="classIcingaApiSearchIdoMysql.html">IcingaApiSearchIdoMysql</a>, <a class="el" href="classIcingaApiSearchIdoOci.html">IcingaApiSearchIdoOci</a>, and <a class="el" href="classIcingaApiSearchIdoPgsql.html">IcingaApiSearchIdoPgsql</a>.</p>
<p><a href="interfaceIcingaApiSearchIdoInterface-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIcingaApiSearchIdoInterface.html#ad667e934da729da6e68359809ef6fa5f">createQueryLimit</a> ($searchLimit=false)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIcingaApiSearchIdoInterface.html#a96bc44e8333f3fcff58728fbc27a76af">createQueryGroup</a> ($searchGroup=false, $resultColumns=false)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIcingaApiSearchIdoInterface.html#aecd3d12bc0b9880fe68230357f361820">postProcessQuery</a> ($query, $resultColumnKeys, $searchOrder, $searchLimit)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<dl class="author"><dt><b>Author:</b></dt><dd>Christian Doebler <<a href="mailto:christian.doebler@netways.de">christian.doebler@netways.de</a>> </dd></dl>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a96bc44e8333f3fcff58728fbc27a76af"></a><!-- doxytag: member="IcingaApiSearchIdoInterface::createQueryGroup" ref="a96bc44e8333f3fcff58728fbc27a76af" args="($searchGroup=false, $resultColumns=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IcingaApiSearchIdoInterface::createQueryGroup </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>searchGroup</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>resultColumns</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>creates group information 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>array</em> </td><td>$searchGroup group information </td></tr>
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>$resultColumns result columns (select columns) </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>array group template and values </dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Christian Doebler <<a href="mailto:christian.doebler@netways.de">christian.doebler@netways.de</a>> </dd></dl>
<p>Implemented in <a class="el" href="classIcingaApiSearchIdoMysql.html#a7e46b719b4e9d40b0afaa524fc317d07">IcingaApiSearchIdoMysql</a>, <a class="el" href="classIcingaApiSearchIdoOci.html#a7cec69b9d2b4fe69ad7dd15f184cb58f">IcingaApiSearchIdoOci</a>, and <a class="el" href="classIcingaApiSearchIdoPgsql.html#aa521ab41450a99eb3d78cbd29f7831a5">IcingaApiSearchIdoPgsql</a>.</p>
</div>
</div>
<a class="anchor" id="ad667e934da729da6e68359809ef6fa5f"></a><!-- doxytag: member="IcingaApiSearchIdoInterface::createQueryLimit" ref="ad667e934da729da6e68359809ef6fa5f" args="($searchLimit=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IcingaApiSearchIdoInterface::createQueryLimit </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>searchLimit</em> = <code>false</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>creates limit information 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>array</em> </td><td>$searchLimit start and length of query limit </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>array limit template and values </dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Christian Doebler <<a href="mailto:christian.doebler@netways.de">christian.doebler@netways.de</a>> </dd></dl>
<p>Implemented in <a class="el" href="classIcingaApiSearchIdoMysql.html#a647c3057f12099efb72dafe046201302">IcingaApiSearchIdoMysql</a>, <a class="el" href="classIcingaApiSearchIdoOci.html#a0f0ee39ab5786af33896017a46b78bfd">IcingaApiSearchIdoOci</a>, and <a class="el" href="classIcingaApiSearchIdoPgsql.html#a424ec27240df7d8e7e12c08d396876b6">IcingaApiSearchIdoPgsql</a>.</p>
</div>
</div>
<a class="anchor" id="aecd3d12bc0b9880fe68230357f361820"></a><!-- doxytag: member="IcingaApiSearchIdoInterface::postProcessQuery" ref="aecd3d12bc0b9880fe68230357f361820" args="($query, $resultColumnKeys, $searchOrder, $searchLimit)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IcingaApiSearchIdoInterface::postProcessQuery </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>query</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>resultColumnKeys</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>searchOrder</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>searchLimit</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>provides post-processing for query generator </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> </td><td>$query query to post process </td></tr>
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>$resultColumnKeys keys of result columns (select columns) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>$searchOrder columns of 'order by' statement </td></tr>
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>$searchLimit limit values of query </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>string post processed query </dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Christian Doebler <<a href="mailto:christian.doebler@netways.de">christian.doebler@netways.de</a>> </dd></dl>
<p>Implemented in <a class="el" href="classIcingaApiSearchIdoMysql.html#a030a32ccdb08961698ae6fd9a56728d9">IcingaApiSearchIdoMysql</a>, <a class="el" href="classIcingaApiSearchIdoOci.html#a5399751ee0a85cf0e605b27887783729">IcingaApiSearchIdoOci</a>, and <a class="el" href="classIcingaApiSearchIdoPgsql.html#a59d69e09d592955f48343dc2b0ed721e">IcingaApiSearchIdoPgsql</a>.</p>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>/home/jefe/workspace_nw/icinga-api/objects/search/data_interfaces/<a class="el" href="IcingaApiSearchIdoInterface_8php.html">IcingaApiSearchIdoInterface.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
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
|
