Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
fa938177 | 6 | | Copyright CiviCRM LLC (c) 2004-2016 | |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
fa938177 | 31 | * @copyright CiviCRM LLC (c) 2004-2016 |
6a488035 TO |
32 | */ |
33 | ||
34 | /** | |
ad37ac8e | 35 | * Form to process actions on Price Sets. |
6a488035 TO |
36 | */ |
37 | class CRM_Price_Form_Set extends CRM_Core_Form { | |
38 | ||
39 | /** | |
fe482240 | 40 | * The set id saved to the session for an update. |
6a488035 TO |
41 | * |
42 | * @var int | |
6a488035 TO |
43 | */ |
44 | protected $_sid; | |
45 | ||
46 | /** | |
fe482240 | 47 | * Set variables up before form is built. |
6a488035 TO |
48 | */ |
49 | public function preProcess() { | |
50 | // current set id | |
51 | $this->_sid = $this->get('sid'); | |
52 | ||
53 | // setting title for html page | |
54 | $title = ts('New Price Set'); | |
55 | if ($this->_sid) { | |
9da8dc8c | 56 | $title = CRM_Price_BAO_PriceSet::getTitle($this->_sid); |
6a488035 TO |
57 | } |
58 | if ($this->_action & CRM_Core_Action::UPDATE) { | |
59 | $title = ts('Edit %1', array(1 => $title)); | |
60 | } | |
61 | elseif ($this->_action & CRM_Core_Action::VIEW) { | |
62 | $title = ts('Preview %1', array(1 => $title)); | |
63 | } | |
64 | CRM_Utils_System::setTitle($title); | |
65 | ||
66 | $url = CRM_Utils_System::url('civicrm/admin/price', 'reset=1'); | |
353ffa53 TO |
67 | $breadCrumb = array( |
68 | array( | |
69 | 'title' => ts('Price Sets'), | |
6a488035 | 70 | 'url' => $url, |
bed98343 | 71 | ), |
353ffa53 | 72 | ); |
6a488035 TO |
73 | CRM_Utils_System::appendBreadCrumb($breadCrumb); |
74 | } | |
75 | ||
76 | /** | |
fe482240 | 77 | * Global form rule. |
6a488035 | 78 | * |
414c1420 TO |
79 | * @param array $fields |
80 | * The input form values. | |
81 | * @param array $files | |
82 | * The uploaded files if any. | |
83 | * @param array $options | |
84 | * Additional user data. | |
6a488035 | 85 | * |
72b3a70c CW |
86 | * @return bool|array |
87 | * true if no errors, else array of errors | |
6a488035 | 88 | */ |
00be9182 | 89 | public static function formRule($fields, $files, $options) { |
6a488035 TO |
90 | $errors = array(); |
91 | $count = count(CRM_Utils_Array::value('extends', $fields)); | |
92 | //price sets configured for membership | |
93 | if ($count && array_key_exists(CRM_Core_Component::getComponentID('CiviMember'), $fields['extends'])) { | |
94 | if ($count > 1) { | |
95 | $errors['extends'] = ts('If you plan on using this price set for membership signup and renewal, you can not also use it for Events or Contributions. However, a membership price set may include additional fields for non-membership options that require an additional fee (e.g. magazine subscription).'); | |
96 | } | |
97 | } | |
98 | //checks the given price set doesnot start with digit | |
99 | $title = $fields['title']; | |
100 | // gives the ascii value | |
101 | $asciiValue = ord($title{0}); | |
102 | if ($asciiValue >= 48 && $asciiValue <= 57) { | |
5ab78070 | 103 | $errors['title'] = ts("Name cannot not start with a digit"); |
6a488035 | 104 | } |
e68e1c9a PN |
105 | // CRM-16189 |
106 | if (!empty($fields['extends']) | |
107 | && (array_key_exists(CRM_Core_Component::getComponentID('CiviEvent'), $fields['extends']) | |
108 | || array_key_exists(CRM_Core_Component::getComponentID('CiviMember'), $fields['extends'])) | |
109 | ) { | |
110 | $isError = CRM_Financial_BAO_FinancialAccount::validateFinancialType($fields['financial_type_id']); | |
111 | if ($isError) { | |
112 | $errors['financial_type_id'] = ts('Deferred revenue account is not configured for selected financial type. Please have an administrator set up the deferred revenue account at Administer > CiviContribute > Financial Accounts, then configure it for financial types at Administer > CiviContribution > Financial Types, Accounts'); | |
113 | } | |
114 | } | |
6a488035 TO |
115 | return empty($errors) ? TRUE : $errors; |
116 | } | |
117 | ||
118 | /** | |
fe482240 | 119 | * Build the form object. |
6a488035 TO |
120 | */ |
121 | public function buildQuickForm() { | |
122 | $this->applyFilter('__ALL__', 'trim'); | |
123 | ||
124 | $this->assign('sid', $this->_sid); | |
125 | ||
126 | // title | |
9da8dc8c | 127 | $this->add('text', 'title', ts('Set Name'), CRM_Core_DAO::getAttribute('CRM_Price_DAO_PriceSet', 'title'), TRUE); |
6a488035 | 128 | $this->addRule('title', ts('Name already exists in Database.'), |
9da8dc8c | 129 | 'objectExists', array('CRM_Price_DAO_PriceSet', $this->_sid, 'title') |
6a488035 TO |
130 | ); |
131 | ||
132 | $priceSetUsedTables = $extends = array(); | |
133 | if ($this->_action == CRM_Core_Action::UPDATE && $this->_sid) { | |
9da8dc8c | 134 | $priceSetUsedTables = CRM_Price_BAO_PriceSet::getUsedBy($this->_sid, 'table'); |
6a488035 TO |
135 | } |
136 | ||
353ffa53 | 137 | $config = CRM_Core_Config::singleton(); |
6a488035 | 138 | $showContribution = FALSE; |
6091117f | 139 | $enabledComponents = CRM_Core_Component::getEnabledComponents(); |
140 | ||
141 | foreach ($enabledComponents as $name => $compObj) { | |
142 | switch ($name) { | |
143 | case 'CiviEvent': | |
144 | $option = $this->createElement('checkbox', $compObj->componentID, NULL, ts('Event')); | |
145 | if (!empty($priceSetUsedTables)) { | |
146 | foreach (array('civicrm_event', 'civicrm_participant') as $table) { | |
147 | if (in_array($table, $priceSetUsedTables)) { | |
148 | $option->freeze(); | |
149 | break; | |
150 | } | |
151 | } | |
152 | } | |
153 | $extends[] = $option; | |
154 | break; | |
ba1dcfda | 155 | |
6091117f | 156 | case 'CiviContribute': |
157 | $option = $this->createElement('checkbox', $compObj->componentID, NULL, ts('Contribution')); | |
158 | if (!empty($priceSetUsedTables)) { | |
159 | foreach (array('civicrm_contribution', 'civicrm_contribution_page') as $table) { | |
160 | if (in_array($table, $priceSetUsedTables)) { | |
161 | $option->freeze(); | |
162 | break; | |
163 | } | |
164 | } | |
165 | } | |
166 | $extends[] = $option; | |
167 | break; | |
ba1dcfda | 168 | |
6091117f | 169 | case 'CiviMember': |
170 | $option = $this->createElement('checkbox', $compObj->componentID, NULL, ts('Membership')); | |
171 | if (!empty($priceSetUsedTables)) { | |
172 | foreach (array('civicrm_membership', 'civicrm_contribution_page') as $table) { | |
173 | if (in_array($table, $priceSetUsedTables)) { | |
174 | $option->freeze(); | |
175 | break; | |
176 | } | |
177 | } | |
6a488035 | 178 | } |
6091117f | 179 | $extends[] = $option; |
180 | break; | |
6a488035 | 181 | } |
6a488035 TO |
182 | } |
183 | ||
184 | if (CRM_Utils_System::isNull($extends)) { | |
185 | $this->assign('extends', FALSE); | |
186 | } | |
187 | else { | |
188 | $this->assign('extends', TRUE); | |
189 | } | |
190 | ||
191 | $this->addGroup($extends, 'extends', ts('Used For'), ' ', TRUE); | |
192 | ||
193 | $this->addRule('extends', ts('%1 is a required field.', array(1 => ts('Used For'))), 'required'); | |
366fe2a3 | 194 | |
6a488035 TO |
195 | // financial type |
196 | $financialType = CRM_Financial_BAO_FinancialType::getIncomeFinancialType(); | |
366fe2a3 | 197 | |
53df1142 | 198 | foreach ($financialType as $finTypeId => $type) { |
40c655aa | 199 | if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus() |
66af7c48 PN |
200 | && !CRM_Core_Permission::check('add contributions of type ' . $type) |
201 | ) { | |
53df1142 E |
202 | unset($financialType[$finTypeId]); |
203 | } | |
204 | } | |
205 | ||
6a488035 TO |
206 | $this->add('select', 'financial_type_id', |
207 | ts('Default Financial Type'), | |
353ffa53 | 208 | array('' => ts('- select -')) + $financialType, 'required' |
6a488035 TO |
209 | ); |
210 | ||
211 | // help text | |
212 | $this->add('textarea', 'help_pre', ts('Pre-form Help'), | |
9da8dc8c | 213 | CRM_Core_DAO::getAttribute('CRM_Price_DAO_PriceSet', 'help_pre') |
6a488035 TO |
214 | ); |
215 | $this->add('textarea', 'help_post', ts('Post-form Help'), | |
9da8dc8c | 216 | CRM_Core_DAO::getAttribute('CRM_Price_DAO_PriceSet', 'help_post') |
6a488035 TO |
217 | ); |
218 | ||
219 | // is this set active ? | |
220 | $this->addElement('checkbox', 'is_active', ts('Is this Price Set active?')); | |
221 | ||
222 | $this->addButtons(array( | |
c5c263ca AH |
223 | array( |
224 | 'type' => 'next', | |
225 | 'name' => ts('Save'), | |
226 | 'spacing' => ' ', | |
227 | 'isDefault' => TRUE, | |
228 | ), | |
229 | array( | |
230 | 'type' => 'cancel', | |
231 | 'name' => ts('Cancel'), | |
232 | ), | |
233 | )); | |
6a488035 TO |
234 | |
235 | $this->addFormRule(array('CRM_Price_Form_Set', 'formRule')); | |
236 | ||
237 | // views are implemented as frozen form | |
238 | if ($this->_action & CRM_Core_Action::VIEW) { | |
239 | $this->freeze(); | |
240 | //$this->addElement('button', 'done', ts('Done'), array('onclick' => "location.href='civicrm/admin/price?reset=1&action=browse'")); | |
241 | } | |
242 | } | |
243 | ||
244 | /** | |
ad37ac8e | 245 | * Set default values for the form. Note that in edit/view mode. |
246 | * | |
247 | * The default values are retrieved from the database. | |
6a488035 | 248 | * |
a6c01b45 CW |
249 | * @return array |
250 | * array of default values | |
6a488035 | 251 | */ |
00be9182 | 252 | public function setDefaultValues() { |
6a488035 TO |
253 | $defaults = array('is_active' => TRUE); |
254 | if ($this->_sid) { | |
255 | $params = array('id' => $this->_sid); | |
9da8dc8c | 256 | CRM_Price_BAO_PriceSet::retrieve($params, $defaults); |
6a488035 TO |
257 | $extends = explode(CRM_Core_DAO::VALUE_SEPARATOR, $defaults['extends']); |
258 | unset($defaults['extends']); | |
9277d9e4 TO |
259 | foreach ($extends as $compId) { |
260 | $defaults['extends'][$compId] = 1; | |
ba1dcfda | 261 | } |
6a488035 TO |
262 | } |
263 | ||
264 | return $defaults; | |
265 | } | |
266 | ||
267 | /** | |
fe482240 | 268 | * Process the form. |
6a488035 TO |
269 | */ |
270 | public function postProcess() { | |
271 | // get the submitted form values. | |
272 | $params = $this->controller->exportValues('Set'); | |
9da8dc8c | 273 | $nameLength = CRM_Core_DAO::getAttribute('CRM_Price_DAO_PriceSet', 'name'); |
6a488035 TO |
274 | $params['is_active'] = CRM_Utils_Array::value('is_active', $params, FALSE); |
275 | $params['financial_type_id'] = CRM_Utils_Array::value('financial_type_id', $params, FALSE); | |
276 | ||
277 | $compIds = array(); | |
278 | $extends = CRM_Utils_Array::value('extends', $params); | |
279 | if (is_array($extends)) { | |
4f99ca55 TO |
280 | foreach ($extends as $compId => $selected) { |
281 | if ($selected) { | |
282 | $compIds[] = $compId; | |
283 | } | |
ba1dcfda | 284 | } |
6a488035 TO |
285 | } |
286 | $params['extends'] = implode(CRM_Core_DAO::VALUE_SEPARATOR, $compIds); | |
287 | ||
288 | if ($this->_action & CRM_Core_Action::UPDATE) { | |
289 | $params['id'] = $this->_sid; | |
290 | } | |
0c86abc7 | 291 | else { |
292 | $params['name'] = CRM_Utils_String::titleToVar($params['title'], | |
293 | CRM_Utils_Array::value('maxlength', $nameLength)); | |
294 | } | |
6a488035 | 295 | |
9da8dc8c | 296 | $set = CRM_Price_BAO_PriceSet::create($params); |
6a488035 TO |
297 | if ($this->_action & CRM_Core_Action::UPDATE) { |
298 | CRM_Core_Session::setStatus(ts('The Set \'%1\' has been saved.', array(1 => $set->title)), ts('Saved'), 'success'); | |
299 | } | |
300 | else { | |
704f21c0 CW |
301 | // Jump directly to adding a field if popups are disabled |
302 | $action = CRM_Core_Resources::singleton()->ajaxPopupsEnabled ? 'browse' : 'add'; | |
353ffa53 | 303 | $url = CRM_Utils_System::url('civicrm/admin/price/field', array( |
c5c263ca AH |
304 | 'reset' => 1, |
305 | 'action' => $action, | |
306 | 'sid' => $set->id, | |
307 | 'new' => 1, | |
308 | )); | |
6a488035 | 309 | CRM_Core_Session::setStatus(ts("Your Set '%1' has been added. You can add fields to this set now.", |
353ffa53 TO |
310 | array(1 => $set->title) |
311 | ), ts('Saved'), 'success'); | |
6a488035 TO |
312 | $session = CRM_Core_Session::singleton(); |
313 | $session->replaceUserContext($url); | |
314 | } | |
315 | } | |
96025800 | 316 | |
6a488035 | 317 | } |