Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
bc77d7c0 | 4 | | Copyright CiviCRM LLC. All rights reserved. | |
6a488035 | 5 | | | |
bc77d7c0 TO |
6 | | This work is published under the GNU AGPLv3 license with some | |
7 | | permitted exceptions and without any warranty. For full license | | |
8 | | and copyright information, see https://civicrm.org/licensing | | |
6a488035 | 9 | +--------------------------------------------------------------------+ |
d25dd0ee | 10 | */ |
6a488035 TO |
11 | |
12 | /** | |
13 | * | |
14 | * @package CRM | |
ca5cec67 | 15 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
6a488035 TO |
16 | */ |
17 | ||
18 | /** | |
c037736a | 19 | * This class generates form components for custom data. |
6a488035 TO |
20 | * |
21 | * It delegates the work to lower level subclasses and integrates the changes | |
22 | * back in. It also uses a lot of functionality with the CRM API's, so any change | |
23 | * made here could potentially affect the API etc. Be careful, be aware, use unit tests. | |
6a488035 TO |
24 | */ |
25 | class CRM_Contact_Form_CustomData extends CRM_Core_Form { | |
26 | ||
27 | /** | |
28 | * The table id, used when editing/creating custom data | |
29 | * | |
30 | * @var int | |
31 | */ | |
32 | protected $_tableId; | |
33 | ||
34 | /** | |
100fef9d | 35 | * Entity type of the table id |
6a488035 TO |
36 | * |
37 | * @var string | |
38 | */ | |
39 | protected $_entityType; | |
40 | ||
41 | /** | |
100fef9d | 42 | * Entity sub type of the table id |
6a488035 TO |
43 | * |
44 | * @var string | |
6a488035 TO |
45 | */ |
46 | protected $_entitySubType; | |
47 | ||
48 | /** | |
100fef9d | 49 | * The group tree data |
6a488035 TO |
50 | * |
51 | * @var array | |
52 | */ | |
53 | //protected $_groupTree; | |
54 | ||
6a488035 TO |
55 | /** |
56 | * Array group titles. | |
57 | * | |
58 | * @var array | |
59 | */ | |
60 | protected $_groupTitle; | |
61 | ||
62 | /** | |
63 | * Array group display status. | |
64 | * | |
65 | * @var array | |
66 | */ | |
67 | protected $_groupCollapseDisplay; | |
68 | ||
69 | /** | |
100fef9d | 70 | * Custom group id |
6a488035 | 71 | * |
69078420 | 72 | * @var int |
6a488035 TO |
73 | */ |
74 | public $_groupID; | |
75 | ||
e41f4660 | 76 | public $_multiRecordDisplay; |
1dde099b PJ |
77 | |
78 | public $_copyValueId; | |
353ffa53 | 79 | |
6a488035 | 80 | /** |
100fef9d | 81 | * Pre processing work done here. |
6a488035 | 82 | * |
c037736a | 83 | * Gets session variables for table name, id of entity in table, type of entity and stores them. |
8ef12e64 | 84 | */ |
00be9182 | 85 | public function preProcess() { |
9c1bc317 | 86 | $this->_cdType = $_GET['type'] ?? NULL; |
6a488035 | 87 | $this->assign('cdType', FALSE); |
e41f4660 PJ |
88 | $this->_multiRecordDisplay = CRM_Utils_Request::retrieve('multiRecordDisplay', 'String', $this); |
89 | if ($this->_cdType || $this->_multiRecordDisplay == 'single') { | |
90 | if ($this->_cdType) { | |
91 | $this->assign('cdType', TRUE); | |
92 | } | |
93 | // NOTE : group id is not stored in session from within CRM_Custom_Form_CustomData::preProcess func | |
94 | // this is due to some condition inside it which restricts it from saving in session | |
95 | // so doing this for multi record edit action | |
9710b8d1 | 96 | $entityId = CRM_Utils_Request::retrieve('entityID', 'Positive', $this); |
22e263ad | 97 | if (!empty($entityId)) { |
9710b8d1 RK |
98 | $subType = CRM_Contact_BAO_Contact::getContactSubType($entityId, ','); |
99 | } | |
100 | CRM_Custom_Form_CustomData::preProcess($this, NULL, $subType, NULL, NULL, $entityId); | |
e41f4660 PJ |
101 | if ($this->_multiRecordDisplay) { |
102 | $this->_groupID = CRM_Utils_Request::retrieve('groupID', 'Positive', $this); | |
103 | $this->_tableID = $this->_entityId; | |
bf076628 PJ |
104 | $this->_contactType = CRM_Contact_BAO_Contact::getContactType($this->_tableID); |
105 | $mode = CRM_Utils_Request::retrieve('mode', 'String', $this); | |
106 | $hasReachedMax = CRM_Core_BAO_CustomGroup::hasReachedMaxLimit($this->_groupID, $this->_tableID); | |
107 | if ($hasReachedMax && $mode == 'add') { | |
108 | CRM_Core_Error::statusBounce(ts('The maximum record limit is reached')); | |
109 | } | |
1dde099b | 110 | $this->_copyValueId = CRM_Utils_Request::retrieve('copyValueId', 'Positive', $this); |
9cb02ab3 | 111 | |
525faea3 PJ |
112 | $groupTitle = CRM_Core_BAO_CustomGroup::getTitle($this->_groupID); |
113 | $mode = CRM_Utils_Request::retrieve('mode', 'String', CRM_Core_DAO::$_nullObject, FALSE, NULL, 'GET'); | |
114 | $mode = ucfirst($mode); | |
be2fb01f | 115 | CRM_Utils_System::setTitle(ts('%1 %2 Record', [1 => $mode, 2 => $groupTitle])); |
525faea3 | 116 | |
5f5a6693 PJ |
117 | if (!empty($_POST['hidden_custom'])) { |
118 | $this->assign('postedInfo', TRUE); | |
119 | } | |
e41f4660 PJ |
120 | } |
121 | return; | |
6a488035 | 122 | } |
6a488035 TO |
123 | $this->_groupID = CRM_Utils_Request::retrieve('groupID', 'Positive', $this, TRUE); |
124 | $this->_tableID = CRM_Utils_Request::retrieve('tableId', 'Positive', $this, TRUE); | |
125 | ||
126 | $this->_contactType = CRM_Contact_BAO_Contact::getContactType($this->_tableID); | |
127 | $this->_contactSubType = CRM_Contact_BAO_Contact::getContactSubType($this->_tableID, ','); | |
128 | $this->assign('contact_type', $this->_contactType); | |
129 | $this->assign('contact_subtype', $this->_contactSubType); | |
130 | list($displayName, $contactImage) = CRM_Contact_BAO_Contact::getDisplayAndImage($this->_tableID); | |
131 | CRM_Utils_System::setTitle($displayName, $contactImage . ' ' . $displayName); | |
132 | ||
133 | // when custom data is included in this page | |
a7488080 | 134 | if (!empty($_POST['hidden_custom'])) { |
88d45a96 | 135 | for ($i = 1; $i <= $_POST['hidden_custom_group_count'][$this->_groupID]; $i++) { |
ecc6bd60 | 136 | CRM_Custom_Form_CustomData::preProcess($this, NULL, $this->_contactSubType, $i, $this->_contactType, $this->_tableID); |
6a488035 TO |
137 | CRM_Custom_Form_CustomData::buildQuickForm($this); |
138 | CRM_Custom_Form_CustomData::setDefaultValues($this); | |
139 | } | |
140 | } | |
141 | } | |
142 | ||
143 | /** | |
fe482240 | 144 | * Build the form object. |
6a488035 TO |
145 | */ |
146 | public function buildQuickForm() { | |
e41f4660 PJ |
147 | if ($this->_cdType || $this->_multiRecordDisplay == 'single') { |
148 | // buttons display for multi-valued fields to perform independednt actions | |
149 | if ($this->_multiRecordDisplay) { | |
150 | $isMultiple = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', | |
151 | $this->_groupID, | |
152 | 'is_multiple' | |
153 | ); | |
154 | if ($isMultiple) { | |
155 | $this->assign('multiRecordDisplay', $this->_multiRecordDisplay); | |
bbb98b08 | 156 | $saveButtonName = $this->_copyValueId ? ts('Save a Copy') : ts('Save'); |
be2fb01f | 157 | $this->addButtons([ |
69078420 SL |
158 | [ |
159 | 'type' => 'upload', | |
160 | 'name' => $saveButtonName, | |
161 | 'isDefault' => TRUE, | |
162 | ], | |
163 | [ | |
164 | 'type' => 'upload', | |
165 | 'name' => ts('Save and New'), | |
166 | 'subName' => 'new', | |
167 | ], | |
168 | [ | |
169 | 'type' => 'cancel', | |
170 | 'name' => ts('Cancel'), | |
171 | ], | |
172 | ]); | |
e41f4660 PJ |
173 | } |
174 | } | |
6a488035 TO |
175 | return CRM_Custom_Form_CustomData::buildQuickForm($this); |
176 | } | |
177 | ||
178 | //need to assign custom data type and subtype to the template | |
179 | $this->assign('entityID', $this->_tableID); | |
180 | $this->assign('groupID', $this->_groupID); | |
181 | ||
182 | // make this form an upload since we dont know if the custom data injected dynamically | |
183 | // is of type file etc | |
be2fb01f | 184 | $this->addButtons([ |
69078420 SL |
185 | [ |
186 | 'type' => 'upload', | |
187 | 'name' => ts('Save'), | |
188 | 'isDefault' => TRUE, | |
189 | ], | |
190 | [ | |
191 | 'type' => 'cancel', | |
192 | 'name' => ts('Cancel'), | |
193 | ], | |
194 | ]); | |
6a488035 TO |
195 | } |
196 | ||
197 | /** | |
fe482240 | 198 | * Set the default form values. |
6a488035 | 199 | * |
6a488035 | 200 | * |
a6c01b45 CW |
201 | * @return array |
202 | * the default array reference | |
6a488035 | 203 | */ |
00be9182 | 204 | public function setDefaultValues() { |
e41f4660 | 205 | if ($this->_cdType || $this->_multiRecordDisplay == 'single') { |
1dde099b PJ |
206 | if ($this->_copyValueId) { |
207 | // cached tree is fetched | |
517755e0 | 208 | $groupTree = CRM_Core_BAO_CustomGroup::getTree($this->_type, |
0b330e6d | 209 | NULL, |
1dde099b | 210 | $this->_entityId, |
e1d48b72 | 211 | $this->_groupID, |
be2fb01f | 212 | [], |
e1d48b72 | 213 | NULL, |
214 | TRUE, | |
215 | NULL, | |
216 | FALSE, | |
217 | TRUE, | |
218 | $this->_copyValueId | |
1dde099b | 219 | ); |
be2fb01f | 220 | $valueIdDefaults = []; |
1dde099b PJ |
221 | $groupTreeValueId = CRM_Core_BAO_CustomGroup::formatGroupTree($groupTree, $this->_copyValueId, $this); |
222 | CRM_Core_BAO_CustomGroup::setDefaults($groupTreeValueId, $valueIdDefaults, FALSE, FALSE, $this->get('action')); | |
223 | $tableId = $groupTreeValueId[$this->_groupID]['table_id']; | |
224 | foreach ($valueIdDefaults as $valueIdElementName => $value) { | |
225 | // build defaults for COPY action for new record saving | |
226 | $valueIdElementNamePieces = explode('_', $valueIdElementName); | |
227 | $valueIdElementNamePieces[2] = "-{$this->_groupCount}"; | |
228 | $elementName = implode('_', $valueIdElementNamePieces); | |
229 | $customDefaultValue[$elementName] = $value; | |
230 | } | |
231 | } | |
232 | else { | |
233 | $customDefaultValue = CRM_Custom_Form_CustomData::setDefaultValues($this); | |
234 | } | |
6a488035 TO |
235 | return $customDefaultValue; |
236 | } | |
237 | ||
517755e0 | 238 | $groupTree = CRM_Core_BAO_CustomGroup::getTree($this->_contactType, |
0b330e6d | 239 | NULL, |
6a488035 TO |
240 | $this->_tableID, |
241 | $this->_groupID, | |
242 | $this->_contactSubType | |
243 | ); | |
244 | ||
a7488080 | 245 | if (empty($_POST['hidden_custom_group_count'])) { |
6a488035 | 246 | // custom data building in edit mode (required to handle multi-value) |
0b330e6d | 247 | $groupTree = CRM_Core_BAO_CustomGroup::getTree($this->_contactType, NULL, $this->_tableID, |
6a488035 TO |
248 | $this->_groupID, $this->_contactSubType |
249 | ); | |
e7cf1b90 | 250 | $customValueCount = CRM_Core_BAO_CustomGroup::buildCustomDataView($this, $groupTree, TRUE, $this->_groupID, NULL, NULL, $this->_tableID); |
6a488035 TO |
251 | } |
252 | else { | |
253 | $customValueCount = $_POST['hidden_custom_group_count'][$this->_groupID]; | |
254 | } | |
255 | ||
256 | $this->assign('customValueCount', $customValueCount); | |
257 | ||
be2fb01f | 258 | $defaults = []; |
6a488035 TO |
259 | return $defaults; |
260 | } | |
261 | ||
262 | /** | |
263 | * Process the user submitted custom data values. | |
6a488035 TO |
264 | */ |
265 | public function postProcess() { | |
266 | // Get the form values and groupTree | |
e7cf1b90 WA |
267 | //CRM-18183 |
268 | $params = $this->controller->exportValues($this->_name); | |
bf076628 | 269 | |
6a488035 | 270 | CRM_Core_BAO_CustomValueTable::postProcess($params, |
6a488035 TO |
271 | 'civicrm_contact', |
272 | $this->_tableID, | |
273 | $this->_entityType | |
274 | ); | |
bf076628 PJ |
275 | $table = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', $this->_groupID, 'table_name'); |
276 | $cgcount = CRM_Core_BAO_CustomGroup::customGroupDataExistsForEntity($this->_tableID, $table, TRUE); | |
277 | $cgcount += 1; | |
278 | $buttonName = $this->controller->getButtonName(); | |
279 | if ($buttonName == $this->getButtonName('upload', 'new')) { | |
353ffa53 TO |
280 | CRM_Core_Session::singleton() |
281 | ->pushUserContext(CRM_Utils_System::url('civicrm/contact/view/cd/edit', "reset=1&type={$this->_contactType}&groupID={$this->_groupID}&entityID={$this->_tableID}&cgcount={$cgcount}&multiRecordDisplay=single&mode=add")); | |
bf076628 | 282 | } |
b4efde7a CW |
283 | |
284 | // Add entry in the log table | |
285 | CRM_Core_BAO_Log::register($this->_tableID, | |
286 | 'civicrm_contact', | |
287 | $this->_tableID | |
288 | ); | |
289 | ||
290 | if (CRM_Core_Resources::isAjaxMode()) { | |
291 | $this->ajaxResponse += CRM_Contact_Form_Inline::renderFooter($this->_tableID); | |
292 | } | |
293 | ||
2b68a50c | 294 | CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush(); |
6a488035 | 295 | } |
96025800 | 296 | |
ef10e0b5 | 297 | } |