updated examples
[civicrm-core.git] / api / v3 / examples / Membership / filterIsCurrent.php
index db786971a980dbb211e3218995cbcc59bb5f279e..c0e98ff39797c8ed89ed381bd1214317db831219 100644 (file)
@@ -1,23 +1,31 @@
 <?php
-
-/*
- Demonstrates use of 'filter' active_only' param
+/**
+ * Test Generated example of using membership get API
+ * Demonstrates use of 'filter' active_only' param *
  */
 function membership_get_example(){
 $params = array(
-  'contact_id' => 13,
+  'contact_id' => 17,
   'filters' => array(
       'is_current' => 1,
     ),
-  'version' => 3,
 );
 
-  $result = civicrm_api( 'membership','get',$params );
+try{
+  $result = civicrm_api3('membership', '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 membership_get_expectedresult(){
@@ -31,17 +39,17 @@ function membership_get_expectedresult(){
       '1' => array(
           'id' => '1',
           'membership_id' => '1',
-          'contact_id' => '13',
-          'membership_contact_id' => '13',
-          'membership_type_id' => '11',
+          'contact_id' => '17',
+          'membership_contact_id' => '17',
+          'membership_type_id' => '25',
           'join_date' => '2009-01-21',
-          'start_date' => '2009-01-21',
+          'start_date' => '2013-07-29 00:00:00',
           'membership_start_date' => '2009-01-21',
-          'end_date' => '2009-12-21',
+          'end_date' => '2013-08-04 00:00:00',
           'membership_end_date' => '2009-12-21',
           'source' => 'Payment',
           'membership_source' => 'Payment',
-          'status_id' => '18',
+          'status_id' => '20',
           'is_override' => '1',
           'is_test' => 0,
           'member_is_test' => 0,
@@ -53,7 +61,7 @@ function membership_get_expectedresult(){
     ),
 );
 
-  return $expectedResult  ;
+  return $expectedResult;
 }
 
 
@@ -61,20 +69,20 @@ function membership_get_expectedresult(){
 * This example has been generated from the API test suite. The test that created it is called
 *
 * testGetOnlyActive and can be found in
-* http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/MembershipTest.php
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MembershipTest.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
+*/