--- /dev/null
+<?php
+/**
+ * Test Generated example demonstrating the Order.cancel API.
+ *
+ * @return array
+ * API result array
+ */
+function order_cancel_example() {
+ $params = array(
+ 'contribution_id' => 1,
+ );
+
+ try{
+ $result = civicrm_api3('Order', 'cancel', $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;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ * API result array
+ */
+function order_cancel_expectedresult() {
+
+ $expectedResult = array(
+ 'is_error' => 0,
+ 'version' => 3,
+ 'count' => 1,
+ 'id' => 1,
+ 'values' => array(
+ '1' => array(
+ 'id' => '1',
+ 'contact_id' => '14',
+ 'financial_type_id' => '1',
+ 'contribution_page_id' => '',
+ 'payment_instrument_id' => '4',
+ 'receive_date' => '2010-01-20 00:00:00',
+ 'non_deductible_amount' => '0.00',
+ 'total_amount' => '100.00',
+ 'fee_amount' => '0.00',
+ 'net_amount' => '100.00',
+ 'trxn_id' => '',
+ 'invoice_id' => '',
+ 'currency' => 'USD',
+ 'cancel_date' => '',
+ 'cancel_reason' => '',
+ 'receipt_date' => '',
+ 'thankyou_date' => '',
+ 'source' => '',
+ 'amount_level' => '',
+ 'contribution_recur_id' => '',
+ 'is_test' => 0,
+ 'is_pay_later' => 0,
+ 'contribution_status_id' => '3',
+ 'address_id' => '',
+ 'check_number' => '',
+ 'campaign_id' => '',
+ 'creditnote_id' => 'CN_1',
+ 'tax_amount' => '',
+ 'contribution_type_id' => '1',
+ ),
+ ),
+ );
+
+ return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testCancelOrder"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OrderTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* 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
+*/
--- /dev/null
+<?php
+/**
+ * Test Generated example demonstrating the Order.create API.
+ *
+ * @return array
+ * API result array
+ */
+function order_create_example() {
+ $params = array(
+ 'contact_id' => 7,
+ 'receive_date' => '2010-01-20',
+ 'total_amount' => 200,
+ 'financial_type_id' => 1,
+ 'contribution_status_id' => 1,
+ 'line_items' => array(
+ '0' => array(
+ 'line_item' => array(
+ '0' => array(
+ 'price_field_id' => '4',
+ 'price_field_value_id' => '5',
+ 'label' => 'Price Field 2',
+ 'field_title' => 'Price Field 2',
+ 'qty' => 1,
+ 'unit_price' => '200',
+ 'line_total' => '200',
+ 'financial_type_id' => '4',
+ 'entity_table' => 'civicrm_membership',
+ 'membership_type_id' => 1,
+ ),
+ ),
+ 'params' => array(
+ 'contact_id' => 7,
+ 'membership_type_id' => 2,
+ 'join_date' => '2006-01-21',
+ 'start_date' => '2006-01-21',
+ 'end_date' => '2006-12-21',
+ 'source' => 'Payment',
+ 'is_override' => 1,
+ 'status_id' => 1,
+ ),
+ ),
+ ),
+ );
+
+ try{
+ $result = civicrm_api3('Order', 'create', $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;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ * API result array
+ */
+function order_create_expectedresult() {
+
+ $expectedResult = array(
+ 'is_error' => 0,
+ 'version' => 3,
+ 'count' => 1,
+ 'id' => 1,
+ 'values' => array(
+ '1' => array(
+ 'id' => '1',
+ 'contact_id' => '7',
+ 'financial_type_id' => '1',
+ 'contribution_page_id' => '',
+ 'payment_instrument_id' => '4',
+ 'receive_date' => '20100120000000',
+ 'non_deductible_amount' => '',
+ 'total_amount' => '200',
+ 'fee_amount' => 0,
+ 'net_amount' => '200',
+ 'trxn_id' => '',
+ 'invoice_id' => '',
+ 'currency' => 'USD',
+ 'cancel_date' => '',
+ 'cancel_reason' => '',
+ 'receipt_date' => '',
+ 'thankyou_date' => '',
+ 'source' => '',
+ 'amount_level' => '',
+ 'contribution_recur_id' => '',
+ 'is_test' => '',
+ 'is_pay_later' => '',
+ 'contribution_status_id' => '1',
+ 'address_id' => '',
+ 'check_number' => '',
+ 'campaign_id' => '',
+ 'creditnote_id' => '',
+ 'tax_amount' => '',
+ 'contribution_type_id' => '1',
+ ),
+ ),
+ );
+
+ return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testAddOrderForMembership"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OrderTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* 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
+*/
--- /dev/null
+<?php
+/**
+ * Test Generated example demonstrating the Order.create API.
+ *
+ * Create order for participant
+ *
+ * @return array
+ * API result array
+ */
+function order_create_example() {
+ $params = array(
+ 'contact_id' => 10,
+ 'receive_date' => '2010-01-20',
+ 'total_amount' => 300,
+ 'financial_type_id' => 1,
+ 'contribution_status_id' => 1,
+ 'line_items' => array(
+ '0' => array(
+ 'line_item' => array(
+ '2' => array(
+ 'price_field_id' => '2',
+ 'price_field_value_id' => '2',
+ 'label' => 'Price Field 1',
+ 'field_title' => 'Price Field 1',
+ 'qty' => 1,
+ 'unit_price' => '100',
+ 'line_total' => '100',
+ 'financial_type_id' => '4',
+ 'entity_table' => 'civicrm_participant',
+ ),
+ '3' => array(
+ 'price_field_id' => '2',
+ 'price_field_value_id' => '3',
+ 'label' => 'Price Field 2',
+ 'field_title' => 'Price Field 2',
+ 'qty' => 1,
+ 'unit_price' => '200',
+ 'line_total' => '200',
+ 'financial_type_id' => '4',
+ 'entity_table' => 'civicrm_participant',
+ ),
+ ),
+ 'params' => array(
+ 'contact_id' => 10,
+ 'event_id' => 1,
+ 'status_id' => 1,
+ 'role_id' => 1,
+ 'register_date' => '2007-07-21 00:00:00',
+ 'source' => 'Online Event Registration: API Testing',
+ ),
+ ),
+ ),
+ );
+
+ try{
+ $result = civicrm_api3('Order', 'create', $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;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ * API result array
+ */
+function order_create_expectedresult() {
+
+ $expectedResult = array(
+ 'is_error' => 0,
+ 'version' => 3,
+ 'count' => 1,
+ 'id' => 1,
+ 'values' => array(
+ '1' => array(
+ 'id' => '1',
+ 'contact_id' => '10',
+ 'financial_type_id' => '1',
+ 'contribution_page_id' => '',
+ 'payment_instrument_id' => '4',
+ 'receive_date' => '20100120000000',
+ 'non_deductible_amount' => '',
+ 'total_amount' => '300',
+ 'fee_amount' => 0,
+ 'net_amount' => '300',
+ 'trxn_id' => '',
+ 'invoice_id' => '',
+ 'currency' => 'USD',
+ 'cancel_date' => '',
+ 'cancel_reason' => '',
+ 'receipt_date' => '',
+ 'thankyou_date' => '',
+ 'source' => '',
+ 'amount_level' => '',
+ 'contribution_recur_id' => '',
+ 'is_test' => '',
+ 'is_pay_later' => '',
+ 'contribution_status_id' => '1',
+ 'address_id' => '',
+ 'check_number' => '',
+ 'campaign_id' => '',
+ 'creditnote_id' => '',
+ 'tax_amount' => '',
+ 'contribution_type_id' => '1',
+ ),
+ ),
+ );
+
+ return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testAddOrderForPariticipant"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OrderTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* 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
+*/
--- /dev/null
+<?php
+/**
+ * Test Generated example demonstrating the Order.delete API.
+ *
+ * @return array
+ * API result array
+ */
+function order_delete_example() {
+ $params = array(
+ 'contribution_id' => 1,
+ );
+
+ try{
+ $result = civicrm_api3('Order', 'delete', $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;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ * API result array
+ */
+function order_delete_expectedresult() {
+
+ $expectedResult = array(
+ 'is_error' => 0,
+ 'version' => 3,
+ 'count' => 1,
+ 'id' => 1,
+ 'values' => array(
+ '1' => 1,
+ ),
+ );
+
+ return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testDeleteOrder"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OrderTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* 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
+*/
--- /dev/null
+<?php
+/**
+ * Test Generated example demonstrating the Order.get API.
+ *
+ * @return array
+ * API result array
+ */
+function order_get_example() {
+ $params = array(
+ 'contribution_id' => 1,
+ );
+
+ try{
+ $result = civicrm_api3('Order', '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;
+}
+
+/**
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ * API result array
+ */
+function order_get_expectedresult() {
+
+ $expectedResult = array(
+ 'is_error' => 0,
+ 'version' => 3,
+ 'count' => 1,
+ 'id' => 1,
+ 'values' => array(
+ '1' => array(
+ 'contact_id' => '3',
+ 'contact_type' => 'Individual',
+ 'contact_sub_type' => '',
+ 'sort_name' => 'Anderson, Anthony',
+ 'display_name' => 'Mr. Anthony Anderson II',
+ 'contribution_id' => '1',
+ 'currency' => 'USD',
+ 'receive_date' => '2010-01-20 00:00:00',
+ 'non_deductible_amount' => '0.00',
+ 'total_amount' => '100.00',
+ 'fee_amount' => '0.00',
+ 'net_amount' => '100.00',
+ 'trxn_id' => '',
+ 'invoice_id' => '',
+ 'cancel_date' => '',
+ 'cancel_reason' => '',
+ 'receipt_date' => '',
+ 'thankyou_date' => '',
+ 'contribution_source' => '',
+ 'amount_level' => '',
+ 'is_test' => 0,
+ 'is_pay_later' => 0,
+ 'contribution_status_id' => '1',
+ 'check_number' => '',
+ 'contribution_campaign_id' => '',
+ 'financial_type_id' => '1',
+ 'financial_type' => 'Donation',
+ 'product_id' => '',
+ 'product_name' => '',
+ 'sku' => '',
+ 'contribution_product_id' => '',
+ 'product_option' => '',
+ 'fulfilled_date' => '',
+ 'contribution_start_date' => '',
+ 'contribution_end_date' => '',
+ 'contribution_recur_id' => '',
+ 'financial_account_id' => '1',
+ 'accounting_code' => '4200',
+ 'campaign_id' => '',
+ 'contribution_campaign_title' => '',
+ 'contribution_note' => '',
+ 'contribution_batch' => '',
+ 'contribution_status' => 'Completed',
+ 'payment_instrument' => 'Check',
+ 'payment_instrument_id' => '4',
+ 'instrument_id' => '4',
+ 'contribution_check_number' => '',
+ 'id' => '1',
+ 'contribution_type_id' => '1',
+ 'line_items' => array(
+ '0' => array(
+ 'id' => '1',
+ 'entity_table' => 'civicrm_contribution',
+ 'entity_id' => '1',
+ 'contribution_id' => '1',
+ 'price_field_id' => '1',
+ 'label' => 'Contribution Amount',
+ 'qty' => '1.00',
+ 'unit_price' => '100.00',
+ 'line_total' => '100.00',
+ 'price_field_value_id' => '1',
+ 'financial_type_id' => '1',
+ 'deductible_amount' => '0.00',
+ ),
+ ),
+ ),
+ ),
+ );
+
+ return $expectedResult;
+}
+
+/*
+* This example has been generated from the API test suite.
+* The test that created it is called "testGetOrder"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OrderTest.php
+*
+* You can see the outcome of the API tests at
+* https://test.civicrm.org/job/CiviCRM-master-git/
+*
+* To Learn about the API read
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
+*
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api
+*
+* 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
+*/
'contribution_id' => $contribution['id'],
);
- $order = $this->callAPISuccess('Order', 'get', $params);
+ $order = $this->callAPIAndDocument('Order', 'get', $params, __FUNCTION__, __FILE__);
$this->assertEquals(1, $order['count']);
$expectedResult = array(
'status_id' => 1,
),
);
- $order = $this->callAPISuccess('order', 'create', $p);
+ $order = $this->callAPIAndDocument('order', 'create', $p, __FUNCTION__, __FILE__);
$params = array(
'contribution_id' => $order['id'],
);
'source' => 'Online Event Registration: API Testing',
),
);
- $order = $this->callAPISuccess('order', 'create', $p);
+ $order = $this->callAPIAndDocument('order', 'create', $p, __FUNCTION__, __FILE__, 'Create order for participant', 'CreateOrderParticipant');
$params = array(
'contribution_id' => $order['id'],
);
'contribution_id' => $order['id'],
'is_test' => TRUE,
));
- $this->callAPISuccess('order', 'delete', $params);
+ $this->callAPIAndDocument('order', 'delete', $params, __FUNCTION__, __FILE__);
$order = $this->callAPISuccess('order', 'get', $params);
$this->assertEquals(0, $order['count']);
}
$params = array(
'contribution_id' => $contribution['id'],
);
- $this->callAPISuccess('order', 'cancel', $params);
+ $this->callAPIAndDocument('order', 'cancel', $params, __FUNCTION__, __FILE__);
$order = $this->callAPISuccess('Order', 'get', $params);
$expectedResult = array(
$contribution['id'] => array(
projects / civicrm-core.git / commitdiff