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
35 * This file is for Pledge search
37 class CRM_Pledge_Form_Search
extends CRM_Core_Form_Search
{
40 * The params that are sent to the query.
44 protected $_queryParams;
47 * Are we restricting ourselves to a single contact.
51 protected $_single = FALSE;
54 * Are we restricting ourselves to a single contact.
58 protected $_limit = NULL;
61 * Prefix for the controller.
63 protected $_prefix = "pledge_";
66 * Processing needed for buildForm and later.
68 public function preProcess() {
70 // set the button names
72 $this->_searchButtonName
= $this->getButtonName('refresh');
73 $this->_actionButtonName
= $this->getButtonName('next', 'action');
76 $this->defaults
= array();
79 // we allow the controller to set force/reset externally, useful when we are being
80 // driven by the wizard framework
82 $this->_reset
= CRM_Utils_Request
::retrieve('reset', 'Boolean', CRM_Core_DAO
::$_nullObject);
83 $this->_force
= CRM_Utils_Request
::retrieve('force', 'Boolean', $this, FALSE);
84 $this->_limit
= CRM_Utils_Request
::retrieve('limit', 'Positive', $this);
85 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this, FALSE, 'search');
87 $this->assign("context", $this->_context
);
89 // get user submitted values
90 // get it from controller only if form has been submitted, else preProcess has set this
91 if (!empty($_POST) && !$this->controller
->isModal()) {
92 $this->_formValues
= $this->controller
->exportValues($this->_name
);
95 $this->_formValues
= $this->get('formValues');
98 if (empty($this->_formValues
)) {
99 if (isset($this->_ssID
)) {
100 $this->_formValues
= CRM_Contact_BAO_SavedSearch
::getFormValues($this->_ssID
);
105 $this->postProcess();
106 $this->set('force', 0);
110 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
111 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
112 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
116 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
117 $selector = new CRM_Pledge_Selector_Search($this->_queryParams
,
125 if ($this->_context
== 'user') {
126 $prefix = $this->_prefix
;
129 $this->assign("{$prefix}limit", $this->_limit
);
130 $this->assign("{$prefix}single", $this->_single
);
132 $controller = new CRM_Core_Selector_Controller($selector,
133 $this->get(CRM_Utils_Pager
::PAGE_ID
),
135 CRM_Core_Action
::VIEW
,
137 CRM_Core_Selector_Controller
::TRANSFER
,
140 $controller->setEmbedded(TRUE);
141 $controller->moveFromSessionToTemplate();
143 $this->assign('summary', $this->get('summary'));
147 * Build the form object.
149 public function buildQuickForm() {
150 parent
::buildQuickForm();
151 $this->addSortNameField();
153 CRM_Pledge_BAO_Query
::buildSearchForm($this);
155 $rows = $this->get('rows');
156 if (is_array($rows)) {
157 if (!$this->_single
) {
158 $this->addRowSelectors($rows);
161 $permission = CRM_Core_Permission
::getPermission();
163 $this->addTaskMenu(CRM_Pledge_Task
::permissionedTaskTitles($permission));
169 * Get the label for the sortName field if email searching is on.
171 * (email searching is a setting under search preferences).
175 protected function getSortNameLabelWithEmail() {
176 return ts('Pledger Name or Email');
180 * Get the label for the sortName field if email searching is off.
182 * (email searching is a setting under search preferences).
186 protected function getSortNameLabelWithOutEmail() {
187 return ts('Pledger Name');
191 * The post processing of the form gets done here.
193 * Key things done during post processing are
194 * - check for reset or next request. if present, skip post procesing.
195 * - now check if user requested running a saved search, if so, then
196 * the form values associated with the saved search are used for searching.
197 * - if user has done a submit with new values the regular post submissing is
199 * The processing consists of using a Selector / Controller framework for getting the
202 public function postProcess() {
209 $this->_formValues
= $this->controller
->exportValues($this->_name
);
211 $this->fixFormValues();
213 // We don't show test records in summaries or dashboards
214 if (empty($this->_formValues
['pledge_test']) && $this->_force
) {
215 $this->_formValues
["pledge_test"] = 0;
218 foreach (array('pledge_amount_low', 'pledge_amount_high') as $f) {
219 if (isset($this->_formValues
[$f])) {
220 $this->_formValues
[$f] = CRM_Utils_Rule
::cleanMoney($this->_formValues
[$f]);
224 if (isset($this->_ssID
) && empty($_POST)) {
225 // if we are editing / running a saved search and the form has not been posted
226 $this->_formValues
= CRM_Contact_BAO_SavedSearch
::getFormValues($this->_ssID
);
229 CRM_Core_BAO_CustomValue
::fixCustomFieldValue($this->_formValues
);
231 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
233 $this->set('formValues', $this->_formValues
);
234 $this->set('queryParams', $this->_queryParams
);
236 $buttonName = $this->controller
->getButtonName();
237 if ($buttonName == $this->_actionButtonName
) {
238 // check actionName and if next, then do not repeat a search, since we are going to the next page
240 // hack, make sure we reset the task values
241 $stateMachine = $this->controller
->getStateMachine();
242 $formName = $stateMachine->getTaskFormName();
243 $this->controller
->resetPage($formName);
248 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
249 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
250 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
254 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
256 $selector = new CRM_Pledge_Selector_Search($this->_queryParams
,
263 $selector->setKey($this->controller
->_key
);
266 if ($this->_context
== 'user') {
267 $prefix = $this->_prefix
;
270 $this->assign("{$prefix}limit", $this->_limit
);
271 $this->assign("{$prefix}single", $this->_single
);
273 $controller = new CRM_Core_Selector_Controller($selector,
274 $this->get(CRM_Utils_Pager
::PAGE_ID
),
276 CRM_Core_Action
::VIEW
,
278 CRM_Core_Selector_Controller
::SESSION
,
281 $controller->setEmbedded(TRUE);
283 $query = &$selector->getQuery();
284 if ($this->_context
== 'user') {
285 $query->setSkipPermission(TRUE);
291 * add the rules (mainly global rules) for form.
292 * All local rules are added near the element
296 public function addRules() {
297 $this->addFormRule(array('CRM_Pledge_Form_Search', 'formRule'));
301 * Global validation rules for the form.
303 * @param array $fields
304 * Posted values of the form.
306 public static function formRule($fields) {
309 if (!empty($errors)) {
317 * Set the default form values.
321 * the default array reference
323 public function setDefaultValues() {
325 $defaults = $this->_formValues
;
329 public function fixFormValues() {
330 if (!$this->_force
) {
334 // set pledge payment related fields
335 $status = CRM_Utils_Request
::retrieve('status', 'String',
336 CRM_Core_DAO
::$_nullObject
339 $this->_formValues
['pledge_payment_status_id'] = array($status => 1);
340 $this->_defaults
['pledge_payment_status_id'] = array($status => 1);
343 $fromDate = CRM_Utils_Request
::retrieve('start', 'Date',
344 CRM_Core_DAO
::$_nullObject
347 list($date) = CRM_Utils_Date
::setDateDefaults($fromDate);
348 $this->_formValues
['pledge_payment_date_low'] = $date;
349 $this->_defaults
['pledge_payment_date_low'] = $date;
352 $toDate = CRM_Utils_Request
::retrieve('end', 'Date',
353 CRM_Core_DAO
::$_nullObject
356 list($date) = CRM_Utils_Date
::setDateDefaults($toDate);
357 $this->_formValues
['pledge_payment_date_high'] = $date;
358 $this->_defaults
['pledge_payment_date_high'] = $date;
361 // set pledge related fields
362 $pledgeStatus = CRM_Utils_Request
::retrieve('pstatus', 'String',
363 CRM_Core_DAO
::$_nullObject
366 $statusValues = CRM_Contribute_PseudoConstant
::contributionStatus();
368 // Remove status values that are only used for recurring contributions for now (Failed).
369 unset($statusValues['4']);
371 // we need set all statuses except Cancelled
372 unset($statusValues[$pledgeStatus]);
375 foreach ($statusValues as $statusId => $value) {
376 $statuses[$statusId] = 1;
379 $this->_formValues
['pledge_status_id'] = $statuses;
380 $this->_defaults
['pledge_status_id'] = $statuses;
383 $pledgeFromDate = CRM_Utils_Request
::retrieve('pstart', 'Date',
384 CRM_Core_DAO
::$_nullObject
386 if ($pledgeFromDate) {
387 list($date) = CRM_Utils_Date
::setDateDefaults($pledgeFromDate);
388 $this->_formValues
['pledge_create_date_low'] = $this->_defaults
['pledge_create_date_low'] = $date;
391 $pledgeToDate = CRM_Utils_Request
::retrieve('pend', 'Date',
392 CRM_Core_DAO
::$_nullObject
395 list($date) = CRM_Utils_Date
::setDateDefaults($pledgeToDate);
396 $this->_formValues
['pledge_create_date_high'] = $this->_defaults
['pledge_create_date_high'] = $date;
399 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
401 $cid = CRM_Utils_Type
::escape($cid, 'Integer');
403 $this->_formValues
['contact_id'] = $cid;
404 list($display, $image) = CRM_Contact_BAO_Contact
::getDisplayAndImage($cid);
405 $this->_defaults
['sort_name'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $cid,
408 // also assign individual mode to the template
409 $this->_single
= TRUE;
417 public function getFormValues() {
422 * Return a descriptive name for the page, used in wizard header
426 public function getTitle() {
427 return ts('Find Pledges');