Merge remote-tracking branch 'upstream/4.4' into 4.4-master-2014-08-25-10-57-01
[civicrm-core.git] / CRM / Contact / Form / Search / Criteria.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
9 | |
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. |
13 | |
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. |
18 | |
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 +--------------------------------------------------------------------+
26 */
27
28 /**
29 *
30 * @package CRM
31 * @copyright CiviCRM LLC (c) 2004-2014
32 * $Id$
33 *
34 */
35 class CRM_Contact_Form_Search_Criteria {
36 /**
37 * @param $form CRM_Core_Form
38 */
39 static function basic(&$form) {
40 $form->addElement('hidden', 'hidden_basic', 1);
41
42 if ($form->_searchOptions['contactType']) {
43 // add checkboxes for contact type
44 //@todo FIXME - using the CRM_Core_DAO::VALUE_SEPARATOR creates invalid html - if you can find the form
45 // this is loaded onto then replace with something like '__' & test
46 $separator = CRM_Core_DAO::VALUE_SEPARATOR;
47 $contactTypes = CRM_Contact_BAO_ContactType::getSelectElements(FALSE, TRUE, $separator);
48
49 if ($contactTypes) {
50 $form->add('select', 'contact_type', ts('Contact Type(s)'), $contactTypes, FALSE,
51 array('id' => 'contact_type', 'multiple' => 'multiple', 'class' => 'crm-select2', 'style' => 'width: 100%;')
52 );
53 }
54 }
55
56 if ($form->_searchOptions['groups']) {
57 // multiselect for groups
58 if ($form->_group) {
59 // Arrange groups into hierarchical listing (child groups follow their parents and have indentation spacing in title)
60 $groupHierarchy = CRM_Contact_BAO_Group::getGroupsHierarchy($form->_group, NULL, '&nbsp;&nbsp;', TRUE);
61
62 $form->add('select', 'group', ts('Groups'), $groupHierarchy, FALSE,
63 array('id' => 'group', 'multiple' => 'multiple', 'class' => 'crm-select2')
64 );
65 $groupOptions = CRM_Core_BAO_OptionValue::getOptionValuesAssocArrayFromName('group_type');
66 $form->add('select', 'group_type', ts('Group Types'), $groupOptions, FALSE,
67 array('id' => 'group_type', 'multiple' => 'multiple', 'class' => 'crm-select2')
68 );
69 $form->add('hidden','group_search_selected','group');
70 }
71 }
72
73 if ($form->_searchOptions['tags']) {
74 // multiselect for categories
75 $contactTags = CRM_Core_BAO_Tag::getTags();
76
77 if ($contactTags) {
78 $form->add('select', 'contact_tags', ts('Tags'), $contactTags, FALSE,
79 array('id' => 'contact_tags', 'multiple' => 'multiple', 'class' => 'crm-select2', 'style' => 'width: 100%;')
80 );
81 }
82
83 $parentNames = CRM_Core_BAO_Tag::getTagSet('civicrm_contact');
84 CRM_Core_Form_Tag::buildQuickForm($form, $parentNames, 'civicrm_contact', NULL, TRUE, FALSE);
85
86 $used_for = CRM_Core_OptionGroup::values('tag_used_for');
87 $tagsTypes = array();
88 $showAllTagTypes = false;
89 foreach ($used_for as $key => $value) {
90 //check tags for every type and find if there are any defined
91 $tags = CRM_Core_BAO_Tag::getTagsUsedFor($key, FALSE, TRUE, NULL);
92 // check if there are tags other than contact type, if no - keep checkbox hidden on adv search
93 // we will hide searching contact by attachments tags until it will be implemented in core
94 if (count($tags) && $key != 'civicrm_file' && $key != 'civicrm_contact') {
95 //if tags exists then add type to display in adv search form help text
96 $tagsTypes[] = ts($value);
97 $showAllTagTypes = true;
98 }
99 }
100 $tagTypesText = implode(" or ", $tagsTypes);
101 if ($showAllTagTypes) {
102 $form->add('checkbox', 'all_tag_types', ts('Include tags used for %1', array(1 => $tagTypesText)));
103 $form->add('hidden','tag_types_text', $tagTypesText);
104 }
105 }
106
107 // add text box for last name, first name, street name, city
108 $form->addElement('text', 'sort_name', ts('Find...'), CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', 'sort_name'));
109
110 // add text box for last name, first name, street name, city
111 $form->add('text', 'email', ts('Contact Email'), CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', 'sort_name'));
112
113 //added contact source
114 $form->add('text', 'contact_source', ts('Contact Source'), CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', 'contact_source'));
115
116 //added job title
117 $form->addElement('text', 'job_title', ts('Job Title'), CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', 'job_title'));
118
119
120 //added internal ID
121 $form->addElement('text', 'contact_id', ts('Contact ID'), CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', 'id'));
122 $form->addRule('contact_id', ts('Please enter valid Contact ID'), 'positiveInteger');
123
124 //added external ID
125 $form->addElement('text', 'external_identifier', ts('External ID'), CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', 'external_identifier'));
126
127 if (CRM_Core_Permission::check('access deleted contacts') and CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'contact_undelete', NULL)) {
128 $form->add('checkbox', 'deleted_contacts', ts('Search in Trash') . '<br />' . ts('(deleted contacts)'));
129 }
130
131 // add checkbox for cms users only
132 $form->addYesNo('uf_user', ts('CMS User?'), TRUE);
133
134 // tag all search
135 $form->add('text', 'tag_search', ts('All Tags'));
136
137 // add search profiles
138
139 // FIXME: This is probably a part of profiles - need to be
140 // FIXME: eradicated from here when profiles are reworked.
141 $types = array('Participant', 'Contribution', 'Membership');
142
143 // get component profiles
144 $componentProfiles = array();
145 $componentProfiles = CRM_Core_BAO_UFGroup::getProfiles($types);
146
147 $ufGroups = CRM_Core_BAO_UFGroup::getModuleUFGroup('Search Profile', 1);
148 $accessibleUfGroups = CRM_Core_Permission::ufGroup(CRM_Core_Permission::VIEW);
149
150 $searchProfiles = array();
151 foreach ($ufGroups as $key => $var) {
152 if (!array_key_exists($key, $componentProfiles) && in_array($key, $accessibleUfGroups)) {
153 $searchProfiles[$key] = $var['title'];
154 }
155 }
156
157 $form->addElement('select',
158 'uf_group_id',
159 ts('Search Views'),
160 array(
161 '0' => ts('- default view -')) + $searchProfiles
162 );
163
164 $componentModes = CRM_Contact_Form_Search::getModeSelect();
165
166 // unset contributions or participants if user does not have
167 // permission on them
168 if (!CRM_Core_Permission::access('CiviContribute')) {
169 unset($componentModes['2']);
170 }
171
172 if (!CRM_Core_Permission::access('CiviEvent')) {
173 unset($componentModes['3']);
174 }
175
176 if (!CRM_Core_Permission::access('CiviMember')) {
177 unset($componentModes['5']);
178 }
179
180 if (!CRM_Core_Permission::check('view all activities')) {
181 unset($componentModes['4']);
182 }
183
184 if (count($componentModes) > 1) {
185 $form->addElement('select',
186 'component_mode',
187 ts('Display Results As'),
188 $componentModes
189 );
190 }
191
192 $form->addElement('select',
193 'operator',
194 ts('Search Operator'),
195 array('AND' => ts('AND'),
196 'OR' => ts('OR'),
197 )
198 );
199
200 // add the option to display relationships
201 $rTypes = CRM_Core_PseudoConstant::relationshipType();
202 $rSelect = array('' => ts('- Select Relationship Type-'));
203 foreach ($rTypes as $rid => $rValue) {
204 if ($rValue['label_a_b'] == $rValue['label_b_a']) {
205 $rSelect[$rid] = $rValue['label_a_b'];
206 }
207 else {
208 $rSelect["{$rid}_a_b"] = $rValue['label_a_b'];
209 $rSelect["{$rid}_b_a"] = $rValue['label_b_a'];
210 }
211 }
212
213 $form->addElement('select',
214 'display_relationship_type',
215 ts('Display Results as Relationship'),
216 $rSelect
217 );
218
219 // checkboxes for DO NOT phone, email, mail
220 // we take labels from SelectValues
221 $t = CRM_Core_SelectValues::privacy();
222 $form->add('select',
223 'privacy_options',
224 ts('Privacy'),
225 $t,
226 FALSE,
227 array(
228 'id' => 'privacy_options',
229 'multiple' => 'multiple',
230 'class' => 'crm-select2',
231 )
232 );
233
234 $form->addElement('select',
235 'privacy_operator',
236 ts('Operator'),
237 array('OR' => ts('OR'),
238 'AND' => ts('AND'),
239 )
240 );
241
242 $options = array(
243 1 => ts('Exclude'),
244 2 => ts('Include by Privacy Option(s)'),
245 );
246 $form->addRadio('privacy_toggle', ts('Privacy Options'), $options, array('allowClear' => FALSE));
247
248 // preferred communication method
249 $comm = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'preferred_communication_method');
250
251 $commPreff = array();
252 foreach ($comm as $k => $v) {
253 $commPreff[] = $form->createElement('advcheckbox', $k, NULL, $v);
254 }
255
256 $onHold[] = $form->createElement('advcheckbox', 'on_hold', NULL, ts(''));
257 $form->addGroup($onHold, 'email_on_hold', ts('Email On Hold'));
258
259 $form->addGroup($commPreff, 'preferred_communication_method', ts('Preferred Communication Method'));
260
261 //CRM-6138 Preferred Language
262 $form->addSelect('preferred_language', array('class' => 'twenty', 'option_url' => NULL));
263
264 // Phone search
265 $form->addElement('text', 'phone_numeric', ts('Phone Number'), CRM_Core_DAO::getAttribute('CRM_Core_DAO_Phone', 'phone'));
266 $locationType = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
267 $phoneType = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Phone', 'phone_type_id');
268 $form->add('select', 'phone_location_type_id', ts('Phone Location'), array('' => ts('- any -')) + $locationType);
269 $form->add('select', 'phone_phone_type_id', ts('Phone Type'), array('' => ts('- any -')) + $phoneType);
270 }
271
272
273 /**
274 * @param CRM_Core_Form $form
275 */
276 static function location(&$form) {
277 $config = CRM_Core_Config::singleton();
278 // Build location criteria based on _submitValues if
279 // available; otherwise, use $form->_formValues.
280 $formValues = $form->_submitValues;
281
282 if (empty($formValues) && !empty($form->_formValues)) {
283 $formValues = $form->_formValues;
284 }
285
286 $form->addElement('hidden', 'hidden_location', 1);
287
288 $addressOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
289 'address_options', TRUE, NULL, TRUE
290 );
291
292 $attributes = CRM_Core_DAO::getAttribute('CRM_Core_DAO_Address');
293
294 $elements = array(
295 'street_address' => array(ts('Street Address'), $attributes['street_address'], NULL, NULL),
296 'city' => array(ts('City'), $attributes['city'], NULL, NULL),
297 'postal_code' => array(ts('Zip / Postal Code'), $attributes['postal_code'], NULL, NULL),
298 'county' => array(ts('County'), $attributes['county_id'], 'county', TRUE),
299 'state_province' => array(ts('State / Province'), $attributes['state_province_id'], 'stateProvince', TRUE),
300 'country' => array(ts('Country'), $attributes['country_id'], 'country', FALSE),
301 'address_name' => array(ts('Address Name'), $attributes['address_name'], NULL, NULL),
302 'street_number' => array(ts('Street Number'), $attributes['street_number'], NULL, NULL),
303 'street_name' => array(ts('Street Name'), $attributes['street_name'], NULL, NULL),
304 'street_unit' => array(ts('Apt/Unit/Suite'), $attributes['street_unit'], NULL, NULL),
305 );
306
307 $parseStreetAddress = CRM_Utils_Array::value('street_address_parsing', $addressOptions, 0);
308 $form->assign('parseStreetAddress', $parseStreetAddress);
309 $stateCountryMap = NULL;
310 foreach ($elements as $name => $v) {
311 list($title, $attributes, $select, $multiSelect) = $v;
312
313 if (in_array($name,
314 array('street_number', 'street_name', 'street_unit')
315 )) {
316 if (!$parseStreetAddress) {
317 continue;
318 }
319 }
320 elseif (!$addressOptions[$name]) {
321 continue;
322 }
323
324 if (!$attributes) {
325 $attributes = $attributes[$name];
326 }
327
328 if ($select) {
329 $stateCountryMap = array(array(
330 'state_province' => 'state_province',
331 'country' => 'country',
332 'county' => 'county',
333 ));
334 if ($select == 'stateProvince') {
335 if (!empty($formValues['country'])) {
336 $selectElements = array('' => ts('- select -')) + CRM_Core_PseudoConstant::stateProvinceForCountry($formValues['country']);
337 }
338 else {
339 //if not setdefault any country
340 $selectElements = CRM_Core_PseudoConstant::$select();
341 }
342 $element = $form->add('select', $name, $title, $selectElements);
343 }
344 elseif ($select == 'country') {
345 $selectElements = array('' => ts('- any -')) + CRM_Core_PseudoConstant::$select();
346 $element = $form->add('select', $name, $title, $selectElements);
347 }
348 elseif ($select == 'county') {
349 if ( array_key_exists('state_province', $formValues) && !CRM_Utils_System::isNull($formValues['state_province'])) {
350 $selectElements = array('' => ts('- select -')) + CRM_Core_PseudoConstant::countyForState($formValues['state_province']);
351 }
352 else {
353 $selectElements = array('' => ts('- any -'));
354 }
355 $element = $form->add('select', $name, $title, $selectElements);
356 }
357 else {
358 $selectElements = array('' => ts('- any -')) + CRM_Core_PseudoConstant::$select();
359 $element = $form->add('select', $name, $title, $selectElements, FALSE, array('class' => 'crm-select2'));
360 }
361 if ($multiSelect) {
362 $element->setMultiple(TRUE);
363 }
364 }
365 else {
366 $form->addElement('text', $name, $title, $attributes);
367 }
368
369 if ($addressOptions['postal_code']) {
370 $attr = array('class' => 'six') + (array) CRM_Utils_Array::value('postal_code', $attributes);
371 $form->addElement('text', 'postal_code_low', NULL, $attr + array('placeholder' => ts('From')));
372 $form->addElement('text', 'postal_code_high', NULL, $attr + array('placeholder' => ts('To')));
373 }
374 }
375
376 CRM_Core_BAO_Address::addStateCountryMap($stateCountryMap);
377
378 // extend addresses with proximity search
379 if (!empty($config->geocodeMethod)) {
380 $form->addElement('text', 'prox_distance', ts('Find contacts within'), array('class' => 'six'));
381 $form->addElement('select', 'prox_distance_unit', NULL, array(
382 'miles' => ts('Miles'),
383 'kilos' => ts('Kilometers')
384 ));
385 $form->addRule('prox_distance', ts('Please enter positive number as a distance'), 'numeric');
386 }
387
388 $form->addSelect('world_region', array('entity' => 'address', 'placeholder' => ts('- any -'), 'option_url' => NULL));
389
390 // select for location type
391 $locationType = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
392 $form->add('select', 'location_type', ts('Address Location'), $locationType, FALSE, array(
393 'multiple' => TRUE,
394 'class' => 'crm-select2',
395 'placeholder' => ts('Primary'),
396 ));
397
398 // custom data extending addresses -
399 $extends = array('Address');
400 $groupDetails = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, TRUE, $extends);
401 if ($groupDetails) {
402 $form->assign('addressGroupTree', $groupDetails);
403 foreach ($groupDetails as $group) {
404 foreach ($group['fields'] as $field) {
405 $elementName = 'custom_' . $field['id'];
406 CRM_Core_BAO_CustomField::addQuickFormElement($form,
407 $elementName,
408 $field['id'],
409 FALSE, FALSE, TRUE
410 );
411 }
412 }
413 }
414 }
415
416 /**
417 * @param $form
418 */
419 static function activity(&$form) {
420 $form->add('hidden', 'hidden_activity', 1);
421 CRM_Activity_BAO_Query::buildSearchForm($form);
422 }
423
424 /**
425 * @param $form
426 */
427 static function changeLog(&$form) {
428 $form->add('hidden', 'hidden_changeLog', 1);
429
430 // block for change log
431 $form->addElement('text', 'changed_by', ts('Modified By'), NULL);
432
433 $dates = array(1 => ts('Added'), 2 => ts('Modified'));
434 $form->addRadio('log_date', NULL, $dates, array('allowClear' => TRUE), '<br />');
435
436 CRM_Core_Form_Date::buildDateRange($form, 'log_date', 1, '_low', '_high', ts('From'), FALSE, FALSE);
437 }
438
439 /**
440 * @param $form
441 */
442 static function task(&$form) {
443 $form->add('hidden', 'hidden_task', 1);
444 }
445
446 /**
447 * @param $form
448 */
449 static function relationship(&$form) {
450 $form->add('hidden', 'hidden_relationship', 1);
451
452 $allRelationshipType = array();
453 $allRelationshipType = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, NULL, NULL, NULL, TRUE);
454 $form->add('select', 'relation_type_id', ts('Relationship Type'), array('' => ts('- select -')) + $allRelationshipType, FALSE, array('class' => 'crm-select2'));
455 $form->addElement('text', 'relation_target_name', ts('Target Contact'), CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', 'sort_name'));
456 // relation status
457 $relStatusOption = array(ts('Active '), ts('Inactive '), ts('All'));
458 $form->addRadio('relation_status', ts('Relationship Status'), $relStatusOption);
459 $form->setDefaults(array('relation_status' => 0));
460 // relation permission
461 $relPermissionOption = array(ts('Any'), ts('Yes '), ts('No ') );
462 $form->addRadio('relation_permission', ts('Permissioned Relationship?'), $relPermissionOption);
463 $form->setDefaults(array('relation_permission' => 0));
464
465 //add the target group
466 if ($form->_group) {
467 $form->add('select', 'relation_target_group', ts('Target Contact(s) in Group'), $form->_group, FALSE,
468 array('id' => 'relation_target_group', 'multiple' => 'multiple', 'class' => 'crm-select2')
469 );
470 }
471 CRM_Core_Form_Date::buildDateRange($form, 'relation_start_date', 1, '_low', '_high', ts('From:'), FALSE, FALSE);
472 CRM_Core_Form_Date::buildDateRange($form, 'relation_end_date', 1, '_low', '_high', ts('From:'), FALSE, FALSE);
473
474 // Add reltionship dates
475 CRM_Core_Form_Date::buildDateRange($form, 'relation_date', 1, '_low', '_high', ts('From:'), FALSE, FALSE);
476
477 // add all the custom searchable fields
478 $relationship = array('Relationship');
479 $groupDetails = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, TRUE, $relationship);
480 if ($groupDetails) {
481 $form->assign('relationshipGroupTree', $groupDetails);
482 foreach ($groupDetails as $group) {
483 foreach ($group['fields'] as $field) {
484 $fieldId = $field['id'];
485 $elementName = 'custom_' . $fieldId;
486 CRM_Core_BAO_CustomField::addQuickFormElement($form,
487 $elementName,
488 $fieldId,
489 FALSE, FALSE, TRUE
490 );
491 }
492 }
493 }
494 }
495
496 /**
497 * @param $form
498 */
499 static function demographics(&$form) {
500 $form->add('hidden', 'hidden_demographics', 1);
501 // radio button for gender
502 $genderOptions = array();
503 $gender = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'gender_id');
504 foreach ($gender as $key => $var) {
505 $genderOptions[$key] = $form->createElement('radio', NULL,
506 ts('Gender'), $var, $key,
507 array('id' => "civicrm_gender_{$var}_{$key}")
508 );
509 }
510 $form->addGroup($genderOptions, 'gender_id', ts('Gender'))->setAttribute('allowClear', TRUE);
511
512 CRM_Core_Form_Date::buildDateRange($form, 'birth_date', 1, '_low', '_high', ts('From'), FALSE, FALSE, 'birth');
513
514 CRM_Core_Form_Date::buildDateRange($form, 'deceased_date', 1, '_low', '_high', ts('From'), FALSE, FALSE, 'birth');
515
516
517 // radio button for is_deceased
518 $form->addYesNo( 'is_deceased', ts('Deceased'), TRUE);
519 }
520
521 /**
522 * @param $form
523 */
524 static function notes(&$form) {
525 $form->add('hidden', 'hidden_notes', 1);
526
527 $options = array(
528 2 => ts('Body Only'),
529 3 => ts('Subject Only'),
530 6 => ts('Both'),
531 );
532 $form->addRadio('note_option', '', $options);
533
534 $form->addElement('text', 'note', ts('Note Text'), CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', 'sort_name'));
535
536 $form->setDefaults(array('note_option' => 6));
537 }
538
539 /**
540 * Generate the custom Data Fields based
541 * on the is_searchable
542 *
543 * @access private
544 *
545 * @param $form
546 *
547 * @return void
548 */
549 static function custom(&$form) {
550 $form->add('hidden', 'hidden_custom', 1);
551 $extends = array_merge(array('Contact', 'Individual', 'Household', 'Organization'),
552 CRM_Contact_BAO_ContactType::subTypes()
553 );
554 $groupDetails = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, TRUE,
555 $extends
556 );
557
558 $form->assign('groupTree', $groupDetails);
559
560 foreach ($groupDetails as $key => $group) {
561 $_groupTitle[$key] = $group['name'];
562 CRM_Core_ShowHideBlocks::links($form, $group['name'], '', '');
563
564 $groupId = $group['id'];
565 foreach ($group['fields'] as $field) {
566 $fieldId = $field['id'];
567 $elementName = 'custom_' . $fieldId;
568
569 CRM_Core_BAO_CustomField::addQuickFormElement($form,
570 $elementName,
571 $fieldId,
572 FALSE, FALSE, TRUE
573 );
574 }
575 }
576
577 //TODO: validate for only one state if prox_distance isset
578 }
579
580 /**
581 * @param $form
582 */
583 static function CiviCase(&$form) {
584 //Looks like obsolete code, since CiviCase is a component, but might be used by HRD
585 $form->add('hidden', 'hidden_CiviCase', 1);
586 CRM_Case_BAO_Query::buildSearchForm($form);
587 }
588 }
589