api/v3/examples/Relationship/NotBetweenRelationshipType.php

   1 <?php
   2 /**
   3  * Test Generated example of using relationship get API
   4  * demonstrates use of Not BETWEEN filter *
   5  */
   6 function relationship_get_example(){
   7 $params = array(
   8   'relationship_type_id' => array(
   9       'NOT BETWEEN' => array(
  10           '0' => 33,
  11           '1' => 35,
  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' => 1,
  39   'id' => 1,
  40   'values' => array(
  41       '1' => array(
  42           'id' => '1',
  43           'contact_id_a' => '87',
  44           'contact_id_b' => '89',
  45           'relationship_type_id' => '32',
  46           'start_date' => '2013-07-29 00:00:00',
  47           'is_active' => '1',
  48           'description' => '',
  49           'is_permission_a_b' => 0,
  50           'is_permission_b_a' => 0,
  51         ),
  52     ),
  53 );
  54
  55   return $expectedResult;
  56 }
  57
  58
  59 /*
  60 * This example has been generated from the API test suite. The test that created it is called
  61 *
  62 * testGetTypeOperators and can be found in
  63 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/RelationshipTest.php
  64 *
  65 * You can see the outcome of the API tests at
  66 * https://test.civicrm.org/job/CiviCRM-master-git/
  67 *
  68 * To Learn about the API read
  69 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  70 *
  71 * Browse the api on your own site with the api explorer
  72 * http://MYSITE.ORG/path/to/civicrm/api/explorer
  73 *
  74 * Read more about testing here
  75 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  76 *
  77 * API Standards documentation:
  78 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  79 */