3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
37 * This file is for Pledge search
39 class CRM_Pledge_Form_Search
extends CRM_Core_Form_Search
{
42 * The params that are sent to the query
46 protected $_queryParams;
49 * Are we restricting ourselves to a single contact
53 protected $_single = FALSE;
56 * Are we restricting ourselves to a single contact
60 protected $_limit = NULL;
63 * Prefix for the controller
66 protected $_prefix = "pledge_";
71 * Processing needed for buildForm and later
75 public function preProcess() {
78 * set the button names
80 $this->_searchButtonName
= $this->getButtonName('refresh');
81 $this->_actionButtonName
= $this->getButtonName('next', 'action');
84 $this->defaults
= array();
87 * we allow the controller to set force/reset externally, useful when we are being
88 * driven by the wizard framework
90 $this->_reset
= CRM_Utils_Request
::retrieve('reset', 'Boolean', CRM_Core_DAO
::$_nullObject);
91 $this->_force
= CRM_Utils_Request
::retrieve('force', 'Boolean', $this, FALSE);
92 $this->_limit
= CRM_Utils_Request
::retrieve('limit', 'Positive', $this);
93 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this, FALSE, 'search');
95 $this->assign("context", $this->_context
);
97 // get user submitted values
98 // get it from controller only if form has been submitted, else preProcess has set this
99 if (!empty($_POST) && !$this->controller
->isModal()) {
100 $this->_formValues
= $this->controller
->exportValues($this->_name
);
103 $this->_formValues
= $this->get('formValues');
106 if (empty($this->_formValues
)) {
107 if (isset($this->_ssID
)) {
108 $this->_formValues
= CRM_Contact_BAO_SavedSearch
::getFormValues($this->_ssID
);
113 $this->postProcess();
114 $this->set('force', 0);
118 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
119 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
120 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
124 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
125 $selector = new CRM_Pledge_Selector_Search($this->_queryParams
,
133 if ($this->_context
== 'user') {
134 $prefix = $this->_prefix
;
137 $this->assign("{$prefix}limit", $this->_limit
);
138 $this->assign("{$prefix}single", $this->_single
);
140 $controller = new CRM_Core_Selector_Controller($selector,
141 $this->get(CRM_Utils_Pager
::PAGE_ID
),
143 CRM_Core_Action
::VIEW
,
145 CRM_Core_Selector_Controller
::TRANSFER
,
148 $controller->setEmbedded(TRUE);
149 $controller->moveFromSessionToTemplate();
151 $this->assign('summary', $this->get('summary'));
155 * Build the form object
160 public function buildQuickForm() {
161 parent
::buildQuickForm();
162 $this->addElement('text', 'sort_name', ts('Pledger Name or Email'), CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Contact', 'sort_name'));
164 CRM_Pledge_BAO_Query
::buildSearchForm($this);
166 $rows = $this->get('rows');
167 if (is_array($rows)) {
168 if (!$this->_single
) {
169 $this->addRowSelectors($rows);
172 $permission = CRM_Core_Permission
::getPermission();
174 $this->addTaskMenu(CRM_Pledge_Task
::permissionedTaskTitles($permission));
180 * The post processing of the form gets done here.
182 * Key things done during post processing are
183 * - check for reset or next request. if present, skip post procesing.
184 * - now check if user requested running a saved search, if so, then
185 * the form values associated with the saved search are used for searching.
186 * - if user has done a submit with new values the regular post submissing is
188 * The processing consists of using a Selector / Controller framework for getting the
195 public function postProcess() {
202 $this->_formValues
= $this->controller
->exportValues($this->_name
);
204 $this->fixFormValues();
206 // We don't show test records in summaries or dashboards
207 if (empty($this->_formValues
['pledge_test']) && $this->_force
) {
208 $this->_formValues
["pledge_test"] = 0;
211 foreach (array('pledge_amount_low', 'pledge_amount_high') as $f) {
212 if (isset($this->_formValues
[$f])) {
213 $this->_formValues
[$f] = CRM_Utils_Rule
::cleanMoney($this->_formValues
[$f]);
217 if (isset($this->_ssID
) && empty($_POST)) {
218 // if we are editing / running a saved search and the form has not been posted
219 $this->_formValues
= CRM_Contact_BAO_SavedSearch
::getFormValues($this->_ssID
);
222 CRM_Core_BAO_CustomValue
::fixFieldValueOfTypeMemo($this->_formValues
);
224 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
226 $this->set('formValues', $this->_formValues
);
227 $this->set('queryParams', $this->_queryParams
);
229 $buttonName = $this->controller
->getButtonName();
230 if ($buttonName == $this->_actionButtonName
) {
231 // check actionName and if next, then do not repeat a search, since we are going to the next page
233 // hack, make sure we reset the task values
234 $stateMachine = $this->controller
->getStateMachine();
235 $formName = $stateMachine->getTaskFormName();
236 $this->controller
->resetPage($formName);
241 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
242 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
243 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
247 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
249 $selector = new CRM_Pledge_Selector_Search($this->_queryParams
,
256 $selector->setKey($this->controller
->_key
);
259 if ($this->_context
== 'user') {
260 $prefix = $this->_prefix
;
263 $this->assign("{$prefix}limit", $this->_limit
);
264 $this->assign("{$prefix}single", $this->_single
);
266 $controller = new CRM_Core_Selector_Controller($selector,
267 $this->get(CRM_Utils_Pager
::PAGE_ID
),
269 CRM_Core_Action
::VIEW
,
271 CRM_Core_Selector_Controller
::SESSION
,
274 $controller->setEmbedded(TRUE);
276 $query = &$selector->getQuery();
277 if ($this->_context
== 'user') {
278 $query->setSkipPermission(TRUE);
284 * This function is used to add the rules (mainly global rules) for form.
285 * All local rules are added near the element
290 public function addRules() {
291 $this->addFormRule(array('CRM_Pledge_Form_Search', 'formRule'));
295 * Global validation rules for the form
297 * @param array $fields
298 * Posted values of the form.
303 public static function formRule($fields) {
306 if (!empty($errors)) {
314 * Set the default form values
317 * @return array the default array reference
319 public function setDefaultValues() {
321 $defaults = $this->_formValues
;
325 public function fixFormValues() {
326 if (!$this->_force
) {
330 // set pledge payment related fields
331 $status = CRM_Utils_Request
::retrieve('status', 'String',
332 CRM_Core_DAO
::$_nullObject
335 $this->_formValues
['pledge_payment_status_id'] = array($status => 1);
336 $this->_defaults
['pledge_payment_status_id'] = array($status => 1);
339 $fromDate = CRM_Utils_Request
::retrieve('start', 'Date',
340 CRM_Core_DAO
::$_nullObject
343 list($date) = CRM_Utils_Date
::setDateDefaults($fromDate);
344 $this->_formValues
['pledge_payment_date_low'] = $date;
345 $this->_defaults
['pledge_payment_date_low'] = $date;
348 $toDate = CRM_Utils_Request
::retrieve('end', 'Date',
349 CRM_Core_DAO
::$_nullObject
352 list($date) = CRM_Utils_Date
::setDateDefaults($toDate);
353 $this->_formValues
['pledge_payment_date_high'] = $date;
354 $this->_defaults
['pledge_payment_date_high'] = $date;
357 // set pledge related fields
358 $pledgeStatus = CRM_Utils_Request
::retrieve('pstatus', 'String',
359 CRM_Core_DAO
::$_nullObject
362 $statusValues = CRM_Contribute_PseudoConstant
::contributionStatus();
364 // Remove status values that are only used for recurring contributions for now (Failed).
365 unset($statusValues['4']);
367 // we need set all statuses except Cancelled
368 unset($statusValues[$pledgeStatus]);
371 foreach ($statusValues as $statusId => $value) {
372 $statuses[$statusId] = 1;
375 $this->_formValues
['pledge_status_id'] = $statuses;
376 $this->_defaults
['pledge_status_id'] = $statuses;
379 $pledgeFromDate = CRM_Utils_Request
::retrieve('pstart', 'Date',
380 CRM_Core_DAO
::$_nullObject
382 if ($pledgeFromDate) {
383 list($date) = CRM_Utils_Date
::setDateDefaults($pledgeFromDate);
384 $this->_formValues
['pledge_create_date_low'] = $this->_defaults
['pledge_create_date_low'] = $date;
387 $pledgeToDate = CRM_Utils_Request
::retrieve('pend', 'Date',
388 CRM_Core_DAO
::$_nullObject
391 list($date) = CRM_Utils_Date
::setDateDefaults($pledgeToDate);
392 $this->_formValues
['pledge_create_date_high'] = $this->_defaults
['pledge_create_date_high'] = $date;
395 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
397 $cid = CRM_Utils_Type
::escape($cid, 'Integer');
399 $this->_formValues
['contact_id'] = $cid;
400 list($display, $image) = CRM_Contact_BAO_Contact
::getDisplayAndImage($cid);
401 $this->_defaults
['sort_name'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $cid,
404 // also assign individual mode to the template
405 $this->_single
= TRUE;
413 public function getFormValues() {
418 * Return a descriptive name for the page, used in wizard header
422 public function getTitle() {
423 return ts('Find Pledges');