3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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-2016
35 * Form to process actions on Price Sets.
37 class CRM_Price_Form_Set
extends CRM_Core_Form
{
40 * The set id saved to the session for an update.
47 * Set variables up before form is built.
49 public function preProcess() {
51 $this->_sid
= $this->get('sid');
53 // setting title for html page
54 $title = ts('New Price Set');
56 $title = CRM_Price_BAO_PriceSet
::getTitle($this->_sid
);
58 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
59 $title = ts('Edit %1', array(1 => $title));
61 elseif ($this->_action
& CRM_Core_Action
::VIEW
) {
62 $title = ts('Preview %1', array(1 => $title));
64 CRM_Utils_System
::setTitle($title);
66 $url = CRM_Utils_System
::url('civicrm/admin/price', 'reset=1');
69 'title' => ts('Price Sets'),
73 CRM_Utils_System
::appendBreadCrumb($breadCrumb);
79 * @param array $fields
80 * The input form values.
82 * The uploaded files if any.
83 * @param array $options
84 * Additional user data.
87 * true if no errors, else array of errors
89 public static function formRule($fields, $files, $options) {
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'])) {
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).');
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) {
103 $errors['title'] = ts("Name cannot not start with a digit");
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']))
111 CRM_Financial_BAO_FinancialAccount
::validateFinancialType($fields['financial_type_id']);
113 catch (CRM_Core_Exception
$e) {
114 $errors['financial_type_id'] = $e->getMessage();
117 return empty($errors) ?
TRUE : $errors;
121 * Build the form object.
123 public function buildQuickForm() {
124 $this->applyFilter('__ALL__', 'trim');
126 $this->assign('sid', $this->_sid
);
129 $this->add('text', 'title', ts('Set Name'), CRM_Core_DAO
::getAttribute('CRM_Price_DAO_PriceSet', 'title'), TRUE);
130 $this->addRule('title', ts('Name already exists in Database.'),
131 'objectExists', array('CRM_Price_DAO_PriceSet', $this->_sid
, 'title')
134 $priceSetUsedTables = $extends = array();
135 if ($this->_action
== CRM_Core_Action
::UPDATE
&& $this->_sid
) {
136 $priceSetUsedTables = CRM_Price_BAO_PriceSet
::getUsedBy($this->_sid
, 'table');
139 $config = CRM_Core_Config
::singleton();
140 $showContribution = FALSE;
141 $enabledComponents = CRM_Core_Component
::getEnabledComponents();
143 foreach ($enabledComponents as $name => $compObj) {
146 $option = $this->createElement('checkbox', $compObj->componentID
, NULL, ts('Event'));
147 if (!empty($priceSetUsedTables)) {
148 foreach (array('civicrm_event', 'civicrm_participant') as $table) {
149 if (in_array($table, $priceSetUsedTables)) {
155 $extends[] = $option;
158 case 'CiviContribute':
159 $option = $this->createElement('checkbox', $compObj->componentID
, NULL, ts('Contribution'));
160 if (!empty($priceSetUsedTables)) {
161 foreach (array('civicrm_contribution', 'civicrm_contribution_page') as $table) {
162 if (in_array($table, $priceSetUsedTables)) {
168 $extends[] = $option;
172 $option = $this->createElement('checkbox', $compObj->componentID
, NULL, ts('Membership'));
173 if (!empty($priceSetUsedTables)) {
174 foreach (array('civicrm_membership', 'civicrm_contribution_page') as $table) {
175 if (in_array($table, $priceSetUsedTables)) {
181 $extends[] = $option;
186 if (CRM_Utils_System
::isNull($extends)) {
187 $this->assign('extends', FALSE);
190 $this->assign('extends', TRUE);
193 $this->addGroup($extends, 'extends', ts('Used For'), ' ', TRUE);
195 $this->addRule('extends', ts('%1 is a required field.', array(1 => ts('Used For'))), 'required');
198 $financialType = CRM_Financial_BAO_FinancialType
::getIncomeFinancialType();
200 foreach ($financialType as $finTypeId => $type) {
201 if (CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()
202 && !CRM_Core_Permission
::check('add contributions of type ' . $type)
204 unset($financialType[$finTypeId]);
208 $this->add('select', 'financial_type_id',
209 ts('Default Financial Type'),
210 array('' => ts('- select -')) +
$financialType, 'required'
214 $this->add('textarea', 'help_pre', ts('Pre-form Help'),
215 CRM_Core_DAO
::getAttribute('CRM_Price_DAO_PriceSet', 'help_pre')
217 $this->add('textarea', 'help_post', ts('Post-form Help'),
218 CRM_Core_DAO
::getAttribute('CRM_Price_DAO_PriceSet', 'help_post')
221 // is this set active ?
222 $this->addElement('checkbox', 'is_active', ts('Is this Price Set active?'));
224 $this->addButtons(array(
227 'name' => ts('Save'),
228 'spacing' => ' ',
233 'name' => ts('Cancel'),
237 $this->addFormRule(array('CRM_Price_Form_Set', 'formRule'));
239 // views are implemented as frozen form
240 if ($this->_action
& CRM_Core_Action
::VIEW
) {
242 //$this->addElement('button', 'done', ts('Done'), array('onclick' => "location.href='civicrm/admin/price?reset=1&action=browse'"));
247 * Set default values for the form. Note that in edit/view mode.
249 * The default values are retrieved from the database.
252 * array of default values
254 public function setDefaultValues() {
255 $defaults = array('is_active' => TRUE);
257 $params = array('id' => $this->_sid
);
258 CRM_Price_BAO_PriceSet
::retrieve($params, $defaults);
259 $extends = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $defaults['extends']);
260 unset($defaults['extends']);
261 foreach ($extends as $compId) {
262 $defaults['extends'][$compId] = 1;
272 public function postProcess() {
273 // get the submitted form values.
274 $params = $this->controller
->exportValues('Set');
275 $nameLength = CRM_Core_DAO
::getAttribute('CRM_Price_DAO_PriceSet', 'name');
276 $params['is_active'] = CRM_Utils_Array
::value('is_active', $params, FALSE);
277 $params['financial_type_id'] = CRM_Utils_Array
::value('financial_type_id', $params, FALSE);
280 $extends = CRM_Utils_Array
::value('extends', $params);
281 if (is_array($extends)) {
282 foreach ($extends as $compId => $selected) {
284 $compIds[] = $compId;
288 $params['extends'] = implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $compIds);
290 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
291 $params['id'] = $this->_sid
;
294 $params['name'] = CRM_Utils_String
::titleToVar($params['title'],
295 CRM_Utils_Array
::value('maxlength', $nameLength));
298 $set = CRM_Price_BAO_PriceSet
::create($params);
299 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
300 CRM_Core_Session
::setStatus(ts('The Set \'%1\' has been saved.', array(1 => $set->title
)), ts('Saved'), 'success');
303 // Jump directly to adding a field if popups are disabled
304 $action = CRM_Core_Resources
::singleton()->ajaxPopupsEnabled ?
'browse' : 'add';
305 $url = CRM_Utils_System
::url('civicrm/admin/price/field', array(
311 CRM_Core_Session
::setStatus(ts("Your Set '%1' has been added. You can add fields to this set now.",
312 array(1 => $set->title
)
313 ), ts('Saved'), 'success');
314 $session = CRM_Core_Session
::singleton();
315 $session->replaceUserContext($url);