crm.fsf.org/20131203/files/sites/all/modules-old/civicrm/api/v3/examples/Relationship/NotInRelationshipType.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the Relationship.get API.
   4  *
   5  * Demonstrates use of NOT IN 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 IN' => array(
  14         '0' => 33,
  15         '1' => 34,
  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       'error' => $errorMessage,
  30       'error_code' => $errorCode,
  31       'error_data' => $errorData,
  32     );
  33   }
  34
  35   return $result;
  36 }
  37
  38 /**
  39  * Function returns array of result expected from previous function.
  40  *
  41  * @return array
  42  *   API result array
  43  */
  44 function relationship_get_expectedresult() {
  45
  46   $expectedResult = array(
  47     'is_error' => 0,
  48     'version' => 3,
  49     'count' => 2,
  50     'values' => array(
  51       '1' => array(
  52         'id' => '1',
  53         'contact_id_a' => '87',
  54         'contact_id_b' => '89',
  55         'relationship_type_id' => '32',
  56         'start_date' => '2013-07-29 00:00:00',
  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' => '87',
  65         'contact_id_b' => '89',
  66         'relationship_type_id' => '35',
  67         'start_date' => '2013-07-29 00:00:00',
  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 * This example has been generated from the API test suite.
  81 * The test that created it is called "testGetTypeOperators"
  82 * and can be found at:
  83 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/RelationshipTest.php
  84 *
  85 * You can see the outcome of the API tests at
  86 * https://test.civicrm.org/job/CiviCRM-master-git/
  87 *
  88 * To Learn about the API read
  89 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  90 *
  91 * Browse the api on your own site with the api explorer
  92 * http://MYSITE.ORG/path/to/civicrm/api
  93 *
  94 * Read more about testing here
  95 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  96 *
  97 * API Standards documentation:
  98 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  99 */