Merge pull request #2749 from monishdeb/HR-317
[civicrm-core.git] / api / v3 / examples / Relationship / filterIsCurrent.php
index 9e441ac4eb5400fe70f83161a3017886ad295408..7ba21e6575e928b955c5db19f963e032397bcef8 100644 (file)
@@ -1,23 +1,30 @@
 <?php
-
-/*
- demonstrates is_current filter
+/**
+ * Test Generated example of using relationship get API
+ * demonstrates is_current filter *
  */
 function relationship_get_example(){
 $params = array(
   'filters' => array(
       'is_current' => 1,
     ),
-  'version' => 3,
-  'debug' => 0,
 );
 
-  $result = civicrm_api( 'relationship','get',$params );
+try{
+  $result = civicrm_api3('relationship', 'get', $params);
+}
+catch (CiviCRM_API3_Exception $e) {
+  // handle error here
+  $errorMessage = $e->getMessage();
+  $errorCode = $e->getErrorCode();
+  $errorData = $e->getExtraParams();
+  return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
+}
 
-  return $result;
+return $result;
 }
 
-/*
+/**
  * Function returns array of result expected from previous function
  */
 function relationship_get_expectedresult(){
@@ -30,10 +37,10 @@ function relationship_get_expectedresult(){
   'values' => array(
       '2' => array(
           'id' => '2',
-          'contact_id_a' => '63',
-          'contact_id_b' => '64',
+          'contact_id_a' => '83',
+          'contact_id_b' => '85',
           'relationship_type_id' => '31',
-          'start_date' => '2008-12-20',
+          'start_date' => '2013-07-29 00:00:00',
           'is_active' => '1',
           'description' => '',
           'is_permission_a_b' => 0,
@@ -42,7 +49,7 @@ function relationship_get_expectedresult(){
     ),
 );
 
-  return $expectedResult  ;
+  return $expectedResult;
 }
 
 
@@ -50,20 +57,20 @@ function relationship_get_expectedresult(){
 * This example has been generated from the API test suite. The test that created it is called
 *
 * testGetIsCurrent and can be found in
-* http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/RelationshipTest.php
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/RelationshipTest.php
 *
 * You can see the outcome of the API tests at
-* http://tests.dev.civicrm.org/trunk/results-api_v3
+* https://test.civicrm.org/job/CiviCRM-master-git/
 *
 * To Learn about the API read
-* http://book.civicrm.org/developer/current/techniques/api/
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
 *
-* and review the wiki at
-* http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api/explorer
 *
 * Read more about testing here
 * http://wiki.civicrm.org/confluence/display/CRM/Testing
 *
 * API Standards documentation:
 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
-*/
\ No newline at end of file
+*/