3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
37 * This class is for UF Group
39 class CRM_UF_Form_Group
extends CRM_Core_Form
{
42 * The form id saved to the session for an update.
49 * The title for group.
54 protected $_groupElement;
59 * Set variables up before form is built.
63 public function preProcess() {
65 $this->_id
= $this->get('id');
67 $this->_id
= CRM_Utils_Request
::retrieve('id', 'Positive', $this, FALSE, 0);
69 $this->assign('gid', $this->_id
);
70 $this->_group
= CRM_Core_PseudoConstant
::group();
72 if ($this->_action
& (CRM_Core_Action
::UPDATE | CRM_Core_Action
::DELETE
)) {
73 $title = CRM_Core_BAO_UFGroup
::getTitle($this->_id
);
74 $this->assign('profileTitle', $title);
77 // setting title for html page
78 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
79 CRM_Utils_System
::setTitle(ts('Profile Settings') . " - $title");
81 elseif ($this->_action
& (CRM_Core_Action
::DISABLE | CRM_Core_Action
::DELETE
)) {
82 $ufGroup['module'] = implode(' , ', CRM_Core_BAO_UFGroup
::getUFJoinRecord($this->_id
, TRUE));
84 $status = CRM_Core_BAO_UFGroup
::usedByModule($this->_id
);
85 if ($this->_action
& (CRM_Core_Action
::DISABLE
)) {
87 $message = 'This profile is currently used for ' . $ufGroup['module'] . '. If you disable the profile - it will be removed from these forms and/or modules. Do you want to continue?';
90 $message = 'Are you sure you want to disable this Profile?';
95 $message = 'This profile is currently used for ' . $ufGroup['module'] . '. If you delete the profile - it will be removed from these forms and/or modules. This action cannot be undone. Do you want to continue?';
98 $message = 'Are you sure you want to delete this Profile? This action cannot be undone.';
101 $this->assign('message', $message);
104 CRM_Utils_System
::setTitle(ts('New CiviCRM Profile'));
109 * Build the form object.
113 public function buildQuickForm() {
114 if ($this->_action
& (CRM_Core_Action
::DISABLE | CRM_Core_Action
::DELETE
)) {
115 if ($this->_action
& (CRM_Core_Action
::DISABLE
)) {
116 $display = 'Disable Profile';
119 $display = 'Delete Profile';
121 $this->addButtons(array(
125 'spacing' => ' ',
130 'name' => ts('Cancel'),
136 $this->applyFilter('__ALL__', 'trim');
139 $this->add('text', 'title', ts('Profile Name'), CRM_Core_DAO
::getAttribute('CRM_Core_DAO_UFGroup', 'title'), TRUE);
140 $this->add('textarea', 'description', ts('Description'), CRM_Core_DAO
::getAttribute('CRM_Core_DAO_UFGroup', 'description'));
143 $uf_group_type = array();
144 $UFGroupType = CRM_Core_SelectValues
::ufGroupTypes();
145 foreach ($UFGroupType as $key => $value) {
146 $uf_group_type[] = $this->createElement('checkbox', $key, NULL, $value);
148 $this->addGroup($uf_group_type, 'uf_group_type', ts('Used For'), ' ');
151 $this->add('wysiwyg', 'help_pre', ts('Pre-form Help'), CRM_Core_DAO
::getAttribute('CRM_Core_DAO_UFGroup', 'help_post'));
152 $this->add('wysiwyg', 'help_post', ts('Post-form Help'), CRM_Core_DAO
::getAttribute('CRM_Core_DAO_UFGroup', 'help_post'));
155 $this->add('text', 'weight', ts('Order'), CRM_Core_DAO
::getAttribute('CRM_Core_DAO_UFJoin', 'weight'), TRUE);
156 $this->addRule('weight', ts('is a numeric field'), 'numeric');
158 // is this group active ?
159 $this->addElement('checkbox', 'is_active', ts('Is this CiviCRM Profile active?'));
161 $paneNames = array('Advanced Settings' => 'buildAdvanceSetting');
163 foreach ($paneNames as $name => $type) {
165 $dataURL = "&reset=1&action=update&id={$this->_id}&snippet=4&formType={$type}";
168 $dataURL = "&reset=1&action=add&snippet=4&formType={$type}";
171 $allPanes[$name] = array(
172 'url' => CRM_Utils_System
::url('civicrm/admin/uf/group/setting',
179 CRM_UF_Form_AdvanceSetting
::$type($this);
182 $this->addButtons(array(
185 'name' => ts('Save'),
186 'spacing' => ' ',
191 'name' => ts('Cancel'),
196 // views are implemented as frozen form
197 if ($this->_action
& CRM_Core_Action
::VIEW
) {
199 $this->addElement('button', 'done', ts('Done'), array('onclick' => "location.href='civicrm/admin/uf/group?reset=1&action=browse'"));
202 $this->addFormRule(array('CRM_UF_Form_Group', 'formRule'), $this);
206 * Set default values for the form. Note that in edit/view mode
207 * the default values are retrieved from the database
212 public function setDefaultValues() {
214 $showHide = new CRM_Core_ShowHideBlocks();
216 if ($this->_action
== CRM_Core_Action
::ADD
) {
217 $defaults['weight'] = CRM_Utils_Weight
::getDefaultWeight('CRM_Core_DAO_UFJoin');
220 //id fetched for Dojo Pane
221 $pId = CRM_Utils_Request
::retrieve('id', 'Positive', $this);
226 if ((isset($this->_id
))) {
228 $defaults['weight'] = CRM_Core_BAO_UFGroup
::getWeight($this->_id
);
230 $params = array('id' => $this->_id
);
231 CRM_Core_BAO_UFGroup
::retrieve($params, $defaults);
232 $defaults['group'] = CRM_Utils_Array
::value('limit_listings_group_id', $defaults);
233 $defaults['add_contact_to_group'] = CRM_Utils_Array
::value('add_to_group_id', $defaults);
234 //get the uf join records for current uf group
235 $ufJoinRecords = CRM_Core_BAO_UFGroup
::getUFJoinRecord($this->_id
);
236 foreach ($ufJoinRecords as $key => $value) {
237 $checked[$value] = 1;
239 $defaults['uf_group_type'] = isset($checked) ?
$checked : "";
241 //get the uf join records for current uf group other than default modules
242 $otherModules = array();
243 $otherModules = CRM_Core_BAO_UFGroup
::getUFJoinRecord($this->_id
, TRUE, TRUE);
244 if (!empty($otherModules)) {
245 $otherModuleString = NULL;
246 foreach ($otherModules as $key) {
247 $otherModuleString .= " [ x ] <label>" . $key . "</label>";
249 $this->assign('otherModuleString', $otherModuleString);
263 'is_proximity_search',
265 foreach ($advFields as $key) {
266 if (!empty($defaults[$key])) {
268 $this->_allPanes
['Advanced Settings']['open'] = 'true';
274 $defaults['is_active'] = 1;
275 $defaults['is_map'] = 0;
276 $defaults['is_update_dupe'] = 0;
277 $defaults['is_proximity_search'] = 0;
279 // Don't assign showHide elements to template in DELETE mode (fields to be shown and hidden don't exist)
280 if (!($this->_action
& CRM_Core_Action
::DELETE
) && !($this->_action
& CRM_Core_Action
::DISABLE
)) {
281 $showHide->addToTemplate();
283 $this->assign('allPanes', $this->_allPanes
);
290 * @param array $fields
291 * The input form values.
292 * @param array $files
293 * The uploaded files if any.
295 * Current form object.
298 * true if no errors, else array of errors
300 public static function formRule($fields, $files, $self) {
303 //validate profile title as well as name.
304 $title = $fields['title'];
305 $name = CRM_Utils_String
::munge($title, '_', 56);
306 $name .= $self->_id ?
'_' . $self->_id
: '';
307 $query = 'select count(*) from civicrm_uf_group where ( name like %1 ) and id != %2';
308 $pCnt = CRM_Core_DAO
::singleValueQuery($query, array(
309 1 => array($name, 'String'),
310 2 => array((int) $self->_id
, 'Integer'),
313 $errors['title'] = ts('Profile \'%1\' already exists in Database.', array(1 => $title));
316 return empty($errors) ?
TRUE : $errors;
324 public function postProcess() {
325 if ($this->_action
& CRM_Core_Action
::DELETE
) {
326 $title = CRM_Core_BAO_UFGroup
::getTitle($this->_id
);
327 CRM_Core_BAO_UFGroup
::del($this->_id
);
328 CRM_Core_Session
::setStatus(ts("Your CiviCRM Profile '%1' has been deleted.", array(1 => $title)), ts('Profile Deleted'), 'success');
330 elseif ($this->_action
& CRM_Core_Action
::DISABLE
) {
331 $ufJoinParams = array('uf_group_id' => $this->_id
);
332 CRM_Core_BAO_UFGroup
::delUFJoin($ufJoinParams);
334 CRM_Core_BAO_UFGroup
::setIsActive($this->_id
, 0);
337 // get the submitted form values.
338 $params = $ids = array();
339 $params = $this->controller
->exportValues($this->_name
);
341 if (!array_key_exists('is_active', $params)) {
342 $params['is_active'] = 0;
345 if ($this->_action
& (CRM_Core_Action
::UPDATE
)) {
346 $ids['ufgroup'] = $this->_id
;
348 // lets skip trying to mess around with profile weights and allow the user to do as needed.
350 elseif ($this->_action
& CRM_Core_Action
::ADD
) {
351 $session = CRM_Core_Session
::singleton();
352 $params['created_id'] = $session->get('userID');
353 $params['created_date'] = date('YmdHis');
357 $ufGroup = CRM_Core_BAO_UFGroup
::add($params, $ids);
359 if (!empty($params['is_active'])) {
360 //make entry in uf join table
361 CRM_Core_BAO_UFGroup
::createUFJoin($params, $ufGroup->id
);
363 elseif ($this->_id
) {
364 // this profile has been set to inactive, delete all corresponding UF Join's
365 $ufJoinParams = array('uf_group_id' => $this->_id
);
366 CRM_Core_BAO_UFGroup
::delUFJoin($ufJoinParams);
369 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
370 $url = CRM_Utils_System
::url('civicrm/admin/uf/group', 'reset=1&action=browse');
371 CRM_Core_Session
::setStatus(ts("Your CiviCRM Profile '%1' has been saved.", array(1 => $ufGroup->title
)), ts('Profile Saved'), 'success');
374 // Jump directly to adding a field if popups are disabled
375 $action = CRM_Core_Resources
::singleton()->ajaxPopupsEnabled ?
'' : '/add';
376 $url = CRM_Utils_System
::url("civicrm/admin/uf/group/field$action", 'reset=1&new=1&gid=' . $ufGroup->id
. '&action=' . ($action ?
'add' : 'browse'));
377 CRM_Core_Session
::setStatus(ts('Your CiviCRM Profile \'%1\' has been added. You can add fields to this profile now.',
378 array(1 => $ufGroup->title
)
379 ), ts('Profile Added'), 'success');
381 $session = CRM_Core_Session
::singleton();
382 $session->replaceUserContext($url);
385 // update cms integration with registration / my account
386 CRM_Utils_System
::updateCategories();