3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
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
33 class CRM_Member_BAO_Query
{
36 * Get available fields.
40 public static function &getFields() {
41 $fields = CRM_Member_BAO_Membership
::exportableFields();
46 * If membership are involved, add the specific membership fields.
48 * @param CRM_Contact_BAO_Query $query
50 public static function select(&$query) {
51 // if membership mode add membership id
52 if ($query->_mode
& CRM_Contact_BAO_Query
::MODE_MEMBER ||
53 CRM_Contact_BAO_Query
::componentPresent($query->_returnProperties
, 'membership_')
56 $query->_select
['membership_id'] = "civicrm_membership.id as membership_id";
57 $query->_element
['membership_id'] = 1;
58 $query->_tables
['civicrm_membership'] = 1;
59 $query->_whereTables
['civicrm_membership'] = 1;
62 if (!empty($query->_returnProperties
['membership_type'])) {
63 $query->_select
['membership_type'] = "civicrm_membership_type.name as membership_type";
64 $query->_element
['membership_type'] = 1;
65 $query->_tables
['civicrm_membership_type'] = 1;
66 $query->_whereTables
['civicrm_membership_type'] = 1;
70 if (!empty($query->_returnProperties
['join_date'])) {
71 $query->_select
['join_date'] = "civicrm_membership.join_date as join_date";
72 $query->_element
['join_date'] = 1;
76 if (!empty($query->_returnProperties
['membership_source'])) {
77 $query->_select
['membership_source'] = "civicrm_membership.source as membership_source";
78 $query->_element
['membership_source'] = 1;
82 if (!empty($query->_returnProperties
['membership_status'])) {
83 $query->_select
['membership_status'] = "civicrm_membership_status.label as membership_status";
84 $query->_element
['membership_status'] = 1;
85 $query->_tables
['civicrm_membership_status'] = 1;
86 $query->_whereTables
['civicrm_membership_status'] = 1;
89 if (!empty($query->_returnProperties
['membership_status_id'])) {
90 $query->_select
['status_id'] = "civicrm_membership_status.id as status_id";
91 $query->_element
['status_id'] = 1;
92 $query->_tables
['civicrm_membership_status'] = 1;
93 $query->_whereTables
['civicrm_membership_status'] = 1;
96 //add start date / end date
97 if (!empty($query->_returnProperties
['membership_start_date'])) {
98 $query->_select
['membership_start_date'] = "civicrm_membership.start_date as membership_start_date";
99 $query->_element
['membership_start_date'] = 1;
102 if (!empty($query->_returnProperties
['membership_end_date'])) {
103 $query->_select
['membership_end_date'] = "civicrm_membership.end_date as membership_end_date";
104 $query->_element
['membership_end_date'] = 1;
107 //add owner_membership_id
108 if (!empty($query->_returnProperties
['owner_membership_id'])) {
109 $query->_select
['owner_membership_id'] = "civicrm_membership.owner_membership_id as owner_membership_id";
110 $query->_element
['owner_membership_id'] = 1;
113 if (!empty($query->_returnProperties
['max_related'])) {
114 $query->_select
['max_related'] = "civicrm_membership.max_related as max_related";
115 $query->_element
['max_related'] = 1;
117 //add recur id w/o taking contribution table in join.
118 if (!empty($query->_returnProperties
['membership_recur_id'])) {
119 $query->_select
['membership_recur_id'] = "civicrm_membership.contribution_recur_id as membership_recur_id";
120 $query->_element
['membership_recur_id'] = 1;
124 if (!empty($query->_returnProperties
['member_campaign_id'])) {
125 $query->_select
['member_campaign_id'] = 'civicrm_membership.campaign_id as member_campaign_id';
126 $query->_element
['member_campaign_id'] = 1;
132 * Generate where clause.
134 * @param CRM_Contact_BAO_Query $query
136 public static function where(&$query) {
137 foreach (array_keys($query->_params
) as $id) {
138 if (empty($query->_params
[$id][0])) {
141 if (substr($query->_params
[$id][0], 0, 7) == 'member_' ||
substr($query->_params
[$id][0], 0, 11) == 'membership_') {
142 if ($query->_mode
== CRM_Contact_BAO_QUERY
::MODE_CONTACTS
) {
143 $query->_useDistinct
= TRUE;
145 self
::whereClauseSingle($query->_params
[$id], $query);
151 * Generate where for a single parameter.
153 * @param array $values
154 * @param CRM_Contact_BAO_Query $query
156 public static function whereClauseSingle(&$values, &$query) {
157 list($name, $op, $value, $grouping) = $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 $format = CRM_Utils_Date
::customFormat(CRM_Utils_Date
::format(array_reverse($value), '-'));
189 $query->_qill
[$grouping][] = ts('Member Since %2 %1', array(1 => $format, 2 => $op));
194 case 'member_source':
195 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
196 $value = $strtolower(CRM_Core_DAO
::escapeString(trim($value)));
198 $query->_where
[$grouping][] = "civicrm_membership.source $op '{$value}'";
199 $query->_qill
[$grouping][] = ts('Source %2 %1', array(1 => $value, 2 => $op));
200 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
203 // CRM-17011 These 2 variants appear in some smart groups saved at some time prior to 4.6.6.
204 case 'member_status_id':
205 case 'member_membership_type_id':
206 if (is_array($value)) {
208 $value = array_keys($value);
210 case 'membership_status':
211 case 'membership_status_id':
212 case 'membership_type':
213 case 'membership_type_id':
214 // CRM-17075 we are specifically handling the possibility we are dealing with the entity reference field
215 // for membership_type_id here (although status would be handled if converted). The unhandled pathway at the moment
216 // is from groupContactCache::load and this is a small fix to get the entity reference field to work.
217 // However, it would seem the larger fix would be to NOT invoke the form formValues for
218 // the load function. The where clause and the whereTables are saved so they should suffice to generate the query
219 // to get a contact list. But, better to deal with in 4.8 now...
220 if (is_string($value) && strpos($value, ',') && $op == '=') {
221 $value = array('IN' => explode(',', $value));
224 case 'member_campaign_id':
226 if (strpos($name, 'status') !== FALSE) {
228 $qillName = 'Membership Status(s)';
230 elseif ($name == 'member_id') {
232 $qillName = 'Membership ID';
234 elseif ($name == 'member_campaign_id') {
235 $name = 'campaign_id';
236 $qillName = 'Campaign';
239 $name = 'membership_type_id';
240 $qillName = 'Membership Type(s)';
242 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_membership.$name",
247 list($op, $value) = CRM_Contact_BAO_Query
::buildQillForFieldValue('CRM_Member_DAO_Membership', $name, $value, $op);
248 $query->_qill
[$grouping][] = ts('%1 %2 %3', array(
253 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
257 // We dont want to include all tests for sql OR CRM-7827
258 if (!$value ||
$query->getOperator() != 'OR') {
259 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_membership.is_test", $op, $value, "Boolean");
261 $query->_qill
[$grouping][] = ts('Membership is a Test');
264 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
267 case 'member_auto_renew':
270 $query->_where
[$grouping][] = " civicrm_membership.contribution_recur_id IS NOT NULL";
271 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause(
272 "ccr.contribution_status_id",
276 CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name')
280 $query->_qill
[$grouping][] = ts("Membership is Auto-Renew");
283 $query->_where
[$grouping][] = " civicrm_membership.contribution_recur_id IS NULL";
284 $query->_qill
[$grouping][] = ts("Membership is NOT Auto-Renew");
286 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
289 case 'member_pay_later':
290 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_membership.is_pay_later",
296 $query->_qill
[$grouping][] = ts("Membership is Pay Later");
299 $query->_qill
[$grouping][] = ts("Membership is NOT Pay Later");
301 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
304 case 'member_is_primary':
306 $query->_where
[$grouping][] = " civicrm_membership.owner_membership_id IS NULL";
307 $query->_qill
[$grouping][] = ts("Primary Members Only");
310 $query->_where
[$grouping][] = " civicrm_membership.owner_membership_id IS NOT NULL";
311 $query->_qill
[$grouping][] = ts("Related Members Only");
313 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
316 case 'member_is_override':
317 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_membership.is_override", $op, $value, "Boolean");
318 $query->_qill
[$grouping][] = $value ?
ts("Is Membership Status overriden? Yes") : ts("Is Membership Status overriden? No");
319 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
325 * Generate from clause.
327 * @param string $name
329 * @param string $side
333 public static function from($name, $mode, $side) {
336 case 'civicrm_membership':
337 $from = " $side JOIN civicrm_membership ON civicrm_membership.contact_id = contact_a.id ";
338 $from .= " $side JOIN civicrm_contribution_recur ccr ON ( civicrm_membership.contribution_recur_id = ccr.id )";
341 case 'civicrm_membership_type':
342 if ($mode & CRM_Contact_BAO_Query
::MODE_MEMBER
) {
343 $from = " INNER JOIN civicrm_membership_type ON civicrm_membership.membership_type_id = civicrm_membership_type.id ";
346 $from = " $side JOIN civicrm_membership_type ON civicrm_membership.membership_type_id = civicrm_membership_type.id ";
350 case 'civicrm_membership_status':
351 if ($mode & CRM_Contact_BAO_Query
::MODE_MEMBER
) {
352 $from = " INNER JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id ";
355 $from = " $side JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id ";
359 case 'civicrm_membership_payment':
360 $from = " $side JOIN civicrm_membership_payment ON civicrm_membership_payment.membership_id = civicrm_membership.id ";
367 * Get default return properties.
369 * @param string $mode
370 * @param bool $includeCustomFields
374 public static function defaultReturnProperties(
376 $includeCustomFields = TRUE
379 if ($mode & CRM_Contact_BAO_Query
::MODE_MEMBER
) {
382 'contact_sub_type' => 1,
385 'membership_type' => 1,
386 'member_is_test' => 1,
387 'member_is_pay_later' => 1,
389 'membership_start_date' => 1,
390 'membership_end_date' => 1,
391 'membership_source' => 1,
392 'membership_status' => 1,
393 'membership_id' => 1,
394 'owner_membership_id' => 1,
396 'membership_recur_id' => 1,
397 'member_campaign_id' => 1,
398 'member_is_override' => 1,
401 if ($includeCustomFields) {
402 // also get all the custom membership properties
403 $fields = CRM_Core_BAO_CustomField
::getFieldsForImport('Membership');
404 if (!empty($fields)) {
405 foreach ($fields as $name => $dontCare) {
406 $properties[$name] = 1;
416 * Build the search form.
418 * @param CRM_Core_Form $form
420 public static function buildSearchForm(&$form) {
421 $membershipStatus = CRM_Member_PseudoConstant
::membershipStatus(NULL, NULL, 'label', FALSE, FALSE);
422 $form->add('select', 'membership_status_id', ts('Membership Status(s)'), $membershipStatus, FALSE, array(
423 'id' => 'membership_status_id',
424 'multiple' => 'multiple',
425 'class' => 'crm-select2',
428 $form->addEntityRef('membership_type_id', ts('Membership Type(s)'), array(
429 'entity' => 'MembershipType',
431 'placeholder' => ts('- any -'),
432 'select' => array('minimumInputLength' => 0),
435 $form->addElement('text', 'member_source', ts('Source'));
437 CRM_Core_Form_Date
::buildDateRange($form, 'member_join_date', 1, '_low', '_high', ts('From'), FALSE);
439 CRM_Core_Form_Date
::buildDateRange($form, 'member_start_date', 1, '_low', '_high', ts('From'), FALSE);
441 CRM_Core_Form_Date
::buildDateRange($form, 'member_end_date', 1, '_low', '_high', ts('From'), FALSE);
443 $form->addYesNo('member_is_primary', ts('Primary Member?'), TRUE);
444 $form->addYesNo('member_pay_later', ts('Pay Later?'), TRUE);
445 $form->addYesNo('member_auto_renew', ts('Auto-Renew?'), TRUE);
446 $form->addYesNo('member_test', ts('Membership is a Test?'), TRUE);
447 $form->addYesNo('member_is_override', ts('Membership Status Is Override?'), TRUE);
449 // add all the custom searchable fields
450 $extends = array('Membership');
451 $groupDetails = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, TRUE, $extends);
453 $form->assign('membershipGroupTree', $groupDetails);
454 foreach ($groupDetails as $group) {
455 foreach ($group['fields'] as $field) {
456 $fieldId = $field['id'];
457 $elementName = 'custom_' . $fieldId;
458 CRM_Core_BAO_CustomField
::addQuickFormElement($form,
467 CRM_Campaign_BAO_Campaign
::addCampaignInComponentSearch($form, 'member_campaign_id');
469 $form->assign('validCiviMember', TRUE);
470 $form->setDefaults(array('member_test' => 0));
474 * Possibly un-required function.
479 public static function searchAction(&$row, $id) {
483 * Add membership table.
485 * @param array $tables
487 public static function tableNames(&$tables) {
488 if (!empty($tables['civicrm_membership_log']) ||
!empty($tables['civicrm_membership_status']) || CRM_Utils_Array
::value('civicrm_membership_type', $tables)) {
489 $tables = array_merge(array('civicrm_membership' => 1), $tables);