3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
35 class CRM_Member_BAO_Query
{
40 public static function &getFields() {
41 $fields = CRM_Member_BAO_Membership
::exportableFields();
46 * If membership are involved, add the specific membership fields
52 public static function select(&$query) {
53 // if membership mode add membership id
54 if ($query->_mode
& CRM_Contact_BAO_Query
::MODE_MEMBER ||
55 CRM_Contact_BAO_Query
::componentPresent($query->_returnProperties
, 'membership_')
58 $query->_select
['membership_id'] = "civicrm_membership.id as membership_id";
59 $query->_element
['membership_id'] = 1;
60 $query->_tables
['civicrm_membership'] = 1;
61 $query->_whereTables
['civicrm_membership'] = 1;
64 if (!empty($query->_returnProperties
['membership_type'])) {
65 $query->_select
['membership_type'] = "civicrm_membership_type.name as membership_type";
66 $query->_element
['membership_type'] = 1;
67 $query->_tables
['civicrm_membership_type'] = 1;
68 $query->_whereTables
['civicrm_membership_type'] = 1;
72 if (!empty($query->_returnProperties
['join_date'])) {
73 $query->_select
['join_date'] = "civicrm_membership.join_date as join_date";
74 $query->_element
['join_date'] = 1;
78 if (!empty($query->_returnProperties
['membership_source'])) {
79 $query->_select
['membership_source'] = "civicrm_membership.source as membership_source";
80 $query->_element
['membership_source'] = 1;
84 if (!empty($query->_returnProperties
['membership_status'])) {
85 $query->_select
['membership_status'] = "civicrm_membership_status.label as membership_status";
86 $query->_element
['membership_status'] = 1;
87 $query->_tables
['civicrm_membership_status'] = 1;
88 $query->_whereTables
['civicrm_membership_status'] = 1;
91 if (!empty($query->_returnProperties
['status_id'])) {
92 $query->_select
['status_id'] = "civicrm_membership_status.id as status_id";
93 $query->_element
['status_id'] = 1;
94 $query->_tables
['civicrm_membership_status'] = 1;
95 $query->_whereTables
['civicrm_membership_status'] = 1;
98 //add start date / end date
99 if (!empty($query->_returnProperties
['membership_start_date'])) {
100 $query->_select
['membership_start_date'] = "civicrm_membership.start_date as membership_start_date";
101 $query->_element
['membership_start_date'] = 1;
104 if (!empty($query->_returnProperties
['membership_end_date'])) {
105 $query->_select
['membership_end_date'] = "civicrm_membership.end_date as membership_end_date";
106 $query->_element
['membership_end_date'] = 1;
109 //add owner_membership_id
110 if (!empty($query->_returnProperties
['owner_membership_id'])) {
111 $query->_select
['owner_membership_id'] = "civicrm_membership.owner_membership_id as owner_membership_id";
112 $query->_element
['owner_membership_id'] = 1;
115 if (!empty($query->_returnProperties
['max_related'])) {
116 $query->_select
['max_related'] = "civicrm_membership.max_related as max_related";
117 $query->_element
['max_related'] = 1;
119 //add recur id w/o taking contribution table in join.
120 if (!empty($query->_returnProperties
['membership_recur_id'])) {
121 $query->_select
['membership_recur_id'] = "civicrm_membership.contribution_recur_id as membership_recur_id";
122 $query->_element
['membership_recur_id'] = 1;
126 if (!empty($query->_returnProperties
['member_campaign_id'])) {
127 $query->_select
['member_campaign_id'] = 'civicrm_membership.campaign_id as member_campaign_id';
128 $query->_element
['member_campaign_id'] = 1;
136 public static function where(&$query) {
138 foreach (array_keys($query->_params
) as $id) {
139 if (empty($query->_params
[$id][0])) {
142 if (substr($query->_params
[$id][0], 0, 7) == 'member_' ||
substr($query->_params
[$id][0], 0, 11) == 'membership_') {
143 if ($query->_mode
== CRM_Contact_BAO_QUERY
::MODE_CONTACTS
) {
144 $query->_useDistinct
= TRUE;
146 $grouping = $query->_params
[$id][3];
147 self
::whereClauseSingle($query->_params
[$id], $query);
156 public static function whereClauseSingle(&$values, &$query) {
157 list($name, $op, $value, $grouping, $wildcard) = $values;
159 case 'member_join_date_low':
160 case 'member_join_date_high':
161 $query->dateQueryBuilder($values,
162 'civicrm_membership', 'member_join_date', 'join_date',
167 case 'member_start_date_low':
168 case 'member_start_date_high':
169 $query->dateQueryBuilder($values,
170 'civicrm_membership', 'member_start_date', 'start_date',
175 case 'member_end_date_low':
176 case 'member_end_date_high':
177 $query->dateQueryBuilder($values,
178 'civicrm_membership', 'member_end_date', 'end_date',
183 case 'member_join_date':
185 $date = CRM_Utils_Date
::format($value);
187 $query->_where
[$grouping][] = "civicrm_membership.join_date {$op} {$date}";
188 $date = CRM_Utils_Date
::customFormat($value);
189 $format = CRM_Utils_Date
::customFormat(CRM_Utils_Date
::format(array_reverse($value), '-'));
190 $query->_qill
[$grouping][] = ts('Member Since %2 %1', array(1 => $format, 2 => $op));
195 case 'member_source':
196 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
197 $value = $strtolower(CRM_Core_DAO
::escapeString(trim($value)));
199 $query->_where
[$grouping][] = "civicrm_membership.source $op '{$value}'";
200 $query->_qill
[$grouping][] = ts('Source %2 %1', array(1 => $value, 2 => $op));
201 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
204 case 'membership_status':
205 case 'member_status_id':
206 if (!is_array($value)) {
208 if (!empty($value)) {
209 $value = array_flip(explode(",", str_replace(array('(', ')'), '', $value)));
216 $status = implode(',', array_keys($value));
217 if (count($value) > 0) {
219 $status = "({$status})";
224 $statusTypes = CRM_Member_PseudoConstant
::membershipStatus(NULL, NULL, 'label');
225 foreach ($value as $id => $dontCare) {
226 $names[] = $statusTypes[$id];
228 $query->_qill
[$grouping][] = ts('Membership Status %1', array(1 => $op)) . ' ' . implode(' ' . ts('or') . ' ', $names);
229 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_membership.status_id",
234 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
238 // We dont want to include all tests for sql OR CRM-7827
239 if (!$value ||
$query->getOperator() != 'OR') {
240 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_membership.is_test", $op, $value, "Boolean");
242 $query->_qill
[$grouping][] = ts('Membership is a Test');
245 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
248 case 'member_auto_renew':
251 $query->_where
[$grouping][] = " civicrm_membership.contribution_recur_id IS NOT NULL";
252 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause(
253 "ccr.contribution_status_id",
257 CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name')
261 $query->_qill
[$grouping][] = ts("Membership is Auto-Renew");
264 $query->_where
[$grouping][] = " civicrm_membership.contribution_recur_id IS NULL";
265 $query->_qill
[$grouping][] = ts("Membership is NOT Auto-Renew");
267 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
270 case 'member_pay_later':
271 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_membership.is_pay_later",
277 $query->_qill
[$grouping][] = ts("Membership is Pay Later");
280 $query->_qill
[$grouping][] = ts("Membership is NOT Pay Later");
282 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
285 case 'membership_type':
286 case 'member_membership_type_id':
287 if (!is_array($value)) {
289 if (!empty($value)) {
290 $value = array_flip(explode(",", str_replace(array('(', ')'), '', $value)));
297 $mType = implode(',', array_keys($value));
298 if (count($value) > 0) {
300 $mType = "({$mType})";
305 $membershipTypes = CRM_Member_PseudoConstant
::membershipType();
306 foreach ($value as $id => $dontCare) {
307 if (!empty($membershipTypes[$id])) {
308 $names[] = $membershipTypes[$id];
311 $query->_qill
[$grouping][] = ts('Membership Type %1', array(1 => $op)) . ' ' . implode(' ' . ts('or') . ' ', $names);
312 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_membership.membership_type_id",
317 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
321 $query->_where
[$grouping][] = " civicrm_membership.id $op $value";
322 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
325 case 'member_is_primary':
327 $query->_where
[$grouping][] = " civicrm_membership.owner_membership_id IS NULL";
328 $query->_qill
[$grouping][] = ts("Primary Members Only");
331 $query->_where
[$grouping][] = " civicrm_membership.owner_membership_id IS NOT NULL";
332 $query->_qill
[$grouping][] = ts("Related Members Only");
334 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
337 case 'member_campaign_id':
340 'campaign' => $value,
341 'grouping' => $grouping,
342 'tableName' => 'civicrm_membership',
344 CRM_Campaign_BAO_Query
::componentSearchClause($campParams, $query);
350 * @param string $name
354 * @return null|string
356 public static function from($name, $mode, $side) {
359 case 'civicrm_membership':
360 $from = " $side JOIN civicrm_membership ON civicrm_membership.contact_id = contact_a.id ";
361 $from .= " $side JOIN civicrm_contribution_recur ccr ON ( civicrm_membership.contribution_recur_id = ccr.id )";
364 case 'civicrm_membership_type':
365 if ($mode & CRM_Contact_BAO_Query
::MODE_MEMBER
) {
366 $from = " INNER JOIN civicrm_membership_type ON civicrm_membership.membership_type_id = civicrm_membership_type.id ";
369 $from = " $side JOIN civicrm_membership_type ON civicrm_membership.membership_type_id = civicrm_membership_type.id ";
373 case 'civicrm_membership_status':
374 if ($mode & CRM_Contact_BAO_Query
::MODE_MEMBER
) {
375 $from = " INNER JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id ";
378 $from = " $side JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id ";
382 case 'civicrm_membership_payment':
383 $from = " $side JOIN civicrm_membership_payment ON civicrm_membership_payment.membership_id = civicrm_membership.id ";
391 * @param bool $includeCustomFields
395 public static function defaultReturnProperties(
397 $includeCustomFields = TRUE
400 if ($mode & CRM_Contact_BAO_Query
::MODE_MEMBER
) {
403 'contact_sub_type' => 1,
406 'membership_type' => 1,
407 'member_is_test' => 1,
408 'member_is_pay_later' => 1,
410 'membership_start_date' => 1,
411 'membership_end_date' => 1,
412 'membership_source' => 1,
413 'membership_status' => 1,
414 'membership_id' => 1,
415 'owner_membership_id' => 1,
417 'membership_recur_id' => 1,
418 'member_campaign_id' => 1,
421 if ($includeCustomFields) {
422 // also get all the custom membership properties
423 $fields = CRM_Core_BAO_CustomField
::getFieldsForImport('Membership');
424 if (!empty($fields)) {
425 foreach ($fields as $name => $dontCare) {
426 $properties[$name] = 1;
436 * @param CRM_Core_Form $form
438 public static function buildSearchForm(&$form) {
439 foreach (CRM_Member_PseudoConstant
::membershipType() as $id => $Name) {
440 $form->_membershipType
= &$form->addElement('checkbox', "member_membership_type_id[$id]", NULL, $Name);
443 foreach (CRM_Member_PseudoConstant
::membershipStatus(NULL, NULL, 'label') as $sId => $sName) {
444 $form->_membershipStatus
= &$form->addElement('checkbox', "member_status_id[$sId]", NULL, $sName);
447 $form->addElement('text', 'member_source', ts('Source'));
449 CRM_Core_Form_Date
::buildDateRange($form, 'member_join_date', 1, '_low', '_high', ts('From'), FALSE);
451 CRM_Core_Form_Date
::buildDateRange($form, 'member_start_date', 1, '_low', '_high', ts('From'), FALSE);
453 CRM_Core_Form_Date
::buildDateRange($form, 'member_end_date', 1, '_low', '_high', ts('From'), FALSE);
455 $form->addYesNo('member_is_primary', ts('Primary Member?'), TRUE);
456 $form->addYesNo('member_pay_later', ts('Pay Later?'), TRUE);
457 $form->addYesNo('member_auto_renew', ts('Auto-Renew?'), TRUE);
458 $form->addYesNo('member_test', ts('Membership is a Test?'), TRUE);
460 // add all the custom searchable fields
461 $extends = array('Membership');
462 $groupDetails = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, TRUE, $extends);
464 $form->assign('membershipGroupTree', $groupDetails);
465 foreach ($groupDetails as $group) {
466 foreach ($group['fields'] as $field) {
467 $fieldId = $field['id'];
468 $elementName = 'custom_' . $fieldId;
469 CRM_Core_BAO_CustomField
::addQuickFormElement($form,
478 CRM_Campaign_BAO_Campaign
::addCampaignInComponentSearch($form, 'member_campaign_id');
480 $form->assign('validCiviMember', TRUE);
481 $form->setDefaults(array('member_test' => 0));
488 public static function searchAction(&$row, $id) {
494 public static function tableNames(&$tables) {
495 //add membership table
496 if (!empty($tables['civicrm_membership_log']) ||
!empty($tables['civicrm_membership_status']) || CRM_Utils_Array
::value('civicrm_membership_type', $tables)) {
497 $tables = array_merge(array('civicrm_membership' => 1), $tables);