/**
* Function get the import/export fields for contribution
*
* @return array self::$_contributionFields associative array of contribution fields
* @static
*/
static function &getFields()
{
if (!self::$_contributionFields) {
self::$_contributionFields = array();
$fields = CRM_Contribute_BAO_Contribution::exportableFields();
unset($fields['contribution_contact_id']);
self::$_contributionFields = $fields;
}
return self::$_contributionFields;
}
/**
* Function get the import/export fields for contribution
*
* @return array self::$_contributionFields associative array of contribution fields
* @static
*/
static function &getFields()
{
if (!self::$_contributionFields) {
self::$_contributionFields = array();
require_once 'CRM/Contribute/BAO/Contribution.php';
$fields =& CRM_Contribute_BAO_Contribution::exportableFields();
unset($fields['contribution_contact_id']);
self::$_contributionFields = $fields;
}
return self::$_contributionFields;
}
/**
* Function get the import/export fields for contribution
*
* @return array self::$_contributionFields associative array of contribution fields
* @static
*/
static function &getFields()
{
if (!self::$_contributionFields) {
self::$_contributionFields = array();
require_once 'CRM/Contribute/BAO/Contribution.php';
$fields =& CRM_Contribute_BAO_Contribution::exportableFields();
// add field to get recur_id
$fields['contribution_recur_id'] = array('name' => 'contribution_recur_id', 'title' => ts('Recurring Contributions ID'), 'where' => 'civicrm_contribution.contribution_recur_id');
$fields['contribution_note'] = array('name' => 'contribution_note', 'title' => ts('Contribution Note'));
unset($fields['contribution_contact_id']);
self::$_contributionFields = $fields;
}
return self::$_contributionFields;
}
/**
* Build the form object.
*/
public function buildQuickForm()
{
if ($this->_batchStatusId == 2) {
$this->add('submit', 'export_batch', ts('Export Batch'));
}
// do not build rest of form unless it is open batch
if ($this->_batchStatusId != 1) {
return;
}
parent::buildQuickForm();
$this->add('submit', 'close_batch', ts('Close Batch'));
$this->add('submit', 'export_batch', ts('Close & Export Batch'));
// text for sort_name
$this->addElement('text', 'sort_name', ts('Contributor Name or Email'), CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', 'sort_name'));
$this->_group = CRM_Core_PseudoConstant::nestedGroup();
// multiselect for groups
if ($this->_group) {
$this->add('select', 'group', ts('Groups'), $this->_group, FALSE, array('id' => 'group', 'multiple' => 'multiple', 'class' => 'crm-select2'));
}
$contactTags = CRM_Core_BAO_Tag::getTags();
if ($contactTags) {
$this->add('select', 'contact_tags', ts('Tags'), $contactTags, FALSE, array('id' => 'contact_tags', 'multiple' => 'multiple', 'class' => 'crm-select2'));
}
CRM_Contribute_BAO_Query::buildSearchForm($this);
$this->addElement('checkbox', 'toggleSelects', NULL, NULL);
$this->add('select', 'trans_remove', ts('Task'), array('' => ts('- actions -')) + array('Remove' => ts('Remove from Batch')));
$this->add('submit', 'rSubmit', ts('Go'), array('class' => 'crm-form-submit', 'id' => 'GoRemove'));
self::$_entityID = CRM_Utils_Request::retrieve('bid', 'Positive');
$this->addButtons(array(array('type' => 'submit', 'name' => ts('Search'), 'isDefault' => TRUE)));
$this->addElement('checkbox', 'toggleSelect', NULL, NULL);
$this->add('select', 'trans_assign', ts('Task'), array('' => ts('- actions -')) + array('Assign' => ts('Assign to Batch')));
$this->add('submit', 'submit', ts('Go'), array('class' => 'crm-form-submit', 'id' => 'Go'));
$this->applyFilter('__ALL__', 'trim');
$this->addElement('hidden', 'batch_id', self::$_entityID);
$this->add('text', 'name', ts('Batch Name'));
}
/**
* Retrieve a set of contributions.
*
* @param array $params
* Input parameters.
*
* @return array
* Array of contributions, if error an array with an error id and error message
*/
function civicrm_api3_contribution_get($params)
{
$mode = CRM_Contact_BAO_Query::MODE_CONTRIBUTE;
$returnProperties = CRM_Contribute_BAO_Query::defaultReturnProperties($mode);
$contributions = _civicrm_api3_get_using_query_object('Contribution', $params, array(), NULL, $mode, $returnProperties);
foreach ($contributions as $id => $contribution) {
$softContribution = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($id, TRUE);
$contributions[$id] = array_merge($contribution, $softContribution);
// format soft credit for backward compatibility
_civicrm_api3_format_soft_credit($contributions[$id]);
}
return civicrm_api3_create_success($contributions, $params, 'Contribution', 'get');
}
/**
* @param null $context
*
* @return array
*/
public function &summaryContribution($context = NULL)
{
list($innerselect, $from, $where, $having) = $this->query(TRUE);
// hack $select
$select = "\nSELECT COUNT( conts.total_amount ) as total_count,\n SUM( conts.total_amount ) as total_amount,\n AVG( conts.total_amount ) as total_avg,\n conts.total_amount as amount,\n conts.currency as currency";
if ($this->_permissionWhereClause) {
$where .= " AND " . $this->_permissionWhereClause;
}
if ($context == 'search') {
$where .= " AND contact_a.is_deleted = 0 ";
}
// make sure contribution is completed - CRM-4989
$completedWhere = $where . " AND civicrm_contribution.contribution_status_id = 1 ";
$summary = array();
$summary['total'] = array();
$summary['total']['count'] = $summary['total']['amount'] = $summary['total']['avg'] = "n/a";
$innerQuery = "SELECT civicrm_contribution.total_amount, COUNT(civicrm_contribution.total_amount) as civicrm_contribution_total_amount_count,\n civicrm_contribution.currency {$from} {$completedWhere}";
$query = "{$select} FROM (\n {$innerQuery} GROUP BY civicrm_contribution.id\n ) as conts\n GROUP BY currency";
$dao = CRM_Core_DAO::executeQuery($query);
$summary['total']['count'] = 0;
$summary['total']['amount'] = $summary['total']['avg'] = array();
while ($dao->fetch()) {
$summary['total']['count'] += $dao->total_count;
$summary['total']['amount'][] = CRM_Utils_Money::format($dao->total_amount, $dao->currency);
$summary['total']['avg'][] = CRM_Utils_Money::format($dao->total_avg, $dao->currency);
}
$orderBy = 'ORDER BY civicrm_contribution_total_amount_count DESC';
$groupBy = 'GROUP BY currency, civicrm_contribution.total_amount';
$modeSQL = "{$select}, conts.civicrm_contribution_total_amount_count as civicrm_contribution_total_amount_count FROM ({$innerQuery}\n {$groupBy} {$orderBy}) as conts\n GROUP BY currency";
$summary['total']['mode'] = CRM_Contribute_BAO_Contribution::computeStats('mode', $modeSQL);
$medianSQL = "{$from} {$completedWhere}";
$summary['total']['median'] = CRM_Contribute_BAO_Contribution::computeStats('median', $medianSQL, 'civicrm_contribution');
$summary['total']['currencyCount'] = count($summary['total']['median']);
if (!empty($summary['total']['amount'])) {
$summary['total']['amount'] = implode(', ', $summary['total']['amount']);
$summary['total']['avg'] = implode(', ', $summary['total']['avg']);
$summary['total']['mode'] = implode(', ', $summary['total']['mode']);
$summary['total']['median'] = implode(', ', $summary['total']['median']);
} else {
$summary['total']['amount'] = $summary['total']['avg'] = $summary['total']['median'] = 0;
}
// soft credit summary
if (CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled()) {
$softCreditWhere = "{$completedWhere} AND civicrm_contribution_soft.id IS NOT NULL";
$query = "\n {$select} FROM (\n SELECT civicrm_contribution_soft.amount as total_amount, civicrm_contribution_soft.currency {$from} {$softCreditWhere}\n GROUP BY civicrm_contribution_soft.id\n ) as conts\n GROUP BY currency";
$dao = CRM_Core_DAO::executeQuery($query);
$summary['soft_credit']['count'] = 0;
$summary['soft_credit']['amount'] = $summary['soft_credit']['avg'] = array();
while ($dao->fetch()) {
$summary['soft_credit']['count'] += $dao->total_count;
$summary['soft_credit']['amount'][] = CRM_Utils_Money::format($dao->total_amount, $dao->currency);
$summary['soft_credit']['avg'][] = CRM_Utils_Money::format($dao->total_avg, $dao->currency);
}
if (!empty($summary['soft_credit']['amount'])) {
$summary['soft_credit']['amount'] = implode(', ', $summary['soft_credit']['amount']);
$summary['soft_credit']['avg'] = implode(', ', $summary['soft_credit']['avg']);
} else {
$summary['soft_credit']['amount'] = $summary['soft_credit']['avg'] = 0;
}
}
// hack $select
//@todo - this could be one query using the IF in mysql - eg
// SELECT sum(total_completed), sum(count_completed), sum(count_cancelled), sum(total_cancelled) FROM (
// SELECT civicrm_contribution.total_amount, civicrm_contribution.currency ,
// IF(civicrm_contribution.contribution_status_id = 1, 1, 0 ) as count_completed,
// IF(civicrm_contribution.contribution_status_id = 1, total_amount, 0 ) as total_completed,
// IF(civicrm_contribution.cancel_date IS NOT NULL = 1, 1, 0 ) as count_cancelled,
// IF(civicrm_contribution.cancel_date IS NOT NULL = 1, total_amount, 0 ) as total_cancelled
// FROM civicrm_contact contact_a
// LEFT JOIN civicrm_contribution ON civicrm_contribution.contact_id = contact_a.id
// WHERE ( ... where clause....
// AND (civicrm_contribution.cancel_date IS NOT NULL OR civicrm_contribution.contribution_status_id = 1)
// ) as conts
$select = "\nSELECT COUNT( conts.total_amount ) as cancel_count,\n SUM( conts.total_amount ) as cancel_amount,\n AVG( conts.total_amount ) as cancel_avg,\n conts.currency as currency";
$where .= " AND civicrm_contribution.cancel_date IS NOT NULL ";
if ($context == 'search') {
$where .= " AND contact_a.is_deleted = 0 ";
}
$query = "{$select} FROM (\n SELECT civicrm_contribution.total_amount, civicrm_contribution.currency {$from} {$where}\n GROUP BY civicrm_contribution.id\n ) as conts\n GROUP BY currency";
$dao = CRM_Core_DAO::executeQuery($query);
if ($dao->N <= 1) {
if ($dao->fetch()) {
$summary['cancel']['count'] = $dao->cancel_count;
$summary['cancel']['amount'] = $dao->cancel_amount;
$summary['cancel']['avg'] = $dao->cancel_avg;
}
} else {
$summary['cancel']['count'] = 0;
$summary['cancel']['amount'] = $summary['cancel']['avg'] = array();
while ($dao->fetch()) {
$summary['cancel']['count'] += $dao->cancel_count;
$summary['cancel']['amount'][] = CRM_Utils_Money::format($dao->cancel_amount, $dao->currency);
$summary['cancel']['avg'][] = CRM_Utils_Money::format($dao->cancel_avg, $dao->currency);
}
$summary['cancel']['amount'] = implode(', ', $summary['cancel']['amount']);
$summary['cancel']['avg'] = implode(', ', $summary['cancel']['avg']);
}
return $summary;
}
/**
* Build the form object.
*/
public function buildQuickForm()
{
parent::buildQuickForm();
// text for sort_name
$this->addElement('text', 'sort_name', ts('Contributor Name or Email'), CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', 'sort_name'));
$this->_group = CRM_Core_PseudoConstant::nestedGroup();
// multiselect for groups
if ($this->_group) {
$this->add('select', 'group', ts('Groups'), $this->_group, FALSE, array('id' => 'group', 'multiple' => 'multiple', 'class' => 'crm-select2'));
}
// multiselect for tags
$contactTags = CRM_Core_BAO_Tag::getTags();
if ($contactTags) {
$this->add('select', 'contact_tags', ts('Tags'), $contactTags, FALSE, array('id' => 'contact_tags', 'multiple' => 'multiple', 'class' => 'crm-select2'));
}
CRM_Contribute_BAO_Query::buildSearchForm($this);
$rows = $this->get('rows');
if (is_array($rows)) {
if (!$this->_single) {
$this->addRowSelectors($rows);
}
$permission = CRM_Core_Permission::getPermission();
$queryParams = $this->get('queryParams');
$softCreditFiltering = FALSE;
if (!empty($queryParams)) {
$softCreditFiltering = CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled($queryParams);
}
$tasks = CRM_Contribute_Task::permissionedTaskTitles($permission, $softCreditFiltering);
$this->addTaskMenu($tasks);
}
}
/**
* Class constructor.
*
* @param array $queryParams
* Array of parameters for query.
* @param \const|int $action - action of search basic or advanced.
* @param string $contributionClause
* If the caller wants to further restrict the search (used in contributions).
* @param bool $single
* Are we dealing only with one contact?.
* @param int $limit
* How many contributions do we want returned.
*
* @param string $context
* @param null $compContext
*
* @return \CRM_Contribute_Selector_Search
*/
public function __construct(&$queryParams, $action = CRM_Core_Action::NONE, $contributionClause = NULL, $single = FALSE, $limit = NULL, $context = 'search', $compContext = NULL)
{
// submitted form values
$this->_queryParams =& $queryParams;
$this->_single = $single;
$this->_limit = $limit;
$this->_context = $context;
$this->_compContext = $compContext;
$this->_contributionClause = $contributionClause;
// type of selector
$this->_action = $action;
$this->_includeSoftCredits = CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled($this->_queryParams);
$this->_query = new CRM_Contact_BAO_Query($this->_queryParams, CRM_Contribute_BAO_Query::selectorReturnProperties(), NULL, FALSE, FALSE, CRM_Contact_BAO_Query::MODE_CONTRIBUTE);
// @todo the function CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled should handle this
// can we remove? if not why not?
if ($this->_includeSoftCredits) {
$this->_query->_rowCountClause = " count(civicrm_contribution.id)";
$this->_query->_groupByComponentClause = " GROUP BY contribution_search_scredit_combined.id, contribution_search_scredit_combined.contact_id, contribution_search_scredit_combined.scredit_id ";
} else {
$this->_query->_distinctComponentClause = " civicrm_contribution.id";
$this->_query->_groupByComponentClause = " GROUP BY civicrm_contribution.id ";
}
}
/**
* Retrieve a set of contributions, given a set of input params
*
* @param array $params (reference ) input parameters
* @param array $returnProperties Which properties should be included in the
* returned Contribution object. If NULL, the default
* set of properties will be included.
*
* @return array (reference ) array of contributions, if error an array with an error id and error message
* @static void
* @access public
*/
function &civicrm_contribution_search(&$params)
{
_civicrm_initialize();
$inputParams = array();
$returnProperties = array();
$otherVars = array('sort', 'offset', 'rowCount');
$sort = null;
$offset = 0;
$rowCount = 25;
foreach ($params as $n => $v) {
if (substr($n, 0, 7) == 'return.') {
$returnProperties[substr($n, 7)] = $v;
} elseif (in_array($n, $otherVars)) {
${$n} = $v;
} else {
$inputParams[$n] = $v;
}
}
// add is_test to the clause if not present
if (!array_key_exists('contribution_test', $inputParams)) {
$inputParams['contribution_test'] = 0;
}
require_once 'CRM/Contribute/BAO/Query.php';
require_once 'CRM/Contact/BAO/Query.php';
if (empty($returnProperties)) {
$returnProperties = CRM_Contribute_BAO_Query::defaultReturnProperties(CRM_Contact_BAO_Query::MODE_CONTRIBUTE);
}
$newParams =& CRM_Contact_BAO_Query::convertFormValues($inputParams);
$query =& new CRM_Contact_BAO_Query($newParams, $returnProperties, null);
list($select, $from, $where) = $query->query();
$sql = "{$select} {$from} {$where}";
if (!empty($sort)) {
$sql .= " ORDER BY {$sort} ";
}
$sql .= " LIMIT {$offset}, {$rowCount} ";
$dao =& CRM_Core_DAO::executeQuery($sql);
$contribution = array();
while ($dao->fetch()) {
$contribution[$dao->contribution_id] = $query->store($dao);
}
$dao->free();
return $contribution;
}
/**
* Get the list the export fields.
*
* @param int $selectAll
* User preference while export.
* @param array $ids
* Contact ids.
* @param array $params
* Associated array of fields.
* @param string $order
* Order by clause.
* @param array $fields
* Associated array of fields.
* @param array $moreReturnProperties
* Additional return fields.
* @param int $exportMode
* Export mode.
* @param string $componentClause
* Component clause.
* @param string $componentTable
* Component table.
* @param bool $mergeSameAddress
* Merge records if they have same address.
* @param bool $mergeSameHousehold
* Merge records if they belong to the same household.
*
* @param array $exportParams
* @param string $queryOperator
*
*/
public static function exportComponents($selectAll, $ids, $params, $order = NULL, $fields = NULL, $moreReturnProperties = NULL, $exportMode = CRM_Export_Form_Select::CONTACT_EXPORT, $componentClause = NULL, $componentTable = NULL, $mergeSameAddress = FALSE, $mergeSameHousehold = FALSE, $exportParams = array(), $queryOperator = 'AND')
{
$headerRows = $returnProperties = array();
$primary = $paymentFields = $selectedPaymentFields = FALSE;
$origFields = $fields;
$relationField = NULL;
$phoneTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Phone', 'phone_type_id');
$imProviders = CRM_Core_PseudoConstant::get('CRM_Core_DAO_IM', 'provider_id');
$contactRelationshipTypes = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, NULL, NULL, NULL, TRUE, 'name', FALSE);
$queryMode = self::getQueryMode($exportMode);
if ($fields) {
//construct return properties
$locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
$locationTypeFields = array('street_address', 'supplemental_address_1', 'supplemental_address_2', 'city', 'postal_code', 'postal_code_suffix', 'geo_code_1', 'geo_code_2', 'state_province', 'country', 'phone', 'email', 'im');
foreach ($fields as $key => $value) {
$phoneTypeId = $imProviderId = NULL;
$relationshipTypes = $fieldName = CRM_Utils_Array::value(1, $value);
if (!$fieldName) {
continue;
}
// get phoneType id and IM service provider id separately
if ($fieldName == 'phone') {
$phoneTypeId = CRM_Utils_Array::value(3, $value);
} elseif ($fieldName == 'im') {
$imProviderId = CRM_Utils_Array::value(3, $value);
}
if (array_key_exists($relationshipTypes, $contactRelationshipTypes)) {
if (!empty($value[2])) {
$relationField = CRM_Utils_Array::value(2, $value);
if (trim(CRM_Utils_Array::value(3, $value))) {
$relLocTypeId = CRM_Utils_Array::value(3, $value);
} else {
$relLocTypeId = 'Primary';
}
if ($relationField == 'phone') {
$relPhoneTypeId = CRM_Utils_Array::value(4, $value);
} elseif ($relationField == 'im') {
$relIMProviderId = CRM_Utils_Array::value(4, $value);
}
} elseif (!empty($value[4])) {
$relationField = CRM_Utils_Array::value(4, $value);
$relLocTypeId = CRM_Utils_Array::value(5, $value);
if ($relationField == 'phone') {
$relPhoneTypeId = CRM_Utils_Array::value(6, $value);
} elseif ($relationField == 'im') {
$relIMProviderId = CRM_Utils_Array::value(6, $value);
}
}
}
$contactType = CRM_Utils_Array::value(0, $value);
$locTypeId = CRM_Utils_Array::value(2, $value);
if ($relationField) {
if (in_array($relationField, $locationTypeFields) && is_numeric($relLocTypeId)) {
if ($relPhoneTypeId) {
$returnProperties[$relationshipTypes]['location'][$locationTypes[$relLocTypeId]]['phone-' . $relPhoneTypeId] = 1;
} elseif ($relIMProviderId) {
$returnProperties[$relationshipTypes]['location'][$locationTypes[$relLocTypeId]]['im-' . $relIMProviderId] = 1;
} else {
$returnProperties[$relationshipTypes]['location'][$locationTypes[$relLocTypeId]][$relationField] = 1;
}
$relPhoneTypeId = $relIMProviderId = NULL;
} else {
$returnProperties[$relationshipTypes][$relationField] = 1;
}
} elseif (is_numeric($locTypeId)) {
if ($phoneTypeId) {
$returnProperties['location'][$locationTypes[$locTypeId]]['phone-' . $phoneTypeId] = 1;
} elseif ($imProviderId) {
$returnProperties['location'][$locationTypes[$locTypeId]]['im-' . $imProviderId] = 1;
} else {
$returnProperties['location'][$locationTypes[$locTypeId]][$fieldName] = 1;
}
} else {
//hack to fix component fields
//revert mix of event_id and title
if ($fieldName == 'event_id') {
$returnProperties['event_id'] = 1;
} elseif ($exportMode == CRM_Export_Form_Select::EVENT_EXPORT && array_key_exists($fieldName, self::componentPaymentFields())) {
$selectedPaymentFields = TRUE;
$paymentTableId = 'participant_id';
$returnProperties[$fieldName] = 1;
} else {
$returnProperties[$fieldName] = 1;
}
}
}
$returnProperties[self::defaultReturnProperty($exportMode)] = 1;
} else {
$primary = TRUE;
$fields = CRM_Contact_BAO_Contact::exportableFields('All', TRUE, TRUE);
foreach ($fields as $key => $var) {
if ($key && substr($key, 0, 6) != 'custom') {
//for CRM=952
$returnProperties[$key] = 1;
}
}
if ($primary) {
$returnProperties['location_type'] = 1;
$returnProperties['im_provider'] = 1;
$returnProperties['phone_type_id'] = 1;
$returnProperties['provider_id'] = 1;
$returnProperties['current_employer'] = 1;
}
$extraReturnProperties = array();
$paymentFields = FALSE;
switch ($queryMode) {
case CRM_Contact_BAO_Query::MODE_EVENT:
$paymentFields = TRUE;
$paymentTableId = 'participant_id';
break;
case CRM_Contact_BAO_Query::MODE_MEMBER:
$paymentFields = TRUE;
$paymentTableId = 'membership_id';
break;
case CRM_Contact_BAO_Query::MODE_PLEDGE:
$extraReturnProperties = CRM_Pledge_BAO_Query::extraReturnProperties($queryMode);
$paymentFields = TRUE;
$paymentTableId = 'pledge_payment_id';
break;
case CRM_Contact_BAO_Query::MODE_CASE:
$extraReturnProperties = CRM_Case_BAO_Query::extraReturnProperties($queryMode);
break;
}
if ($queryMode != CRM_Contact_BAO_Query::MODE_CONTACTS) {
$componentReturnProperties = CRM_Contact_BAO_Query::defaultReturnProperties($queryMode);
if ($queryMode == CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
// soft credit columns are not automatically populated, because contribution search doesn't require them by default
$componentReturnProperties = array_merge($componentReturnProperties, CRM_Contribute_BAO_Query::softCreditReturnProperties(TRUE));
}
$returnProperties = array_merge($returnProperties, $componentReturnProperties);
if (!empty($extraReturnProperties)) {
$returnProperties = array_merge($returnProperties, $extraReturnProperties);
}
// unset non exportable fields for components
$nonExpoFields = array('groups', 'tags', 'notes', 'contribution_status_id', 'pledge_status_id', 'pledge_payment_status_id');
foreach ($nonExpoFields as $value) {
unset($returnProperties[$value]);
}
}
}
if ($mergeSameAddress) {
//make sure the addressee fields are selected
//while using merge same address feature
$returnProperties['addressee'] = 1;
$returnProperties['postal_greeting'] = 1;
$returnProperties['email_greeting'] = 1;
$returnProperties['street_name'] = 1;
$returnProperties['household_name'] = 1;
$returnProperties['street_address'] = 1;
$returnProperties['city'] = 1;
$returnProperties['state_province'] = 1;
// some columns are required for assistance incase they are not already present
$exportParams['merge_same_address']['temp_columns'] = array();
$tempColumns = array('id', 'master_id', 'state_province_id', 'postal_greeting_id', 'addressee_id');
foreach ($tempColumns as $column) {
if (!array_key_exists($column, $returnProperties)) {
$returnProperties[$column] = 1;
$column = $column == 'id' ? 'civicrm_primary_id' : $column;
$exportParams['merge_same_address']['temp_columns'][$column] = 1;
}
}
}
if (!$selectAll && $componentTable && !empty($exportParams['additional_group'])) {
// If an Additional Group is selected, then all contacts in that group are
// added to the export set (filtering out duplicates).
$query = "\nINSERT INTO {$componentTable} SELECT distinct gc.contact_id FROM civicrm_group_contact gc WHERE gc.group_id = {$exportParams['additional_group']} ON DUPLICATE KEY UPDATE {$componentTable}.contact_id = gc.contact_id";
CRM_Core_DAO::executeQuery($query);
}
if ($moreReturnProperties) {
// fix for CRM-7066
if (!empty($moreReturnProperties['group'])) {
unset($moreReturnProperties['group']);
$moreReturnProperties['groups'] = 1;
}
$returnProperties = array_merge($returnProperties, $moreReturnProperties);
}
$exportParams['postal_mailing_export']['temp_columns'] = array();
if ($exportParams['exportOption'] == 2 && isset($exportParams['postal_mailing_export']) && CRM_Utils_Array::value('postal_mailing_export', $exportParams['postal_mailing_export']) == 1) {
$postalColumns = array('is_deceased', 'do_not_mail', 'street_address', 'supplemental_address_1');
foreach ($postalColumns as $column) {
if (!array_key_exists($column, $returnProperties)) {
$returnProperties[$column] = 1;
$exportParams['postal_mailing_export']['temp_columns'][$column] = 1;
}
}
}
// rectify params to what proximity search expects if there is a value for prox_distance
// CRM-7021
if (!empty($params)) {
CRM_Contact_BAO_ProximityQuery::fixInputParams($params);
}
$query = new CRM_Contact_BAO_Query($params, $returnProperties, NULL, FALSE, FALSE, $queryMode, FALSE, TRUE, TRUE, NULL, $queryOperator);
//sort by state
//CRM-15301
$query->_sort = $order;
list($select, $from, $where, $having) = $query->query();
if ($mergeSameHousehold == 1) {
if (!$returnProperties['id']) {
$returnProperties['id'] = 1;
}
//also merge Head of Household
$relationKeyMOH = CRM_Utils_Array::key('Household Member of', $contactRelationshipTypes);
$relationKeyHOH = CRM_Utils_Array::key('Head of Household for', $contactRelationshipTypes);
foreach ($returnProperties as $key => $value) {
if (!array_key_exists($key, $contactRelationshipTypes)) {
$returnProperties[$relationKeyMOH][$key] = $value;
$returnProperties[$relationKeyHOH][$key] = $value;
}
}
unset($returnProperties[$relationKeyMOH]['location_type']);
unset($returnProperties[$relationKeyMOH]['im_provider']);
unset($returnProperties[$relationKeyHOH]['location_type']);
unset($returnProperties[$relationKeyHOH]['im_provider']);
}
$allRelContactArray = $relationQuery = array();
foreach ($contactRelationshipTypes as $rel => $dnt) {
if ($relationReturnProperties = CRM_Utils_Array::value($rel, $returnProperties)) {
$allRelContactArray[$rel] = array();
// build Query for each relationship
$relationQuery[$rel] = new CRM_Contact_BAO_Query(NULL, $relationReturnProperties, NULL, FALSE, FALSE, $queryMode);
list($relationSelect, $relationFrom, $relationWhere, $relationHaving) = $relationQuery[$rel]->query();
list($id, $direction) = explode('_', $rel, 2);
// identify the relationship direction
$contactA = 'contact_id_a';
$contactB = 'contact_id_b';
if ($direction == 'b_a') {
$contactA = 'contact_id_b';
$contactB = 'contact_id_a';
}
if ($exportMode == CRM_Export_Form_Select::CONTACT_EXPORT) {
$relIDs = $ids;
} elseif ($exportMode == CRM_Export_Form_Select::ACTIVITY_EXPORT) {
$sourceID = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_ActivityContact', 'record_type_id', 'Activity Source');
$query = "SELECT contact_id FROM civicrm_activity_contact\n WHERE activity_id IN ( " . implode(',', $ids) . ") AND\n record_type_id = {$sourceID}";
$dao = CRM_Core_DAO::executeQuery($query);
while ($dao->fetch()) {
$relIDs[] = $dao->contact_id;
}
} else {
$component = self::exportComponent($exportMode);
if ($exportMode == CRM_Export_Form_Select::CASE_EXPORT) {
$relIDs = CRM_Case_BAO_Case::retrieveContactIdsByCaseId($ids);
} else {
$relIDs = CRM_Core_DAO::getContactIDsFromComponent($ids, $component);
}
}
$relationshipJoin = $relationshipClause = '';
if (!$selectAll && $componentTable) {
$relationshipJoin = " INNER JOIN {$componentTable} ctTable ON ctTable.contact_id = {$contactA}";
} elseif (!empty($relIDs)) {
$relID = implode(',', $relIDs);
$relationshipClause = " AND crel.{$contactA} IN ( {$relID} )";
}
$relationFrom = " {$relationFrom}\n INNER JOIN civicrm_relationship crel ON crel.{$contactB} = contact_a.id AND crel.relationship_type_id = {$id}\n {$relationshipJoin} ";
//check for active relationship status only
$today = date('Ymd');
$relationActive = " AND (crel.is_active = 1 AND ( crel.end_date is NULL OR crel.end_date >= {$today} ) )";
$relationWhere = " WHERE contact_a.is_deleted = 0 {$relationshipClause} {$relationActive}";
$relationGroupBy = " GROUP BY crel.{$contactA}";
$relationSelect = "{$relationSelect}, {$contactA} as refContact ";
$relationQueryString = "{$relationSelect} {$relationFrom} {$relationWhere} {$relationHaving} {$relationGroupBy}";
$allRelContactDAO = CRM_Core_DAO::executeQuery($relationQueryString);
while ($allRelContactDAO->fetch()) {
//FIX Me: Migrate this to table rather than array
// build the array of all related contacts
$allRelContactArray[$rel][$allRelContactDAO->refContact] = clone $allRelContactDAO;
}
$allRelContactDAO->free();
}
}
// make sure the groups stuff is included only if specifically specified
// by the fields param (CRM-1969), else we limit the contacts outputted to only
// ones that are part of a group
if (!empty($returnProperties['groups'])) {
$oldClause = "( contact_a.id = civicrm_group_contact.contact_id )";
$newClause = " ( {$oldClause} AND ( civicrm_group_contact.status = 'Added' OR civicrm_group_contact.status IS NULL ) )";
// total hack for export, CRM-3618
$from = str_replace($oldClause, $newClause, $from);
}
if (!$selectAll && $componentTable) {
$from .= " INNER JOIN {$componentTable} ctTable ON ctTable.contact_id = contact_a.id ";
} elseif ($componentClause) {
if (empty($where)) {
$where = "WHERE {$componentClause}";
} else {
$where .= " AND {$componentClause}";
}
}
// CRM-13982 - check if is deleted
$excludeTrashed = TRUE;
foreach ($params as $value) {
if ($value[0] == 'contact_is_deleted') {
$excludeTrashed = FALSE;
}
}
$trashClause = $excludeTrashed ? "contact_a.is_deleted != 1" : "( 1 )";
if (empty($where)) {
$where = "WHERE {$trashClause}";
} else {
$where .= " AND {$trashClause}";
}
$queryString = "{$select} {$from} {$where} {$having}";
$groupBy = "";
if (!empty($returnProperties['tags']) || !empty($returnProperties['groups']) || CRM_Utils_Array::value('notes', $returnProperties) || $queryMode & CRM_Contact_BAO_Query::MODE_CONTACTS && $query->_useGroupBy) {
$groupBy = " GROUP BY contact_a.id";
}
switch ($exportMode) {
case CRM_Export_Form_Select::CONTRIBUTE_EXPORT:
$groupBy = 'GROUP BY civicrm_contribution.id';
if (CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled()) {
// especial group by when soft credit columns are included
$groupBy = 'GROUP BY contribution_search_scredit_combined.id, contribution_search_scredit_combined.scredit_id';
}
break;
case CRM_Export_Form_Select::EVENT_EXPORT:
$groupBy = 'GROUP BY civicrm_participant.id';
break;
case CRM_Export_Form_Select::MEMBER_EXPORT:
$groupBy = " GROUP BY civicrm_membership.id";
break;
}
if ($queryMode & CRM_Contact_BAO_Query::MODE_ACTIVITY) {
$groupBy = " GROUP BY civicrm_activity.id ";
}
$queryString .= $groupBy;
// always add contact_a.id to the ORDER clause
// so the order is deterministic
//CRM-15301
if (strpos('contact_a.id', $order) === FALSE) {
$order .= ", contact_a.id";
}
if ($order) {
list($field, $dir) = explode(' ', $order, 2);
$field = trim($field);
if (!empty($returnProperties[$field])) {
//CRM-15301
$queryString .= " ORDER BY {$order}";
}
}
$multipleSelectFields = array('preferred_communication_method' => 1);
$addPaymentHeader = FALSE;
$paymentDetails = array();
if ($paymentFields || $selectedPaymentFields) {
// get payment related in for event and members
$paymentDetails = CRM_Contribute_BAO_Contribution::getContributionDetails($exportMode, $ids);
//get all payment headers.
// If we haven't selected specific payment fields, load in all the
// payment headers.
if (!$selectedPaymentFields) {
$paymentHeaders = self::componentPaymentFields();
if (!empty($paymentDetails)) {
$addPaymentHeader = TRUE;
}
} else {
$paymentHeaders = array();
}
$nullContributionDetails = array_fill_keys(array_keys($paymentHeaders), NULL);
}
$componentDetails = $headerRows = $sqlColumns = array();
$setHeader = TRUE;
$rowCount = self::EXPORT_ROW_COUNT;
$offset = 0;
// we write to temp table often to avoid using too much memory
$tempRowCount = 100;
$count = -1;
// for CRM-3157 purposes
$i18n = CRM_Core_I18n::singleton();
$outputColumns = array();
//@todo - it would be clearer to start defining output columns earlier in this function rather than stick with return properties until this point
// as the array is not actually 'returnProperties' after the sql query is formed - making the alterations to it confusing
foreach ($returnProperties as $key => $value) {
$outputColumns[$key] = $value;
}
while (1) {
$limitQuery = "{$queryString} LIMIT {$offset}, {$rowCount}";
$dao = CRM_Core_DAO::executeQuery($limitQuery);
if ($dao->N <= 0) {
break;
}
while ($dao->fetch()) {
$count++;
$row = array();
//convert the pseudo constants
// CRM-14398 there is problem in this architecture that is not easily solved. For now we are using the cloned
// temporary iterationDAO object to get around it.
// the issue is that the convertToPseudoNames function is adding additional properties (e.g for campaign) to the DAO object
// these additional properties are NOT reset when the $dao cycles through the while loop
// nor are they overwritten as they are not in the loop
// the convertToPseudoNames will not adequately over-write them either as it doesn't 'kick-in' unless the
// relevant property is set.
// It may be that a long-term fix could be introduced there - however, it's probably necessary to figure out how to test the
// export class before tackling a better architectural fix
$iterationDAO = clone $dao;
$query->convertToPseudoNames($iterationDAO);
//first loop through output columns so that we return what is required, and in same order.
$relationshipField = 0;
foreach ($outputColumns as $field => $value) {
//we should set header only once
if ($setHeader) {
$sqlDone = FALSE;
// Split campaign into 2 fields for id and title
if (substr($field, -14) == 'campaign_title') {
$headerRows[] = ts('Campaign Title');
} elseif (substr($field, -11) == 'campaign_id') {
$headerRows[] = ts('Campaign ID');
} elseif (isset($query->_fields[$field]['title'])) {
$headerRows[] = $query->_fields[$field]['title'];
} elseif ($field == 'phone_type_id') {
$headerRows[] = ts('Phone Type');
} elseif ($field == 'provider_id') {
$headerRows[] = ts('IM Service Provider');
} elseif (is_array($value) && $field == 'location') {
// fix header for location type case
foreach ($value as $ltype => $val) {
foreach (array_keys($val) as $fld) {
$type = explode('-', $fld);
$hdr = "{$ltype}-" . $query->_fields[$type[0]]['title'];
if (!empty($type[1])) {
if (CRM_Utils_Array::value(0, $type) == 'phone') {
$hdr .= "-" . CRM_Utils_Array::value($type[1], $phoneTypes);
} elseif (CRM_Utils_Array::value(0, $type) == 'im') {
$hdr .= "-" . CRM_Utils_Array::value($type[1], $imProviders);
}
}
$headerRows[] = $hdr;
self::sqlColumnDefn($query, $sqlColumns, $hdr);
}
$sqlDone = TRUE;
}
} elseif (substr($field, 0, 5) == 'case_') {
if ($query->_fields['case'][$field]['title']) {
$headerRows[] = $query->_fields['case'][$field]['title'];
} elseif ($query->_fields['activity'][$field]['title']) {
$headerRows[] = $query->_fields['activity'][$field]['title'];
}
} elseif (array_key_exists($field, $contactRelationshipTypes)) {
$relName = $field;
foreach ($value as $relationField => $relationValue) {
// below block is same as primary block (duplicate)
if (isset($relationQuery[$field]->_fields[$relationField]['title'])) {
if ($relationQuery[$field]->_fields[$relationField]['name'] == 'name') {
$headerName = $field . '-' . $relationField;
} else {
if ($relationField == 'current_employer') {
$headerName = $field . '-' . 'current_employer';
} else {
$headerName = $field . '-' . $relationQuery[$field]->_fields[$relationField]['name'];
}
}
$headerRows[] = $headerName;
self::sqlColumnDefn($query, $sqlColumns, $headerName);
} elseif ($relationField == 'phone_type_id') {
$headerName = $field . '-' . 'Phone Type';
$headerRows[] = $headerName;
self::sqlColumnDefn($query, $sqlColumns, $headerName);
} elseif ($relationField == 'provider_id') {
$headerName = $field . '-' . 'Im Service Provider';
$headerRows[] = $headerName;
self::sqlColumnDefn($query, $sqlColumns, $headerName);
} elseif ($relationField == 'state_province_id') {
$headerName = $field . '-' . 'state_province_id';
$headerRows[] = $headerName;
self::sqlColumnDefn($query, $sqlColumns, $headerName);
} elseif (is_array($relationValue) && $relationField == 'location') {
// fix header for location type case
foreach ($relationValue as $ltype => $val) {
foreach (array_keys($val) as $fld) {
$type = explode('-', $fld);
$hdr = "{$ltype}-" . $relationQuery[$field]->_fields[$type[0]]['title'];
if (!empty($type[1])) {
if (CRM_Utils_Array::value(0, $type) == 'phone') {
$hdr .= "-" . CRM_Utils_Array::value($type[1], $phoneTypes);
} elseif (CRM_Utils_Array::value(0, $type) == 'im') {
$hdr .= "-" . CRM_Utils_Array::value($type[1], $imProviders);
}
}
$headerName = $field . '-' . $hdr;
$headerRows[] = $headerName;
self::sqlColumnDefn($query, $sqlColumns, $headerName);
}
}
}
}
} elseif ($selectedPaymentFields && array_key_exists($field, self::componentPaymentFields())) {
$headerRows[] = CRM_Utils_Array::value($field, self::componentPaymentFields());
} else {
$headerRows[] = $field;
}
if (!$sqlDone) {
self::sqlColumnDefn($query, $sqlColumns, $field);
}
}
// add im_provider to $dao object
if ($field == 'im_provider' && property_exists($iterationDAO, 'provider_id')) {
$iterationDAO->im_provider = $iterationDAO->provider_id;
}
//build row values (data)
$fieldValue = NULL;
if (property_exists($iterationDAO, $field)) {
$fieldValue = $iterationDAO->{$field};
// to get phone type from phone type id
if ($field == 'phone_type_id' && isset($phoneTypes[$fieldValue])) {
$fieldValue = $phoneTypes[$fieldValue];
} elseif ($field == 'provider_id' || $field == 'im_provider') {
$fieldValue = CRM_Utils_Array::value($fieldValue, $imProviders);
} elseif ($field == 'master_id') {
$masterAddressId = NULL;
if (isset($iterationDAO->master_id)) {
$masterAddressId = $iterationDAO->master_id;
}
// get display name of contact that address is shared.
$fieldValue = CRM_Contact_BAO_Contact::getMasterDisplayName($masterAddressId, $iterationDAO->contact_id);
}
}
if ($field == 'id') {
$row[$field] = $iterationDAO->contact_id;
// special case for calculated field
} elseif ($field == 'source_contact_id') {
$row[$field] = $iterationDAO->contact_id;
} elseif ($field == 'pledge_balance_amount') {
$row[$field] = $iterationDAO->pledge_amount - $iterationDAO->pledge_total_paid;
// special case for calculated field
} elseif ($field == 'pledge_next_pay_amount') {
$row[$field] = $iterationDAO->pledge_next_pay_amount + $iterationDAO->pledge_outstanding_amount;
} elseif (is_array($value) && $field == 'location') {
// fix header for location type case
foreach ($value as $ltype => $val) {
foreach (array_keys($val) as $fld) {
$type = explode('-', $fld);
$fldValue = "{$ltype}-" . $type[0];
// CRM-14076 - fix label to work as the query object expects
// FIXME: We should not be using labels as keys!
$daoField = CRM_Utils_String::munge($ltype) . '-' . $type[0];
if (!empty($type[1])) {
$fldValue .= "-" . $type[1];
$daoField .= "-" . $type[1];
}
// CRM-3157: localise country, region (both have ‘country’ context) and state_province (‘province’ context)
switch ($fld) {
case 'country':
case 'world_region':
$row[$fldValue] = $i18n->crm_translate($iterationDAO->{$daoField}, array('context' => 'country'));
break;
case 'state_province':
$row[$fldValue] = $i18n->crm_translate($iterationDAO->{$daoField}, array('context' => 'province'));
break;
case 'im_provider':
$imFieldvalue = $daoField . "-provider_id";
$row[$fldValue] = CRM_Utils_Array::value($iterationDAO->{$imFieldvalue}, $imProviders);
break;
default:
$row[$fldValue] = $iterationDAO->{$daoField};
break;
}
}
}
} elseif (array_key_exists($field, $contactRelationshipTypes)) {
$relDAO = CRM_Utils_Array::value($iterationDAO->contact_id, $allRelContactArray[$field]);
$relationQuery[$field]->convertToPseudoNames($relDAO);
foreach ($value as $relationField => $relationValue) {
if (is_object($relDAO) && property_exists($relDAO, $relationField)) {
$fieldValue = $relDAO->{$relationField};
if ($relationField == 'phone_type_id') {
$fieldValue = $phoneTypes[$relationValue];
} elseif ($relationField == 'provider_id') {
$fieldValue = CRM_Utils_Array::value($relationValue, $imProviders);
} elseif (is_object($relDAO) && in_array($relationField, array('email_greeting', 'postal_greeting', 'addressee'))) {
//special case for greeting replacement
$fldValue = "{$relationField}_display";
$fieldValue = $relDAO->{$fldValue};
}
} elseif (is_object($relDAO) && $relationField == 'state_province') {
$fieldValue = CRM_Core_PseudoConstant::stateProvince($relDAO->state_province_id);
} elseif (is_object($relDAO) && $relationField == 'country') {
$fieldValue = CRM_Core_PseudoConstant::country($relDAO->country_id);
} else {
$fieldValue = '';
}
$field = $field . '_';
if (array_key_exists($relationField, $multipleSelectFields)) {
$param = array($relationField => $fieldValue);
$names = array($relationField => array('newName' => $relationField, 'groupName' => $relationField));
CRM_Core_OptionGroup::lookupValues($param, $names, FALSE);
$fieldValue = $param[$relationField];
}
if (is_object($relDAO) && $relationField == 'id') {
$row[$field . $relationField] = $relDAO->contact_id;
} elseif (is_array($relationValue) && $relationField == 'location') {
foreach ($relationValue as $ltype => $val) {
foreach (array_keys($val) as $fld) {
$type = explode('-', $fld);
$fldValue = "{$ltype}-" . $type[0];
if (!empty($type[1])) {
$fldValue .= "-" . $type[1];
}
// CRM-3157: localise country, region (both have ‘country’ context)
// and state_province (‘province’ context)
switch (TRUE) {
case !is_object($relDAO):
$row[$field . '_' . $fldValue] = '';
break;
case in_array('country', $type):
case in_array('world_region', $type):
$row[$field . '_' . $fldValue] = $i18n->crm_translate($relDAO->{$fldValue}, array('context' => 'country'));
break;
case in_array('state_province', $type):
$row[$field . '_' . $fldValue] = $i18n->crm_translate($relDAO->{$fldValue}, array('context' => 'province'));
break;
default:
$row[$field . '_' . $fldValue] = $relDAO->{$fldValue};
break;
}
}
}
} elseif (isset($fieldValue) && $fieldValue != '') {
//check for custom data
if ($cfID = CRM_Core_BAO_CustomField::getKeyID($relationField)) {
$row[$field . $relationField] = CRM_Core_BAO_CustomField::getDisplayValue($fieldValue, $cfID, $relationQuery[$field]->_options);
} else {
//normal relationship fields
// CRM-3157: localise country, region (both have ‘country’ context) and state_province (‘province’ context)
switch ($relationField) {
case 'country':
case 'world_region':
$row[$field . $relationField] = $i18n->crm_translate($fieldValue, array('context' => 'country'));
break;
case 'state_province':
$row[$field . $relationField] = $i18n->crm_translate($fieldValue, array('context' => 'province'));
break;
default:
$row[$field . $relationField] = $fieldValue;
break;
}
}
} else {
// if relation field is empty or null
$row[$field . $relationField] = '';
}
}
} elseif (isset($fieldValue) && $fieldValue != '') {
//check for custom data
if ($cfID = CRM_Core_BAO_CustomField::getKeyID($field)) {
$row[$field] = CRM_Core_BAO_CustomField::getDisplayValue($fieldValue, $cfID, $query->_options);
} elseif (array_key_exists($field, $multipleSelectFields)) {
//option group fixes
$paramsNew = array($field => $fieldValue);
if ($field == 'test_tutoring') {
$name = array($field => array('newName' => $field, 'groupName' => 'test'));
// for readers group
} elseif (substr($field, 0, 4) == 'cmr_') {
$name = array($field => array('newName' => $field, 'groupName' => substr($field, 0, -3)));
} else {
$name = array($field => array('newName' => $field, 'groupName' => $field));
}
CRM_Core_OptionGroup::lookupValues($paramsNew, $name, FALSE);
$row[$field] = $paramsNew[$field];
} elseif (in_array($field, array('email_greeting', 'postal_greeting', 'addressee'))) {
//special case for greeting replacement
$fldValue = "{$field}_display";
$row[$field] = $iterationDAO->{$fldValue};
} else {
//normal fields with a touch of CRM-3157
switch ($field) {
case 'country':
case 'world_region':
$row[$field] = $i18n->crm_translate($fieldValue, array('context' => 'country'));
break;
case 'state_province':
$row[$field] = $i18n->crm_translate($fieldValue, array('context' => 'province'));
break;
case 'gender':
case 'preferred_communication_method':
case 'preferred_mail_format':
case 'communication_style':
$row[$field] = $i18n->crm_translate($fieldValue);
break;
default:
$row[$field] = $fieldValue;
break;
}
}
} elseif ($selectedPaymentFields && array_key_exists($field, self::componentPaymentFields())) {
$paymentData = CRM_Utils_Array::value($iterationDAO->{$paymentTableId}, $paymentDetails);
$payFieldMapper = array('componentPaymentField_total_amount' => 'total_amount', 'componentPaymentField_contribution_status' => 'contribution_status', 'componentPaymentField_payment_instrument' => 'pay_instru', 'componentPaymentField_transaction_id' => 'trxn_id', 'componentPaymentField_received_date' => 'receive_date');
$row[$field] = CRM_Utils_Array::value($payFieldMapper[$field], $paymentData, '');
} else {
// if field is empty or null
$row[$field] = '';
}
}
// add payment headers if required
if ($addPaymentHeader && $paymentFields) {
$headerRows = array_merge($headerRows, $paymentHeaders);
foreach (array_keys($paymentHeaders) as $paymentHdr) {
self::sqlColumnDefn($query, $sqlColumns, $paymentHdr);
}
}
if ($setHeader) {
$exportTempTable = self::createTempTable($sqlColumns);
}
//build header only once
$setHeader = FALSE;
// If specific payment fields have been selected for export, payment
// data will already be in $row. Otherwise, add payment related
// information, if appropriate.
if ($addPaymentHeader) {
if (!$selectedPaymentFields) {
if ($paymentFields) {
$paymentData = CRM_Utils_Array::value($row[$paymentTableId], $paymentDetails);
if (!is_array($paymentData) || empty($paymentData)) {
$paymentData = $nullContributionDetails;
}
$row = array_merge($row, $paymentData);
} elseif (!empty($paymentDetails)) {
$row = array_merge($row, $nullContributionDetails);
}
}
}
//remove organization name for individuals if it is set for current employer
if (!empty($row['contact_type']) && $row['contact_type'] == 'Individual' && array_key_exists('organization_name', $row)) {
$row['organization_name'] = '';
}
// add component info
// write the row to a file
$componentDetails[] = $row;
// output every $tempRowCount rows
if ($count % $tempRowCount == 0) {
self::writeDetailsToTable($exportTempTable, $componentDetails, $sqlColumns);
$componentDetails = array();
}
}
$dao->free();
$offset += $rowCount;
}
if ($exportTempTable) {
self::writeDetailsToTable($exportTempTable, $componentDetails, $sqlColumns);
// do merge same address and merge same household processing
if ($mergeSameAddress) {
self::mergeSameAddress($exportTempTable, $headerRows, $sqlColumns, $exportParams);
}
// merge the records if they have corresponding households
if ($mergeSameHousehold) {
self::mergeSameHousehold($exportTempTable, $headerRows, $sqlColumns, $relationKeyMOH);
self::mergeSameHousehold($exportTempTable, $headerRows, $sqlColumns, $relationKeyHOH);
}
// fix the headers for rows with relationship type
if (!empty($relName)) {
self::manipulateHeaderRows($headerRows, $contactRelationshipTypes);
}
// if postalMailing option is checked, exclude contacts who are deceased, have
// "Do not mail" privacy setting, or have no street address
if (isset($exportParams['postal_mailing_export']['postal_mailing_export']) && $exportParams['postal_mailing_export']['postal_mailing_export'] == 1) {
self::postalMailingFormat($exportTempTable, $headerRows, $sqlColumns, $exportMode);
}
// call export hook
CRM_Utils_Hook::export($exportTempTable, $headerRows, $sqlColumns, $exportMode);
// now write the CSV file
self::writeCSVFromTable($exportTempTable, $headerRows, $sqlColumns, $exportMode);
// delete the export temp table and component table
$sql = "DROP TABLE IF EXISTS {$exportTempTable}";
CRM_Core_DAO::executeQuery($sql);
CRM_Utils_System::civiExit();
} else {
CRM_Core_Error::fatal(ts('No records to export'));
}
}
/**
* Class constructor
*
* @param array $queryParams array of parameters for query
* @param int $action - action of search basic or advanced.
* @param string $contributionClause if the caller wants to further restrict the search (used in contributions)
* @param boolean $single are we dealing only with one contact?
* @param int $limit how many contributions do we want returned
*
* @return CRM_Contact_Selector
* @access public
*/
function __construct(&$queryParams, $action = CRM_Core_Action::NONE, $contributionClause = NULL, $single = FALSE, $limit = NULL, $context = 'search', $compContext = NULL)
{
// submitted form values
$this->_queryParams =& $queryParams;
$this->_single = $single;
$this->_limit = $limit;
$this->_context = $context;
$this->_compContext = $compContext;
$this->_contributionClause = $contributionClause;
// type of selector
$this->_action = $action;
$this->_query = new CRM_Contact_BAO_Query($this->_queryParams, CRM_Contribute_BAO_Query::defaultReturnProperties(CRM_Contact_BAO_Query::MODE_CONTRIBUTE, FALSE), NULL, FALSE, FALSE, CRM_Contact_BAO_Query::MODE_CONTRIBUTE);
$this->_query->_distinctComponentClause = " civicrm_contribution.id";
$this->_query->_groupByComponentClause = " GROUP BY civicrm_contribution.id ";
}
/**
* Build the form
*
* @access public
* @return void
*/
function buildQuickForm()
{
// text for sort_name
$this->addElement('text', 'sort_name', ts('Contributor Name or Email'), CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', 'sort_name'));
require_once 'CRM/Contribute/BAO/Query.php';
CRM_Contribute_BAO_Query::buildSearchForm($this);
/*
* add form checkboxes for each row. This is needed out here to conform to QF protocol
* of all elements being declared in builQuickForm
*/
$rows = $this->get('rows');
if (is_array($rows)) {
if (!$this->_single) {
$this->addElement('checkbox', 'toggleSelect', null, null, array('onclick' => "toggleTaskAction( true ); return toggleCheckboxVals('mark_x_',this);"));
foreach ($rows as $row) {
$this->addElement('checkbox', $row['checkbox'], null, null, array('onclick' => "toggleTaskAction( true ); return checkSelectedBox('" . $row['checkbox'] . "', '" . $this->getName() . "');"));
}
}
$total = $cancel = 0;
require_once "CRM/Core/Permission.php";
$permission = CRM_Core_Permission::getPermission();
require_once 'CRM/Contribute/Task.php';
$tasks = array('' => ts('- more actions -')) + CRM_Contribute_Task::permissionedTaskTitles($permission);
$this->add('select', 'task', ts('Actions:') . ' ', $tasks);
$this->add('submit', $this->_actionButtonName, ts('Go'), array('class' => 'form-submit', 'id' => 'Go', 'onclick' => "return checkPerformAction('mark_x', '" . $this->getName() . "', 0);"));
$this->add('submit', $this->_printButtonName, ts('Print'), array('class' => 'form-submit', 'onclick' => "return checkPerformAction('mark_x', '" . $this->getName() . "', 1);"));
// need to perform tasks on all or selected items ? using radio_ts(task selection) for it
$this->addElement('radio', 'radio_ts', null, '', 'ts_sel', array('checked' => 'checked'));
$this->addElement('radio', 'radio_ts', null, '', 'ts_all', array('onclick' => $this->getName() . ".toggleSelect.checked = false; toggleCheckboxVals('mark_x_',this); toggleTaskAction( true );"));
}
// add buttons
$this->addButtons(array(array('type' => 'refresh', 'name' => ts('Search'), 'isDefault' => true)));
}
/**
* Build the form
*
* @access public
*
* @return void
*/
function buildQuickForm()
{
// text for sort_name
$this->addElement('text', 'sort_name', ts('Contributor Name or Email'), CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', 'sort_name'));
$this->_group = CRM_Core_PseudoConstant::group();
// multiselect for groups
if ($this->_group) {
$this->add('select', 'group', ts('Groups'), $this->_group, FALSE, array('id' => 'group', 'multiple' => 'multiple', 'class' => 'crm-select2'));
}
// multiselect for tags
$contactTags = CRM_Core_BAO_Tag::getTags();
if ($contactTags) {
$this->add('select', 'contact_tags', ts('Tags'), $contactTags, FALSE, array('id' => 'contact_tags', 'multiple' => 'multiple', 'class' => 'crm-select2'));
}
CRM_Contribute_BAO_Query::buildSearchForm($this);
/*
* add form checkboxes for each row. This is needed out here to conform to QF protocol
* of all elements being declared in builQuickForm
*/
$rows = $this->get('rows');
if (is_array($rows)) {
if (!$this->_single) {
$this->addElement('checkbox', 'toggleSelect', NULL, NULL, array('onclick' => "toggleTaskAction( true );", 'class' => 'select-rows'));
foreach ($rows as $row) {
$this->addElement('checkbox', $row['checkbox'], NULL, NULL, array('onclick' => "toggleTaskAction( true );", 'class' => 'select-row'));
}
}
$total = $cancel = 0;
$permission = CRM_Core_Permission::getPermission();
$tasks = array('' => ts('- actions -')) + CRM_Contribute_Task::permissionedTaskTitles($permission);
$this->add('select', 'task', ts('Actions:') . ' ', $tasks);
$this->add('submit', $this->_actionButtonName, ts('Go'), array('class' => 'form-submit', 'id' => 'Go', 'onclick' => "return checkPerformAction('mark_x', '" . $this->getName() . "', 0);"));
// need to perform tasks on all or selected items ? using radio_ts(task selection) for it
$this->addElement('radio', 'radio_ts', NULL, '', 'ts_sel', array('checked' => 'checked'));
$this->addElement('radio', 'radio_ts', NULL, '', 'ts_all', array('class' => 'select-rows', 'onclick' => $this->getName() . ".toggleSelect.checked = false; toggleTaskAction( true );"));
}
// add buttons
$this->addButtons(array(array('type' => 'refresh', 'name' => ts('Search'), 'isDefault' => TRUE)));
}
/**
* Retrieve a set of contributions, given a set of input params
*
* @param array $params (reference ) input parameters
* @param array $returnProperties Which properties should be included in the
* returned Contribution object. If NULL, the default
* set of properties will be included.
*
* @return array (reference ) array of contributions, if error an array with an error id and error message
* @static void
* @access public
* {@getfields Contribution_get}
* @example ContributionGet.php
*/
function civicrm_api3_contribution_get($params)
{
$options = _civicrm_api3_get_options_from_params($params, TRUE, 'contribution', 'get');
$sort = CRM_Utils_Array::value('sort', $options, NULL);
$offset = CRM_Utils_Array::value('offset', $options);
$rowCount = CRM_Utils_Array::value('limit', $options);
$smartGroupCache = CRM_Utils_Array::value('smartGroupCache', $params);
$inputParams = CRM_Utils_Array::value('input_params', $options, array());
$returnProperties = CRM_Utils_Array::value('return', $options, NULL);
if (empty($returnProperties)) {
$returnProperties = CRM_Contribute_BAO_Query::defaultReturnProperties(CRM_Contact_BAO_Query::MODE_CONTRIBUTE);
}
$newParams = CRM_Contact_BAO_Query::convertFormValues($inputParams);
$query = new CRM_Contact_BAO_Query($newParams, $returnProperties, NULL, FALSE, FALSE, CRM_Contact_BAO_Query::MODE_CONTRIBUTE);
list($select, $from, $where, $having) = $query->query();
$sql = "{$select} {$from} {$where} {$having}";
if (!empty($sort)) {
$sql .= " ORDER BY {$sort} ";
}
$sql .= " LIMIT {$offset}, {$rowCount} ";
$dao = CRM_Core_DAO::executeQuery($sql);
$contribution = array();
while ($dao->fetch()) {
//CRM-8662
$contribution_details = $query->store($dao);
$softContribution = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($dao->contribution_id, TRUE);
$contribution[$dao->contribution_id] = array_merge($contribution_details, $softContribution);
if (isset($contribution[$dao->contribution_id]['financial_type_id'])) {
$contribution[$dao->contribution_id]['financial_type_id'] = $contribution[$dao->contribution_id]['financial_type_id'];
}
// format soft credit for backward compatibility
_civicrm_api3_format_soft_credit($contribution[$dao->contribution_id]);
}
return civicrm_api3_create_success($contribution, $params, 'contribution', 'get', $dao);
}
/**
* @param array $queryParams
*
* @return bool
*/
public static function isSoftCreditOptionEnabled($queryParams = array())
{
static $tempTableFilled = FALSE;
if (!empty($queryParams)) {
foreach (array_keys($queryParams) as $id) {
if (empty($queryParams[$id][0])) {
continue;
}
if ($queryParams[$id][0] == 'contribution_or_softcredits') {
self::$_contribOrSoftCredit = $queryParams[$id][2];
}
}
}
if (in_array(self::$_contribOrSoftCredit, array("only_scredits", "both_related", "both"))) {
if (!$tempTableFilled) {
// build a temp table which is union of contributions and soft credits
// note: group-by in first part ensures uniqueness in counts
$tempQuery = "\n CREATE TEMPORARY TABLE IF NOT EXISTS contribution_search_scredit_combined AS\n SELECT con.id as id, con.contact_id, cso.id as filter_id, NULL as scredit_id\n FROM civicrm_contribution con\n LEFT JOIN civicrm_contribution_soft cso ON con.id = cso.contribution_id\n GROUP BY id, contact_id, scredit_id\n UNION ALL\n SELECT scredit.contribution_id as id, scredit.contact_id, scredit.id as filter_id, scredit.id as scredit_id\n FROM civicrm_contribution_soft as scredit";
CRM_Core_DAO::executeQuery($tempQuery);
$tempTableFilled = TRUE;
}
return TRUE;
}
return FALSE;
}
/**
* Reset the various system caches and some important static variables.
*/
public static function flushCache()
{
// flush out all cache entries so we can reload new data
// a bit aggressive, but livable for now
$cache = CRM_Utils_Cache::singleton();
$cache->flush();
// also reset the various static memory caches
// reset the memory or array cache
CRM_Core_BAO_Cache::deleteGroup('contact fields', NULL, FALSE);
// reset ACL cache
CRM_ACL_BAO_Cache::resetCache();
// reset various static arrays used here
CRM_Contact_BAO_Contact::$_importableFields = CRM_Contact_BAO_Contact::$_exportableFields = CRM_Contribute_BAO_Contribution::$_importableFields = CRM_Contribute_BAO_Contribution::$_exportableFields = CRM_Pledge_BAO_Pledge::$_exportableFields = CRM_Contribute_BAO_Query::$_contributionFields = CRM_Core_BAO_CustomField::$_importFields = CRM_Core_BAO_Cache::$_cache = CRM_Core_DAO::$_dbColumnValueCache = NULL;
CRM_Core_OptionGroup::flushAll();
CRM_Utils_PseudoConstant::flushAll();
}
/**
* Get dao query object based on input params.
*
* Ideally this would be merged with _civicrm_get_using_query_object but we need to resolve differences in what the
* 2 variants call
*
* @param array $params
* @param string $mode
* @param string $entity
*
* @return array
* [CRM_Core_DAO|CRM_Contact_BAO_Query]
*/
function _civicrm_api3_get_query_object($params, $mode, $entity)
{
$options = _civicrm_api3_get_options_from_params($params, TRUE, $entity, 'get');
$sort = CRM_Utils_Array::value('sort', $options, NULL);
$offset = CRM_Utils_Array::value('offset', $options);
$rowCount = CRM_Utils_Array::value('limit', $options);
$inputParams = CRM_Utils_Array::value('input_params', $options, array());
$returnProperties = CRM_Utils_Array::value('return', $options, NULL);
if (empty($returnProperties)) {
$returnProperties = CRM_Contribute_BAO_Query::defaultReturnProperties($mode);
}
$newParams = CRM_Contact_BAO_Query::convertFormValues($inputParams, 0, FALSE, $entity);
$query = new CRM_Contact_BAO_Query($newParams, $returnProperties, NULL, FALSE, FALSE, $mode, empty($params['check_permissions']));
list($select, $from, $where, $having) = $query->query();
$sql = "{$select} {$from} {$where} {$having}";
if (!empty($sort)) {
$sql .= " ORDER BY {$sort} ";
}
if (!empty($rowCount)) {
$sql .= " LIMIT {$offset}, {$rowCount} ";
}
$dao = CRM_Core_DAO::executeQuery($sql);
return array($dao, $query);
}
/**
* Retrieve financial items assigned for a batch.
*
* @param int $entityID
* @param array $returnValues
* @param bool $notPresent
* @param array $params
* @param bool $getCount
*
* @return CRM_Core_DAO
*/
public static function getBatchFinancialItems($entityID, $returnValues, $notPresent = NULL, $params = NULL, $getCount = FALSE)
{
if (!$getCount) {
if (!empty($params['rowCount']) && $params['rowCount'] > 0) {
$limit = " LIMIT {$params['offset']}, {$params['rowCount']} ";
}
}
// action is taken depending upon the mode
$select = 'civicrm_financial_trxn.id ';
if (!empty($returnValues)) {
$select .= " , " . implode(' , ', $returnValues);
}
$orderBy = " ORDER BY civicrm_financial_trxn.id";
if (!empty($params['sort'])) {
$orderBy = ' ORDER BY ' . CRM_Utils_Type::escape($params['sort'], 'String');
}
$from = "civicrm_financial_trxn\nLEFT JOIN civicrm_entity_financial_trxn ON civicrm_entity_financial_trxn.financial_trxn_id = civicrm_financial_trxn.id\nLEFT JOIN civicrm_entity_batch ON civicrm_entity_batch.entity_table = 'civicrm_financial_trxn'\nAND civicrm_entity_batch.entity_id = civicrm_financial_trxn.id\nLEFT JOIN civicrm_contribution ON civicrm_contribution.id = civicrm_entity_financial_trxn.entity_id\nLEFT JOIN civicrm_financial_type ON civicrm_financial_type.id = civicrm_contribution.financial_type_id\nLEFT JOIN civicrm_contact contact_a ON contact_a.id = civicrm_contribution.contact_id\nLEFT JOIN civicrm_contribution_soft ON civicrm_contribution_soft.contribution_id = civicrm_contribution.id\n";
$searchFields = array('sort_name', 'financial_type_id', 'contribution_page_id', 'payment_instrument_id', 'contribution_trxn_id', 'contribution_source', 'contribution_currency_type', 'contribution_pay_later', 'contribution_recurring', 'contribution_test', 'contribution_thankyou_date_is_not_null', 'contribution_receipt_date_is_not_null', 'contribution_pcp_made_through_id', 'contribution_pcp_display_in_roll', 'contribution_date_relative', 'contribution_amount_low', 'contribution_amount_high', 'contribution_in_honor_of', 'contact_tags', 'group', 'contribution_date_relative', 'contribution_date_high', 'contribution_date_low', 'contribution_check_number', 'contribution_status_id');
$values = array();
foreach ($searchFields as $field) {
if (isset($params[$field])) {
$values[$field] = $params[$field];
if ($field == 'sort_name') {
$from .= " LEFT JOIN civicrm_contact contact_b ON contact_b.id = civicrm_contribution.contact_id\n LEFT JOIN civicrm_email ON contact_b.id = civicrm_email.contact_id";
}
if ($field == 'contribution_in_honor_of') {
$from .= " LEFT JOIN civicrm_contact contact_b ON contact_b.id = civicrm_contribution.contact_id";
}
if ($field == 'contact_tags') {
$from .= " LEFT JOIN civicrm_entity_tag `civicrm_entity_tag-{$params[$field]}` ON `civicrm_entity_tag-{$params[$field]}`.entity_id = contact_a.id";
}
if ($field == 'group') {
$from .= " LEFT JOIN civicrm_group_contact `civicrm_group_contact-{$params[$field]}` ON contact_a.id = `civicrm_group_contact-{$params[$field]}`.contact_id ";
}
if ($field == 'contribution_date_relative') {
$relativeDate = explode('.', $params[$field]);
$date = CRM_Utils_Date::relativeToAbsolute($relativeDate[0], $relativeDate[1]);
$values['contribution_date_low'] = $date['from'];
$values['contribution_date_high'] = $date['to'];
}
$searchParams = CRM_Contact_BAO_Query::convertFormValues($values);
$query = new CRM_Contact_BAO_Query($searchParams, CRM_Contribute_BAO_Query::defaultReturnProperties(CRM_Contact_BAO_Query::MODE_CONTRIBUTE, FALSE), NULL, FALSE, FALSE, CRM_Contact_BAO_Query::MODE_CONTRIBUTE);
if ($field == 'contribution_date_high' || $field == 'contribution_date_low') {
$query->dateQueryBuilder($params[$field], 'civicrm_contribution', 'contribution_date', 'receive_date', 'Contribution Date');
}
}
}
if (!empty($query->_where[0])) {
$where = implode(' AND ', $query->_where[0]) . " AND civicrm_entity_batch.batch_id IS NULL\n AND civicrm_entity_financial_trxn.entity_table = 'civicrm_contribution'";
$where = str_replace('civicrm_contribution.payment_instrument_id', 'civicrm_financial_trxn.payment_instrument_id', $where);
$searchValue = TRUE;
} else {
$searchValue = FALSE;
}
if (!$searchValue) {
if (!$notPresent) {
$where = " ( civicrm_entity_batch.batch_id = {$entityID}\n AND civicrm_entity_batch.entity_table = 'civicrm_financial_trxn'\n AND civicrm_entity_financial_trxn.entity_table = 'civicrm_contribution') ";
} else {
$where = " ( civicrm_entity_batch.batch_id IS NULL\n AND civicrm_entity_financial_trxn.entity_table = 'civicrm_contribution')";
}
}
$sql = "\nSELECT {$select}\nFROM {$from}\nWHERE {$where}\n {$orderBy}\n";
if (isset($limit)) {
$sql .= "{$limit}";
}
$result = CRM_Core_DAO::executeQuery($sql);
return $result;
}
/**
* @param CRM_Core_Form $form
* @param bool $useTable
*/
public static function preProcessCommon(&$form, $useTable = FALSE)
{
$form->_contributionIds = array();
$values = $form->controller->exportValues($form->get('searchFormName'));
$form->_task = $values['task'];
$contributeTasks = CRM_Contribute_Task::tasks();
$form->assign('taskName', $contributeTasks[$form->_task]);
$ids = array();
if ($values['radio_ts'] == 'ts_sel') {
foreach ($values as $name => $value) {
if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
$ids[] = substr($name, CRM_Core_Form::CB_PREFIX_LEN);
}
}
} else {
$queryParams = $form->get('queryParams');
$sortOrder = NULL;
if ($form->get(CRM_Utils_Sort::SORT_ORDER)) {
$sortOrder = $form->get(CRM_Utils_Sort::SORT_ORDER);
}
$form->_includesSoftCredits = CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled($queryParams);
$query = new CRM_Contact_BAO_Query($queryParams, array('contribution_id'), NULL, FALSE, FALSE, CRM_Contact_BAO_Query::MODE_CONTRIBUTE);
// @todo the function CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled should handle this
// can we remove? if not why not?
if ($form->_includesSoftCredits) {
$contactIds = $contributionContactIds = array();
$query->_rowCountClause = " count(civicrm_contribution.id)";
$query->_groupByComponentClause = " GROUP BY contribution_search_scredit_combined.id, contribution_search_scredit_combined.contact_id, contribution_search_scredit_combined.scredit_id ";
} else {
$query->_distinctComponentClause = ' civicrm_contribution.id';
$query->_groupByComponentClause = ' GROUP BY civicrm_contribution.id ';
}
$result = $query->searchQuery(0, 0, $sortOrder);
while ($result->fetch()) {
$ids[] = $result->contribution_id;
if ($form->_includesSoftCredits) {
$contactIds[$result->contact_id] = $result->contact_id;
$contributionContactIds["{$result->contact_id}-{$result->contribution_id}"] = $result->contribution_id;
}
}
$result->free();
$form->assign('totalSelectedContributions', $form->get('rowCount'));
}
if (!empty($ids)) {
$form->_componentClause = ' civicrm_contribution.id IN ( ' . implode(',', $ids) . ' ) ';
$form->assign('totalSelectedContributions', count($ids));
}
if (!empty($form->_includesSoftCredits) && !empty($contactIds)) {
$form->_contactIds = $contactIds;
$form->_contributionContactIds = $contributionContactIds;
}
$form->_contributionIds = $form->_componentIds = $ids;
//set the context for redirection for any task actions
$session = CRM_Core_Session::singleton();
$qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $form);
$urlParams = 'force=1';
if (CRM_Utils_Rule::qfKey($qfKey)) {
$urlParams .= "&qfKey={$qfKey}";
}
$searchFormName = strtolower($form->get('searchFormName'));
if ($searchFormName == 'search') {
$session->replaceUserContext(CRM_Utils_System::url('civicrm/contribute/search', $urlParams));
} else {
$session->replaceUserContext(CRM_Utils_System::url("civicrm/contact/search/{$searchFormName}", $urlParams));
}
}
