CRM/Core/BAO/LabelFormat.php

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