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

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