api/v3/examples/RelationshipCreate.php

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