Short array syntax - auto-convert api dir
[civicrm-core.git] / api / v3 / examples / Membership / Get.php
index 773ef1a6c204d590942f18fa7303164b60fdff77..cb6c5aa4bbb82ec4e57cfd9c985f60fce43edf28 100644 (file)
@@ -1,29 +1,29 @@
 <?php
 /**
- * Test Generated example of using membership get API.
- *
+ * Test Generated example demonstrating the Membership.get API.
  *
  * @return array
  *   API result array
  */
 function membership_get_example() {
-  $params = array(
-    'membership_type_id' => 21,
-  );
+  $params = [
+    'membership_type_id' => 23,
+  ];
 
   try{
-    $result = civicrm_api3('membership', 'get', $params);
+    $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,
+    return [
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
-    );
+    ];
   }
 
   return $result;
@@ -37,40 +37,39 @@ function membership_get_example() {
  */
 function membership_get_expectedresult() {
 
-  $expectedResult = array(
+  $expectedResult = [
     'is_error' => 0,
     'version' => 3,
     'count' => 1,
     'id' => 1,
-    'values' => array(
-      '1' => array(
+    'values' => [
+      '1' => [
         'id' => '1',
-        'contact_id' => '35',
-        'membership_type_id' => '21',
+        'contact_id' => '38',
+        'membership_type_id' => '23',
         'join_date' => '2009-01-21',
         'start_date' => '2013-07-29 00:00:00',
         'end_date' => '2013-08-04 00:00:00',
         'source' => 'Payment',
-        'status_id' => '18',
+        'status_id' => '19',
         'is_override' => '1',
         'is_test' => 0,
         'is_pay_later' => 0,
+        'custom_1' => 'custom string',
         'membership_name' => 'General',
         'relationship_name' => 'Child of',
-        'custom_1' => 'custom string',
         'custom_1_1' => 'custom string',
-      ),
-    ),
-  );
+      ],
+    ],
+  ];
 
   return $expectedResult;
 }
 
-/**
+/*
 * This example has been generated from the API test suite.
-* The test that created it is called
-* testGetWithParamsMemberShipIdAndCustom
-* and can be found in
+* The test that created it is called "testGetWithParamsMemberShipIdAndCustom"
+* and can be found at:
 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MembershipTest.php
 *
 * You can see the outcome of the API tests at