CRM/Badge/Form/Layout.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  * This class generates form components for name badge layout
  38  *
  39  */
  40 class CRM_Badge_Form_Layout extends CRM_Admin_Form {
  41
  42   const FIELD_ROWCOUNT = 6;
  43   /**
  44    * Function to build the form
  45    *
  46    * @return void
  47    * @access public
  48    */
  49   public function buildQuickForm() {
  50     if ($this->_action & CRM_Core_Action::DELETE) {
  51       return parent::buildQuickForm();
  52     }
  53
  54     $config = CRM_Core_Config::singleton();
  55     $resources = CRM_Core_Resources::singleton();
  56     $resources->addSetting(
  57       array(
  58         'kcfinderPath' => $config->userFrameworkResourceURL .'packages' .DIRECTORY_SEPARATOR
  59       )
  60     );
  61     $resources->addScriptFile('civicrm', 'templates/CRM/Badge/Form/Layout.js');
  62
  63     $this->applyFilter('__ALL__', 'trim');
  64
  65     $this->add('text', 'title', ts('Title'), CRM_Core_DAO::getAttribute('CRM_Core_DAO_PrintLabel', 'title'), true);
  66
  67     $labelStyle = CRM_Core_BAO_LabelFormat::getList(TRUE, 'name_badge');
  68     $this->add('select', 'label_format_name', ts('Label Format'), array('' => ts('- select -')) + $labelStyle, TRUE);
  69
  70     $this->add('text', 'description', ts('Description'),
  71       CRM_Core_DAO::getAttribute('CRM_Core_DAO_PrintLabel', 'title'));
  72
  73     // get the tokens
  74     $contactTokens = CRM_Core_SelectValues::contactTokens();
  75     $eventTokens = array(
  76       '{event.event_id}' => ts('Event ID'),
  77       '{event.title}' => ts('Event Title'),
  78       '{event.start_date}' => ts('Event Start Date'),
  79       '{event.end_date}' => ts('Event End Date')
  80     );
  81     $participantTokens = CRM_Core_SelectValues::participantTokens();
  82
  83     $tokens = array_merge($contactTokens, $eventTokens, $participantTokens);
  84     asort($tokens);
  85
  86     $tokens = array_merge(array('spacer' => ts('- spacer -')) + $tokens);
  87
  88     $fontSizes = CRM_Core_BAO_LabelFormat::getFontSizes();
  89     $fontStyles = CRM_Core_BAO_LabelFormat::getFontStyles();
  90     $fontNames = CRM_Core_BAO_LabelFormat::getFontNames('name_badge');
  91     $textAlignment = CRM_Core_BAO_LabelFormat::getTextAlignments();
  92
  93     $rowCount = self::FIELD_ROWCOUNT;
  94     for ( $i =1; $i <= $rowCount; $i++ ) {
  95       $this->add('select', "token[$i]", ts('Token'), array('' => ts('- skip -')) + $tokens);
  96       $this->add('select', "font_name[$i]", ts('Font Name'), $fontNames);
  97       $this->add('select', "font_size[$i]", ts('Font Size'), $fontSizes);
  98       $this->add('select', "font_style[$i]", ts('Font Style'), $fontStyles);
  99       $this->add('select', "text_alignment[$i]", ts('Alignment'), $textAlignment);
 100     }
 101     $rowCount++;
 102     $this->assign('rowCount', $rowCount);
 103
 104     $barcodeTypes = CRM_Core_SelectValues::getBarcodeTypes();
 105     $this->add('checkbox', 'add_barcode', ts('Barcode?'));
 106     $this->add('select', "barcode_type", ts('Type'), $barcodeTypes);
 107     $this->add('select', "barcode_alignment", ts('Alignment'), $textAlignment);
 108
 109
 110     $attributes = array('readonly'=> true);
 111     $this->add('text', 'image_1', ts('Image (top left)'),
 112       $attributes + CRM_Core_DAO::getAttribute('CRM_Core_DAO_PrintLabel', 'title'));
 113     $this->add('text', 'width_image_1', ts('Width (mm)'), array('size' => 6));
 114     $this->add('text', 'height_image_1', ts('Height (mm)'), array('size' => 6));
 115
 116     $this->add('text', 'image_2', ts('Image (top right)'),
 117       $attributes + CRM_Core_DAO::getAttribute('CRM_Core_DAO_PrintLabel', 'title'));
 118     $this->add('text', 'width_image_2', ts('Width (mm)'), array('size' => 6));
 119     $this->add('text', 'height_image_2', ts('Height (mm)'), array('size' => 6));
 120
 121     $this->add('checkbox', 'is_default', ts('Default?'));
 122     $this->add('checkbox', 'is_active', ts('Enabled?'));
 123     $this->add('checkbox', 'is_reserved', ts('Reserved?'));
 124
 125     $this->addRule('width_image_1', ts('Enter valid width'), 'positiveInteger');
 126     $this->addRule('width_image_2', ts('Enter valid width'), 'positiveInteger');
 127     $this->addRule('height_image_1', ts('Enter valid height'), 'positiveInteger');
 128     $this->addRule('height_image_2', ts('Enter valid height'), 'positiveInteger');
 129
 130     $this->addButtons(array(
 131         array(
 132           'type' => 'next',
 133           'name' => ts('Save'),
 134           'isDefault' => TRUE,
 135         ),
 136         array(
 137           'type' => 'refresh',
 138           'name' => ts('Save and Preview'),
 139         ),
 140         array(
 141           'type' => 'cancel',
 142           'name' => ts('Cancel'),
 143         ),
 144       )
 145     );
 146   }
 147
 148   /**
 149    * This function sets the default values for the form. MobileProvider that in edit/view mode
 150    * the default values are retrieved from the database
 151    *
 152    * @access public
 153    *
 154    * @return void
 155    */
 156   function setDefaultValues() {
 157     if (isset($this->_id)) {
 158       $defaults = array_merge($this->_values,
 159         CRM_Badge_BAO_Layout::getDecodedData($this->_values['data']));
 160     }
 161     else {
 162       for ($i = 1; $i <= self::FIELD_ROWCOUNT; $i++) {
 163         $defaults['text_alignment'][$i] = "C";
 164       }
 165     }
 166
 167     if ($this->_action == CRM_Core_Action::DELETE && isset($defaults['title'])) {
 168       $this->assign('delName', $defaults['title']);
 169     }
 170
 171     // its ok if there is no element called is_active
 172     $defaults['is_active'] = ($this->_id) ? CRM_Utils_Array::value('is_active', $defaults) : 1;
 173
 174     return $defaults;
 175   }
 176
 177   /**
 178    * Function to process the form
 179    *
 180    * @access public
 181    *
 182    * @return void
 183    */
 184   public function postProcess() {
 185     if ($this->_action & CRM_Core_Action::DELETE) {
 186       CRM_Badge_BAO_Layout::del($this->_id);
 187       CRM_Core_Session::setStatus(ts('Selected badge layout has been deleted.'), ts('Record Deleted'), 'success');
 188       return;
 189     }
 190
 191     $params = $data = $this->exportValues();
 192
 193     unset($data['qfKey']);
 194     $params['data'] = json_encode($data);
 195
 196     if ($this->_id) {
 197       $params['id'] = $this->_id;
 198     }
 199
 200     // store the submitted values in an array
 201     $badgeInfo = CRM_Badge_BAO_Layout::create($params);
 202
 203     if (isset($params['_qf_Layout_refresh'])) {
 204       $this->set('id', $badgeInfo->id);
 205       $params['badge_id'] = $badgeInfo->id;
 206       self::buildPreview($params);
 207     }
 208     else {
 209       CRM_Core_Session::setStatus(ts("The badge layout '%1' has been saved.",
 210         array(1 => $params['title'])
 211       ), ts('Saved'), 'success');
 212     }
 213   }
 214
 215   public function buildPreview(&$params) {
 216     // get a max participant id
 217     $participantID = CRM_Core_DAO::singleValueQuery('select max(id) from civicrm_participant');
 218
 219     if (!$participantID) {
 220       CRM_Core_Session::setStatus(ts('Preview requires at least one event and one participant record.
 221        If you are just getting started, you can add a test participant record.'), ts('Preview Requirements'), 'alert');
 222       return;
 223     }
 224
 225     $this->_single = TRUE;
 226     $this->_participantIds = array($participantID);
 227     $this->_componentClause = " civicrm_participant.id = $participantID ";
 228
 229     CRM_Badge_BAO_Badge::buildBadges($params, $this);
 230   }
 231 }