3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
37 * Abstract class for search BAO query objects
39 abstract class CRM_Contact_BAO_Query_Interface
{
41 abstract public function &getFields();
50 abstract public function from($fieldName, $mode, $side);
57 public function select(&$query) {
66 public function where(&$query) {
75 public function setTableDependency(&$tables) {
84 public function registerAdvancedSearchPane(&$panes) {
94 public function buildAdvancedSearchPaneForm(&$form, $type) {
99 * @param $paneTemplatePathArray
104 public function setAdvancedSearchPaneTemplatePath(&$paneTemplatePathArray, $type) {
109 * Describe options for available for use in the search-builder.
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).
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
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.)
121 public function alterSearchBuilderOptions(&$apiEntities, &$fieldOptions) {