From 84193f76312c94fbd080e42f8a41e9301590ebbc Mon Sep 17 00:00:00 2001 From: Chris Burgess Date: Sat, 4 Feb 2017 08:12:56 +1300 Subject: [PATCH] CRM-19967: Proposed docs improvements. Conflicts: CRM/Contact/BAO/Query.php --- CRM/Contact/BAO/Query.php | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/CRM/Contact/BAO/Query.php b/CRM/Contact/BAO/Query.php index 764f57325b..dc74cf1900 100644 --- a/CRM/Contact/BAO/Query.php +++ b/CRM/Contact/BAO/Query.php @@ -2499,16 +2499,23 @@ class CRM_Contact_BAO_Query { * Create the from clause. * * @param array $tables - * Tables that need to be included in this from clause. - * if null, return mimimal from clause (i.e. civicrm_contact) + * Tables that need to be included in this from clause. If null, + * return mimimal from clause (i.e. civicrm_contact). * @param array $inner * Tables that should be inner-joined. * @param array $right * Tables that should be right-joined. - * * @param bool $primaryLocation + * Search on primary location. See note below. * @param int $mode + * Determines search mode based on bitwise MODE_* constants. * @param string|NULL $apiEntity + * Determines search mode based on entity by string. + * + * The $primaryLocation flag only seems to be used when + * locationType() has been called. This may be a search option + * exposed, or perhaps it's a "search all details" approach which + * predates decoupling of location types and primary fields? * * @return string * the from clause -- 2.25.1