api/v3/examples/Relationship/BetweenRelationshipType.php

   1 <?php
   2 /**
   3  * Test Generated example of using relationship get API
   4  * demonstrates use of BETWEEN filter *
   5  */
   6 function relationship_get_example(){
   7 $params = array(
   8   'relationship_type_id' => array(
   9       'BETWEEN' => array(
  10           '0' => 32,
  11           '1' => 34,
  12         ),
  13     ),
  14 );
  15
  16 try{
  17   $result = civicrm_api3('relationship', 'get', $params);
  18 }
  19 catch (CiviCRM_API3_Exception $e) {
  20   // handle error here
  21   $errorMessage = $e->getMessage();
  22   $errorCode = $e->getErrorCode();
  23   $errorData = $e->getExtraParams();
  24   return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  25 }
  26
  27 return $result;
  28 }
  29
  30 /**
  31  * Function returns array of result expected from previous function
  32  */
  33 function relationship_get_expectedresult(){
  34
  35   $expectedResult = array(
  36   'is_error' => 0,
  37   'version' => 3,
  38   'count' => 3,
  39   'values' => array(
  40       '2' => array(
  41           'id' => '2',
  42           'contact_id_a' => '63',
  43           'contact_id_b' => '64',
  44           'relationship_type_id' => '32',
  45           'start_date' => '2008-12-20',
  46           'is_active' => '1',
  47           'description' => '',
  48           'is_permission_a_b' => 0,
  49           'is_permission_b_a' => 0,
  50         ),
  51       '3' => array(
  52           'id' => '3',
  53           'contact_id_a' => '63',
  54           'contact_id_b' => '64',
  55           'relationship_type_id' => '33',
  56           'start_date' => '2008-12-20',
  57           'is_active' => '1',
  58           'description' => '',
  59           'is_permission_a_b' => 0,
  60           'is_permission_b_a' => 0,
  61         ),
  62       '4' => array(
  63           'id' => '4',
  64           'contact_id_a' => '63',
  65           'contact_id_b' => '64',
  66           'relationship_type_id' => '34',
  67           'start_date' => '2008-12-20',
  68           'is_active' => '1',
  69           'description' => '',
  70           'is_permission_a_b' => 0,
  71           'is_permission_b_a' => 0,
  72         ),
  73     ),
  74 );
  75
  76   return $expectedResult;
  77 }
  78
  79
  80 /*
  81 * This example has been generated from the API test suite. The test that created it is called
  82 *
  83 * testGetTypeOperators and can be found in
  84 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/RelationshipTest.php
  85 *
  86 * You can see the outcome of the API tests at
  87 * http://tests.dev.civicrm.org/trunk/results-api_v3
  88 *
  89 * To Learn about the API read
  90 * http://book.civicrm.org/developer/current/techniques/api/
  91 *
  92 * and review the wiki at
  93 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  94 *
  95 * Read more about testing here
  96 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  97 *
  98 * API Standards documentation:
  99 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
 100 */