File: IcingaApiSearchIdoInterface.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 (40 lines) | stat: -rw-r--r-- 1,286 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
<?php

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

	/**
	 * creates limit information for query
	 * @param	array		$searchLimit			start and length of query limit
	 * @return	array								limit template and values
	 * @author	Christian Doebler <christian.doebler@netways.de>
	 */
	public function createQueryLimit ($searchLimit = false);

	/**
	 * creates group information for query
	 * @param	array		$searchGroup			group information
	 * @param	array		$resultColumns			result columns (select columns)
	 * @return	array								group template and values
	 * @author	Christian Doebler <christian.doebler@netways.de>
	 */
	public function createQueryGroup ($searchGroup = false, $resultColumns = false);

	/**
	 * provides post-processing for query generator
	 * @param	string		$query					query to post process
	 * @param	array		$resultColumnKeys		keys of result columns (select columns)
	 * @param	string		$searchOrder			columns of 'order by' statement
	 * @param	array		$searchLimit			limit values of query
	 * @return	string								post processed query
	 * @author	Christian Doebler <christian.doebler@netways.de>
	 */
	public function postProcessQuery ($query, $resultColumnKeys, $searchOrder, $searchLimit);

}

?>