CiviCRM Community Forums (archive)

I was looking thought the v2 API, and can't find a simple way to get the following information without loading a lot of stuff I don't need.

The code here shows you what I want to do.  This works fine, but is so low level that it will likely break in a future release:

<?php
function da_core_get_group_status($contact_id, $group_id) {
  //AFAICT, there isn't a way to do this efficiently in either the
  //high level or low level API.  So we do the following hack:
  civicrm_initialize();
  $sql = "
  select gc.contact_id, gc.group_id, gc.status, sh.date as last_changed
  from civicrm_group_contact gc
  left join civicrm_subscription_history sh
    on gc.group_id = sh.group_id and
       gc.contact_id = sh.contact_id and
       gc.status = sh.status
  where gc.contact_id = %1 and
        gc.group_id = %2
  order by sh.date desc limit 1;
  ";

  $args =
    array(
      1 => array($contact_id, 'Integer'),
      2 => array($group_id, 'Integer')
    );

  $dao =& CRM_Core_DAO::executeQuery( $sql, $args );
  $rslt = array();
  if ($dao->fetch()) {
    $rslt['contact_id'] = $dao->contact_id;
    $rslt['group_id'] = $dao->group_id;
    $rslt['status'] = $dao->status;
    $rslt['last_changed'] = $dao->last_changed;
  }
  $dao->free();
  return $rslt;

}
?>

You can get all the groups someone is added to, and you can get all the groups for a contact of a particular status, or you can get all of the groups with no status info.  But I couldn't find a high level way to do exactly what I'm doing here: get the status and date info for a single contact_id/group_id pair.

Is there a high level way to do this, or did I really need to roll my own here?

Yep.  And it turns out, it's real hard to do what I'm trying to do with any of them.  Hence the post.  In more detail:

You can get all the groups someone is added to,

civicrm_group_contact_get()  will retrieve a list of all the groups the contact is Added on.  This is hard coded as late as 3.1 (around line 64:
<?php
    $status = CRM_Utils_Array::value( 'status', $params, 'Added' );
    require_once 'CRM/Contact/BAO/GroupContact.php';
    $values =& CRM_Contact_BAO_GroupContact::getContactGroup( $params['contact_id'], $status, null, false, true );
?>
Here, it would be better if $params could include a 'status' argument.

and you can get all the groups for a contact of a particular status,

using CRM_Contact_BAO_GroupContact::getContactGroup().  Which will give you all contacts for a single status, or

or you can get all of the groups with no status info.

if you specify status is NULL, you will get the full list of group-contact records, but the results do not return the status field at all.  So you get a list of groups to which a contact is Added, Pending, or Removed.  And you can't tell which is which   

  But I couldn't find a high level way to do exactly what I'm doing here: get the status and date info for a single contact_id/group_id pair.

Using the HL API, you can't do this at all.  Using the OO API, you have to call CRM_Contact_BAO_GroupContact::getContactGroup() twice, and merge the results.

This is pretty heavy weight.  IMNSHO, we should change the behavior of one or more of these higher level APIs to fix this.

I'd be willing to make the HL API actually use the 'status' argument, which I suspect is the best way to solve this problem in the HL framework.