3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
37 * This class provides the functionality to group
38 * contacts. This class provides functionality for the actual
39 * addition of contacts to groups.
41 class CRM_Contact_Form_Task_AddToGroup
extends CRM_Contact_Form_Task
{
44 * The context that we are working on
51 * The groupId retrieved from the GET vars
58 * The title of the group
65 * Build all the data structures needed to build the form
70 function preProcess() {
72 * initialize the task and row fields
76 $this->_context
= $this->get('context');
77 $this->_id
= $this->get('amtgID');
81 * Build the form object
87 function buildQuickForm() {
89 //create radio buttons to select existing group or add a new group
90 $options = array(ts('Add Contact To Existing Group'), ts('Create New Group'));
93 $this->addRadio('group_option', ts('Group Options'), $options, array('onclick' => "return showElements();"));
95 $this->add('text', 'title', ts('Group Name:') . ' ',
96 CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Group', 'title')
98 $this->addRule('title', ts('Name already exists in Database.'),
99 'objectExists', array('CRM_Contact_DAO_Group', $this->_id
, 'title')
102 $this->add('textarea', 'description', ts('Description:') . ' ',
103 CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Group', 'description')
106 $groupTypes = CRM_Core_OptionGroup
::values('group_type', TRUE);
107 if (!CRM_Core_Permission
::access('CiviMail')) {
108 $isWorkFlowEnabled = CRM_Mailing_Info
::workflowEnabled();
109 if ($isWorkFlowEnabled &&
110 !CRM_Core_Permission
::check('create mailings') &&
111 !CRM_Core_Permission
::check('schedule mailings') &&
112 !CRM_Core_Permission
::check('approve mailings')
114 unset($groupTypes['Mailing List']);
118 if (!empty($groupTypes)) {
119 $this->addCheckBox('group_type',
122 NULL, NULL, NULL, NULL, ' '
127 // add select for groups
128 $group = array('' => ts('- select group -')) + CRM_Core_PseudoConstant
::nestedGroup();
130 $groupElement = $this->add('select', 'group_id', ts('Select Group'), $group, FALSE, array('class' => 'crm-select2 huge'));
132 $this->_title
= $group[$this->_id
];
134 if ($this->_context
=== 'amtg') {
135 $groupElement->freeze();
137 // also set the group title
138 $groupValues = array('id' => $this->_id
, 'title' => $this->_title
);
139 $this->assign_by_ref('group', $groupValues);
142 // Set dynamic page title for 'Add Members Group (confirm)'
144 CRM_Utils_System
::setTitle(ts('Add Contacts: %1', array(1 => $this->_title
)));
147 CRM_Utils_System
::setTitle(ts('Add Contacts to A Group'));
150 $this->addDefaultButtons(ts('Add to Group'));
154 * Set the default form values
158 * @return array the default array reference
160 function setDefaultValues() {
163 if ($this->_context
=== 'amtg') {
164 $defaults['group_id'] = $this->_id
;
167 $defaults['group_option'] = 0;
172 * Add local and global form rules
178 function addRules() {
179 $this->addFormRule(array('CRM_Contact_Form_task_AddToGroup', 'formRule'));
183 * Global validation rules for the form
185 * @param array $params
187 * @return array list of errors to be posted back to the form
191 static function formRule($params) {
194 if (!empty($params['group_option']) && empty($params['title'])) {
195 $errors['title'] = "Group Name is a required field";
197 elseif (empty($params['group_option']) && empty($params['group_id'])) {
198 $errors['group_id'] = "Select Group is a required field.";
201 return empty($errors) ?
TRUE : $errors;
205 * Process the form after the input has been submitted and validated
211 public function postProcess() {
212 $params = $this->controller
->exportValues();
213 $groupOption = CRM_Utils_Array
::value('group_option', $params, NULL);
215 $groupParams = array();
216 $groupParams['title'] = $params['title'];
217 $groupParams['description'] = $params['description'];
218 $groupParams['visibility'] = "User and User Admin Only";
219 if (array_key_exists('group_type', $params) && is_array($params['group_type'])) {
220 $groupParams['group_type'] = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
221 array_keys($params['group_type'])
222 ) . CRM_Core_DAO
::VALUE_SEPARATOR
;
225 $groupParams['group_type'] = '';
227 $groupParams['is_active'] = 1;
229 $createdGroup = CRM_Contact_BAO_Group
::create($groupParams);
230 $groupID = $createdGroup->id
;
231 $groupName = $groupParams['title'];
234 $groupID = $params['group_id'];
235 $group = CRM_Core_PseudoConstant
::group();
236 $groupName = $group[$groupID];
239 list($total, $added, $notAdded) = CRM_Contact_BAO_GroupContact
::addContactsToGroup($this->_contactIds
, $groupID);
241 $status = array(ts('%count contact added to group', array('count' => $added, 'plural' => '%count contacts added to group')));
243 $status[] = ts('%count contact was already in group', array('count' => $notAdded, 'plural' => '%count contacts were already in group'));
245 $status = '<ul><li>' . implode('</li><li>', $status) . '</li></ul>';
246 CRM_Core_Session
::setStatus($status, ts('Added Contact to %1', array(1 => $groupName, 'count' => $added, 'plural' => 'Added Contacts to %1')), 'success', array('expires' => 0));
248 if ($this->_context
=== 'amtg') {
249 CRM_Core_Session
::singleton()->pushUserContext(CRM_Utils_System
::url('civicrm/group/search', "reset=1&force=1&context=smog&gid=$groupID"));