api/v3/examples/RelationshipType/Create.php

   1 <?php
   2 /**
   3  * Test Generated example of using relationship_type create API
   4  * *
   5  */
   6 function relationship_type_create_example(){
   7 $params = array(
   8   'name_a_b' => 'Relation 1 for relationship type create',
   9   'name_b_a' => 'Relation 2 for relationship type create',
  10   'contact_type_a' => 'Individual',
  11   'contact_type_b' => 'Organization',
  12   'is_reserved' => 1,
  13   'is_active' => 1,
  14   'sequential' => 1,
  15 );
  16
  17 try{
  18   $result = civicrm_api3('relationship_type', '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_type_create_expectedresult(){
  35
  36   $expectedResult = array(
  37   'is_error' => 0,
  38   'version' => 3,
  39   'count' => 1,
  40   'id' => 1,
  41   'values' => array(
  42       '0' => array(
  43           'id' => '1',
  44           'name_a_b' => 'Relation 1 for relationship type create',
  45           'label_a_b' => 'Relation 1 for relationship type create',
  46           'name_b_a' => 'Relation 2 for relationship type create',
  47           'label_b_a' => 'Relation 2 for relationship type create',
  48           'description' => '',
  49           'contact_type_a' => 'Individual',
  50           'contact_type_b' => 'Organization',
  51           'contact_sub_type_a' => '',
  52           'contact_sub_type_b' => '',
  53           'is_reserved' => '1',
  54           'is_active' => '1',
  55         ),
  56     ),
  57 );
  58
  59   return $expectedResult;
  60 }
  61
  62
  63 /*
  64 * This example has been generated from the API test suite. The test that created it is called
  65 *
  66 * testRelationshipTypeCreate and can be found in
  67 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/RelationshipTypeTest.php
  68 *
  69 * You can see the outcome of the API tests at
  70 * https://test.civicrm.org/job/CiviCRM-master-git/
  71 *
  72 * To Learn about the API read
  73 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  74 *
  75 * Browse the api on your own site with the api explorer
  76 * http://MYSITE.ORG/path/to/civicrm/api/explorer
  77 *
  78 * Read more about testing here
  79 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  80 *
  81 * API Standards documentation:
  82 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  83 */