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-2019
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.
44 private static $_gid = NULL;
47 * PDF Page Format fields stored in the 'value' field of the Option Value table.
50 private static $optionValueFields = [
52 'name' => 'paper_size',
53 'type' => CRM_Utils_Type
::T_STRING
,
54 'default' => 'letter',
57 'name' => 'stationery',
58 'type' => CRM_Utils_Type
::T_STRING
,
62 'name' => 'orientation',
63 'type' => CRM_Utils_Type
::T_STRING
,
64 'default' => 'portrait',
68 'type' => CRM_Utils_Type
::T_STRING
,
72 'name' => 'margin_top',
73 'type' => CRM_Utils_Type
::T_FLOAT
,
78 'name' => 'margin_bottom',
79 'type' => CRM_Utils_Type
::T_FLOAT
,
84 'name' => 'margin_left',
85 'type' => CRM_Utils_Type
::T_FLOAT
,
90 'name' => 'margin_right',
91 'type' => CRM_Utils_Type
::T_FLOAT
,
98 * Get page orientations recognized by the DOMPDF package used to create PDF letters.
101 * array of page orientations
103 public static function getPageOrientations() {
105 'portrait' => ts('Portrait'),
106 'landscape' => ts('Landscape'),
111 * Get measurement units recognized by the DOMPDF package used to create PDF letters.
114 * array of measurement units
116 public static function getUnits() {
118 'in' => ts('Inches'),
119 'cm' => ts('Centimeters'),
120 'mm' => ts('Millimeters'),
121 'pt' => ts('Points'),
126 * Get Option Group ID for PDF Page Formats.
129 * Group ID (null if Group ID doesn't exist)
131 private static function _getGid() {
133 self
::$_gid = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', 'pdf_format', 'id', 'name');
135 CRM_Core_Error
::fatal(ts('PDF Format Option Group not found in database.'));
142 * Add ordering fields to Page Format list.
144 * @param array $list List of PDF Page Formats
145 * @param string $returnURL
146 * URL of page calling this function.
148 public static function addOrder(&$list, $returnURL) {
149 $filter = "option_group_id = " . self
::_getGid();
150 CRM_Utils_Weight
::addOrder($list, 'CRM_Core_DAO_OptionValue', 'id', $returnURL, $filter);
154 * Get list of PDF Page Formats.
156 * @param bool $namesOnly
157 * Return simple list of names.
160 * (reference) PDF Page Format list
162 public static function &getList($namesOnly = FALSE) {
164 if (self
::_getGid()) {
165 // get saved PDF Page Formats from Option Value table
166 $dao = new CRM_Core_DAO_OptionValue();
167 $dao->option_group_id
= self
::_getGid();
169 $dao->orderBy('weight');
171 while ($dao->fetch()) {
173 $list[$dao->id
] = $dao->name
;
176 CRM_Core_DAO
::storeValues($dao, $list[$dao->id
]);
184 * Get the default PDF Page Format values.
187 * Name/value pairs containing the default PDF Page Format values.
189 public static function &getDefaultValues() {
190 $params = ['is_active' => 1, 'is_default' => 1];
192 if (!self
::retrieve($params, $defaults)) {
193 foreach (self
::$optionValueFields as $name => $field) {
194 $defaults[$name] = $field['default'];
196 $filter = ['option_group_id' => self
::_getGid()];
197 $defaults['weight'] = CRM_Utils_Weight
::getDefaultWeight('CRM_Core_DAO_OptionValue', $filter);
199 // also set the id to avoid NOTICES, CRM-8454
200 $defaults['id'] = NULL;
206 * Get PDF Page Format from the DB.
208 * @param string $field
209 * Field name to search by.
211 * Field value to search for.
214 * (reference) associative array of name/value pairs
216 public static function &getPdfFormat($field, $val) {
217 $params = ['is_active' => 1, $field => $val];
219 if (self
::retrieve($params, $pdfFormat)) {
223 return self
::getDefaultValues();
228 * Get PDF Page Format by Name.
231 * PDF Page Format name. Empty = get default PDF Page Format.
234 * (reference) associative array of name/value pairs
236 public static function &getByName($name) {
237 return self
::getPdfFormat('name', $name);
241 * Get PDF Page Format by ID.
244 * PDF Page Format id. 0 = get default PDF Page Format.
247 * (reference) associative array of name/value pairs
249 public static function &getById($id) {
250 return self
::getPdfFormat('id', $id);
254 * Get PDF Page Format field from associative array.
256 * @param string $field
257 * Name of a PDF Page Format field.
258 * @param array $values associative array of name/value pairs containing
259 * PDF Page Format field selections
261 * @param null $default
265 public static function getValue($field, &$values, $default = NULL) {
266 if (array_key_exists($field, self
::$optionValueFields)) {
267 switch (self
::$optionValueFields[$field]['type']) {
268 case CRM_Utils_Type
::T_INT
:
269 return (int) CRM_Utils_Array
::value($field, $values, $default);
271 case CRM_Utils_Type
::T_FLOAT
:
272 // Round float values to three decimal places and trim trailing zeros.
273 // Add a leading zero to values less than 1.
274 $f = sprintf('%05.3f', $values[$field]);
277 return (float) (empty($f) ?
'0' : $f);
279 return CRM_Utils_Array
::value($field, $values, $default);
285 * Retrieve DB object based on input parameters.
287 * It also stores all the retrieved values in the default array.
289 * @param array $params
290 * (reference ) an assoc array of name/value pairs.
291 * @param array $values
292 * (reference ) an assoc array to hold the flattened values.
294 * @return CRM_Core_DAO_OptionValue
296 public static function retrieve(&$params, &$values) {
297 $optionValue = new CRM_Core_DAO_OptionValue();
298 $optionValue->copyValues($params);
299 $optionValue->option_group_id
= self
::_getGid();
300 if ($optionValue->find(TRUE)) {
301 // Extract fields that have been serialized in the 'value' column of the Option Value table.
302 $values = json_decode($optionValue->value
, TRUE);
303 // Add any new fields that don't yet exist in the saved values.
304 foreach (self
::$optionValueFields as $name => $field) {
305 if (!isset($values[$name])) {
306 $values[$name] = $field['default'];
307 if (!empty($field['metric'])) {
308 $values[$name] = CRM_Utils_PDF_Utils
::convertMetric($field['default'],
309 self
::$optionValueFields['metric']['default'],
315 // Add fields from the OptionValue base class
316 CRM_Core_DAO
::storeValues($optionValue, $values);
323 * Save the PDF Page Format in the DB.
325 * @param array $values associative array of name/value pairs
327 * Id of the database record (null = new record).
329 public function savePdfFormat(&$values, $id = NULL) {
330 // get the Option Group ID for PDF Page Formats (create one if it doesn't exist)
331 $group_id = self
::_getGid();
333 // clear other default if this is the new default PDF Page Format
334 if ($values['is_default']) {
335 $query = "UPDATE civicrm_option_value SET is_default = 0 WHERE option_group_id = $group_id";
336 CRM_Core_DAO
::executeQuery($query);
339 // fetch existing record
345 // copy the supplied form values to the corresponding Option Value fields in the base class
346 foreach ($this->fields() as $name => $field) {
347 $this->$name = trim(CRM_Utils_Array
::value($name, $values, $this->$name));
348 if (empty($this->$name)) {
349 $this->$name = 'null';
353 $this->option_group_id
= $group_id;
354 $this->label
= $this->name
;
355 $this->is_active
= 1;
357 // serialize PDF Page Format fields into a single string to store in the 'value' column of the Option Value table
358 $v = json_decode($this->value
, TRUE);
359 foreach (self
::$optionValueFields as $name => $field) {
360 $v[$name] = self
::getValue($name, $values, CRM_Utils_Array
::value($name, $v));
362 $this->value
= json_encode($v);
364 // make sure serialized array will fit in the 'value' column
365 $attribute = CRM_Core_DAO
::getAttribute('CRM_Core_BAO_PdfFormat', 'value');
366 if (strlen($this->value
) > $attribute['maxlength']) {
367 CRM_Core_Error
::fatal(ts('PDF Page Format does not fit in database.'));
371 // fix duplicate weights
372 $filter = ['option_group_id' => self
::_getGid()];
373 CRM_Utils_Weight
::correctDuplicateWeights('CRM_Core_DAO_OptionValue', $filter);
377 * Delete a PDF Page Format.
380 * ID of the PDF Page Format to be deleted.
383 public static function del($id) {
385 $dao = new CRM_Core_DAO_OptionValue();
387 if ($dao->find(TRUE)) {
388 if ($dao->option_group_id
== self
::_getGid()) {
389 $filter = ['option_group_id' => self
::_getGid()];
390 CRM_Utils_Weight
::delWeight('CRM_Core_DAO_OptionValue', $id, $filter);
396 CRM_Core_Error
::fatal(ts('Invalid value passed to delete function.'));