<?php
/**
- * File for the CiviCRM APIv3 API wrapper
+ * @file CiviCRM APIv3 API wrapper.
*
* @package CiviCRM_APIv3
- * @subpackage API
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: api.php 30486 2010-11-02 16:12:09Z shot $
*/
/**
+ * CiviCRM API wrapper function.
+ *
* @param string $entity
* type of entities to deal with
* @param string $action
}
/**
- * Version 3 wrapper for civicrm_api. Throws exception
+ * Version 3 wrapper for civicrm_api.
+ *
+ * Throws exception.
*
* @param string $entity
* Type of entities to deal with.
}
/**
- * call getfields from api wrapper. This function ensures that settings that could alter
- * getfields output (e.g. action for all api & profile_id for profile api ) are consistently passed in.
+ * Call getfields from api wrapper.
+ *
+ * This function ensures that settings that
+ * could alter getfields output (e.g. action for all api & profile_id for
+ * profile api ) are consistently passed in.
*
- * We check whether the api call is 'getfields' because if getfields is being called we return an empty array
- * as no alias swapping, validation or default filling is done on getfields & we want to avoid a loop
+ * We check whether the api call is 'getfields' because if getfields is
+ * being called we return an empty array as no alias swapping, validation or
+ * default filling is done on getfields & we want to avoid a loop
*
* @todo other output modifiers include contact_type
*
* @param array $apiRequest
- * @return array getfields output
+ *
+ * @return array
+ * getfields output
*/
function _civicrm_api3_api_getfields(&$apiRequest) {
if (strtolower($apiRequest['action'] == 'getfields')) {
}
$getFieldsParams = array('action' => $apiRequest['action']);
$entity = $apiRequest['entity'];
- if ($entity == 'profile' && array_key_exists('profile_id', $apiRequest['params'])) {
+ if ($entity == 'Profile' && array_key_exists('profile_id', $apiRequest['params'])) {
$getFieldsParams['profile_id'] = $apiRequest['params']['profile_id'];
}
$fields = civicrm_api3($entity, 'getfields', $getFieldsParams);
*
* @param $result
*
- * @return boolean true if error, false otherwise
- * @static void
- * @access public
+ * @return bool
+ * true if error, false otherwise
*/
function civicrm_error($result) {
if (is_array($result)) {
}
/**
- * @param $entity
+ * Get camel case version of entity name.
*
- * @return string
+ * @param string|null $entity
+ *
+ * @return string|null
*/
function _civicrm_api_get_camel_name($entity) {
- return CRM_Utils_String::convertStringToCamel($entity);
+ return is_string($entity) ? CRM_Utils_String::convertStringToCamel($entity) : NULL;
}
/**
- * Swap out any $values vars - ie. the value after $value is swapped for the parent $result
+ * Swap out any $values vars.
+ *
+ * Ie. the value after $value is swapped for the parent $result
* 'activity_type_id' => '$value.testfield',
- 'tag_id' => '$value.api.tag.create.id',
- 'tag1_id' => '$value.api.entity.create.0.id'
+ * 'tag_id' => '$value.api.tag.create.id',
+ * 'tag1_id' => '$value.api.entity.create.0.id'
+ *
+ * @param array $params
+ * @param array $parentResult
+ * @param string $separator
*/
-function _civicrm_api_replace_variables($entity, $action, &$params, &$parentResult, $separator = '.') {
+function _civicrm_api_replace_variables(&$params, &$parentResult, $separator = '.') {
foreach ($params as $field => $value) {
if (is_string($value) && substr($value, 0, 6) == '$value') {
- $valuesubstitute = substr($value, 7);
+ $valueSubstitute = substr($value, 7);
- if (!empty($parentResult[$valuesubstitute])) {
- $params[$field] = $parentResult[$valuesubstitute];
+ if (!empty($parentResult[$valueSubstitute])) {
+ $params[$field] = $parentResult[$valueSubstitute];
}
else {
$fieldname .= "." . array_shift($stringParts);
if (array_key_exists($fieldname, $parentResult) && is_array($parentResult[$fieldname])) {
$arrayLocation = $parentResult[$fieldname];
- foreach ($stringParts as $key => $value) {
- $arrayLocation = CRM_Utils_Array::value($value, $arrayLocation);
+ foreach ($stringParts as $key => $innerValue) {
+ $arrayLocation = CRM_Utils_Array::value($innerValue, $arrayLocation);
}
$params[$field] = $arrayLocation;
}
$count = count($stringParts);
}
}
+ // CRM-16168 If we have failed to swap it out we should unset it rather than leave the placeholder.
+ if (substr($params[$field], 0, 6) == '$value') {
+ $params[$field] = NULL;
+ }
}
}
}
/**
- * Convert possibly camel name to underscore separated entity name
+ * Convert possibly camel name to underscore separated entity name.
*
* @param string $entity
- * Entity name in various formats e.g. Contribution, contribution, OptionValue, option_value, UFJoin, uf_join.
- * @return string $entity entity name in underscore separated format
+ * Entity name in various formats e.g. Contribution, contribution,
+ * OptionValue, option_value, UFJoin, uf_join.
*
- * FIXME: Why isn't this called first thing in civicrm_api wrapper?
+ * @return string
+ * Entity name in underscore separated format.
*/
function _civicrm_api_get_entity_name_from_camel($entity) {
- if ($entity == strtolower($entity)) {
+ if (!$entity || $entity === strtolower($entity)) {
return $entity;
}
else {
}
/**
- * Having a DAO object find the entity name
+ * Having a DAO object find the entity name.
+ *
* @param object $bao
* DAO being passed in.
+ *
* @return string
*/
function _civicrm_api_get_entity_name_from_dao($bao) {
$daoName = str_replace("BAO", "DAO", get_class($bao));
- return _civicrm_api_get_entity_name_from_camel(CRM_Core_DAO_AllCoreTables::getBriefName($daoName));
+ return CRM_Core_DAO_AllCoreTables::getBriefName($daoName);
}