CRM/UF/Form/AbstractPreview.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class generates form components
  38  * for previewing Civicrm Profile Group
  39  *
  40  */
  41 class CRM_UF_Form_AbstractPreview extends CRM_Core_Form {
  42
  43   /**
  44    * The fields needed to build this form
  45    *
  46    * @var array
  47    */
  48   public $_fields;
  49
  50   /**
  51    * Set the profile/field structure for this form
  52    *
  53    * @param array $fields list of fields per CRM_Core_BAO_UFGroup::formatUFFields or CRM_Core_BAO_UFGroup::getFields
  54    * @param bool $isSingleField
  55    * @param bool $flag
  56    */
  57   public function setProfile($fields, $isSingleField = FALSE, $flag = FALSE) {
  58     if ($isSingleField) {
  59       $this->assign('previewField', $isSingleField);
  60     }
  61
  62     if ($flag) {
  63       $this->assign('viewOnly', FALSE);
  64     }
  65     else {
  66       $this->assign('viewOnly', TRUE);
  67     }
  68
  69     $this->set('fieldId', NULL);
  70     $this->assign("fields", $fields);
  71     $this->_fields = $fields;
  72   }
  73
  74   /**
  75    * Set the default form values
  76    *
  77    * @access protected
  78    *
  79    * @return array the default array reference
  80    */
  81   public function setDefaultValues() {
  82     $defaults = array();
  83     foreach ($this->_fields as $name => $field) {
  84       if ($customFieldID = CRM_Core_BAO_CustomField::getKeyID($field['name'])) {
  85         CRM_Core_BAO_CustomField::setProfileDefaults($customFieldID, $name, $defaults, NULL, CRM_Profile_Form::MODE_REGISTER);
  86       }
  87     }
  88
  89     //set default for country.
  90     CRM_Core_BAO_UFGroup::setRegisterDefaults($this->_fields, $defaults);
  91
  92     return $defaults;
  93   }
  94
  95   /**
  96    * Build the form object
  97    *
  98    * @return void
  99    * @access public
 100    */
 101   public function buildQuickForm() {
 102     foreach ($this->_fields as $name => $field) {
 103       if (empty($field['is_view'])) {
 104         CRM_Core_BAO_UFGroup::buildProfile($this, $field, CRM_Profile_Form::MODE_CREATE);
 105       }
 106     }
 107   }
 108
 109   /**
 110    * Use the form name to create the tpl file name
 111    *
 112    * @return string
 113    * @access public
 114    */
 115   /**
 116    * @return string
 117    */
 118   public function getTemplateFileName() {
 119     return 'CRM/UF/Form/Preview.tpl';
 120   }
 121 }