CRM/Core/BAO/PdfFormat.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 PDF Page Formats
  39  */
  40 class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue {
  41
  42   /**
  43    * Static holder for the PDF Page Formats Option Group ID
  44    */
  45   private static $_gid = NULL;
  46
  47   /**
  48    * PDF Page Format fields stored in the 'value' field of the Option Value table.
  49    */
  50   private static $optionValueFields = array(
  51     'paper_size' => array(
  52       'name' => 'paper_size',
  53       'type' => CRM_Utils_Type::T_STRING,
  54       'default' => 'letter',
  55     ),
  56     'stationery' => array(
  57       'name' => 'stationery',
  58       'type' => CRM_Utils_Type::T_STRING,
  59       'default' => '',
  60     ),
  61     'orientation' => array(
  62       'name' => 'orientation',
  63       'type' => CRM_Utils_Type::T_STRING,
  64       'default' => 'portrait',
  65     ),
  66     'metric' => array(
  67       'name' => 'metric',
  68       'type' => CRM_Utils_Type::T_STRING,
  69       'default' => 'in',
  70     ),
  71     'margin_top' => array(
  72       'name' => 'margin_top',
  73       'type' => CRM_Utils_Type::T_FLOAT,
  74       'metric' => TRUE,
  75       'default' => 0.75,
  76     ),
  77     'margin_bottom' => array(
  78       'name' => 'margin_bottom',
  79       'type' => CRM_Utils_Type::T_FLOAT,
  80       'metric' => TRUE,
  81       'default' => 0.75,
  82     ),
  83     'margin_left' => array(
  84       'name' => 'margin_left',
  85       'type' => CRM_Utils_Type::T_FLOAT,
  86       'metric' => TRUE,
  87       'default' => 0.75,
  88     ),
  89     'margin_right' => array(
  90       'name' => 'margin_right',
  91       'type' => CRM_Utils_Type::T_FLOAT,
  92       'metric' => TRUE,
  93       'default' => 0.75,
  94     ),
  95   );
  96
  97   /**
  98    * Get page orientations recognized by the DOMPDF package used to create PDF letters.
  99    *
 100    * @param void
 101    *
 102    * @return array
 103    *   array of page orientations
 104    */
 105   public static function getPageOrientations() {
 106     return array(
 107       'portrait' => ts('Portrait'),
 108       'landscape' => ts('Landscape'),
 109     );
 110   }
 111
 112   /**
 113    * Get measurement units recognized by the DOMPDF package used to create PDF letters.
 114    *
 115    * @param void
 116    *
 117    * @return array
 118    *   array of measurement units
 119    */
 120   public static function getUnits() {
 121     return array(
 122       'in' => ts('Inches'),
 123       'cm' => ts('Centimeters'),
 124       'mm' => ts('Millimeters'),
 125       'pt' => ts('Points'),
 126     );
 127   }
 128
 129   /**
 130    * Get Option Group ID for PDF Page Formats
 131    *
 132    * @param void
 133    *
 134    * @return int
 135    *   Group ID (null if Group ID doesn't exist)
 136    */
 137   private static function _getGid() {
 138     if (!self::$_gid) {
 139       self::$_gid = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', 'pdf_format', 'id', 'name');
 140       if (!self::$_gid) {
 141         CRM_Core_Error::fatal(ts('PDF Format Option Group not found in database.'));
 142       }
 143     }
 144     return self::$_gid;
 145   }
 146
 147   /**
 148    * Add ordering fields to Page Format list
 149    *
 150    * @param array (reference) $list List of PDF Page Formats
 151    * @param string $returnURL
 152    *   URL of page calling this function.
 153    *
 154    * @return void
 155    * @static
 156    */
 157   public static function addOrder(&$list, $returnURL) {
 158     $filter = "option_group_id = " . self::_getGid();
 159     CRM_Utils_Weight::addOrder($list, 'CRM_Core_DAO_OptionValue', 'id', $returnURL, $filter);
 160   }
 161
 162   /**
 163    * Get list of PDF Page Formats.
 164    *
 165    * @param bool $namesOnly
 166    *   Return simple list of names.
 167    *
 168    * @return array
 169    *   (reference)   PDF Page Format list
 170    * @static
 171    */
 172   public static function &getList($namesOnly = FALSE) {
 173     static $list = array();
 174     if (self::_getGid()) {
 175       // get saved PDF Page Formats from Option Value table
 176       $dao = new CRM_Core_DAO_OptionValue();
 177       $dao->option_group_id = self::_getGid();
 178       $dao->is_active = 1;
 179       $dao->orderBy('weight');
 180       $dao->find();
 181       while ($dao->fetch()) {
 182         if ($namesOnly) {
 183           $list[$dao->id] = $dao->name;
 184         }
 185         else {
 186           CRM_Core_DAO::storeValues($dao, $list[$dao->id]);
 187         }
 188       }
 189     }
 190     return $list;
 191   }
 192
 193   /**
 194    * Get the default PDF Page Format values
 195    *
 196    * @param NULL
 197    *
 198    * @return array
 199    *   Name/value pairs containing the default PDF Page Format values.
 200    * @static
 201    */
 202   public static function &getDefaultValues() {
 203     $params = array('is_active' => 1, 'is_default' => 1);
 204     $defaults = array();
 205     if (!self::retrieve($params, $defaults)) {
 206       foreach (self::$optionValueFields as $name => $field) {
 207         $defaults[$name] = $field['default'];
 208       }
 209       $filter = array('option_group_id' => self::_getGid());
 210       $defaults['weight'] = CRM_Utils_Weight::getDefaultWeight('CRM_Core_DAO_OptionValue', $filter);
 211
 212       // also set the id to avoid NOTICES, CRM-8454
 213       $defaults['id'] = NULL;
 214     }
 215     return $defaults;
 216   }
 217
 218   /**
 219    * Get PDF Page Format from the DB
 220    *
 221    * @param string $field
 222    *   Field name to search by.
 223    * @param int $val
 224    *   Field value to search for.
 225    *
 226    * @return array
 227    *   (reference) associative array of name/value pairs
 228    */
 229   public static function &getPdfFormat($field, $val) {
 230     $params = array('is_active' => 1, $field => $val);
 231     $pdfFormat = array();
 232     if (self::retrieve($params, $pdfFormat)) {
 233       return $pdfFormat;
 234     }
 235     else {
 236       return self::getDefaultValues();
 237     }
 238   }
 239
 240   /**
 241    * Get PDF Page Format by Name
 242    *
 243    * @param int $name
 244    *   PDF Page Format name. Empty = get default PDF Page Format.
 245    *
 246    * @return array
 247    *   (reference) associative array of name/value pairs
 248    */
 249   public static function &getByName($name) {
 250     return self::getPdfFormat('name', $name);
 251   }
 252
 253   /**
 254    * Get PDF Page Format by ID
 255    *
 256    * @param int $id
 257    *   PDF Page Format id. 0 = get default PDF Page Format.
 258    *
 259    * @return array
 260    *   (reference) associative array of name/value pairs
 261    */
 262   public static function &getById($id) {
 263     return self::getPdfFormat('id', $id);
 264   }
 265
 266   /**
 267    * Get PDF Page Format field from associative array
 268    *
 269    * @param string $field
 270    *   Name of a PDF Page Format field.
 271    * @param array (reference) $values associative array of name/value pairs containing
 272    *                                           PDF Page Format field selections
 273    *
 274    * @param null $default
 275    *
 276    * @return value
 277    * @static
 278    */
 279   public static function getValue($field, &$values, $default = NULL) {
 280     if (array_key_exists($field, self::$optionValueFields)) {
 281       switch (self::$optionValueFields[$field]['type']) {
 282         case CRM_Utils_Type::T_INT:
 283           return (int) CRM_Utils_Array::value($field, $values, $default);
 284
 285         case CRM_Utils_Type::T_FLOAT:
 286           // Round float values to three decimal places and trim trailing zeros.
 287           // Add a leading zero to values less than 1.
 288           $f = sprintf('%05.3f', $values[$field]);
 289           $f = rtrim($f, '0');
 290           $f = rtrim($f, '.');
 291           return (float) (empty($f) ? '0' : $f);
 292       }
 293       return CRM_Utils_Array::value($field, $values, $default);
 294     }
 295     return $default;
 296   }
 297
 298   /**
 299    * Takes a bunch of params that are needed to match certain criteria and
 300    * retrieves the relevant objects. Typically the valid params are only
 301    * format id. It also stores all the retrieved values in the default array.
 302    *
 303    * @param array $params
 304    *   (reference ) an assoc array of name/value pairs.
 305    * @param array $values
 306    *   (reference ) an assoc array to hold the flattened values.
 307    *
 308    * @return CRM_Core_DAO_OptionValue
 309    * @static
 310    */
 311   public static function retrieve(&$params, &$values) {
 312     $optionValue = new CRM_Core_DAO_OptionValue();
 313     $optionValue->copyValues($params);
 314     $optionValue->option_group_id = self::_getGid();
 315     if ($optionValue->find(TRUE)) {
 316       // Extract fields that have been serialized in the 'value' column of the Option Value table.
 317       $values = json_decode($optionValue->value, TRUE);
 318       // Add any new fields that don't yet exist in the saved values.
 319       foreach (self::$optionValueFields as $name => $field) {
 320         if (!isset($values[$name])) {
 321           $values[$name] = $field['default'];
 322           if ($field['metric']) {
 323             $values[$name] = CRM_Utils_PDF_Utils::convertMetric($field['default'],
 324               self::$optionValueFields['metric']['default'],
 325               $values['metric'], 3
 326             );
 327           }
 328         }
 329       }
 330       // Add fields from the OptionValue base class
 331       CRM_Core_DAO::storeValues($optionValue, $values);
 332       return $optionValue;
 333     }
 334     return NULL;
 335   }
 336
 337   /**
 338    * Save the PDF Page Format in the DB
 339    *
 340    * @param array (reference) $values associative array of name/value pairs
 341    * @param int $id
 342    *   Id of the database record (null = new record).
 343    *
 344    * @return void
 345    */
 346   public function savePdfFormat(&$values, $id = NULL) {
 347     // get the Option Group ID for PDF Page Formats (create one if it doesn't exist)
 348     $group_id = self::_getGid();
 349
 350     // clear other default if this is the new default PDF Page Format
 351     if ($values['is_default']) {
 352       $query = "UPDATE civicrm_option_value SET is_default = 0 WHERE option_group_id = $group_id";
 353       CRM_Core_DAO::executeQuery($query, CRM_Core_DAO::$_nullArray);
 354     }
 355     if ($id) {
 356       // fetch existing record
 357       $this->id = $id;
 358       if ($this->find()) {
 359         $this->fetch();
 360       }
 361     }
 362     // copy the supplied form values to the corresponding Option Value fields in the base class
 363     foreach ($this->fields() as $name => $field) {
 364       $this->$name = trim(CRM_Utils_Array::value($name, $values, $this->$name));
 365       if (empty($this->$name)) {
 366         $this->$name = 'null';
 367       }
 368     }
 369     $this->id = $id;
 370     $this->option_group_id = $group_id;
 371     $this->label = $this->name;
 372     $this->is_active = 1;
 373
 374     // serialize PDF Page Format fields into a single string to store in the 'value' column of the Option Value table
 375     $v = json_decode($this->value, TRUE);
 376     foreach (self::$optionValueFields as $name => $field) {
 377       $v[$name] = self::getValue($name, $values, CRM_Utils_Array::value($name, $v));
 378     }
 379     $this->value = json_encode($v);
 380
 381     // make sure serialized array will fit in the 'value' column
 382     $attribute = CRM_Core_DAO::getAttribute('CRM_Core_BAO_PdfFormat', 'value');
 383     if (strlen($this->value) > $attribute['maxlength']) {
 384       CRM_Core_Error::fatal(ts('PDF Page Format does not fit in database.'));
 385     }
 386     $this->save();
 387
 388     // fix duplicate weights
 389     $filter = array('option_group_id' => self::_getGid());
 390     CRM_Utils_Weight::correctDuplicateWeights('CRM_Core_DAO_OptionValue', $filter);
 391   }
 392
 393   /**
 394    * Delete a PDF Page Format
 395    *
 396    * @param int $id
 397    *   ID of the PDF Page Format to be deleted.
 398    *
 399    * @static
 400    */
 401   public static function del($id) {
 402     if ($id) {
 403       $dao = new CRM_Core_DAO_OptionValue();
 404       $dao->id = $id;
 405       if ($dao->find(TRUE)) {
 406         if ($dao->option_group_id == self::_getGid()) {
 407           $filter = array('option_group_id' => self::_getGid());
 408           CRM_Utils_Weight::delWeight('CRM_Core_DAO_OptionValue', $id, $filter);
 409           $dao->delete();
 410           return;
 411         }
 412       }
 413     }
 414     CRM_Core_Error::fatal(ts('Invalid value passed to delete function.'));
 415   }
 416 }