From b7fa0173f6b9bf46a13d4aafc8fb49724ed80013 Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Thu, 22 Aug 2013 18:27:00 -0700 Subject: [PATCH] CRM_Contact_BAO_Query_Interface - More docs --- CRM/Contact/BAO/Query/Interface.php | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CRM/Contact/BAO/Query/Interface.php b/CRM/Contact/BAO/Query/Interface.php index ea6f6c3a36..f70eeeda83 100644 --- a/CRM/Contact/BAO/Query/Interface.php +++ b/CRM/Contact/BAO/Query/Interface.php @@ -68,8 +68,14 @@ abstract class CRM_Contact_BAO_Query_Interface { /** * Describe options for available for use in the search-builder. * + * The search builder determines its options by examining the API metadata corresponding to each + * search field. This approach assumes that each field has a unique-name (ie that the field's + * unique-name in the API matches the unique-name in the search-builder). + * * @param array $apiEntities list of entities whose options should be automatically scanned using API metadata * @param array $fieldOptions keys are field unique-names; values describe how to lookup the options + * For boolean options, use value "yesno". For pseudoconstants/FKs, use the name of an API entity + * from which the metadata of the field may be queried. (Yes - that is a mouthful.) * @void */ public function alterSearchBuilderOptions(&$apiEntities, &$fieldOptions) { -- 2.25.1