CiviCRM Community Forums (archive)

One problem I hit with custom tokens is that they aren't very portable - if you want to re-use some (but not all) tokens from one site on another (which has it's own tokens) you have to sort of integrate the tokens from the module on the first site into the ones on the second site - or split them out into lots of separate modules.

I have created my own civitoken module (https://svn.fuzion.co.nz/repos/fuzion-code/trunk/drupal/d7modules/civitoken) which looks in the custom php directory for a folder called 'tokens' & loads token files from there. This makes the token definition very granular & easy to move individual token files from one site to another.


Here's a sample - it exposes the name of a related contact as the mygroup.group token. I can put this in the $custom_php_dir/token folder on any site that has civitoken installed & it will become available on that site - of course this not an example of a token that I would port to other sites.

 mygroup.inc

function mygroup_civitoken_declare($token){
  return array(
    $token. '.group' => 'My Group',
    );
}


function abagroup_civitoken_get($cid, &$value){
  //Get contacts group
  $group = civicrm_api('relationship', 'get', array(
    'version' => 3,
    'contact_id_a' => $cid,
    'relationship_type_id' => 13,
    'sequential' => 1,
    'api.contact.getvalue' => array(
      'id' => '$value.contact_id_b',
      'return' => 'display_name')));
 
 

    $value['mygroup.group'] = $group['values'][0]['api.contact.getvalue'];
return $value;
}

yes, someday.

For now it's just a drupal module

Yep - think you can talk Tim into doing it?

Hmm Coleman - that possibility just never arose for me (the efficient query :-)). I think it would make sense to to have a different function name for that.

I don't think it's doing #2 because I have been  using it against 4.0 & I think #2 only become doable for 4.1 & I haven't gotten my head around the changes yet.

Ah yes, that is the obvious answer.

If anyone else has any interest in extending this before it hits the top of my priority list I'm happy for someone to move it onto github (or even if they feel ready drupal.org)