| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 5 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright (C) 2011 Marty Wright | |
| 7 | | Licensed to CiviCRM under the Academic Free License version 3.0. | |
| 8 | +--------------------------------------------------------------------+ |
| 9 | | This file is a part of CiviCRM. | |
| 10 | | | |
| 11 | | CiviCRM is free software; you can copy, modify, and distribute it | |
| 12 | | under the terms of the GNU Affero General Public License | |
| 13 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | |
| 14 | | | |
| 15 | | CiviCRM is distributed in the hope that it will be useful, but | |
| 16 | | WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 17 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | |
| 18 | | See the GNU Affero General Public License for more details. | |
| 19 | | | |
| 20 | | You should have received a copy of the GNU Affero General Public | |
| 21 | | License and the CiviCRM Licensing Exception along | |
| 22 | | with this program; if not, contact CiviCRM LLC | |
| 23 | | at info[AT]civicrm[DOT]org. If you have questions about the | |
| 24 | | GNU Affero General Public License or the licensing of CiviCRM, | |
| 25 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | |
| 26 | +--------------------------------------------------------------------+ |
| 27 | */ |
| 28 | |
| 29 | /** |
| 30 | * |
| 31 | * @package CRM |
| 32 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
| 33 | */ |
| 34 | |
| 35 | /** |
| 36 | * This class generates form components for Label Format Settings. |
| 37 | */ |
| 38 | class CRM_Admin_Form_LabelFormats extends CRM_Admin_Form { |
| 39 | |
| 40 | /** |
| 41 | * Label Format ID. |
| 42 | * @var int |
| 43 | */ |
| 44 | public $_id = NULL; |
| 45 | |
| 46 | /** |
| 47 | * Group name, label format or name badge |
| 48 | * @var string |
| 49 | */ |
| 50 | protected $_group = NULL; |
| 51 | |
| 52 | /** |
| 53 | * @var bool |
| 54 | */ |
| 55 | public $submitOnce = TRUE; |
| 56 | |
| 57 | public function preProcess() { |
| 58 | $this->_id = $this->get('id'); |
| 59 | $this->_group = CRM_Utils_Request::retrieve('group', 'String', $this, FALSE, 'label_format'); |
| 60 | $this->_values = []; |
| 61 | if (isset($this->_id)) { |
| 62 | $params = ['id' => $this->_id]; |
| 63 | CRM_Core_BAO_LabelFormat::retrieve($params, $this->_values, $this->_group); |
| 64 | } |
| 65 | } |
| 66 | |
| 67 | /** |
| 68 | * Build the form object. |
| 69 | */ |
| 70 | public function buildQuickForm() { |
| 71 | parent::buildQuickForm(); |
| 72 | |
| 73 | if ($this->_action & (CRM_Core_Action::DELETE | CRM_Core_Action::COPY)) { |
| 74 | $formatName = CRM_Core_BAO_LabelFormat::getFieldValue('CRM_Core_BAO_LabelFormat', $this->_id, 'label'); |
| 75 | $this->assign('formatName', $formatName); |
| 76 | return; |
| 77 | } |
| 78 | |
| 79 | $disabled = []; |
| 80 | $required = TRUE; |
| 81 | $is_reserved = $this->_id ? CRM_Core_BAO_LabelFormat::getFieldValue('CRM_Core_BAO_LabelFormat', $this->_id, 'is_reserved') : FALSE; |
| 82 | if ($is_reserved) { |
| 83 | $disabled['disabled'] = 'disabled'; |
| 84 | $required = FALSE; |
| 85 | } |
| 86 | |
| 87 | $attributes = CRM_Core_DAO::getAttribute('CRM_Core_BAO_LabelFormat'); |
| 88 | $this->add('text', 'label', ts('Name'), $attributes['label'] + $disabled, $required); |
| 89 | $this->add('text', 'description', ts('Description'), ['size' => CRM_Utils_Type::HUGE]); |
| 90 | $this->add('checkbox', 'is_default', ts('Is this Label Format the default?')); |
| 91 | |
| 92 | // currently we support only mailing label creation, hence comment below code |
| 93 | /* |
| 94 | $options = array( |
| 95 | 'label_format' => ts('Mailing Label'), |
| 96 | 'name_badge' => ts('Name Badge'), |
| 97 | ); |
| 98 | |
| 99 | $labelType = $this->addRadio('label_type', ts('Used For'), $options, null, ' '); |
| 100 | |
| 101 | if ($this->_action != CRM_Core_Action::ADD) { |
| 102 | $labelType->freeze(); |
| 103 | } |
| 104 | */ |
| 105 | |
| 106 | $this->add('select', 'paper_size', ts('Sheet Size'), |
| 107 | [ |
| 108 | 0 => ts('- default -'), |
| 109 | ] + CRM_Core_BAO_PaperSize::getList(TRUE), FALSE, |
| 110 | [ |
| 111 | 'onChange' => "selectPaper( this.value );", |
| 112 | ] + $disabled |
| 113 | ); |
| 114 | $this->add('static', 'paper_dimensions', NULL, ts('Sheet Size (w x h)')); |
| 115 | $this->add('select', 'orientation', ts('Orientation'), CRM_Core_BAO_LabelFormat::getPageOrientations(), FALSE, |
| 116 | [ |
| 117 | 'onChange' => "updatePaperDimensions();", |
| 118 | ] + $disabled |
| 119 | ); |
| 120 | $this->add('select', 'font_name', ts('Font Name'), CRM_Core_BAO_LabelFormat::getFontNames($this->_group)); |
| 121 | $this->add('select', 'font_size', ts('Font Size'), CRM_Core_BAO_LabelFormat::getFontSizes()); |
| 122 | $this->add('static', 'font_style', ts('Font Style')); |
| 123 | $this->add('checkbox', 'bold', ts('Bold')); |
| 124 | $this->add('checkbox', 'italic', ts('Italic')); |
| 125 | $this->add('select', 'metric', ts('Unit of Measure'), CRM_Core_BAO_LabelFormat::getUnits(), FALSE, |
| 126 | ['onChange' => "selectMetric( this.value );"] |
| 127 | ); |
| 128 | $this->add('text', 'width', ts('Label Width'), ['size' => 8, 'maxlength' => 8] + $disabled, $required); |
| 129 | $this->add('text', 'height', ts('Label Height'), ['size' => 8, 'maxlength' => 8] + $disabled, $required); |
| 130 | $this->add('text', 'NX', ts('Labels Per Row'), ['size' => 3, 'maxlength' => 3] + $disabled, $required); |
| 131 | $this->add('text', 'NY', ts('Labels Per Column'), ['size' => 3, 'maxlength' => 3] + $disabled, $required); |
| 132 | $this->add('text', 'tMargin', ts('Top Margin'), ['size' => 8, 'maxlength' => 8] + $disabled, $required); |
| 133 | $this->add('text', 'lMargin', ts('Left Margin'), ['size' => 8, 'maxlength' => 8] + $disabled, $required); |
| 134 | $this->add('text', 'SpaceX', ts('Horizontal Spacing'), ['size' => 8, 'maxlength' => 8] + $disabled, $required); |
| 135 | $this->add('text', 'SpaceY', ts('Vertical Spacing'), ['size' => 8, 'maxlength' => 8] + $disabled, $required); |
| 136 | $this->add('text', 'lPadding', ts('Left Padding'), ['size' => 8, 'maxlength' => 8], $required); |
| 137 | $this->add('text', 'tPadding', ts('Top Padding'), ['size' => 8, 'maxlength' => 8], $required); |
| 138 | $this->add('number', 'weight', ts('Order'), CRM_Core_DAO::getAttribute('CRM_Core_BAO_LabelFormat', 'weight'), TRUE); |
| 139 | |
| 140 | $this->addRule('label', ts('Name already exists in Database.'), 'objectExists', [ |
| 141 | 'CRM_Core_BAO_LabelFormat', |
| 142 | $this->_id, |
| 143 | ]); |
| 144 | $this->addRule('NX', ts('Please enter a valid integer.'), 'integer'); |
| 145 | $this->addRule('NY', ts('Please enter a valid integer.'), 'integer'); |
| 146 | $this->addRule('tMargin', ts('Please enter a valid number.'), 'numeric'); |
| 147 | $this->addRule('lMargin', ts('Please enter a valid number.'), 'numeric'); |
| 148 | $this->addRule('SpaceX', ts('Please enter a valid number.'), 'numeric'); |
| 149 | $this->addRule('SpaceY', ts('Please enter a valid number.'), 'numeric'); |
| 150 | $this->addRule('lPadding', ts('Please enter a valid number.'), 'numeric'); |
| 151 | $this->addRule('tPadding', ts('Please enter a valid number.'), 'numeric'); |
| 152 | $this->addRule('width', ts('Please enter a valid number.'), 'numeric'); |
| 153 | $this->addRule('height', ts('Please enter a valid number.'), 'numeric'); |
| 154 | $this->addRule('weight', ts('Please enter a valid integer.'), 'integer'); |
| 155 | } |
| 156 | |
| 157 | /** |
| 158 | * @return int |
| 159 | */ |
| 160 | public function setDefaultValues() { |
| 161 | if ($this->_action & CRM_Core_Action::ADD) { |
| 162 | $defaults['weight'] = CRM_Utils_Array::value('weight', CRM_Core_BAO_LabelFormat::getDefaultValues($this->_group), 0); |
| 163 | $defaults['font_name'] = CRM_Utils_Array::value('font-name', CRM_Core_BAO_LabelFormat::getDefaultValues($this->_group), ''); |
| 164 | } |
| 165 | else { |
| 166 | $defaults = $this->_values; |
| 167 | // Convert field names that are illegal PHP/SMARTY variable names |
| 168 | $defaults['paper_size'] = $defaults['paper-size']; |
| 169 | unset($defaults['paper-size']); |
| 170 | $defaults['font_name'] = $defaults['font-name']; |
| 171 | unset($defaults['font-name']); |
| 172 | $defaults['font_size'] = $defaults['font-size']; |
| 173 | unset($defaults['font-size']); |
| 174 | |
| 175 | $defaults['bold'] = (stripos($defaults['font-style'], 'B') !== FALSE); |
| 176 | $defaults['italic'] = (stripos($defaults['font-style'], 'I') !== FALSE); |
| 177 | unset($defaults['font-style']); |
| 178 | } |
| 179 | |
| 180 | $defaults['label_type'] = $this->_group; |
| 181 | return $defaults; |
| 182 | } |
| 183 | |
| 184 | /** |
| 185 | * Process the form submission. |
| 186 | */ |
| 187 | public function postProcess() { |
| 188 | if ($this->_action & CRM_Core_Action::DELETE) { |
| 189 | // delete Label Format |
| 190 | CRM_Core_BAO_LabelFormat::del($this->_id, $this->_group); |
| 191 | CRM_Core_Session::setStatus(ts('Selected Label Format has been deleted.'), ts('Record Deleted'), 'success'); |
| 192 | return; |
| 193 | } |
| 194 | if ($this->_action & CRM_Core_Action::COPY) { |
| 195 | // make a copy of the Label Format |
| 196 | $labelFormat = CRM_Core_BAO_LabelFormat::getById($this->_id, $this->_group); |
| 197 | $newlabel = ts('Copy of %1', [1 => $labelFormat['label']]); |
| 198 | |
| 199 | $list = CRM_Core_BAO_LabelFormat::getList(TRUE, $this->_group); |
| 200 | $count = 1; |
| 201 | |
| 202 | while (in_array($newlabel, $list)) { |
| 203 | $count++; |
| 204 | $newlabel = ts('Copy %1 of %2', [1 => $count, 2 => $labelFormat['label']]); |
| 205 | } |
| 206 | |
| 207 | $labelFormat['label'] = $newlabel; |
| 208 | $labelFormat['grouping'] = CRM_Core_BAO_LabelFormat::customGroupName(); |
| 209 | $labelFormat['is_default'] = 0; |
| 210 | $labelFormat['is_reserved'] = 0; |
| 211 | |
| 212 | $bao = new CRM_Core_BAO_LabelFormat(); |
| 213 | $bao->saveLabelFormat($labelFormat, NULL, $this->_group); |
| 214 | CRM_Core_Session::setStatus(ts('%1 has been created.', [1 => $labelFormat['label']]), ts('Saved'), 'success'); |
| 215 | return; |
| 216 | } |
| 217 | |
| 218 | $values = $this->controller->exportValues($this->getName()); |
| 219 | |
| 220 | // since we currently support only mailing label format |
| 221 | $values['label_type'] = 'label_format'; |
| 222 | |
| 223 | $values['is_default'] = isset($values['is_default']); |
| 224 | |
| 225 | // Restore field names that were converted because they are illegal PHP/SMARTY variable names |
| 226 | if (isset($values['paper_size'])) { |
| 227 | $values['paper-size'] = $values['paper_size']; |
| 228 | unset($values['paper_size']); |
| 229 | } |
| 230 | if (isset($values['font_name'])) { |
| 231 | $values['font-name'] = $values['font_name']; |
| 232 | unset($values['font_name']); |
| 233 | } |
| 234 | if (isset($values['font_size'])) { |
| 235 | $values['font-size'] = $values['font_size']; |
| 236 | unset($values['font_size']); |
| 237 | } |
| 238 | |
| 239 | $style = ''; |
| 240 | if (isset($values['bold'])) { |
| 241 | $style .= 'B'; |
| 242 | } |
| 243 | if (isset($values['italic'])) { |
| 244 | $style .= 'I'; |
| 245 | } |
| 246 | $values['font-style'] = $style; |
| 247 | |
| 248 | $bao = new CRM_Core_BAO_LabelFormat(); |
| 249 | $bao->saveLabelFormat($values, $this->_id, $values['label_type']); |
| 250 | |
| 251 | $status = ts('Your new Label Format titled <strong>%1</strong> has been saved.', [1 => $values['label']]); |
| 252 | if ($this->_action & CRM_Core_Action::UPDATE) { |
| 253 | $status = ts('Your Label Format titled <strong>%1</strong> has been updated.', [1 => $values['label']]); |
| 254 | } |
| 255 | CRM_Core_Session::setStatus($status, ts('Saved'), 'success'); |
| 256 | } |
| 257 | |
| 258 | } |