// defaults based on data model and API policy
switch ($action) {
case 'getfields':
- $values = _civicrm_api_get_fields($entity, false, $apiRequest['params']);
+ $values = _civicrm_api_get_fields($entity, FALSE, $apiRequest['params']);
return civicrm_api3_create_success($values, $apiRequest['params'], $entity, 'getfields');
case 'create':
case 'update':
$hypApiRequest = array('entity' => $apiRequest['entity'], 'action' => $action, 'version' => $apiRequest['version']);
try {
list ($apiProvider, $hypApiRequest) = \Civi\Core\Container::singleton()->get('civi_api_kernel')->resolve($hypApiRequest);
- $helper = '_' . $hypApiRequest['function'] . '_spec';
+ if (isset($hypApiRequest['function'])) {
+ $helper = '_' . $hypApiRequest['function'] . '_spec';
+ } else {
+ // not implemented MagicFunctionProvider
+ $helper = NULL;
+ }
} catch (\Civi\API\Exception\NotImplementedException $e) {
$helper = NULL;
}
return civicrm_api3_create_error("missing param return=field you want to read the value of", array('error_type' => 'mandatory_missing', 'missing_param' => 'return'));
}
+/**
+ * @param $params
+ */
+function _civicrm_api3_generic_getrefcount_spec(&$params) {
+ $params['id']['api.required'] = 1;
+}
+
+/**
+ * API to determine if a record is in-use
+ *
+ * @param array $apiRequest api request as an array
+ *
+ * @throws API_Exception
+ * @return array API result (int 0 or 1)
+ */
+function civicrm_api3_generic_getrefcount($apiRequest) {
+ $entityToClassMap = CRM_Core_DAO_AllCoreTables::daoToClass();
+ if (!isset($entityToClassMap[$apiRequest['entity']])) {
+ throw new API_Exception("The entity '{$apiRequest['entity']}' is unknown or unsupported by 'getrefcount'. Consider implementing this API.", 'getrefcount_unsupported');
+ }
+ $daoClass = $entityToClassMap[$apiRequest['entity']];
+
+ /* @var $dao CRM_Core_DAO */
+ $dao = new $daoClass();
+ $dao->id = $apiRequest['params']['id'];
+ if ($dao->find(TRUE)) {
+ return civicrm_api3_create_success($dao->getReferenceCounts());
+ }
+ else {
+ return civicrm_api3_create_success(array());
+ }
+}
+
/**
* API wrapper for replace function
*
* 2) the field is a pseudoconstant and is NOT an FK
* - the reason for this is that checking / transformation is done on pseudoconstants but
* - if the field is an FK then mysql will enforce the data quality (& we have handling on failure)
- * @todo - if may be we should define a 'resolve' key on the psuedoconstant for when these rules are not fine enough
+ * @todo - if may be we should define a 'resolve' key on the pseudoconstant for when these rules are not fine enough
*
* This function is only split out for the purpose of code clarity / comment block documentation
*