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
33 class CRM_Member_BAO_Query
{
38 public static function &getFields() {
39 $fields = CRM_Member_BAO_Membership
::exportableFields();
44 * If membership are involved, add the specific membership fields
48 public 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 (!empty($query->_returnProperties
['membership_type'])) {
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 (!empty($query->_returnProperties
['join_date'])) {
69 $query->_select
['join_date'] = "civicrm_membership.join_date as join_date";
70 $query->_element
['join_date'] = 1;
74 if (!empty($query->_returnProperties
['membership_source'])) {
75 $query->_select
['membership_source'] = "civicrm_membership.source as membership_source";
76 $query->_element
['membership_source'] = 1;
80 if (!empty($query->_returnProperties
['membership_status'])) {
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 (!empty($query->_returnProperties
['membership_status_id'])) {
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 (!empty($query->_returnProperties
['membership_start_date'])) {
96 $query->_select
['membership_start_date'] = "civicrm_membership.start_date as membership_start_date";
97 $query->_element
['membership_start_date'] = 1;
100 if (!empty($query->_returnProperties
['membership_end_date'])) {
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 (!empty($query->_returnProperties
['owner_membership_id'])) {
107 $query->_select
['owner_membership_id'] = "civicrm_membership.owner_membership_id as owner_membership_id";
108 $query->_element
['owner_membership_id'] = 1;
111 if (!empty($query->_returnProperties
['max_related'])) {
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 (!empty($query->_returnProperties
['membership_recur_id'])) {
117 $query->_select
['membership_recur_id'] = "civicrm_membership.contribution_recur_id as membership_recur_id";
118 $query->_element
['membership_recur_id'] = 1;
122 if (!empty($query->_returnProperties
['member_campaign_id'])) {
123 $query->_select
['member_campaign_id'] = 'civicrm_membership.campaign_id as member_campaign_id';
124 $query->_element
['member_campaign_id'] = 1;
132 public static function where(&$query) {
134 foreach (array_keys($query->_params
) as $id) {
135 if (empty($query->_params
[$id][0])) {
138 if (substr($query->_params
[$id][0], 0, 7) == 'member_' ||
substr($query->_params
[$id][0], 0, 11) == 'membership_') {
139 if ($query->_mode
== CRM_Contact_BAO_QUERY
::MODE_CONTACTS
) {
140 $query->_useDistinct
= TRUE;
142 $grouping = $query->_params
[$id][3];
143 self
::whereClauseSingle($query->_params
[$id], $query);
152 public static function whereClauseSingle(&$values, &$query) {
153 list($name, $op, $value, $grouping, $wildcard) = $values;
155 case 'member_join_date_low':
156 case 'member_join_date_high':
157 $query->dateQueryBuilder($values,
158 'civicrm_membership', 'member_join_date', 'join_date',
163 case 'member_start_date_low':
164 case 'member_start_date_high':
165 $query->dateQueryBuilder($values,
166 'civicrm_membership', 'member_start_date', 'start_date',
171 case 'member_end_date_low':
172 case 'member_end_date_high':
173 $query->dateQueryBuilder($values,
174 'civicrm_membership', 'member_end_date', 'end_date',
179 case 'member_join_date':
181 $date = CRM_Utils_Date
::format($value);
183 $query->_where
[$grouping][] = "civicrm_membership.join_date {$op} {$date}";
184 $date = CRM_Utils_Date
::customFormat($value);
185 $format = CRM_Utils_Date
::customFormat(CRM_Utils_Date
::format(array_reverse($value), '-'));
186 $query->_qill
[$grouping][] = ts('Member Since %2 %1', array(1 => $format, 2 => $op));
191 case 'member_source':
192 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
193 $value = $strtolower(CRM_Core_DAO
::escapeString(trim($value)));
195 $query->_where
[$grouping][] = "civicrm_membership.source $op '{$value}'";
196 $query->_qill
[$grouping][] = ts('Source %2 %1', array(1 => $value, 2 => $op));
197 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
200 // CRM-17011 These 2 variants appear in some smart groups saved at some time prior to 4.6.6.
201 case 'member_status_id':
202 case 'member_membership_type_id':
203 if (is_array($value)) {
205 $value = array_keys($value);
207 case 'membership_status':
208 case 'membership_status_id':
209 case 'membership_type':
210 case 'membership_type_id':
212 if (strpos($name, 'status') !== FALSE) {
214 $qillName = 'Membership Status(s)';
216 elseif ($name == 'member_id') {
218 $qillName = 'Membership ID';
221 $name = 'membership_type_id';
222 $qillName = 'Membership Type(s)';
224 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_membership.$name",
229 list($op, $value) = CRM_Contact_BAO_Query
::buildQillForFieldValue('CRM_Member_DAO_Membership', $name, $value, $op);
230 $query->_qill
[$grouping][] = ts('%1 %2 %3', array(1 => $qillName, 2 => $op, 3 => $value));
231 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
235 // We dont want to include all tests for sql OR CRM-7827
236 if (!$value ||
$query->getOperator() != 'OR') {
237 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_membership.is_test", $op, $value, "Boolean");
239 $query->_qill
[$grouping][] = ts('Membership is a Test');
242 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
245 case 'member_auto_renew':
248 $query->_where
[$grouping][] = " civicrm_membership.contribution_recur_id IS NOT NULL";
249 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause(
250 "ccr.contribution_status_id",
254 CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name')
258 $query->_qill
[$grouping][] = ts("Membership is Auto-Renew");
261 $query->_where
[$grouping][] = " civicrm_membership.contribution_recur_id IS NULL";
262 $query->_qill
[$grouping][] = ts("Membership is NOT Auto-Renew");
264 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
267 case 'member_pay_later':
268 $query->_where
[$grouping][] = CRM_Contact_BAO_Query
::buildClause("civicrm_membership.is_pay_later",
274 $query->_qill
[$grouping][] = ts("Membership is Pay Later");
277 $query->_qill
[$grouping][] = ts("Membership is NOT Pay Later");
279 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
282 case 'member_is_primary':
284 $query->_where
[$grouping][] = " civicrm_membership.owner_membership_id IS NULL";
285 $query->_qill
[$grouping][] = ts("Primary Members Only");
288 $query->_where
[$grouping][] = " civicrm_membership.owner_membership_id IS NOT NULL";
289 $query->_qill
[$grouping][] = ts("Related Members Only");
291 $query->_tables
['civicrm_membership'] = $query->_whereTables
['civicrm_membership'] = 1;
294 case 'member_campaign_id':
295 if (CRM_Utils_Array
::value($op, $value)) {
296 $value = $value[$op];
300 'campaign' => $value,
301 'grouping' => $grouping,
302 'tableName' => 'civicrm_membership',
304 CRM_Campaign_BAO_Query
::componentSearchClause($campParams, $query);
310 * @param string $name
314 * @return null|string
316 public static function from($name, $mode, $side) {
319 case 'civicrm_membership':
320 $from = " $side JOIN civicrm_membership ON civicrm_membership.contact_id = contact_a.id ";
321 $from .= " $side JOIN civicrm_contribution_recur ccr ON ( civicrm_membership.contribution_recur_id = ccr.id )";
324 case 'civicrm_membership_type':
325 if ($mode & CRM_Contact_BAO_Query
::MODE_MEMBER
) {
326 $from = " INNER JOIN civicrm_membership_type ON civicrm_membership.membership_type_id = civicrm_membership_type.id ";
329 $from = " $side JOIN civicrm_membership_type ON civicrm_membership.membership_type_id = civicrm_membership_type.id ";
333 case 'civicrm_membership_status':
334 if ($mode & CRM_Contact_BAO_Query
::MODE_MEMBER
) {
335 $from = " INNER JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id ";
338 $from = " $side JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id ";
342 case 'civicrm_membership_payment':
343 $from = " $side JOIN civicrm_membership_payment ON civicrm_membership_payment.membership_id = civicrm_membership.id ";
351 * @param bool $includeCustomFields
355 public static function defaultReturnProperties(
357 $includeCustomFields = TRUE
360 if ($mode & CRM_Contact_BAO_Query
::MODE_MEMBER
) {
363 'contact_sub_type' => 1,
366 'membership_type' => 1,
367 'member_is_test' => 1,
368 'member_is_pay_later' => 1,
370 'membership_start_date' => 1,
371 'membership_end_date' => 1,
372 'membership_source' => 1,
373 'membership_status' => 1,
374 'membership_id' => 1,
375 'owner_membership_id' => 1,
377 'membership_recur_id' => 1,
378 'member_campaign_id' => 1,
381 if ($includeCustomFields) {
382 // also get all the custom membership properties
383 $fields = CRM_Core_BAO_CustomField
::getFieldsForImport('Membership');
384 if (!empty($fields)) {
385 foreach ($fields as $name => $dontCare) {
386 $properties[$name] = 1;
396 * @param CRM_Core_Form $form
398 public static function buildSearchForm(&$form) {
399 $membershipStatus = CRM_Member_PseudoConstant
::membershipStatus();
400 $form->add('select', 'membership_status_id', ts('Membership Status(s)'), $membershipStatus, FALSE,
401 array('id' => 'membership_status_id', 'multiple' => 'multiple', 'class' => 'crm-select2')
404 $form->addSelect('membership_type_id',
405 array('entity' => 'membership', 'multiple' => 'multiple', 'label' => ts('Membership Type(s)'), 'option_url' => NULL, 'placeholder' => ts('- any -'))
408 $form->addElement('text', 'member_source', ts('Source'));
410 CRM_Core_Form_Date
::buildDateRange($form, 'member_join_date', 1, '_low', '_high', ts('From'), FALSE);
412 CRM_Core_Form_Date
::buildDateRange($form, 'member_start_date', 1, '_low', '_high', ts('From'), FALSE);
414 CRM_Core_Form_Date
::buildDateRange($form, 'member_end_date', 1, '_low', '_high', ts('From'), FALSE);
416 $form->addYesNo('member_is_primary', ts('Primary Member?'), TRUE);
417 $form->addYesNo('member_pay_later', ts('Pay Later?'), TRUE);
418 $form->addYesNo('member_auto_renew', ts('Auto-Renew?'), TRUE);
419 $form->addYesNo('member_test', ts('Membership is a Test?'), TRUE);
421 // add all the custom searchable fields
422 $extends = array('Membership');
423 $groupDetails = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, TRUE, $extends);
425 $form->assign('membershipGroupTree', $groupDetails);
426 foreach ($groupDetails as $group) {
427 foreach ($group['fields'] as $field) {
428 $fieldId = $field['id'];
429 $elementName = 'custom_' . $fieldId;
430 CRM_Core_BAO_CustomField
::addQuickFormElement($form,
439 CRM_Campaign_BAO_Campaign
::addCampaignInComponentSearch($form, 'member_campaign_id');
441 $form->assign('validCiviMember', TRUE);
442 $form->setDefaults(array('member_test' => 0));
449 public static function searchAction(&$row, $id) {
455 public static function tableNames(&$tables) {
456 //add membership table
457 if (!empty($tables['civicrm_membership_log']) ||
!empty($tables['civicrm_membership_status']) || CRM_Utils_Array
::value('civicrm_membership_type', $tables)) {
458 $tables = array_merge(array('civicrm_membership' => 1), $tables);