File: classIcingaApiSearchFile.html

package info (click to toggle)
icinga 1.0.2-2%2Bsqueeze2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze-lts
  • size: 33,964 kB
  • ctags: 13,294
  • sloc: xml: 154,821; ansic: 99,198; sh: 14,761; sql: 5,852; php: 5,126; perl: 2,838; makefile: 1,268
file content (188 lines) | stat: -rw-r--r-- 9,419 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
 
<!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: IcingaApiSearchFile 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>IcingaApiSearchFile Class Reference</h1><!-- doxytag: class="IcingaApiSearchFile" --><!-- doxytag: inherits="IcingaApiSearch" -->
<p>Inherits <a class="el" href="classIcingaApiSearch.html">IcingaApiSearch</a>.</p>
<div class="dynheader">
Collaboration diagram for IcingaApiSearchFile:</div>
<div class="dynsection">
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classIcingaApiSearchFile-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="classIcingaApiSearchFile.html#a5a54c6c6a51aa620941e65d5fc085ab1">__construct</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIcingaApiSearchFile.html#a0e2e594818788a5967b61fcdb49b6fdc">setQueryType</a> ($type)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIcingaApiSearchFile.html#ae4ddb1703cf50205177f11ea9ac98dd2">getData</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIcingaApiSearchFile.html#ac19b628f2798aa5c66032da8cf12f570">setInputFiles</a> ($files)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIcingaApiSearchFile.html#a474bc14aee08b788df795f1dcae7421a">fetch</a> ()</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="a5a54c6c6a51aa620941e65d5fc085ab1"></a><!-- doxytag: member="IcingaApiSearchFile::__construct" ref="a5a54c6c6a51aa620941e65d5fc085ab1" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">IcingaApiSearchFile::__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="a474bc14aee08b788df795f1dcae7421a"></a><!-- doxytag: member="IcingaApiSearchFile::fetch" ref="a474bc14aee08b788df795f1dcae7421a" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">IcingaApiSearchFile::fetch </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>determines possible result objects by getting intersections of all available objects </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 list of possible result objects </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; (non-PHPdoc) </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd>objects/search/IcingaApiSearch<a class="el" href="classIcingaApiSearchFile.html#a474bc14aee08b788df795f1dcae7421a">fetch()</a> </dd></dl>

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

</div>
</div>
<a class="anchor" id="ae4ddb1703cf50205177f11ea9ac98dd2"></a><!-- doxytag: member="IcingaApiSearchFile::getData" ref="ae4ddb1703cf50205177f11ea9ac98dd2" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">IcingaApiSearchFile::getData </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>returns processed data </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>object NOT DEFINED YET </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="ac19b628f2798aa5c66032da8cf12f570"></a><!-- doxytag: member="IcingaApiSearchFile::setInputFiles" ref="ac19b628f2798aa5c66032da8cf12f570" args="($files)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">IcingaApiSearchFile::setInputFiles </td>
          <td>(</td>
          <td class="paramtype">$&nbsp;</td>
          <td class="paramname"> <em>files</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>sets file config </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>&nbsp;</td><td>$files associative array defining file locations </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classIcingaApiSearchFile.html">IcingaApiSearchFile</a> <a class="el" href="classIcingaApiSearchFile.html">IcingaApiSearchFile</a> object </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="a0e2e594818788a5967b61fcdb49b6fdc"></a><!-- doxytag: member="IcingaApiSearchFile::setQueryType" ref="a0e2e594818788a5967b61fcdb49b6fdc" args="($type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">IcingaApiSearchFile::setQueryType </td>
          <td>(</td>
          <td class="paramtype">$&nbsp;</td>
          <td class="paramname"> <em>type</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>sets the query type a.k.a. search target (DEPRECATED) </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>$type type of query for further filter action </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classIcingaApiSearchFile.html">IcingaApiSearchFile</a> <a class="el" href="classIcingaApiSearchFile.html">IcingaApiSearchFile</a> object </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="IcingaApiSearchFile_8php.html">IcingaApiSearchFile.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>