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