<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
/**
* Test APIv3 civicrm_contribute_* functions
*
- * @package CiviCRM_APIv3
- * @subpackage API_Contribution
+ * @package CiviCRM_APIv3
+ * @subpackage API_Contribution
*/
-
class api_v3_ContributionTest extends CiviUnitTestCase {
/**
protected $_ids = array();
protected $_pageParams = array();
- function setUp() {
+ public function setUp() {
parent::setUp();
$this->_apiversion = 3;
'contact_id' => $this->_individualId,
'receive_date' => '20120511',
'total_amount' => 100.00,
- 'financial_type_id' => $this->_financialTypeId,
+ 'financial_type_id' => $this->_financialTypeId,
'non_deductible_amount' => 10.00,
'fee_amount' => 5.00,
'net_amount' => 95.00,
'is_allow_other_amount' => 1,
'min_amount' => 10,
'max_amount' => 1000,
- );
+ );
}
- function tearDown() {
+ public function tearDown() {
$this->quickCleanUpFinancialEntities();
}
- function testGetContribution() {
+ public function testGetContribution() {
$p = array(
'contact_id' => $this->_individualId,
'receive_date' => '2010-01-20',
$contribution = $this->callAPIAndDocument('contribution', 'get', $params, __FUNCTION__, __FILE__);
$financialParams['id'] = $this->_financialTypeId;
- $default = null;
+ $default = NULL;
CRM_Financial_BAO_FinancialType::retrieve($financialParams, $default);
$this->assertEquals(1, $contribution['count']);
'id' => $this->_contribution['id'],
'format.only_id' => 1,
));
- $this->assertEquals($this->_contribution['id'], $contribution, print_r($contribution,true) . " in line " . __LINE__);
+ $this->assertEquals($this->_contribution['id'], $contribution, print_r($contribution, TRUE) . " in line " . __LINE__);
//test id only format
$contribution = $this->callAPISuccess('contribution', 'get', array(
'id' => $contribution2['id'],
));
}
-/**
- * We need to ensure previous tested behaviour still works as part of the api contract
- */
- function testGetContributionLegacyBehaviour() {
+ /**
+ * We need to ensure previous tested behaviour still works as part of the api contract
+ */
+ public function testGetContributionLegacyBehaviour() {
$p = array(
'contact_id' => $this->_individualId,
'receive_date' => '2010-01-20',
);
$contribution = $this->callAPIAndDocument('contribution', 'get', $params, __FUNCTION__, __FILE__);
$financialParams['id'] = $this->_financialTypeId;
- $default = null;
+ $default = NULL;
CRM_Financial_BAO_FinancialType::retrieve($financialParams, $default);
- $this->assertEquals(1,$contribution['count']);
+ $this->assertEquals(1, $contribution['count']);
$this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
$this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], $this->_financialTypeId);
$this->assertEquals($contribution['values'][$contribution['id']]['contribution_type_id'], $this->_financialTypeId);
'id' => $this->_contribution['id'],
'format.only_id' => 1,
));
- $this->assertEquals($this->_contribution['id'], $contribution, print_r($contribution,true) . " in line " . __LINE__);
+ $this->assertEquals($this->_contribution['id'], $contribution, print_r($contribution, TRUE) . " in line " . __LINE__);
//test id only format
$contribution = $this->callAPISuccess('contribution', 'get', array(
'id' => $contribution2['id'],
$this->assertEquals(2, $contribution['count']);
$this->callAPISuccess('Contribution', 'Delete', array(
- 'id' => $this->_contribution['id'],
+ 'id' => $this->_contribution['id'],
));
$this->callAPISuccess('Contribution', 'Delete', array(
- 'id' => $contribution2['id'],
+ 'id' => $contribution2['id'],
));
}
+
///////////////// civicrm_contribution_
- function testCreateEmptyContributionIDUseDonation() {
+ public function testCreateEmptyContributionIDUseDonation() {
$params = array(
'contribution_id' => FALSE,
'contact_id' => 1,
'total_amount' => 1,
- 'check_permissions' => false,
+ 'check_permissions' => FALSE,
'financial_type_id' => 'Donation',
);
$this->callAPISuccess('contribution', 'create', $params);
- }
+ }
/*
* ensure we continue to support contribution_type_id as part of the api commitment to
* stability
*///////////////// civicrm_contribution_
- function testCreateLegacyBehaviour() {
+ public function testCreateLegacyBehaviour() {
$params = array(
'contribution_id' => FALSE,
'contact_id' => 1,
'total_amount' => 1,
- 'check_permissions' => false,
+ 'check_permissions' => FALSE,
'contribution_type_id' => 3,
);
$contribution = $this->callAPISuccess('contribution', 'create', $params);
- $contribution = $this->callAPISuccess('contribution', 'getsingle', array( 'id' => $contribution['id']));
+ $contribution = $this->callAPISuccess('contribution', 'getsingle', array('id' => $contribution['id']));
$this->assertEquals(3, $contribution['financial_type_id']);
}
/**
- * check with complete array + custom field
+ * Check with complete array + custom field
* Note that the test is written on purpose without any
* variables specific to participant so it can be replicated into other entities
* and / or moved to the automated test suite
*/
- function testCreateWithCustom() {
+ public function testCreateWithCustom() {
$ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
$params = $this->_params;
$params['custom_' . $ids['custom_field_id']] = "custom string";
- $result = $this->callAPIAndDocument($this->_entity, 'create', $params, __FUNCTION__, __FILE__);
+ $result = $this->callAPIAndDocument($this->_entity, 'create', $params, __FUNCTION__, __FILE__);
$this->assertEquals($result['id'], $result['values'][$result['id']]['id']);
$check = $this->callAPISuccess($this->_entity, 'get', array(
'return.custom_' . $ids['custom_field_id'] => 1,
}
/**
- * check with complete array + custom field
+ * Check with complete array + custom field
* Note that the test is written on purpose without any
* variables specific to participant so it can be replicated into other entities
* and / or moved to the automated test suite
*/
- function testCreateGetFieldsWithCustom() {
- $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
+ public function testCreateGetFieldsWithCustom() {
+ $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
$idsContact = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, 'ContactTest.php');
- $result = $this->callAPISuccess('Contribution', 'getfields', array());
+ $result = $this->callAPISuccess('Contribution', 'getfields', array());
$this->assertArrayHasKey('custom_' . $ids['custom_field_id'], $result['values']);
$this->assertArrayNotHasKey('custom_' . $idsContact['custom_field_id'], $result['values']);
$this->customFieldDelete($ids['custom_field_id']);
$this->customGroupDelete($idsContact['custom_group_id']);
}
- function testCreateContributionNoLineItems() {
+ public function testCreateContributionNoLineItems() {
$params = array(
'contact_id' => $this->_individualId,
'receive_date' => '20120511',
'total_amount' => 100.00,
- 'financial_type_id' => $this->_financialTypeId,
+ 'financial_type_id' => $this->_financialTypeId,
'payment_instrument_id' => 1,
'non_deductible_amount' => 10.00,
'fee_amount' => 50.00,
);
$contribution = $this->callAPISuccess('contribution', 'create', $params);
- $lineItems = $this->callAPISuccess('line_item','get',array(
+ $lineItems = $this->callAPISuccess('line_item', 'get', array(
'entity_id' => $contribution['id'],
'entity_table' => 'civicrm_contribution',
'sequential' => 1,
));
$this->assertEquals(0, $lineItems['count']);
}
+
/*
* Test checks that passing in line items suppresses the create mechanism
*/
- function testCreateContributionChainedLineItems() {
+ public function testCreateContributionChainedLineItems() {
$params = array(
'contact_id' => $this->_individualId,
$description = "Create Contribution with Nested Line Items";
$subfile = "CreateWithNestedLineItems";
- $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__,__FILE__, $description, $subfile);
+ $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
- $lineItems = $this->callAPISuccess('line_item','get',array(
+ $lineItems = $this->callAPISuccess('line_item', 'get', array(
'entity_id' => $contribution['id'],
'contribution_id' => $contribution['id'],
'entity_table' => 'civicrm_contribution',
$this->assertEquals(2, $lineItems['count']);
}
- function testCreateContributionOffline() {
+ public function testCreateContributionOffline() {
$params = array(
'contact_id' => $this->_individualId,
'receive_date' => '20120511',
$contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__);
$this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
$this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
- $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'],1 );
+ $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
$this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345);
$this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890);
$this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF');
$this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 1);
- $lineItems = $this->callAPISuccess('line_item','get',array(
+ $lineItems = $this->callAPISuccess('line_item', 'get', array(
'entity_id' => $contribution['id'],
'contribution_id' => $contribution['id'],
'entity_table' => 'civicrm_contribution',
'sequential' => 1,
- ));
+ ));
$this->assertEquals(1, $lineItems['count']);
$this->assertEquals($contribution['id'], $lineItems['values'][0]['entity_id']);
$this->assertEquals($contribution['id'], $lineItems['values'][0]['contribution_id']);
$this->_checkFinancialRecords($contribution, 'offline');
$this->contributionGetnCheck($params, $contribution['id']);
}
+
/**
- * test create with valid payment instument
+ * Test create with valid payment instument
*/
- function testCreateContributionWithPaymentInstrument() {
+ public function testCreateContributionWithPaymentInstrument() {
$params = $this->_params + array('payment_instrument' => 'EFT');
$contribution = $this->callAPISuccess('contribution', 'create', $params);
- $contribution = $this->callAPISuccess('contribution','get', array(
+ $contribution = $this->callAPISuccess('contribution', 'get', array(
'sequential' => 1,
- 'id' => $contribution['id']
+ 'id' => $contribution['id'],
));
$this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
$this->assertEquals('EFT', $contribution['values'][0]['payment_instrument']);
- $this->callAPISuccess('contribution', 'create', array('id' => $contribution['id'], 'payment_instrument' => 'Credit Card'));
- $contribution = $this->callAPISuccess('contribution','get', array(
+ $this->callAPISuccess('contribution', 'create', array(
+ 'id' => $contribution['id'],
+ 'payment_instrument' => 'Credit Card',
+ ));
+ $contribution = $this->callAPISuccess('contribution', 'get', array(
'sequential' => 1,
- 'id' => $contribution['id']
+ 'id' => $contribution['id'],
));
$this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
$this->assertEquals('Credit Card', $contribution['values'][0]['payment_instrument']);
}
- function testGetContributionByPaymentInstrument() {
+ public function testGetContributionByPaymentInstrument() {
$params = $this->_params + array('payment_instrument' => 'EFT');
$params2 = $this->_params + array('payment_instrument' => 'Cash');
- $this->callAPISuccess('contribution','create',$params);
- $this->callAPISuccess('contribution','create',$params2);
- $contribution = $this->callAPISuccess('contribution','get',array( 'sequential' => 1, 'contribution_payment_instrument_id' => 'Cash'));
+ $this->callAPISuccess('contribution', 'create', $params);
+ $this->callAPISuccess('contribution', 'create', $params2);
+ $contribution = $this->callAPISuccess('contribution', 'get', array(
+ 'sequential' => 1,
+ 'contribution_payment_instrument_id' => 'Cash',
+ ));
$this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
- $this->assertEquals('Cash',$contribution['values'][0]['payment_instrument']);
- $this->assertEquals(1,$contribution['count']);
- $contribution = $this->callAPISuccess('contribution','get',array('sequential' => 1, 'payment_instrument_id' => 'EFT'));
+ $this->assertEquals('Cash', $contribution['values'][0]['payment_instrument']);
+ $this->assertEquals(1, $contribution['count']);
+ $contribution = $this->callAPISuccess('contribution', 'get', array(
+ 'sequential' => 1,
+ 'payment_instrument_id' => 'EFT',
+ ));
$this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
- $this->assertEquals('EFT',$contribution['values'][0]['payment_instrument']);
+ $this->assertEquals('EFT', $contribution['values'][0]['payment_instrument']);
$this->assertEquals(1, $contribution['count']);
- $contribution = $this->callAPISuccess('contribution','get',array( 'sequential' => 1, 'payment_instrument_id' => 5));
+ $contribution = $this->callAPISuccess('contribution', 'get', array(
+ 'sequential' => 1,
+ 'payment_instrument_id' => 5,
+ ));
$this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
- $this->assertEquals('EFT',$contribution['values'][0]['payment_instrument']);
- $this->assertEquals(1,$contribution['count']);
- $contribution = $this->callAPISuccess('contribution','get',array( 'sequential' => 1, 'payment_instrument' => 'EFT'));
+ $this->assertEquals('EFT', $contribution['values'][0]['payment_instrument']);
+ $this->assertEquals(1, $contribution['count']);
+ $contribution = $this->callAPISuccess('contribution', 'get', array(
+ 'sequential' => 1,
+ 'payment_instrument' => 'EFT',
+ ));
$this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
$this->assertEquals('EFT', $contribution['values'][0]['payment_instrument']);
$this->assertEquals(1, $contribution['count']);
- $contribution = $this->callAPISuccess('contribution', 'create', array('id' => $contribution['id'], 'payment_instrument' => 'Credit Card'));
- $contribution = $this->callAPISuccess('contribution','get',array( 'sequential' => 1, 'id' => $contribution['id'], ));
+ $contribution = $this->callAPISuccess('contribution', 'create', array(
+ 'id' => $contribution['id'],
+ 'payment_instrument' => 'Credit Card',
+ ));
+ $contribution = $this->callAPISuccess('contribution', 'get', array('sequential' => 1, 'id' => $contribution['id']));
$this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
- $this->assertEquals('Credit Card',$contribution['values'][0]['payment_instrument']);
- $this->assertEquals(1,$contribution['count']);
+ $this->assertEquals('Credit Card', $contribution['values'][0]['payment_instrument']);
+ $this->assertEquals(1, $contribution['count']);
}
- /*
- * Create test with unique field name on source
- */
- function testCreateContributionSource() {
+ /**
+ * Create test with unique field name on source
+ */
+ public function testCreateContributionSource() {
$params = array(
'contact_id' => $this->_individualId,
/*
* Create test with unique field name on source
*/
- function testCreateDefaultNow() {
+ public function testCreateDefaultNow() {
$params = $this->_params;
unset($params['receive_date']);
$this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($contribution['receive_date'])));
}
- /*
- * Create test with unique field name on source
- */
- function testCreateContributionSourceInvalidContac() {
+ /**
+ * Create test with unique field name on source
+ */
+ public function testCreateContributionSourceInvalidContac() {
$params = array(
'contact_id' => 999,
$this->callAPIFailure('contribution', 'create', $params, 'contact_id is not valid : 999');
}
- function testCreateContributionSourceInvalidContContact() {
+ public function testCreateContributionSourceInvalidContContact() {
$params = array(
'contribution_contact_id' => 999,
}
/**
- * test note created correctly
+ * Test note created correctly
*/
- function testCreateContributionWithNote() {
+ public function testCreateContributionWithNote() {
$description = "Demonstrates creating contribution with Note Entity";
- $subfile = "ContributionCreateWithNote";
- $params = array(
+ $subfile = "ContributionCreateWithNote";
+ $params = array(
'contact_id' => $this->_individualId,
'receive_date' => '2012-01-01',
'total_amount' => 100.00,
);
$contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
- $result = $this->callAPISuccess('note', 'get', array('entity_table' => 'civicrm_contribution', 'entity_id' => $contribution['id'], 'sequential' => 1));
+ $result = $this->callAPISuccess('note', 'get', array(
+ 'entity_table' => 'civicrm_contribution',
+ 'entity_id' => $contribution['id'],
+ 'sequential' => 1,
+ ));
$this->assertEquals('my contribution note', $result['values'][0]['note']);
$this->callAPISuccess('contribution', 'delete', array('id' => $contribution['id']));
}
- function testCreateContributionWithNoteUniqueNameAliases() {
- $params = array(
+ public function testCreateContributionWithNoteUniqueNameAliases() {
+ $params = array(
'contact_id' => $this->_individualId,
'receive_date' => '2012-01-01',
'total_amount' => 100.00,
);
$contribution = $this->callAPISuccess('contribution', 'create', $params);
- $result = $this->callAPISuccess('note', 'get', array('entity_table' => 'civicrm_contribution', 'entity_id' => $contribution['id'], 'sequential' => 1));
+ $result = $this->callAPISuccess('note', 'get', array(
+ 'entity_table' => 'civicrm_contribution',
+ 'entity_id' => $contribution['id'],
+ 'sequential' => 1,
+ ));
$this->assertEquals('my contribution note', $result['values'][0]['note']);
$this->callAPISuccess('contribution', 'delete', array('id' => $contribution['id']));
}
- /*
- * This is the test for creating soft credits - however a 'get' is not yet possible via API
- * as the current BAO functions are contact-centric (from what I can find)
- *
- */
- function testCreateContributionWithSoftCredt() {
+
+ /**
+ * This is the test for creating soft credits - however a 'get' is not yet possible via API
+ * as the current BAO functions are contact-centric (from what I can find)
+ */
+ public function testCreateContributionWithSoftCredt() {
$description = "Demonstrates creating contribution with SoftCredit";
- $subfile = "ContributionCreateWithSoftCredit";
- $contact2 = $this->callAPISuccess('Contact', 'create', array('display_name' => 'superman', 'contact_type' => 'Individual'));
- $softparams = array(
+ $subfile = "ContributionCreateWithSoftCredit";
+ $contact2 = $this->callAPISuccess('Contact', 'create', array(
+ 'display_name' => 'superman',
+ 'contact_type' => 'Individual',
+ ));
+ $softparams = array(
'contact_id' => $contact2['id'],
'amount' => 50,
- 'soft_credit_type_id' => 3
+ 'soft_credit_type_id' => 3,
);
- $params = $this->_params + array('soft_credit' => array(1 => $softparams));
+ $params = $this->_params + array('soft_credit' => array(1 => $softparams));
$contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
- $result = $this->callAPISuccess('contribution','get', array('return'=> 'soft_credit', 'sequential' => 1));
+ $result = $this->callAPISuccess('contribution', 'get', array('return' => 'soft_credit', 'sequential' => 1));
$this->assertEquals($softparams['contact_id'], $result['values'][0]['soft_credit'][1]['contact_id']);
$this->assertEquals($softparams['amount'], $result['values'][0]['soft_credit'][1]['amount']);
$this->callAPISuccess('contact', 'delete', array('id' => $contact2['id']));
}
- function testCreateContributionWithSoftCreditDefaults() {
+ public function testCreateContributionWithSoftCreditDefaults() {
$description = "Demonstrates creating contribution with Soft Credit defaults for amount and type";
- $subfile = "ContributionCreateWithSoftCreditDefaults";
- $contact2 = $this->callAPISuccess('Contact', 'create', array('display_name' => 'superman', 'contact_type' => 'Individual'));
+ $subfile = "ContributionCreateWithSoftCreditDefaults";
+ $contact2 = $this->callAPISuccess('Contact', 'create', array(
+ 'display_name' => 'superman',
+ 'contact_type' => 'Individual',
+ ));
$params = $this->_params + array(
- 'soft_credit_to' => $contact2['id'],
- );
+ 'soft_credit_to' => $contact2['id'],
+ );
$contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
- $result = $this->callAPISuccess('contribution','get', array('return'=> 'soft_credit', 'sequential' => 1));
+ $result = $this->callAPISuccess('contribution', 'get', array('return' => 'soft_credit', 'sequential' => 1));
$this->assertEquals($contact2['id'], $result['values'][0]['soft_credit'][1]['contact_id']);
// Default soft credit amount = contribution.total_amount
$this->callAPISuccess('contact', 'delete', array('id' => $contact2['id']));
}
- function testCreateContributionWithHonoreeContact() {
+ public function testCreateContributionWithHonoreeContact() {
$description = "Demonstrates creating contribution with Soft Credit by passing in honor_contact_id";
- $subfile = "ContributionCreateWithHonoreeContact";
- $contact2 = $this->callAPISuccess('Contact', 'create', array('display_name' => 'superman', 'contact_type' => 'Individual'));
+ $subfile = "ContributionCreateWithHonoreeContact";
+ $contact2 = $this->callAPISuccess('Contact', 'create', array(
+ 'display_name' => 'superman',
+ 'contact_type' => 'Individual',
+ ));
$params = $this->_params + array(
- 'honor_contact_id' => $contact2['id'],
- );
+ 'honor_contact_id' => $contact2['id'],
+ );
$contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
- $result = $this->callAPISuccess('contribution','get', array('return'=> 'soft_credit', 'sequential' => 1));
+ $result = $this->callAPISuccess('contribution', 'get', array('return' => 'soft_credit', 'sequential' => 1));
$this->assertEquals($contact2['id'], $result['values'][0]['soft_credit'][1]['contact_id']);
// Default soft credit amount = contribution.total_amount
/**
* Test using example code
*/
- function testContributionCreateExample() {
+ public function testContributionCreateExample() {
//make sure at least on page exists since there is a truncate in tear down
$page = $this->callAPISuccess('contribution_page', 'create', $this->_pageParams);
$this->assertAPISuccess($page);
require_once 'api/v3/examples/Contribution/Create.php';
- $result = contribution_create_example();
+ $result = contribution_create_example();
$this->assertAPISuccess($result);
$contributionId = $result['id'];
$expectedResult = contribution_create_expectedresult();
/*
* Function tests that additional financial records are created when fee amount is recorded
*/
- function testCreateContributionWithFee() {
+ public function testCreateContributionWithFee() {
$params = array(
'contact_id' => $this->_individualId,
'receive_date' => '20120511',
$this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
$this->assertEquals($contribution['values'][$contribution['id']]['fee_amount'], 50.00);
$this->assertEquals($contribution['values'][$contribution['id']]['net_amount'], 50.00);
- $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'],1 );
+ $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
$this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345);
$this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890);
$this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF');
$this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 1);
- $lineItems = $this->callAPISuccess('line_item','get',array(
+ $lineItems = $this->callAPISuccess('line_item', 'get', array(
'entity_id' => $contribution['id'],
'entity_table' => 'civicrm_contribution',
'sequential' => 1,
- ));
+ ));
$this->assertEquals(1, $lineItems['count']);
$this->assertEquals($contribution['id'], $lineItems['values'][0]['entity_id']);
$this->assertEquals($contribution['id'], $lineItems['values'][0]['contribution_id']);
- $lineItems = $this->callAPISuccess('line_item','get',array(
+ $lineItems = $this->callAPISuccess('line_item', 'get', array(
- 'entity_id' => $contribution['id'],
- 'contribution_id' => $contribution['id'],
- 'entity_table' => 'civicrm_contribution',
- 'sequential' => 1,
+ 'entity_id' => $contribution['id'],
+ 'contribution_id' => $contribution['id'],
+ 'entity_table' => 'civicrm_contribution',
+ 'sequential' => 1,
));
$this->assertEquals(1, $lineItems['count']);
$this->_checkFinancialRecords($contribution, 'feeAmount');
/**
* Function tests that additional financial records are created when online contribution is created
*/
- function testCreateContributionOnline() {
+ public function testCreateContributionOnline() {
CRM_Financial_BAO_PaymentProcessor::create($this->_processorParams);
- $contributionPage = $this->callAPISuccess( 'contribution_page','create', $this->_pageParams );
+ $contributionPage = $this->callAPISuccess('contribution_page', 'create', $this->_pageParams);
$this->assertAPISuccess($contributionPage);
$params = array(
'contact_id' => $this->_individualId,
$contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__);
$this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
$this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
- $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'],1 );
+ $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
$this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345);
$this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890);
$this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF');
}
/**
- * in the interests of removing financial type / contribution type checks from
+ * In the interests of removing financial type / contribution type checks from
* legacy format function lets test that the api is doing this for us
*/
- function testCreateInvalidFinancialType() {
+ public function testCreateInvalidFinancialType() {
$params = $this->_params;
$params['financial_type_id'] = 99999;
$this->callAPIFailure($this->_entity, 'create', $params, "'99999' is not a valid option for field financial_type_id");
}
/**
- * in the interests of removing financial type / contribution type checks from
+ * In the interests of removing financial type / contribution type checks from
* legacy format function lets test that the api is doing this for us
*/
- function testValidNamedFinancialType() {
+ public function testValidNamedFinancialType() {
$params = $this->_params;
$params['financial_type_id'] = 'Donation';
$this->callAPISuccess($this->_entity, 'create', $params);
* Function tests that additional financial records are created when online contribution with pay later option
* is created
*/
- function testCreateContributionPayLaterOnline() {
+ public function testCreateContributionPayLaterOnline() {
CRM_Financial_BAO_PaymentProcessor::create($this->_processorParams);
$this->_pageParams['is_pay_later'] = 1;
- $contributionPage = $this->callAPISuccess( 'contribution_page','create',$this->_pageParams );
+ $contributionPage = $this->callAPISuccess('contribution_page', 'create', $this->_pageParams);
$this->assertAPISuccess($contributionPage);
$params = array(
'contact_id' => $this->_individualId,
$contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__);
$this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
$this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
- $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'],1 );
+ $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
$this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345);
$this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890);
$this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF');
* Function tests that additional financial records are created when online contribution with pending option
* is created
*/
- function testCreateContributionPendingOnline() {
+ public function testCreateContributionPendingOnline() {
$paymentProcessor = CRM_Financial_BAO_PaymentProcessor::create($this->_processorParams);
- $contributionPage = $this->callAPISuccess( 'contribution_page', 'create', $this->_pageParams );
+ $contributionPage = $this->callAPISuccess('contribution_page', 'create', $this->_pageParams);
$this->assertAPISuccess($contributionPage);
$params = array(
'contact_id' => $this->_individualId,
$contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__);
$this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
$this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
- $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'],1 );
+ $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
$this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345);
$this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890);
$this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF');
$this->_checkFinancialRecords($contribution, 'pending');
}
+ /**
+ * Test that BAO defaults work
+ */
+ public function testCreateBAODefaults() {
+ unset($this->_params['contribution_source_id'], $this->_params['payment_instrument_id']);
+ $contribution = $this->callAPISuccess('contribution', 'create', $this->_params);
+ $contribution = $this->callAPISuccess('contribution', 'getsingle', array(
+ 'id' => $contribution['id'],
+ 'api.contribution.delete' => 1,
+ ));
+ $this->assertEquals(1, $contribution['contribution_status_id']);
+ $this->assertEquals('Check', $contribution['payment_instrument']);
+ }
+
/*
* Function tests that line items, financial records are updated when contribution amount is changed
*/
- function testCreateUpdateContributionChangeTotal() {
+ public function testCreateUpdateContributionChangeTotal() {
$contribution = $this->callAPISuccess('contribution', 'create', $this->_params);
- $lineItems = $this->callAPISuccess('line_item','getvalue', array(
+ $lineItems = $this->callAPISuccess('line_item', 'getvalue', array(
'entity_id' => $contribution['id'],
'entity_table' => 'civicrm_contribution',
$newParams = array(
'id' => $contribution['id'],
- 'total_amount' => '125');
+ 'total_amount' => '125',
+ );
$contribution = $this->callAPISuccess('contribution', 'create', $newParams);
- $lineItems = $this->callAPISuccess('line_item','getvalue',array(
+ $lineItems = $this->callAPISuccess('line_item', 'getvalue', array(
- 'entity_id' => $contribution['id'],
- 'entity_table' => 'civicrm_contribution',
- 'sequential' => 1,
- 'return' => 'line_total',
+ 'entity_id' => $contribution['id'],
+ 'entity_table' => 'civicrm_contribution',
+ 'sequential' => 1,
+ 'return' => 'line_total',
));
$this->assertEquals('125.00', $lineItems);
/*
* Function tests that line items, financial records are updated when pay later contribution is received
*/
- function testCreateUpdateContributionPayLater() {
+ public function testCreateUpdateContributionPayLater() {
$contribParams = array(
'contact_id' => $this->_individualId,
'receive_date' => '2012-01-01',
$contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
$newParams = array_merge($contribParams, array(
- 'id' => $contribution['id'],
- 'contribution_status_id' => 1,)
+ 'id' => $contribution['id'],
+ 'contribution_status_id' => 1,
+ )
);
$contribution = $this->callAPISuccess('contribution', 'create', $newParams);
$contribution = $contribution['values'][$contribution['id']];
- $this->assertEquals($contribution['contribution_status_id'],'1');
+ $this->assertEquals($contribution['contribution_status_id'], '1');
$this->_checkFinancialItem($contribution['id'], 'paylater');
$this->_checkFinancialTrxn($contribution, 'payLater');
}
/*
* Function tests that financial records are updated when Payment Instrument is changed
*/
- function testCreateUpdateContributionPaymentInstrument() {
+ public function testCreateUpdateContributionPaymentInstrument() {
$instrumentId = $this->_addPaymentInstrument();
$contribParams = array(
'contact_id' => $this->_individualId,
$contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
$newParams = array_merge($contribParams, array(
- 'id' => $contribution['id'],
- 'payment_instrument_id' => $instrumentId,)
+ 'id' => $contribution['id'],
+ 'payment_instrument_id' => $instrumentId,
+ )
);
$contribution = $this->callAPISuccess('contribution', 'create', $newParams);
$this->assertAPISuccess($contribution);
/*
* Function tests that financial records are added when Contribution is Refunded
*/
- function testCreateUpdateContributionRefund() {
+ public function testCreateUpdateContributionRefund() {
$contribParams = array(
'contact_id' => $this->_individualId,
'receive_date' => '2012-01-01',
);
$contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
$newParams = array_merge($contribParams, array(
- 'id' => $contribution['id'],
- 'contribution_status_id' => 7,
+ 'id' => $contribution['id'],
+ 'contribution_status_id' => 7,
)
);
/*
* Function tests invalid contribution status change
*/
- function testCreateUpdateContributionInValidStatusChange() {
+ public function testCreateUpdateContributionInValidStatusChange() {
$contribParams = array(
'contact_id' => 1,
'receive_date' => '2012-01-01',
);
$contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
$newParams = array_merge($contribParams, array(
- 'id' => $contribution['id'],
- 'contribution_status_id' => 2,
+ 'id' => $contribution['id'],
+ 'contribution_status_id' => 2,
)
);
- $this->callAPIFailure('contribution', 'create', $newParams,ts('Cannot change contribution status from Completed to Pending.'));
+ $this->callAPIFailure('contribution', 'create', $newParams, ts('Cannot change contribution status from Completed to Pending.'));
}
/*
* Function tests that financial records are added when Pending Contribution is Canceled
*/
- function testCreateUpdateContributionCancelPending() {
+ public function testCreateUpdateContributionCancelPending() {
$contribParams = array(
'contact_id' => $this->_individualId,
'receive_date' => '2012-01-01',
);
$contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
$newParams = array_merge($contribParams, array(
- 'id' => $contribution['id'],
- 'contribution_status_id' => 3,
+ 'id' => $contribution['id'],
+ 'contribution_status_id' => 3,
)
);
$contribution = $this->callAPISuccess('contribution', 'create', $newParams);
/*
* Function tests that financial records are added when Financial Type is Changed
*/
- function testCreateUpdateContributionChangeFinancialType() {
+ public function testCreateUpdateContributionChangeFinancialType() {
$contribParams = array(
'contact_id' => $this->_individualId,
'receive_date' => '2012-01-01',
);
$contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
$newParams = array_merge($contribParams, array(
- 'id' => $contribution['id'],
- 'financial_type_id' => 3,
+ 'id' => $contribution['id'],
+ 'financial_type_id' => 3,
)
);
$contribution = $this->callAPISuccess('contribution', 'create', $newParams);
}
/**
- * test that update does not change status id CRM-15105
+ * Test that update does not change status id CRM-15105
*/
- function testCreateUpdateWithoutChangingPendingStatus() {
+ public function testCreateUpdateWithoutChangingPendingStatus() {
$contribution = $this->callAPISuccess('contribution', 'create', array_merge($this->_params, array('contribution_status_id' => 2)));
$this->callAPISuccess('contribution', 'create', array('id' => $contribution['id'], 'source' => 'new source'));
- $contribution = $this->callAPISuccess('contribution', 'getsingle', array('id' => $contribution['id'], 'api.contribution.delete' => 1));
+ $contribution = $this->callAPISuccess('contribution', 'getsingle', array(
+ 'id' => $contribution['id'],
+ 'api.contribution.delete' => 1,
+ ));
$this->assertEquals(2, $contribution['contribution_status_id']);
}
//To Update Contribution
//CHANGE: we require the API to do an incremental update
- function testCreateUpdateContribution() {
+ public function testCreateUpdateContribution() {
$contributionID = $this->contributionCreate($this->_individualId, $this->_financialTypeId, 'idofsh', 212355);
$old_params = array(
$this->assertEquals($contribution['values'][$contributionID]['contact_id'], $this->_individualId);
$this->assertEquals($contribution['values'][$contributionID]['total_amount'], 110.00);
- $this->assertEquals($contribution['values'][$contributionID]['financial_type_id'],$this->_financialTypeId );
+ $this->assertEquals($contribution['values'][$contributionID]['financial_type_id'], $this->_financialTypeId);
$this->assertEquals($contribution['values'][$contributionID]['instrument_id'], $old_payment_instrument);
$this->assertEquals($contribution['values'][$contributionID]['non_deductible_amount'], 10.00);
$this->assertEquals($contribution['values'][$contributionID]['fee_amount'], $old_fee_amount);
}
///////////////// civicrm_contribution_delete methods
- function testDeleteEmptyParamsContribution() {
+ public function testDeleteEmptyParamsContribution() {
$params = array();
$this->callAPIFailure('contribution', 'delete', $params);
}
- function testDeleteParamsNotArrayContribution() {
+ public function testDeleteParamsNotArrayContribution() {
$params = 'contribution_id= 1';
$contribution = $this->callAPIFailure('contribution', 'delete', $params);
$this->assertEquals($contribution['error_message'], 'Input variable `params` is not an array');
}
- function testDeleteWrongParamContribution() {
+ public function testDeleteWrongParamContribution() {
$params = array(
'contribution_source' => 'SSF',
$this->callAPIFailure('contribution', 'delete', $params);
}
- function testDeleteContribution() {
+ public function testDeleteContribution() {
$contributionID = $this->contributionCreate($this->_individualId, $this->_financialTypeId, 'dfsdf', 12389);
$params = array(
* Test civicrm_contribution_search with empty params.
* All available contributions expected.
*/
- function testSearchEmptyParams() {
+ public function testSearchEmptyParams() {
$params = array();
$p = array(
$this->assertEquals($p['contact_id'], $res['contact_id']);
$this->assertEquals($p['total_amount'], $res['total_amount']);
- $this->assertEquals($p['financial_type_id'], $res['financial_type_id'] );
+ $this->assertEquals($p['financial_type_id'], $res['financial_type_id']);
$this->assertEquals($p['net_amount'], $res['net_amount']);
$this->assertEquals($p['non_deductible_amount'], $res['non_deductible_amount']);
$this->assertEquals($p['fee_amount'], $res['fee_amount']);
/**
* Test civicrm_contribution_search. Success expected.
*/
- function testSearch() {
+ public function testSearch() {
$p1 = array(
'contact_id' => $this->_individualId,
'receive_date' => date('Ymd'),
$this->assertEquals($p2['contact_id'], $res['contact_id']);
$this->assertEquals($p2['total_amount'], $res['total_amount']);
- $this->assertEquals($p2['financial_type_id'], $res['financial_type_id'] );
+ $this->assertEquals($p2['financial_type_id'], $res['financial_type_id']);
$this->assertEquals($p2['net_amount'], $res['net_amount']);
$this->assertEquals($p2['non_deductible_amount'], $res['non_deductible_amount']);
$this->assertEquals($p2['fee_amount'], $res['fee_amount']);
* Note that we are creating a logged in user because email goes out from
* that person
*/
- function testCompleteTransaction() {
- $mut = new CiviMailUtils( $this, true );
+ public function testCompleteTransaction() {
+ $mut = new CiviMailUtils($this, TRUE);
$this->createLoggedInUser();
- $params = array_merge($this->_params, array('contribution_status_id' => 2,));
- $contribution = $this->callAPISuccess('contribution','create', $params);
+ $params = array_merge($this->_params, array('contribution_status_id' => 2));
+ $contribution = $this->callAPISuccess('contribution', 'create', $params);
$this->callAPISuccess('contribution', 'completetransaction', array(
'id' => $contribution['id'],
));
- $contribution = $this->callAPISuccess('contribution', 'get', array('id' => $contribution['id'], 'sequential' => 1,));
+ $contribution = $this->callAPISuccess('contribution', 'get', array('id' => $contribution['id'], 'sequential' => 1));
$this->assertEquals('Completed', $contribution['values'][0]['contribution_status']);
$mut->checkMailLog(array(
'Receipt - Contribution',
*
* tests.
*/
- function testCompleteTransactionWithReceiptDateSet() {
- $mut = new CiviMailUtils( $this, true );
+ public function testCompleteTransactionWithReceiptDateSet() {
+ $mut = new CiviMailUtils($this, TRUE);
$this->createLoggedInUser();
- $params = array_merge($this->_params, array('contribution_status_id' => 2,'receipt_date' => 'now'));
- $contribution = $this->callAPISuccess('contribution','create', $params);
- $this->callAPISuccess('contribution', 'completetransaction', array('id' => $contribution['id'],));
- $contribution = $this->callAPISuccess('contribution', 'get', array('id' => $contribution['id'], 'sequential' => 1,));
+ $params = array_merge($this->_params, array('contribution_status_id' => 2, 'receipt_date' => 'now'));
+ $contribution = $this->callAPISuccess('contribution', 'create', $params);
+ $this->callAPISuccess('contribution', 'completetransaction', array('id' => $contribution['id']));
+ $contribution = $this->callAPISuccess('contribution', 'get', array('id' => $contribution['id'], 'sequential' => 1));
$this->assertEquals('Completed', $contribution['values'][0]['contribution_status']);
$mut->checkMailLog(array(
'Receipt - Contribution',
* Note that we are creating a logged in user because email goes out from
* that person
*/
- function testCompleteTransactionWithParticipantRecord() {
- $mut = new CiviMailUtils( $this, true );
+ public function testCompleteTransactionWithParticipantRecord() {
+ $mut = new CiviMailUtils($this, TRUE);
$mut->clearMessages();
$this->createLoggedInUser();
$contributionID = $this->createPendingParticipantContribution();
$this->callAPISuccess('contribution', 'completetransaction', array(
- 'id' => $contributionID,)
+ 'id' => $contributionID,
+ )
);
- $participantStatus = $this->callAPISuccessGetValue('participant', array('id' => $this->_ids['participant'], 'return' => 'participant_status_id'));
+ $participantStatus = $this->callAPISuccessGetValue('participant', array(
+ 'id' => $this->_ids['participant'],
+ 'return' => 'participant_status_id',
+ ));
$this->assertEquals(1, $participantStatus);
$mut->checkMailLog(array(
'Annual CiviCRM meet',
}
/**
- * test membership is renewed when transaction completed
+ * Test membership is renewed when transaction completed
*/
- function testCompleteTransactionMembershipPriceSet() {
+ public function testCompleteTransactionMembershipPriceSet() {
$this->createPriceSetWithPage('membership');
$this->setUpPendingContribution($this->_ids['price_field_value'][0]);
- $this->callAPISuccess('contribution', 'completetransaction', array('id' => $this->_ids['contribution']));
+ $this->callAPISuccess('contribution', 'completetransaction', array('id' => $this->_ids['contribution']));
$membership = $this->callAPISuccess('membership', 'getsingle', array('id' => $this->_ids['membership']));
$this->assertEquals(date('Y-m-d', strtotime('yesterday + 1 year')), $membership['end_date']);
$this->cleanUpAfterPriceSets();
}
/**
- * test membership is renewed when transaction completed
+ * Test membership is renewed when transaction completed
*/
- function testCompleteTransactionMembershipPriceSetTwoTerms() {
+ public function testCompleteTransactionMembershipPriceSetTwoTerms() {
$this->createPriceSetWithPage('membership');
$this->setUpPendingContribution($this->_ids['price_field_value'][1]);
- $this->callAPISuccess('contribution', 'completetransaction', array('id' => $this->_ids['contribution']));
+ $this->callAPISuccess('contribution', 'completetransaction', array('id' => $this->_ids['contribution']));
$membership = $this->callAPISuccess('membership', 'getsingle', array('id' => $this->_ids['membership']));
$this->assertEquals(date('Y-m-d', strtotime('yesterday + 2 years')), $membership['end_date']);
$this->cleanUpAfterPriceSets();
}
- function cleanUpAfterPriceSets() {
+ public function cleanUpAfterPriceSets() {
$this->quickCleanUpFinancialEntities();
$this->contactDelete($this->_ids['contact']);
$this->callAPISuccess('price_set', 'delete', array('id' => $this->_ids['price_set']));
/**
- * this could be merged with 4.5 function setup in api_v3_ContributionPageTest::setUpContributionPage
+ * This could be merged with 4.5 function setup in api_v3_ContributionPageTest::setUpContributionPage
* on parent class at some point (fn is not in 4.4)
* @param $entity
* @param array $params
*/
- function createPriceSetWithPage($entity, $params = array()) {
+ public function createPriceSetWithPage($entity, $params = array()) {
$membershipTypeID = $this->membershipTypeCreate();
$contributionPageResult = $this->callAPISuccess('contribution_page', 'create', array(
'title' => "Test Contribution Page",
'is_quick_config' => 0,
'extends' => 'CiviMember',
'financial_type_id' => 1,
- 'title' => 'my Page'
+ 'title' => 'my Page',
));
$priceSetID = $priceSet['id'];
- CRM_Price_BAO_PriceSet::addTo('civicrm_contribution_page', $contributionPageResult['id'], $priceSetID );
+ CRM_Price_BAO_PriceSet::addTo('civicrm_contribution_page', $contributionPageResult['id'], $priceSetID);
$priceField = $this->callAPISuccess('price_field', 'create', array(
- 'price_set_id' => $priceSetID ,
+ 'price_set_id' => $priceSetID,
'label' => 'Goat Breed',
'html_type' => 'Radio',
));
$priceFieldValue = $this->callAPISuccess('price_field_value', 'create', array(
- 'price_set_id' => $priceSetID ,
+ 'price_set_id' => $priceSetID,
'price_field_id' => $priceField['id'],
'label' => 'Long Haired Goat',
'amount' => 20,
);
$this->_ids['price_field_value'] = array($priceFieldValue['id']);
$priceFieldValue = $this->callAPISuccess('price_field_value', 'create', array(
- 'price_set_id' => $priceSetID ,
+ 'price_set_id' => $priceSetID,
'price_field_id' => $priceField['id'],
'label' => 'Shoe-eating Goat',
'amount' => 10,
/**
* Set up a pending transaction with a specific price field id
- * @param $priceFieldValueID
+ * @param int $priceFieldValueID
*/
- function setUpPendingContribution($priceFieldValueID){
+ public function setUpPendingContribution($priceFieldValueID) {
$contactID = $this->individualCreate();
$membership = $this->callAPISuccess('membership', 'create', array(
'contact_id' => $contactID,
/**
* Test sending a mail via the API
*/
- function testSendMail() {
- $mut = new CiviMailUtils( $this, true );
- $contribution = $this->callAPISuccess('contribution','create',$this->_params);
+ public function testSendMail() {
+ $mut = new CiviMailUtils($this, TRUE);
+ $contribution = $this->callAPISuccess('contribution', 'create', $this->_params);
$this->callAPISuccess('contribution', 'sendconfirmation', array(
- 'id' => $contribution['id'],
- 'receipt_from_email' => 'api@civicrm.org',
+ 'id' => $contribution['id'],
+ 'receipt_from_email' => 'api@civicrm.org',
)
);
$mut->checkMailLog(array(
'Contribution Information',
'Please print this confirmation for your records',
), array(
- 'Event'
+ 'Event',
)
);
$mut->stop();
/**
* Test sending a mail via the API
*/
- function testSendMailEvent() {
- $mut = new CiviMailUtils( $this, true );
- $contribution = $this->callAPISuccess('contribution','create',$this->_params);
+ public function testSendMailEvent() {
+ $mut = new CiviMailUtils($this, TRUE);
+ $contribution = $this->callAPISuccess('contribution', 'create', $this->_params);
$event = $this->eventCreate(array(
'is_email_confirm' => 1,
'confirm_from_email' => 'test@civicrm.org',
'contribution_id' => $contribution['id'],
));
$this->callAPISuccess('contribution', 'sendconfirmation', array(
- 'id' => $contribution['id'],
- 'receipt_from_email' => 'api@civicrm.org',
+ 'id' => $contribution['id'],
+ 'receipt_from_email' => 'api@civicrm.org',
)
);
'Annual CiviCRM meet',
'Event',
'To: "Mr. Anthony Anderson II" <anthony_anderson@civicrm.org>',
- ), array(
-
- )
+ ), array()
);
$mut->stop();
}
/**
- * This function does a GET & compares the result against the $params
- * Use as a double check on Creates
- */
- function contributionGetnCheck($params, $id, $delete = 1) {
+ * This function does a GET & compares the result against the $params
+ * Use as a double check on Creates
+ */
+ public function contributionGetnCheck($params, $id, $delete = 1) {
$contribution = $this->callAPISuccess('Contribution', 'Get', array(
'id' => $id,
- ));
+ ));
if ($delete) {
$this->callAPISuccess('contribution', 'delete', array('id' => $id));
* Create a pending contribution & linked pending participant record
* (along with an event)
*/
- function createPendingParticipantContribution(){
- $event = $this->eventCreate(array('is_email_confirm' => 1, 'confirm_from_email' => 'test@civicrm.org',));
+ public function createPendingParticipantContribution() {
+ $event = $this->eventCreate(array('is_email_confirm' => 1, 'confirm_from_email' => 'test@civicrm.org'));
$participantID = $this->participantCreate(array('event_id' => $event['id'], 'status_id' => 6));
- $this->_ids['participant'] = $participantID;
+ $this->_ids['participant'] = $participantID;
$params = array_merge($this->_params, array('contribution_status_id' => 2, 'financial_type_id' => 'Event Fee'));
- $contribution = $this->callAPISuccess('contribution','create', $params);
- $this->callAPISuccess('participant_payment', 'create', array('contribution_id' => $contribution['id'], 'participant_id' => $participantID));
+ $contribution = $this->callAPISuccess('contribution', 'create', $params);
+ $this->callAPISuccess('participant_payment', 'create', array(
+ 'contribution_id' => $contribution['id'],
+ 'participant_id' => $participantID,
+ ));
$this->callAPISuccess('line_item', 'get', array(
'entity_id' => $contribution['id'],
'entity_table' => 'civicrm_contribution',
}
/**
- * @param $contId
+ * @param int $contId
*
* @return null|string
- */function _getFinancialTrxnAmount($contId) {
- $query = "SELECT
+ */
+ function _getFinancialTrxnAmount($contId) {
+ $query = "SELECT
SUM( ft.total_amount ) AS total
FROM civicrm_financial_trxn AS ft
LEFT JOIN civicrm_entity_financial_trxn AS ceft ON ft.id = ceft.financial_trxn_id
WHERE ceft.entity_table = 'civicrm_contribution'
AND ceft.entity_id = {$contId}";
- $result = CRM_Core_DAO::singleValueQuery($query);
- return $result;
- }
+ $result = CRM_Core_DAO::singleValueQuery($query);
+ return $result;
+ }
/**
- * @param $contId
+ * @param int $contId
*
* @return null|string
- */function _getFinancialItemAmount($contId) {
- $lineItem = key(CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution'));
- $query = "SELECT
+ */
+ function _getFinancialItemAmount($contId) {
+ $lineItem = key(CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution'));
+ $query = "SELECT
SUM(amount)
FROM civicrm_financial_item
WHERE entity_table = 'civicrm_line_item'
AND entity_id = {$lineItem}";
- $result = CRM_Core_DAO::singleValueQuery($query);
- return $result;
- }
+ $result = CRM_Core_DAO::singleValueQuery($query);
+ return $result;
+ }
/**
- * @param $contId
+ * @param int $contId
* @param $context
*/
- function _checkFinancialItem($contId, $context) {
- if ($context != 'paylater') {
- $params = array (
- 'entity_id' => $contId,
- 'entity_table' => 'civicrm_contribution',
- );
- $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($params, TRUE));
- $entityParams = array(
+ public function _checkFinancialItem($contId, $context) {
+ if ($context != 'paylater') {
+ $params = array(
+ 'entity_id' => $contId,
+ 'entity_table' => 'civicrm_contribution',
+ );
+ $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($params, TRUE));
+ $entityParams = array(
'financial_trxn_id' => $trxn['financial_trxn_id'],
'entity_table' => 'civicrm_financial_item',
- );
- $entityTrxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
- $params = array(
+ );
+ $entityTrxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
+ $params = array(
'id' => $entityTrxn['entity_id'],
- );
- }
- if ($context == 'paylater') {
- $lineItems = CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution');
- foreach ($lineItems as $key=>$item) {
- $params = array(
- 'entity_id' => $key,
- 'entity_table' => 'civicrm_line_item',
- );
- $compareParams = array ('status_id' => 1);
- $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
- }
- }
- elseif ($context == 'refund') {
- $compareParams = array(
- 'status_id' => 1,
- 'financial_account_id' => 1,
- 'amount' => -100,
- );
- }
- elseif ($context == 'cancelPending') {
- $compareParams = array(
- 'status_id' => 3,
- 'financial_account_id' => 1,
- 'amount' => -100,
- );
- }
- elseif ($context == 'changeFinancial') {
- $lineKey = key(CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution'));
- $params = array(
- 'entity_id' => $lineKey,
- 'amount' => -100,
- );
- $compareParams = array(
- 'financial_account_id' => 1,
- );
- $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
- $params = array(
- 'financial_account_id' => 3,
- 'entity_id' => $lineKey,
- );
- $compareParams = array(
- 'amount' => 100,
- );
- }
- if ($context != 'paylater') {
- $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
- }
- }
+ );
+ }
+ if ($context == 'paylater') {
+ $lineItems = CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution');
+ foreach ($lineItems as $key => $item) {
+ $params = array(
+ 'entity_id' => $key,
+ 'entity_table' => 'civicrm_line_item',
+ );
+ $compareParams = array('status_id' => 1);
+ $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
+ }
+ }
+ elseif ($context == 'refund') {
+ $compareParams = array(
+ 'status_id' => 1,
+ 'financial_account_id' => 1,
+ 'amount' => -100,
+ );
+ }
+ elseif ($context == 'cancelPending') {
+ $compareParams = array(
+ 'status_id' => 3,
+ 'financial_account_id' => 1,
+ 'amount' => -100,
+ );
+ }
+ elseif ($context == 'changeFinancial') {
+ $lineKey = key(CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution'));
+ $params = array(
+ 'entity_id' => $lineKey,
+ 'amount' => -100,
+ );
+ $compareParams = array(
+ 'financial_account_id' => 1,
+ );
+ $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
+ $params = array(
+ 'financial_account_id' => 3,
+ 'entity_id' => $lineKey,
+ );
+ $compareParams = array(
+ 'amount' => 100,
+ );
+ }
+ if ($context != 'paylater') {
+ $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
+ }
+ }
/**
* @param $contribution
* @param $context
- * @param null $instrumentId
+ * @param int $instrumentId
*/
- function _checkFinancialTrxn($contribution, $context, $instrumentId = NULL) {
- $trxnParams = array(
- 'entity_id' => $contribution['id'],
- 'entity_table' => 'civicrm_contribution',
- );
- $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($trxnParams, TRUE));
- $params = array(
- 'id' => $trxn['financial_trxn_id'],
- );
- if ($context == 'payLater') {
- $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
- $compareParams = array(
- 'status_id' => 1,
- 'from_financial_account_id' => CRM_Contribute_PseudoConstant::financialAccountType($contribution['financial_type_id'], $relationTypeId),
- );
- }
- elseif ($context == 'refund') {
- $compareParams = array(
- 'to_financial_account_id' => 6,
- 'total_amount' => -100,
- 'status_id' => 7,
- );
- }
- elseif ($context == 'cancelPending') {
- $compareParams = array(
- 'from_financial_account_id' => 7,
- 'total_amount' => -100,
- 'status_id' => 3,
- );
- }
- elseif ($context == 'changeFinancial' || $context == 'paymentInstrument') {
- $entityParams = array(
- 'entity_id' => $contribution['id'],
- 'entity_table' => 'civicrm_contribution',
- 'amount' => -100,
- );
- $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
- $trxnParams1 = array(
+ public function _checkFinancialTrxn($contribution, $context, $instrumentId = NULL) {
+ $trxnParams = array(
+ 'entity_id' => $contribution['id'],
+ 'entity_table' => 'civicrm_contribution',
+ );
+ $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($trxnParams, TRUE));
+ $params = array(
+ 'id' => $trxn['financial_trxn_id'],
+ );
+ if ($context == 'payLater') {
+ $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
+ $compareParams = array(
+ 'status_id' => 1,
+ 'from_financial_account_id' => CRM_Contribute_PseudoConstant::financialAccountType($contribution['financial_type_id'], $relationTypeId),
+ );
+ }
+ elseif ($context == 'refund') {
+ $compareParams = array(
+ 'to_financial_account_id' => 6,
+ 'total_amount' => -100,
+ 'status_id' => 7,
+ );
+ }
+ elseif ($context == 'cancelPending') {
+ $compareParams = array(
+ 'from_financial_account_id' => 7,
+ 'total_amount' => -100,
+ 'status_id' => 3,
+ );
+ }
+ elseif ($context == 'changeFinancial' || $context == 'paymentInstrument') {
+ $entityParams = array(
+ 'entity_id' => $contribution['id'],
+ 'entity_table' => 'civicrm_contribution',
+ 'amount' => -100,
+ );
+ $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
+ $trxnParams1 = array(
'id' => $trxn['financial_trxn_id'],
- );
- $compareParams = array(
- 'total_amount' => -100,
- 'status_id' => 1,
- );
- if ($context == 'paymentInstrument') {
- $compareParams += array(
- 'to_financial_account_id' => CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount(4),
- 'payment_instrument_id' => 4,
- );
- }
- else {
- $compareParams['to_financial_account_id'] = 12;
- }
- $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams1, $compareParams);
- $compareParams['total_amount'] = 100;
- if ($context == 'paymentInstrument') {
- $compareParams['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($instrumentId);
- $compareParams['payment_instrument_id'] = $instrumentId;
- }
- else {
- $compareParams['to_financial_account_id'] = 12;
- }
- }
-
- $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $params, $compareParams);
- }
+ );
+ $compareParams = array(
+ 'total_amount' => -100,
+ 'status_id' => 1,
+ );
+ if ($context == 'paymentInstrument') {
+ $compareParams += array(
+ 'to_financial_account_id' => CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount(4),
+ 'payment_instrument_id' => 4,
+ );
+ }
+ else {
+ $compareParams['to_financial_account_id'] = 12;
+ }
+ $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams1, $compareParams);
+ $compareParams['total_amount'] = 100;
+ if ($context == 'paymentInstrument') {
+ $compareParams['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($instrumentId);
+ $compareParams['payment_instrument_id'] = $instrumentId;
+ }
+ else {
+ $compareParams['to_financial_account_id'] = 12;
+ }
+ }
+
+ $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $params, $compareParams);
+ }
/**
* @return mixed
*/
- function _addPaymentInstrument () {
- $gId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', 'payment_instrument', 'id', 'name');
- $optionParams = array(
- 'option_group_id' => $gId,
- 'label' => 'Test Card',
- 'name' => 'Test Card',
- 'value' => '6',
- 'weight' => '6',
- 'is_active' => 1,
-);
- $optionValue = $this->callAPISuccess('option_value', 'create', $optionParams);
- $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Asset Account is' "));
- $financialParams = array(
- 'entity_table' => 'civicrm_option_value',
- 'entity_id' => $optionValue['id'],
- 'account_relationship' => $relationTypeId,
- 'financial_account_id' => 7,
- );
- CRM_Financial_BAO_FinancialTypeAccount::add($financialParams, CRM_Core_DAO::$_nullArray);
- $this->assertNotEmpty($optionValue['values'][$optionValue['id']]['value']);
- return $optionValue['values'][$optionValue['id']]['value'];
- }
+ public function _addPaymentInstrument() {
+ $gId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', 'payment_instrument', 'id', 'name');
+ $optionParams = array(
+ 'option_group_id' => $gId,
+ 'label' => 'Test Card',
+ 'name' => 'Test Card',
+ 'value' => '6',
+ 'weight' => '6',
+ 'is_active' => 1,
+ );
+ $optionValue = $this->callAPISuccess('option_value', 'create', $optionParams);
+ $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Asset Account is' "));
+ $financialParams = array(
+ 'entity_table' => 'civicrm_option_value',
+ 'entity_id' => $optionValue['id'],
+ 'account_relationship' => $relationTypeId,
+ 'financial_account_id' => 7,
+ );
+ CRM_Financial_BAO_FinancialTypeAccount::add($financialParams, CRM_Core_DAO::$_nullArray);
+ $this->assertNotEmpty($optionValue['values'][$optionValue['id']]['value']);
+ return $optionValue['values'][$optionValue['id']]['value'];
+ }
/**
- * @param $params
+ * @param array $params
* @param $context
*/
- function _checkFinancialRecords($params,$context) {
- $entityParams = array(
- 'entity_id' => $params['id'],
- 'entity_table' => 'civicrm_contribution',
- );
+ public function _checkFinancialRecords($params, $context) {
+ $entityParams = array(
+ 'entity_id' => $params['id'],
+ 'entity_table' => 'civicrm_contribution',
+ );
$contribution = $this->callAPISuccess('contribution', 'getsingle', array('id' => $params['id']));
$this->assertEquals($contribution['total_amount'] - $contribution['fee_amount'], $contribution['net_amount']);
- if ($context == 'pending') {
- $trxn = CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams);
- $this->assertNull($trxn, 'No Trxn to be created until IPN callback');
- return;
- }
- $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
- $trxnParams = array(
- 'id' => $trxn['financial_trxn_id'],
- );
- if ($context != 'online' && $context != 'payLater') {
- $compareParams = array(
- 'to_financial_account_id' => 6,
- 'total_amount' => 100,
- 'status_id' => 1,
- );
- }
- if ($context == 'feeAmount') {
- $compareParams['fee_amount'] = 50;
- }
- elseif ($context == 'online') {
- $compareParams = array(
- 'to_financial_account_id' => 12,
- 'total_amount' => 100,
- 'status_id' => 1,
- );
- }
- elseif ($context == 'payLater') {
- $compareParams = array(
- 'to_financial_account_id' => 7,
- 'total_amount' => 100,
- 'status_id' => 2,
- );
- }
- $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn',$trxnParams, $compareParams);
- $entityParams = array(
- 'financial_trxn_id' => $trxn['financial_trxn_id'],
- 'entity_table' => 'civicrm_financial_item',
- );
- $entityTrxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
- $fitemParams = array(
- 'id' => $entityTrxn['entity_id'],
- );
- $compareParams = array(
- 'amount' => 100,
- 'status_id' => 1,
- 'financial_account_id' => 1,
- );
- if ($context == 'payLater') {
- $compareParams = array(
- 'amount' => 100,
- 'status_id' => 3,
- 'financial_account_id' => 1,
- );
- }
- $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $fitemParams, $compareParams);
- if ($context == 'feeAmount') {
- $maxParams = array(
- 'entity_id' => $params['id'],
- 'entity_table' => 'civicrm_contribution',
- );
- $maxTrxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($maxParams, TRUE));
- $trxnParams = array(
- 'id' => $maxTrxn['financial_trxn_id'],
- );
- $compareParams = array(
- 'to_financial_account_id' => 5,
- 'from_financial_account_id' => 6,
- 'total_amount' => 50,
- 'status_id' => 1,
- );
- $trxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($params['id'], 'DESC');
- $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams, $compareParams);
- $fitemParams = array(
- 'entity_id' => $trxnId['financialTrxnId'],
- 'entity_table' => 'civicrm_financial_trxn',
- );
- $compareParams = array(
- 'amount' => 50,
- 'status_id' => 1,
- 'financial_account_id' => 5,
- );
- $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $fitemParams, $compareParams);
- }
- }
+ if ($context == 'pending') {
+ $trxn = CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams);
+ $this->assertNull($trxn, 'No Trxn to be created until IPN callback');
+ return;
+ }
+ $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
+ $trxnParams = array(
+ 'id' => $trxn['financial_trxn_id'],
+ );
+ if ($context != 'online' && $context != 'payLater') {
+ $compareParams = array(
+ 'to_financial_account_id' => 6,
+ 'total_amount' => 100,
+ 'status_id' => 1,
+ );
+ }
+ if ($context == 'feeAmount') {
+ $compareParams['fee_amount'] = 50;
+ }
+ elseif ($context == 'online') {
+ $compareParams = array(
+ 'to_financial_account_id' => 12,
+ 'total_amount' => 100,
+ 'status_id' => 1,
+ );
+ }
+ elseif ($context == 'payLater') {
+ $compareParams = array(
+ 'to_financial_account_id' => 7,
+ 'total_amount' => 100,
+ 'status_id' => 2,
+ );
+ }
+ $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams, $compareParams);
+ $entityParams = array(
+ 'financial_trxn_id' => $trxn['financial_trxn_id'],
+ 'entity_table' => 'civicrm_financial_item',
+ );
+ $entityTrxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
+ $fitemParams = array(
+ 'id' => $entityTrxn['entity_id'],
+ );
+ $compareParams = array(
+ 'amount' => 100,
+ 'status_id' => 1,
+ 'financial_account_id' => 1,
+ );
+ if ($context == 'payLater') {
+ $compareParams = array(
+ 'amount' => 100,
+ 'status_id' => 3,
+ 'financial_account_id' => 1,
+ );
+ }
+ $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $fitemParams, $compareParams);
+ if ($context == 'feeAmount') {
+ $maxParams = array(
+ 'entity_id' => $params['id'],
+ 'entity_table' => 'civicrm_contribution',
+ );
+ $maxTrxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($maxParams, TRUE));
+ $trxnParams = array(
+ 'id' => $maxTrxn['financial_trxn_id'],
+ );
+ $compareParams = array(
+ 'to_financial_account_id' => 5,
+ 'from_financial_account_id' => 6,
+ 'total_amount' => 50,
+ 'status_id' => 1,
+ );
+ $trxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($params['id'], 'DESC');
+ $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams, $compareParams);
+ $fitemParams = array(
+ 'entity_id' => $trxnId['financialTrxnId'],
+ 'entity_table' => 'civicrm_financial_trxn',
+ );
+ $compareParams = array(
+ 'amount' => 50,
+ 'status_id' => 1,
+ 'financial_account_id' => 5,
+ );
+ $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $fitemParams, $compareParams);
+ }
+ }
}
-
projects / civicrm-core.git / blobdiff