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
41 * This file is for civievent search
43 class CRM_Event_Form_Search
extends CRM_Core_Form_Search
{
46 * The params that are sent to the query
50 protected $_queryParams;
53 * Are we restricting ourselves to a single contact
57 protected $_single = FALSE;
60 * Are we restricting ourselves to a single contact
64 protected $_limit = NULL;
67 * Prefix for the controller
69 protected $_prefix = "event_";
74 * The saved search ID retrieved from the GET vars
81 * Processing needed for buildForm and later
85 public function preProcess() {
86 $this->set('searchFormName', 'Search');
89 * set the button names
91 $this->_searchButtonName
= $this->getButtonName('refresh');
92 $this->_actionButtonName
= $this->getButtonName('next', 'action');
95 $this->defaults
= array();
98 * we allow the controller to set force/reset externally, useful when we are being
99 * driven by the wizard framework
101 $this->_reset
= CRM_Utils_Request
::retrieve('reset', 'Boolean', CRM_Core_DAO
::$_nullObject);
102 $this->_force
= CRM_Utils_Request
::retrieve('force', 'Boolean', $this, FALSE);
103 $this->_limit
= CRM_Utils_Request
::retrieve('limit', 'Positive', $this);
104 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this, FALSE, 'search');
105 $this->_ssID
= CRM_Utils_Request
::retrieve('ssID', 'Positive', $this);
106 $this->assign("context", $this->_context
);
108 // get user submitted values
109 // get it from controller only if form has been submitted, else preProcess has set this
110 if (!empty($_POST) && !$this->controller
->isModal()) {
111 $this->_formValues
= $this->controller
->exportValues($this->_name
);
114 $this->_formValues
= $this->get('formValues');
117 if (empty($this->_formValues
)) {
118 if (isset($this->_ssID
)) {
119 $this->_formValues
= CRM_Contact_BAO_SavedSearch
::getFormValues($this->_ssID
);
124 $this->postProcess();
125 $this->set('force', 0);
129 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
130 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
131 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
135 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
136 $selector = new CRM_Event_Selector_Search($this->_queryParams
,
144 if ($this->_context
== 'user') {
145 $prefix = $this->_prefix
;
148 $this->assign("{$prefix}limit", $this->_limit
);
149 $this->assign("{$prefix}single", $this->_single
);
151 $controller = new CRM_Core_Selector_Controller($selector,
152 $this->get(CRM_Utils_Pager
::PAGE_ID
),
154 CRM_Core_Action
::VIEW
,
156 CRM_Core_Selector_Controller
::TRANSFER
,
159 $controller->setEmbedded(TRUE);
160 $controller->moveFromSessionToTemplate();
162 $this->assign('summary', $this->get('summary'));
166 * Build the form object
171 public function buildQuickForm() {
172 parent
::buildQuickForm();
173 $this->addElement('text', 'sort_name', ts('Participant Name or Email'), CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Contact', 'sort_name'));
175 CRM_Event_BAO_Query
::buildSearchForm($this);
177 $rows = $this->get('rows');
178 if (is_array($rows)) {
179 $lineItems = $eventIds = array();
180 if (!$this->_single
) {
181 $this->addRowSelectors($rows);
183 foreach ($rows as $row) {
184 $eventIds[$row['event_id']] = $row['event_id'];
185 if (CRM_Event_BAO_Event
::usesPriceSet($row['event_id'])) {
186 // add line item details if applicable
187 $lineItems[$row['participant_id']] = CRM_Price_BAO_LineItem
::getLineItems($row['participant_id']);
191 //get actual count only when we are dealing w/ single event.
192 $participantCount = 0;
193 if (count($eventIds) == 1) {
194 //convert form values to clause.
195 $seatClause = array();
198 if (!empty($this->_formValues
['participant_fee_id'])) {
199 $participant_fee_id = $this->_formValues
['participant_fee_id'];
200 $feeLabel = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceFieldValue', $participant_fee_id, 'label');
201 $feeLabel = CRM_Core_DAO
::escapeString(trim($feeLabel));
202 $clause = " ( participant.fee_level LIKE '%$feeLabel%' ) ";
205 $participantCount = CRM_Event_BAO_Event
::eventTotalSeats(array_pop($eventIds), $clause);
207 $this->assign('participantCount', $participantCount);
208 $this->assign('lineItems', $lineItems);
210 $permission = CRM_Core_Permission
::getPermission();
212 $tasks = CRM_Event_Task
::permissionedTaskTitles($permission);
213 if (isset($this->_ssID
)) {
214 if ($permission == CRM_Core_Permission
::EDIT
) {
215 $tasks = $tasks + CRM_Event_Task
::optionalTaskTitle();
218 $savedSearchValues = array(
219 'id' => $this->_ssID
,
220 'name' => CRM_Contact_BAO_SavedSearch
::getName($this->_ssID
, 'title'),
222 $this->assign_by_ref('savedSearch', $savedSearchValues);
223 $this->assign('ssID', $this->_ssID
);
226 $this->addTaskMenu($tasks);
232 * The post processing of the form gets done here.
234 * Key things done during post processing are
235 * - check for reset or next request. if present, skip post procesing.
236 * - now check if user requested running a saved search, if so, then
237 * the form values associated with the saved search are used for searching.
238 * - if user has done a submit with new values the regular post submissing is
240 * The processing consists of using a Selector / Controller framework for getting the
247 public function postProcess() {
254 if (!empty($_POST)) {
255 $this->_formValues
= $this->controller
->exportValues($this->_name
);
256 foreach (array('participant_status_id', 'participant_role_id') as $element) {
257 $value = CRM_Utils_Array
::value($element, $this->_formValues
);
258 if ($value && is_array($value)) {
259 $this->_formValues
[$element] = array('IN' => $value);
264 if (empty($this->_formValues
)) {
265 $this->_formValues
= $this->controller
->exportValues($this->_name
);
268 $this->fixFormValues();
270 if (isset($this->_ssID
) && empty($_POST)) {
271 // if we are editing / running a saved search and the form has not been posted
272 $this->_formValues
= CRM_Contact_BAO_SavedSearch
::getFormValues($this->_ssID
);
275 // We don't show test records in summaries or dashboards
276 if (empty($this->_formValues
['participant_test']) && $this->_force
) {
277 $this->_formValues
["participant_test"] = 0;
280 CRM_Core_BAO_CustomValue
::fixFieldValueOfTypeMemo($this->_formValues
);
282 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
284 $this->set('formValues', $this->_formValues
);
285 $this->set('queryParams', $this->_queryParams
);
287 $buttonName = $this->controller
->getButtonName();
288 if ($buttonName == $this->_actionButtonName
) {
289 // check actionName and if next, then do not repeat a search, since we are going to the next page
291 // hack, make sure we reset the task values
292 $stateMachine = $this->controller
->getStateMachine();
293 $formName = $stateMachine->getTaskFormName();
294 $this->controller
->resetPage($formName);
299 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
300 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
301 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
305 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
307 $selector = new CRM_Event_Selector_Search($this->_queryParams
,
315 $selector->setKey($this->controller
->_key
);
318 if ($this->_context
== 'user') {
319 $prefix = $this->_prefix
;
322 $this->assign("{$prefix}limit", $this->_limit
);
323 $this->assign("{$prefix}single", $this->_single
);
325 $controller = new CRM_Core_Selector_Controller($selector,
326 $this->get(CRM_Utils_Pager
::PAGE_ID
),
328 CRM_Core_Action
::VIEW
,
330 CRM_Core_Selector_Controller
::SESSION
,
333 $controller->setEmbedded(TRUE);
335 $query = $selector->getQuery();
336 if ($this->_context
== 'user') {
337 $query->setSkipPermission(TRUE);
343 * add the rules (mainly global rules) for form.
344 * All local rules are added near the element
349 public function addRules() {
353 * Set the default form values
357 * the default array reference
359 public function setDefaultValues() {
361 $defaults = $this->_formValues
;
365 public function fixFormValues() {
366 // if this search has been forced
367 // then see if there are any get values, and if so over-ride the post values
368 // note that this means that GET over-rides POST :)
369 $event = CRM_Utils_Request
::retrieve('event', 'Positive',
370 CRM_Core_DAO
::$_nullObject
373 $this->_formValues
['event_id'] = $event;
374 $this->_formValues
['event_name'] = CRM_Event_PseudoConstant
::event($event, TRUE);
377 $status = CRM_Utils_Request
::retrieve('status', 'String',
378 CRM_Core_DAO
::$_nullObject
381 if (isset($status)) {
382 if ($status === 'true') {
383 $statusTypes = CRM_Event_PseudoConstant
::participantStatus(NULL, "is_counted = 1");
385 elseif ($status === 'false') {
386 $statusTypes = CRM_Event_PseudoConstant
::participantStatus(NULL, "is_counted = 0");
388 elseif (is_numeric($status)) {
389 $status = (int) $status;
390 $statusTypes = array($status => CRM_Event_PseudoConstant
::participantStatus($status));
393 foreach ($statusTypes as $key => $value) {
396 $this->_formValues
['participant_status_id'] = $status;
399 $role = CRM_Utils_Request
::retrieve('role', 'String',
400 CRM_Core_DAO
::$_nullObject
404 if ($role === 'true') {
405 $roleTypes = CRM_Event_PseudoConstant
::participantRole(NULL, "filter = 1");
407 elseif ($role === 'false') {
408 $roleTypes = CRM_Event_PseudoConstant
::participantRole(NULL, "filter = 0");
410 elseif (is_numeric($role)) {
412 $roleTypes = array($role => CRM_Event_PseudoConstant
::participantRole($role));
415 foreach ($roleTypes as $key => $value) {
418 $this->_formValues
['participant_role_id'] = $role;
421 $type = CRM_Utils_Request
::retrieve('type', 'Positive',
422 CRM_Core_DAO
::$_nullObject
425 $this->_formValues
['event_type'] = $type;
428 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
431 $cid = CRM_Utils_Type
::escape($cid, 'Integer');
433 $this->_formValues
['contact_id'] = $cid;
435 // also assign individual mode to the template
436 $this->_single
= TRUE;
444 public function getFormValues() {
449 * Return a descriptive name for the page, used in wizard header
453 public function getTitle() {
454 return ts('Find Participants');