CiviCRM Community Forums (archive)

Hello,

unfortunately and after many hours experimenting I have to say, that CiviCRM API doesn't what it is expected to in case of querying events.

The starting point was, that I wrote a drupal module to display upcoming events. The following example was a basis for the code
http://wiki.civicrm.org/confluence/display/CRMDOC40/List+of+Upcoming+CiviEvents+or+Feed+of+Events

Finally I had to realize, that some of the events were not displayed and so I started to find out why. I activated the build in CiviCRM block for upcoming events on a test node and to my suprise it showed all events correctly.
So I went back to experiment with my module, stripped of all unnecessary things like filtering, sorting, limiting and so on.

But whatever I do, the missing events are not shown. So I dare to say, that there's an issue with the API.

Any idea what could be the reason?
Did anybody write a module on basis of CRM/Event/BAO/Event.php, which is the basis for the built in upcoming events block?

The left over test function inside the module:

function civicrm_test_getevents2() {

  if(module_exists('civicrm')) {

    civicrm_initialize(TRUE);
    require_once 'api/v2/Event.php';
    // This example limits listing to public and active events
    $params = array ('is_public'     => 1, 'is_active'     => 1);
    $myEvents = civicrm_event_search( $params );
    $display = '';
    if($myEvents) {
      $count = 0;
      $last = '';
      usort($myEvents,'cmp_date');
      foreach ($myEvents as $event) {
        $display .=  "<li>".sprintf("%2d", (int)$event['id'])." - ".$event['event_title']."</li>";
        $count++;
      }
      $display = "<pre><ul>".$display."</ul></pre>";
      if ($count <= 0) {
        $display = 'No events found.';
      }
    } else {
      $display = 'No events found.';
    }
  }
  else {
    $display = 'CiviCRM not installed.';
  }
  return($display);
}

Hello Hershel,

thank you for your response.

I forgot to say, that in may original module I used API V3.

To be sure I even changed my test modul. Unfortunately the same behaviour as I descriped in my first post. Some events are not listet, but they are listet with the built in upcoming events block.

Any other idea?

Changed source code to this

function civicrm_test_getevents2() {

  if(module_exists('civicrm')) {

    civicrm_initialize(TRUE);
    require_once 'api/api.php';
    $params = array (
      'is_public' => 1,
      'is_active' => 1,
      'version' => 3
    );
    $myEvents = civicrm_api('event', 'get', $params);

    $display = '';
    if($myEvents) {
      $count = 0;
      $last = '';
      usort($myEvents['values'],'cmp_date');
      foreach ($myEvents['values'] as $event) {
        $display .=  "<li>".sprintf("%2d", (int)$event['id'])." - ".$event['event_title']."</li>";
        $count++;
      }
      $display = "<pre><ul>".$display."</ul></pre>";
      if ($count <= 0) {
        $display = 'No events found.';
      }
    } else {
      $display = 'No events found.';
    }
  }
  else {
    $display = 'CiviCRM not installed.';
  }
  return($display);
}

Hi,

Spent some time yesterday on it with IRC. It seems that the get ignores the param and always return all the events (at least was the issue when trying to filter by title).

To verify it's this (and that what you do fixes it), add tests (that should fail) tests/phpunit/api/v3/EventTest.php

  function testGetEventByWrongTitle() {
    $params = array('title' => 'No event with that title',
      'version' => $this->_apiversion,
    );

    $result = civicrm_api('event', 'get', $params);
    $this->assertEquals($result['count'], 0); // this should fail and return one event, even if the title doesn't match
  }


The get event is probably better replaced by a generic get

function civicrm_api3_event_get($params) {
  return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}

But I haven't verified if it breaks something (run all the tests for Events should confirm)

You'd need to install from svn & set up a test environement. Despite all my moaning, isn't that difficult.

Would be super helpful if you could do the above.

X+

Sorry but I didn't and don't have the time to debug this, but here is a solution that works for us, in hopes this will help someone.

The function returns the values as the API V3 function does, so one doesn't have to change the rest of the code. This piece of code can then be changed in the future, when API V3 works as expected.

function civicrm_eventlist_sortdate($a,$b) {
  if ($a['start_date'] > $b['start_date']) return 1;
  if ($a['start_date'] < $b['start_date']) return -1;
  return 0;
}

function civicrm_eventlist_eventlist($eventtype=0) {

  $result = array();

  if (!civicrm_initialize()) {
    $result['is_error'] = 1;
    return($result);
  }

  $result['is_error'] = 0;
  $result['count'] = 0;
  $result['values'] = array();
  $file1 = './'. drupal_get_path('module', 'civicrm') ."/../CRM/Event/BAO/Event.php";
  $file2 = './'. drupal_get_path('module', 'civicrm') ."/../CRM/Core/Permission.php";
  if( is_file($file1) AND is_file($file2) ) {
    require_once($file1);
    require_once($file2);
    $cv = new CRM_Event_BAO_Event();
    $start = null;
    $type = ($eventtype == 0) ? null : $eventtype;
    $eventId = null;
    $end = null;
    $result['values'] = $cv->getCompleteInfo($start, $type, $eventId, $end);
    $result['count'] = sizeof($result['values']);
  }

  usort($result['values'], 'civicrm_eventlist_sortdate');
  return($result);
}

I don't mark this thread as solved, because this is only a partial or interim solution.

Maybe I'll find the time to examine this in one or two month.