Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
06b69b18 | 4 | | CiviCRM version 4.5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
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 | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | class CRM_Contact_Form_Search_Custom extends CRM_Contact_Form_Search { | |
36 | ||
37 | protected $_customClass = NULL; | |
38 | ||
39 | public function preProcess() { | |
40 | $this->set('searchFormName', 'Custom'); | |
41 | ||
42 | $this->set('context', 'custom'); | |
43 | ||
44 | $csID = CRM_Utils_Request::retrieve('csid', 'Integer', $this); | |
45 | $ssID = CRM_Utils_Request::retrieve('ssID', 'Integer', $this); | |
46 | $gID = CRM_Utils_Request::retrieve('gid', 'Integer', $this); | |
47 | ||
c7b8b4e4 DL |
48 | list( |
49 | $this->_customSearchID, | |
6a488035 TO |
50 | $this->_customSearchClass, |
51 | $formValues | |
52 | ) = CRM_Contact_BAO_SearchCustom::details($csID, $ssID, $gID); | |
53 | ||
54 | if (!$this->_customSearchID) { | |
55 | CRM_Core_Error::fatal('Could not get details for custom search.'); | |
56 | } | |
57 | ||
c7b8b4e4 DL |
58 | // stash this as a hidden element so we can potentially go there if the session |
59 | // is reset but this is available in the POST | |
60 | $this->addElement('hidden', 'csid', $csID); | |
61 | ||
6a488035 TO |
62 | if (!empty($formValues)) { |
63 | $this->_formValues = $formValues; | |
64 | } | |
65 | ||
66 | // set breadcrumb to return to Custom Search listings page | |
67 | $breadCrumb = array(array('title' => ts('Custom Searches'), | |
68 | 'url' => CRM_Utils_System::url('civicrm/contact/search/custom/list', | |
69 | 'reset=1' | |
70 | ), | |
71 | )); | |
72 | CRM_Utils_System::appendBreadCrumb($breadCrumb); | |
73 | ||
74 | // use the custom selector | |
75 | self::$_selectorName = 'CRM_Contact_Selector_Custom'; | |
76 | ||
77 | $this->set('customSearchID', $this->_customSearchID); | |
78 | $this->set('customSearchClass', $this->_customSearchClass); | |
79 | ||
80 | parent::preProcess(); | |
81 | ||
82 | // instantiate the new class | |
4d5c2eb5 | 83 | $this->_customClass = new $this->_customSearchClass( $this->_formValues ); |
4e54c348 PJ |
84 | |
85 | // CRM-12747 | |
86 | if (isset($this->_customClass->_permissionedComponent) && | |
87 | !self::isPermissioned($this->_customClass->_permissionedComponent)) { | |
88 | CRM_Utils_System::permissionDenied(); | |
89 | } | |
6a488035 TO |
90 | } |
91 | ||
86538308 EM |
92 | /** |
93 | * This virtual function is used to set the default values of | |
94 | * various form elements | |
95 | * | |
96 | * access public | |
97 | * | |
98 | * @return array reference to the array of default values | |
99 | * | |
100 | */ | |
101 | /** | |
102 | * @return array | |
103 | */ | |
6a488035 TO |
104 | function setDefaultValues() { |
105 | if (method_exists($this->_customSearchClass, 'setDefaultValues')) { | |
106 | return $this->_customClass->setDefaultValues(); | |
107 | } | |
108 | return $this->_formValues; | |
109 | } | |
110 | ||
111 | function buildQuickForm() { | |
112 | $this->_customClass->buildForm($this); | |
113 | ||
114 | parent::buildQuickForm(); | |
115 | } | |
116 | ||
86538308 EM |
117 | /** |
118 | * Use the form name to create the tpl file name | |
119 | * | |
120 | * @return string | |
121 | * @access public | |
122 | */ | |
123 | /** | |
124 | * @return string | |
125 | */ | |
6a488035 TO |
126 | function getTemplateFileName() { |
127 | ||
128 | $ext = CRM_Extension_System::singleton()->getMapper(); | |
129 | ||
130 | if ($ext->isExtensionClass(CRM_Utils_System::getClassName($this->_customClass))) { | |
131 | $fileName = $ext->getTemplatePath(CRM_Utils_System::getClassName($this->_customClass)) . '/' . $ext->getTemplateName(CRM_Utils_System::getClassName($this->_customClass)); | |
132 | } | |
133 | else { | |
134 | $fileName = $this->_customClass->templateFile(); | |
135 | } | |
136 | ||
137 | return $fileName ? $fileName : parent::getTemplateFileName(); | |
138 | } | |
139 | ||
140 | function postProcess() { | |
141 | $this->set('isAdvanced', '3'); | |
142 | $this->set('isCustom', '1'); | |
143 | ||
144 | // get user submitted values | |
145 | // get it from controller only if form has been submitted, else preProcess has set this | |
146 | if (!empty($_POST)) { | |
147 | $this->_formValues = $this->controller->exportValues($this->_name); | |
148 | ||
149 | $this->_formValues['customSearchID'] = $this->_customSearchID; | |
150 | $this->_formValues['customSearchClass'] = $this->_customSearchClass; | |
151 | } | |
152 | ||
153 | //use the custom selector | |
154 | self::$_selectorName = 'CRM_Contact_Selector_Custom'; | |
155 | ||
156 | parent::postProcess(); | |
157 | } | |
158 | ||
86538308 EM |
159 | /** |
160 | * Return a descriptive name for the page, used in wizard header | |
161 | * | |
162 | * @return string | |
163 | * @access public | |
164 | */ | |
165 | /** | |
166 | * @return string | |
167 | */ | |
6a488035 TO |
168 | public function getTitle() { |
169 | return ts('Custom Search'); | |
170 | } | |
6a488035 | 171 | |
86538308 EM |
172 | /** |
173 | * @param $components | |
174 | * | |
175 | * @return bool | |
176 | */ | |
4e54c348 PJ |
177 | function isPermissioned($components) { |
178 | if (empty($components)) { | |
179 | return TRUE; | |
180 | } | |
181 | if (is_array($components)) { | |
182 | foreach ($components as $component) { | |
183 | if (!CRM_Core_Permission::access($component)) { | |
184 | return FALSE; | |
185 | } | |
186 | } | |
187 | } | |
188 | else { | |
189 | if (!CRM_Core_Permission::access($components)) { | |
190 | return FALSE; | |
191 | } | |
192 | } | |
193 | return TRUE; | |
194 | } | |
232624b1 | 195 | } |