3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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-2017
33 class CRM_Contact_Form_Search_Custom
extends CRM_Contact_Form_Search
{
35 protected $_customClass = NULL;
37 public function preProcess() {
38 $this->set('searchFormName', 'Custom');
40 $this->set('context', 'custom');
42 $csID = CRM_Utils_Request
::retrieve('csid', 'Integer', $this);
43 $ssID = CRM_Utils_Request
::retrieve('ssID', 'Integer', $this);
44 $gID = CRM_Utils_Request
::retrieve('gid', 'Integer', $this);
47 $this->_customSearchID
,
48 $this->_customSearchClass
,
50 ) = CRM_Contact_BAO_SearchCustom
::details($csID, $ssID, $gID);
52 if (!$this->_customSearchID
) {
53 CRM_Core_Error
::fatal('Could not get details for custom search.');
56 // stash this as a hidden element so we can potentially go there if the session
57 // is reset but this is available in the POST
58 $this->addElement('hidden', 'csid', $csID);
60 if (!empty($formValues)) {
61 $this->_formValues
= $formValues;
64 // set breadcrumb to return to Custom Search listings page
67 'title' => ts('Custom Searches'),
68 'url' => CRM_Utils_System
::url('civicrm/contact/search/custom/list',
73 CRM_Utils_System
::appendBreadCrumb($breadCrumb);
75 // use the custom selector
76 self
::$_selectorName = 'CRM_Contact_Selector_Custom';
78 $this->set('customSearchID', $this->_customSearchID
);
79 $this->set('customSearchClass', $this->_customSearchClass
);
83 // instantiate the new class
84 $this->_customClass
= new $this->_customSearchClass($this->_formValues
);
86 $this->addFormRule(array($this->_customClass
, 'formRule'), $this);
89 if (isset($this->_customClass
->_permissionedComponent
) &&
90 !self
::isPermissioned($this->_customClass
->_permissionedComponent
)
92 CRM_Utils_System
::permissionDenied();
97 * Add local and global form rules.
99 public function addRules() {
100 $this->addFormRule(array($this->_customClass
, 'formRule'));
104 * Set the default values of various form elements.
107 * reference to the array of default values
109 public function setDefaultValues() {
110 if (method_exists($this->_customSearchClass
, 'setDefaultValues')) {
111 return $this->_customClass
->setDefaultValues();
113 return $this->_formValues
;
117 * Builds the list of tasks or actions that a searcher can perform on a result set.
121 public function buildTaskList() {
122 // call the parent method to populate $this->_taskList for the custom search
123 parent
::buildTaskList();
125 return $this->_customClass
->buildTaskList($this);
128 public function buildQuickForm() {
129 $this->_customClass
->buildForm($this);
131 parent
::buildQuickForm();
135 * Use the form name to create the tpl file name.
142 public function getTemplateFileName() {
144 $ext = CRM_Extension_System
::singleton()->getMapper();
146 if ($ext->isExtensionClass(CRM_Utils_System
::getClassName($this->_customClass
))) {
147 $fileName = $ext->getTemplatePath(CRM_Utils_System
::getClassName($this->_customClass
)) . '/' . $ext->getTemplateName(CRM_Utils_System
::getClassName($this->_customClass
));
150 $fileName = $this->_customClass
->templateFile();
153 return $fileName ?
$fileName : parent
::getTemplateFileName();
156 public function postProcess() {
157 $this->set('isAdvanced', '3');
158 $this->set('isCustom', '1');
160 // get user submitted values
161 // get it from controller only if form has been submitted, else preProcess has set this
162 if (!empty($_POST)) {
163 $this->_formValues
= $this->controller
->exportValues($this->_name
);
165 $this->_formValues
['customSearchID'] = $this->_customSearchID
;
166 $this->_formValues
['customSearchClass'] = $this->_customSearchClass
;
169 //use the custom selector
170 self
::$_selectorName = 'CRM_Contact_Selector_Custom';
172 parent
::postProcess();
176 * Return a descriptive name for the page, used in wizard header.
180 public function getTitle() {
181 return ts('Custom Search');
189 public function isPermissioned($components) {
190 if (empty($components)) {
193 if (is_array($components)) {
194 foreach ($components as $component) {
195 if (!CRM_Core_Permission
::access($component)) {
201 if (!CRM_Core_Permission
::access($components)) {