From: Coleman Watts <coleman@civicrm.org>
Date: Fri, 1 Jan 2016 03:51:03 +0000 (-0500)
Subject: No, this is not a "simple function"
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=f77df040992113ab56463e9126a13cbff5139f2a;p=civicrm-core.git

No, this is not a "simple function"
---

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