Author Topic: New proposed action 'getvalues' (Read 973 times)

Eileen · September 13, 2013, 01:25:22 pm

So, we have getvalue but for autocompletes 'getvalues' would be handy - e.g

CRM.api('state_province', 'getvalues', array(
  'country_id' => array('IN' => array(1228, 1229),
  'name' => array('LIKE' => 'M%'),
  'return' => 'name', 
  'options' => array('limit' => 5)
);

to return an array like

Code: [Select]

{
'1018' : 'Maine',
'1019' : 'Maryland'
'1020' : 'Massachusetts'
}

Code: [Select]

CRM.api('state_province', 'getvalues', array(
  'country_id' => array('IN' => array(1228, 1229),
  'name' => array('LIKE' => 'M%'),
  'return' => 'name', 
  'options' => array(
    'limit' => 5,
    'key' => 'abbreviation',
  )
);

to return an array like

Code: [Select]

{
'MD' : 'Maine',
'ME' : 'Maryland'
'MA' : 'Massachusetts'
}

Code: [Select]

CRM.api('state_province', 'getvalues', array(
  'country_id' => array('IN' => array(1228, 1229),
  'name' => array('LIKE' => 'M%'),
  'return' => 'name, abbreviation', 
  'options' => array(
    'limit' => 5,
    'key' => 'id',
    'separator' => ': ',
  )
);

Code: [Select]

{
'1018' : 'MD: Maine',
'1019' : 'ME: Maryland',
'1020' : 'MA: Massachusetts',
}

The missing magic in the above (specific to state) is how to deal with the config var of limit to state. We could limit to configured if country is not specified & people can bypass using 'country_id' => array('LIKE' => '%',

xavier · September 16, 2013, 11:27:39 pm

Hi,

In jsland, I tend to find easier not to use keys, just an array that contains all the data, eg.

Code: [Select]

[
{id:'1018', abbreviation : 'MD',name: 'Maine'},
id:'1019', abbreviation: 'ME', name: 'Maryland'},
{id:'1020', abbeviation:'MA', name:'Massachusetts',}
]

if the other formats are needed, they can be trivially generated on the client side from this single one, so I'd rather not go the options.key options.separator

Erik Hommel · September 16, 2013, 11:40:22 pm

I think we need to make the most of the js possibilities so +1 for X

Eileen · September 17, 2013, 12:18:58 am

hmm - so that is basically the same as doing a get & then using the values key. Maybe I'm still just too php in my thinking as the one I thought would be useful was

Code: [Select]

{
'1018' : 'Maine',
'1019' : 'Maryland'
'1020' : 'Massachusetts'
}

as it would mean the code doing the look up wouldn't need to know the field names involved - just $field => $key

Maybe I just need to re-look at my assumptions & use the existing get

nicolas · September 17, 2013, 10:36:15 am

Eileen - how would this fit with the new pseudoconstants functions that Tim worked on?
KISS: if this is already possible with a get, and massaging the output to the right format, then no need for 'getvalues'.

Eileen · September 17, 2013, 01:55:34 pm

Yeah, my thinking was that getvalues would make js simpler (particularly in the context of jquery lookups) in the same way that 'getvalue' & getsingle' are handy wrappers & would not just apply to pseudoconstants.

However, I was specifically looking at existing autocomplete code as my starting point. X's reply has made me realise I would need to pass the 'return' values to my code anyway & so it makes sense to work with the existing get.

The problem with using a pseudoconstant (getoptions) here (for state & country) is
1) I don't think you can specific country calling getoptions on state
2) in the context of an autocomplete the performance of calling getoptions is bad as it will render them all rather than those you want
3) the pseudoconstant is restricted by 'available states'. Turning on available states for all, or large numbers of, countries kills the site (out of memory errors) so I was hoping to be able to access states not deemed available

totten · September 17, 2013, 04:22:07 pm

@nicolas,Coleman was the main man behind the pseudo-constants changes. But thanks for thinking of me.

nicolas · September 17, 2013, 09:41:27 pm

Ooops ... Coleman, next time we met f2f beer's on me

CiviCRM Community Forums (archive)

News:

Author Topic: New proposed action 'getvalues' (Read 973 times)

Eileen

New proposed action 'getvalues'

xavier

Re: New proposed action 'getvalues'

Erik Hommel

Re: New proposed action 'getvalues'

Eileen

Re: New proposed action 'getvalues'

nicolas

Re: New proposed action 'getvalues'

Eileen

Re: New proposed action 'getvalues'

totten

Re: New proposed action 'getvalues'

nicolas

Re: New proposed action 'getvalues'