File: IcingaApiResultInterface.php

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 (66 lines) | stat: -rw-r--r-- 1,532 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
<?php

/**
 * 
 * @author Christian Doebler <christian.doebler@netways.de>
 *
 */
interface IcingaApiResultInterface {

	/**
	 * sets the type of return data
	 *
	 * @param	string		$type				type of data to return (object, array)
	 * @return	boolean							true on success otherwise false
	 * @author	Christian Doebler <christian.doebler@netways.de>
	 */
	public function setResultType ($type);

	/**
	 * returns result data
	 *
	 * @param	string		$name			name of column to return
	 * @return	void
	 * @author	Christian Doebler <christian.doebler@netways.de>
	 */
	public function __get ($name);

	/**
	 * returns result data
	 *
	 * @param	string		$name			name of column to return
	 * @param	array		$arguments		NOT USED
	 * @return	void
	 * @author	Christian Doebler <christian.doebler@netways.de>
	 */
	public function __call ($name, $arguments = array());

	/**
	 * returns query result
	 *
	 * @param	string		$searchField		field name to return value of
	 * @return	mixed							search result
	 * @author	Christian Doebler <christian.doebler@netways.de>
	 */
	public function get ($searchField = false);

	/**
	 * returns a complete row from query result
	 *
	 * @param	void
	 * @return	mixed							search-result row
	 * @author	Christian Doebler <christian.doebler@netways.de>
	 */
	public function getRow ();

	/**
	 * return the number of rows which where returned by a query
	 *
	 * @return	integer							number of rows
	 * @author	Christian Doebler <christian.doebler@netways.de>
	 */
	public function getResultCount ();

}

?>