| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 4.4 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2013 | |
| 7 | +--------------------------------------------------------------------+ |
| 8 | | This file is a part of CiviCRM. | |
| 9 | | | |
| 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. | |
| 13 | | | |
| 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. | |
| 18 | | | |
| 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 | +--------------------------------------------------------------------+ |
| 26 | */ |
| 27 | |
| 28 | /** |
| 29 | * |
| 30 | * @package CRM |
| 31 | * @copyright CiviCRM LLC (c) 2004-2013 |
| 32 | * $Id$ |
| 33 | * |
| 34 | */ |
| 35 | |
| 36 | /** |
| 37 | * This class generates form components for custom data |
| 38 | * |
| 39 | * It delegates the work to lower level subclasses and integrates the changes |
| 40 | * back in. It also uses a lot of functionality with the CRM API's, so any change |
| 41 | * made here could potentially affect the API etc. Be careful, be aware, use unit tests. |
| 42 | * |
| 43 | */ |
| 44 | class CRM_Contact_Form_CustomData extends CRM_Core_Form { |
| 45 | |
| 46 | /** |
| 47 | * The table id, used when editing/creating custom data |
| 48 | * |
| 49 | * @var int |
| 50 | */ |
| 51 | protected $_tableId; |
| 52 | |
| 53 | /** |
| 54 | * entity type of the table id |
| 55 | * |
| 56 | * @var string |
| 57 | */ |
| 58 | protected $_entityType; |
| 59 | |
| 60 | /** |
| 61 | * entity sub type of the table id |
| 62 | * |
| 63 | * @var string |
| 64 | * @access protected |
| 65 | */ |
| 66 | protected $_entitySubType; |
| 67 | |
| 68 | /** |
| 69 | * the group tree data |
| 70 | * |
| 71 | * @var array |
| 72 | */ |
| 73 | //protected $_groupTree; |
| 74 | |
| 75 | /** |
| 76 | * Which blocks should we show and hide. |
| 77 | * |
| 78 | * @var CRM_Core_ShowHideBlocks |
| 79 | */ |
| 80 | protected $_showHide; |
| 81 | |
| 82 | /** |
| 83 | * Array group titles. |
| 84 | * |
| 85 | * @var array |
| 86 | */ |
| 87 | protected $_groupTitle; |
| 88 | |
| 89 | /** |
| 90 | * Array group display status. |
| 91 | * |
| 92 | * @var array |
| 93 | */ |
| 94 | protected $_groupCollapseDisplay; |
| 95 | |
| 96 | /** |
| 97 | * custom group id |
| 98 | * |
| 99 | * @int |
| 100 | * @access public |
| 101 | */ |
| 102 | public $_groupID; |
| 103 | |
| 104 | public $_multiRecordDisplay; |
| 105 | |
| 106 | public $_copyValueId; |
| 107 | /** |
| 108 | * pre processing work done here. |
| 109 | * |
| 110 | * gets session variables for table name, id of entity in table, type of entity and stores them. |
| 111 | * |
| 112 | * @param |
| 113 | * |
| 114 | * @return void |
| 115 | * |
| 116 | * @access public |
| 117 | * |
| 118 | */ |
| 119 | function preProcess() { |
| 120 | $this->_cdType = CRM_Utils_Array::value('type', $_GET); |
| 121 | $this->assign('cdType', FALSE); |
| 122 | $this->_multiRecordDisplay = CRM_Utils_Request::retrieve('multiRecordDisplay', 'String', $this); |
| 123 | if ($this->_cdType || $this->_multiRecordDisplay == 'single') { |
| 124 | if ($this->_cdType) { |
| 125 | $this->assign('cdType', TRUE); |
| 126 | } |
| 127 | // NOTE : group id is not stored in session from within CRM_Custom_Form_CustomData::preProcess func |
| 128 | // this is due to some condition inside it which restricts it from saving in session |
| 129 | // so doing this for multi record edit action |
| 130 | CRM_Custom_Form_CustomData::preProcess($this); |
| 131 | if ($this->_multiRecordDisplay) { |
| 132 | $this->_groupID = CRM_Utils_Request::retrieve('groupID', 'Positive', $this); |
| 133 | $this->_tableID = $this->_entityId; |
| 134 | $this->_copyValueId = CRM_Utils_Request::retrieve('copyValueId', 'Positive', $this); |
| 135 | } |
| 136 | return; |
| 137 | } |
| 138 | $this->_groupID = CRM_Utils_Request::retrieve('groupID', 'Positive', $this, TRUE); |
| 139 | $this->_tableID = CRM_Utils_Request::retrieve('tableId', 'Positive', $this, TRUE); |
| 140 | |
| 141 | $this->_contactType = CRM_Contact_BAO_Contact::getContactType($this->_tableID); |
| 142 | $this->_contactSubType = CRM_Contact_BAO_Contact::getContactSubType($this->_tableID, ','); |
| 143 | $this->assign('contact_type', $this->_contactType); |
| 144 | $this->assign('contact_subtype', $this->_contactSubType); |
| 145 | list($displayName, $contactImage) = CRM_Contact_BAO_Contact::getDisplayAndImage($this->_tableID); |
| 146 | CRM_Utils_System::setTitle($displayName, $contactImage . ' ' . $displayName); |
| 147 | |
| 148 | // when custom data is included in this page |
| 149 | if (!empty($_POST['hidden_custom'])) { |
| 150 | for ($i = 0; $i <= $_POST['hidden_custom_group_count'][$this->_groupID]; $i++) { |
| 151 | CRM_Custom_Form_CustomData::preProcess($this, NULL, NULL, $i); |
| 152 | CRM_Custom_Form_CustomData::buildQuickForm($this); |
| 153 | CRM_Custom_Form_CustomData::setDefaultValues($this); |
| 154 | } |
| 155 | } |
| 156 | } |
| 157 | |
| 158 | /** |
| 159 | * Function to actually build the form |
| 160 | * |
| 161 | * @return void |
| 162 | * @access public |
| 163 | */ |
| 164 | public function buildQuickForm() { |
| 165 | if ($this->_cdType || $this->_multiRecordDisplay == 'single') { |
| 166 | // buttons display for multi-valued fields to perform independednt actions |
| 167 | if ($this->_multiRecordDisplay) { |
| 168 | $isMultiple = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', |
| 169 | $this->_groupID, |
| 170 | 'is_multiple' |
| 171 | ); |
| 172 | if ($isMultiple) { |
| 173 | $this->assign('multiRecordDisplay', $this->_multiRecordDisplay); |
| 174 | $saveButtonName = $this->_copyValueId ? 'Save a Copy': 'Save'; |
| 175 | $this->addButtons(array( |
| 176 | array( |
| 177 | 'type' => 'upload', |
| 178 | 'name' => ts('%1', array(1 => $saveButtonName)), |
| 179 | 'isDefault' => TRUE, |
| 180 | ), |
| 181 | array( |
| 182 | 'type' => 'cancel', |
| 183 | 'name' => ts('Cancel'), |
| 184 | ), |
| 185 | ) |
| 186 | ); |
| 187 | } |
| 188 | } |
| 189 | return CRM_Custom_Form_CustomData::buildQuickForm($this); |
| 190 | } |
| 191 | |
| 192 | //need to assign custom data type and subtype to the template |
| 193 | $this->assign('entityID', $this->_tableID); |
| 194 | $this->assign('groupID', $this->_groupID); |
| 195 | |
| 196 | // make this form an upload since we dont know if the custom data injected dynamically |
| 197 | // is of type file etc |
| 198 | $this->addButtons(array( |
| 199 | array( |
| 200 | 'type' => 'upload', |
| 201 | 'name' => ts('Save'), |
| 202 | 'isDefault' => TRUE, |
| 203 | ), |
| 204 | array( |
| 205 | 'type' => 'cancel', |
| 206 | 'name' => ts('Cancel'), |
| 207 | ), |
| 208 | ) |
| 209 | ); |
| 210 | } |
| 211 | |
| 212 | /** |
| 213 | * Set the default form values |
| 214 | * |
| 215 | * @access protected |
| 216 | * |
| 217 | * @return array the default array reference |
| 218 | */ |
| 219 | function setDefaultValues() { |
| 220 | if ($this->_cdType || $this->_multiRecordDisplay == 'single') { |
| 221 | if ($this->_copyValueId) { |
| 222 | // cached tree is fetched |
| 223 | $groupTree = &CRM_Core_BAO_CustomGroup::getTree($this->_type, |
| 224 | $this, |
| 225 | $this->_entityId, |
| 226 | $this->_groupID |
| 227 | ); |
| 228 | $valueIdDefaults = array(); |
| 229 | $groupTreeValueId = CRM_Core_BAO_CustomGroup::formatGroupTree($groupTree, $this->_copyValueId, $this); |
| 230 | CRM_Core_BAO_CustomGroup::setDefaults($groupTreeValueId, $valueIdDefaults, FALSE, FALSE, $this->get('action')); |
| 231 | $tableId = $groupTreeValueId[$this->_groupID]['table_id']; |
| 232 | foreach ($valueIdDefaults as $valueIdElementName => $value) { |
| 233 | // build defaults for COPY action for new record saving |
| 234 | $valueIdElementNamePieces = explode('_', $valueIdElementName); |
| 235 | $valueIdElementNamePieces[2] = "-{$this->_groupCount}"; |
| 236 | $elementName = implode('_', $valueIdElementNamePieces); |
| 237 | $customDefaultValue[$elementName] = $value; |
| 238 | } |
| 239 | } |
| 240 | else { |
| 241 | $customDefaultValue = CRM_Custom_Form_CustomData::setDefaultValues($this); |
| 242 | } |
| 243 | return $customDefaultValue; |
| 244 | } |
| 245 | |
| 246 | $groupTree = &CRM_Core_BAO_CustomGroup::getTree($this->_contactType, |
| 247 | $this, |
| 248 | $this->_tableID, |
| 249 | $this->_groupID, |
| 250 | $this->_contactSubType |
| 251 | ); |
| 252 | |
| 253 | if (empty($_POST['hidden_custom_group_count'])) { |
| 254 | // custom data building in edit mode (required to handle multi-value) |
| 255 | $groupTree = &CRM_Core_BAO_CustomGroup::getTree($this->_contactType, $this, $this->_tableID, |
| 256 | $this->_groupID, $this->_contactSubType |
| 257 | ); |
| 258 | $customValueCount = CRM_Core_BAO_CustomGroup::buildCustomDataView($this, $groupTree, TRUE, $this->_groupID); |
| 259 | } |
| 260 | else { |
| 261 | $customValueCount = $_POST['hidden_custom_group_count'][$this->_groupID]; |
| 262 | } |
| 263 | |
| 264 | $this->assign('customValueCount', $customValueCount); |
| 265 | |
| 266 | $defaults = array(); |
| 267 | return $defaults; |
| 268 | } |
| 269 | |
| 270 | /** |
| 271 | * Process the user submitted custom data values. |
| 272 | * |
| 273 | * @access public |
| 274 | * |
| 275 | * @return void |
| 276 | */ |
| 277 | public function postProcess() { |
| 278 | // Get the form values and groupTree |
| 279 | $params = $this->controller->exportValues($this->_name); |
| 280 | CRM_Core_BAO_CustomValueTable::postProcess($params, |
| 281 | $this->_groupTree[$this->_groupID]['fields'], |
| 282 | 'civicrm_contact', |
| 283 | $this->_tableID, |
| 284 | $this->_entityType |
| 285 | ); |
| 286 | |
| 287 | // reset the group contact cache for this group |
| 288 | CRM_Contact_BAO_GroupContactCache::remove(); |
| 289 | } |
| 290 | } |