3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2013
37 * This class generates form components for previewing custom data
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.
44 class CRM_Custom_Form_Preview
extends CRM_Core_Form
{
51 protected $_groupTree;
54 * pre processing work done here.
56 * gets session variables for group or field id
63 function preProcess() {
64 // get the controller vars
65 $this->_groupId
= $this->get('groupId');
66 $this->_fieldId
= $this->get('fieldId');
67 if ($this->_fieldId
) {
70 $params = array('id' => $this->_fieldId
);
71 $fieldDAO = new CRM_Core_DAO_CustomField();
72 CRM_Core_DAO
::commonRetrieve('CRM_Core_DAO_CustomField', $params, $defaults);
74 if (!empty($defaults['is_view'])) {
75 CRM_Core_Error
::statusBounce(ts('This field is view only so it will not display on edit form.'));
77 elseif (CRM_Utils_Array
::value('is_active', $defaults) == 0) {
78 CRM_Core_Error
::statusBounce(ts('This field is inactive so it will not display on edit form.'));
82 $groupTree[$this->_groupId
]['id'] = 0;
83 $groupTree[$this->_groupId
]['fields'] = array();
84 $groupTree[$this->_groupId
]['fields'][$this->_fieldId
] = $defaults;
85 $this->_groupTree
= CRM_Core_BAO_CustomGroup
::formatGroupTree($groupTree, 1, $this);
86 $this->assign('preview_type', 'field');
89 $groupTree = CRM_Core_BAO_CustomGroup
::getGroupDetail($this->_groupId
);
90 $this->_groupTree
= CRM_Core_BAO_CustomGroup
::formatGroupTree($groupTree, TRUE, $this);
91 $this->assign('preview_type', 'group');
96 * Set the default form values
100 * @return array the default array reference
103 function setDefaultValues() {
106 CRM_Core_BAO_CustomGroup
::setDefaults($this->_groupTree
, $defaults, FALSE, FALSE);
112 * Function to actually build the form
119 public function buildQuickForm() {
120 if (is_array($this->_groupTree
[$this->_groupId
])) {
121 foreach ($this->_groupTree
[$this->_groupId
]['fields'] as & $field) {
122 //add the form elements
123 CRM_Core_BAO_CustomField
::addQuickFormElement($this, $field['element_name'], $field['id'], FALSE, CRM_Utils_Array
::value('is_required', $field));
126 $this->assign('groupTree', $this->_groupTree
);
128 $this->addButtons(array(
131 'name' => ts('Done with Preview'),