CiviCRM Community Forums (archive)

Hi,

Haven't commited this yet but trying to figure out the civicrm_create_success function. It seems some functions (like contact_create) start get given an array indexed by id whereas others e.g tag_create get a sequentially indexed array as their starting point

For REST uses I think the sequential is almost always better whereas for std PHP the one indexed by id is probably better so ideally the civicrm_create_success would take either form in & be able to convert it to the other if required. I tried this patch which worked in the context of UFJoin.php (copied from Tag ) but it doesn't do the third option of converting an id-indexed one back to a sequentially indexed. (My tired brain is trying to turn 3 possibilies into a boolean)

Index: api/v3/UFJoin.php
===================================================================
--- api/v3/UFJoin.php (revision 31984)
+++ api/v3/UFJoin.php (working copy)
@@ -102,7 +102,11 @@
     while ($ufJoinDAO->fetch()) {
       _civicrm_object_to_array($ufJoinDAO, $ufJoin[]);
     }
-    return civicrm_create_success($ufJoin);
+    //set to reindex if $params['sequential'] not set - this is because result is indexed
+    //in sequential order in this function whereas in some functions it is id indexed
+    //so for example in the contact API which is indexed by ID (by default) this clause would be reversed
+    $reindex = ($params['sequential']? 0 : 1);
+    return civicrm_create_success($ufJoin,$reindex);
   
   } catch (PEAR_Exception $e) {
     return civicrm_create_error( $e->getMessage() );
Index: api/v3/utils.php
===================================================================
--- api/v3/utils.php (revision 31981)
+++ api/v3/utils.php (working copy)
@@ -79,7 +79,7 @@
  */
 function civicrm_verify_mandatory (&$params, $daoName = null, $keys = array() ) {
   if ( ! is_array( $params ) ) {
-     throw new Exception ('Input parameters is not an array');
+     throw new Exception ('Input variable `params` is not an array');
   }
 
   if ($daoName != null) {
@@ -122,10 +122,10 @@
 
 /**
  *
- * @param <type> $result
- * @return <type>
+ * @param array $result
+ * @return array
  */
-function civicrm_create_success( $params = 1 )
+function civicrm_create_success( $params = 1, $reindex = 0, $idfield = 'id' )
 {
     $result = array();
     $result['is_error'] = 0;
@@ -140,7 +140,13 @@
             $result['count'] = 0;
         }
     }
-    $result['values'] = $params;
+    if ($reindex){
+      foreach ($params as $key =>$values){
+        $result['values'][$values[$idfield]] = $values;
+      }
+    }else{
+      $result['values'] = $params;
+    }
     return $result;
 }
 /**


Ok - so I can't think of an example but would prefer to keep default php behaviour unchanged to keep things a little simpler.

My main point is that some functions receive the array already indexed by ids from the BAO functions they call whereas others don't. I think that civicrm_create_success should cope with these being passed in as they come back from the BAO function. Xavier - you moved this functionality out of the Tag.php & I think that is correct - it's not too complicated to make civicrm_create_success accept both sequentially numbered & id numbered arrays & split our either or depending on $variables