api/v3/examples/Relationship/filterIsCurrent.php

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