3 +--------------------------------------------------------------------+
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-2018
36 * This class contains functions for managing PDF Page Formats.
38 class CRM_Core_BAO_PdfFormat
extends CRM_Core_DAO_OptionValue
{
41 * Static holder for the PDF Page Formats Option Group ID.
43 private static $_gid = NULL;
46 * PDF Page Format fields stored in the 'value' field of the Option Value table.
48 private static $optionValueFields = array(
49 'paper_size' => array(
50 'name' => 'paper_size',
51 'type' => CRM_Utils_Type
::T_STRING
,
52 'default' => 'letter',
54 'stationery' => array(
55 'name' => 'stationery',
56 'type' => CRM_Utils_Type
::T_STRING
,
59 'orientation' => array(
60 'name' => 'orientation',
61 'type' => CRM_Utils_Type
::T_STRING
,
62 'default' => 'portrait',
66 'type' => CRM_Utils_Type
::T_STRING
,
69 'margin_top' => array(
70 'name' => 'margin_top',
71 'type' => CRM_Utils_Type
::T_FLOAT
,
75 'margin_bottom' => array(
76 'name' => 'margin_bottom',
77 'type' => CRM_Utils_Type
::T_FLOAT
,
81 'margin_left' => array(
82 'name' => 'margin_left',
83 'type' => CRM_Utils_Type
::T_FLOAT
,
87 'margin_right' => array(
88 'name' => 'margin_right',
89 'type' => CRM_Utils_Type
::T_FLOAT
,
96 * Get page orientations recognized by the DOMPDF package used to create PDF letters.
99 * array of page orientations
101 public static function getPageOrientations() {
103 'portrait' => ts('Portrait'),
104 'landscape' => ts('Landscape'),
109 * Get measurement units recognized by the DOMPDF package used to create PDF letters.
112 * array of measurement units
114 public static function getUnits() {
116 'in' => ts('Inches'),
117 'cm' => ts('Centimeters'),
118 'mm' => ts('Millimeters'),
119 'pt' => ts('Points'),
124 * Get Option Group ID for PDF Page Formats.
127 * Group ID (null if Group ID doesn't exist)
129 private static function _getGid() {
131 self
::$_gid = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', 'pdf_format', 'id', 'name');
133 CRM_Core_Error
::fatal(ts('PDF Format Option Group not found in database.'));
140 * Add ordering fields to Page Format list.
142 * @param array (reference) $list List of PDF Page Formats
143 * @param string $returnURL
144 * URL of page calling this function.
146 public static function addOrder(&$list, $returnURL) {
147 $filter = "option_group_id = " . self
::_getGid();
148 CRM_Utils_Weight
::addOrder($list, 'CRM_Core_DAO_OptionValue', 'id', $returnURL, $filter);
152 * Get list of PDF Page Formats.
154 * @param bool $namesOnly
155 * Return simple list of names.
158 * (reference) PDF Page Format list
160 public static function &getList($namesOnly = FALSE) {
161 static $list = array();
162 if (self
::_getGid()) {
163 // get saved PDF Page Formats from Option Value table
164 $dao = new CRM_Core_DAO_OptionValue();
165 $dao->option_group_id
= self
::_getGid();
167 $dao->orderBy('weight');
169 while ($dao->fetch()) {
171 $list[$dao->id
] = $dao->name
;
174 CRM_Core_DAO
::storeValues($dao, $list[$dao->id
]);
182 * Get the default PDF Page Format values.
185 * Name/value pairs containing the default PDF Page Format values.
187 public static function &getDefaultValues() {
188 $params = array('is_active' => 1, 'is_default' => 1);
190 if (!self
::retrieve($params, $defaults)) {
191 foreach (self
::$optionValueFields as $name => $field) {
192 $defaults[$name] = $field['default'];
194 $filter = array('option_group_id' => self
::_getGid());
195 $defaults['weight'] = CRM_Utils_Weight
::getDefaultWeight('CRM_Core_DAO_OptionValue', $filter);
197 // also set the id to avoid NOTICES, CRM-8454
198 $defaults['id'] = NULL;
204 * Get PDF Page Format from the DB.
206 * @param string $field
207 * Field name to search by.
209 * Field value to search for.
212 * (reference) associative array of name/value pairs
214 public static function &getPdfFormat($field, $val) {
215 $params = array('is_active' => 1, $field => $val);
216 $pdfFormat = array();
217 if (self
::retrieve($params, $pdfFormat)) {
221 return self
::getDefaultValues();
226 * Get PDF Page Format by Name.
229 * PDF Page Format name. Empty = get default PDF Page Format.
232 * (reference) associative array of name/value pairs
234 public static function &getByName($name) {
235 return self
::getPdfFormat('name', $name);
239 * Get PDF Page Format by ID.
242 * PDF Page Format id. 0 = get default PDF Page Format.
245 * (reference) associative array of name/value pairs
247 public static function &getById($id) {
248 return self
::getPdfFormat('id', $id);
252 * Get PDF Page Format field from associative array.
254 * @param string $field
255 * Name of a PDF Page Format field.
256 * @param array (reference) $values associative array of name/value pairs containing
257 * PDF Page Format field selections
259 * @param null $default
263 public static function getValue($field, &$values, $default = NULL) {
264 if (array_key_exists($field, self
::$optionValueFields)) {
265 switch (self
::$optionValueFields[$field]['type']) {
266 case CRM_Utils_Type
::T_INT
:
267 return (int) CRM_Utils_Array
::value($field, $values, $default);
269 case CRM_Utils_Type
::T_FLOAT
:
270 // Round float values to three decimal places and trim trailing zeros.
271 // Add a leading zero to values less than 1.
272 $f = sprintf('%05.3f', $values[$field]);
275 return (float) (empty($f) ?
'0' : $f);
277 return CRM_Utils_Array
::value($field, $values, $default);
283 * Retrieve DB object based on input parameters.
285 * It also stores all the retrieved values in the default array.
287 * @param array $params
288 * (reference ) an assoc array of name/value pairs.
289 * @param array $values
290 * (reference ) an assoc array to hold the flattened values.
292 * @return CRM_Core_DAO_OptionValue
294 public static function retrieve(&$params, &$values) {
295 $optionValue = new CRM_Core_DAO_OptionValue();
296 $optionValue->copyValues($params);
297 $optionValue->option_group_id
= self
::_getGid();
298 if ($optionValue->find(TRUE)) {
299 // Extract fields that have been serialized in the 'value' column of the Option Value table.
300 $values = json_decode($optionValue->value
, TRUE);
301 // Add any new fields that don't yet exist in the saved values.
302 foreach (self
::$optionValueFields as $name => $field) {
303 if (!isset($values[$name])) {
304 $values[$name] = $field['default'];
305 if (!empty($field['metric'])) {
306 $values[$name] = CRM_Utils_PDF_Utils
::convertMetric($field['default'],
307 self
::$optionValueFields['metric']['default'],
313 // Add fields from the OptionValue base class
314 CRM_Core_DAO
::storeValues($optionValue, $values);
321 * Save the PDF Page Format in the DB.
323 * @param array $values associative array of name/value pairs
325 * Id of the database record (null = new record).
327 public function savePdfFormat(&$values, $id = NULL) {
328 // get the Option Group ID for PDF Page Formats (create one if it doesn't exist)
329 $group_id = self
::_getGid();
331 // clear other default if this is the new default PDF Page Format
332 if ($values['is_default']) {
333 $query = "UPDATE civicrm_option_value SET is_default = 0 WHERE option_group_id = $group_id";
334 CRM_Core_DAO
::executeQuery($query);
337 // fetch existing record
343 // copy the supplied form values to the corresponding Option Value fields in the base class
344 foreach ($this->fields() as $name => $field) {
345 $this->$name = trim(CRM_Utils_Array
::value($name, $values, $this->$name));
346 if (empty($this->$name)) {
347 $this->$name = 'null';
351 $this->option_group_id
= $group_id;
352 $this->label
= $this->name
;
353 $this->is_active
= 1;
355 // serialize PDF Page Format fields into a single string to store in the 'value' column of the Option Value table
356 $v = json_decode($this->value
, TRUE);
357 foreach (self
::$optionValueFields as $name => $field) {
358 $v[$name] = self
::getValue($name, $values, CRM_Utils_Array
::value($name, $v));
360 $this->value
= json_encode($v);
362 // make sure serialized array will fit in the 'value' column
363 $attribute = CRM_Core_DAO
::getAttribute('CRM_Core_BAO_PdfFormat', 'value');
364 if (strlen($this->value
) > $attribute['maxlength']) {
365 CRM_Core_Error
::fatal(ts('PDF Page Format does not fit in database.'));
369 // fix duplicate weights
370 $filter = array('option_group_id' => self
::_getGid());
371 CRM_Utils_Weight
::correctDuplicateWeights('CRM_Core_DAO_OptionValue', $filter);
375 * Delete a PDF Page Format.
378 * ID of the PDF Page Format to be deleted.
381 public static function del($id) {
383 $dao = new CRM_Core_DAO_OptionValue();
385 if ($dao->find(TRUE)) {
386 if ($dao->option_group_id
== self
::_getGid()) {
387 $filter = array('option_group_id' => self
::_getGid());
388 CRM_Utils_Weight
::delWeight('CRM_Core_DAO_OptionValue', $id, $filter);
394 CRM_Core_Error
::fatal(ts('Invalid value passed to delete function.'));