From f77df040992113ab56463e9126a13cbff5139f2a Mon Sep 17 00:00:00 2001 From: Coleman Watts Date: Thu, 31 Dec 2015 22:51:03 -0500 Subject: [PATCH] No, this is not a "simple function" --- api/v3/utils.php | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/api/v3/utils.php b/api/v3/utils.php index 3281beada0..dc71983581 100644 --- a/api/v3/utils.php +++ b/api/v3/utils.php @@ -461,10 +461,15 @@ function _civicrm_api3_store_values(&$fields, &$params, &$values) { } /** - * Get function for query object api. + * Query function for civicrm_api_basic_get. + * + * Fetches an entity based on specified params for the "where" clause, + * return properties for the "select" clause, + * as well as limit and order. + * + * Automatically joins on custom fields to return or filter by them. * - * This is a simple get function, but it should be usable for any kind of - * entity. I created it to work around CRM-16036. + * Supports an additional sql fragment which the calling api can provide. * * @param string $dao_name * Name of DAO -- 2.25.1