CRM/UF/Page/Field.php

   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     CRM_Core_Resources::singleton()->addScriptFile('civicrm', 'js/crm.livePage.js');
 112     $ufField = array();
 113     $ufFieldBAO = new CRM_Core_BAO_UFField();
 114
 115     // fkey is gid
 116     $ufFieldBAO->uf_group_id = $this->_gid;
 117     $ufFieldBAO->orderBy('weight', 'field_name');
 118     $ufFieldBAO->find();
 119
 120     $otherModules = CRM_Core_BAO_UFGroup::getUFJoinRecord($this->_gid);
 121     $this->assign('otherModules', $otherModules);
 122
 123     $isGroupReserved = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $this->_gid, 'is_reserved');
 124     $this->assign('isGroupReserved', $isGroupReserved);
 125
 126     $profileType = CRM_Core_BAO_UFField::getProfileType($this->_gid);
 127     if ($profileType == 'Contribution' || $profileType == 'Membership' || $profileType == 'Activity' || $profileType == 'Participant') {
 128       $this->assign('skipCreate', TRUE);
 129     }
 130
 131     $locationType = array();
 132     $locationType = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
 133
 134     $fields = CRM_Contact_BAO_Contact::exportableFields('All', FALSE, TRUE);
 135     $fields = array_merge(CRM_Contribute_BAO_Contribution::getContributionFields(), $fields);
 136
 137     $select = array();
 138     foreach ($fields as $name => $field) {
 139       if ($name) {
 140         $select[$name] = $field['title'];
 141       }
 142     }
 143     $select['group'] = ts('Group(s)');
 144     $select['tag'] = ts('Tag(s)');
 145
 146     $visibility = CRM_Core_SelectValues::ufVisibility();
 147     while ($ufFieldBAO->fetch()) {
 148       $ufField[$ufFieldBAO->id] = array();
 149       $phoneType = $locType = '';
 150       CRM_Core_DAO::storeValues($ufFieldBAO, $ufField[$ufFieldBAO->id]);
 151       $ufField[$ufFieldBAO->id]['visibility_display'] = $visibility[$ufFieldBAO->visibility];
 152
 153       $ufField[$ufFieldBAO->id]['label'] = $ufFieldBAO->label;
 154
 155       $action = array_sum(array_keys($this->actionLinks()));
 156       if ($ufFieldBAO->is_active) {
 157         $action -= CRM_Core_Action::ENABLE;
 158       }
 159       else {
 160         $action -= CRM_Core_Action::DISABLE;
 161       }
 162
 163       if ($ufFieldBAO->is_reserved) {
 164         $action -= CRM_Core_Action::UPDATE;
 165         $action -= CRM_Core_Action::DISABLE;
 166         $action -= CRM_Core_Action::DELETE;
 167       }
 168       $ufField[$ufFieldBAO->id]['order'] = $ufField[$ufFieldBAO->id]['weight'];
 169       $ufField[$ufFieldBAO->id]['action'] = CRM_Core_Action::formLink(self::actionLinks(),
 170         $action,
 171         array(
 172           'id' => $ufFieldBAO->id,
 173           'gid' => $this->_gid,
 174         ),
 175         ts('more'),
 176         FALSE,
 177         'ufField.row.actions',
 178         'UFField',
 179         $ufFieldBAO->id
 180       );
 181     }
 182
 183     $returnURL = CRM_Utils_System::url('civicrm/admin/uf/group/field',
 184       "reset=1&action=browse&gid={$this->_gid}"
 185     );
 186     $filter = "uf_group_id = {$this->_gid}";
 187     CRM_Utils_Weight::addOrder($ufField, 'CRM_Core_DAO_UFField',
 188       'id', $returnURL, $filter
 189     );
 190
 191     $this->assign('ufField', $ufField);
 192
 193     // retrieve showBestResult from session
 194     $session = CRM_Core_Session::singleton();
 195     $showBestResult = $session->get('showBestResult');
 196     $this->assign('showBestResult', $showBestResult);
 197     $session->set('showBestResult', 0);
 198   }
 199
 200   /**
 201    * edit CiviCRM Profile data.
 202    *
 203    * editing would involved modifying existing fields + adding data to new fields.
 204    *
 205    * @param string $action the action to be invoked
 206    *
 207    * @return void
 208    * @access public
 209    */
 210   function edit($action) {
 211     // create a simple controller for editing CiviCRM Profile data
 212     $controller = new CRM_Core_Controller_Simple('CRM_UF_Form_Field', ts('CiviCRM Profile Field'), $action);
 213
 214     // set the userContext stack
 215     $session = CRM_Core_Session::singleton();
 216     $session->pushUserContext(CRM_Utils_System::url('civicrm/admin/uf/group/field',
 217         'reset=1&action=browse&gid=' . $this->_gid
 218       ));
 219     $controller->set('gid', $this->_gid);
 220     $controller->setEmbedded(TRUE);
 221     $controller->process();
 222     $controller->run();
 223   }
 224
 225   /**
 226    * Run the page.
 227    *
 228    * This method is called after the page is created. It checks for the
 229    * type of action and executes that action.
 230    *
 231    * @return void
 232    * @access public
 233    *
 234    */
 235   function run() {
 236     // get the group id
 237     $this->_gid = CRM_Utils_Request::retrieve('gid', 'Positive',
 238       $this, FALSE, 0
 239     );
 240
 241     if ($this->_gid) {
 242       $groupTitle = CRM_Core_BAO_UFGroup::getTitle($this->_gid);
 243       $this->assign('gid', $this->_gid);
 244       $this->assign('groupTitle', $groupTitle);
 245       CRM_Utils_System::setTitle(ts('%1 - CiviCRM Profile Fields', array(1 => $groupTitle)));
 246     }
 247
 248     // get the requested action
 249     $action = CRM_Utils_Request::retrieve('action', 'String',
 250       // default to 'browse'
 251       $this, FALSE, 'browse'
 252     );
 253
 254     // assign vars to templates
 255     $this->assign('action', $action);
 256
 257     $id = CRM_Utils_Request::retrieve('id', 'Positive',
 258       $this, FALSE, 0
 259     );
 260
 261     // what action to take ?
 262     if ($action & (CRM_Core_Action::UPDATE | CRM_Core_Action::ADD | CRM_Core_Action::VIEW | CRM_Core_Action::DELETE)) {
 263       // no browse for edit/update/view/delete
 264       $this->edit($action);
 265     }
 266     elseif ($action & CRM_Core_Action::PREVIEW) {
 267       $this->preview($id, $this->_gid);
 268     }
 269     else {
 270       $this->browse();
 271     }
 272
 273     // Call the parents run method
 274     return parent::run();
 275   }
 276
 277   /**
 278    * Preview custom field
 279    *
 280    * @param int $id custom field id
 281    *
 282    * @return void
 283    * @access public
 284    */
 285   function preview($fieldId, $groupId) {
 286     $controller = new CRM_Core_Controller_Simple('CRM_UF_Form_Preview', ts('Preview Custom Data'), CRM_Core_Action::PREVIEW);
 287     $session = CRM_Core_Session::singleton();
 288     $session->pushUserContext(CRM_Utils_System::url('civicrm/admin/uf/group/field',
 289         'reset=1&action=browse&gid=' . $this->_gid
 290       ));
 291     $controller->set('fieldId', $fieldId);
 292     $controller->set('id', $groupId);
 293     $controller->setEmbedded(TRUE);
 294     $controller->process();
 295     $controller->run();
 296   }
 297 }
 298