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. |
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 'stationery' => array(
57 'name' => 'stationery',
58 'type' => CRM_Utils_Type
::T_STRING
,
61 'orientation' => array(
62 'name' => 'orientation',
63 'type' => CRM_Utils_Type
::T_STRING
,
64 'default' => 'portrait',
68 'type' => CRM_Utils_Type
::T_STRING
,
71 'margin_top' => array(
72 'name' => 'margin_top',
73 'type' => CRM_Utils_Type
::T_FLOAT
,
77 'margin_bottom' => array(
78 'name' => 'margin_bottom',
79 'type' => CRM_Utils_Type
::T_FLOAT
,
83 'margin_left' => array(
84 'name' => 'margin_left',
85 'type' => CRM_Utils_Type
::T_FLOAT
,
89 'margin_right' => array(
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.
102 * @return array array of page orientations
104 public static function getPageOrientations() {
106 'portrait' => ts('Portrait'),
107 'landscape' => ts('Landscape'),
112 * Get measurement units recognized by the DOMPDF package used to create PDF letters.
116 * @return array array of measurement units
118 public static function getUnits() {
120 'in' => ts('Inches'),
121 'cm' => ts('Centimeters'),
122 'mm' => ts('Millimeters'),
123 'pt' => ts('Points'),
128 * Get Option Group ID for PDF Page Formats
132 * @return int Group ID (null if Group ID doesn't exist)
134 private static function _getGid() {
136 self
::$_gid = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', 'pdf_format', 'id', 'name');
138 CRM_Core_Error
::fatal(ts('PDF Format Option Group not found in database.'));
145 * Add ordering fields to Page Format list
147 * @param array (reference) $list List of PDF Page Formats
148 * @param string $returnURL
149 * URL of page calling this function.
154 public static function addOrder(&$list, $returnURL) {
155 $filter = "option_group_id = " . self
::_getGid();
156 CRM_Utils_Weight
::addOrder($list, 'CRM_Core_DAO_OptionValue', 'id', $returnURL, $filter);
160 * Get list of PDF Page Formats.
162 * @param bool $namesOnly
163 * Return simple list of names.
165 * @return array (reference) PDF Page Format list
168 public static function &getList($namesOnly = FALSE) {
169 static $list = array();
170 if (self
::_getGid()) {
171 // get saved PDF Page Formats from Option Value table
172 $dao = new CRM_Core_DAO_OptionValue();
173 $dao->option_group_id
= self
::_getGid();
175 $dao->orderBy('weight');
177 while ($dao->fetch()) {
179 $list[$dao->id
] = $dao->name
;
182 CRM_Core_DAO
::storeValues($dao, $list[$dao->id
]);
190 * Get the default PDF Page Format values
194 * @return array Name/value pairs containing the default PDF Page Format values.
197 public static function &getDefaultValues() {
198 $params = array('is_active' => 1, 'is_default' => 1);
200 if (!self
::retrieve($params, $defaults)) {
201 foreach (self
::$optionValueFields as $name => $field) {
202 $defaults[$name] = $field['default'];
204 $filter = array('option_group_id' => self
::_getGid());
205 $defaults['weight'] = CRM_Utils_Weight
::getDefaultWeight('CRM_Core_DAO_OptionValue', $filter);
207 // also set the id to avoid NOTICES, CRM-8454
208 $defaults['id'] = NULL;
214 * Get PDF Page Format from the DB
216 * @param string $field
217 * Field name to search by.
219 * Field value to search for.
221 * @return array $values (reference) associative array of name/value pairs
223 public static function &getPdfFormat($field, $val) {
224 $params = array('is_active' => 1, $field => $val);
225 $pdfFormat = array();
226 if (self
::retrieve($params, $pdfFormat)) {
230 return self
::getDefaultValues();
235 * Get PDF Page Format by Name
238 * PDF Page Format name. Empty = get default PDF Page Format.
240 * @return array $values (reference) associative array of name/value pairs
242 public static function &getByName($name) {
243 return self
::getPdfFormat('name', $name);
247 * Get PDF Page Format by ID
250 * PDF Page Format id. 0 = get default PDF Page Format.
252 * @return array $values (reference) associative array of name/value pairs
254 public static function &getById($id) {
255 return self
::getPdfFormat('id', $id);
259 * Get PDF Page Format field from associative array
261 * @param string $field
262 * Name of a PDF Page Format field.
263 * @param array (reference) $values associative array of name/value pairs containing
264 * PDF Page Format field selections
266 * @param null $default
271 public static function getValue($field, &$values, $default = NULL) {
272 if (array_key_exists($field, self
::$optionValueFields)) {
273 switch (self
::$optionValueFields[$field]['type']) {
274 case CRM_Utils_Type
::T_INT
:
275 return (int)CRM_Utils_Array
::value($field, $values, $default);
277 case CRM_Utils_Type
::T_FLOAT
:
278 // Round float values to three decimal places and trim trailing zeros.
279 // Add a leading zero to values less than 1.
280 $f = sprintf('%05.3f', $values[$field]);
283 return (float)(empty($f) ?
'0' : $f);
285 return CRM_Utils_Array
::value($field, $values, $default);
291 * Takes a bunch of params that are needed to match certain criteria and
292 * retrieves the relevant objects. Typically the valid params are only
293 * format id. It also stores all the retrieved values in the default array.
295 * @param array $params
296 * (reference ) an assoc array of name/value pairs.
297 * @param array $values
298 * (reference ) an assoc array to hold the flattened values.
300 * @return CRM_Core_DAO_OptionValue object
303 public static function retrieve(&$params, &$values) {
304 $optionValue = new CRM_Core_DAO_OptionValue();
305 $optionValue->copyValues($params);
306 $optionValue->option_group_id
= self
::_getGid();
307 if ($optionValue->find(TRUE)) {
308 // Extract fields that have been serialized in the 'value' column of the Option Value table.
309 $values = json_decode($optionValue->value
, TRUE);
310 // Add any new fields that don't yet exist in the saved values.
311 foreach (self
::$optionValueFields as $name => $field) {
312 if (!isset($values[$name])) {
313 $values[$name] = $field['default'];
314 if ($field['metric']) {
315 $values[$name] = CRM_Utils_PDF_Utils
::convertMetric($field['default'],
316 self
::$optionValueFields['metric']['default'],
322 // Add fields from the OptionValue base class
323 CRM_Core_DAO
::storeValues($optionValue, $values);
330 * Save the PDF Page Format in the DB
332 * @param array (reference) $values associative array of name/value pairs
334 * Id of the database record (null = new record).
338 public function savePdfFormat(&$values, $id = NULL) {
339 // get the Option Group ID for PDF Page Formats (create one if it doesn't exist)
340 $group_id = self
::_getGid();
342 // clear other default if this is the new default PDF Page Format
343 if ($values['is_default']) {
344 $query = "UPDATE civicrm_option_value SET is_default = 0 WHERE option_group_id = $group_id";
345 CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
348 // fetch existing record
354 // copy the supplied form values to the corresponding Option Value fields in the base class
355 foreach ($this->fields() as $name => $field) {
356 $this->$name = trim(CRM_Utils_Array
::value($name, $values, $this->$name));
357 if (empty($this->$name)) {
358 $this->$name = 'null';
362 $this->option_group_id
= $group_id;
363 $this->label
= $this->name
;
364 $this->is_active
= 1;
366 // serialize PDF Page Format fields into a single string to store in the 'value' column of the Option Value table
367 $v = json_decode($this->value
, TRUE);
368 foreach (self
::$optionValueFields as $name => $field) {
369 $v[$name] = self
::getValue($name, $values, CRM_Utils_Array
::value($name, $v));
371 $this->value
= json_encode($v);
373 // make sure serialized array will fit in the 'value' column
374 $attribute = CRM_Core_DAO
::getAttribute('CRM_Core_BAO_PdfFormat', 'value');
375 if (strlen($this->value
) > $attribute['maxlength']) {
376 CRM_Core_Error
::fatal(ts('PDF Page Format does not fit in database.'));
380 // fix duplicate weights
381 $filter = array('option_group_id' => self
::_getGid());
382 CRM_Utils_Weight
::correctDuplicateWeights('CRM_Core_DAO_OptionValue', $filter);
386 * Delete a PDF Page Format
389 * ID of the PDF Page Format to be deleted.
393 public static function del($id) {
395 $dao = new CRM_Core_DAO_OptionValue();
397 if ($dao->find(TRUE)) {
398 if ($dao->option_group_id
== self
::_getGid()) {
399 $filter = array('option_group_id' => self
::_getGid());
400 CRM_Utils_Weight
::delWeight('CRM_Core_DAO_OptionValue', $id, $filter);
406 CRM_Core_Error
::fatal(ts('Invalid value passed to delete function.'));