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 Paper Sizes.
38 class CRM_Core_BAO_PaperSize
extends CRM_Core_DAO_OptionValue
{
41 * Static holder for the Paper Size Option Group ID.
44 private static $_gid = NULL;
47 * Paper Size fields stored in the 'value' field of the Option Value table.
50 private static $optionValueFields = [
53 'type' => CRM_Utils_Type
::T_STRING
,
58 'type' => CRM_Utils_Type
::T_FLOAT
,
64 'type' => CRM_Utils_Type
::T_FLOAT
,
71 * Get Option Group ID for Paper Sizes.
74 * Group ID (null if Group ID doesn't exist)
76 private static function _getGid() {
78 self
::$_gid = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', 'paper_size', 'id', 'name');
80 CRM_Core_Error
::fatal(ts('Paper Size Option Group not found in database.'));
87 * Add ordering fields to Paper Size list.
89 * @param array $list List of Paper Sizes
90 * @param string $returnURL
91 * URL of page calling this function.
94 public static function &addOrder(&$list, $returnURL) {
95 $filter = "option_group_id = " . self
::_getGid();
96 CRM_Utils_Weight
::addOrder($list, 'CRM_Core_DAO_OptionValue', 'id', $returnURL, $filter);
100 * Retrieve list of Paper Sizes.
102 * @param bool $namesOnly
103 * Return simple list of names.
106 * (reference) Paper Size list
108 public static function &getList($namesOnly = FALSE) {
110 if (self
::_getGid()) {
111 // get saved Paper Sizes from Option Value table
112 $dao = new CRM_Core_DAO_OptionValue();
113 $dao->option_group_id
= self
::_getGid();
115 $dao->orderBy('weight');
117 while ($dao->fetch()) {
119 $list[$dao->name
] = $dao->label
;
122 CRM_Core_DAO
::storeValues($dao, $list[$dao->id
]);
130 * Retrieve the default Paper Size values.
133 * Name/value pairs containing the default Paper Size values.
135 public static function &getDefaultValues() {
136 $params = ['is_active' => 1, 'is_default' => 1];
138 if (!self
::retrieve($params, $defaults)) {
139 foreach (self
::$optionValueFields as $name => $field) {
140 $defaults[$name] = $field['default'];
142 $filter = ['option_group_id' => self
::_getGid()];
143 $defaults['weight'] = CRM_Utils_Weight
::getDefaultWeight('CRM_Core_DAO_OptionValue', $filter);
149 * Get Paper Size from the DB.
151 * @param string $field
152 * Field name to search by.
154 * Field value to search for.
157 * (reference) associative array of name/value pairs
159 public static function &getPaperFormat($field, $val) {
160 $params = ['is_active' => 1, $field => $val];
162 if (self
::retrieve($params, $paperFormat)) {
166 return self
::getDefaultValues();
171 * Get Paper Size by Name.
174 * Paper Size name. Empty = get default Paper Size.
177 * (reference) associative array of name/value pairs
179 public static function &getByName($name) {
180 return self
::getPaperFormat('name', $name);
184 * Get Paper Size by ID.
187 * Paper Size id. 0 = get default Paper Size.
190 * (reference) associative array of name/value pairs
192 public static function &getById($id) {
193 return self
::getPaperFormat('id', $id);
197 * Get Paper Size field from associative array.
199 * @param string $field
200 * Name of a Paper Size field.
201 * @param array $values associative array of name/value pairs containing
202 * Paper Size field selections
204 * @param null $default
208 public static function getValue($field, &$values, $default = NULL) {
209 if (array_key_exists($field, self
::$optionValueFields)) {
210 switch (self
::$optionValueFields[$field]['type']) {
211 case CRM_Utils_Type
::T_INT
:
212 return (int) CRM_Utils_Array
::value($field, $values, $default);
214 case CRM_Utils_Type
::T_FLOAT
:
215 // Round float values to three decimal places and trim trailing zeros.
216 // Add a leading zero to values less than 1.
217 $f = sprintf('%05.3f', $values[$field]);
220 return (float) (empty($f) ?
'0' : $f);
222 return CRM_Utils_Array
::value($field, $values, $default);
228 * Retrieve DB object based on input parameters.
230 * It also stores all the retrieved values in the default array.
232 * @param array $params
233 * (reference ) an assoc array of name/value pairs.
234 * @param array $values
235 * (reference ) an assoc array to hold the flattened values.
237 * @return CRM_Core_DAO_OptionValue
239 public static function retrieve(&$params, &$values) {
240 $optionValue = new CRM_Core_DAO_OptionValue();
241 $optionValue->copyValues($params);
242 $optionValue->option_group_id
= self
::_getGid();
243 if ($optionValue->find(TRUE)) {
244 // Extract fields that have been serialized in the 'value' column of the Option Value table.
245 $values = json_decode($optionValue->value
, TRUE);
246 // Add any new fields that don't yet exist in the saved values.
247 foreach (self
::$optionValueFields as $name => $field) {
248 if (!isset($values[$name])) {
249 $values[$name] = $field['default'];
250 if ($field['metric']) {
251 $values[$name] = CRM_Utils_PDF_Utils
::convertMetric($field['default'],
252 self
::$optionValueFields['metric']['default'],
258 // Add fields from the OptionValue base class
259 CRM_Core_DAO
::storeValues($optionValue, $values);
266 * Save the Paper Size in the DB.
268 * @param array $values associative array of name/value pairs
270 * Id of the database record (null = new record).
272 public function savePaperSize(&$values, $id) {
273 // get the Option Group ID for Paper Sizes (create one if it doesn't exist)
274 $group_id = self
::_getGid(TRUE);
276 // clear other default if this is the new default Paper Size
277 if ($values['is_default']) {
278 $query = "UPDATE civicrm_option_value SET is_default = 0 WHERE option_group_id = $group_id";
279 CRM_Core_DAO
::executeQuery($query);
282 // fetch existing record
289 // new record: set group = custom
290 $values['grouping'] = self
::customGroupName();
292 // copy the supplied form values to the corresponding Option Value fields in the base class
293 foreach ($this->fields() as $name => $field) {
294 $this->$name = trim(CRM_Utils_Array
::value($name, $values, $this->$name));
295 if (empty($this->$name)) {
296 $this->$name = 'null';
300 $this->option_group_id
= $group_id;
301 $this->label
= $this->name
;
302 $this->is_active
= 1;
304 // serialize Paper Size fields into a single string to store in the 'value' column of the Option Value table
305 $v = json_decode($this->value
, TRUE);
306 foreach (self
::$optionValueFields as $name => $field) {
307 $v[$name] = self
::getValue($name, $values, $v[$name]);
309 $this->value
= json_encode($v);
311 // make sure serialized array will fit in the 'value' column
312 $attribute = CRM_Core_DAO
::getAttribute('CRM_Core_BAO_PaperSize', 'value');
313 if (strlen($this->value
) > $attribute['maxlength']) {
314 CRM_Core_Error
::fatal(ts('Paper Size does not fit in database.'));
318 // fix duplicate weights
319 $filter = ['option_group_id' => self
::_getGid()];
320 CRM_Utils_Weight
::correctDuplicateWeights('CRM_Core_DAO_OptionValue', $filter);
324 * Delete a Paper Size.
327 * ID of the Paper Size to be deleted.
330 public static function del($id) {
332 $dao = new CRM_Core_DAO_OptionValue();
334 if ($dao->find(TRUE)) {
335 if ($dao->option_group_id
== self
::_getGid()) {
336 $filter = ['option_group_id' => self
::_getGid()];
337 CRM_Utils_Weight
::delWeight('CRM_Core_DAO_OptionValue', $id, $filter);
343 CRM_Core_Error
::fatal(ts('Invalid value passed to delete function.'));