3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
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-2015
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.
43 private static $_gid = NULL;
46 * Paper Size fields stored in the 'value' field of the Option Value table.
48 private static $optionValueFields = array(
51 'type' => CRM_Utils_Type
::T_STRING
,
56 'type' => CRM_Utils_Type
::T_FLOAT
,
62 'type' => CRM_Utils_Type
::T_FLOAT
,
69 * Get Option Group ID for Paper Sizes.
72 * Group ID (null if Group ID doesn't exist)
74 private static function _getGid() {
76 self
::$_gid = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', 'paper_size', 'id', 'name');
78 CRM_Core_Error
::fatal(ts('Paper Size Option Group not found in database.'));
85 * Add ordering fields to Paper Size list.
87 * @param array (reference) $list List of Paper Sizes
88 * @param string $returnURL
89 * URL of page calling this function.
92 public static function &addOrder(&$list, $returnURL) {
93 $filter = "option_group_id = " . self
::_getGid();
94 CRM_Utils_Weight
::addOrder($list, 'CRM_Core_DAO_OptionValue', 'id', $returnURL, $filter);
98 * Retrieve list of Paper Sizes.
100 * @param bool $namesOnly
101 * Return simple list of names.
104 * (reference) Paper Size list
106 public static function &getList($namesOnly = FALSE) {
107 static $list = array();
108 if (self
::_getGid()) {
109 // get saved Paper Sizes from Option Value table
110 $dao = new CRM_Core_DAO_OptionValue();
111 $dao->option_group_id
= self
::_getGid();
113 $dao->orderBy('weight');
115 while ($dao->fetch()) {
117 $list[$dao->name
] = $dao->label
;
120 CRM_Core_DAO
::storeValues($dao, $list[$dao->id
]);
128 * Retrieve the default Paper Size values.
131 * Name/value pairs containing the default Paper Size values.
133 public static function &getDefaultValues() {
134 $params = array('is_active' => 1, 'is_default' => 1);
136 if (!self
::retrieve($params, $defaults)) {
137 foreach (self
::$optionValueFields as $name => $field) {
138 $defaults[$name] = $field['default'];
140 $filter = array('option_group_id' => self
::_getGid());
141 $defaults['weight'] = CRM_Utils_Weight
::getDefaultWeight('CRM_Core_DAO_OptionValue', $filter);
147 * Get Paper Size from the DB.
149 * @param string $field
150 * Field name to search by.
152 * Field value to search for.
155 * (reference) associative array of name/value pairs
157 public static function &getPaperFormat($field, $val) {
158 $params = array('is_active' => 1, $field => $val);
159 $paperFormat = array();
160 if (self
::retrieve($params, $paperFormat)) {
164 return self
::getDefaultValues();
169 * Get Paper Size by Name.
172 * Paper Size name. Empty = get default Paper Size.
175 * (reference) associative array of name/value pairs
177 public static function &getByName($name) {
178 return self
::getPaperFormat('name', $name);
182 * Get Paper Size by ID.
185 * Paper Size id. 0 = get default Paper Size.
188 * (reference) associative array of name/value pairs
190 public static function &getById($id) {
191 return self
::getPaperFormat('id', $id);
195 * Get Paper Size field from associative array.
197 * @param string $field
198 * Name of a Paper Size field.
199 * @param array (reference) $values associative array of name/value pairs containing
200 * Paper Size field selections
202 * @param null $default
206 public static function getValue($field, &$values, $default = NULL) {
207 if (array_key_exists($field, self
::$optionValueFields)) {
208 switch (self
::$optionValueFields[$field]['type']) {
209 case CRM_Utils_Type
::T_INT
:
210 return (int) CRM_Utils_Array
::value($field, $values, $default);
212 case CRM_Utils_Type
::T_FLOAT
:
213 // Round float values to three decimal places and trim trailing zeros.
214 // Add a leading zero to values less than 1.
215 $f = sprintf('%05.3f', $values[$field]);
218 return (float) (empty($f) ?
'0' : $f);
220 return CRM_Utils_Array
::value($field, $values, $default);
226 * Retrieve DB object based on input parameters.
228 * It also stores all the retrieved values in the default array.
230 * @param array $params
231 * (reference ) an assoc array of name/value pairs.
232 * @param array $values
233 * (reference ) an assoc array to hold the flattened values.
235 * @return CRM_Core_DAO_OptionValue
237 public static function retrieve(&$params, &$values) {
238 $optionValue = new CRM_Core_DAO_OptionValue();
239 $optionValue->copyValues($params);
240 $optionValue->option_group_id
= self
::_getGid();
241 if ($optionValue->find(TRUE)) {
242 // Extract fields that have been serialized in the 'value' column of the Option Value table.
243 $values = json_decode($optionValue->value
, TRUE);
244 // Add any new fields that don't yet exist in the saved values.
245 foreach (self
::$optionValueFields as $name => $field) {
246 if (!isset($values[$name])) {
247 $values[$name] = $field['default'];
248 if ($field['metric']) {
249 $values[$name] = CRM_Utils_PDF_Utils
::convertMetric($field['default'],
250 self
::$optionValueFields['metric']['default'],
256 // Add fields from the OptionValue base class
257 CRM_Core_DAO
::storeValues($optionValue, $values);
264 * Save the Paper Size in the DB.
266 * @param array (reference) $values associative array of name/value pairs
268 * Id of the database record (null = new record).
270 public function savePaperSize(&$values, $id) {
271 // get the Option Group ID for Paper Sizes (create one if it doesn't exist)
272 $group_id = self
::_getGid(TRUE);
274 // clear other default if this is the new default Paper Size
275 if ($values['is_default']) {
276 $query = "UPDATE civicrm_option_value SET is_default = 0 WHERE option_group_id = $group_id";
277 CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
280 // fetch existing record
287 // new record: set group = custom
288 $values['grouping'] = self
::customGroupName();
290 // copy the supplied form values to the corresponding Option Value fields in the base class
291 foreach ($this->fields() as $name => $field) {
292 $this->$name = trim(CRM_Utils_Array
::value($name, $values, $this->$name));
293 if (empty($this->$name)) {
294 $this->$name = 'null';
298 $this->option_group_id
= $group_id;
299 $this->label
= $this->name
;
300 $this->is_active
= 1;
302 // serialize Paper Size fields into a single string to store in the 'value' column of the Option Value table
303 $v = json_decode($this->value
, TRUE);
304 foreach (self
::$optionValueFields as $name => $field) {
305 $v[$name] = self
::getValue($name, $values, $v[$name]);
307 $this->value
= json_encode($v);
309 // make sure serialized array will fit in the 'value' column
310 $attribute = CRM_Core_DAO
::getAttribute('CRM_Core_BAO_PaperSize', 'value');
311 if (strlen($this->value
) > $attribute['maxlength']) {
312 CRM_Core_Error
::fatal(ts('Paper Size does not fit in database.'));
316 // fix duplicate weights
317 $filter = array('option_group_id' => self
::_getGid());
318 CRM_Utils_Weight
::correctDuplicateWeights('CRM_Core_DAO_OptionValue', $filter);
322 * Delete a Paper Size.
325 * ID of the Paper Size to be deleted.
328 public static function del($id) {
330 $dao = new CRM_Core_DAO_OptionValue();
332 if ($dao->find(TRUE)) {
333 if ($dao->option_group_id
== self
::_getGid()) {
334 $filter = array('option_group_id' => self
::_getGid());
335 CRM_Utils_Weight
::delWeight('CRM_Core_DAO_OptionValue', $id, $filter);
341 CRM_Core_Error
::fatal(ts('Invalid value passed to delete function.'));