Commit | Line | Data |
---|---|---|
99e9587a DS |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
06b69b18 | 4 | | CiviCRM version 4.5 | |
99e9587a | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
99e9587a DS |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
99e9587a DS |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
efa3a566 | 37 | * Abstract class for search BAO query objects |
99e9587a | 38 | */ |
efa3a566 | 39 | abstract class CRM_Contact_BAO_Query_Interface { |
99e9587a | 40 | |
efa3a566 | 41 | abstract public function &getFields(); |
86538308 EM |
42 | |
43 | /** | |
44 | * @param $fieldName | |
45 | * @param $mode | |
46 | * @param $side | |
47 | * | |
48 | * @return mixed | |
49 | */ | |
efa3a566 | 50 | abstract public function from($fieldName, $mode, $side); |
99e9587a | 51 | |
86538308 EM |
52 | /** |
53 | * @param $query | |
54 | * | |
55 | * @return null | |
56 | */ | |
efa3a566 DS |
57 | public function select(&$query) { |
58 | return NULL; | |
59 | } | |
99e9587a | 60 | |
86538308 EM |
61 | /** |
62 | * @param $query | |
63 | * | |
64 | * @return null | |
65 | */ | |
efa3a566 DS |
66 | public function where(&$query) { |
67 | return NULL; | |
68 | } | |
99e9587a | 69 | |
86538308 EM |
70 | /** |
71 | * @param $tables | |
72 | * | |
73 | * @return null | |
74 | */ | |
efa3a566 DS |
75 | public function setTableDependency(&$tables) { |
76 | return NULL; | |
77 | } | |
78 | ||
86538308 EM |
79 | /** |
80 | * @param $panes | |
81 | * | |
82 | * @return null | |
83 | */ | |
efa3a566 DS |
84 | public function registerAdvancedSearchPane(&$panes) { |
85 | return NULL; | |
86 | } | |
87 | ||
86538308 EM |
88 | /** |
89 | * @param $form | |
90 | * @param $type | |
91 | * | |
92 | * @return null | |
93 | */ | |
efa3a566 DS |
94 | public function buildAdvancedSearchPaneForm(&$form, $type) { |
95 | return NULL; | |
96 | } | |
97 | ||
86538308 EM |
98 | /** |
99 | * @param $paneTemplatePathArray | |
100 | * @param $type | |
101 | * | |
102 | * @return null | |
103 | */ | |
efa3a566 DS |
104 | public function setAdvancedSearchPaneTemplatePath(&$paneTemplatePathArray, $type) { |
105 | return NULL; | |
106 | } | |
6a5f199e TO |
107 | |
108 | /** | |
109 | * Describe options for available for use in the search-builder. | |
110 | * | |
b7fa0173 TO |
111 | * The search builder determines its options by examining the API metadata corresponding to each |
112 | * search field. This approach assumes that each field has a unique-name (ie that the field's | |
113 | * unique-name in the API matches the unique-name in the search-builder). | |
114 | * | |
6a5f199e TO |
115 | * @param array $apiEntities list of entities whose options should be automatically scanned using API metadata |
116 | * @param array $fieldOptions keys are field unique-names; values describe how to lookup the options | |
b7fa0173 TO |
117 | * For boolean options, use value "yesno". For pseudoconstants/FKs, use the name of an API entity |
118 | * from which the metadata of the field may be queried. (Yes - that is a mouthful.) | |
6a5f199e TO |
119 | * @void |
120 | */ | |
121 | public function alterSearchBuilderOptions(&$apiEntities, &$fieldOptions) { | |
122 | } | |
86538308 | 123 | } |