api/v3/examples/PaymentProcessor/Create.php

   1 <?php
   2 /**
   3  * Test Generated example of using payment_processor create API
   4  * *
   5  */
   6 function payment_processor_create_example(){
   7 $params = array(
   8   'name' => 'API Test PP',
   9   'payment_processor_type_id' => 1,
  10   'class_name' => 'CRM_Core_Payment_APITest',
  11   'is_recur' => 0,
  12   'domain_id' => 1,
  13 );
  14
  15 try{
  16   $result = civicrm_api3('payment_processor', 'create', $params);
  17 }
  18 catch (CiviCRM_API3_Exception $e) {
  19   // handle error here
  20   $errorMessage = $e->getMessage();
  21   $errorCode = $e->getErrorCode();
  22   $errorData = $e->getExtraParams();
  23   return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  24 }
  25
  26 return $result;
  27 }
  28
  29 /**
  30  * Function returns array of result expected from previous function
  31  */
  32 function payment_processor_create_expectedresult(){
  33
  34   $expectedResult = array(
  35   'is_error' => 0,
  36   'version' => 3,
  37   'count' => 1,
  38   'id' => 1,
  39   'values' => array(
  40       '1' => array(
  41           'id' => '1',
  42           'domain_id' => '1',
  43           'name' => 'API Test PP',
  44           'description' => '',
  45           'payment_processor_type_id' => '1',
  46           'is_active' => '',
  47           'is_default' => 0,
  48           'is_test' => 0,
  49           'user_name' => '',
  50           'password' => '',
  51           'signature' => '',
  52           'url_site' => '',
  53           'url_api' => '',
  54           'url_recur' => '',
  55           'url_button' => '',
  56           'subject' => '',
  57           'class_name' => 'CRM_Core_Payment_APITest',
  58           'billing_mode' => '1',
  59           'is_recur' => 0,
  60           'payment_type' => '1',
  61         ),
  62     ),
  63 );
  64
  65   return $expectedResult;
  66 }
  67
  68
  69 /*
  70 * This example has been generated from the API test suite. The test that created it is called
  71 *
  72 * testPaymentProcessorCreate and can be found in
  73 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PaymentProcessorTest.php
  74 *
  75 * You can see the outcome of the API tests at
  76 * https://test.civicrm.org/job/CiviCRM-master-git/
  77 *
  78 * To Learn about the API read
  79 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  80 *
  81 * Browse the api on your own site with the api explorer
  82 * http://MYSITE.ORG/path/to/civicrm/api/explorer
  83 *
  84 * Read more about testing here
  85 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  86 *
  87 * API Standards documentation:
  88 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  89 */