From: Tim Otten <totten@civicrm.org>
Date: Fri, 23 Aug 2013 01:27:00 +0000 (-0700)
Subject: CRM_Contact_BAO_Query_Interface - More docs
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=b7fa0173f6b9bf46a13d4aafc8fb49724ed80013;p=civicrm-core.git

CRM_Contact_BAO_Query_Interface - More docs
---

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) {