3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.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. |
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. |
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. |
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 +--------------------------------------------------------------------+
32 * @copyright CiviCRM LLC (c) 2004-2014
38 * This class contains functions for managing PDF Page Formats
40 class CRM_Core_BAO_PdfFormat
extends CRM_Core_DAO_OptionValue
{
43 * static holder for the PDF Page Formats Option Group ID
45 private static $_gid = NULL;
48 * PDF Page Format fields stored in the 'value' field of the Option Value table.
50 private static $optionValueFields = array(
51 'paper_size' => array(
52 'name' => 'paper_size',
53 'type' => CRM_Utils_Type
::T_STRING
,
54 'default' => 'letter',
56 'orientation' => array(
57 'name' => 'orientation',
58 'type' => CRM_Utils_Type
::T_STRING
,
59 'default' => 'portrait',
63 'type' => CRM_Utils_Type
::T_STRING
,
66 'margin_top' => array(
67 'name' => 'margin_top',
68 'type' => CRM_Utils_Type
::T_FLOAT
,
72 'margin_bottom' => array(
73 'name' => 'margin_bottom',
74 'type' => CRM_Utils_Type
::T_FLOAT
,
78 'margin_left' => array(
79 'name' => 'margin_left',
80 'type' => CRM_Utils_Type
::T_FLOAT
,
84 'margin_right' => array(
85 'name' => 'margin_right',
86 'type' => CRM_Utils_Type
::T_FLOAT
,
93 * Get page orientations recognized by the DOMPDF package used to create PDF letters.
97 * @return array array of page orientations
100 public static function getPageOrientations() {
102 'portrait' => ts('Portrait'),
103 'landscape' => ts('Landscape'),
108 * Get measurement units recognized by the DOMPDF package used to create PDF letters.
112 * @return array array of measurement units
115 public static function getUnits() {
117 'in' => ts('Inches'),
118 'cm' => ts('Centimeters'),
119 'mm' => ts('Millimeters'),
120 'pt' => ts('Points'),
125 * Get Option Group ID for PDF Page Formats
129 * @return int Group ID (null if Group ID doesn't exist)
132 private static function _getGid() {
134 self
::$_gid = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', 'pdf_format', 'id', 'name');
136 CRM_Core_Error
::fatal(ts('PDF Format Option Group not found in database.'));
143 * Add ordering fields to Page Format list
145 * @param array (reference) $list List of PDF Page Formats
146 * @param string $returnURL URL of page calling this function
152 static function addOrder(&$list, $returnURL) {
153 $filter = "option_group_id = " . self
::_getGid();
154 CRM_Utils_Weight
::addOrder($list, 'CRM_Core_DAO_OptionValue', 'id', $returnURL, $filter);
158 * Get list of PDF Page Formats.
160 * @param bool $namesOnly return simple list of names
162 * @return array (reference) PDF Page Format list
166 static function &getList($namesOnly = FALSE) {
167 static $list = array();
168 if (self
::_getGid()) {
169 // get saved PDF Page Formats from Option Value table
170 $dao = new CRM_Core_DAO_OptionValue();
171 $dao->option_group_id
= self
::_getGid();
173 $dao->orderBy('weight');
175 while ($dao->fetch()) {
177 $list[$dao->id
] = $dao->name
;
180 CRM_Core_DAO
::storeValues($dao, $list[$dao->id
]);
188 * Get the default PDF Page Format values
192 * @return array Name/value pairs containing the default PDF Page Format values.
196 static function &getDefaultValues() {
197 $params = array('is_active' => 1, 'is_default' => 1);
199 if (!self
::retrieve($params, $defaults)) {
200 foreach (self
::$optionValueFields as $name => $field) {
201 $defaults[$name] = $field['default'];
203 $filter = array('option_group_id' => self
::_getGid());
204 $defaults['weight'] = CRM_Utils_Weight
::getDefaultWeight('CRM_Core_DAO_OptionValue', $filter);
206 // also set the id to avoid NOTICES, CRM-8454
207 $defaults['id'] = NULL;
213 * Get PDF Page Format from the DB
215 * @param string $field Field name to search by
216 * @param int $val Field value to search for
218 * @return array $values (reference) associative array of name/value pairs
221 static function &getPdfFormat($field, $val) {
222 $params = array('is_active' => 1, $field => $val);
223 $pdfFormat = array();
224 if (self
::retrieve($params, $pdfFormat)) {
228 return self
::getDefaultValues();
233 * Get PDF Page Format by Name
235 * @param int $name PDF Page Format name. Empty = get default PDF Page Format
237 * @return array $values (reference) associative array of name/value pairs
240 static function &getByName($name) {
241 return self
::getPdfFormat('name', $name);
245 * Get PDF Page Format by ID
247 * @param int $id PDF Page Format id. 0 = get default PDF Page Format
249 * @return array $values (reference) associative array of name/value pairs
252 static function &getById($id) {
253 return self
::getPdfFormat('id', $id);
257 * Get PDF Page Format field from associative array
259 * @param string $field 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
263 * @param null $default
269 static function getValue($field, &$values, $default = NULL) {
270 if (array_key_exists($field, self
::$optionValueFields)) {
271 switch (self
::$optionValueFields[$field]['type']) {
272 case CRM_Utils_Type
::T_INT
:
273 return (int)CRM_Utils_Array
::value($field, $values, $default);
275 case CRM_Utils_Type
::T_FLOAT
:
276 // Round float values to three decimal places and trim trailing zeros.
277 // Add a leading zero to values less than 1.
278 $f = sprintf('%05.3f', $values[$field]);
281 return (float)(empty($f) ?
'0' : $f);
283 return CRM_Utils_Array
::value($field, $values, $default);
289 * Takes a bunch of params that are needed to match certain criteria and
290 * retrieves the relevant objects. Typically the valid params are only
291 * format id. It also stores all the retrieved values in the default array.
293 * @param array $params (reference ) an assoc array of name/value pairs
294 * @param array $values (reference ) an assoc array to hold the flattened values
296 * @return object CRM_Core_DAO_OptionValue object
300 static function retrieve(&$params, &$values) {
301 $optionValue = new CRM_Core_DAO_OptionValue();
302 $optionValue->copyValues($params);
303 $optionValue->option_group_id
= self
::_getGid();
304 if ($optionValue->find(TRUE)) {
305 // Extract fields that have been serialized in the 'value' column of the Option Value table.
306 $values = json_decode($optionValue->value
, TRUE);
307 // Add any new fields that don't yet exist in the saved values.
308 foreach (self
::$optionValueFields as $name => $field) {
309 if (!isset($values[$name])) {
310 $values[$name] = $field['default'];
311 if ($field['metric']) {
312 $values[$name] = CRM_Utils_PDF_Utils
::convertMetric($field['default'],
313 self
::$optionValueFields['metric']['default'],
319 // Add fields from the OptionValue base class
320 CRM_Core_DAO
::storeValues($optionValue, $values);
327 * Save the PDF Page Format in the DB
329 * @param array (reference) $values associative array of name/value pairs
330 * @param int $id id of the database record (null = new record)
335 function savePdfFormat(&$values, $id = NULL) {
336 // get the Option Group ID for PDF Page Formats (create one if it doesn't exist)
337 $group_id = self
::_getGid();
339 // clear other default if this is the new default PDF Page Format
340 if ($values['is_default']) {
341 $query = "UPDATE civicrm_option_value SET is_default = 0 WHERE option_group_id = $group_id";
342 CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
345 // fetch existing record
351 // copy the supplied form values to the corresponding Option Value fields in the base class
352 foreach ($this->fields() as $name => $field) {
353 $this->$name = trim(CRM_Utils_Array
::value($name, $values, $this->$name));
354 if (empty($this->$name)) {
355 $this->$name = 'null';
359 $this->option_group_id
= $group_id;
360 $this->label
= $this->name
;
361 $this->is_active
= 1;
363 // serialize PDF Page Format fields into a single string to store in the 'value' column of the Option Value table
364 $v = json_decode($this->value
, TRUE);
365 foreach (self
::$optionValueFields as $name => $field) {
366 $v[$name] = self
::getValue($name, $values, CRM_Utils_Array
::value($name, $v));
368 $this->value
= json_encode($v);
370 // make sure serialized array will fit in the 'value' column
371 $attribute = CRM_Core_DAO
::getAttribute('CRM_Core_BAO_PdfFormat', 'value');
372 if (strlen($this->value
) > $attribute['maxlength']) {
373 CRM_Core_Error
::fatal(ts('PDF Page Format does not fit in database.'));
377 // fix duplicate weights
378 $filter = array('option_group_id' => self
::_getGid());
379 CRM_Utils_Weight
::correctDuplicateWeights('CRM_Core_DAO_OptionValue', $filter);
383 * Function to delete a PDF Page Format
385 * @param int $id ID of the PDF Page Format to be deleted.
390 static function del($id) {
392 $dao = new CRM_Core_DAO_OptionValue();
394 if ($dao->find(TRUE)) {
395 if ($dao->option_group_id
== self
::_getGid()) {
396 $filter = array('option_group_id' => self
::_getGid());
397 CRM_Utils_Weight
::delWeight('CRM_Core_DAO_OptionValue', $id, $filter);
403 CRM_Core_Error
::fatal(ts('Invalid value passed to delete function.'));