Short array syntax - auto-convert api dir
[civicrm-core.git] / api / v3 / examples / PaymentProcessor / Delete.php
index e979277b457f17e5967241e087525d45d3fd47d7..4ee4993aa159c78bedc5d32ac9f79cec2974880b 100644 (file)
@@ -1,28 +1,29 @@
 <?php
 /**
- * Test Generated example of using payment_processor delete API.
+ * Test Generated example demonstrating the PaymentProcessor.delete API.
  *
  * @return array
  *   API result array
  */
 function payment_processor_delete_example() {
-  $params = array(
+  $params = [
     'id' => 2,
-  );
+  ];
 
   try{
-    $result = civicrm_api3('payment_processor', 'delete', $params);
+    $result = civicrm_api3('PaymentProcessor', 'delete', $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;
@@ -36,21 +37,20 @@ function payment_processor_delete_example() {
  */
 function payment_processor_delete_expectedresult() {
 
-  $expectedResult = array(
+  $expectedResult = [
     'is_error' => 0,
     'version' => 3,
     'count' => 1,
-    'values' => TRUE,
-  );
+    'values' => 1,
+  ];
 
   return $expectedResult;
 }
 
-/**
+/*
 * This example has been generated from the API test suite.
-* The test that created it is called
-* testPaymentProcessorDelete
-* and can be found in
+* The test that created it is called "testPaymentProcessorDelete"
+* and can be found at:
 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PaymentProcessorTest.php
 *
 * You can see the outcome of the API tests at