3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
35 class CRM_Member_BAO_Query
{
40 static function &getFields() {
41 $fields = CRM_Member_BAO_Membership
::exportableFields();
46 * if membership are involved, add the specific membership fields
53 static function select(&$query) {
54 // if membership mode add membership id
55 if ($query->_mode
& CRM_Contact_BAO_Query
::MODE_MEMBER ||
56 CRM_Contact_BAO_Query
::componentPresent($query->_returnProperties
, 'membership_')
59 $query->_select
['membership_id'] = "civicrm_membership.id as membership_id";
60 $query->_element
['membership_id'] = 1;
61 $query->_tables
['civicrm_membership'] = 1;
62 $query->_whereTables
['civicrm_membership'] = 1;
65 if (!empty($query->_returnProperties
['membership_type'])) {
66 $query->_select
['membership_type'] = "civicrm_membership_type.name as membership_type";
67 $query->_element
['membership_type'] = 1;
68 $query->_tables
['civicrm_membership_type'] = 1;
69 $query->_whereTables
['civicrm_membership_type'] = 1;
73 if (!empty($query->_returnProperties
['join_date'])) {
74 $query->_select
['join_date'] = "civicrm_membership.join_date as join_date";
75 $query->_element
['join_date'] = 1;
79 if (!empty($query->_returnProperties
['membership_source'])) {
80 $query->_select
['membership_source'] = "civicrm_membership.source as membership_source";
81 $query->_element
['membership_source'] = 1;
85 if (!empty($query->_returnProperties
['membership_status'])) {
86 $query->_select
['membership_status'] = "civicrm_membership_status.label as membership_status";
87 $query->_element
['membership_status'] = 1;
88 $query->_tables
['civicrm_membership_status'] = 1;
89 $query->_whereTables
['civicrm_membership_status'] = 1;
92 if (!empty($query->_returnProperties
['status_id'])) {
93 $query->_select
['status_id'] = "civicrm_membership_status.id as status_id";
94 $query->_element
['status_id'] = 1;
95 $query->_tables
['civicrm_membership_status'] = 1;
96 $query->_whereTables
['civicrm_membership_status'] = 1;
99 //add start date / end date
100 if (!empty($query->_returnProperties
['membership_start_date'])) {
101 $query->_select
['membership_start_date'] = "civicrm_membership.start_date as membership_start_date";
102 $query->_element
['membership_start_date'] = 1;
105 if (!empty($query->_returnProperties
['membership_end_date'])) {
106 $query->_select
['membership_end_date'] = "civicrm_membership.end_date as membership_end_date";
107 $query->_element
['membership_end_date'] = 1;
110 //add owner_membership_id
111 if (!empty($query->_returnProperties
['owner_membership_id'])) {
112 $query->_select
['owner_membership_id'] = "civicrm_membership.owner_membership_id as owner_membership_id";
113 $query->_element
['owner_membership_id'] = 1;
116 if (!empty($query->_returnProperties
['max_related'])) {
117 $query->_select
['max_related'] = "civicrm_membership.max_related as max_related";
118 $query->_element
['max_related'] = 1;
120 //add recur id w/o taking contribution table in join.
121 if (!empty($query->_returnProperties
['membership_recur_id'])) {
122 $query->_select
['membership_recur_id'] = "civicrm_membership.contribution_recur_id as membership_recur_id";
123 $query->_element
['membership_recur_id'] = 1;
127 if (!empty($query->_returnProperties
['member_campaign_id'])) {
128 $query->_select
['member_campaign_id'] = 'civicrm_membership.campaign_id as member_campaign_id';
129 $query->_element
['member_campaign_id'] = 1;
137 static function where(&$query) {
139 foreach (array_keys($query->_params
) as $id) {
140 if (empty($query->_params
[$id][0])) {
143 if (substr($query->_params
[$id][0], 0, 7) == 'member_' ||
substr($query->_params
[$id][0], 0, 11) == 'membership_') {
144 if ($query->_mode
== CRM_Contact_BAO_QUERY
::MODE_CONTACTS
) {
145 $query->_useDistinct
= TRUE;
147 $grouping = $query->_params
[$id][3];
148 self
::whereClauseSingle($query->_params
[$id], $query);
157 static function whereClauseSingle(&$values, &$query) {
158 list($name, $op, $value, $grouping, $wildcard) = $values;
160 case 'member_join_date_low':
161 case 'member_join_date_high':
162 $query->dateQueryBuilder($values,
163 'civicrm_membership', 'member_join_date', 'join_date',
168 case 'member_start_date_low':
169 case 'member_start_date_high':
170 $query->dateQueryBuilder($values,
171 'civicrm_membership', 'member_start_date', 'start_date',
176 case 'member_end_date_low':
177 case 'member_end_date_high':
178 $query->dateQueryBuilder($values,
179 'civicrm_membership', 'member_end_date', 'end_date',
184 case 'member_join_date':
186 $date = CRM_Utils_Date
::format($value);
188 $query->_where
[$grouping][] = "civicrm_membership.join_date {$op} {$date}";
189 $date = CRM_Utils_Date
::customFormat($value);
190 $format = CRM_Utils_Date
::customFormat(CRM_Utils_Date
::format(array_reverse($value), '-'));
191 $query->_qill
[$grouping][] = ts('Member Since %2 %1', array(1 => $format, 2 => $op));
196 case 'member_source':
197 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
198 $value = $strtolower(CRM_Core_DAO
::escapeString(trim($value)));
200 $query->_where
[$grouping][] = "civicrm_membership.source $op '{$value}'";
201 $query->_qill
[$grouping][] = ts('Source %2 %1', array(1 => $value, 2 => $op));
202 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
205 case 'membership_status':
206 case 'member_status_id':
207 if (!is_array($value)) {
209 if (!empty($value)) {
210 $value = array_flip(explode(",", str_replace(array( '(', ')' ), '', $value)));
217 $status = implode(',', array_keys($value));
218 if (count($value) > 0) {
220 $status = "({$status})";
225 $statusTypes = CRM_Member_PseudoConstant
::membershipStatus(NULL, NULL, 'label');
226 foreach ($value as $id => $dontCare) {
227 $names[] = $statusTypes[$id];
229 $query->_qill
[$grouping][] = ts('Membership Status %1', array(1 => $op)) . ' ' . implode(' ' . ts('or') . ' ', $names);
230 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_membership.status_id",
235 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
239 // We dont want to include all tests for sql OR CRM-7827
240 if (!$value ||
$query->getOperator() != 'OR') {
241 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_membership.is_test", $op, $value, "Boolean");
243 $query->_qill
[$grouping][] = ts('Membership is a Test');
246 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
249 case 'member_auto_renew':
252 $query->_where
[$grouping][] = " civicrm_membership.contribution_recur_id IS NOT NULL";
253 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause(
254 "ccr.contribution_status_id",
256 CRM_Core_DAO
::getFieldValue(
257 'CRM_Core_DAO_OptionValue',
264 $query->_qill
[$grouping][] = ts("Membership is Auto-Renew");
267 $query->_where
[$grouping][] = " civicrm_membership.contribution_recur_id IS NULL";
268 $query->_qill
[$grouping][] = ts("Membership is NOT Auto-Renew");
270 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
273 case 'member_pay_later':
274 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_membership.is_pay_later",
280 $query->_qill
[$grouping][] = ts("Membership is Pay Later");
283 $query->_qill
[$grouping][] = ts("Membership is NOT Pay Later");
285 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
288 case 'membership_type':
289 case 'member_membership_type_id':
290 if (!is_array($value)) {
292 if (!empty($value)) {
293 $value = array_flip(explode(",", str_replace(array( '(', ')' ), '', $value)));
300 $mType = implode(',', array_keys($value));
301 if (count($value) > 0) {
303 $mType = "({$mType})";
308 $membershipTypes = CRM_Member_PseudoConstant
::membershipType();
309 foreach ($value as $id => $dontCare) {
310 if(!empty($membershipTypes[$id])) {
311 $names[] = $membershipTypes[$id];
314 $query->_qill
[$grouping][] = ts('Membership Type %1', array(1 => $op)) . ' ' . implode(' ' . ts('or') . ' ', $names);
315 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_membership.membership_type_id",
320 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
324 $query->_where
[$grouping][] = " civicrm_membership.id $op $value";
325 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
328 case 'member_is_primary':
330 $query->_where
[$grouping][] = " civicrm_membership.owner_membership_id IS NULL";
331 $query->_qill
[$grouping][] = ts("Primary Members Only");
334 $query->_where
[$grouping][] = " civicrm_membership.owner_membership_id IS NOT NULL";
335 $query->_qill
[$grouping][] = ts("Related Members Only");
337 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
340 case 'member_campaign_id':
343 'campaign' => $value,
344 'grouping' => $grouping,
345 'tableName' => 'civicrm_membership',
347 CRM_Campaign_BAO_Query
::componentSearchClause($campParams, $query);
357 * @return null|string
359 static function from($name, $mode, $side) {
362 case 'civicrm_membership':
363 $from = " $side JOIN civicrm_membership ON civicrm_membership.contact_id = contact_a.id ";
364 $from .= " $side JOIN civicrm_contribution_recur ccr ON ( civicrm_membership.contribution_recur_id = ccr.id )";
367 case 'civicrm_membership_type':
368 if ($mode & CRM_Contact_BAO_Query
::MODE_MEMBER
) {
369 $from = " INNER JOIN civicrm_membership_type ON civicrm_membership.membership_type_id = civicrm_membership_type.id ";
372 $from = " $side JOIN civicrm_membership_type ON civicrm_membership.membership_type_id = civicrm_membership_type.id ";
376 case 'civicrm_membership_status':
377 if ($mode & CRM_Contact_BAO_Query
::MODE_MEMBER
) {
378 $from = " INNER JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id ";
381 $from = " $side JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id ";
385 case 'civicrm_membership_payment':
386 $from = " $side JOIN civicrm_membership_payment ON civicrm_membership_payment.membership_id = civicrm_membership.id ";
394 * @param bool $includeCustomFields
398 static function defaultReturnProperties($mode,
399 $includeCustomFields = TRUE
402 if ($mode & CRM_Contact_BAO_Query
::MODE_MEMBER
) {
405 'contact_sub_type' => 1,
408 'membership_type' => 1,
409 'member_is_test' => 1,
410 'member_is_pay_later' => 1,
412 'membership_start_date' => 1,
413 'membership_end_date' => 1,
414 'membership_source' => 1,
415 'membership_status' => 1,
416 'membership_id' => 1,
417 'owner_membership_id' => 1,
419 'membership_recur_id' => 1,
420 'member_campaign_id' => 1,
423 if ($includeCustomFields) {
424 // also get all the custom membership properties
425 $fields = CRM_Core_BAO_CustomField
::getFieldsForImport('Membership');
426 if (!empty($fields)) {
427 foreach ($fields as $name => $dontCare) {
428 $properties[$name] = 1;
440 static function buildSearchForm(&$form) {
441 foreach (CRM_Member_PseudoConstant
::membershipType() as $id => $Name) {
442 $form->_membershipType
= &$form->addElement('checkbox', "member_membership_type_id[$id]", NULL, $Name);
446 foreach (CRM_Member_PseudoConstant
::membershipStatus(NULL, NULL, 'label') as $sId => $sName) {
447 $form->_membershipStatus
= &$form->addElement('checkbox', "member_status_id[$sId]", NULL, $sName);
450 $form->addElement('text', 'member_source', ts('Source'));
452 CRM_Core_Form_Date
::buildDateRange($form, 'member_join_date', 1, '_low', '_high', ts('From'), FALSE);
454 CRM_Core_Form_Date
::buildDateRange($form, 'member_start_date', 1, '_low', '_high', ts('From'), FALSE);
456 CRM_Core_Form_Date
::buildDateRange($form, 'member_end_date', 1, '_low', '_high', ts('From'), FALSE);
458 $form->addYesNo('member_is_primary', ts('Primary Member?'), TRUE);
459 $form->addYesNo('member_pay_later', ts('Pay Later?'), TRUE);
460 $form->addYesNo('member_auto_renew', ts('Auto-Renew?'), TRUE);
461 $form->addYesNo('member_test', ts('Membership is a Test?'), TRUE);
463 // add all the custom searchable fields
464 $extends = array('Membership');
465 $groupDetails = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, TRUE, $extends);
467 $form->assign('membershipGroupTree', $groupDetails);
468 foreach ($groupDetails as $group) {
469 foreach ($group['fields'] as $field) {
470 $fieldId = $field['id'];
471 $elementName = 'custom_' . $fieldId;
472 CRM_Core_BAO_CustomField
::addQuickFormElement($form,
481 CRM_Campaign_BAO_Campaign
::addCampaignInComponentSearch($form, 'member_campaign_id');
483 $form->assign('validCiviMember', TRUE);
484 $form->setDefaults(array('member_test' => 0));
491 static function searchAction(&$row, $id) {}
496 static function tableNames(&$tables) {
497 //add membership table
498 if (!empty($tables['civicrm_membership_log']) ||
!empty($tables['civicrm_membership_status']) || CRM_Utils_Array
::value('civicrm_membership_type', $tables)) {
499 $tables = array_merge(array('civicrm_membership' => 1), $tables);