Merge pull request #11034 from ejegg/docStrings
[civicrm-core.git] / CRM / Contact / Form / DedupeFind.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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-2017
32 */
33
34 /**
35 * This class generates form components for DedupeRules.
36 */
37 class CRM_Contact_Form_DedupeFind extends CRM_Admin_Form {
38
39 /**
40 * Pre processing.
41 */
42 public function preProcess() {
43 $this->rgid = CRM_Utils_Request::retrieve('rgid', 'Positive', $this, FALSE, 0);
44 }
45
46 /**
47 * Build the form object.
48 */
49 public function buildQuickForm() {
50
51 $groupList = array('' => ts('- All Contacts -')) + CRM_Core_PseudoConstant::nestedGroup();
52
53 $this->add('select', 'group_id', ts('Select Group'), $groupList, FALSE, array('class' => 'crm-select2 huge'));
54 if (Civi::settings()->get('dedupe_default_limit')) {
55 $this->add('text', 'limit', ts('No of contacts to find matches for '));
56 }
57 $this->addButtons(array(
58 array(
59 'type' => 'next',
60 'name' => ts('Continue'),
61 'isDefault' => TRUE,
62 ),
63 //hack to support cancel button functionality
64 array(
65 'type' => 'submit',
66 'class' => 'cancel',
67 'icon' => 'fa-times',
68 'name' => ts('Cancel'),
69 ),
70 )
71 );
72 }
73
74 /**
75 * Set the default values for the form.
76 *
77 * @return array
78 */
79 public function setDefaultValues() {
80 $this->_defaults['limit'] = Civi::settings()->get('dedupe_default_limit');
81 return $this->_defaults;
82 }
83
84 /**
85 * Process the form submission.
86 */
87 public function postProcess() {
88 $values = $this->exportValues();
89 if (!empty($_POST['_qf_DedupeFind_submit'])) {
90 //used for cancel button
91 CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contact/deduperules', 'reset=1'));
92 return;
93 }
94 $url = CRM_Utils_System::url('civicrm/contact/dedupefind', "reset=1&action=update&rgid={$this->rgid}");
95 if ($values['group_id']) {
96 $url .= "&gid={$values['group_id']}";
97 }
98
99 if (!empty($values['limit'])) {
100 $url .= '&limit=' . $values['limit'];
101 }
102
103 CRM_Utils_System::redirect($url);
104 }
105
106 }