drupal-civicrm/sites/all/modules/civicrm/CRM/UF/Form/Group.php
2018-01-14 13:10:16 +00:00

388 lines
13 KiB
PHP

<?php
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.7 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2017 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| CiviCRM is free software; you can copy, modify, and distribute it |
| under the terms of the GNU Affero General Public License |
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
| |
| CiviCRM is distributed in the hope that it will be useful, but |
| WITHOUT ANY WARRANTY; without even the implied warranty of |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
| See the GNU Affero General Public License for more details. |
| |
| You should have received a copy of the GNU Affero General Public |
| License and the CiviCRM Licensing Exception along |
| with this program; if not, contact CiviCRM LLC |
| at info[AT]civicrm[DOT]org. If you have questions about the |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/
/**
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2017
* $Id$
*
*/
/**
* This class is for UF Group
*/
class CRM_UF_Form_Group extends CRM_Core_Form {
/**
* The form id saved to the session for an update.
*
* @var int
*/
protected $_id;
/**
* The title for group.
*
* @var int
*/
protected $_title;
protected $_groupElement;
protected $_group;
protected $_allPanes;
/**
* Set variables up before form is built.
*
* @return void
*/
public function preProcess() {
// current form id
$this->_id = $this->get('id');
if (!$this->_id) {
$this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this, FALSE, 0);
}
$this->assign('gid', $this->_id);
$this->_group = CRM_Core_PseudoConstant::group();
if ($this->_action & (CRM_Core_Action::UPDATE | CRM_Core_Action::DELETE)) {
$title = CRM_Core_BAO_UFGroup::getTitle($this->_id);
$this->assign('profileTitle', $title);
}
// setting title for html page
if ($this->_action & CRM_Core_Action::UPDATE) {
CRM_Utils_System::setTitle(ts('Profile Settings') . " - $title");
}
elseif ($this->_action & (CRM_Core_Action::DISABLE | CRM_Core_Action::DELETE)) {
$ufGroup['module'] = implode(' , ', CRM_Core_BAO_UFGroup::getUFJoinRecord($this->_id, TRUE));
$status = 0;
$status = CRM_Core_BAO_UFGroup::usedByModule($this->_id);
if ($this->_action & (CRM_Core_Action::DISABLE)) {
if ($status) {
$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?';
}
else {
$message = 'Are you sure you want to disable this Profile?';
}
}
else {
if ($status) {
$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?';
}
else {
$message = 'Are you sure you want to delete this Profile? This action cannot be undone.';
}
}
$this->assign('message', $message);
}
else {
CRM_Utils_System::setTitle(ts('New CiviCRM Profile'));
}
}
/**
* Build the form object.
*
* @return void
*/
public function buildQuickForm() {
if ($this->_action & (CRM_Core_Action::DISABLE | CRM_Core_Action::DELETE)) {
if ($this->_action & (CRM_Core_Action::DISABLE)) {
$display = 'Disable Profile';
}
else {
$display = 'Delete Profile';
}
$this->addButtons(array(
array(
'type' => 'next',
'name' => $display,
'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
'isDefault' => TRUE,
),
array(
'type' => 'cancel',
'name' => ts('Cancel'),
),
));
return;
}
$this->applyFilter('__ALL__', 'trim');
// title
$this->add('text', 'title', ts('Profile Name'), CRM_Core_DAO::getAttribute('CRM_Core_DAO_UFGroup', 'title'), TRUE);
$this->add('textarea', 'description', ts('Description'), CRM_Core_DAO::getAttribute('CRM_Core_DAO_UFGroup', 'description'));
//add checkboxes
$uf_group_type = array();
$UFGroupType = CRM_Core_SelectValues::ufGroupTypes();
foreach ($UFGroupType as $key => $value) {
$uf_group_type[] = $this->createElement('checkbox', $key, NULL, $value);
}
$this->addGroup($uf_group_type, 'uf_group_type', ts('Used For'), '&nbsp;');
// help text
$this->add('wysiwyg', 'help_pre', ts('Pre-form Help'), CRM_Core_DAO::getAttribute('CRM_Core_DAO_UFGroup', 'help_post'));
$this->add('wysiwyg', 'help_post', ts('Post-form Help'), CRM_Core_DAO::getAttribute('CRM_Core_DAO_UFGroup', 'help_post'));
// weight
$this->add('text', 'weight', ts('Order'), CRM_Core_DAO::getAttribute('CRM_Core_DAO_UFJoin', 'weight'), TRUE);
$this->addRule('weight', ts('is a numeric field'), 'numeric');
// is this group active ?
$this->addElement('checkbox', 'is_active', ts('Is this CiviCRM Profile active?'));
$paneNames = array('Advanced Settings' => 'buildAdvanceSetting');
foreach ($paneNames as $name => $type) {
if ($this->_id) {
$dataURL = "&reset=1&action=update&id={$this->_id}&snippet=4&formType={$type}";
}
else {
$dataURL = "&reset=1&action=add&snippet=4&formType={$type}";
}
$allPanes[$name] = array(
'url' => CRM_Utils_System::url('civicrm/admin/uf/group/setting',
$dataURL
),
'open' => 'false',
'id' => $type,
);
CRM_UF_Form_AdvanceSetting::$type($this);
}
$this->addButtons(array(
array(
'type' => 'next',
'name' => ts('Save'),
'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
'isDefault' => TRUE,
),
array(
'type' => 'cancel',
'name' => ts('Cancel'),
),
));
// views are implemented as frozen form
if ($this->_action & CRM_Core_Action::VIEW) {
$this->freeze();
$this->addElement('button', 'done', ts('Done'), array('onclick' => "location.href='civicrm/admin/uf/group?reset=1&action=browse'"));
}
$this->addFormRule(array('CRM_UF_Form_Group', 'formRule'), $this);
}
/**
* Set default values for the form. Note that in edit/view mode
* the default values are retrieved from the database
*
*
* @return void
*/
public function setDefaultValues() {
$defaults = array();
$showHide = new CRM_Core_ShowHideBlocks();
if ($this->_action == CRM_Core_Action::ADD) {
$defaults['weight'] = CRM_Utils_Weight::getDefaultWeight('CRM_Core_DAO_UFJoin');
}
//id fetched for Dojo Pane
$pId = CRM_Utils_Request::retrieve('id', 'Positive', $this);
if (isset($pId)) {
$this->_id = $pId;
}
if ((isset($this->_id))) {
$defaults['weight'] = CRM_Core_BAO_UFGroup::getWeight($this->_id);
$params = array('id' => $this->_id);
CRM_Core_BAO_UFGroup::retrieve($params, $defaults);
$defaults['group'] = CRM_Utils_Array::value('limit_listings_group_id', $defaults);
$defaults['add_contact_to_group'] = CRM_Utils_Array::value('add_to_group_id', $defaults);
//get the uf join records for current uf group
$ufJoinRecords = CRM_Core_BAO_UFGroup::getUFJoinRecord($this->_id);
foreach ($ufJoinRecords as $key => $value) {
$checked[$value] = 1;
}
$defaults['uf_group_type'] = isset($checked) ? $checked : "";
//get the uf join records for current uf group other than default modules
$otherModules = array();
$otherModules = CRM_Core_BAO_UFGroup::getUFJoinRecord($this->_id, TRUE, TRUE);
if (!empty($otherModules)) {
$otherModuleString = NULL;
foreach ($otherModules as $key) {
$otherModuleString .= " [ x ] <label>" . $key . "</label>";
}
$this->assign('otherModuleString', $otherModuleString);
}
$showAdvanced = 0;
$advFields = array(
'group',
'post_URL',
'cancel_URL',
'add_captcha',
'is_map',
'is_uf_link',
'is_edit_link',
'is_update_dupe',
'is_cms_user',
'is_proximity_search',
);
foreach ($advFields as $key) {
if (!empty($defaults[$key])) {
$showAdvanced = 1;
$this->_allPanes['Advanced Settings']['open'] = 'true';
break;
}
}
}
else {
$defaults['is_active'] = 1;
$defaults['is_map'] = 0;
$defaults['is_update_dupe'] = 0;
$defaults['is_proximity_search'] = 0;
}
// Don't assign showHide elements to template in DELETE mode (fields to be shown and hidden don't exist)
if (!($this->_action & CRM_Core_Action::DELETE) && !($this->_action & CRM_Core_Action::DISABLE)) {
$showHide->addToTemplate();
}
$this->assign('allPanes', $this->_allPanes);
return $defaults;
}
/**
* Global form rule.
*
* @param array $fields
* The input form values.
* @param array $files
* The uploaded files if any.
* @param array $self
* Current form object.
*
* @return bool|array
* true if no errors, else array of errors
*/
public static function formRule($fields, $files, $self) {
$errors = array();
//validate profile title as well as name.
$title = $fields['title'];
$name = CRM_Utils_String::munge($title, '_', 56);
$name .= $self->_id ? '_' . $self->_id : '';
$query = 'select count(*) from civicrm_uf_group where ( name like %1 ) and id != %2';
$pCnt = CRM_Core_DAO::singleValueQuery($query, array(
1 => array($name, 'String'),
2 => array((int) $self->_id, 'Integer'),
));
if ($pCnt) {
$errors['title'] = ts('Profile \'%1\' already exists in Database.', array(1 => $title));
}
return empty($errors) ? TRUE : $errors;
}
/**
* Process the form.
*
* @return void
*/
public function postProcess() {
if ($this->_action & CRM_Core_Action::DELETE) {
$title = CRM_Core_BAO_UFGroup::getTitle($this->_id);
CRM_Core_BAO_UFGroup::del($this->_id);
CRM_Core_Session::setStatus(ts("Your CiviCRM Profile '%1' has been deleted.", array(1 => $title)), ts('Profile Deleted'), 'success');
}
elseif ($this->_action & CRM_Core_Action::DISABLE) {
$ufJoinParams = array('uf_group_id' => $this->_id);
CRM_Core_BAO_UFGroup::delUFJoin($ufJoinParams);
CRM_Core_BAO_UFGroup::setIsActive($this->_id, 0);
}
else {
// get the submitted form values.
$params = $ids = array();
$params = $this->controller->exportValues($this->_name);
if (!array_key_exists('is_active', $params)) {
$params['is_active'] = 0;
}
if ($this->_action & (CRM_Core_Action::UPDATE)) {
$ids['ufgroup'] = $this->_id;
// CRM-5284
// lets skip trying to mess around with profile weights and allow the user to do as needed.
}
elseif ($this->_action & CRM_Core_Action::ADD) {
$session = CRM_Core_Session::singleton();
$params['created_id'] = $session->get('userID');
$params['created_date'] = date('YmdHis');
}
// create uf group
$ufGroup = CRM_Core_BAO_UFGroup::add($params, $ids);
if (!empty($params['is_active'])) {
//make entry in uf join table
CRM_Core_BAO_UFGroup::createUFJoin($params, $ufGroup->id);
}
elseif ($this->_id) {
// this profile has been set to inactive, delete all corresponding UF Join's
$ufJoinParams = array('uf_group_id' => $this->_id);
CRM_Core_BAO_UFGroup::delUFJoin($ufJoinParams);
}
if ($this->_action & CRM_Core_Action::UPDATE) {
$url = CRM_Utils_System::url('civicrm/admin/uf/group', 'reset=1&action=browse');
CRM_Core_Session::setStatus(ts("Your CiviCRM Profile '%1' has been saved.", array(1 => $ufGroup->title)), ts('Profile Saved'), 'success');
}
else {
// Jump directly to adding a field if popups are disabled
$action = CRM_Core_Resources::singleton()->ajaxPopupsEnabled ? '' : '/add';
$url = CRM_Utils_System::url("civicrm/admin/uf/group/field$action", 'reset=1&new=1&gid=' . $ufGroup->id . '&action=' . ($action ? 'add' : 'browse'));
CRM_Core_Session::setStatus(ts('Your CiviCRM Profile \'%1\' has been added. You can add fields to this profile now.',
array(1 => $ufGroup->title)
), ts('Profile Added'), 'success');
}
$session = CRM_Core_Session::singleton();
$session->replaceUserContext($url);
}
// update cms integration with registration / my account
CRM_Utils_System::updateCategories();
}
}