| 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 | * Create a page for displaying CiviCRM Profile Fields. |
| 38 | * |
| 39 | * Heart of this class is the run method which checks |
| 40 | * for action type and then displays the appropriate |
| 41 | * page. |
| 42 | * |
| 43 | */ |
| 44 | class CRM_UF_Page_Field extends CRM_Core_Page { |
| 45 | |
| 46 | /** |
| 47 | * The group id of the field |
| 48 | * |
| 49 | * @var int |
| 50 | * @access protected |
| 51 | */ |
| 52 | protected $_gid; |
| 53 | |
| 54 | /** |
| 55 | * The action links that we need to display for the browse screen |
| 56 | * |
| 57 | * @var array |
| 58 | * @access private |
| 59 | */ |
| 60 | private static $_actionLinks; |
| 61 | |
| 62 | /** |
| 63 | * Get the action links for this page. |
| 64 | * |
| 65 | * @return array $_actionLinks |
| 66 | * |
| 67 | */ function &actionLinks() { |
| 68 | if (!isset(self::$_actionLinks)) { |
| 69 | self::$_actionLinks = array( |
| 70 | CRM_Core_Action::UPDATE => array( |
| 71 | 'name' => ts('Edit'), |
| 72 | 'url' => 'civicrm/admin/uf/group/field/update', |
| 73 | 'qs' => 'reset=1&action=update&id=%%id%%&gid=%%gid%%', |
| 74 | 'title' => ts('Edit CiviCRM Profile Field'), |
| 75 | ), |
| 76 | CRM_Core_Action::PREVIEW => array( |
| 77 | 'name' => ts('Preview'), |
| 78 | 'url' => 'civicrm/admin/uf/group/field', |
| 79 | 'qs' => 'action=preview&id=%%id%%&field=1', |
| 80 | 'title' => ts('Preview CiviCRM Profile Field'), |
| 81 | ), |
| 82 | CRM_Core_Action::DISABLE => array( |
| 83 | 'name' => ts('Disable'), |
| 84 | 'ref' => 'crm-enable-disable', |
| 85 | 'title' => ts('Disable CiviCRM Profile Field'), |
| 86 | ), |
| 87 | CRM_Core_Action::ENABLE => array( |
| 88 | 'name' => ts('Enable'), |
| 89 | 'ref' => 'crm-enable-disable', |
| 90 | 'title' => ts('Enable CiviCRM Profile Field'), |
| 91 | ), |
| 92 | CRM_Core_Action::DELETE => array( |
| 93 | 'name' => ts('Delete'), |
| 94 | 'url' => 'civicrm/admin/uf/group/field', |
| 95 | 'qs' => 'action=delete&id=%%id%%', |
| 96 | 'title' => ts('Enable CiviCRM Profile Field'), |
| 97 | ), |
| 98 | ); |
| 99 | } |
| 100 | return self::$_actionLinks; |
| 101 | } |
| 102 | |
| 103 | /** |
| 104 | * Browse all CiviCRM Profile group fields. |
| 105 | * |
| 106 | * @return void |
| 107 | * @access public |
| 108 | * @static |
| 109 | */ |
| 110 | function browse() { |
| 111 | if (CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'ajax_popups_enabled', NULL, TRUE)) { |
| 112 | CRM_Core_Resources::singleton()->addScriptFile('civicrm', 'js/crm.livePage.js'); |
| 113 | } |
| 114 | $ufField = array(); |
| 115 | $ufFieldBAO = new CRM_Core_BAO_UFField(); |
| 116 | |
| 117 | // fkey is gid |
| 118 | $ufFieldBAO->uf_group_id = $this->_gid; |
| 119 | $ufFieldBAO->orderBy('weight', 'field_name'); |
| 120 | $ufFieldBAO->find(); |
| 121 | |
| 122 | $otherModules = CRM_Core_BAO_UFGroup::getUFJoinRecord($this->_gid); |
| 123 | $this->assign('otherModules', $otherModules); |
| 124 | |
| 125 | $isGroupReserved = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $this->_gid, 'is_reserved'); |
| 126 | $this->assign('isGroupReserved', $isGroupReserved); |
| 127 | |
| 128 | $profileType = CRM_Core_BAO_UFField::getProfileType($this->_gid); |
| 129 | if ($profileType == 'Contribution' || $profileType == 'Membership' || $profileType == 'Activity' || $profileType == 'Participant') { |
| 130 | $this->assign('skipCreate', TRUE); |
| 131 | } |
| 132 | |
| 133 | $locationType = array(); |
| 134 | $locationType = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id'); |
| 135 | |
| 136 | $fields = CRM_Contact_BAO_Contact::exportableFields('All', FALSE, TRUE); |
| 137 | $fields = array_merge(CRM_Contribute_BAO_Contribution::getContributionFields(), $fields); |
| 138 | |
| 139 | $select = array(); |
| 140 | foreach ($fields as $name => $field) { |
| 141 | if ($name) { |
| 142 | $select[$name] = $field['title']; |
| 143 | } |
| 144 | } |
| 145 | $select['group'] = ts('Group(s)'); |
| 146 | $select['tag'] = ts('Tag(s)'); |
| 147 | |
| 148 | $visibility = CRM_Core_SelectValues::ufVisibility(); |
| 149 | while ($ufFieldBAO->fetch()) { |
| 150 | $ufField[$ufFieldBAO->id] = array(); |
| 151 | $phoneType = $locType = ''; |
| 152 | CRM_Core_DAO::storeValues($ufFieldBAO, $ufField[$ufFieldBAO->id]); |
| 153 | $ufField[$ufFieldBAO->id]['visibility_display'] = $visibility[$ufFieldBAO->visibility]; |
| 154 | |
| 155 | $ufField[$ufFieldBAO->id]['label'] = $ufFieldBAO->label; |
| 156 | |
| 157 | $action = array_sum(array_keys($this->actionLinks())); |
| 158 | if ($ufFieldBAO->is_active) { |
| 159 | $action -= CRM_Core_Action::ENABLE; |
| 160 | } |
| 161 | else { |
| 162 | $action -= CRM_Core_Action::DISABLE; |
| 163 | } |
| 164 | |
| 165 | if ($ufFieldBAO->is_reserved) { |
| 166 | $action -= CRM_Core_Action::UPDATE; |
| 167 | $action -= CRM_Core_Action::DISABLE; |
| 168 | $action -= CRM_Core_Action::DELETE; |
| 169 | } |
| 170 | $ufField[$ufFieldBAO->id]['order'] = $ufField[$ufFieldBAO->id]['weight']; |
| 171 | $ufField[$ufFieldBAO->id]['action'] = CRM_Core_Action::formLink(self::actionLinks(), |
| 172 | $action, |
| 173 | array( |
| 174 | 'id' => $ufFieldBAO->id, |
| 175 | 'gid' => $this->_gid, |
| 176 | ), |
| 177 | ts('more'), |
| 178 | FALSE, |
| 179 | 'ufField.row.actions', |
| 180 | 'UFField', |
| 181 | $ufFieldBAO->id |
| 182 | ); |
| 183 | } |
| 184 | |
| 185 | $returnURL = CRM_Utils_System::url('civicrm/admin/uf/group/field', |
| 186 | "reset=1&action=browse&gid={$this->_gid}" |
| 187 | ); |
| 188 | $filter = "uf_group_id = {$this->_gid}"; |
| 189 | CRM_Utils_Weight::addOrder($ufField, 'CRM_Core_DAO_UFField', |
| 190 | 'id', $returnURL, $filter |
| 191 | ); |
| 192 | |
| 193 | $this->assign('ufField', $ufField); |
| 194 | |
| 195 | // retrieve showBestResult from session |
| 196 | $session = CRM_Core_Session::singleton(); |
| 197 | $showBestResult = $session->get('showBestResult'); |
| 198 | $this->assign('showBestResult', $showBestResult); |
| 199 | $session->set('showBestResult', 0); |
| 200 | } |
| 201 | |
| 202 | /** |
| 203 | * edit CiviCRM Profile data. |
| 204 | * |
| 205 | * editing would involved modifying existing fields + adding data to new fields. |
| 206 | * |
| 207 | * @param string $action the action to be invoked |
| 208 | * |
| 209 | * @return void |
| 210 | * @access public |
| 211 | */ |
| 212 | function edit($action) { |
| 213 | // create a simple controller for editing CiviCRM Profile data |
| 214 | $controller = new CRM_Core_Controller_Simple('CRM_UF_Form_Field', ts('CiviCRM Profile Field'), $action); |
| 215 | |
| 216 | // set the userContext stack |
| 217 | $session = CRM_Core_Session::singleton(); |
| 218 | $session->pushUserContext(CRM_Utils_System::url('civicrm/admin/uf/group/field', |
| 219 | 'reset=1&action=browse&gid=' . $this->_gid |
| 220 | )); |
| 221 | $controller->set('gid', $this->_gid); |
| 222 | $controller->setEmbedded(TRUE); |
| 223 | $controller->process(); |
| 224 | $controller->run(); |
| 225 | } |
| 226 | |
| 227 | /** |
| 228 | * Run the page. |
| 229 | * |
| 230 | * This method is called after the page is created. It checks for the |
| 231 | * type of action and executes that action. |
| 232 | * |
| 233 | * @return void |
| 234 | * @access public |
| 235 | * |
| 236 | */ |
| 237 | function run() { |
| 238 | // get the group id |
| 239 | $this->_gid = CRM_Utils_Request::retrieve('gid', 'Positive', |
| 240 | $this, FALSE, 0 |
| 241 | ); |
| 242 | |
| 243 | if ($this->_gid) { |
| 244 | $groupTitle = CRM_Core_BAO_UFGroup::getTitle($this->_gid); |
| 245 | $this->assign('gid', $this->_gid); |
| 246 | $this->assign('groupTitle', $groupTitle); |
| 247 | CRM_Utils_System::setTitle(ts('%1 - CiviCRM Profile Fields', array(1 => $groupTitle))); |
| 248 | } |
| 249 | |
| 250 | // get the requested action |
| 251 | $action = CRM_Utils_Request::retrieve('action', 'String', |
| 252 | // default to 'browse' |
| 253 | $this, FALSE, 'browse' |
| 254 | ); |
| 255 | |
| 256 | // assign vars to templates |
| 257 | $this->assign('action', $action); |
| 258 | |
| 259 | $id = CRM_Utils_Request::retrieve('id', 'Positive', |
| 260 | $this, FALSE, 0 |
| 261 | ); |
| 262 | |
| 263 | // what action to take ? |
| 264 | if ($action & (CRM_Core_Action::UPDATE | CRM_Core_Action::ADD | CRM_Core_Action::VIEW | CRM_Core_Action::DELETE)) { |
| 265 | // no browse for edit/update/view/delete |
| 266 | $this->edit($action); |
| 267 | } |
| 268 | elseif ($action & CRM_Core_Action::PREVIEW) { |
| 269 | $this->preview($id, $this->_gid); |
| 270 | } |
| 271 | else { |
| 272 | $this->browse(); |
| 273 | } |
| 274 | |
| 275 | // Call the parents run method |
| 276 | return parent::run(); |
| 277 | } |
| 278 | |
| 279 | /** |
| 280 | * Preview custom field |
| 281 | * |
| 282 | * @param int $id custom field id |
| 283 | * |
| 284 | * @return void |
| 285 | * @access public |
| 286 | */ |
| 287 | function preview($fieldId, $groupId) { |
| 288 | $controller = new CRM_Core_Controller_Simple('CRM_UF_Form_Preview', ts('Preview Custom Data'), CRM_Core_Action::PREVIEW); |
| 289 | $session = CRM_Core_Session::singleton(); |
| 290 | $session->pushUserContext(CRM_Utils_System::url('civicrm/admin/uf/group/field', |
| 291 | 'reset=1&action=browse&gid=' . $this->_gid |
| 292 | )); |
| 293 | $controller->set('fieldId', $fieldId); |
| 294 | $controller->set('id', $groupId); |
| 295 | $controller->setEmbedded(TRUE); |
| 296 | $controller->process(); |
| 297 | $controller->run(); |
| 298 | } |
| 299 | } |
| 300 | |