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
|
<!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: IcingaApiCommand 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 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>IcingaApiCommand Class Reference</h1><!-- doxytag: class="IcingaApiCommand" --><!-- doxytag: inherits="IcingaApi" -->
<p>Inherits <a class="el" href="classIcingaApi.html">IcingaApi</a>.</p>
<p>Inherited by <a class="el" href="classIcingaApiCommandCollection.html">IcingaApiCommandCollection</a>, <a class="el" href="classIcingaApiCommandDispatcher.html">IcingaApiCommandDispatcher</a>, <a class="el" href="classIcingaApiCommandDispatcherException.html">IcingaApiCommandDispatcherException</a>, and <a class="el" href="classIcingaApiCommandSend.html">IcingaApiCommandSend</a>.</p>
<div class="dynheader">
Collaboration diagram for IcingaApiCommand:</div>
<div class="dynsection">
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classIcingaApiCommand-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="classIcingaApiCommand.html#a2641749ac27c84d018d651b7f533c5e0">__construct</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIcingaApiCommand.html#ab041ace70b9accd415e5c663af6dfd73">setCommand</a> ($command=false)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIcingaApiCommand.html#ae0ffabd16c50ed2306bb06b6d9f4e031">setTarget</a> ($key=false, $value=false)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIcingaApiCommand.html#a74ee5c7639a888bbb2851f2fc42a18ca">checkFields</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIcingaApiCommand.html#ac1521e59dc306064ddaf53e87c4548ed">getCommandLine</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<dl class="author"><dt><b>Author:</b></dt><dd>Christian Doebler <christian <a href="mailto:doebler@netways.de">doebler@netways.de</a>> </dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a2641749ac27c84d018d651b7f533c5e0"></a><!-- doxytag: member="IcingaApiCommand::__construct" ref="a2641749ac27c84d018d651b7f533c5e0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IcingaApiCommand::__construct </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </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> </td><td></td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classIcingaApiCommand.html">IcingaApiCommand</a> instance of <a class="el" href="classIcingaApiCommand.html">IcingaApiCommand</a> object </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>Reimplemented from <a class="el" href="classIcingaApi.html#a0f4c0e78ca30b530dd8e7865518f32ac">IcingaApi</a>.</p>
<p>Reimplemented in <a class="el" href="classIcingaApiCommandCollection.html#a9abd93f99836c7ecb3ccc8cf1e2059f0">IcingaApiCommandCollection</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a74ee5c7639a888bbb2851f2fc42a18ca"></a><!-- doxytag: member="IcingaApiCommand::checkFields" ref="a74ee5c7639a888bbb2851f2fc42a18ca" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IcingaApiCommand::checkFields </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>checks fields (command parameter values) </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> </td><td></td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>boolean true if fields are ok otherwise false </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>
</div>
</div>
<a class="anchor" id="ac1521e59dc306064ddaf53e87c4548ed"></a><!-- doxytag: member="IcingaApiCommand::getCommandLine" ref="ac1521e59dc306064ddaf53e87c4548ed" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IcingaApiCommand::getCommandLine </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>returns the command line which will be sent to icinga </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> </td><td></td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>string command line </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>
</div>
</div>
<a class="anchor" id="ab041ace70b9accd415e5c663af6dfd73"></a><!-- doxytag: member="IcingaApiCommand::setCommand" ref="ab041ace70b9accd415e5c663af6dfd73" args="($command=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IcingaApiCommand::setCommand </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>command</em> = <code>false</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>sets an icinga command </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> </td><td>$command command id (integer) or command name (string) </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classIcingaApiCommand.html">IcingaApiCommand</a> the current object </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>Reimplemented in <a class="el" href="classIcingaApiCommandDispatcher.html#afcd6e54f3afeb57d9c2b690ee6a810c8">IcingaApiCommandDispatcher</a>.</p>
</div>
</div>
<a class="anchor" id="ae0ffabd16c50ed2306bb06b6d9f4e031"></a><!-- doxytag: member="IcingaApiCommand::setTarget" ref="ae0ffabd16c50ed2306bb06b6d9f4e031" args="($key=false, $value=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IcingaApiCommand::setTarget </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>key</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>value</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>sets command target (command parameter) </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>$key command key </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mixed</em> </td><td>$value command value </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classIcingaApiCommand.html">IcingaApiCommand</a> instance of <a class="el" href="classIcingaApiCommand.html">IcingaApiCommand</a> object </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>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/jefe/workspace_nw/icinga-api/objects/command/<a class="el" href="IcingaApiCommand_8php.html">IcingaApiCommand.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>
|
