3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
35 class CRM_Member_BAO_Query
{
37 static function &getFields() {
38 $fields = CRM_Member_BAO_Membership
::exportableFields();
43 * if membership are involved, add the specific membership fields
48 static function select(&$query) {
49 // if membership mode add membership id
50 if ($query->_mode
& CRM_Contact_BAO_Query
::MODE_MEMBER ||
51 CRM_Contact_BAO_Query
::componentPresent($query->_returnProperties
, 'membership_')
54 $query->_select
['membership_id'] = "civicrm_membership.id as membership_id";
55 $query->_element
['membership_id'] = 1;
56 $query->_tables
['civicrm_membership'] = 1;
57 $query->_whereTables
['civicrm_membership'] = 1;
60 if (CRM_Utils_Array
::value('membership_type', $query->_returnProperties
)) {
61 $query->_select
['membership_type'] = "civicrm_membership_type.name as membership_type";
62 $query->_element
['membership_type'] = 1;
63 $query->_tables
['civicrm_membership_type'] = 1;
64 $query->_whereTables
['civicrm_membership_type'] = 1;
68 if (CRM_Utils_Array
::value('join_date', $query->_returnProperties
)) {
69 $query->_select
['join_date'] = "civicrm_membership.join_date as join_date";
70 $query->_element
['join_date'] = 1;
74 if (CRM_Utils_Array
::value('membership_source', $query->_returnProperties
)) {
75 $query->_select
['membership_source'] = "civicrm_membership.source as membership_source";
76 $query->_element
['membership_source'] = 1;
80 if (CRM_Utils_Array
::value('membership_status', $query->_returnProperties
)) {
81 $query->_select
['membership_status'] = "civicrm_membership_status.label as membership_status";
82 $query->_element
['membership_status'] = 1;
83 $query->_tables
['civicrm_membership_status'] = 1;
84 $query->_whereTables
['civicrm_membership_status'] = 1;
87 if (CRM_Utils_Array
::value('status_id', $query->_returnProperties
)) {
88 $query->_select
['status_id'] = "civicrm_membership_status.id as status_id";
89 $query->_element
['status_id'] = 1;
90 $query->_tables
['civicrm_membership_status'] = 1;
91 $query->_whereTables
['civicrm_membership_status'] = 1;
94 //add start date / end date
95 if (CRM_Utils_Array
::value('membership_start_date', $query->_returnProperties
)) {
96 $query->_select
['membership_start_date'] = "civicrm_membership.start_date as membership_start_date";
97 $query->_element
['membership_start_date'] = 1;
100 if (CRM_Utils_Array
::value('membership_end_date', $query->_returnProperties
)) {
101 $query->_select
['membership_end_date'] = "civicrm_membership.end_date as membership_end_date";
102 $query->_element
['membership_end_date'] = 1;
105 //add owner_membership_id
106 if (CRM_Utils_Array
::value('owner_membership_id', $query->_returnProperties
)) {
107 $query->_select
['owner_membership_id'] = "civicrm_membership.owner_membership_id as owner_membership_id";
108 $query->_element
['owner_membership_id'] = 1;
111 if (CRM_Utils_Array
::value('max_related', $query->_returnProperties
)) {
112 $query->_select
['max_related'] = "civicrm_membership.max_related as max_related";
113 $query->_element
['max_related'] = 1;
115 //add recur id w/o taking contribution table in join.
116 if (CRM_Utils_Array
::value('membership_recur_id', $query->_returnProperties
)) {
117 $query->_select
['membership_recur_id'] = "civicrm_membership.contribution_recur_id as membership_recur_id";
118 $query->_element
['membership_recur_id'] = 1;
122 if (CRM_Utils_Array
::value('member_campaign_id', $query->_returnProperties
)) {
123 $query->_select
['member_campaign_id'] = 'civicrm_membership.campaign_id as member_campaign_id';
124 $query->_element
['member_campaign_id'] = 1;
129 static function where(&$query) {
131 foreach (array_keys($query->_params
) as $id) {
132 if (!CRM_Utils_Array
::value(0, $query->_params
[$id])) {
135 if (substr($query->_params
[$id][0], 0, 7) == 'member_' ||
substr($query->_params
[$id][0], 0, 11) == 'membership_') {
136 if ($query->_mode
== CRM_Contact_BAO_QUERY
::MODE_CONTACTS
) {
137 $query->_useDistinct
= TRUE;
139 $grouping = $query->_params
[$id][3];
140 self
::whereClauseSingle($query->_params
[$id], $query);
145 static function whereClauseSingle(&$values, &$query) {
146 list($name, $op, $value, $grouping, $wildcard) = $values;
148 case 'member_join_date_low':
149 case 'member_join_date_high':
150 $query->dateQueryBuilder($values,
151 'civicrm_membership', 'member_join_date', 'join_date',
156 case 'member_start_date_low':
157 case 'member_start_date_high':
158 $query->dateQueryBuilder($values,
159 'civicrm_membership', 'member_start_date', 'start_date',
164 case 'member_end_date_low':
165 case 'member_end_date_high':
166 $query->dateQueryBuilder($values,
167 'civicrm_membership', 'member_end_date', 'end_date',
172 case 'member_join_date':
174 $date = CRM_Utils_Date
::format($value);
176 $query->_where
[$grouping][] = "civicrm_membership.join_date {$op} {$date}";
177 $date = CRM_Utils_Date
::customFormat($value);
178 $format = CRM_Utils_Date
::customFormat(CRM_Utils_Date
::format(array_reverse($value), '-'));
179 $query->_qill
[$grouping][] = ts('Member Since %2 %1', array(1 => $format, 2 => $op));
184 case 'member_source':
185 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
186 $value = $strtolower(CRM_Core_DAO
::escapeString(trim($value)));
188 $query->_where
[$grouping][] = "civicrm_membership.source $op '{$value}'";
189 $query->_qill
[$grouping][] = ts('Source %2 %1', array(1 => $value, 2 => $op));
190 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
193 case 'membership_status':
194 case 'member_status_id':
195 if (!is_array($value)) {
197 if (!empty($value)) {
198 $value = array_flip(explode(",", str_replace(array( '(', ')' ), '', $value)));
205 $status = implode(',', array_keys($value));
206 if (count($value) > 1) {
208 $status = "({$status})";
213 $statusTypes = CRM_Member_PseudoConstant
::membershipStatus(NULL, NULL, 'label');
214 foreach ($value as $id => $dontCare) {
215 $names[] = $statusTypes[$id];
217 $query->_qill
[$grouping][] = ts('Membership Status %1', array(1 => $op)) . ' ' . implode(' ' . ts('or') . ' ', $names);
218 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_membership.status_id",
223 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
227 // We dont want to include all tests for sql OR CRM-7827
228 if (!$value ||
$query->getOperator() != 'OR') {
229 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_membership.is_test", $op, $value, "Boolean");
231 $query->_qill
[$grouping][] = ts('Membership is a Test');
234 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
237 case 'member_auto_renew':
240 $query->_where
[$grouping][] = " civicrm_membership.contribution_recur_id IS NOT NULL";
241 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause(
242 "ccr.contribution_status_id",
244 CRM_Core_DAO
::getFieldValue(
245 'CRM_Core_DAO_OptionValue',
252 $query->_qill
[$grouping][] = ts("Membership is Auto-Renew");
255 $query->_where
[$grouping][] = " civicrm_membership.contribution_recur_id IS NULL";
256 $query->_qill
[$grouping][] = ts("Membership is NOT Auto-Renew");
258 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
261 case 'member_pay_later':
262 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_membership.is_pay_later",
268 $query->_qill
[$grouping][] = ts("Membership is Pay Later");
271 $query->_qill
[$grouping][] = ts("Membership is NOT Pay Later");
273 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
276 case 'membership_type':
277 case 'member_membership_type_id':
278 if (!is_array($value)) {
280 if (!empty($value)) {
281 $value = array_flip(explode(",", str_replace(array( '(', ')' ), '', $value)));
288 $mType = implode(',', array_keys($value));
289 if (count($value) > 1) {
291 $mType = "({$mType})";
296 $membershipTypes = CRM_Member_PseudoConstant
::membershipType();
297 foreach ($value as $id => $dontCare) {
298 if(!empty($membershipTypes[$id])) {
299 $names[] = $membershipTypes[$id];
302 $query->_qill
[$grouping][] = ts('Membership Type %1', array(1 => $op)) . ' ' . implode(' ' . ts('or') . ' ', $names);
303 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_membership.membership_type_id",
308 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
312 $query->_where
[$grouping][] = " civicrm_membership.id $op $value";
313 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
316 case 'member_is_primary':
318 $query->_where
[$grouping][] = " civicrm_membership.owner_membership_id IS NULL";
319 $query->_qill
[$grouping][] = ts("Primary Members Only");
322 $query->_where
[$grouping][] = " civicrm_membership.owner_membership_id IS NOT NULL";
323 $query->_qill
[$grouping][] = ts("Related Members Only");
325 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
328 case 'member_campaign_id':
331 'campaign' => $value,
332 'grouping' => $grouping,
333 'tableName' => 'civicrm_membership',
335 CRM_Campaign_BAO_Query
::componentSearchClause($campParams, $query);
340 static function from($name, $mode, $side) {
343 case 'civicrm_membership':
344 $from = " $side JOIN civicrm_membership ON civicrm_membership.contact_id = contact_a.id ";
345 $from .= " $side JOIN civicrm_contribution_recur ccr ON ( civicrm_membership.contribution_recur_id = ccr.id )";
348 case 'civicrm_membership_type':
349 if ($mode & CRM_Contact_BAO_Query
::MODE_MEMBER
) {
350 $from = " INNER JOIN civicrm_membership_type ON civicrm_membership.membership_type_id = civicrm_membership_type.id ";
353 $from = " $side JOIN civicrm_membership_type ON civicrm_membership.membership_type_id = civicrm_membership_type.id ";
357 case 'civicrm_membership_status':
358 if ($mode & CRM_Contact_BAO_Query
::MODE_MEMBER
) {
359 $from = " INNER JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id ";
362 $from = " $side JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id ";
366 case 'civicrm_membership_payment':
367 $from = " $side JOIN civicrm_membership_payment ON civicrm_membership_payment.membership_id = civicrm_membership.id ";
373 static function defaultReturnProperties($mode,
374 $includeCustomFields = TRUE
377 if ($mode & CRM_Contact_BAO_Query
::MODE_MEMBER
) {
380 'contact_sub_type' => 1,
383 'membership_type' => 1,
384 'member_is_test' => 1,
385 'member_is_pay_later' => 1,
387 'membership_start_date' => 1,
388 'membership_end_date' => 1,
389 'membership_source' => 1,
390 'membership_status' => 1,
391 'membership_id' => 1,
392 'owner_membership_id' => 1,
394 'membership_recur_id' => 1,
395 'member_campaign_id' => 1,
398 if ($includeCustomFields) {
399 // also get all the custom membership properties
400 $fields = CRM_Core_BAO_CustomField
::getFieldsForImport('Membership');
401 if (!empty($fields)) {
402 foreach ($fields as $name => $dontCare) {
403 $properties[$name] = 1;
412 static function buildSearchForm(&$form) {
413 foreach (CRM_Member_PseudoConstant
::membershipType() as $id => $Name) {
414 $form->_membershipType
= &$form->addElement('checkbox', "member_membership_type_id[$id]", NULL, $Name);
418 foreach (CRM_Member_PseudoConstant
::membershipStatus(NULL, NULL, 'label') as $sId => $sName) {
419 $form->_membershipStatus
= &$form->addElement('checkbox', "member_status_id[$sId]", NULL, $sName);
422 $form->addElement('text', 'member_source', ts('Source'));
424 CRM_Core_Form_Date
::buildDateRange($form, 'member_join_date', 1, '_low', '_high', ts('From'), FALSE);
426 CRM_Core_Form_Date
::buildDateRange($form, 'member_start_date', 1, '_low', '_high', ts('From'), FALSE);
428 CRM_Core_Form_Date
::buildDateRange($form, 'member_end_date', 1, '_low', '_high', ts('From'), FALSE);
430 $form->addYesNo('member_is_primary', ts('Primary Member?'));
431 $form->addYesNo('member_pay_later', ts('Pay Later?'));
432 $form->addYesNo('member_auto_renew', ts('Auto-Renew?'));
433 $form->addYesNo('member_test', ts('Membership is a Test?'));
435 // add all the custom searchable fields
436 $extends = array('Membership');
437 $groupDetails = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, TRUE, $extends);
439 $form->assign('membershipGroupTree', $groupDetails);
440 foreach ($groupDetails as $group) {
441 foreach ($group['fields'] as $field) {
442 $fieldId = $field['id'];
443 $elementName = 'custom_' . $fieldId;
444 CRM_Core_BAO_CustomField
::addQuickFormElement($form,
453 CRM_Campaign_BAO_Campaign
::addCampaignInComponentSearch($form, 'member_campaign_id');
455 $form->assign('validCiviMember', TRUE);
456 $form->setDefaults(array('member_test' => 0));
459 static function searchAction(&$row, $id) {}
461 static function addShowHide(&$showHide) {
462 $showHide->addHide('memberForm');
463 $showHide->addShow('memberForm_show');
466 static function tableNames(&$tables) {
467 //add membership table
468 if (CRM_Utils_Array
::value('civicrm_membership_log', $tables) || CRM_Utils_Array
::value('civicrm_membership_status', $tables) || CRM_Utils_Array
::value('civicrm_membership_type', $tables)) {
469 $tables = array_merge(array('civicrm_membership' => 1), $tables);