CRM/Core/BAO/LabelFormat.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   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-2013
  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     return array(
 198       6 => ts('6 pt'),
 199       7 => ts('7 pt'),
 200       8 => ts('8 pt'),
 201       9 => ts('9 pt'),
 202       10 => ts('10 pt'),
 203       11 => ts('11 pt'),
 204       12 => ts('12 pt'),
 205       13 => ts('13 pt'),
 206       14 => ts('14 pt'),
 207       15 => ts('15 pt'),
 208     );
 209   }
 210
 211   /**
 212    * Get measurement units recognized by the TCPDF package used to create PDF labels.
 213    *
 214    * @param void
 215    *
 216    * @return array   array of measurement units
 217    * @access public
 218    * @static
 219    */
 220   public static function getUnits() {
 221     return array(
 222       'in' => ts('Inches'),
 223       'cm' => ts('Centimeters'),
 224       'mm' => ts('Millimeters'),
 225       'pt' => ts('Points'),
 226     );
 227   }
 228
 229   /**
 230    * Get Option Group ID for Label Formats
 231    *
 232    * @param void
 233    *
 234    * @return int  Group ID (null if Group ID doesn't exist)
 235    * @access private
 236    */
 237   private static function _getGid($name='label_format') {
 238     if (!isset(self::$_gid[$name]) || !self::$_gid[$name]) {
 239       self::$_gid[$name] = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', $name, 'id', 'name');
 240       if (!self::$_gid[$name]) {
 241         CRM_Core_Error::fatal(ts('Label Format Option Group not found in database.'));
 242       }
 243     }
 244     return self::$_gid[$name];
 245   }
 246
 247   /**
 248    * Add ordering fields to Label Format list
 249    *
 250    * @param array (reference)   $list         List of Label Formats
 251    * @param string              $returnURL    URL of page calling this function
 252    *
 253    * @return array  (reference)   List of Label Formats
 254    * @static
 255    * @access public
 256    */
 257   static function addOrder(&$list, $returnURL) {
 258     $filter = "option_group_id = " . self::_getGid();
 259     CRM_Utils_Weight::addOrder($list, 'CRM_Core_DAO_OptionValue', 'id', $returnURL, $filter);
 260   }
 261
 262   /**
 263    * Retrieve list of Label Formats.
 264    *
 265    * @param bool    $namesOnly    return simple list of names
 266    * @param string  $groupName    group name of the label format option group
 267    *
 268    * @return array  (reference)   label format list
 269    * @static
 270    * @access public
 271    */
 272   static function &getList($namesOnly = FALSE, $groupName='label_format') {
 273     static $list = array();
 274     if (self::_getGid($groupName)) {
 275       // get saved label formats from Option Value table
 276       $dao = new CRM_Core_DAO_OptionValue();
 277       $dao->option_group_id = self::_getGid($groupName);
 278       $dao->is_active = 1;
 279       $dao->orderBy('weight');
 280       $dao->find();
 281       while ($dao->fetch()) {
 282         if ($namesOnly) {
 283           $list[$groupName][$dao->name] = $dao->label;
 284         }
 285         else {
 286           CRM_Core_DAO::storeValues($dao, $list[$groupName][$dao->id]);
 287         }
 288       }
 289     }
 290     return $list[$groupName];
 291   }
 292
 293   /**
 294    * retrieve the default Label Format values
 295    *
 296    * @param string $groupName label format group name
 297    *
 298    * @return array   Name/value pairs containing the default Label Format values.
 299    * @static
 300    * @access public
 301    */
 302   static function &getDefaultValues($groupName = 'label_format') {
 303     $params = array('is_active' => 1, 'is_default' => 1);
 304     $defaults = array();
 305     if (!self::retrieve($params, $defaults, $groupName)) {
 306       foreach (self::$optionValueFields as $name => $field) {
 307         $defaults[$name] = $field['default'];
 308       }
 309       $filter = array('option_group_id' => self::_getGid($groupName));
 310       $defaults['weight'] = CRM_Utils_Weight::getDefaultWeight('CRM_Core_DAO_OptionValue', $filter);
 311     }
 312     return $defaults;
 313   }
 314
 315   /**
 316    * Get Label Format from the DB
 317    *
 318    * @param string $field   Field name to search by
 319    * @param int    $val     Field value to search for
 320    *
 321    * @return array  $values (reference) associative array of name/value pairs
 322    * @access public
 323    */
 324   static function &getLabelFormat($field, $val, $groupName = 'label_format') {
 325     $params = array('is_active' => 1, $field => $val);
 326     $labelFormat = array();
 327     if (self::retrieve($params, $labelFormat, $groupName)) {
 328       return $labelFormat;
 329     }
 330     else {
 331       return self::getDefaultValues($groupName);
 332     }
 333   }
 334
 335   /**
 336    * Get Label Format by Name
 337    *
 338    * @param int    $name   Label format name. Empty = get default label format
 339    *
 340    * @return array  $values (reference) associative array of name/value pairs
 341    * @access public
 342    */
 343   static function &getByName($name) {
 344     return self::getLabelFormat('name', $name);
 345   }
 346
 347   /**
 348    * Get Label Format by ID
 349    *
 350    * @param int    $id   label format id. 0 = get default label format
 351    * @param string $groupName group name
 352    *
 353    * @return array  $values (reference) associative array of name/value pairs
 354    * @access public
 355    */
 356   static function &getById($id, $groupName = 'label_format') {
 357     return self::getLabelFormat('id', $id, $groupName);
 358   }
 359
 360   /**
 361    * Get Label Format field from associative array
 362    *
 363    * @param string              $field         name of a label format field
 364    * @param array (reference)   $values        associative array of name/value pairs containing
 365    *                                           label format field selections
 366    *
 367    * @return value
 368    * @access public
 369    * @static
 370    */
 371   static function getValue($field, &$values, $default = NULL) {
 372     if (array_key_exists($field, self::$optionValueFields)) {
 373       switch (self::$optionValueFields[$field]['type']) {
 374         case CRM_Utils_Type::T_INT:
 375           return (int)CRM_Utils_Array::value($field, $values, $default);
 376
 377         case CRM_Utils_Type::T_FLOAT:
 378           // Round float values to three decimal places and trim trailing zeros.
 379           // Add a leading zero to values less than 1.
 380           $f = sprintf('%05.3f', $values[$field]);
 381           $f = rtrim($f, '0');
 382           $f = rtrim($f, '.');
 383           return (float)(empty($f) ? '0' : $f);
 384       }
 385       return CRM_Utils_Array::value($field, $values, $default);
 386     }
 387     return $default;
 388   }
 389
 390   /**
 391    * Takes a bunch of params that are needed to match certain criteria and
 392    * retrieves the relevant objects. Typically the valid params are only
 393    * label id. It also stores all the retrieved values in the default array.
 394    *
 395    * @param array $params   (reference ) an assoc array of name/value pairs
 396    * @param array $values   (reference ) an assoc array to hold the flattened values
 397    *
 398    * @return object CRM_Core_DAO_OptionValue object
 399    * @access public
 400    * @static
 401    */
 402   static function retrieve(&$params, &$values, $groupName='label_format') {
 403     $optionValue = new CRM_Core_DAO_OptionValue();
 404     $optionValue->copyValues($params);
 405     $optionValue->option_group_id = self::_getGid($groupName);
 406     if ($optionValue->find(TRUE)) {
 407       // Extract fields that have been serialized in the 'value' column of the Option Value table.
 408       $values = json_decode($optionValue->value, TRUE);
 409       // Add any new fields that don't yet exist in the saved values.
 410       foreach (self::$optionValueFields as $name => $field) {
 411         if (!isset($values[$name])) {
 412           $values[$name] = $field['default'];
 413           if ($field['metric']) {
 414             $values[$name] = CRM_Utils_PDF_Utils::convertMetric($field['default'],
 415               self::$optionValueFields['metric']['default'],
 416               $values['metric'], 3
 417             );
 418           }
 419         }
 420       }
 421       // Add fields from the OptionValue base class
 422       CRM_Core_DAO::storeValues($optionValue, $values);
 423       return $optionValue;
 424     }
 425     return NULL;
 426   }
 427
 428   /**
 429    * Return the name of the group for customized labels
 430    *
 431    * @param void
 432    *
 433    * @return void
 434    * @access public
 435    */
 436   public static function customGroupName() {
 437     return ts('Custom');
 438   }
 439
 440   /**
 441    * Save the Label Format in the DB
 442    *
 443    * @param array (reference)   $values    associative array of name/value pairs
 444    * @param int                 $id        id of the database record (null = new record)
 445    * @param string $groupName   group name of the label format
 446    *
 447    * @return void
 448    * @access public
 449    */
 450   function saveLabelFormat(&$values, $id = NULL, $groupName = 'label_format') {
 451     // get the Option Group ID for Label Formats (create one if it doesn't exist)
 452     $group_id = self::_getGid($groupName);
 453
 454     // clear other default if this is the new default label format
 455     if ($values['is_default']) {
 456       $query = "UPDATE civicrm_option_value SET is_default = 0 WHERE option_group_id = $group_id";
 457       CRM_Core_DAO::executeQuery($query, CRM_Core_DAO::$_nullArray);
 458     }
 459     if ($id) {
 460       // fetch existing record
 461       $this->id = $id;
 462       if ($this->find()) {
 463         $this->fetch();
 464       }
 465     }
 466     else {
 467       // new record
 468       $list = self::getList(TRUE,$groupName);
 469       $cnt = 1;
 470       while (array_key_exists("custom_$cnt", $list)) $cnt++;
 471       $values['name'] = "custom_$cnt";
 472       $values['grouping'] = self::customGroupName();
 473     }
 474     // copy the supplied form values to the corresponding Option Value fields in the base class
 475     foreach ($this->fields() as $name => $field) {
 476       $this->$name = trim(CRM_Utils_Array::value($name, $values, $this->$name));
 477       if (empty($this->$name)) {
 478         $this->$name = 'null';
 479       }
 480     }
 481     $this->id = $id;
 482     $this->option_group_id = $group_id;
 483     $this->is_active = 1;
 484
 485     // serialize label format fields into a single string to store in the 'value' column of the Option Value table
 486     $v = json_decode($this->value, TRUE);
 487     foreach (self::$optionValueFields as $name => $field) {
 488       $v[$name] = self::getValue($name, $values, $v[$name]);
 489     }
 490     $this->value = json_encode($v);
 491
 492     // make sure serialized array will fit in the 'value' column
 493     $attribute = CRM_Core_DAO::getAttribute('CRM_Core_BAO_LabelFormat', 'value');
 494     if (strlen($this->value) > $attribute['maxlength']) {
 495       CRM_Core_Error::fatal(ts('Label Format does not fit in database.'));
 496     }
 497     $this->save();
 498
 499     // fix duplicate weights
 500     $filter = array('option_group_id' => self::_getGid());
 501     CRM_Utils_Weight::correctDuplicateWeights('CRM_Core_DAO_OptionValue', $filter);
 502   }
 503
 504   /**
 505    * Function to delete a Label Format
 506    *
 507    * @param  int  $id     ID of the label format to be deleted.
 508    * @param  string $groupName group name
 509    * @access public
 510    * @static
 511    */
 512   static function del($id, $groupName) {
 513     if ($id) {
 514       $dao = new CRM_Core_DAO_OptionValue();
 515       $dao->id = $id;
 516       if ($dao->find(TRUE)) {
 517         if ($dao->option_group_id == self::_getGid($groupName)) {
 518           $filter = array('option_group_id' => self::_getGid($groupName));
 519           CRM_Utils_Weight::delWeight('CRM_Core_DAO_OptionValue', $id, $filter);
 520           $dao->delete();
 521           return;
 522         }
 523       }
 524     }
 525     CRM_Core_Error::fatal(ts('Invalid value passed to delete function.'));
 526   }
 527 }
 528