crm.fsf.org/20131203/files/sites/all/modules-old/civicrm/CRM/Custom/Form/Preview.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class generates form components for previewing 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_Custom_Form_Preview extends CRM_Core_Form {
  45
  46   /**
  47    * The group tree data.
  48    *
  49    * @var array
  50    */
  51   protected $_groupTree;
  52
  53   /**
  54    * Pre processing work done here.
  55    *
  56    * gets session variables for group or field id
  57    *
  58    * @return void
  59    */
  60   public function preProcess() {
  61     // get the controller vars
  62     $this->_groupId = $this->get('groupId');
  63     $this->_fieldId = $this->get('fieldId');
  64     if ($this->_fieldId) {
  65       // field preview
  66       $defaults = array();
  67       $params = array('id' => $this->_fieldId);
  68       $fieldDAO = new CRM_Core_DAO_CustomField();
  69       CRM_Core_DAO::commonRetrieve('CRM_Core_DAO_CustomField', $params, $defaults);
  70
  71       if (!empty($defaults['is_view'])) {
  72         CRM_Core_Error::statusBounce(ts('This field is view only so it will not display on edit form.'));
  73       }
  74       elseif (CRM_Utils_Array::value('is_active', $defaults) == 0) {
  75         CRM_Core_Error::statusBounce(ts('This field is inactive so it will not display on edit form.'));
  76       }
  77
  78       $groupTree = array();
  79       $groupTree[$this->_groupId]['id'] = 0;
  80       $groupTree[$this->_groupId]['fields'] = array();
  81       $groupTree[$this->_groupId]['fields'][$this->_fieldId] = $defaults;
  82       $this->_groupTree = CRM_Core_BAO_CustomGroup::formatGroupTree($groupTree, 1, $this);
  83       $this->assign('preview_type', 'field');
  84     }
  85     else {
  86       $groupTree = CRM_Core_BAO_CustomGroup::getGroupDetail($this->_groupId);
  87       $this->_groupTree = CRM_Core_BAO_CustomGroup::formatGroupTree($groupTree, TRUE, $this);
  88       $this->assign('preview_type', 'group');
  89     }
  90   }
  91
  92   /**
  93    * Set the default form values.
  94    *
  95    * @return array
  96    *   the default array reference
  97    */
  98   public function setDefaultValues() {
  99     $defaults = array();
 100
 101     CRM_Core_BAO_CustomGroup::setDefaults($this->_groupTree, $defaults, FALSE, FALSE);
 102
 103     return $defaults;
 104   }
 105
 106   /**
 107    * Build the form object.
 108    *
 109    * @return void
 110    */
 111   public function buildQuickForm() {
 112     if (is_array($this->_groupTree[$this->_groupId])) {
 113       foreach ($this->_groupTree[$this->_groupId]['fields'] as & $field) {
 114         //add the form elements
 115         CRM_Core_BAO_CustomField::addQuickFormElement($this, $field['element_name'], $field['id'], FALSE, CRM_Utils_Array::value('is_required', $field));
 116       }
 117
 118       $this->assign('groupTree', $this->_groupTree);
 119     }
 120     $this->addButtons(array(
 121         array(
 122           'type' => 'cancel',
 123           'name' => ts('Done with Preview'),
 124           'isDefault' => TRUE,
 125         ),
 126       )
 127     );
 128   }
 129
 130 }