CiviCRM Community Forums (archive)

Going through the API in eclipse highlights that there are some minor discrepancies that show up in the IDE. Not hugely important but would be good to have a 'preferred'

1)
I see the $params is sometimes passed in with &  and sometimes without - ie.

function civicrm_custom_field_delete( $params )

vs

function civicrm_event_create( &$params )

the second seems more recent so may be preferred although I'm not sure why it makes more sense.


2)

 Also, of the lines at the bottom I assume the first is the best ie.:
- $params mentioned (which it isn't in #2)
- array with no capital
- description says associative array (seems like over-wordiness given that array is specified)

 
 * @param $params     array   Associative array of property name/value pairs to insert in group.
 * @param array id of the group to be deleted
 * @param $params     Array id of the field to be deleted
 

Like Eileen, I have no idea why we would use &$params, can anyone enlighten us :-)
Erik

Thanks X!

So the standards for API over Xmas became:
* we use civicrm_create_success to return results (and fix it first for the REST, one array level too deep)
* we use params by ref so &$params
* we get rid of the _ internal functions with the same name (so no more civicrm_contact_get and _civicrm_contact_get)
Erik

From PHPDoc it looks like

@param $params     array   Associative array of property name/value pairs to insert in group.

should be


@param  array  $params  Associative array of property name/value pairs to insert in group.

Re demeritcowboy's point I notice the case API DOES change a params value - not sure why

    // status msg
    $params['statusMsg'] = ts('Case opened successfully.');

Agree, API should not change the input param!