CRM/Core/BAO/LabelFormat.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.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 (c) 2004-2014
  33  * $Id$
  34  *
  35  */
  36
  37 /**
  38  * This class contains functions for managing Label Formats
  39  */
  40 class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
  41
  42   /**
  43    * Static holder for the Label Formats Option Group ID
  44    */
  45   private static $_gid = NULL;
  46
  47   /**
  48    * Label Format fields stored in the 'value' field of the Option Value table.
  49    */
  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',
  56     ),
  57     'orientation' => array(
  58       // Paper orientation: 'portrait' or 'landscape'
  59       'name' => 'orientation',
  60       'type' => CRM_Utils_Type::T_STRING,
  61       'default' => 'portrait',
  62     ),
  63     'font-name' => array(
  64       // Font name: 'courier', 'helvetica', 'times'
  65       'name' => 'font-name',
  66       'type' => CRM_Utils_Type::T_STRING,
  67       'default' => 'helvetica',
  68     ),
  69     'font-size' => array(
  70       // Font size: always in points
  71       'name' => 'font-size',
  72       'type' => CRM_Utils_Type::T_INT,
  73       'default' => 8,
  74     ),
  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,
  79       'default' => '',
  80     ),
  81     'NX' => array(
  82       // Number of labels horizontally
  83       'name' => 'NX',
  84       'type' => CRM_Utils_Type::T_INT,
  85       'default' => 3,
  86     ),
  87     'NY' => array(
  88       // Number of labels vertically
  89       'name' => 'NY',
  90       'type' => CRM_Utils_Type::T_INT,
  91       'default' => 10,
  92     ),
  93     'metric' => array(
  94       // Unit of measurement for all of the following fields
  95       'name' => 'metric',
  96       'type' => CRM_Utils_Type::T_STRING,
  97       'default' => 'mm',
  98     ),
  99     'lMargin' => array(
 100       // Left margin
 101       'name' => 'lMargin',
 102       'type' => CRM_Utils_Type::T_FLOAT,
 103       'metric' => TRUE,
 104       'default' => 4.7625,
 105     ),
 106     'tMargin' => array(
 107       // Right margin
 108       'name' => 'tMargin',
 109       'type' => CRM_Utils_Type::T_FLOAT,
 110       'metric' => TRUE,
 111       'default' => 12.7,
 112     ),
 113     'SpaceX' => array(
 114       // Horizontal space between two labels
 115       'name' => 'SpaceX',
 116       'type' => CRM_Utils_Type::T_FLOAT,
 117       'metric' => TRUE,
 118       'default' => 3.96875,
 119     ),
 120     'SpaceY' => array(
 121       // Vertical space between two labels
 122       'name' => 'SpaceY',
 123       'type' => CRM_Utils_Type::T_FLOAT,
 124       'metric' => TRUE,
 125       'default' => 0,
 126     ),
 127     'width' => array(
 128       // Width of label
 129       'name' => 'width',
 130       'type' => CRM_Utils_Type::T_FLOAT,
 131       'metric' => TRUE,
 132       'default' => 65.875,
 133     ),
 134     'height' => array(
 135       // Height of label
 136       'name' => 'height',
 137       'type' => CRM_Utils_Type::T_FLOAT,
 138       'metric' => TRUE,
 139       'default' => 25.4,
 140     ),
 141     'lPadding' => array(
 142       // Space between text and left edge of label
 143       'name' => 'lPadding',
 144       'type' => CRM_Utils_Type::T_FLOAT,
 145       'metric' => TRUE,
 146       'default' => 5.08,
 147     ),
 148     'tPadding' => array(
 149       // Space between text and top edge of label
 150       'name' => 'tPadding',
 151       'type' => CRM_Utils_Type::T_FLOAT,
 152       'metric' => TRUE,
 153       'default' => 5.08,
 154     ),
 155   );
 156
 157   /**
 158    * Get page orientations recognized by the DOMPDF package used to create PDF letters.
 159    *
 160    * @param void
 161    *
 162    * @return array   array of page orientations
 163    * @access public
 164    * @static
 165    */
 166   public static function getPageOrientations() {
 167     return array(
 168       'portrait' => ts('Portrait'),
 169       'landscape' => ts('Landscape'),
 170     );
 171   }
 172
 173   /**
 174    * Get font names supported by the TCPDF package used to create PDF labels.
 175    *
 176    * @param string $name group name
 177    *
 178    * @return array   array of font names
 179    * @access public
 180    * @static
 181    */
 182   public static function getFontNames($name='label_format') {
 183     $label = new CRM_Utils_PDF_Label(self::getDefaultValues($name));
 184     return $label->getFontNames();
 185   }
 186
 187   /**
 188    * Get font sizes supported by the TCPDF package used to create PDF labels.
 189    *
 190    * @param void
 191    *
 192    * @return array   array of font sizes
 193    * @access public
 194    * @static
 195    */
 196   public static function getFontSizes() {
 197     $fontSizes = array();
 198     for ($i = 6; $i <= 60; $i++) {
 199       $fontSizes[$i] = ts('%1 pt', array(1 => $i));
 200     }
 201
 202     return $fontSizes;
 203   }
 204
 205   /**
 206    * Get measurement units recognized by the TCPDF package used to create PDF labels.
 207    *
 208    * @param void
 209    *
 210    * @return array   array of measurement units
 211    * @access public
 212    * @static
 213    */
 214   public static function getUnits() {
 215     return array(
 216       'in' => ts('Inches'),
 217       'cm' => ts('Centimeters'),
 218       'mm' => ts('Millimeters'),
 219       'pt' => ts('Points'),
 220     );
 221   }
 222
 223   /**
 224    * Get text alignment recognized by the TCPDF package used to create PDF labels.
 225    *
 226    * @param void
 227    *
 228    * @return array   array of alignments
 229    * @access public
 230    * @static
 231    */
 232   public static function getTextAlignments() {
 233     return array(
 234       'R' => ts('Right'),
 235       'L' => ts('Left'),
 236       'C' => ts('Center'),
 237     );
 238   }
 239
 240   /**
 241    * Get text alignment recognized by the TCPDF package used to create PDF labels.
 242    *
 243    * @param void
 244    *
 245    * @return array   array of alignments
 246    * @access public
 247    * @static
 248    */
 249   public static function getFontStyles() {
 250     return array(
 251       '' => ts('Normal'),
 252       'B' => ts('Bold'),
 253       'I' => ts('Italic'),
 254     );
 255   }
 256
 257   /**
 258    * Get Option Group ID for Label Formats
 259    *
 260    * @param string $name
 261    *
 262    * @return int  Group ID (null if Group ID doesn't exist)
 263    * @access private
 264    */
 265   private static function _getGid($name='label_format') {
 266     if (!isset(self::$_gid[$name]) || !self::$_gid[$name]) {
 267       self::$_gid[$name] = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', $name, 'id', 'name');
 268       if (!self::$_gid[$name]) {
 269         CRM_Core_Error::fatal(ts('Label Format Option Group not found in database.'));
 270       }
 271     }
 272     return self::$_gid[$name];
 273   }
 274
 275   /**
 276    * Add ordering fields to Label Format list
 277    *
 278    * @param array (reference)   $list         List of Label Formats
 279    * @param string              $returnURL    URL of page calling this function
 280    *
 281    * @return array  (reference)   List of Label Formats
 282    * @static
 283    * @access public
 284    */
 285   static function addOrder(&$list, $returnURL) {
 286     $filter = "option_group_id = " . self::_getGid();
 287     CRM_Utils_Weight::addOrder($list, 'CRM_Core_DAO_OptionValue', 'id', $returnURL, $filter);
 288   }
 289
 290   /**
 291    * Retrieve list of Label Formats.
 292    *
 293    * @param bool    $namesOnly    return simple list of names
 294    * @param string  $groupName    group name of the label format option group
 295    *
 296    * @return array  (reference)   label format list
 297    * @static
 298    * @access public
 299    */
 300   static function &getList($namesOnly = FALSE, $groupName='label_format') {
 301     static $list = array();
 302     if (self::_getGid($groupName)) {
 303       // get saved label formats from Option Value table
 304       $dao = new CRM_Core_DAO_OptionValue();
 305       $dao->option_group_id = self::_getGid($groupName);
 306       $dao->is_active = 1;
 307       $dao->orderBy('weight');
 308       $dao->find();
 309       while ($dao->fetch()) {
 310         if ($namesOnly) {
 311           $list[$groupName][$dao->name] = $dao->label;
 312         }
 313         else {
 314           CRM_Core_DAO::storeValues($dao, $list[$groupName][$dao->id]);
 315         }
 316       }
 317     }
 318     return $list[$groupName];
 319   }
 320
 321   /**
 322    * Retrieve the default Label Format values
 323    *
 324    * @param string $groupName label format group name
 325    *
 326    * @return array   Name/value pairs containing the default Label Format values.
 327    * @static
 328    * @access public
 329    */
 330   static function &getDefaultValues($groupName = 'label_format') {
 331     $params = array('is_active' => 1, 'is_default' => 1);
 332     $defaults = array();
 333     if (!self::retrieve($params, $defaults, $groupName)) {
 334       foreach (self::$optionValueFields as $name => $field) {
 335         $defaults[$name] = $field['default'];
 336       }
 337       $filter = array('option_group_id' => self::_getGid($groupName));
 338       $defaults['weight'] = CRM_Utils_Weight::getDefaultWeight('CRM_Core_DAO_OptionValue', $filter);
 339     }
 340     return $defaults;
 341   }
 342
 343   /**
 344    * Get Label Format from the DB
 345    *
 346    * @param string $field Field name to search by
 347    * @param int $val Field value to search for
 348    *
 349    * @param string $groupName
 350    *
 351    * @return array  $values (reference) associative array of name/value pairs
 352    * @access public
 353    */
 354   static function &getLabelFormat($field, $val, $groupName = 'label_format') {
 355     $params = array('is_active' => 1, $field => $val);
 356     $labelFormat = array();
 357     if (self::retrieve($params, $labelFormat, $groupName)) {
 358       return $labelFormat;
 359     }
 360     else {
 361       return self::getDefaultValues($groupName);
 362     }
 363   }
 364
 365   /**
 366    * Get Label Format by Name
 367    *
 368    * @param int    $name   Label format name. Empty = get default label format
 369    *
 370    * @return array  $values (reference) associative array of name/value pairs
 371    * @access public
 372    */
 373   static function &getByName($name) {
 374     return self::getLabelFormat('name', $name);
 375   }
 376
 377   /**
 378    * Get Label Format by ID
 379    *
 380    * @param int    $id   label format id. 0 = get default label format
 381    * @param string $groupName group name
 382    *
 383    * @return array  $values (reference) associative array of name/value pairs
 384    * @access public
 385    */
 386   static function &getById($id, $groupName = 'label_format') {
 387     return self::getLabelFormat('id', $id, $groupName);
 388   }
 389
 390   /**
 391    * Get Label Format field from associative array
 392    *
 393    * @param string $field name of a label format field
 394    * @param array (reference) $values associative array of name/value pairs containing
 395    *                                           label format field selections
 396    *
 397    * @param null $default
 398    *
 399    * @return value
 400    * @access public
 401    * @static
 402    */
 403   static function getValue($field, &$values, $default = NULL) {
 404     if (array_key_exists($field, self::$optionValueFields)) {
 405       switch (self::$optionValueFields[$field]['type']) {
 406         case CRM_Utils_Type::T_INT:
 407           return (int)CRM_Utils_Array::value($field, $values, $default);
 408
 409         case CRM_Utils_Type::T_FLOAT:
 410           // Round float values to three decimal places and trim trailing zeros.
 411           // Add a leading zero to values less than 1.
 412           $f = sprintf('%05.3f', $values[$field]);
 413           $f = rtrim($f, '0');
 414           $f = rtrim($f, '.');
 415           return (float)(empty($f) ? '0' : $f);
 416       }
 417       return CRM_Utils_Array::value($field, $values, $default);
 418     }
 419     return $default;
 420   }
 421
 422   /**
 423    * Takes a bunch of params that are needed to match certain criteria and
 424    * retrieves the relevant objects. Typically the valid params are only
 425    * label id. It also stores all the retrieved values in the default array.
 426    *
 427    * @param array $params (reference ) an assoc array of name/value pairs
 428    * @param array $values (reference ) an assoc array to hold the flattened values
 429    *
 430    * @param string $groupName
 431    *
 432    * @return CRM_Core_DAO_OptionValue object
 433    * @access public
 434    * @static
 435    */
 436   static function retrieve(&$params, &$values, $groupName='label_format') {
 437     $optionValue = new CRM_Core_DAO_OptionValue();
 438     $optionValue->copyValues($params);
 439     $optionValue->option_group_id = self::_getGid($groupName);
 440     if ($optionValue->find(TRUE)) {
 441       // Extract fields that have been serialized in the 'value' column of the Option Value table.
 442       $values = json_decode($optionValue->value, TRUE);
 443       // Add any new fields that don't yet exist in the saved values.
 444       foreach (self::$optionValueFields as $name => $field) {
 445         if (!isset($values[$name])) {
 446           $values[$name] = $field['default'];
 447           if ($field['metric']) {
 448             $values[$name] = CRM_Utils_PDF_Utils::convertMetric($field['default'],
 449               self::$optionValueFields['metric']['default'],
 450               $values['metric'], 3
 451             );
 452           }
 453         }
 454       }
 455       // Add fields from the OptionValue base class
 456       CRM_Core_DAO::storeValues($optionValue, $values);
 457       return $optionValue;
 458     }
 459     return NULL;
 460   }
 461
 462   /**
 463    * Return the name of the group for customized labels
 464    *
 465    * @param void
 466    *
 467    * @return void
 468    * @access public
 469    */
 470   public static function customGroupName() {
 471     return ts('Custom');
 472   }
 473
 474   /**
 475    * Save the Label Format in the DB
 476    *
 477    * @param array (reference)   $values    associative array of name/value pairs
 478    * @param int                 $id        id of the database record (null = new record)
 479    * @param string $groupName   group name of the label format
 480    *
 481    * @return void
 482    * @access public
 483    */
 484   function saveLabelFormat(&$values, $id = NULL, $groupName = 'label_format') {
 485     // get the Option Group ID for Label Formats (create one if it doesn't exist)
 486     $group_id = self::_getGid($groupName);
 487
 488     // clear other default if this is the new default label format
 489     if ($values['is_default']) {
 490       $query = "UPDATE civicrm_option_value SET is_default = 0 WHERE option_group_id = $group_id";
 491       CRM_Core_DAO::executeQuery($query, CRM_Core_DAO::$_nullArray);
 492     }
 493     if ($id) {
 494       // fetch existing record
 495       $this->id = $id;
 496       if ($this->find()) {
 497         $this->fetch();
 498       }
 499     }
 500     else {
 501       // new record
 502       $list = self::getList(TRUE,$groupName);
 503       $cnt = 1;
 504       while (array_key_exists("custom_$cnt", $list)) $cnt++;
 505       $values['name'] = "custom_$cnt";
 506       $values['grouping'] = self::customGroupName();
 507     }
 508     // copy the supplied form values to the corresponding Option Value fields in the base class
 509     foreach ($this->fields() as $name => $field) {
 510       $this->$name = trim(CRM_Utils_Array::value($name, $values, $this->$name));
 511       if (empty($this->$name)) {
 512         $this->$name = 'null';
 513       }
 514     }
 515     $this->id = $id;
 516     $this->option_group_id = $group_id;
 517     $this->is_active = 1;
 518
 519     // serialize label format fields into a single string to store in the 'value' column of the Option Value table
 520     $v = json_decode($this->value, TRUE);
 521     foreach (self::$optionValueFields as $name => $field) {
 522       if (!isset($v[$name])) {
 523         $v[$name] = NULL;
 524       }
 525       $v[$name] = self::getValue($name, $values, $v[$name]);
 526     }
 527     $this->value = json_encode($v);
 528
 529     // make sure serialized array will fit in the 'value' column
 530     $attribute = CRM_Core_DAO::getAttribute('CRM_Core_BAO_LabelFormat', 'value');
 531     if (strlen($this->value) > $attribute['maxlength']) {
 532       CRM_Core_Error::fatal(ts('Label Format does not fit in database.'));
 533     }
 534     $this->save();
 535
 536     // fix duplicate weights
 537     $filter = array('option_group_id' => self::_getGid());
 538     CRM_Utils_Weight::correctDuplicateWeights('CRM_Core_DAO_OptionValue', $filter);
 539   }
 540
 541   /**
 542    * Delete a Label Format
 543    *
 544    * @param  int  $id     ID of the label format to be deleted.
 545    * @param  string $groupName group name
 546    * @access public
 547    * @static
 548    */
 549   static function del($id, $groupName) {
 550     if ($id) {
 551       $dao = new CRM_Core_DAO_OptionValue();
 552       $dao->id = $id;
 553       if ($dao->find(TRUE)) {
 554         if ($dao->option_group_id == self::_getGid($groupName)) {
 555           $filter = array('option_group_id' => self::_getGid($groupName));
 556           CRM_Utils_Weight::delWeight('CRM_Core_DAO_OptionValue', $id, $filter);
 557           $dao->delete();
 558           return;
 559         }
 560       }
 561     }
 562     CRM_Core_Error::fatal(ts('Invalid value passed to delete function.'));
 563   }
 564 }
 565