api/v3/examples/Activity/DateTimeHigh.php

   1 <?php
   2 /**
   3  * Test Generated example of using activity get API
   4  * demonstrates _high filter (at time of writing doesn't work if contact_id is set *
   5  */
   6 function activity_get_example(){
   7 $params = array(
   8   'source_contact_id' => 17,
   9   'filter.activity_date_time_high' => '20120101000000',
  10   'sequential' => 1,
  11 );
  12
  13 try{
  14   $result = civicrm_api3('activity', 'get', $params);
  15 }
  16 catch (CiviCRM_API3_Exception $e) {
  17   // handle error here
  18   $errorMessage = $e->getMessage();
  19   $errorCode = $e->getErrorCode();
  20   $errorData = $e->getExtraParams();
  21   return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  22 }
  23
  24 return $result;
  25 }
  26
  27 /**
  28  * Function returns array of result expected from previous function
  29  */
  30 function activity_get_expectedresult(){
  31
  32   $expectedResult = array(
  33   'is_error' => 0,
  34   'version' => 3,
  35   'count' => 1,
  36   'id' => 1,
  37   'values' => array(
  38       '0' => array(
  39           'id' => '1',
  40           'activity_type_id' => '46',
  41           'subject' => 'Make-it-Happen Meeting',
  42           'activity_date_time' => '2011-01-01 00:00:00',
  43           'duration' => '120',
  44           'location' => 'Pensulvania',
  45           'details' => 'a test activity',
  46           'status_id' => '1',
  47           'priority_id' => '1',
  48           'is_test' => 0,
  49           'is_auto' => 0,
  50           'is_current_revision' => '1',
  51           'is_deleted' => 0,
  52           'source_contact_id' => '17',
  53         ),
  54     ),
  55 );
  56
  57   return $expectedResult;
  58 }
  59
  60
  61 /*
  62 * This example has been generated from the API test suite. The test that created it is called
  63 *
  64 * testGetFilterMaxDate and can be found in
  65 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/ActivityTest.php
  66 *
  67 * You can see the outcome of the API tests at
  68 * http://tests.dev.civicrm.org/trunk/results-api_v3
  69 *
  70 * To Learn about the API read
  71 * http://book.civicrm.org/developer/current/techniques/api/
  72 *
  73 * and review the wiki at
  74 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  75 *
  76 * Read more about testing here
  77 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  78 *
  79 * API Standards documentation:
  80 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  81 */