CRM/Core/BAO/LabelFormat.php

   1 <?php
   2 /*
   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.                                    |
  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
 163    *   array of page orientations
 164    */
 165   public static function getPageOrientations() {
 166     return array(
 167       'portrait' => ts('Portrait'),
 168       'landscape' => ts('Landscape'),
 169     );
 170   }
 171
 172   /**
 173    * Get font names supported by the TCPDF package used to create PDF labels.
 174    *
 175    * @param string $name
 176    *   Group name.
 177    *
 178    * @return array
 179    *   array of font names
 180    */
 181   public static function getFontNames($name = 'label_format') {
 182     $label = new CRM_Utils_PDF_Label(self::getDefaultValues($name));
 183     return $label->getFontNames();
 184   }
 185
 186   /**
 187    * Get font sizes supported by the TCPDF package used to create PDF labels.
 188    *
 189    * @param void
 190    *
 191    * @return array
 192    *   array of font sizes
 193    */
 194   public static function getFontSizes() {
 195     $fontSizes = array();
 196     for ($i = 6; $i <= 60; $i++) {
 197       $fontSizes[$i] = ts('%1 pt', array(1 => $i));
 198     }
 199
 200     return $fontSizes;
 201   }
 202
 203   /**
 204    * Get measurement units recognized by the TCPDF package used to create PDF labels.
 205    *
 206    * @param void
 207    *
 208    * @return array
 209    *   array of measurement units
 210    */
 211   public static function getUnits() {
 212     return array(
 213       'in' => ts('Inches'),
 214       'cm' => ts('Centimeters'),
 215       'mm' => ts('Millimeters'),
 216       'pt' => ts('Points'),
 217     );
 218   }
 219
 220   /**
 221    * Get text alignment recognized by the TCPDF package used to create PDF labels.
 222    *
 223    * @param void
 224    *
 225    * @return array
 226    *   array of alignments
 227    */
 228   public static function getTextAlignments() {
 229     return array(
 230       'R' => ts('Right'),
 231       'L' => ts('Left'),
 232       'C' => ts('Center'),
 233     );
 234   }
 235
 236   /**
 237    * Get text alignment recognized by the TCPDF package used to create PDF labels.
 238    *
 239    * @param void
 240    *
 241    * @return array
 242    *   array of alignments
 243    */
 244   public static function getFontStyles() {
 245     return array(
 246       '' => ts('Normal'),
 247       'B' => ts('Bold'),
 248       'I' => ts('Italic'),
 249     );
 250   }
 251
 252   /**
 253    * Get Option Group ID for Label Formats
 254    *
 255    * @param string $name
 256    *
 257    * @return int
 258    *   Group ID (null if Group ID doesn't exist)
 259    */
 260   private static function _getGid($name = 'label_format') {
 261     if (!isset(self::$_gid[$name]) || !self::$_gid[$name]) {
 262       self::$_gid[$name] = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', $name, 'id', 'name');
 263       if (!self::$_gid[$name]) {
 264         CRM_Core_Error::fatal(ts('Label Format Option Group not found in database.'));
 265       }
 266     }
 267     return self::$_gid[$name];
 268   }
 269
 270   /**
 271    * Add ordering fields to Label Format list
 272    *
 273    * @param array (reference) $list List of Label Formats
 274    * @param string $returnURL
 275    *   URL of page calling this function.
 276    *
 277    * @return array
 278    *   (reference)   List of Label Formats
 279    */
 280   public static function addOrder(&$list, $returnURL) {
 281     $filter = "option_group_id = " . self::_getGid();
 282     CRM_Utils_Weight::addOrder($list, 'CRM_Core_DAO_OptionValue', 'id', $returnURL, $filter);
 283   }
 284
 285   /**
 286    * Retrieve list of Label Formats.
 287    *
 288    * @param bool $namesOnly
 289    *   Return simple list of names.
 290    * @param string $groupName
 291    *   Group name of the label format option group.
 292    *
 293    * @return array
 294    *   (reference)   label format list
 295    */
 296   public static function &getList($namesOnly = FALSE, $groupName = 'label_format') {
 297     static $list = array();
 298     if (self::_getGid($groupName)) {
 299       // get saved label formats from Option Value table
 300       $dao = new CRM_Core_DAO_OptionValue();
 301       $dao->option_group_id = self::_getGid($groupName);
 302       $dao->is_active = 1;
 303       $dao->orderBy('weight');
 304       $dao->find();
 305       while ($dao->fetch()) {
 306         if ($namesOnly) {
 307           $list[$groupName][$dao->name] = $dao->label;
 308         }
 309         else {
 310           CRM_Core_DAO::storeValues($dao, $list[$groupName][$dao->id]);
 311         }
 312       }
 313     }
 314     return $list[$groupName];
 315   }
 316
 317   /**
 318    * Retrieve the default Label Format values
 319    *
 320    * @param string $groupName
 321    *   Label format group name.
 322    *
 323    * @return array
 324    *   Name/value pairs containing the default Label Format values.
 325    */
 326   public static function &getDefaultValues($groupName = 'label_format') {
 327     $params = array('is_active' => 1, 'is_default' => 1);
 328     $defaults = array();
 329     if (!self::retrieve($params, $defaults, $groupName)) {
 330       foreach (self::$optionValueFields as $name => $field) {
 331         $defaults[$name] = $field['default'];
 332       }
 333       $filter = array('option_group_id' => self::_getGid($groupName));
 334       $defaults['weight'] = CRM_Utils_Weight::getDefaultWeight('CRM_Core_DAO_OptionValue', $filter);
 335     }
 336     return $defaults;
 337   }
 338
 339   /**
 340    * Get Label Format from the DB
 341    *
 342    * @param string $field
 343    *   Field name to search by.
 344    * @param int $val
 345    *   Field value to search for.
 346    *
 347    * @param string $groupName
 348    *
 349    * @return array
 350    *   (reference) associative array of name/value pairs
 351    */
 352   public static function &getLabelFormat($field, $val, $groupName = 'label_format') {
 353     $params = array('is_active' => 1, $field => $val);
 354     $labelFormat = array();
 355     if (self::retrieve($params, $labelFormat, $groupName)) {
 356       return $labelFormat;
 357     }
 358     else {
 359       return self::getDefaultValues($groupName);
 360     }
 361   }
 362
 363   /**
 364    * Get Label Format by Name
 365    *
 366    * @param int $name
 367    *   Label format name. Empty = get default label format.
 368    *
 369    * @return array
 370    *   (reference) associative array of name/value pairs
 371    */
 372   public static function &getByName($name) {
 373     return self::getLabelFormat('name', $name);
 374   }
 375
 376   /**
 377    * Get Label Format by ID
 378    *
 379    * @param int $id
 380    *   Label format id. 0 = get default label format.
 381    * @param string $groupName
 382    *   Group name.
 383    *
 384    * @return array
 385    *   (reference) associative array of name/value pairs
 386    */
 387   public static function &getById($id, $groupName = 'label_format') {
 388     return self::getLabelFormat('id', $id, $groupName);
 389   }
 390
 391   /**
 392    * Get Label Format field from associative array
 393    *
 394    * @param string $field
 395    *   Name of a label format field.
 396    * @param array (reference) $values associative array of name/value pairs containing
 397    *                                           label format field selections
 398    *
 399    * @param null $default
 400    *
 401    * @return value
 402    */
 403   public 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
 428    *   (reference ) an assoc array of name/value pairs.
 429    * @param array $values
 430    *   (reference ) an assoc array to hold the flattened values.
 431    *
 432    * @param string $groupName
 433    *
 434    * @return CRM_Core_DAO_OptionValue
 435    */
 436   public 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    */
 469   public static function customGroupName() {
 470     return ts('Custom');
 471   }
 472
 473   /**
 474    * Save the Label Format in the DB
 475    *
 476    * @param array (reference) $values associative array of name/value pairs
 477    * @param int $id
 478    *   Id of the database record (null = new record).
 479    * @param string $groupName
 480    *   Group name of the label format.
 481    *
 482    * @return void
 483    */
 484   public 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)) {
 505         $cnt++;
 506       }
 507       $values['name'] = "custom_$cnt";
 508       $values['grouping'] = self::customGroupName();
 509     }
 510     // copy the supplied form values to the corresponding Option Value fields in the base class
 511     foreach ($this->fields() as $name => $field) {
 512       $this->$name = trim(CRM_Utils_Array::value($name, $values, $this->$name));
 513       if (empty($this->$name)) {
 514         $this->$name = 'null';
 515       }
 516     }
 517     $this->id = $id;
 518     $this->option_group_id = $group_id;
 519     $this->is_active = 1;
 520
 521     // serialize label format fields into a single string to store in the 'value' column of the Option Value table
 522     $v = json_decode($this->value, TRUE);
 523     foreach (self::$optionValueFields as $name => $field) {
 524       if (!isset($v[$name])) {
 525         $v[$name] = NULL;
 526       }
 527       $v[$name] = self::getValue($name, $values, $v[$name]);
 528     }
 529     $this->value = json_encode($v);
 530
 531     // make sure serialized array will fit in the 'value' column
 532     $attribute = CRM_Core_DAO::getAttribute('CRM_Core_BAO_LabelFormat', 'value');
 533     if (strlen($this->value) > $attribute['maxlength']) {
 534       CRM_Core_Error::fatal(ts('Label Format does not fit in database.'));
 535     }
 536     $this->save();
 537
 538     // fix duplicate weights
 539     $filter = array('option_group_id' => self::_getGid());
 540     CRM_Utils_Weight::correctDuplicateWeights('CRM_Core_DAO_OptionValue', $filter);
 541   }
 542
 543   /**
 544    * Delete a Label Format
 545    *
 546    * @param int $id
 547    *   ID of the label format to be deleted.
 548    * @param string $groupName
 549    *   Group name.
 550    */
 551   public static function del($id, $groupName) {
 552     if ($id) {
 553       $dao = new CRM_Core_DAO_OptionValue();
 554       $dao->id = $id;
 555       if ($dao->find(TRUE)) {
 556         if ($dao->option_group_id == self::_getGid($groupName)) {
 557           $filter = array('option_group_id' => self::_getGid($groupName));
 558           CRM_Utils_Weight::delWeight('CRM_Core_DAO_OptionValue', $id, $filter);
 559           $dao->delete();
 560           return;
 561         }
 562       }
 563     }
 564     CRM_Core_Error::fatal(ts('Invalid value passed to delete function.'));
 565   }
 566 }