api/v3/examples/Relationship/NotBetweenRelationshipType.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the Relationship.get API.
   4  *
   5  * Demonstrates use of Not BETWEEN filter.
   6  *
   7  * @return array
   8  *   API result array
   9  */
  10 function relationship_get_example() {
  11   $params = array(
  12     'relationship_type_id' => array(
  13       'NOT BETWEEN' => array(
  14         '0' => 36,
  15         '1' => 38,
  16       ),
  17     ),
  18   );
  19
  20   try{
  21     $result = civicrm_api3('Relationship', 'get', $params);
  22   }
  23   catch (CiviCRM_API3_Exception $e) {
  24     // Handle error here.
  25     $errorMessage = $e->getMessage();
  26     $errorCode = $e->getErrorCode();
  27     $errorData = $e->getExtraParams();
  28     return array(
  29       'is_error' => 1,
  30       'error_message' => $errorMessage,
  31       'error_code' => $errorCode,
  32       'error_data' => $errorData,
  33     );
  34   }
  35
  36   return $result;
  37 }
  38
  39 /**
  40  * Function returns array of result expected from previous function.
  41  *
  42  * @return array
  43  *   API result array
  44  */
  45 function relationship_get_expectedresult() {
  46
  47   $expectedResult = array(
  48     'is_error' => 0,
  49     'version' => 3,
  50     'count' => 1,
  51     'id' => 1,
  52     'values' => array(
  53       '1' => array(
  54         'id' => '1',
  55         'contact_id_a' => '99',
  56         'contact_id_b' => '101',
  57         'relationship_type_id' => '35',
  58         'start_date' => '2013-07-29 00:00:00',
  59         'is_active' => '1',
  60         'is_permission_a_b' => 0,
  61         'is_permission_b_a' => 0,
  62       ),
  63     ),
  64   );
  65
  66   return $expectedResult;
  67 }
  68
  69 /*
  70 * This example has been generated from the API test suite.
  71 * The test that created it is called "testGetTypeOperators"
  72 * and can be found at:
  73 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/RelationshipTest.php
  74 *
  75 * You can see the outcome of the API tests at
  76 * https://test.civicrm.org/job/CiviCRM-master-git/
  77 *
  78 * To Learn about the API read
  79 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  80 *
  81 * Browse the api on your own site with the api explorer
  82 * http://MYSITE.ORG/path/to/civicrm/api
  83 *
  84 * Read more about testing here
  85 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  86 *
  87 * API Standards documentation:
  88 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  89 */