X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FGeneric.php;h=ee41baa8a80ccab305cf2cb86beb98fa14f4afc0;hb=2241036a1adf3cf03fdcc86f4328ad98f89f6b59;hp=a6559f39df2ffdfd4833b7fe1fccca0781b80d85;hpb=3a234f292baf93aa8675cbd98c95df0deedd6254;p=civicrm-core.git

diff --git a/api/v3/Generic.php b/api/v3/Generic.php
index a6559f39df..ee41baa8a8 100644
--- a/api/v3/Generic.php
+++ b/api/v3/Generic.php
@@ -10,13 +10,14 @@
  * access multiple objects e.g. contact api accesses is_deleted from the activity
  * table & from the contact table
  *
- * @param array $apiRequest api request as an array. Keys are
+ * @param array $apiRequest
+ *   Api request as an array. Keys are.
  *  - entity: string
  *  - action: string
  *  - version: string
  *  - function: callback (mixed)
  *  - params: array, varies
- *  @return array API success object
+ * @return array API success object
  */
 function civicrm_api3_generic_getfields($apiRequest) {
   static $results = array();
@@ -24,12 +25,12 @@ function civicrm_api3_generic_getfields($apiRequest) {
     $results = array();
     // we will also clear pseudoconstants here - should potentially be moved to relevant BAO classes
     CRM_Core_PseudoConstant::flush();
-    if(!empty($apiRequest['params']['fieldname'])){
+    if (!empty($apiRequest['params']['fieldname'])) {
       CRM_Utils_PseudoConstant::flushConstant($apiRequest['params']['fieldname']);
     }
-    if(!empty($apiRequest['params']['option_group_id'])){
-      $optionGroupName = civicrm_api('option_group', 'getvalue', array('version' => 3, 'id' => $apiRequest['params']['option_group_id'], 'return' => 'name') );
-      if(is_string($optionGroupName)){
+    if (!empty($apiRequest['params']['option_group_id'])) {
+      $optionGroupName = civicrm_api('option_group', 'getvalue', array('version' => 3, 'id' => $apiRequest['params']['option_group_id'], 'return' => 'name'));
+      if (is_string($optionGroupName)) {
         CRM_Utils_PseudoConstant::flushConstant(_civicrm_api_get_camel_name($optionGroupName));
       }
     }
@@ -62,15 +63,15 @@ function civicrm_api3_generic_getfields($apiRequest) {
     case 'getsingle':
     case 'getcount':
       $metadata = _civicrm_api_get_fields($apiRequest['entity'], $unique, $apiRequest['params']);
-      if (empty($metadata['id'])){
+      if (empty($metadata['id'])) {
         // if id is not set we will set it eg. 'id' from 'case_id', case_id will be an alias
-        if(!empty($metadata[strtolower($apiRequest['entity']) . '_id'])) {
+        if (!empty($metadata[strtolower($apiRequest['entity']) . '_id'])) {
           $metadata['id'] = $metadata[$lcase_entity . '_id'];
           unset($metadata[$lcase_entity . '_id']);
           $metadata['id']['api.aliases'] = array($lcase_entity . '_id');
         }
       }
-      else{
+      else {
         // really the preference would be to set the unique name in the xml
         // question is which is a less risky fix this close to a release - setting in xml for the known failure
         // (note) or setting for all api where fields is returning 'id' & we want to accept 'note_id' @ the api layer
@@ -103,7 +104,8 @@ function civicrm_api3_generic_getfields($apiRequest) {
           'title' => 'Context',
         ),
       );
-        break;
+      break;
+
     default:
       // oddballs are on their own
       $metadata = array();
@@ -115,11 +117,13 @@ function civicrm_api3_generic_getfields($apiRequest) {
     list ($apiProvider, $hypApiRequest) = \Civi\Core\Container::singleton()->get('civi_api_kernel')->resolve($hypApiRequest);
     if (isset($hypApiRequest['function'])) {
       $helper = '_' . $hypApiRequest['function'] . '_spec';
-    } else {
+    }
+    else {
       // not implemented MagicFunctionProvider
       $helper = NULL;
     }
-  } catch (\Civi\API\Exception\NotImplementedException $e) {
+  }
+  catch (\Civi\API\Exception\NotImplementedException $e) {
     $helper = NULL;
   }
   if (function_exists($helper)) {
@@ -133,14 +137,15 @@ function civicrm_api3_generic_getfields($apiRequest) {
     _civicrm_api3_generic_get_metadata_options($metadata, $apiRequest, $fieldname, $fieldSpec, $fieldsToResolve);
   }
 
-  $results[$entity][$action][$sequential] = civicrm_api3_create_success($metadata, $apiRequest['params'], NULL, 'getfields');
+  $results[$entity][$action][$sequential] = civicrm_api3_create_success($metadata, $apiRequest['params'], $entity, 'getfields');
   return $results[$entity][$action][$sequential];
 }
 
 /**
  * API return function to reformat results as count
  *
- * @param array $apiRequest api request as an array. Keys are
+ * @param array $apiRequest
+ *   Api request as an array. Keys are.
  *
  * @throws API_Exception
  * @return integer count of results
@@ -148,10 +153,10 @@ function civicrm_api3_generic_getfields($apiRequest) {
 function civicrm_api3_generic_getcount($apiRequest) {
   $apiRequest['params']['options']['is_count'] = TRUE;
   $result = civicrm_api($apiRequest['entity'], 'get', $apiRequest['params']);
-  if(is_numeric (CRM_Utils_Array::value('values', $result))) {
+  if (is_numeric(CRM_Utils_Array::value('values', $result))) {
     return (int) $result['values'];
   }
-  if(!isset($result['count'])) {
+  if (!isset($result['count'])) {
     throw new API_Exception(ts('Unexpected result from getcount') . print_r($result, TRUE));
   }
   return $result['count'];
@@ -160,7 +165,8 @@ function civicrm_api3_generic_getcount($apiRequest) {
 /**
  * API return function to reformat results as single result
  *
- * @param array $apiRequest api request as an array. Keys are
+ * @param array $apiRequest
+ *   Api request as an array. Keys are.
  *
  * @return integer count of results
  */
@@ -183,7 +189,8 @@ function civicrm_api3_generic_getsingle($apiRequest) {
 /**
  * API return function to reformat results as single value
  *
- * @param array $apiRequest api request as an array. Keys are
+ * @param array $apiRequest
+ *   Api request as an array. Keys are.
  *
  * @return integer count of results
  */
@@ -211,7 +218,7 @@ function civicrm_api3_generic_getvalue($apiRequest) {
 }
 
 /**
- * @param $params
+ * @param array $params
  */
 function _civicrm_api3_generic_getrefcount_spec(&$params) {
   $params['id']['api.required'] = 1;
@@ -221,7 +228,8 @@ function _civicrm_api3_generic_getrefcount_spec(&$params) {
 /**
  * API to determine if a record is in-use
  *
- * @param array $apiRequest api request as an array
+ * @param array $apiRequest
+ *   Api request as an array.
  *
  * @throws API_Exception
  * @return array API result (int 0 or 1)
@@ -247,7 +255,8 @@ function civicrm_api3_generic_getrefcount($apiRequest) {
 /**
  * API wrapper for replace function
  *
- * @param array $apiRequest api request as an array. Keys are
+ * @param array $apiRequest
+ *   Api request as an array. Keys are.
  *
  * @return integer count of results
  */
@@ -258,7 +267,8 @@ function civicrm_api3_generic_replace($apiRequest) {
 /**
  * API wrapper for getoptions function
  *
- * @param array $apiRequest api request as an array.
+ * @param array $apiRequest
+ *   Api request as an array.
  *
  * @return array of results
  */
@@ -274,18 +284,15 @@ function civicrm_api3_generic_getoptions($apiRequest) {
   unset($apiRequest['params']['context'], $apiRequest['params']['field']);
 
   $baoName = _civicrm_api3_get_BAO($apiRequest['entity']);
-  $options = $output = $baoName::buildOptions($fieldName, $context, $apiRequest['params']);
+  $options = $baoName::buildOptions($fieldName, $context, $apiRequest['params']);
   if ($options === FALSE) {
     return civicrm_api3_create_error("The field '{$fieldName}' has no associated option list.");
   }
   // Support 'sequential' output as a non-associative array
   if (!empty($apiRequest['params']['sequential'])) {
-    $output = array();
-    foreach ($options as $key => $val) {
-      $output[] = array('key' => $key, 'value' => $val);
-    }
+    $options = CRM_Utils_Array::makeNonAssociative($options);
   }
-  return civicrm_api3_create_success($output, $apiRequest['params'], $apiRequest['entity'], 'getoptions');
+  return civicrm_api3_create_success($options, $apiRequest['params'], $apiRequest['entity'], 'getoptions');
 }
 
 /**
@@ -299,13 +306,17 @@ function civicrm_api3_generic_getoptions($apiRequest) {
  *
  * This function is only split out for the purpose of code clarity / comment block documentation
  *
- * @param array $metadata the array of metadata that will form the result of the getfields function
+ * @param array $metadata
+ *   The array of metadata that will form the result of the getfields function.
  * @param $apiRequest
- * @param string $fieldname field currently being processed
- * @param array $fieldSpec metadata for that field
- * @param array $fieldsToResolve anny field resolutions specifically requested
+ * @param string $fieldname
+ *   Field currently being processed.
+ * @param array $fieldSpec
+ *   Metadata for that field.
+ * @param array $fieldsToResolve
+ *   Anny field resolutions specifically requested.
  */
-function _civicrm_api3_generic_get_metadata_options(&$metadata, $apiRequest, $fieldname, $fieldSpec, $fieldsToResolve){
+function _civicrm_api3_generic_get_metadata_options(&$metadata, $apiRequest, $fieldname, $fieldSpec, $fieldsToResolve) {
   if (empty($fieldSpec['pseudoconstant']) && empty($fieldSpec['option_group_id'])) {
     return;
   }