3 * File for the CiviUnitTestCase class
7 * @copyright Copyright CiviCRM LLC (C) 2009
8 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html
9 * GNU Affero General Public License version 3
12 * This file is part of CiviCRM
14 * CiviCRM is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU Affero General Public License
16 * as published by the Free Software Foundation; either version 3 of
17 * the License, or (at your option) any later version.
19 * CiviCRM is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU Affero General Public License for more details.
24 * You should have received a copy of the GNU Affero General Public
25 * License along with this program. If not, see
26 * <http://www.gnu.org/licenses/>.
29 use Civi\Payment\System
;
30 use League\Csv\Reader
;
33 * Include class definitions
35 require_once 'api/api.php';
36 define('API_LATEST_VERSION', 3);
39 * Base class for CiviCRM unit tests
41 * This class supports two (mutually-exclusive) techniques for cleaning up test data. Subclasses
42 * may opt for one or neither:
44 * 1. quickCleanup() is a helper which truncates a series of tables. Call quickCleanup()
45 * as part of setUp() and/or tearDown(). quickCleanup() is thorough - but it can
46 * be cumbersome to use (b/c you must identify the tables to cleanup) and slow to execute.
47 * 2. useTransaction() executes the test inside a transaction. It's easier to use
48 * (because you don't need to identify specific tables), but it doesn't work for tests
49 * which manipulate schema or truncate data -- and could behave inconsistently
50 * for tests which specifically examine DB transactions.
52 * Common functions for unit tests
56 class CiviUnitTestCase
extends PHPUnit\Framework\TestCase
{
58 use \Civi\Test\Api3DocTrait
;
59 use \Civi\Test\GenericAssertionsTrait
;
60 use \Civi\Test\DbTestTrait
;
61 use \Civi\Test\ContactTestTrait
;
62 use \Civi\Test\MailingTestTrait
;
65 * Database has been initialized.
69 private static $dbInit = FALSE;
72 * Database connection.
74 * @var PHPUnit_Extensions_Database_DB_IDatabaseConnection
83 static protected $_dbName;
86 * Track tables we have modified during a test.
90 protected $_tablesToTruncate = [];
94 * Array of temporary directory names
100 * populateOnce allows to skip db resets in setUp
102 * WARNING! USE WITH CAUTION - IT'LL RENDER DATA DEPENDENCIES
103 * BETWEEN TESTS WHEN RUN IN SUITE. SUITABLE FOR LOCAL, LIMITED
106 * IF POSSIBLE, USE $this->DBResetRequired = FALSE IN YOUR TEST CASE!
108 * @see http://forum.civicrm.org/index.php/topic,18065.0.html
110 public static $populateOnce = FALSE;
113 * DBResetRequired allows skipping DB reset
114 * in specific test case. If you still need
115 * to reset single test (method) of such case, call
116 * $this->cleanDB() in the first line of this
120 public $DBResetRequired = TRUE;
123 * @var CRM_Core_Transaction|null
128 * Array of IDs created to support the test.
131 * $this->ids = ['Contact' => ['descriptive_key' => $contactID], 'Group' => [$groupID]];
138 * Class used for hooks during tests.
140 * This can be used to test hooks within tests. For example in the ACL_PermissionTrait:
142 * $this->hookClass->setHook('civicrm_aclWhereClause', array($this, 'aclWhereHookAllResults'));
144 * @var \CRM_Utils_Hook_UnitTests
146 public $hookClass = NULL;
150 * Common values to be re-used multiple times within a class - usually to create the relevant entity
152 protected $_params = [];
155 * @var CRM_Extension_System
157 protected $origExtensionSystem;
160 * Array of IDs created during test setup routine.
162 * The cleanUpSetUpIds method can be used to clear these at the end of the test.
166 public $setupIDs = [];
169 * PHPUnit Mock Method to use.
173 public $mockMethod = 'getMock';
178 * Because we are overriding the parent class constructor, we
179 * need to show the same arguments as exist in the constructor of
180 * PHPUnit_Framework_TestCase, since
181 * PHPUnit_Framework_TestSuite::createTest() creates a
182 * ReflectionClass of the Test class and checks the constructor
183 * of that class to decide how to set up the test.
185 * @param string $name
187 * @param string $dataName
189 public function __construct($name = NULL, array $data = [], $dataName = '') {
190 parent
::__construct($name, $data, $dataName);
192 // we need full error reporting
193 error_reporting(E_ALL
& ~E_NOTICE
);
195 self
::$_dbName = self
::getDBName();
197 // also load the class loader
198 require_once 'CRM/Core/ClassLoader.php';
199 CRM_Core_ClassLoader
::singleton()->register();
200 if (function_exists('_civix_phpunit_setUp')) {
201 // FIXME: loosen coupling
202 _civix_phpunit_setUp();
204 if (class_exists('PHPUnit_Runner_Version') && version_compare(\PHPUnit_Runner_Version
::id(), '5', '>=')) {
205 $this->mockMethod
= 'createMock';
207 elseif (class_exists('PHPUnit\Runner\Version') && version_compare(PHPUnit\Runner\Version
::id(), '6', '>=')) {
208 $this->mockMethod
= 'createMock';
213 * Override to run the test and assert its state.
217 * @throws \PHPUnit_Framework_IncompleteTest
218 * @throws \PHPUnit_Framework_SkippedTest
220 protected function runTest() {
222 return parent
::runTest();
224 catch (PEAR_Exception
$e) {
225 // PEAR_Exception has metadata in funny places, and PHPUnit won't log it nicely
226 throw new Exception(\CRM_Core_Error
::formatTextException($e), $e->getCode());
233 public function requireDBReset() {
234 return $this->DBResetRequired
;
240 public static function getDBName() {
241 static $dbName = NULL;
242 if ($dbName === NULL) {
243 require_once "DB.php";
244 $dsninfo = DB
::parseDSN(CIVICRM_DSN
);
245 $dbName = $dsninfo['database'];
251 * Create database connection for this instance.
253 * Initialize the test database if it hasn't been initialized
256 protected function getConnection() {
257 if (!self
::$dbInit) {
258 $dbName = self
::getDBName();
260 // install test database
261 echo PHP_EOL
. "Installing {$dbName} database" . PHP_EOL
;
263 static::_populateDB(FALSE, $this);
265 self
::$dbInit = TRUE;
271 * Required implementation of abstract method.
273 protected function getDataSet() {
277 * @param bool $perClass
278 * @param null $object
281 * TRUE if the populate logic runs; FALSE if it is skipped
283 protected static function _populateDB($perClass = FALSE, &$object = NULL) {
284 if (CIVICRM_UF
!== 'UnitTests') {
285 throw new \
RuntimeException("_populateDB requires CIVICRM_UF=UnitTests");
288 if ($perClass ||
$object == NULL) {
292 $dbreset = $object->requireDBReset();
295 if (self
::$populateOnce ||
!$dbreset) {
298 self
::$populateOnce = NULL;
300 Civi\Test
::data()->populate();
305 public static function setUpBeforeClass() {
306 static::_populateDB(TRUE);
308 // also set this global hack
309 $GLOBALS['_PEAR_ERRORSTACK_OVERRIDE_CALLBACK'] = [];
313 * Common setup functions for all unit tests.
315 protected function setUp() {
316 $session = CRM_Core_Session
::singleton();
317 $session->set('userID', NULL);
319 $this->_apiversion
= 3;
322 $this->errorScope
= CRM_Core_TemporaryErrorScope
::useException();
323 // Use a temporary file for STDIN
324 $GLOBALS['stdin'] = tmpfile();
325 if ($GLOBALS['stdin'] === FALSE) {
326 echo "Couldn't open temporary file\n";
330 // Get and save a connection to the database
331 $this->_dbconn
= $this->getConnection();
333 // reload database before each test
334 // $this->_populateDB();
336 // "initialize" CiviCRM to avoid problems when running single tests
337 // FIXME: look at it closer in second stage
339 $GLOBALS['civicrm_setting']['domain']['fatalErrorHandler'] = 'CiviUnitTestCase_fatalErrorHandler';
340 $GLOBALS['civicrm_setting']['domain']['backtrace'] = 1;
342 // disable any left-over test extensions
343 CRM_Core_DAO
::executeQuery('DELETE FROM civicrm_extension WHERE full_name LIKE "test.%"');
345 // reset all the caches
346 CRM_Utils_System
::flushCache();
348 // initialize the object once db is loaded
349 \Civi
::$statics = [];
351 $config = CRM_Core_Config
::singleton(TRUE, TRUE);
353 // when running unit tests, use mockup user framework
354 $this->hookClass
= CRM_Utils_Hook
::singleton();
356 // Make sure the DB connection is setup properly
357 $config->userSystem
->setMySQLTimeZone();
358 $env = new CRM_Utils_Check_Component_Env();
359 CRM_Utils_Check
::singleton()->assertValid($env->checkMysqlTime());
361 // clear permissions stub to not check permissions
362 $config->userPermissionClass
->permissions
= NULL;
364 //flush component settings
365 CRM_Core_Component
::getEnabledComponents(TRUE);
367 $_REQUEST = $_GET = $_POST = [];
368 error_reporting(E_ALL
);
370 $this->renameLabels();
371 $this->_sethtmlGlobals();
375 * Read everything from the datasets directory and insert into the db.
377 public function loadAllFixtures() {
378 $fixturesDir = __DIR__
. '/../../fixtures';
380 CRM_Core_DAO
::executeQuery("SET FOREIGN_KEY_CHECKS = 0;");
382 $jsonFiles = glob($fixturesDir . '/*.json');
383 foreach ($jsonFiles as $jsonFixture) {
384 $json = json_decode(file_get_contents($jsonFixture));
385 foreach ($json as $tableName => $vars) {
386 if ($tableName === 'civicrm_contact') {
387 CRM_Core_DAO
::executeQuery('DELETE c FROM civicrm_contact c LEFT JOIN civicrm_domain d ON d.contact_id = c.id WHERE d.id IS NULL');
390 CRM_Core_DAO
::executeQuery("TRUNCATE $tableName");
392 foreach ($vars as $entity) {
393 $keys = $values = [];
394 foreach ($entity as $key => $value) {
396 $values[] = is_numeric($value) ?
$value : "'{$value}'";
398 CRM_Core_DAO
::executeQuery("
399 INSERT INTO $tableName (" . implode(',', $keys) . ') VALUES(' . implode(',', $values) . ')'
406 CRM_Core_DAO
::executeQuery("SET FOREIGN_KEY_CHECKS = 1;");
410 * Load the data that used to be handled by the discontinued dbunit class.
412 * This could do with further tidy up - the initial priority is simply to get rid of
413 * the dbunity package which is no longer supported.
415 * @param string $fileName
417 protected function loadXMLDataSet($fileName) {
418 CRM_Core_DAO
::executeQuery('SET FOREIGN_KEY_CHECKS = 0');
419 $xml = json_decode(json_encode(simplexml_load_file($fileName)), TRUE);
420 foreach ($xml as $tableName => $element) {
421 if (!empty($element)) {
422 foreach ($element as $row) {
423 $keys = $values = [];
424 if (isset($row['@attributes'])) {
425 foreach ($row['@attributes'] as $key => $value) {
427 $values[] = is_numeric($value) ?
$value : "'{$value}'";
430 elseif (!empty($row)) {
431 // cos we copied it & it is inconsistent....
432 foreach ($row as $key => $value) {
434 $values[] = is_numeric($value) ?
$value : "'{$value}'";
438 if (!empty($values)) {
439 CRM_Core_DAO
::executeQuery("
440 INSERT INTO $tableName (" . implode(',', $keys) . ') VALUES(' . implode(',', $values) . ')'
446 CRM_Core_DAO
::executeQuery('SET FOREIGN_KEY_CHECKS = 1');
450 * Create default domain contacts for the two domains added during test class.
451 * database population.
453 public function createDomainContacts() {
454 $this->organizationCreate();
455 $this->organizationCreate(['organization_name' => 'Second Domain']);
459 * Common teardown functions for all unit tests.
461 protected function tearDown() {
462 $this->_apiversion
= 3;
463 $this->resetLabels();
465 error_reporting(E_ALL
& ~E_NOTICE
);
466 CRM_Utils_Hook
::singleton()->reset();
467 if ($this->hookClass
) {
468 $this->hookClass
->reset();
470 CRM_Core_Session
::singleton()->reset(1);
473 $this->tx
->rollback()->commit();
476 CRM_Core_Transaction
::forceRollbackIfEnabled();
477 \Civi\Core\Transaction\Manager
::singleton(TRUE);
480 CRM_Core_Transaction
::forceRollbackIfEnabled();
481 \Civi\Core\Transaction\Manager
::singleton(TRUE);
483 $tablesToTruncate = ['civicrm_contact', 'civicrm_uf_match'];
484 $this->quickCleanup($tablesToTruncate);
485 $this->createDomainContacts();
488 $this->cleanTempDirs();
489 $this->unsetExtensionSystem();
490 $this->assertEquals([], CRM_Core_DAO
::$_nullArray);
491 $this->assertEquals(NULL, CRM_Core_DAO
::$_nullObject);
495 * Create a batch of external API calls which can
496 * be executed concurrently.
499 * $calls = $this->createExternalAPI()
500 * ->addCall('Contact', 'get', ...)
501 * ->addCall('Contact', 'get', ...)
507 * @return \Civi\API\ExternalBatch
508 * @throws PHPUnit_Framework_SkippedTestError
510 public function createExternalAPI() {
511 global $civicrm_root;
513 'version' => $this->_apiversion
,
517 $calls = new \Civi\API\
ExternalBatch($defaultParams);
519 if (!$calls->isSupported()) {
520 $this->markTestSkipped('The test relies on Civi\API\ExternalBatch. This is unsupported in the local environment.');
527 * Create required data based on $this->entity & $this->params
528 * This is just a way to set up the test data for delete & get functions
529 * so the distinction between set
530 * up & tested functions is clearer
535 public function createTestEntity() {
536 return $entity = $this->callAPISuccess($this->entity
, 'create', $this->params
);
540 * @param int $contactTypeId
544 public function contactTypeDelete($contactTypeId) {
545 $result = CRM_Contact_BAO_ContactType
::del($contactTypeId);
547 throw new Exception('Could not delete contact type');
552 * @param array $params
556 public function membershipTypeCreate($params = []) {
557 CRM_Member_PseudoConstant
::flush('membershipType');
558 CRM_Core_Config
::clearDBCache();
559 $this->setupIDs
['contact'] = $memberOfOrganization = $this->organizationCreate();
560 $params = array_merge([
562 'duration_unit' => 'year',
563 'duration_interval' => 1,
564 'period_type' => 'rolling',
565 'member_of_contact_id' => $memberOfOrganization,
567 'financial_type_id' => 2,
570 'visibility' => 'Public',
573 $result = $this->callAPISuccess('MembershipType', 'Create', $params);
575 CRM_Member_PseudoConstant
::flush('membershipType');
576 CRM_Utils_Cache
::singleton()->flush();
578 return $result['id'];
584 * @param array $params
587 * @throws \CRM_Core_Exception
589 public function contactMembershipCreate($params) {
590 $params = array_merge([
591 'join_date' => '2007-01-21',
592 'start_date' => '2007-01-21',
593 'end_date' => '2007-12-21',
594 'source' => 'Payment',
595 'membership_type_id' => 'General',
597 if (!is_numeric($params['membership_type_id'])) {
598 $membershipTypes = $this->callAPISuccess('Membership', 'getoptions', ['action' => 'create', 'field' => 'membership_type_id']);
599 if (!in_array($params['membership_type_id'], $membershipTypes['values'], TRUE)) {
600 $this->membershipTypeCreate(['name' => $params['membership_type_id']]);
604 $result = $this->callAPISuccess('Membership', 'create', $params);
605 return $result['id'];
609 * Delete Membership Type.
611 * @param array $params
613 public function membershipTypeDelete($params) {
614 $this->callAPISuccess('MembershipType', 'Delete', $params);
618 * @param int $membershipID
620 public function membershipDelete($membershipID) {
621 $deleteParams = ['id' => $membershipID];
622 $result = $this->callAPISuccess('Membership', 'Delete', $deleteParams);
626 * @param string $name
630 public function membershipStatusCreate($name = 'test member status') {
631 $params['name'] = $name;
632 $params['start_event'] = 'start_date';
633 $params['end_event'] = 'end_date';
634 $params['is_current_member'] = 1;
635 $params['is_active'] = 1;
637 $result = $this->callAPISuccess('MembershipStatus', 'Create', $params);
638 CRM_Member_PseudoConstant
::flush('membershipStatus');
639 return $result['id'];
643 * @param int $membershipStatusID
645 public function membershipStatusDelete($membershipStatusID) {
646 if (!$membershipStatusID) {
649 $result = $this->callAPISuccess('MembershipStatus', 'Delete', ['id' => $membershipStatusID]);
652 public function membershipRenewalDate($durationUnit, $membershipEndDate) {
653 // We only have an end_date if frequency units match, otherwise membership won't be autorenewed and dates won't be calculated.
654 $renewedMembershipEndDate = new DateTime($membershipEndDate);
655 switch ($durationUnit) {
657 $renewedMembershipEndDate->add(new DateInterval('P1Y'));
661 // We have to add 1 day first in case it's the end of the month, then subtract afterwards
662 // eg. 2018-02-28 should renew to 2018-03-31, if we just added 1 month we'd get 2018-03-28
663 $renewedMembershipEndDate->add(new DateInterval('P1D'));
664 $renewedMembershipEndDate->add(new DateInterval('P1M'));
665 $renewedMembershipEndDate->sub(new DateInterval('P1D'));
668 return $renewedMembershipEndDate->format('Y-m-d');
672 * Create a relationship type.
674 * @param array $params
678 * @throws \CRM_Core_Exception
680 public function relationshipTypeCreate($params = []) {
681 $params = array_merge([
682 'name_a_b' => 'Relation 1 for relationship type create',
683 'name_b_a' => 'Relation 2 for relationship type create',
684 'contact_type_a' => 'Individual',
685 'contact_type_b' => 'Organization',
690 $result = $this->callAPISuccess('relationship_type', 'create', $params);
691 CRM_Core_PseudoConstant
::flush('relationshipType');
693 return $result['id'];
697 * Delete Relatinship Type.
699 * @param int $relationshipTypeID
701 public function relationshipTypeDelete($relationshipTypeID) {
702 $params['id'] = $relationshipTypeID;
703 $check = $this->callAPISuccess('relationship_type', 'get', $params);
704 if (!empty($check['count'])) {
705 $this->callAPISuccess('relationship_type', 'delete', $params);
710 * @param array $params
713 * @throws \CRM_Core_Exception
715 public function paymentProcessorTypeCreate($params = NULL) {
716 if (is_null($params)) {
718 'name' => 'API_Test_PP',
719 'title' => 'API Test Payment Processor',
720 'class_name' => 'CRM_Core_Payment_APITest',
721 'billing_mode' => 'form',
727 $result = $this->callAPISuccess('payment_processor_type', 'create', $params);
729 CRM_Core_PseudoConstant
::flush('paymentProcessorType');
731 return $result['id'];
735 * Create test Authorize.net instance.
737 * @param array $params
741 public function paymentProcessorAuthorizeNetCreate($params = []) {
742 $params = array_merge([
743 'name' => 'Authorize',
744 'domain_id' => CRM_Core_Config
::domainID(),
745 'payment_processor_type_id' => 'AuthNet',
746 'title' => 'AuthNet',
751 'user_name' => '4y5BfuW7jm',
752 'password' => '4cAmW927n8uLf5J8',
753 'url_site' => 'https://test.authorize.net/gateway/transact.dll',
754 'url_recur' => 'https://apitest.authorize.net/xml/v1/request.api',
755 'class_name' => 'Payment_AuthorizeNet',
759 $result = $this->callAPISuccess('PaymentProcessor', 'create', $params);
760 return $result['id'];
764 * Create Participant.
766 * @param array $params
767 * Array of contact id and event id values.
770 * $id of participant created
772 public function participantCreate($params = []) {
773 if (empty($params['contact_id'])) {
774 $params['contact_id'] = $this->individualCreate();
776 if (empty($params['event_id'])) {
777 $event = $this->eventCreate();
778 $params['event_id'] = $event['id'];
783 'register_date' => 20070219,
784 'source' => 'Wimbeldon',
785 'event_level' => 'Payment',
789 $params = array_merge($defaults, $params);
790 $result = $this->callAPISuccess('Participant', 'create', $params);
791 return $result['id'];
795 * Create Payment Processor.
798 * Id Payment Processor
800 public function processorCreate($params = []) {
804 'payment_processor_type_id' => 'Dummy',
805 'financial_account_id' => 12,
809 'url_site' => 'http://dummy.com',
810 'url_recur' => 'http://dummy.com',
813 'payment_instrument_id' => 'Debit Card',
815 $processorParams = array_merge($processorParams, $params);
816 $processor = $this->callAPISuccess('PaymentProcessor', 'create', $processorParams);
817 return $processor['id'];
821 * Create Payment Processor.
823 * @param array $processorParams
825 * @return \CRM_Core_Payment_Dummy
826 * Instance of Dummy Payment Processor
828 * @throws \CiviCRM_API3_Exception
830 public function dummyProcessorCreate($processorParams = []) {
831 $paymentProcessorID = $this->processorCreate($processorParams);
832 // For the tests we don't need a live processor, but as core ALWAYS creates a processor in live mode and one in test mode we do need to create both
833 // Otherwise we are testing a scenario that only exists in tests (and some tests fail because the live processor has not been defined).
834 $processorParams['is_test'] = FALSE;
835 $this->processorCreate($processorParams);
836 return System
::singleton()->getById($paymentProcessorID);
840 * Create contribution page.
842 * @param array $params
845 * Array of contribution page
847 public function contributionPageCreate($params = []) {
848 $this->_pageParams
= array_merge([
849 'title' => 'Test Contribution Page',
850 'financial_type_id' => 1,
852 'financial_account_id' => 1,
854 'is_allow_other_amount' => 1,
856 'max_amount' => 1000,
858 return $this->callAPISuccess('contribution_page', 'create', $this->_pageParams
);
862 * Create a sample batch.
864 public function batchCreate() {
865 $params = $this->_params
;
866 $params['name'] = $params['title'] = 'Batch_433397';
867 $params['status_id'] = 1;
868 $result = $this->callAPISuccess('batch', 'create', $params);
869 return $result['id'];
875 * @param array $params
878 * result of created tag
880 public function tagCreate($params = []) {
882 'name' => 'New Tag3',
883 'description' => 'This is description for Our New Tag ',
886 $params = array_merge($defaults, $params);
887 $result = $this->callAPISuccess('Tag', 'create', $params);
888 return $result['values'][$result['id']];
895 * Id of the tag to be deleted.
899 public function tagDelete($tagId) {
900 require_once 'api/api.php';
904 $result = $this->callAPISuccess('Tag', 'delete', $params);
905 return $result['id'];
909 * Add entity(s) to the tag
911 * @param array $params
915 public function entityTagAdd($params) {
916 $result = $this->callAPISuccess('entity_tag', 'create', $params);
923 * @param array $params
927 * id of created pledge
929 public function pledgeCreate($params) {
930 $params = array_merge([
931 'pledge_create_date' => date('Ymd'),
932 'start_date' => date('Ymd'),
933 'scheduled_date' => date('Ymd'),
935 'pledge_status_id' => '2',
936 'financial_type_id' => '1',
937 'pledge_original_installment_amount' => 20,
938 'frequency_interval' => 5,
939 'frequency_unit' => 'year',
940 'frequency_day' => 15,
945 $result = $this->callAPISuccess('Pledge', 'create', $params);
946 return $result['id'];
950 * Delete contribution.
952 * @param int $pledgeId
954 public function pledgeDelete($pledgeId) {
956 'pledge_id' => $pledgeId,
958 $this->callAPISuccess('Pledge', 'delete', $params);
962 * Create contribution.
964 * @param array $params
965 * Array of parameters.
968 * id of created contribution
969 * @throws \CRM_Core_Exception
971 public function contributionCreate($params) {
973 $params = array_merge([
975 'receive_date' => date('Ymd'),
976 'total_amount' => 100.00,
977 'fee_amount' => 5.00,
978 'financial_type_id' => 1,
979 'payment_instrument_id' => 1,
980 'non_deductible_amount' => 10.00,
982 'contribution_status_id' => 1,
985 $result = $this->callAPISuccess('contribution', 'create', $params);
986 return $result['id'];
990 * Delete contribution.
992 * @param int $contributionId
995 * @throws \CRM_Core_Exception
997 public function contributionDelete($contributionId) {
999 'contribution_id' => $contributionId,
1001 $result = $this->callAPISuccess('contribution', 'delete', $params);
1008 * @param array $params
1009 * Name-value pair for an event.
1012 * @throws \CRM_Core_Exception
1014 public function eventCreate($params = []) {
1015 // if no contact was passed, make up a dummy event creator
1016 if (!isset($params['contact_id'])) {
1017 $params['contact_id'] = $this->_contactCreate([
1018 'contact_type' => 'Individual',
1019 'first_name' => 'Event',
1020 'last_name' => 'Creator',
1024 // set defaults for missing params
1025 $params = array_merge([
1026 'title' => 'Annual CiviCRM meet',
1027 'summary' => 'If you have any CiviCRM related issues or want to track where CiviCRM is heading, Sign up now',
1028 'description' => 'This event is intended to give brief idea about progess of CiviCRM and giving solutions to common user issues',
1029 'event_type_id' => 1,
1031 'start_date' => 20081021,
1032 'end_date' => 20081023,
1033 'is_online_registration' => 1,
1034 'registration_start_date' => 20080601,
1035 'registration_end_date' => 20081015,
1036 'max_participants' => 100,
1037 'event_full_text' => 'Sorry! We are already full',
1040 'is_show_location' => 0,
1041 'is_email_confirm' => 1,
1044 return $this->callAPISuccess('Event', 'create', $params);
1048 * Create a paid event.
1050 * @param array $params
1052 * @param array $options
1054 * @param string $key
1055 * Index for storing event ID in ids array.
1059 * @throws \CRM_Core_Exception
1061 protected function eventCreatePaid($params, $options = [['name' => 'hundy', 'amount' => 100]], $key = 'event') {
1062 $event = $this->eventCreate($params);
1063 $this->ids
['event'][$key] = (int) $event['id'];
1064 $this->priceSetID
= $this->ids
['PriceSet'][] = $this->eventPriceSetCreate(55, 0, 'Radio', $options);
1065 CRM_Price_BAO_PriceSet
::addTo('civicrm_event', $event['id'], $this->priceSetID
);
1066 $priceSet = CRM_Price_BAO_PriceSet
::getSetDetail($this->priceSetID
, TRUE, FALSE);
1067 $priceSet = CRM_Utils_Array
::value($this->priceSetID
, $priceSet);
1068 $this->eventFeeBlock
= CRM_Utils_Array
::value('fields', $priceSet);
1080 public function eventDelete($id) {
1084 return $this->callAPISuccess('event', 'delete', $params);
1088 * Delete participant.
1090 * @param int $participantID
1094 public function participantDelete($participantID) {
1096 'id' => $participantID,
1098 $check = $this->callAPISuccess('Participant', 'get', $params);
1099 if ($check['count'] > 0) {
1100 return $this->callAPISuccess('Participant', 'delete', $params);
1105 * Create participant payment.
1107 * @param int $participantID
1108 * @param int $contributionID
1111 * $id of created payment
1113 public function participantPaymentCreate($participantID, $contributionID = NULL) {
1114 //Create Participant Payment record With Values
1116 'participant_id' => $participantID,
1117 'contribution_id' => $contributionID,
1120 $result = $this->callAPISuccess('participant_payment', 'create', $params);
1121 return $result['id'];
1125 * Delete participant payment.
1127 * @param int $paymentID
1129 public function participantPaymentDelete($paymentID) {
1133 $result = $this->callAPISuccess('participant_payment', 'delete', $params);
1139 * @param int $contactID
1142 * location id of created location
1144 public function locationAdd($contactID) {
1147 'location_type' => 'New Location Type',
1149 'name' => 'Saint Helier St',
1150 'county' => 'Marin',
1151 'country' => 'UNITED STATES',
1152 'state_province' => 'Michigan',
1153 'supplemental_address_1' => 'Hallmark Ct',
1154 'supplemental_address_2' => 'Jersey Village',
1155 'supplemental_address_3' => 'My Town',
1160 'contact_id' => $contactID,
1161 'address' => $address,
1162 'location_format' => '2.0',
1163 'location_type' => 'New Location Type',
1166 $result = $this->callAPISuccess('Location', 'create', $params);
1171 * Delete Locations of contact.
1173 * @param array $params
1176 public function locationDelete($params) {
1177 $this->callAPISuccess('Location', 'delete', $params);
1181 * Add a Location Type.
1183 * @param array $params
1185 * @return CRM_Core_DAO_LocationType
1186 * location id of created location
1188 public function locationTypeCreate($params = NULL) {
1189 if ($params === NULL) {
1191 'name' => 'New Location Type',
1192 'vcard_name' => 'New Location Type',
1193 'description' => 'Location Type for Delete',
1198 $locationType = new CRM_Core_DAO_LocationType();
1199 $locationType->copyValues($params);
1200 $locationType->save();
1201 // clear getfields cache
1202 CRM_Core_PseudoConstant
::flush();
1203 $this->callAPISuccess('phone', 'getfields', ['version' => 3, 'cache_clear' => 1]);
1204 return $locationType;
1208 * Delete a Location Type.
1210 * @param int $locationTypeId
1212 public function locationTypeDelete($locationTypeId) {
1213 $locationType = new CRM_Core_DAO_LocationType();
1214 $locationType->id
= $locationTypeId;
1215 $locationType->delete();
1221 * @param array $params
1223 * @return CRM_Core_DAO_Mapping
1224 * Mapping id of created mapping
1226 public function mappingCreate($params = NULL) {
1227 if ($params === NULL) {
1229 'name' => 'Mapping name',
1230 'description' => 'Mapping description',
1231 // 'Export Contact' mapping.
1232 'mapping_type_id' => 7,
1236 $mapping = new CRM_Core_DAO_Mapping();
1237 $mapping->copyValues($params);
1239 // clear getfields cache
1240 CRM_Core_PseudoConstant
::flush();
1241 $this->callAPISuccess('mapping', 'getfields', ['version' => 3, 'cache_clear' => 1]);
1248 * @param int $mappingId
1250 public function mappingDelete($mappingId) {
1251 $mapping = new CRM_Core_DAO_Mapping();
1252 $mapping->id
= $mappingId;
1257 * Prepare class for ACLs.
1259 protected function prepareForACLs() {
1260 $config = CRM_Core_Config
::singleton();
1261 $config->userPermissionClass
->permissions
= [];
1267 protected function cleanUpAfterACLs() {
1268 CRM_Utils_Hook
::singleton()->reset();
1269 $tablesToTruncate = [
1271 'civicrm_acl_cache',
1272 'civicrm_acl_entity_role',
1273 'civicrm_acl_contact_cache',
1275 $this->quickCleanup($tablesToTruncate);
1276 $config = CRM_Core_Config
::singleton();
1277 unset($config->userPermissionClass
->permissions
);
1281 * Create a smart group.
1283 * By default it will be a group of households.
1285 * @param array $smartGroupParams
1286 * @param array $groupParams
1287 * @param string $contactType
1291 public function smartGroupCreate($smartGroupParams = [], $groupParams = [], $contactType = 'Household') {
1292 $smartGroupParams = array_merge(['form_values' => ['contact_type' => ['IN' => [$contactType]]]], $smartGroupParams);
1293 $savedSearch = CRM_Contact_BAO_SavedSearch
::create($smartGroupParams);
1295 $groupParams['saved_search_id'] = $savedSearch->id
;
1296 return $this->groupCreate($groupParams);
1302 * @param array $params
1304 public function uFFieldCreate($params = []) {
1305 $params = array_merge([
1307 'field_name' => 'first_name',
1310 'visibility' => 'Public Pages and Listings',
1311 'is_searchable' => '1',
1312 'label' => 'first_name',
1313 'field_type' => 'Individual',
1316 $this->callAPISuccess('uf_field', 'create', $params);
1320 * Add a UF Join Entry.
1322 * @param array $params
1325 * $id of created UF Join
1327 public function ufjoinCreate($params = NULL) {
1328 if ($params === NULL) {
1331 'module' => 'CiviEvent',
1332 'entity_table' => 'civicrm_event',
1338 $result = $this->callAPISuccess('uf_join', 'create', $params);
1343 * @param array $params
1344 * Optional parameters.
1345 * @param bool $reloadConfig
1346 * While enabling CiviCampaign component, we shouldn't always forcibly
1347 * reload config as this hinder hook call in test environment
1352 public function campaignCreate($params = [], $reloadConfig = TRUE) {
1353 $this->enableCiviCampaign($reloadConfig);
1354 $campaign = $this->callAPISuccess('campaign', 'create', array_merge([
1355 'name' => 'big_campaign',
1356 'title' => 'Campaign',
1358 return $campaign['id'];
1362 * Create Group for a contact.
1364 * @param int $contactId
1366 public function contactGroupCreate($contactId) {
1368 'contact_id.1' => $contactId,
1372 $this->callAPISuccess('GroupContact', 'Create', $params);
1376 * Delete Group for a contact.
1378 * @param int $contactId
1380 public function contactGroupDelete($contactId) {
1382 'contact_id.1' => $contactId,
1385 $this->civicrm_api('GroupContact', 'Delete', $params);
1391 * @param array $params
1395 public function activityCreate($params = []) {
1396 $params = array_merge([
1397 'subject' => 'Discussion on warm beer',
1398 'activity_date_time' => date('Ymd'),
1400 'location' => 'Baker Street',
1401 'details' => 'Lets schedule a meeting',
1403 'activity_type_id' => 'Meeting',
1405 if (!isset($params['source_contact_id'])) {
1406 $params['source_contact_id'] = $this->individualCreate();
1408 if (!isset($params['target_contact_id'])) {
1409 $params['target_contact_id'] = $this->individualCreate([
1410 'first_name' => 'Julia',
1411 'last_name' => 'Anderson',
1413 'email' => 'julia_anderson@civicrm.org',
1414 'contact_type' => 'Individual',
1417 if (!isset($params['assignee_contact_id'])) {
1418 $params['assignee_contact_id'] = $params['target_contact_id'];
1421 $result = civicrm_api3('Activity', 'create', $params);
1423 $result['target_contact_id'] = $params['target_contact_id'];
1424 $result['assignee_contact_id'] = $params['assignee_contact_id'];
1429 * Create an activity type.
1431 * @param array $params
1436 public function activityTypeCreate($params) {
1437 return $this->callAPISuccess('ActivityType', 'create', $params);
1441 * Delete activity type.
1443 * @param int $activityTypeId
1444 * Id of the activity type.
1448 public function activityTypeDelete($activityTypeId) {
1449 $params['activity_type_id'] = $activityTypeId;
1450 return $this->callAPISuccess('ActivityType', 'delete', $params);
1454 * Create custom group.
1456 * @param array $params
1460 public function customGroupCreate($params = []) {
1462 'title' => 'new custom group',
1463 'extends' => 'Contact',
1465 'style' => 'Inline',
1469 $params = array_merge($defaults, $params);
1471 return $this->callAPISuccess('custom_group', 'create', $params);
1475 * Existing function doesn't allow params to be over-ridden so need a new one
1476 * this one allows you to only pass in the params you want to change
1478 * @param array $params
1482 public function CustomGroupCreateByParams($params = []) {
1484 'title' => "API Custom Group",
1485 'extends' => 'Contact',
1487 'style' => 'Inline',
1490 $params = array_merge($defaults, $params);
1491 return $this->callAPISuccess('custom_group', 'create', $params);
1495 * Create custom group with multi fields.
1497 * @param array $params
1501 public function CustomGroupMultipleCreateByParams($params = []) {
1506 $params = array_merge($defaults, $params);
1507 return $this->CustomGroupCreateByParams($params);
1511 * Create custom group with multi fields.
1513 * @param array $params
1517 public function CustomGroupMultipleCreateWithFields($params = []) {
1518 // also need to pass on $params['custom_field'] if not set but not in place yet
1520 $customGroup = $this->CustomGroupMultipleCreateByParams($params);
1521 $ids['custom_group_id'] = $customGroup['id'];
1523 $customField = $this->customFieldCreate([
1524 'custom_group_id' => $ids['custom_group_id'],
1525 'label' => 'field_1' . $ids['custom_group_id'],
1529 $ids['custom_field_id'][] = $customField['id'];
1531 $customField = $this->customFieldCreate([
1532 'custom_group_id' => $ids['custom_group_id'],
1533 'default_value' => '',
1534 'label' => 'field_2' . $ids['custom_group_id'],
1537 $ids['custom_field_id'][] = $customField['id'];
1539 $customField = $this->customFieldCreate([
1540 'custom_group_id' => $ids['custom_group_id'],
1541 'default_value' => '',
1542 'label' => 'field_3' . $ids['custom_group_id'],
1545 $ids['custom_field_id'][] = $customField['id'];
1551 * Create a custom group with a single text custom field. See
1552 * participant:testCreateWithCustom for how to use this
1554 * @param string $function
1556 * @param string $filename
1560 * ids of created objects
1562 public function entityCustomGroupWithSingleFieldCreate($function, $filename) {
1563 $params = ['title' => $function];
1564 $entity = substr(basename($filename), 0, strlen(basename($filename)) - 8);
1565 $params['extends'] = $entity ?
$entity : 'Contact';
1566 $customGroup = $this->customGroupCreate($params);
1567 $customField = $this->customFieldCreate(['custom_group_id' => $customGroup['id'], 'label' => $function]);
1568 CRM_Core_PseudoConstant
::flush();
1570 return ['custom_group_id' => $customGroup['id'], 'custom_field_id' => $customField['id']];
1574 * Create a custom group with a single text custom field, multi-select widget, with a variety of option values including upper and lower case.
1575 * See api_v3_SyntaxConformanceTest:testCustomDataGet for how to use this
1577 * @param string $function
1579 * @param string $filename
1583 * ids of created objects
1585 public function entityCustomGroupWithSingleStringMultiSelectFieldCreate($function, $filename) {
1586 $params = ['title' => $function];
1587 $entity = substr(basename($filename), 0, strlen(basename($filename)) - 8);
1588 $params['extends'] = $entity ?
$entity : 'Contact';
1589 $customGroup = $this->customGroupCreate($params);
1590 $customField = $this->customFieldCreate(['custom_group_id' => $customGroup['id'], 'label' => $function, 'html_type' => 'Multi-Select', 'default_value' => 1]);
1591 CRM_Core_PseudoConstant
::flush();
1593 'defaultValue' => 'Default Value',
1594 'lowercasevalue' => 'Lowercase Value',
1595 1 => 'Integer Value',
1598 $custom_field_params = ['sequential' => 1, 'id' => $customField['id']];
1599 $custom_field_api_result = $this->callAPISuccess('custom_field', 'get', $custom_field_params);
1600 $this->assertNotEmpty($custom_field_api_result['values'][0]['option_group_id']);
1601 $option_group_params = ['sequential' => 1, 'id' => $custom_field_api_result['values'][0]['option_group_id']];
1602 $option_group_result = $this->callAPISuccess('OptionGroup', 'get', $option_group_params);
1603 $this->assertNotEmpty($option_group_result['values'][0]['name']);
1604 foreach ($options as $option_value => $option_label) {
1605 $option_group_params = ['option_group_id' => $option_group_result['values'][0]['name'], 'value' => $option_value, 'label' => $option_label];
1606 $option_value_result = $this->callAPISuccess('OptionValue', 'create', $option_group_params);
1610 'custom_group_id' => $customGroup['id'],
1611 'custom_field_id' => $customField['id'],
1612 'custom_field_option_group_id' => $custom_field_api_result['values'][0]['option_group_id'],
1613 'custom_field_group_options' => $options,
1618 * Delete custom group.
1620 * @param int $customGroupID
1624 public function customGroupDelete($customGroupID) {
1625 $params['id'] = $customGroupID;
1626 return $this->callAPISuccess('custom_group', 'delete', $params);
1630 * Create custom field.
1632 * @param array $params
1633 * (custom_group_id) is required.
1637 public function customFieldCreate($params) {
1638 $params = array_merge([
1639 'label' => 'Custom Field',
1640 'data_type' => 'String',
1641 'html_type' => 'Text',
1642 'is_searchable' => 1,
1644 'default_value' => 'defaultValue',
1647 $result = $this->callAPISuccess('custom_field', 'create', $params);
1648 // these 2 functions are called with force to flush static caches
1649 CRM_Core_BAO_CustomField
::getTableColumnGroup($result['id'], 1);
1650 CRM_Core_Component
::getEnabledComponents(1);
1655 * Delete custom field.
1657 * @param int $customFieldID
1661 public function customFieldDelete($customFieldID) {
1663 $params['id'] = $customFieldID;
1664 return $this->callAPISuccess('custom_field', 'delete', $params);
1674 public function noteCreate($cId) {
1676 'entity_table' => 'civicrm_contact',
1677 'entity_id' => $cId,
1678 'note' => 'hello I am testing Note',
1679 'contact_id' => $cId,
1680 'modified_date' => date('Ymd'),
1681 'subject' => 'Test Note',
1684 return $this->callAPISuccess('Note', 'create', $params);
1688 * Enable CiviCampaign Component.
1690 * @param bool $reloadConfig
1691 * Force relaod config or not
1693 public function enableCiviCampaign($reloadConfig = TRUE) {
1694 CRM_Core_BAO_ConfigSetting
::enableComponent('CiviCampaign');
1695 if ($reloadConfig) {
1696 // force reload of config object
1697 $config = CRM_Core_Config
::singleton(TRUE, TRUE);
1699 //flush cache by calling with reset
1700 $activityTypes = CRM_Core_PseudoConstant
::activityType(TRUE, TRUE, TRUE, 'name', TRUE);
1704 * Create custom field with Option Values.
1706 * @param array $customGroup
1707 * @param string $name
1708 * Name of custom field.
1709 * @param array $extraParams
1710 * Additional parameters to pass through.
1714 public function customFieldOptionValueCreate($customGroup, $name, $extraParams = []) {
1716 'custom_group_id' => $customGroup['id'],
1717 'name' => 'test_custom_group',
1718 'label' => 'Country',
1719 'html_type' => 'Select',
1720 'data_type' => 'String',
1723 'is_searchable' => 0,
1729 'name' => 'option_group1',
1730 'label' => 'option_group_label1',
1734 'option_label' => ['Label1', 'Label2'],
1735 'option_value' => ['value1', 'value2'],
1736 'option_name' => [$name . '_1', $name . '_2'],
1737 'option_weight' => [1, 2],
1738 'option_status' => [1, 1],
1741 $params = array_merge($fieldParams, $optionGroup, $optionValue, $extraParams);
1743 return $this->callAPISuccess('custom_field', 'create', $params);
1751 public function confirmEntitiesDeleted($entities) {
1752 foreach ($entities as $entity) {
1754 $result = $this->callAPISuccess($entity, 'Get', []);
1755 if ($result['error'] == 1 ||
$result['count'] > 0) {
1756 // > than $entity[0] to allow a value to be passed in? e.g. domain?
1764 * Quick clean by emptying tables created for the test.
1766 * @param array $tablesToTruncate
1767 * @param bool $dropCustomValueTables
1769 * @throws \CRM_Core_Exception
1771 public function quickCleanup($tablesToTruncate, $dropCustomValueTables = FALSE) {
1773 throw new \
CRM_Core_Exception("CiviUnitTestCase: quickCleanup() is not compatible with useTransaction()");
1775 if ($dropCustomValueTables) {
1776 $optionGroupResult = CRM_Core_DAO
::executeQuery('SELECT option_group_id FROM civicrm_custom_field');
1777 while ($optionGroupResult->fetch()) {
1778 // We have a test that sets the option_group_id for a custom group to that of 'activity_type'.
1779 // Then test tearDown deletes it. This is all mildly terrifying but for the context here we can be pretty
1780 // sure the low-numbered (50 is arbitrary) option groups are not ones to 'just delete' in a
1781 // generic cleanup routine.
1782 if (!empty($optionGroupResult->option_group_id
) && $optionGroupResult->option_group_id
> 50) {
1783 CRM_Core_DAO
::executeQuery('DELETE FROM civicrm_option_group WHERE id = ' . $optionGroupResult->option_group_id
);
1786 $tablesToTruncate[] = 'civicrm_custom_group';
1787 $tablesToTruncate[] = 'civicrm_custom_field';
1790 $tablesToTruncate = array_unique(array_merge($this->_tablesToTruncate
, $tablesToTruncate));
1792 CRM_Core_DAO
::executeQuery("SET FOREIGN_KEY_CHECKS = 0;");
1793 foreach ($tablesToTruncate as $table) {
1794 $sql = "TRUNCATE TABLE $table";
1795 CRM_Core_DAO
::executeQuery($sql);
1797 CRM_Core_DAO
::executeQuery("SET FOREIGN_KEY_CHECKS = 1;");
1799 if ($dropCustomValueTables) {
1800 $dbName = self
::getDBName();
1802 SELECT TABLE_NAME as tableName
1803 FROM INFORMATION_SCHEMA.TABLES
1804 WHERE TABLE_SCHEMA = '{$dbName}'
1805 AND ( TABLE_NAME LIKE 'civicrm_value_%' )
1808 $tableDAO = CRM_Core_DAO
::executeQuery($query);
1809 while ($tableDAO->fetch()) {
1810 $sql = "DROP TABLE {$tableDAO->tableName}";
1811 CRM_Core_DAO
::executeQuery($sql);
1817 * Clean up financial entities after financial tests (so we remember to get all the tables :-))
1819 * @throws \CRM_Core_Exception
1821 public function quickCleanUpFinancialEntities() {
1822 $tablesToTruncate = [
1824 'civicrm_activity_contact',
1825 'civicrm_contribution',
1826 'civicrm_contribution_soft',
1827 'civicrm_contribution_product',
1828 'civicrm_financial_trxn',
1829 'civicrm_financial_item',
1830 'civicrm_contribution_recur',
1831 'civicrm_line_item',
1832 'civicrm_contribution_page',
1833 'civicrm_payment_processor',
1834 'civicrm_entity_financial_trxn',
1835 'civicrm_membership',
1836 'civicrm_membership_type',
1837 'civicrm_membership_payment',
1838 'civicrm_membership_log',
1839 'civicrm_membership_block',
1841 'civicrm_participant',
1842 'civicrm_participant_payment',
1844 'civicrm_pledge_block',
1845 'civicrm_pledge_payment',
1846 'civicrm_price_set_entity',
1847 'civicrm_price_field_value',
1848 'civicrm_price_field',
1850 $this->quickCleanup($tablesToTruncate);
1851 CRM_Core_DAO
::executeQuery("DELETE FROM civicrm_membership_status WHERE name NOT IN('New', 'Current', 'Grace', 'Expired', 'Pending', 'Cancelled', 'Deceased')");
1852 $this->restoreDefaultPriceSetConfig();
1853 $this->disableTaxAndInvoicing();
1854 $this->setCurrencySeparators(',');
1855 CRM_Core_PseudoConstant
::flush('taxRates');
1856 System
::singleton()->flushProcessors();
1857 // @fixme this parameter is leaking - it should not be defined as a class static
1858 // but for now we just handle in tear down.
1859 CRM_Contribute_BAO_Query
::$_contribOrSoftCredit = 'only contribs';
1863 * Reset the price set config so results exist.
1865 public function restoreDefaultPriceSetConfig() {
1866 CRM_Core_DAO
::executeQuery("DELETE FROM civicrm_price_set WHERE name NOT IN('default_contribution_amount', 'default_membership_type_amount')");
1867 CRM_Core_DAO
::executeQuery("UPDATE civicrm_price_set SET id = 1 WHERE name ='default_contribution_amount'");
1868 CRM_Core_DAO
::executeQuery("INSERT INTO `civicrm_price_field` (`id`, `price_set_id`, `name`, `label`, `html_type`, `is_enter_qty`, `help_pre`, `help_post`, `weight`, `is_display_amounts`, `options_per_line`, `is_active`, `is_required`, `active_on`, `expire_on`, `javascript`, `visibility_id`) VALUES (1, 1, 'contribution_amount', 'Contribution Amount', 'Text', 0, NULL, NULL, 1, 1, 1, 1, 1, NULL, NULL, NULL, 1)");
1869 CRM_Core_DAO
::executeQuery("INSERT INTO `civicrm_price_field_value` (`id`, `price_field_id`, `name`, `label`, `description`, `amount`, `count`, `max_value`, `weight`, `membership_type_id`, `membership_num_terms`, `is_default`, `is_active`, `financial_type_id`, `non_deductible_amount`) VALUES (1, 1, 'contribution_amount', 'Contribution Amount', NULL, '1', NULL, NULL, 1, NULL, NULL, 0, 1, 1, 0.00)");
1873 * Recreate default membership types.
1875 public function restoreMembershipTypes() {
1876 CRM_Core_DAO
::executeQuery(
1877 "REPLACE INTO civicrm_membership_type
1878 (id, domain_id, name, description, member_of_contact_id, financial_type_id, minimum_fee, duration_unit, duration_interval, period_type, fixed_period_start_day, fixed_period_rollover_day, relationship_type_id, relationship_direction, visibility, weight, is_active)
1880 (1, 1, 'General', 'Regular annual membership.', 1, 2, 100.00, 'year', 2, 'rolling', NULL, NULL, 7, 'b_a', 'Public', 1, 1),
1881 (2, 1, 'Student', 'Discount membership for full-time students.', 1, 2, 50.00, 'year', 1, 'rolling', NULL, NULL, NULL, NULL, 'Public', 2, 1),
1882 (3, 1, 'Lifetime', 'Lifetime membership.', 1, 2, 1200.00, 'lifetime', 1, 'rolling', NULL, NULL, 7, 'b_a', 'Admin', 3, 1);
1887 * Function does a 'Get' on the entity & compares the fields in the Params with those returned
1888 * Default behaviour is to also delete the entity
1889 * @param array $params
1890 * Params array to check against.
1892 * Id of the entity concerned.
1893 * @param string $entity
1894 * Name of entity concerned (e.g. membership).
1895 * @param bool $delete
1896 * Should the entity be deleted as part of this check.
1897 * @param string $errorText
1898 * Text to print on error.
1902 * @param array $params
1905 * @param int $delete
1906 * @param string $errorText
1908 * @throws CRM_Core_Exception
1910 public function getAndCheck($params, $id, $entity, $delete = 1, $errorText = '') {
1912 $result = $this->callAPISuccessGetSingle($entity, [
1917 $this->callAPISuccess($entity, 'Delete', [
1921 $dateFields = $keys = $dateTimeFields = [];
1922 $fields = $this->callAPISuccess($entity, 'getfields', ['version' => 3, 'action' => 'get']);
1923 foreach ($fields['values'] as $field => $settings) {
1924 if (array_key_exists($field, $result)) {
1925 $keys[CRM_Utils_Array
::value('name', $settings, $field)] = $field;
1928 $keys[CRM_Utils_Array
::value('name', $settings, $field)] = CRM_Utils_Array
::value('name', $settings, $field);
1930 $type = CRM_Utils_Array
::value('type', $settings);
1931 if ($type == CRM_Utils_Type
::T_DATE
) {
1932 $dateFields[] = $settings['name'];
1933 // we should identify both real names & unique names as dates
1934 if ($field != $settings['name']) {
1935 $dateFields[] = $field;
1938 if ($type == CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
) {
1939 $dateTimeFields[] = $settings['name'];
1940 // we should identify both real names & unique names as dates
1941 if ($field != $settings['name']) {
1942 $dateTimeFields[] = $field;
1947 if (strtolower($entity) == 'contribution') {
1948 $params['receive_date'] = date('Y-m-d', strtotime($params['receive_date']));
1949 // this is not returned in id format
1950 unset($params['payment_instrument_id']);
1951 $params['contribution_source'] = $params['source'];
1952 unset($params['source']);
1955 foreach ($params as $key => $value) {
1956 if ($key == 'version' ||
substr($key, 0, 3) == 'api' ||
!array_key_exists($keys[$key], $result)) {
1959 if (in_array($key, $dateFields)) {
1960 $value = date('Y-m-d', strtotime($value));
1961 $result[$key] = date('Y-m-d', strtotime($result[$key]));
1963 if (in_array($key, $dateTimeFields)) {
1964 $value = date('Y-m-d H:i:s', strtotime($value));
1965 $result[$keys[$key]] = date('Y-m-d H:i:s', strtotime(CRM_Utils_Array
::value($keys[$key], $result, CRM_Utils_Array
::value($key, $result))));
1967 $this->assertEquals($value, $result[$keys[$key]], $key . " GetandCheck function determines that for key {$key} value: $value doesn't match " . print_r($result[$keys[$key]], TRUE) . $errorText);
1972 * Get formatted values in the actual and expected result.
1974 * @param array $actual
1975 * Actual calculated values.
1976 * @param array $expected
1979 public function checkArrayEquals(&$actual, &$expected) {
1980 self
::unsetId($actual);
1981 self
::unsetId($expected);
1982 $this->assertEquals($expected, $actual);
1986 * Unset the key 'id' from the array
1988 * @param array $unformattedArray
1989 * The array from which the 'id' has to be unset.
1991 public static function unsetId(&$unformattedArray) {
1992 $formattedArray = [];
1993 if (array_key_exists('id', $unformattedArray)) {
1994 unset($unformattedArray['id']);
1996 if (!empty($unformattedArray['values']) && is_array($unformattedArray['values'])) {
1997 foreach ($unformattedArray['values'] as $key => $value) {
1998 if (is_array($value)) {
1999 foreach ($value as $k => $v) {
2005 elseif ($key == 'id') {
2006 $unformattedArray[$key];
2008 $formattedArray = [$value];
2010 $unformattedArray['values'] = $formattedArray;
2015 * Helper to enable/disable custom directory support
2017 * @param array $customDirs
2019 * 'php_path' Set to TRUE to use the default, FALSE or "" to disable support, or a string path to use another path
2020 * 'template_path' Set to TRUE to use the default, FALSE or "" to disable support, or a string path to use another path
2022 public function customDirectories($customDirs) {
2023 $config = CRM_Core_Config
::singleton();
2025 if (empty($customDirs['php_path']) ||
$customDirs['php_path'] === FALSE) {
2026 unset($config->customPHPPathDir
);
2028 elseif ($customDirs['php_path'] === TRUE) {
2029 $config->customPHPPathDir
= dirname(dirname(__FILE__
)) . '/custom_directories/php/';
2032 $config->customPHPPathDir
= $php_path;
2035 if (empty($customDirs['template_path']) ||
$customDirs['template_path'] === FALSE) {
2036 unset($config->customTemplateDir
);
2038 elseif ($customDirs['template_path'] === TRUE) {
2039 $config->customTemplateDir
= dirname(dirname(__FILE__
)) . '/custom_directories/templates/';
2042 $config->customTemplateDir
= $template_path;
2047 * Generate a temporary folder.
2049 * @param string $prefix
2053 public function createTempDir($prefix = 'test-') {
2054 $tempDir = CRM_Utils_File
::tempdir($prefix);
2055 $this->tempDirs
[] = $tempDir;
2059 public function cleanTempDirs() {
2060 if (!is_array($this->tempDirs
)) {
2061 // fix test errors where this is not set
2064 foreach ($this->tempDirs
as $tempDir) {
2065 if (is_dir($tempDir)) {
2066 CRM_Utils_File
::cleanDir($tempDir, TRUE, FALSE);
2072 * Temporarily replace the singleton extension with a different one.
2074 * @param \CRM_Extension_System $system
2076 public function setExtensionSystem(CRM_Extension_System
$system) {
2077 if ($this->origExtensionSystem
== NULL) {
2078 $this->origExtensionSystem
= CRM_Extension_System
::singleton();
2080 CRM_Extension_System
::setSingleton($this->origExtensionSystem
);
2083 public function unsetExtensionSystem() {
2084 if ($this->origExtensionSystem
!== NULL) {
2085 CRM_Extension_System
::setSingleton($this->origExtensionSystem
);
2086 $this->origExtensionSystem
= NULL;
2091 * Temporarily alter the settings-metadata to add a mock setting.
2093 * WARNING: The setting metadata will disappear on the next cache-clear.
2099 public function setMockSettingsMetaData($extras) {
2100 CRM_Utils_Hook
::singleton()
2101 ->setHook('civicrm_alterSettingsMetaData', function (&$metadata, $domainId, $profile) use ($extras) {
2102 $metadata = array_merge($metadata, $extras);
2105 Civi
::service('settings_manager')->flush();
2107 $fields = $this->callAPISuccess('setting', 'getfields', []);
2108 foreach ($extras as $key => $spec) {
2109 $this->assertNotEmpty($spec['title']);
2110 $this->assertEquals($spec['title'], $fields['values'][$key]['title']);
2115 * @param string $name
2117 public function financialAccountDelete($name) {
2118 $financialAccount = new CRM_Financial_DAO_FinancialAccount();
2119 $financialAccount->name
= $name;
2120 if ($financialAccount->find(TRUE)) {
2121 $entityFinancialType = new CRM_Financial_DAO_EntityFinancialAccount();
2122 $entityFinancialType->financial_account_id
= $financialAccount->id
;
2123 $entityFinancialType->delete();
2124 $financialAccount->delete();
2129 * FIXME: something NULLs $GLOBALS['_HTML_QuickForm_registered_rules'] when the tests are ran all together
2130 * (NB unclear if this is still required)
2132 public function _sethtmlGlobals() {
2133 $GLOBALS['_HTML_QuickForm_registered_rules'] = [
2135 'html_quickform_rule_required',
2136 'HTML/QuickForm/Rule/Required.php',
2139 'html_quickform_rule_range',
2140 'HTML/QuickForm/Rule/Range.php',
2143 'html_quickform_rule_range',
2144 'HTML/QuickForm/Rule/Range.php',
2147 'html_quickform_rule_range',
2148 'HTML/QuickForm/Rule/Range.php',
2151 'html_quickform_rule_email',
2152 'HTML/QuickForm/Rule/Email.php',
2155 'html_quickform_rule_regex',
2156 'HTML/QuickForm/Rule/Regex.php',
2159 'html_quickform_rule_regex',
2160 'HTML/QuickForm/Rule/Regex.php',
2163 'html_quickform_rule_regex',
2164 'HTML/QuickForm/Rule/Regex.php',
2167 'html_quickform_rule_regex',
2168 'HTML/QuickForm/Rule/Regex.php',
2170 'nopunctuation' => [
2171 'html_quickform_rule_regex',
2172 'HTML/QuickForm/Rule/Regex.php',
2175 'html_quickform_rule_regex',
2176 'HTML/QuickForm/Rule/Regex.php',
2179 'html_quickform_rule_callback',
2180 'HTML/QuickForm/Rule/Callback.php',
2183 'html_quickform_rule_compare',
2184 'HTML/QuickForm/Rule/Compare.php',
2187 // FIXME: …ditto for $GLOBALS['HTML_QUICKFORM_ELEMENT_TYPES']
2188 $GLOBALS['HTML_QUICKFORM_ELEMENT_TYPES'] = [
2190 'HTML/QuickForm/group.php',
2191 'HTML_QuickForm_group',
2194 'HTML/QuickForm/hidden.php',
2195 'HTML_QuickForm_hidden',
2198 'HTML/QuickForm/reset.php',
2199 'HTML_QuickForm_reset',
2202 'HTML/QuickForm/checkbox.php',
2203 'HTML_QuickForm_checkbox',
2206 'HTML/QuickForm/file.php',
2207 'HTML_QuickForm_file',
2210 'HTML/QuickForm/image.php',
2211 'HTML_QuickForm_image',
2214 'HTML/QuickForm/password.php',
2215 'HTML_QuickForm_password',
2218 'HTML/QuickForm/radio.php',
2219 'HTML_QuickForm_radio',
2222 'HTML/QuickForm/button.php',
2223 'HTML_QuickForm_button',
2226 'HTML/QuickForm/submit.php',
2227 'HTML_QuickForm_submit',
2230 'HTML/QuickForm/select.php',
2231 'HTML_QuickForm_select',
2234 'HTML/QuickForm/hiddenselect.php',
2235 'HTML_QuickForm_hiddenselect',
2238 'HTML/QuickForm/text.php',
2239 'HTML_QuickForm_text',
2242 'HTML/QuickForm/textarea.php',
2243 'HTML_QuickForm_textarea',
2246 'HTML/QuickForm/fckeditor.php',
2247 'HTML_QuickForm_FCKEditor',
2250 'HTML/QuickForm/tinymce.php',
2251 'HTML_QuickForm_TinyMCE',
2254 'HTML/QuickForm/dojoeditor.php',
2255 'HTML_QuickForm_dojoeditor',
2258 'HTML/QuickForm/link.php',
2259 'HTML_QuickForm_link',
2262 'HTML/QuickForm/advcheckbox.php',
2263 'HTML_QuickForm_advcheckbox',
2266 'HTML/QuickForm/date.php',
2267 'HTML_QuickForm_date',
2270 'HTML/QuickForm/static.php',
2271 'HTML_QuickForm_static',
2274 'HTML/QuickForm/header.php',
2275 'HTML_QuickForm_header',
2278 'HTML/QuickForm/html.php',
2279 'HTML_QuickForm_html',
2282 'HTML/QuickForm/hierselect.php',
2283 'HTML_QuickForm_hierselect',
2286 'HTML/QuickForm/autocomplete.php',
2287 'HTML_QuickForm_autocomplete',
2290 'HTML/QuickForm/xbutton.php',
2291 'HTML_QuickForm_xbutton',
2293 'advmultiselect' => [
2294 'HTML/QuickForm/advmultiselect.php',
2295 'HTML_QuickForm_advmultiselect',
2301 * Set up an acl allowing contact to see 2 specified groups
2302 * - $this->_permissionedGroup & $this->_permissionedDisabledGroup
2304 * You need to have pre-created these groups & created the user e.g
2305 * $this->createLoggedInUser();
2306 * $this->_permissionedDisabledGroup = $this->groupCreate(array('title' => 'pick-me-disabled', 'is_active' => 0, 'name' => 'pick-me-disabled'));
2307 * $this->_permissionedGroup = $this->groupCreate(array('title' => 'pick-me-active', 'is_active' => 1, 'name' => 'pick-me-active'));
2309 * @param bool $isProfile
2311 public function setupACL($isProfile = FALSE) {
2313 $_REQUEST = $this->_params
;
2315 CRM_Core_Config
::singleton()->userPermissionClass
->permissions
= ['access CiviCRM'];
2316 $optionGroupID = $this->callAPISuccessGetValue('option_group', ['return' => 'id', 'name' => 'acl_role']);
2317 $ov = new CRM_Core_DAO_OptionValue();
2318 $ov->option_group_id
= $optionGroupID;
2320 if ($ov->find(TRUE)) {
2321 CRM_Core_DAO
::executeQuery("DELETE FROM civicrm_option_value WHERE id = {$ov->id}");
2323 $optionValue = $this->callAPISuccess('option_value', 'create', [
2324 'option_group_id' => $optionGroupID,
2325 'label' => 'pick me',
2329 CRM_Core_DAO
::executeQuery("
2330 TRUNCATE civicrm_acl_cache
2333 CRM_Core_DAO
::executeQuery("
2334 TRUNCATE civicrm_acl_contact_cache
2337 CRM_Core_DAO
::executeQuery("
2338 INSERT INTO civicrm_acl_entity_role (
2339 `acl_role_id`, `entity_table`, `entity_id`, `is_active`
2340 ) VALUES (55, 'civicrm_group', {$this->_permissionedGroup}, 1);
2344 CRM_Core_DAO
::executeQuery("
2345 INSERT INTO civicrm_acl (
2346 `name`, `entity_table`, `entity_id`, `operation`, `object_table`, `object_id`, `is_active`
2349 'view picked', 'civicrm_acl_role', 55, 'Edit', 'civicrm_uf_group', 0, 1
2354 CRM_Core_DAO
::executeQuery("
2355 INSERT INTO civicrm_acl (
2356 `name`, `entity_table`, `entity_id`, `operation`, `object_table`, `object_id`, `is_active`
2359 'view picked', 'civicrm_group', $this->_permissionedGroup , 'Edit', 'civicrm_saved_search', {$this->_permissionedGroup}, 1
2363 CRM_Core_DAO
::executeQuery("
2364 INSERT INTO civicrm_acl (
2365 `name`, `entity_table`, `entity_id`, `operation`, `object_table`, `object_id`, `is_active`
2368 'view picked', 'civicrm_group', $this->_permissionedGroup, 'Edit', 'civicrm_saved_search', {$this->_permissionedDisabledGroup}, 1
2373 $this->_loggedInUser
= CRM_Core_Session
::singleton()->get('userID');
2374 $this->callAPISuccess('group_contact', 'create', [
2375 'group_id' => $this->_permissionedGroup
,
2376 'contact_id' => $this->_loggedInUser
,
2381 CRM_ACL_BAO_Cache
::resetCache();
2382 CRM_ACL_API
::groupPermission('whatever', 9999, NULL, 'civicrm_saved_search', NULL, NULL);
2387 * Alter default price set so that the field numbers are not all 1 (hiding errors)
2389 public function offsetDefaultPriceSet() {
2390 $contributionPriceSet = $this->callAPISuccess('price_set', 'getsingle', ['name' => 'default_contribution_amount']);
2391 $firstID = $contributionPriceSet['id'];
2392 $this->callAPISuccess('price_set', 'create', [
2393 'id' => $contributionPriceSet['id'],
2397 unset($contributionPriceSet['id']);
2398 $newPriceSet = $this->callAPISuccess('price_set', 'create', $contributionPriceSet);
2399 $priceField = $this->callAPISuccess('price_field', 'getsingle', [
2400 'price_set_id' => $firstID,
2401 'options' => ['limit' => 1],
2403 unset($priceField['id']);
2404 $priceField['price_set_id'] = $newPriceSet['id'];
2405 $newPriceField = $this->callAPISuccess('price_field', 'create', $priceField);
2406 $priceFieldValue = $this->callAPISuccess('price_field_value', 'getsingle', [
2407 'price_set_id' => $firstID,
2409 'options' => ['limit' => 1],
2412 unset($priceFieldValue['id']);
2413 //create some padding to use up ids
2414 $this->callAPISuccess('price_field_value', 'create', $priceFieldValue);
2415 $this->callAPISuccess('price_field_value', 'create', $priceFieldValue);
2416 $this->callAPISuccess('price_field_value', 'create', array_merge($priceFieldValue, ['price_field_id' => $newPriceField['id']]));
2420 * Create an instance of the paypal processor.
2422 * @todo this isn't a great place to put it - but really it belongs on a class that extends
2423 * this parent class & we don't have a structure for that yet
2424 * There is another function to this effect on the PaypalPro test but it appears to be silently failing
2425 * & the best protection against that is the functions this class affords
2427 * @param array $params
2429 * @return int $result['id'] payment processor id
2431 public function paymentProcessorCreate($params = []) {
2432 $params = array_merge([
2434 'domain_id' => CRM_Core_Config
::domainID(),
2435 'payment_processor_type_id' => 'PayPal',
2439 'user_name' => 'sunil._1183377782_biz_api1.webaccess.co.in',
2440 'password' => '1183377788',
2441 'signature' => 'APixCoQ-Zsaj-u3IH7mD5Do-7HUqA9loGnLSzsZga9Zr-aNmaJa3WGPH',
2442 'url_site' => 'https://www.sandbox.paypal.com/',
2443 'url_api' => 'https://api-3t.sandbox.paypal.com/',
2444 'url_button' => 'https://www.paypal.com/en_US/i/btn/btn_xpressCheckout.gif',
2445 'class_name' => 'Payment_PayPalImpl',
2446 'billing_mode' => 3,
2447 'financial_type_id' => 1,
2448 'financial_account_id' => 12,
2449 // Credit card = 1 so can pass 'by accident'.
2450 'payment_instrument_id' => 'Debit Card',
2452 if (!is_numeric($params['payment_processor_type_id'])) {
2453 // really the api should handle this through getoptions but it's not exactly api call so lets just sort it
2455 $params['payment_processor_type_id'] = $this->callAPISuccess('payment_processor_type', 'getvalue', [
2456 'name' => $params['payment_processor_type_id'],
2460 $result = $this->callAPISuccess('payment_processor', 'create', $params);
2461 return $result['id'];
2465 * Set up initial recurring payment allowing subsequent IPN payments.
2467 * @param array $recurParams (Optional)
2468 * @param array $contributionParams (Optional)
2470 * @throws \CRM_Core_Exception
2472 public function setupRecurringPaymentProcessorTransaction($recurParams = [], $contributionParams = []) {
2473 $contributionParams = array_merge([
2474 'total_amount' => '200',
2475 'invoice_id' => $this->_invoiceID
,
2476 'financial_type_id' => 'Donation',
2477 'contribution_status_id' => 'Pending',
2478 'contact_id' => $this->_contactID
,
2479 'contribution_page_id' => $this->_contributionPageID
,
2480 'payment_processor_id' => $this->_paymentProcessorID
,
2482 'receive_date' => '2019-07-25 07:34:23',
2483 'skipCleanMoney' => TRUE,
2484 ], $contributionParams);
2485 $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array_merge([
2486 'contact_id' => $this->_contactID
,
2489 'installments' => 5,
2490 'frequency_unit' => 'Month',
2491 'frequency_interval' => 1,
2492 'invoice_id' => $this->_invoiceID
,
2493 'contribution_status_id' => 2,
2494 'payment_processor_id' => $this->_paymentProcessorID
,
2495 // processor provided ID - use contact ID as proxy.
2496 'processor_id' => $this->_contactID
,
2497 'api.Order.create' => $contributionParams,
2498 ], $recurParams))['values'][0];
2499 $this->_contributionRecurID
= $contributionRecur['id'];
2500 $this->_contributionID
= $contributionRecur['api.Order.create']['id'];
2501 $this->ids
['Contribution'][0] = $this->_contributionID
;
2505 * We don't have a good way to set up a recurring contribution with a membership so let's just do one then alter it
2507 * @param array $params Optionally modify params for membership/recur (duration_unit/frequency_unit)
2509 * @throws \CRM_Core_Exception
2511 public function setupMembershipRecurringPaymentProcessorTransaction($params = []) {
2512 $membershipParams = $recurParams = [];
2513 if (!empty($params['duration_unit'])) {
2514 $membershipParams['duration_unit'] = $params['duration_unit'];
2516 if (!empty($params['frequency_unit'])) {
2517 $recurParams['frequency_unit'] = $params['frequency_unit'];
2520 $this->ids
['membership_type'] = $this->membershipTypeCreate($membershipParams);
2521 //create a contribution so our membership & contribution don't both have id = 1
2522 if ($this->callAPISuccess('Contribution', 'getcount', []) === 0) {
2523 $this->contributionCreate([
2524 'contact_id' => $this->_contactID
,
2526 'financial_type_id' => 1,
2527 'invoice_id' => 'abcd',
2529 'receive_date' => '2019-07-25 07:34:23',
2533 $this->ids
['membership'] = $this->callAPISuccess('Membership', 'create', [
2534 'contact_id' => $this->_contactID
,
2535 'membership_type_id' => $this->ids
['membership_type'],
2536 'format.only_id' => TRUE,
2537 'source' => 'Payment',
2538 'skipLineItem' => TRUE,
2540 $this->setupRecurringPaymentProcessorTransaction($recurParams, [
2545 'entity_table' => 'civicrm_membership',
2546 'entity_id' => $this->ids
['membership'],
2547 'label' => 'General',
2549 'unit_price' => 200,
2550 'line_total' => 200,
2551 'financial_type_id' => 1,
2552 'price_field_id' => $this->callAPISuccess('price_field', 'getvalue', [
2554 'label' => 'Membership Amount',
2555 'options' => ['limit' => 1, 'sort' => 'id DESC'],
2557 'price_field_value_id' => $this->callAPISuccess('price_field_value', 'getvalue', [
2559 'label' => 'General',
2560 'options' => ['limit' => 1, 'sort' => 'id DESC'],
2567 $this->callAPISuccess('Membership', 'create', ['id' => $this->ids
['membership'], 'contribution_recur_id' => $this->_contributionRecurID
]);
2575 public function CiviUnitTestCase_fatalErrorHandler($message) {
2576 throw new Exception("{$message['message']}: {$message['code']}");
2580 * Wrap the entire test case in a transaction.
2582 * Only subsequent DB statements will be wrapped in TX -- this cannot
2583 * retroactively wrap old DB statements. Therefore, it makes sense to
2584 * call this at the beginning of setUp().
2586 * Note: Recall that TRUNCATE and ALTER will force-commit transactions, so
2587 * this option does not work with, e.g., custom-data.
2589 * WISHLIST: Monitor SQL queries in unit-tests and generate an exception
2590 * if TRUNCATE or ALTER is called while using a transaction.
2593 * Whether to use nesting or reference-counting.
2595 public function useTransaction($nest = TRUE) {
2597 $this->tx
= new CRM_Core_Transaction($nest);
2598 $this->tx
->rollback();
2603 * Assert the attachment exists.
2605 * @param bool $exists
2606 * @param array $apiResult
2608 protected function assertAttachmentExistence($exists, $apiResult) {
2609 $fileId = $apiResult['id'];
2610 $this->assertTrue(is_numeric($fileId));
2611 $this->assertEquals($exists, file_exists($apiResult['values'][$fileId]['path']));
2612 $this->assertDBQuery($exists ?
1 : 0, 'SELECT count(*) FROM civicrm_file WHERE id = %1', [
2613 1 => [$fileId, 'Int'],
2615 $this->assertDBQuery($exists ?
1 : 0, 'SELECT count(*) FROM civicrm_entity_file WHERE id = %1', [
2616 1 => [$fileId, 'Int'],
2621 * Assert 2 sql strings are the same, ignoring double spaces.
2623 * @param string $expectedSQL
2624 * @param string $actualSQL
2625 * @param string $message
2627 protected function assertLike($expectedSQL, $actualSQL, $message = 'different sql') {
2628 $expected = trim((preg_replace('/[ \r\n\t]+/', ' ', $expectedSQL)));
2629 $actual = trim((preg_replace('/[ \r\n\t]+/', ' ', $actualSQL)));
2630 $this->assertEquals($expected, $actual, $message);
2634 * Create a price set for an event.
2636 * @param int $feeTotal
2637 * @param int $minAmt
2638 * @param string $type
2640 * @param array $options
2644 * @throws \CRM_Core_Exception
2646 protected function eventPriceSetCreate($feeTotal, $minAmt = 0, $type = 'Text', $options = [['name' => 'hundy', 'amount' => 100]]) {
2647 // creating price set, price field
2648 $paramsSet['title'] = 'Price Set';
2649 $paramsSet['name'] = CRM_Utils_String
::titleToVar('Price Set');
2650 $paramsSet['is_active'] = FALSE;
2651 $paramsSet['extends'] = 1;
2652 $paramsSet['min_amount'] = $minAmt;
2654 $priceSet = CRM_Price_BAO_PriceSet
::create($paramsSet);
2655 $this->_ids
['price_set'] = $priceSet->id
;
2658 'label' => 'Price Field',
2659 'name' => CRM_Utils_String
::titleToVar('Price Field'),
2660 'html_type' => $type,
2661 'price' => $feeTotal,
2662 'option_label' => ['1' => 'Price Field'],
2663 'option_value' => ['1' => $feeTotal],
2664 'option_name' => ['1' => $feeTotal],
2665 'option_weight' => ['1' => 1],
2666 'option_amount' => ['1' => 1],
2667 'is_display_amounts' => 1,
2669 'options_per_line' => 1,
2670 'is_active' => ['1' => 1],
2671 'price_set_id' => $this->_ids
['price_set'],
2672 'is_enter_qty' => 1,
2673 'financial_type_id' => $this->getFinancialTypeId('Event Fee'),
2675 if ($type === 'Radio') {
2676 foreach ($options as $index => $option) {
2677 $paramsField['is_enter_qty'] = 0;
2678 $optionID = $index +
2;
2679 $paramsField['option_value'][$optionID] = $paramsField['option_weight'][$optionID] = $paramsField['option_amount'][$optionID] = $option['amount'];
2680 $paramsField['option_label'][$optionID] = $paramsField['option_name'][$optionID] = $option['name'];
2684 $this->callAPISuccess('PriceField', 'create', $paramsField);
2685 $fields = $this->callAPISuccess('PriceField', 'get', ['price_set_id' => $this->_ids
['price_set']]);
2686 $this->_ids
['price_field'] = array_keys($fields['values']);
2687 $fieldValues = $this->callAPISuccess('PriceFieldValue', 'get', ['price_field_id' => $this->_ids
['price_field'][0]]);
2688 $this->_ids
['price_field_value'] = array_keys($fieldValues['values']);
2690 return $this->_ids
['price_set'];
2694 * Add a profile to a contribution page.
2696 * @param string $name
2697 * @param int $contributionPageID
2698 * @param string $module
2700 protected function addProfile($name, $contributionPageID, $module = 'CiviContribute') {
2702 'uf_group_id' => $name,
2703 'module' => $module,
2704 'entity_table' => 'civicrm_contribution_page',
2705 'entity_id' => $contributionPageID,
2708 if ($module !== 'CiviContribute') {
2709 $params['module_data'] = [$module => []];
2711 $this->callAPISuccess('UFJoin', 'create', $params);
2715 * Add participant with contribution
2719 * @throws \CRM_Core_Exception
2721 protected function createPartiallyPaidParticipantOrder() {
2722 $orderParams = $this->getParticipantOrderParams();
2723 $orderParams['api.Payment.create'] = ['total_amount' => 150];
2724 return $this->callAPISuccess('Order', 'create', $orderParams);
2730 * @param string $component
2731 * @param int $componentId
2732 * @param array $priceFieldOptions
2736 protected function createPriceSet($component = 'contribution_page', $componentId = NULL, $priceFieldOptions = []) {
2737 $paramsSet['title'] = 'Price Set' . substr(sha1(rand()), 0, 7);
2738 $paramsSet['name'] = CRM_Utils_String
::titleToVar($paramsSet['title']);
2739 $paramsSet['is_active'] = TRUE;
2740 $paramsSet['financial_type_id'] = 'Event Fee';
2741 $paramsSet['extends'] = 1;
2742 $priceSet = $this->callAPISuccess('price_set', 'create', $paramsSet);
2743 $priceSetId = $priceSet['id'];
2744 //Checking for priceset added in the table.
2745 $this->assertDBCompareValue('CRM_Price_BAO_PriceSet', $priceSetId, 'title',
2746 'id', $paramsSet['title'], 'Check DB for created priceset'
2748 $paramsField = array_merge([
2749 'label' => 'Price Field',
2750 'name' => CRM_Utils_String
::titleToVar('Price Field'),
2751 'html_type' => 'CheckBox',
2752 'option_label' => ['1' => 'Price Field 1', '2' => 'Price Field 2'],
2753 'option_value' => ['1' => 100, '2' => 200],
2754 'option_name' => ['1' => 'Price Field 1', '2' => 'Price Field 2'],
2755 'option_weight' => ['1' => 1, '2' => 2],
2756 'option_amount' => ['1' => 100, '2' => 200],
2757 'is_display_amounts' => 1,
2759 'options_per_line' => 1,
2760 'is_active' => ['1' => 1, '2' => 1],
2761 'price_set_id' => $priceSet['id'],
2762 'is_enter_qty' => 1,
2763 'financial_type_id' => $this->getFinancialTypeId('Event Fee'),
2764 ], $priceFieldOptions);
2766 $priceField = CRM_Price_BAO_PriceField
::create($paramsField);
2768 CRM_Price_BAO_PriceSet
::addTo('civicrm_' . $component, $componentId, $priceSetId);
2770 return $this->callAPISuccess('PriceFieldValue', 'get', ['price_field_id' => $priceField->id
]);
2774 * Replace the template with a test-oriented template designed to show all the variables.
2776 * @param string $templateName
2777 * @param string $type
2779 protected function swapMessageTemplateForTestTemplate($templateName = 'contribution_online_receipt', $type = 'html') {
2780 $testTemplate = file_get_contents(__DIR__
. '/../../templates/message_templates/' . $templateName . '_' . $type . '.tpl');
2781 CRM_Core_DAO
::executeQuery(
2782 "UPDATE civicrm_option_group og
2783 LEFT JOIN civicrm_option_value ov ON ov.option_group_id = og.id
2784 LEFT JOIN civicrm_msg_template m ON m.workflow_id = ov.id
2785 SET m.msg_{$type} = %1
2786 WHERE og.name LIKE 'msg_tpl_workflow_%'
2787 AND ov.name = '{$templateName}'
2788 AND m.is_default = 1", [1 => [$testTemplate, 'String']]
2793 * Reinstate the default template.
2795 * @param string $templateName
2796 * @param string $type
2798 protected function revertTemplateToReservedTemplate($templateName = 'contribution_online_receipt', $type = 'html') {
2799 CRM_Core_DAO
::executeQuery(
2800 "UPDATE civicrm_option_group og
2801 LEFT JOIN civicrm_option_value ov ON ov.option_group_id = og.id
2802 LEFT JOIN civicrm_msg_template m ON m.workflow_id = ov.id
2803 LEFT JOIN civicrm_msg_template m2 ON m2.workflow_id = ov.id AND m2.is_reserved = 1
2804 SET m.msg_{$type} = m2.msg_{$type}
2805 WHERE og.name = 'msg_tpl_workflow_contribution'
2806 AND ov.name = '{$templateName}'
2807 AND m.is_default = 1"
2812 * Flush statics relating to financial type.
2814 protected function flushFinancialTypeStatics() {
2815 if (isset(\Civi
::$statics['CRM_Financial_BAO_FinancialType'])) {
2816 unset(\Civi
::$statics['CRM_Financial_BAO_FinancialType']);
2818 if (isset(\Civi
::$statics['CRM_Contribute_PseudoConstant'])) {
2819 unset(\Civi
::$statics['CRM_Contribute_PseudoConstant']);
2821 CRM_Contribute_PseudoConstant
::flush('financialType');
2822 CRM_Contribute_PseudoConstant
::flush('membershipType');
2823 // Pseudoconstants may be saved to the cache table.
2824 CRM_Core_DAO
::executeQuery("TRUNCATE civicrm_cache");
2825 CRM_Financial_BAO_FinancialType
::$_statusACLFt = [];
2826 CRM_Financial_BAO_FinancialType
::$_availableFinancialTypes = NULL;
2830 * Set the permissions to the supplied array.
2832 * @param array $permissions
2834 protected function setPermissions($permissions) {
2835 CRM_Core_Config
::singleton()->userPermissionClass
->permissions
= $permissions;
2836 $this->flushFinancialTypeStatics();
2840 * @param array $params
2843 public function _checkFinancialRecords($params, $context) {
2845 'entity_id' => $params['id'],
2846 'entity_table' => 'civicrm_contribution',
2848 $contribution = $this->callAPISuccess('contribution', 'getsingle', ['id' => $params['id']]);
2849 $this->assertEquals($contribution['total_amount'] - $contribution['fee_amount'], $contribution['net_amount']);
2850 if ($context == 'pending') {
2851 $trxn = CRM_Financial_BAO_FinancialItem
::retrieveEntityFinancialTrxn($entityParams);
2852 $this->assertNull($trxn, 'No Trxn to be created until IPN callback');
2855 $trxn = current(CRM_Financial_BAO_FinancialItem
::retrieveEntityFinancialTrxn($entityParams));
2857 'id' => $trxn['financial_trxn_id'],
2859 if ($context != 'online' && $context != 'payLater') {
2861 'to_financial_account_id' => 6,
2862 'total_amount' => CRM_Utils_Array
::value('total_amount', $params, 100),
2866 if ($context == 'feeAmount') {
2867 $compareParams['fee_amount'] = 50;
2869 elseif ($context == 'online') {
2871 'to_financial_account_id' => 12,
2872 'total_amount' => CRM_Utils_Array
::value('total_amount', $params, 100),
2874 'payment_instrument_id' => CRM_Utils_Array
::value('payment_instrument_id', $params, 1),
2877 elseif ($context == 'payLater') {
2879 'to_financial_account_id' => 7,
2880 'total_amount' => CRM_Utils_Array
::value('total_amount', $params, 100),
2884 $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams, $compareParams);
2886 'financial_trxn_id' => $trxn['financial_trxn_id'],
2887 'entity_table' => 'civicrm_financial_item',
2889 $entityTrxn = current(CRM_Financial_BAO_FinancialItem
::retrieveEntityFinancialTrxn($entityParams));
2891 'id' => $entityTrxn['entity_id'],
2894 'amount' => CRM_Utils_Array
::value('total_amount', $params, 100),
2896 'financial_account_id' => CRM_Utils_Array
::value('financial_account_id', $params, 1),
2898 if ($context == 'payLater') {
2900 'amount' => CRM_Utils_Array
::value('total_amount', $params, 100),
2902 'financial_account_id' => CRM_Utils_Array
::value('financial_account_id', $params, 1),
2905 $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $fitemParams, $compareParams);
2906 if ($context == 'feeAmount') {
2908 'entity_id' => $params['id'],
2909 'entity_table' => 'civicrm_contribution',
2911 $maxTrxn = current(CRM_Financial_BAO_FinancialItem
::retrieveEntityFinancialTrxn($maxParams, TRUE));
2913 'id' => $maxTrxn['financial_trxn_id'],
2916 'to_financial_account_id' => 5,
2917 'from_financial_account_id' => 6,
2918 'total_amount' => 50,
2921 $trxnId = CRM_Core_BAO_FinancialTrxn
::getFinancialTrxnId($params['id'], 'DESC');
2922 $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams, $compareParams);
2924 'entity_id' => $trxnId['financialTrxnId'],
2925 'entity_table' => 'civicrm_financial_trxn',
2930 'financial_account_id' => 5,
2932 $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $fitemParams, $compareParams);
2934 // This checks that empty Sales tax rows are not being created. If for any reason it needs to be removed the
2935 // line should be copied into all the functions that call this function & evaluated there
2936 // Be really careful not to remove or bypass this without ensuring stray rows do not re-appear
2937 // when calling completeTransaction or repeatTransaction.
2938 $this->callAPISuccessGetCount('FinancialItem', ['description' => 'Sales Tax', 'amount' => 0], 0);
2942 * Return financial type id on basis of name
2944 * @param string $name Financial type m/c name
2948 public function getFinancialTypeId($name) {
2949 return CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialType', $name, 'id', 'name');
2953 * Cleanup function for contents of $this->ids.
2955 * This is a best effort cleanup to use in tear downs etc.
2957 * It will not fail if the data has already been removed (some tests may do
2958 * their own cleanup).
2960 protected function cleanUpSetUpIDs() {
2961 foreach ($this->setupIDs
as $entity => $id) {
2963 civicrm_api3($entity, 'delete', ['id' => $id, 'skip_undelete' => 1]);
2965 catch (CiviCRM_API3_Exception
$e) {
2966 // This is a best-effort cleanup function, ignore.
2972 * Create Financial Type.
2974 * @param array $params
2978 protected function createFinancialType($params = []) {
2979 $params = array_merge($params,
2981 'name' => 'Financial-Type -' . substr(sha1(rand()), 0, 7),
2985 return $this->callAPISuccess('FinancialType', 'create', $params);
2989 * Create Payment Instrument.
2991 * @param array $params
2992 * @param string $financialAccountName
2996 protected function createPaymentInstrument($params = [], $financialAccountName = 'Donation') {
2997 $params = array_merge([
2998 'label' => 'Payment Instrument -' . substr(sha1(rand()), 0, 7),
2999 'option_group_id' => 'payment_instrument',
3002 $newPaymentInstrument = $this->callAPISuccess('OptionValue', 'create', $params)['id'];
3004 $relationTypeID = key(CRM_Core_PseudoConstant
::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Asset Account is' "));
3006 $financialAccountParams = [
3007 'entity_table' => 'civicrm_option_value',
3008 'entity_id' => $newPaymentInstrument,
3009 'account_relationship' => $relationTypeID,
3010 'financial_account_id' => $this->callAPISuccess('FinancialAccount', 'getValue', ['name' => $financialAccountName, 'return' => 'id']),
3012 CRM_Financial_BAO_FinancialTypeAccount
::add($financialAccountParams);
3014 return CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'payment_instrument_id', $params['label']);
3018 * Enable Tax and Invoicing
3020 * @param array $params
3022 * @return \Civi\Core\SettingsBag
3024 protected function enableTaxAndInvoicing($params = []) {
3025 // Enable component contribute setting
3026 $contributeSetting = array_merge($params,
3029 'invoice_prefix' => 'INV_',
3031 'due_date_period' => 'days',
3033 'is_email_pdf' => 1,
3034 'tax_term' => 'Sales Tax',
3035 'tax_display_settings' => 'Inclusive',
3038 return Civi
::settings()->set('contribution_invoice_settings', $contributeSetting);
3042 * Enable Tax and Invoicing
3044 protected function disableTaxAndInvoicing($params = []) {
3045 if (!empty(\Civi
::$statics['CRM_Core_PseudoConstant']) && isset(\Civi
::$statics['CRM_Core_PseudoConstant']['taxRates'])) {
3046 unset(\Civi
::$statics['CRM_Core_PseudoConstant']['taxRates']);
3048 // Enable component contribute setting
3049 $contributeSetting = array_merge($params,
3054 return Civi
::settings()->set('contribution_invoice_settings', $contributeSetting);
3058 * Add Sales Tax relation for financial type with financial account.
3060 * @param int $financialTypeId
3064 protected function relationForFinancialTypeWithFinancialAccount($financialTypeId) {
3066 'name' => 'Sales tax account ' . substr(sha1(rand()), 0, 4),
3067 'financial_account_type_id' => key(CRM_Core_PseudoConstant
::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Liability' ")),
3068 'is_deductible' => 1,
3073 $account = CRM_Financial_BAO_FinancialAccount
::add($params);
3075 'entity_table' => 'civicrm_financial_type',
3076 'entity_id' => $financialTypeId,
3077 'account_relationship' => key(CRM_Core_PseudoConstant
::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Sales Tax Account is' ")),
3080 // set tax rate (as 10) for provided financial type ID to static variable, later used to fetch tax rates of all financial types
3081 \Civi
::$statics['CRM_Core_PseudoConstant']['taxRates'][$financialTypeId] = 10;
3083 //CRM-20313: As per unique index added in civicrm_entity_financial_account table,
3084 // first check if there's any record on basis of unique key (entity_table, account_relationship, entity_id)
3085 $dao = new CRM_Financial_DAO_EntityFinancialAccount();
3086 $dao->copyValues($entityParams);
3088 if ($dao->fetch()) {
3089 $entityParams['id'] = $dao->id
;
3091 $entityParams['financial_account_id'] = $account->id
;
3093 return CRM_Financial_BAO_FinancialTypeAccount
::add($entityParams);
3097 * Create price set with contribution test for test setup.
3099 * This could be merged with 4.5 function setup in api_v3_ContributionPageTest::setUpContributionPage
3100 * on parent class at some point (fn is not in 4.4).
3103 * @param array $params
3105 public function createPriceSetWithPage($entity = NULL, $params = []) {
3106 $membershipTypeID = $this->membershipTypeCreate(['name' => 'Special']);
3107 $contributionPageResult = $this->callAPISuccess('contribution_page', 'create', [
3108 'title' => "Test Contribution Page",
3109 'financial_type_id' => 1,
3110 'currency' => 'NZD',
3111 'goal_amount' => 50,
3112 'is_pay_later' => 1,
3113 'is_monetary' => TRUE,
3114 'is_email_receipt' => FALSE,
3116 $priceSet = $this->callAPISuccess('price_set', 'create', [
3117 'is_quick_config' => 0,
3118 'extends' => 'CiviMember',
3119 'financial_type_id' => 1,
3120 'title' => 'my Page',
3122 $priceSetID = $priceSet['id'];
3124 CRM_Price_BAO_PriceSet
::addTo('civicrm_contribution_page', $contributionPageResult['id'], $priceSetID);
3125 $priceField = $this->callAPISuccess('price_field', 'create', [
3126 'price_set_id' => $priceSetID,
3127 'label' => 'Goat Breed',
3128 'html_type' => 'Radio',
3130 $priceFieldValue = $this->callAPISuccess('price_field_value', 'create', [
3131 'price_set_id' => $priceSetID,
3132 'price_field_id' => $priceField['id'],
3133 'label' => 'Long Haired Goat',
3135 'financial_type_id' => 'Donation',
3136 'membership_type_id' => $membershipTypeID,
3137 'membership_num_terms' => 1,
3139 $this->_ids
['price_field_value'] = [$priceFieldValue['id']];
3140 $priceFieldValue = $this->callAPISuccess('price_field_value', 'create', [
3141 'price_set_id' => $priceSetID,
3142 'price_field_id' => $priceField['id'],
3143 'label' => 'Shoe-eating Goat',
3145 'financial_type_id' => 'Donation',
3146 'membership_type_id' => $membershipTypeID,
3147 'membership_num_terms' => 2,
3149 $this->_ids
['price_field_value'][] = $priceFieldValue['id'];
3151 $priceFieldValue = $this->callAPISuccess('price_field_value', 'create', [
3152 'price_set_id' => $priceSetID,
3153 'price_field_id' => $priceField['id'],
3154 'label' => 'Shoe-eating Goat',
3156 'financial_type_id' => 'Donation',
3158 $this->_ids
['price_field_value']['cont'] = $priceFieldValue['id'];
3160 $this->_ids
['price_set'] = $priceSetID;
3161 $this->_ids
['contribution_page'] = $contributionPageResult['id'];
3162 $this->_ids
['price_field'] = [$priceField['id']];
3164 $this->_ids
['membership_type'] = $membershipTypeID;
3168 * Only specified contact returned.
3170 * @implements CRM_Utils_Hook::aclWhereClause
3174 * @param $whereTables
3178 public function aclWhereMultipleContacts($type, &$tables, &$whereTables, &$contactID, &$where) {
3179 $where = " contact_a.id IN (" . implode(', ', $this->allowedContacts
) . ")";
3183 * @implements CRM_Utils_Hook::selectWhereClause
3185 * @param string $entity
3186 * @param array $clauses
3188 public function selectWhereClauseHook($entity, &$clauses) {
3189 if ($entity == 'Event') {
3190 $clauses['event_type_id'][] = "IN (2, 3, 4)";
3195 * An implementation of hook_civicrm_post used with all our test cases.
3198 * @param string $objectName
3199 * @param int $objectId
3202 public function onPost($op, $objectName, $objectId, &$objectRef) {
3203 if ($op == 'create' && $objectName == 'Individual') {
3204 CRM_Core_DAO
::executeQuery(
3205 "UPDATE civicrm_contact SET nick_name = 'munged' WHERE id = %1",
3207 1 => [$objectId, 'Integer'],
3212 if ($op == 'edit' && $objectName == 'Participant') {
3214 1 => [$objectId, 'Integer'],
3216 $query = "UPDATE civicrm_participant SET source = 'Post Hook Update' WHERE id = %1";
3217 CRM_Core_DAO
::executeQuery($query, $params);
3222 * Instantiate form object.
3224 * We need to instantiate the form to run preprocess, which means we have to trick it about the request method.
3226 * @param string $class
3227 * Name of form class.
3229 * @param array $formValues
3231 * @param string $pageName
3233 * @return \CRM_Core_Form
3234 * @throws \CRM_Core_Exception
3236 public function getFormObject($class, $formValues = [], $pageName = '') {
3237 $form = new $class();
3238 $_SERVER['REQUEST_METHOD'] = 'GET';
3239 $form->controller
= new CRM_Core_Controller();
3240 $form->controller
->setStateMachine(new CRM_Core_StateMachine($form->controller
));
3241 $_SESSION['_' . $form->controller
->_name
. '_container']['values'][$pageName] = $formValues;
3246 * Get possible thousand separators.
3250 public function getThousandSeparators() {
3251 return [['.'], [',']];
3255 * Get the boolean options as a provider.
3259 public function getBooleanDataProvider() {
3260 return [[TRUE], [FALSE]];
3264 * Set the separators for thousands and decimal points.
3266 * Use setMonetaryDecimalPoint and setMonetaryThousandSeparator instead
3268 * @param string $thousandSeparator
3271 protected function setCurrencySeparators($thousandSeparator) {
3272 // Jaap Jansma: I do think the code below is a bit useless. It does an assumption
3273 // that when the thousand separator is a comma, the decimal is point. It
3274 // does not cater for a situation where the thousand separator is a [space]
3275 // Latter is the Norwegian localization.
3276 Civi
::settings()->set('monetaryThousandSeparator', $thousandSeparator);
3278 ->set('monetaryDecimalPoint', ($thousandSeparator === ',' ?
'.' : ','));
3282 * Sets the thousand separator.
3284 * If you use this function also set the decimal separator: setMonetaryDecimalSeparator
3286 * @param $thousandSeparator
3288 protected function setMonetaryThousandSeparator($thousandSeparator) {
3289 Civi
::settings()->set('monetaryThousandSeparator', $thousandSeparator);
3293 * Sets the decimal separator.
3295 * If you use this function also set the thousand separator setMonetaryDecimalPoint
3297 * @param $decimalPoint
3299 protected function setMonetaryDecimalPoint($decimalPoint) {
3300 Civi
::settings()->set('monetaryDecimalPoint', $decimalPoint);
3304 * Sets the default currency.
3308 protected function setDefaultCurrency($currency) {
3309 Civi
::settings()->set('defaultCurrency', $currency);
3313 * Format money as it would be input.
3315 * @param string $amount
3319 protected function formatMoneyInput($amount) {
3320 return CRM_Utils_Money
::format($amount, NULL, '%a');
3324 * Get the contribution object.
3326 * @param int $contributionID
3328 * @return \CRM_Contribute_BAO_Contribution
3330 protected function getContributionObject($contributionID) {
3331 $contributionObj = new CRM_Contribute_BAO_Contribution();
3332 $contributionObj->id
= $contributionID;
3333 $contributionObj->find(TRUE);
3334 return $contributionObj;
3338 * Enable multilingual.
3340 public function enableMultilingual() {
3341 $this->callAPISuccess('Setting', 'create', [
3342 'lcMessages' => 'en_US',
3343 'languageLimit' => [
3348 CRM_Core_I18n_Schema
::makeMultilingual('en_US');
3351 $dbLocale = '_en_US';
3355 * Setup or clean up SMS tests
3357 * @param bool $teardown
3359 * @throws \CiviCRM_API3_Exception
3361 public function setupForSmsTests($teardown = FALSE) {
3362 require_once 'CiviTest/CiviTestSMSProvider.php';
3364 // Option value params for CiviTestSMSProvider
3365 $groupID = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', 'sms_provider_name', 'id', 'name');
3367 'option_group_id' => $groupID,
3368 'label' => 'unittestSMS',
3369 'value' => 'unit.test.sms',
3370 'name' => 'CiviTestSMSProvider',
3377 // Test completed, delete provider
3378 $providerOptionValueResult = civicrm_api3('option_value', 'get', $params);
3379 civicrm_api3('option_value', 'delete', ['id' => $providerOptionValueResult['id']]);
3383 // Create an SMS provider "CiviTestSMSProvider". Civi handles "CiviTestSMSProvider" as a special case and allows it to be instantiated
3384 // in CRM/Sms/Provider.php even though it is not an extension.
3385 return civicrm_api3('option_value', 'create', $params);
3389 * Start capturing browser output.
3391 * The starts the process of browser output being captured, setting any variables needed for e-notice prevention.
3393 protected function startCapturingOutput() {
3395 $_SERVER['HTTP_USER_AGENT'] = 'unittest';
3399 * Stop capturing browser output and return as a csv.
3401 * @param bool $isFirstRowHeaders
3403 * @return \League\Csv\Reader
3405 * @throws \League\Csv\Exception
3407 protected function captureOutputToCSV($isFirstRowHeaders = TRUE) {
3408 $output = ob_get_flush();
3409 $stream = fopen('php://memory', 'r+');
3410 fwrite($stream, $output);
3412 $this->assertEquals("\xEF\xBB\xBF", substr($output, 0, 3));
3413 $csv = Reader
::createFromString($output);
3414 if ($isFirstRowHeaders) {
3415 $csv->setHeaderOffset(0);
3422 * Rename various labels to not match the names.
3424 * Doing these mimics the fact the name != the label in international installs & triggers failures in
3425 * code that expects it to.
3427 protected function renameLabels() {
3428 $replacements = ['Pending', 'Refunded'];
3429 foreach ($replacements as $name) {
3430 CRM_Core_DAO
::executeQuery("UPDATE civicrm_option_value SET label = '{$name} Label**' where label = '{$name}' AND name = '{$name}'");
3435 * Undo any label renaming.
3437 protected function resetLabels() {
3438 CRM_Core_DAO
::executeQuery("UPDATE civicrm_option_value SET label = REPLACE(name, ' Label**', '') WHERE label LIKE '% Label**'");
3442 * Get parameters to set up a multi-line participant order.
3445 * @throws \CRM_Core_Exception
3447 protected function getParticipantOrderParams(): array {
3448 $this->_contactId
= $this->individualCreate();
3449 $event = $this->eventCreate();
3450 $this->_eventId
= $event['id'];
3452 'id' => $this->_eventId
,
3453 'financial_type_id' => 4,
3456 $this->callAPISuccess('event', 'create', $eventParams);
3457 $priceFields = $this->createPriceSet('event', $this->_eventId
);
3458 $participantParams = [
3459 'financial_type_id' => 4,
3460 'event_id' => $this->_eventId
,
3463 'fee_currency' => 'USD',
3464 'contact_id' => $this->_contactId
,
3466 $participant = $this->callAPISuccess('Participant', 'create', $participantParams);
3468 'total_amount' => 300,
3469 'currency' => 'USD',
3470 'contact_id' => $this->_contactId
,
3471 'financial_type_id' => 4,
3472 'contribution_status_id' => 'Pending',
3473 'contribution_mode' => 'participant',
3474 'participant_id' => $participant['id'],
3476 foreach ($priceFields['values'] as $key => $priceField) {
3477 $orderParams['line_items'][] = [
3480 'price_field_id' => $priceField['price_field_id'],
3481 'price_field_value_id' => $priceField['id'],
3482 'label' => $priceField['label'],
3483 'field_title' => $priceField['label'],
3485 'unit_price' => $priceField['amount'],
3486 'line_total' => $priceField['amount'],
3487 'financial_type_id' => $priceField['financial_type_id'],
3488 'entity_table' => 'civicrm_participant',
3491 'params' => $participant,
3494 return $orderParams;
3500 * @throws \CRM_Core_Exception
3502 protected function validatePayments($payments) {
3503 foreach ($payments as $payment) {
3504 $balance = CRM_Contribute_BAO_Contribution
::getContributionBalance($payment['contribution_id']);
3505 if ($balance < 0 && $balance +
$payment['total_amount'] === 0.0) {
3506 // This is an overpayment situation. there are no financial items to allocate the overpayment.
3507 // This is a pretty rough way at guessing which payment is the overpayment - but
3508 // for the test suite it should be enough.
3511 $items = $this->callAPISuccess('EntityFinancialTrxn', 'get', [
3512 'financial_trxn_id' => $payment['id'],
3513 'entity_table' => 'civicrm_financial_item',
3514 'return' => ['amount'],
3517 foreach ($items as $item) {
3518 $itemTotal +
= $item['amount'];
3520 $this->assertEquals($payment['total_amount'], $itemTotal);
3525 * Validate all created payments.
3527 * @throws \CRM_Core_Exception
3529 protected function validateAllPayments() {
3530 $payments = $this->callAPISuccess('Payment', 'get', ['options' => ['limit' => 0]])['values'];
3531 $this->validatePayments($payments);
3535 * Validate all created contributions.
3537 * @throws \CRM_Core_Exception
3539 protected function validateAllContributions() {
3540 $contributions = $this->callAPISuccess('Contribution', 'get', [])['values'];
3541 foreach ($contributions as $contribution) {
3542 $lineItems = $this->callAPISuccess('LineItem', 'get', ['contribution_id' => $contribution['id']])['values'];
3544 foreach ($lineItems as $lineItem) {
3545 $total +
= $lineItem['line_total'];
3547 $this->assertEquals($total, $contribution['total_amount']);