api/v3/examples/RelationshipDelete.php

   1 <?php
   2
   3 /*
   4
   5  */
   6 function relationship_delete_example(){
   7 $params = array(
   8   'id' => 1,
   9   'version' => 3,
  10   'debug' => 0,
  11 );
  12
  13   $result = civicrm_api( 'relationship','delete',$params );
  14
  15   return $result;
  16 }
  17
  18 /*
  19  * Function returns array of result expected from previous function
  20  */
  21 function relationship_delete_expectedresult(){
  22
  23   $expectedResult = array(
  24   'is_error' => 0,
  25   'version' => 3,
  26   'count' => 1,
  27   'values' => 'Deleted relationship successfully',
  28 );
  29
  30   return $expectedResult  ;
  31 }
  32
  33
  34 /*
  35 * This example has been generated from the API test suite. The test that created it is called
  36 *
  37 * testRelationshipDelete and can be found in
  38 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/RelationshipTest.php
  39 *
  40 * You can see the outcome of the API tests at
  41 * http://tests.dev.civicrm.org/trunk/results-api_v3
  42 *
  43 * To Learn about the API read
  44 * http://book.civicrm.org/developer/current/techniques/api/
  45 *
  46 * and review the wiki at
  47 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  48 *
  49 * Read more about testing here
  50 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  51 *
  52 * API Standards documentation:
  53 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  54 */