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_Contact_Form_Search_Criteria
{
37 * @param $form CRM_Core_Form
39 static function basic(&$form) {
40 $form->addElement('hidden', 'hidden_basic', 1);
42 if ($form->_searchOptions
['contactType']) {
43 // add checkboxes for contact type
44 $contactTypes = CRM_Contact_BAO_ContactType
::getSelectElements();
47 $form->add('select', 'contact_type', ts('Contact Type(s)'), $contactTypes, FALSE,
48 array('id' => 'contact_type', 'multiple' => 'multiple', 'class' => 'crm-select2', 'style' => 'width: 100%;')
53 if ($form->_searchOptions
['groups']) {
54 // multiselect for groups
56 // Arrange groups into hierarchical listing (child groups follow their parents and have indentation spacing in title)
57 $groupHierarchy = CRM_Contact_BAO_Group
::getGroupsHierarchy($form->_group
, NULL, ' ', TRUE);
59 $form->add('select', 'group', ts('Groups'), $groupHierarchy, FALSE,
60 array('id' => 'group', 'multiple' => 'multiple', 'class' => 'crm-select2')
62 $groupOptions = CRM_Core_BAO_OptionValue
::getOptionValuesAssocArrayFromName('group_type');
63 $form->add('select', 'group_type', ts('Group Types'), $groupOptions, FALSE,
64 array('id' => 'group_type', 'multiple' => 'multiple', 'class' => 'crm-select2')
66 $form->add('hidden','group_search_selected','group');
70 if ($form->_searchOptions
['tags']) {
71 // multiselect for categories
72 $contactTags = CRM_Core_BAO_Tag
::getTags();
75 $form->add('select', 'contact_tags', ts('Tags'), $contactTags, FALSE,
76 array('id' => 'contact_tags', 'multiple' => 'multiple', 'class' => 'crm-select2', 'style' => 'width: 100%;')
80 $parentNames = CRM_Core_BAO_Tag
::getTagSet('civicrm_contact');
81 CRM_Core_Form_Tag
::buildQuickForm($form, $parentNames, 'civicrm_contact', NULL, TRUE, FALSE, TRUE);
83 $used_for = CRM_Core_OptionGroup
::values('tag_used_for');
85 $showAllTagTypes = false;
86 foreach ($used_for as $key => $value) {
87 //check tags for every type and find if there are any defined
88 $tags = CRM_Core_BAO_Tag
::getTagsUsedFor($key, FALSE, TRUE, NULL);
89 // check if there are tags other than contact type, if no - keep checkbox hidden on adv search
90 // we will hide searching contact by attachments tags until it will be implemented in core
91 if (count($tags) && $key != 'civicrm_file' && $key != 'civicrm_contact') {
92 //if tags exists then add type to display in adv search form help text
93 $tagsTypes[] = ts($value);
94 $showAllTagTypes = true;
97 $tagTypesText = implode(" or ", $tagsTypes);
98 if ($showAllTagTypes) {
99 $form->add('checkbox', 'all_tag_types', ts('Include tags used for %1', array(1 => $tagTypesText)));
100 $form->add('hidden','tag_types_text', $tagTypesText);
104 // add text box for last name, first name, street name, city
105 $form->addElement('text', 'sort_name', ts('Find...'), CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Contact', 'sort_name'));
107 // add text box for last name, first name, street name, city
108 $form->add('text', 'email', ts('Contact Email'), CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Contact', 'sort_name'));
110 //added contact source
111 $form->add('text', 'contact_source', ts('Contact Source'), CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Contact', 'contact_source'));
114 $form->addElement('text', 'job_title', ts('Job Title'), CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Contact', 'job_title'));
118 $form->addElement('text', 'contact_id', ts('Contact ID'), CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Contact', 'id'));
119 $form->addRule('contact_id', ts('Please enter valid Contact ID'), 'positiveInteger');
122 $form->addElement('text', 'external_identifier', ts('External ID'), CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Contact', 'external_identifier'));
124 if (CRM_Core_Permission
::check('access deleted contacts') and CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'contact_undelete', NULL)) {
125 $form->add('checkbox', 'deleted_contacts', ts('Search in Trash') . '<br />' . ts('(deleted contacts)'));
128 // add checkbox for cms users only
129 $form->addYesNo('uf_user', ts('CMS User?'), TRUE);
132 $form->add('text', 'tag_search', ts('All Tags'));
134 // add search profiles
136 // FIXME: This is probably a part of profiles - need to be
137 // FIXME: eradicated from here when profiles are reworked.
138 $types = array('Participant', 'Contribution', 'Membership');
140 // get component profiles
141 $componentProfiles = array();
142 $componentProfiles = CRM_Core_BAO_UFGroup
::getProfiles($types);
144 $ufGroups = CRM_Core_BAO_UFGroup
::getModuleUFGroup('Search Profile', 1);
145 $accessibleUfGroups = CRM_Core_Permission
::ufGroup(CRM_Core_Permission
::VIEW
);
147 $searchProfiles = array();
148 foreach ($ufGroups as $key => $var) {
149 if (!array_key_exists($key, $componentProfiles) && in_array($key, $accessibleUfGroups)) {
150 $searchProfiles[$key] = $var['title'];
154 $form->addElement('select',
158 '0' => ts('- default view -')) +
$searchProfiles
161 $componentModes = CRM_Contact_Form_Search
::getModeSelect();
163 // unset contributions or participants if user does not have
164 // permission on them
165 if (!CRM_Core_Permission
::access('CiviContribute')) {
166 unset($componentModes['2']);
169 if (!CRM_Core_Permission
::access('CiviEvent')) {
170 unset($componentModes['3']);
173 if (!CRM_Core_Permission
::access('CiviMember')) {
174 unset($componentModes['5']);
177 if (!CRM_Core_Permission
::check('view all activities')) {
178 unset($componentModes['4']);
181 if (count($componentModes) > 1) {
182 $form->addElement('select',
184 ts('Display Results As'),
189 $form->addElement('select',
191 ts('Search Operator'),
192 array('AND' => ts('AND'),
197 // add the option to display relationships
198 $rTypes = CRM_Core_PseudoConstant
::relationshipType();
199 $rSelect = array('' => ts('- Select Relationship Type-'));
200 foreach ($rTypes as $rid => $rValue) {
201 if ($rValue['label_a_b'] == $rValue['label_b_a']) {
202 $rSelect[$rid] = $rValue['label_a_b'];
205 $rSelect["{$rid}_a_b"] = $rValue['label_a_b'];
206 $rSelect["{$rid}_b_a"] = $rValue['label_b_a'];
210 $form->addElement('select',
211 'display_relationship_type',
212 ts('Display Results as Relationship'),
216 // checkboxes for DO NOT phone, email, mail
217 // we take labels from SelectValues
218 $t = CRM_Core_SelectValues
::privacy();
225 'id' => 'privacy_options',
226 'multiple' => 'multiple',
227 'class' => 'crm-select2',
231 $form->addElement('select',
234 array('OR' => ts('OR'),
241 2 => ts('Include by Privacy Option(s)'),
243 $form->addRadio('privacy_toggle', ts('Privacy Options'), $options, NULL, NULL, TRUE);
245 // preferred communication method
246 $comm = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'preferred_communication_method');
248 $commPreff = array();
249 foreach ($comm as $k => $v) {
250 $commPreff[] = $form->createElement('advcheckbox', $k, NULL, $v);
253 $onHold[] = $form->createElement('advcheckbox', 'on_hold', NULL, ts(''));
254 $form->addGroup($onHold, 'email_on_hold', ts('Email On Hold'));
256 $form->addGroup($commPreff, 'preferred_communication_method', ts('Preferred Communication Method'));
258 //CRM-6138 Preferred Language
259 $form->add('select', 'preferred_language', ts('Preferred Language'), array('' => ts('- any -')) + CRM_Contact_BAO_Contact
::buildOptions('preferred_language'), FALSE, array('class' => 'crm-select2'));
262 $form->addElement('text', 'phone_numeric', ts('Phone Number'), CRM_Core_DAO
::getAttribute('CRM_Core_DAO_Phone', 'phone'));
263 $locationType = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
264 $phoneType = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Phone', 'phone_type_id');
265 $form->add('select', 'phone_location_type_id', ts('Phone Location'), array('' => ts('- any -')) +
$locationType);
266 $form->add('select', 'phone_phone_type_id', ts('Phone Type'), array('' => ts('- any -')) +
$phoneType);
270 static function location(&$form) {
271 // Build location criteria based on _submitValues if
272 // available; otherwise, use $form->_formValues.
273 $formValues = $form->_submitValues
;
275 if (empty($formValues) && !empty($form->_formValues
)) {
276 $formValues = $form->_formValues
;
279 $form->addElement('hidden', 'hidden_location', 1);
281 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
282 'address_options', TRUE, NULL, TRUE
285 $attributes = CRM_Core_DAO
::getAttribute('CRM_Core_DAO_Address');
288 'street_address' => array(ts('Street Address'), $attributes['street_address'], NULL, NULL),
289 'city' => array(ts('City'), $attributes['city'], NULL, NULL),
290 'postal_code' => array(ts('Zip / Postal Code'), $attributes['postal_code'], NULL, NULL),
291 'county' => array(ts('County'), $attributes['county_id'], 'county', TRUE),
292 'state_province' => array(ts('State / Province'), $attributes['state_province_id'], 'stateProvince', TRUE),
293 'country' => array(ts('Country'), $attributes['country_id'], 'country', FALSE),
294 'address_name' => array(ts('Address Name'), $attributes['address_name'], NULL, NULL),
295 'street_number' => array(ts('Street Number'), $attributes['street_number'], NULL, NULL),
296 'street_name' => array(ts('Street Name'), $attributes['street_name'], NULL, NULL),
297 'street_unit' => array(ts('Apt/Unit/Suite'), $attributes['street_unit'], NULL, NULL),
300 $parseStreetAddress = CRM_Utils_Array
::value('street_address_parsing', $addressOptions, 0);
301 $form->assign('parseStreetAddress', $parseStreetAddress);
302 foreach ($elements as $name => $v) {
303 list($title, $attributes, $select, $multiSelect) = $v;
306 array('street_number', 'street_name', 'street_unit')
308 if (!$parseStreetAddress) {
312 elseif (!$addressOptions[$name]) {
317 $attributes = $attributes[$name];
321 $stateCountryMap[] = array(
322 'state_province' => 'state_province',
323 'country' => 'country',
324 'county' => 'county',
326 if ($select == 'stateProvince') {
327 if (!empty($formValues['country'])) {
328 $selectElements = array('' => ts('- select -')) + CRM_Core_PseudoConstant
::stateProvinceForCountry($formValues['country']);
331 //if not setdefault any country
332 $selectElements = CRM_Core_PseudoConstant
::$select();
334 $element = $form->add('select', $name, $title, $selectElements, FALSE, array('class' => 'crm-select2'));
336 elseif ($select == 'country') {
337 $selectElements = array('' => ts('- any -')) + CRM_Core_PseudoConstant
::$select();
338 $element = $form->add('select', $name, $title, $selectElements, FALSE, array('class' => 'crm-select2'));
340 elseif ($select == 'county') {
341 if ( array_key_exists('state_province', $formValues) && !CRM_Utils_System
::isNull($formValues['state_province'])) {
342 $selectElements = array('' => ts('- select -')) + CRM_Core_PseudoConstant
::countyForState($formValues['state_province']);
345 $selectElements = array('' => ts('- any -'));
347 $element = $form->add('select', $name, $title, $selectElements, FALSE, array('class' => 'crm-select2'));
350 $selectElements = array('' => ts('- any -')) + CRM_Core_PseudoConstant
::$select();
351 $element = $form->add('select', $name, $title, $selectElements, FALSE, array('class' => 'crm-select2'));
354 $element->setMultiple(TRUE);
358 $form->addElement('text', $name, $title, $attributes);
361 if ($addressOptions['postal_code']) {
362 $form->addElement('text', 'postal_code_low', ts('Range-From'),
363 CRM_Utils_Array
::value('postal_code', $attributes)
365 $form->addElement('text', 'postal_code_high', ts('To'),
366 CRM_Utils_Array
::value('postal_code', $attributes)
371 CRM_Core_BAO_Address
::addStateCountryMap($stateCountryMap);
373 // extend addresses with proximity search
374 $form->addElement('text', 'prox_distance', ts('Find contacts within'));
375 $form->addElement('select', 'prox_distance_unit', NULL, array('miles' => ts('Miles'), 'kilos' => ts('Kilometers')));
377 // is there another form rule that does decimals besides money ? ...
378 $form->addRule('prox_distance', ts('Please enter positive number as a distance'), 'numeric');
380 $worldRegions = array('' => ts('- any region -')) + CRM_Core_PseudoConstant
::worldRegion();
381 $form->add('select', 'world_region', ts('World Region'), $worldRegions, FALSE, array('class' => 'crm-select2'));
383 // checkboxes for location type
384 $location_type = array();
385 $locationType = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
386 foreach ($locationType as $locationTypeID => $locationTypeName) {
387 $location_type[] = $form->createElement('checkbox', $locationTypeID, NULL, $locationTypeName);
389 $form->addGroup($location_type, 'location_type', ts('Location Types'), ' ');
391 // custom data extending addresses -
392 $extends = array('Address');
393 $groupDetails = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, TRUE, $extends);
395 $form->assign('addressGroupTree', $groupDetails);
396 foreach ($groupDetails as $group) {
397 foreach ($group['fields'] as $field) {
398 $elementName = 'custom_' . $field['id'];
399 CRM_Core_BAO_CustomField
::addQuickFormElement($form,
409 static function activity(&$form) {
410 $form->add('hidden', 'hidden_activity', 1);
411 CRM_Activity_BAO_Query
::buildSearchForm($form);
414 static function changeLog(&$form) {
415 $form->add('hidden', 'hidden_changeLog', 1);
417 // block for change log
418 $form->addElement('text', 'changed_by', ts('Modified By'), NULL);
420 $dates = array(1 => ts('Added'), 2 => ts('Modified'));
421 $form->addRadio('log_date', NULL, $dates, array('unselectable' => TRUE), '<br />');
423 CRM_Core_Form_Date
::buildDateRange($form, 'log_date', 1, '_low', '_high', ts('From'), FALSE, FALSE);
426 static function task(&$form) {
427 $form->add('hidden', 'hidden_task', 1);
430 static function relationship(&$form) {
431 $form->add('hidden', 'hidden_relationship', 1);
433 $allRelationshipType = array();
434 $allRelationshipType = CRM_Contact_BAO_Relationship
::getContactRelationshipType(NULL, NULL, NULL, NULL, TRUE);
435 $form->add('select', 'relation_type_id', ts('Relationship Type'), array('' => ts('- select -')) +
$allRelationshipType, FALSE, array('class' => 'crm-select2'));
436 $form->addElement('text', 'relation_target_name', ts('Target Contact'), CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Contact', 'sort_name'));
438 $relStatusOption = array(ts('Active '), ts('Inactive '), ts('All'));
439 $form->addRadio('relation_status', ts('Relationship Status'), $relStatusOption);
440 $form->setDefaults(array('relation_status' => 0));
441 // relation permission
442 $relPermissionOption = array(ts('Any'), ts('Yes '), ts('No ') );
443 $form->addRadio('relation_permission', ts('Permissioned Relationship?'), $relPermissionOption);
444 $form->setDefaults(array('relation_permission' => 0));
446 //add the target group
448 $form->add('select', 'relation_target_group', ts('Target Contact(s) in Group'), $form->_group
, FALSE,
449 array('id' => 'relation_target_group', 'multiple' => 'multiple', 'class' => 'crm-select2')
452 CRM_Core_Form_Date
::buildDateRange($form, 'relation_start_date', 1, '_low', '_high', ts('From:'), FALSE, FALSE);
453 CRM_Core_Form_Date
::buildDateRange($form, 'relation_end_date', 1, '_low', '_high', ts('From:'), FALSE, FALSE);
455 // Add reltionship dates
456 CRM_Core_Form_Date
::buildDateRange($form, 'relation_date', 1, '_low', '_high', ts('From:'), FALSE, FALSE);
458 // add all the custom searchable fields
459 $relationship = array('Relationship');
460 $groupDetails = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, TRUE, $relationship);
462 $form->assign('relationshipGroupTree', $groupDetails);
463 foreach ($groupDetails as $group) {
464 foreach ($group['fields'] as $field) {
465 $fieldId = $field['id'];
466 $elementName = 'custom_' . $fieldId;
467 CRM_Core_BAO_CustomField
::addQuickFormElement($form,
477 static function demographics(&$form) {
478 $form->add('hidden', 'hidden_demographics', 1);
479 // radio button for gender
480 $genderOptions = array();
481 $gender = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'gender_id');
482 foreach ($gender as $key => $var) {
483 $genderOptions[$key] = $form->createElement('radio', NULL,
484 ts('Gender'), $var, $key,
485 array('id' => "civicrm_gender_{$var}_{$key}")
488 $form->addGroup($genderOptions, 'gender_id', ts('Gender'))->setAttribute('unselectable', TRUE);
490 CRM_Core_Form_Date
::buildDateRange($form, 'birth_date', 1, '_low', '_high', ts('From'), FALSE, FALSE, 'birth');
492 CRM_Core_Form_Date
::buildDateRange($form, 'deceased_date', 1, '_low', '_high', ts('From'), FALSE, FALSE, 'birth');
495 // radio button for is_deceased
496 $form->addYesNo( 'is_deceased', ts('Deceased'), TRUE);
499 static function notes(&$form) {
500 $form->add('hidden', 'hidden_notes', 1);
503 2 => ts('Body Only'),
504 3 => ts('Subject Only'),
507 $form->addRadio('note_option', '', $options);
509 $form->addElement('text', 'note', ts('Note Text'), CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Contact', 'sort_name'));
511 $form->setDefaults(array('note_option' => 6));
515 * Generate the custom Data Fields based
516 * on the is_searchable
522 static function custom(&$form) {
523 $form->add('hidden', 'hidden_custom', 1);
524 $extends = array_merge(array('Contact', 'Individual', 'Household', 'Organization'),
525 CRM_Contact_BAO_ContactType
::subTypes()
527 $groupDetails = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, TRUE,
531 $form->assign('groupTree', $groupDetails);
533 foreach ($groupDetails as $key => $group) {
534 $_groupTitle[$key] = $group['name'];
535 CRM_Core_ShowHideBlocks
::links($form, $group['name'], '', '');
537 $groupId = $group['id'];
538 foreach ($group['fields'] as $field) {
539 $fieldId = $field['id'];
540 $elementName = 'custom_' . $fieldId;
542 CRM_Core_BAO_CustomField
::addQuickFormElement($form,
550 //TODO: validate for only one state if prox_distance isset
553 static function CiviCase(&$form) {
554 //Looks like obsolete code, since CiviCase is a component, but might be used by HRD
555 $form->add('hidden', 'hidden_CiviCase', 1);
556 CRM_Case_BAO_Query
::buildSearchForm($form);