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)
75 * @throws CRM_Core_Exception
77 private static function _getGid() {
79 self
::$_gid = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', 'paper_size', 'id', 'name');
81 throw new CRM_Core_Exception(ts('Paper Size Option Group not found in database.'));
88 * Add ordering fields to Paper Size list.
90 * @param array $list List of Paper Sizes
91 * @param string $returnURL
92 * URL of page calling this function.
95 public static function &addOrder(&$list, $returnURL) {
96 $filter = "option_group_id = " . self
::_getGid();
97 CRM_Utils_Weight
::addOrder($list, 'CRM_Core_DAO_OptionValue', 'id', $returnURL, $filter);
101 * Retrieve list of Paper Sizes.
103 * @param bool $namesOnly
104 * Return simple list of names.
107 * (reference) Paper Size list
109 public static function &getList($namesOnly = FALSE) {
111 if (self
::_getGid()) {
112 // get saved Paper Sizes from Option Value table
113 $dao = new CRM_Core_DAO_OptionValue();
114 $dao->option_group_id
= self
::_getGid();
116 $dao->orderBy('weight');
118 while ($dao->fetch()) {
120 $list[$dao->name
] = $dao->label
;
123 CRM_Core_DAO
::storeValues($dao, $list[$dao->id
]);
131 * Retrieve the default Paper Size values.
134 * Name/value pairs containing the default Paper Size values.
136 public static function &getDefaultValues() {
137 $params = ['is_active' => 1, 'is_default' => 1];
139 if (!self
::retrieve($params, $defaults)) {
140 foreach (self
::$optionValueFields as $name => $field) {
141 $defaults[$name] = $field['default'];
143 $filter = ['option_group_id' => self
::_getGid()];
144 $defaults['weight'] = CRM_Utils_Weight
::getDefaultWeight('CRM_Core_DAO_OptionValue', $filter);
150 * Get Paper Size from the DB.
152 * @param string $field
153 * Field name to search by.
155 * Field value to search for.
158 * (reference) associative array of name/value pairs
160 public static function &getPaperFormat($field, $val) {
161 $params = ['is_active' => 1, $field => $val];
163 if (self
::retrieve($params, $paperFormat)) {
167 return self
::getDefaultValues();
172 * Get Paper Size by Name.
175 * Paper Size name. Empty = get default Paper Size.
178 * (reference) associative array of name/value pairs
180 public static function &getByName($name) {
181 return self
::getPaperFormat('name', $name);
185 * Get Paper Size by ID.
188 * Paper Size id. 0 = get default Paper Size.
191 * (reference) associative array of name/value pairs
193 public static function &getById($id) {
194 return self
::getPaperFormat('id', $id);
198 * Get Paper Size field from associative array.
200 * @param string $field
201 * Name of a Paper Size field.
202 * @param array $values associative array of name/value pairs containing
203 * Paper Size field selections
205 * @param null $default
209 public static function getValue($field, &$values, $default = NULL) {
210 if (array_key_exists($field, self
::$optionValueFields)) {
211 switch (self
::$optionValueFields[$field]['type']) {
212 case CRM_Utils_Type
::T_INT
:
213 return (int) CRM_Utils_Array
::value($field, $values, $default);
215 case CRM_Utils_Type
::T_FLOAT
:
216 // Round float values to three decimal places and trim trailing zeros.
217 // Add a leading zero to values less than 1.
218 $f = sprintf('%05.3f', $values[$field]);
221 return (float) (empty($f) ?
'0' : $f);
223 return CRM_Utils_Array
::value($field, $values, $default);
229 * Retrieve DB object based on input parameters.
231 * It also stores all the retrieved values in the default array.
233 * @param array $params
234 * (reference ) an assoc array of name/value pairs.
235 * @param array $values
236 * (reference ) an assoc array to hold the flattened values.
238 * @return CRM_Core_DAO_OptionValue
240 public static function retrieve(&$params, &$values) {
241 $optionValue = new CRM_Core_DAO_OptionValue();
242 $optionValue->copyValues($params);
243 $optionValue->option_group_id
= self
::_getGid();
244 if ($optionValue->find(TRUE)) {
245 // Extract fields that have been serialized in the 'value' column of the Option Value table.
246 $values = json_decode($optionValue->value
, TRUE);
247 // Add any new fields that don't yet exist in the saved values.
248 foreach (self
::$optionValueFields as $name => $field) {
249 if (!isset($values[$name])) {
250 $values[$name] = $field['default'];
251 if ($field['metric']) {
252 $values[$name] = CRM_Utils_PDF_Utils
::convertMetric($field['default'],
253 self
::$optionValueFields['metric']['default'],
259 // Add fields from the OptionValue base class
260 CRM_Core_DAO
::storeValues($optionValue, $values);
267 * Save the Paper Size in the DB.
269 * @param array $values associative array of name/value pairs
271 * Id of the database record (null = new record).
272 * @throws CRM_Core_Exception
274 public function savePaperSize(&$values, $id) {
275 // get the Option Group ID for Paper Sizes (create one if it doesn't exist)
276 $group_id = self
::_getGid(TRUE);
278 // clear other default if this is the new default Paper Size
279 if ($values['is_default']) {
280 $query = "UPDATE civicrm_option_value SET is_default = 0 WHERE option_group_id = $group_id";
281 CRM_Core_DAO
::executeQuery($query);
284 // fetch existing record
291 // new record: set group = custom
292 $values['grouping'] = self
::customGroupName();
294 // copy the supplied form values to the corresponding Option Value fields in the base class
295 foreach ($this->fields() as $name => $field) {
296 $this->$name = trim(CRM_Utils_Array
::value($name, $values, $this->$name));
297 if (empty($this->$name)) {
298 $this->$name = 'null';
302 $this->option_group_id
= $group_id;
303 $this->label
= $this->name
;
304 $this->is_active
= 1;
306 // serialize Paper Size fields into a single string to store in the 'value' column of the Option Value table
307 $v = json_decode($this->value
, TRUE);
308 foreach (self
::$optionValueFields as $name => $field) {
309 $v[$name] = self
::getValue($name, $values, $v[$name]);
311 $this->value
= json_encode($v);
313 // make sure serialized array will fit in the 'value' column
314 $attribute = CRM_Core_DAO
::getAttribute('CRM_Core_BAO_PaperSize', 'value');
315 if (strlen($this->value
) > $attribute['maxlength']) {
316 throw new CRM_Core_Exception(ts('Paper Size does not fit in database.'));
320 // fix duplicate weights
321 $filter = ['option_group_id' => self
::_getGid()];
322 CRM_Utils_Weight
::correctDuplicateWeights('CRM_Core_DAO_OptionValue', $filter);
326 * Delete a Paper Size.
329 * ID of the Paper Size to be deleted.
330 * @throws CRM_Core_Exception
332 public static function del($id) {
334 $dao = new CRM_Core_DAO_OptionValue();
336 if ($dao->find(TRUE)) {
337 if ($dao->option_group_id
== self
::_getGid()) {
338 $filter = ['option_group_id' => self
::_getGid()];
339 CRM_Utils_Weight
::delWeight('CRM_Core_DAO_OptionValue', $id, $filter);
345 throw new CRM_Core_Exception(ts('Invalid value passed to delete function.'));