3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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. |
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. |
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. |
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 +--------------------------------------------------------------------+
32 * @copyright CiviCRM LLC (c) 2004-2014
38 * This class contains functions for managing Label Formats
40 class CRM_Core_BAO_LabelFormat
extends CRM_Core_DAO_OptionValue
{
43 * Static holder for the Label Formats Option Group ID.
45 private static $_gid = NULL;
48 * Label Format fields stored in the 'value' field of the Option Value table.
50 private static $optionValueFields = array(
51 'paper-size' => array(
52 // Paper size: names defined in option_value table (option_group = 'paper_size')
53 'name' => 'paper-size',
54 'type' => CRM_Utils_Type
::T_STRING
,
55 'default' => 'letter',
57 'orientation' => array(
58 // Paper orientation: 'portrait' or 'landscape'
59 'name' => 'orientation',
60 'type' => CRM_Utils_Type
::T_STRING
,
61 'default' => 'portrait',
64 // Font name: 'courier', 'helvetica', 'times'
65 'name' => 'font-name',
66 'type' => CRM_Utils_Type
::T_STRING
,
67 'default' => 'helvetica',
70 // Font size: always in points
71 'name' => 'font-size',
72 'type' => CRM_Utils_Type
::T_INT
,
75 'font-style' => array(
76 // Font style: 'B' bold, 'I' italic, 'BI' bold+italic
77 'name' => 'font-style',
78 'type' => CRM_Utils_Type
::T_STRING
,
82 // Number of labels horizontally
84 'type' => CRM_Utils_Type
::T_INT
,
88 // Number of labels vertically
90 'type' => CRM_Utils_Type
::T_INT
,
94 // Unit of measurement for all of the following fields
96 'type' => CRM_Utils_Type
::T_STRING
,
102 'type' => CRM_Utils_Type
::T_FLOAT
,
109 'type' => CRM_Utils_Type
::T_FLOAT
,
114 // Horizontal space between two labels
116 'type' => CRM_Utils_Type
::T_FLOAT
,
118 'default' => 3.96875,
121 // Vertical space between two labels
123 'type' => CRM_Utils_Type
::T_FLOAT
,
130 'type' => CRM_Utils_Type
::T_FLOAT
,
137 'type' => CRM_Utils_Type
::T_FLOAT
,
142 // Space between text and left edge of label
143 'name' => 'lPadding',
144 'type' => CRM_Utils_Type
::T_FLOAT
,
149 // Space between text and top edge of label
150 'name' => 'tPadding',
151 'type' => CRM_Utils_Type
::T_FLOAT
,
158 * Get page orientations recognized by the DOMPDF package used to create PDF letters.
161 * array of page orientations
163 public static function getPageOrientations() {
165 'portrait' => ts('Portrait'),
166 'landscape' => ts('Landscape'),
171 * Get font names supported by the TCPDF package used to create PDF labels.
173 * @param string $name
177 * array of font names
179 public static function getFontNames($name = 'label_format') {
180 $label = new CRM_Utils_PDF_Label(self
::getDefaultValues($name));
181 return $label->getFontNames();
185 * Get font sizes supported by the TCPDF package used to create PDF labels.
188 * array of font sizes
190 public static function getFontSizes() {
191 $fontSizes = array();
192 for ($i = 6; $i <= 60; $i++
) {
193 $fontSizes[$i] = ts('%1 pt', array(1 => $i));
200 * Get measurement units recognized by the TCPDF package used to create PDF labels.
203 * array of measurement units
205 public static function getUnits() {
207 'in' => ts('Inches'),
208 'cm' => ts('Centimeters'),
209 'mm' => ts('Millimeters'),
210 'pt' => ts('Points'),
215 * Get text alignment recognized by the TCPDF package used to create PDF labels.
218 * array of alignments
220 public static function getTextAlignments() {
229 * Get text alignment recognized by the TCPDF package used to create PDF labels.
232 * array of alignments
234 public static function getFontStyles() {
243 * Get Option Group ID for Label Formats.
245 * @param string $name
248 * Group ID (null if Group ID doesn't exist)
250 private static function _getGid($name = 'label_format') {
251 if (!isset(self
::$_gid[$name]) ||
!self
::$_gid[$name]) {
252 self
::$_gid[$name] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', $name, 'id', 'name');
253 if (!self
::$_gid[$name]) {
254 CRM_Core_Error
::fatal(ts('Label Format Option Group not found in database.'));
257 return self
::$_gid[$name];
261 * Add ordering fields to Label Format list.
263 * @param array (reference) $list List of Label Formats
264 * @param string $returnURL
265 * URL of page calling this function.
268 * (reference) List of Label Formats
270 public static function addOrder(&$list, $returnURL) {
271 $filter = "option_group_id = " . self
::_getGid();
272 CRM_Utils_Weight
::addOrder($list, 'CRM_Core_DAO_OptionValue', 'id', $returnURL, $filter);
277 * Retrieve list of Label Formats.
279 * @param bool $namesOnly
280 * Return simple list of names.
281 * @param string $groupName
282 * Group name of the label format option group.
285 * (reference) label format list
287 public static function &getList($namesOnly = FALSE, $groupName = 'label_format') {
288 static $list = array();
289 if (self
::_getGid($groupName)) {
290 // get saved label formats from Option Value table
291 $dao = new CRM_Core_DAO_OptionValue();
292 $dao->option_group_id
= self
::_getGid($groupName);
294 $dao->orderBy('weight');
296 while ($dao->fetch()) {
298 $list[$groupName][$dao->name
] = $dao->label
;
301 CRM_Core_DAO
::storeValues($dao, $list[$groupName][$dao->id
]);
305 return $list[$groupName];
309 * Retrieve the default Label Format values.
311 * @param string $groupName
312 * Label format group name.
315 * Name/value pairs containing the default Label Format values.
317 public static function &getDefaultValues($groupName = 'label_format') {
318 $params = array('is_active' => 1, 'is_default' => 1);
320 if (!self
::retrieve($params, $defaults, $groupName)) {
321 foreach (self
::$optionValueFields as $name => $field) {
322 $defaults[$name] = $field['default'];
324 $filter = array('option_group_id' => self
::_getGid($groupName));
325 $defaults['weight'] = CRM_Utils_Weight
::getDefaultWeight('CRM_Core_DAO_OptionValue', $filter);
331 * Get Label Format from the DB.
333 * @param string $field
334 * Field name to search by.
336 * Field value to search for.
338 * @param string $groupName
341 * (reference) associative array of name/value pairs
343 public static function &getLabelFormat($field, $val, $groupName = 'label_format') {
344 $params = array('is_active' => 1, $field => $val);
345 $labelFormat = array();
346 if (self
::retrieve($params, $labelFormat, $groupName)) {
350 return self
::getDefaultValues($groupName);
355 * Get Label Format by Name.
358 * Label format name. Empty = get default label format.
361 * (reference) associative array of name/value pairs
363 public static function &getByName($name) {
364 return self
::getLabelFormat('name', $name);
368 * Get Label Format by ID.
371 * Label format id. 0 = get default label format.
372 * @param string $groupName
376 * (reference) associative array of name/value pairs
378 public static function &getById($id, $groupName = 'label_format') {
379 return self
::getLabelFormat('id', $id, $groupName);
383 * Get Label Format field from associative array.
385 * @param string $field
386 * Name of a label format field.
387 * @param array (reference) $values associative array of name/value pairs containing
388 * label format field selections
390 * @param null $default
394 public static function getValue($field, &$values, $default = NULL) {
395 if (array_key_exists($field, self
::$optionValueFields)) {
396 switch (self
::$optionValueFields[$field]['type']) {
397 case CRM_Utils_Type
::T_INT
:
398 return (int) CRM_Utils_Array
::value($field, $values, $default);
400 case CRM_Utils_Type
::T_FLOAT
:
401 // Round float values to three decimal places and trim trailing zeros.
402 // Add a leading zero to values less than 1.
403 $f = sprintf('%05.3f', $values[$field]);
406 return (float) (empty($f) ?
'0' : $f);
408 return CRM_Utils_Array
::value($field, $values, $default);
414 * Retrieve DB object based on input parameters.
416 * It also stores all the retrieved values in the default array.
418 * @param array $params
419 * (reference ) an assoc array of name/value pairs.
420 * @param array $values
421 * (reference ) an assoc array to hold the flattened values.
423 * @param string $groupName
425 * @return CRM_Core_DAO_OptionValue
427 public static function retrieve(&$params, &$values, $groupName = 'label_format') {
428 $optionValue = new CRM_Core_DAO_OptionValue();
429 $optionValue->copyValues($params);
430 $optionValue->option_group_id
= self
::_getGid($groupName);
431 if ($optionValue->find(TRUE)) {
432 // Extract fields that have been serialized in the 'value' column of the Option Value table.
433 $values = json_decode($optionValue->value
, TRUE);
434 // Add any new fields that don't yet exist in the saved values.
435 foreach (self
::$optionValueFields as $name => $field) {
436 if (!isset($values[$name])) {
437 $values[$name] = $field['default'];
438 if ($field['metric']) {
439 $values[$name] = CRM_Utils_PDF_Utils
::convertMetric($field['default'],
440 self
::$optionValueFields['metric']['default'],
446 // Add fields from the OptionValue base class
447 CRM_Core_DAO
::storeValues($optionValue, $values);
454 * Return the name of the group for customized labels.
458 public static function customGroupName() {
463 * Save the Label Format in the DB.
465 * @param array (reference) $values associative array of name/value pairs
467 * Id of the database record (null = new record).
468 * @param string $groupName
469 * Group name of the label format.
473 public function saveLabelFormat(&$values, $id = NULL, $groupName = 'label_format') {
474 // get the Option Group ID for Label Formats (create one if it doesn't exist)
475 $group_id = self
::_getGid($groupName);
477 // clear other default if this is the new default label format
478 if ($values['is_default']) {
479 $query = "UPDATE civicrm_option_value SET is_default = 0 WHERE option_group_id = $group_id";
480 CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
483 // fetch existing record
491 $list = self
::getList(TRUE, $groupName);
493 while (array_key_exists("custom_$cnt", $list)) {
496 $values['name'] = "custom_$cnt";
497 $values['grouping'] = self
::customGroupName();
499 // copy the supplied form values to the corresponding Option Value fields in the base class
500 foreach ($this->fields() as $name => $field) {
501 $this->$name = trim(CRM_Utils_Array
::value($name, $values, $this->$name));
502 if (empty($this->$name)) {
503 $this->$name = 'null';
507 $this->option_group_id
= $group_id;
508 $this->is_active
= 1;
510 // serialize label format fields into a single string to store in the 'value' column of the Option Value table
511 $v = json_decode($this->value
, TRUE);
512 foreach (self
::$optionValueFields as $name => $field) {
513 if (!isset($v[$name])) {
516 $v[$name] = self
::getValue($name, $values, $v[$name]);
518 $this->value
= json_encode($v);
520 // make sure serialized array will fit in the 'value' column
521 $attribute = CRM_Core_DAO
::getAttribute('CRM_Core_BAO_LabelFormat', 'value');
522 if (strlen($this->value
) > $attribute['maxlength']) {
523 CRM_Core_Error
::fatal(ts('Label Format does not fit in database.'));
527 // fix duplicate weights
528 $filter = array('option_group_id' => self
::_getGid());
529 CRM_Utils_Weight
::correctDuplicateWeights('CRM_Core_DAO_OptionValue', $filter);
533 * Delete a Label Format.
536 * ID of the label format to be deleted.
537 * @param string $groupName
540 public static function del($id, $groupName) {
542 $dao = new CRM_Core_DAO_OptionValue();
544 if ($dao->find(TRUE)) {
545 if ($dao->option_group_id
== self
::_getGid($groupName)) {
546 $filter = array('option_group_id' => self
::_getGid($groupName));
547 CRM_Utils_Weight
::delWeight('CRM_Core_DAO_OptionValue', $id, $filter);
553 CRM_Core_Error
::fatal(ts('Invalid value passed to delete function.'));