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 https://civicrm.org/licensing
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)
130 * @throws CRM_Core_Exception
132 private static function _getGid() {
134 self
::$_gid = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', 'pdf_format', 'id', 'name');
136 throw new CRM_Core_Exception(ts('PDF Format Option Group not found in database.'));
143 * Add ordering fields to Page Format list.
145 * @param array $list List of PDF Page Formats
146 * @param string $returnURL
147 * URL of page calling this function.
149 public static function addOrder(&$list, $returnURL) {
150 $filter = "option_group_id = " . self
::_getGid();
151 CRM_Utils_Weight
::addOrder($list, 'CRM_Core_DAO_OptionValue', 'id', $returnURL, $filter);
155 * Get list of PDF Page Formats.
157 * @param bool $namesOnly
158 * Return simple list of names.
161 * (reference) PDF Page Format list
163 public static function &getList($namesOnly = FALSE) {
165 if (self
::_getGid()) {
166 // get saved PDF Page Formats from Option Value table
167 $dao = new CRM_Core_DAO_OptionValue();
168 $dao->option_group_id
= self
::_getGid();
170 $dao->orderBy('weight');
172 while ($dao->fetch()) {
174 $list[$dao->id
] = $dao->name
;
177 CRM_Core_DAO
::storeValues($dao, $list[$dao->id
]);
185 * Get the default PDF Page Format values.
188 * Name/value pairs containing the default PDF Page Format values.
190 public static function &getDefaultValues() {
191 $params = ['is_active' => 1, 'is_default' => 1];
193 if (!self
::retrieve($params, $defaults)) {
194 foreach (self
::$optionValueFields as $name => $field) {
195 $defaults[$name] = $field['default'];
197 $filter = ['option_group_id' => self
::_getGid()];
198 $defaults['weight'] = CRM_Utils_Weight
::getDefaultWeight('CRM_Core_DAO_OptionValue', $filter);
200 // also set the id to avoid NOTICES, CRM-8454
201 $defaults['id'] = NULL;
207 * Get PDF Page Format from the DB.
209 * @param string $field
210 * Field name to search by.
212 * Field value to search for.
215 * (reference) associative array of name/value pairs
217 public static function &getPdfFormat($field, $val) {
218 $params = ['is_active' => 1, $field => $val];
220 if (self
::retrieve($params, $pdfFormat)) {
224 return self
::getDefaultValues();
229 * Get PDF Page Format by Name.
232 * PDF Page Format name. Empty = get default PDF Page Format.
235 * (reference) associative array of name/value pairs
237 public static function &getByName($name) {
238 return self
::getPdfFormat('name', $name);
242 * Get PDF Page Format by ID.
245 * PDF Page Format id. 0 = get default PDF Page Format.
248 * (reference) associative array of name/value pairs
250 public static function &getById($id) {
251 return self
::getPdfFormat('id', $id);
255 * Get PDF Page Format field from associative array.
257 * @param string $field
258 * Name of a PDF Page Format field.
259 * @param array $values associative array of name/value pairs containing
260 * PDF Page Format field selections
262 * @param null $default
266 public static function getValue($field, $values, $default = NULL) {
267 if (array_key_exists($field, self
::$optionValueFields)) {
268 switch (self
::$optionValueFields[$field]['type']) {
269 case CRM_Utils_Type
::T_INT
:
270 return (int) CRM_Utils_Array
::value($field, $values, $default);
272 case CRM_Utils_Type
::T_FLOAT
:
273 // Round float values to three decimal places and trim trailing zeros.
274 // Add a leading zero to values less than 1.
275 $f = sprintf('%05.3f', $values[$field]);
278 return (float) (empty($f) ?
'0' : $f);
280 return CRM_Utils_Array
::value($field, $values, $default);
286 * Retrieve DB object based on input parameters.
288 * It also stores all the retrieved values in the default array.
290 * @param array $params
291 * (reference ) an assoc array of name/value pairs.
292 * @param array $values
293 * (reference ) an assoc array to hold the flattened values.
295 * @return CRM_Core_DAO_OptionValue
297 public static function retrieve(&$params, &$values) {
298 $optionValue = new CRM_Core_DAO_OptionValue();
299 $optionValue->copyValues($params);
300 $optionValue->option_group_id
= self
::_getGid();
301 if ($optionValue->find(TRUE)) {
302 // Extract fields that have been serialized in the 'value' column of the Option Value table.
303 $values = json_decode($optionValue->value
, TRUE);
304 // Add any new fields that don't yet exist in the saved values.
305 foreach (self
::$optionValueFields as $name => $field) {
306 if (!isset($values[$name])) {
307 $values[$name] = $field['default'];
308 if (!empty($field['metric'])) {
309 $values[$name] = CRM_Utils_PDF_Utils
::convertMetric($field['default'],
310 self
::$optionValueFields['metric']['default'],
316 // Add fields from the OptionValue base class
317 CRM_Core_DAO
::storeValues($optionValue, $values);
324 * Save the PDF Page Format in the DB.
326 * @param array $values associative array of name/value pairs
328 * Id of the database record (null = new record).
329 * @throws CRM_Core_Exception
331 public function savePdfFormat($values, $id = NULL) {
332 // get the Option Group ID for PDF Page Formats (create one if it doesn't exist)
333 $group_id = self
::_getGid();
335 // clear other default if this is the new default PDF Page Format
336 if ($values['is_default']) {
337 $query = "UPDATE civicrm_option_value SET is_default = 0 WHERE option_group_id = $group_id";
338 CRM_Core_DAO
::executeQuery($query);
341 // fetch existing record
347 // copy the supplied form values to the corresponding Option Value fields in the base class
348 foreach ($this->fields() as $name => $field) {
349 $this->$name = trim(CRM_Utils_Array
::value($name, $values, $this->$name));
350 if (empty($this->$name)) {
351 $this->$name = 'null';
355 $this->option_group_id
= $group_id;
356 $this->label
= $this->name
;
357 $this->is_active
= 1;
359 // serialize PDF Page Format fields into a single string to store in the 'value' column of the Option Value table
360 $v = json_decode($this->value
, TRUE);
361 foreach (self
::$optionValueFields as $name => $field) {
362 $v[$name] = self
::getValue($name, $values, CRM_Utils_Array
::value($name, $v));
364 $this->value
= json_encode($v);
366 // make sure serialized array will fit in the 'value' column
367 $attribute = CRM_Core_DAO
::getAttribute('CRM_Core_BAO_PdfFormat', 'value');
368 if (strlen($this->value
) > $attribute['maxlength']) {
369 throw new CRM_Core_Exception(ts('PDF Page Format does not fit in database.'));
373 // fix duplicate weights
374 $filter = ['option_group_id' => self
::_getGid()];
375 CRM_Utils_Weight
::correctDuplicateWeights('CRM_Core_DAO_OptionValue', $filter);
379 * Delete a PDF Page Format.
382 * ID of the PDF Page Format to be deleted.
383 * @throws CRM_Core_Exception
385 public static function del($id) {
387 $dao = new CRM_Core_DAO_OptionValue();
389 if ($dao->find(TRUE)) {
390 if ($dao->option_group_id
== self
::_getGid()) {
391 $filter = ['option_group_id' => self
::_getGid()];
392 CRM_Utils_Weight
::delWeight('CRM_Core_DAO_OptionValue', $id, $filter);
398 throw new CRM_Core_Exception(ts('Invalid value passed to delete function.'));