* @param array $params
* array to be passed to function
*
- * @return array|int
+ * @return array|int|Civi\Api4\Generic\Result
*/
function civicrm_api(string $entity, string $action, array $params) {
return \Civi::service('civi_api_kernel')->runSafe($entity, $action, $params);
$indexField = $index && is_string($index) && !CRM_Utils_Rule::integer($index) ? $index : NULL;
$removeIndexField = FALSE;
- // If index field is not part of the select query, we add it here and remove it below
- if ($indexField && !empty($params['select']) && is_array($params['select']) && !\Civi\Api4\Utils\SelectUtil::isFieldSelected($indexField, $params['select'])) {
+ // If index field is not part of the select query, we add it here and remove it below (except for oddball "Setting" api)
+ if ($indexField && !empty($params['select']) && is_array($params['select']) && !($entity === 'Setting' && $action === 'get') && !\Civi\Api4\Utils\SelectUtil::isFieldSelected($indexField, $params['select'])) {
$params['select'][] = $indexField;
$removeIndexField = TRUE;
}
if ($index && is_array($index)) {
$indexCol = reset($index);
$indexField = key($index);
- if (property_exists($apiCall, 'select')) {
+ // Index array indicates only 1 or 2 fields need to be selected (except for oddball "Setting" api)
+ if ($entity !== 'Setting' && property_exists($apiCall, 'select')) {
$apiCall->setSelect([$indexCol]);
if ($indexField && $indexField != $indexCol) {
$apiCall->addSelect($indexField);
*
* @throws CiviCRM_API3_Exception
*
- * @return array
+ * @return array|int
+ * Dependant on the $action
*/
function civicrm_api3(string $entity, string $action, array $params = []) {
$params['version'] = 3;
* 'format.is_success' => 1
* will result in a boolean success /fail being returned if that is what you need.
*
- * @param $result
+ * @param mixed $result
*
* @return bool
* true if error, false otherwise