3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2018
33 class CRM_Badge_BAO_Layout
extends CRM_Core_DAO_PrintLabel
{
38 public function __construct() {
39 parent
::__construct();
43 * Retrieve DB object based on input parameters.
45 * It also stores all the retrieved values in the default array.
47 * @param array $params
48 * (reference ) an assoc array of name/value pairs.
49 * @param array $defaults
50 * (reference ) an assoc array to hold the flattened values.
52 * @return CRM_Core_DAO_PrintLabel|null
53 * object on success, null otherwise
55 public static function retrieve(&$params, &$defaults) {
56 $printLabel = new CRM_Core_DAO_PrintLabel();
57 $printLabel->copyValues($params);
58 if ($printLabel->find(TRUE)) {
59 CRM_Core_DAO
::storeValues($printLabel, $defaults);
66 * Update the is_active flag in the db.
69 * Id of the database record.
70 * @param bool $is_active
71 * Value we want to set the is_active field.
74 * true if we found and updated the object, else false
76 public static function setIsActive($id, $is_active) {
77 return CRM_Core_DAO
::setFieldValue('CRM_Core_DAO_PrintLabel', $id, 'is_active', $is_active);
83 * @param array $params
84 * Reference array contains the values submitted by the form.
89 public static function create(&$params) {
90 $params['is_active'] = CRM_Utils_Array
::value('is_active', $params, FALSE);
91 $params['is_default'] = CRM_Utils_Array
::value('is_default', $params, FALSE);
92 $params['is_reserved'] = CRM_Utils_Array
::value('is_reserved', $params, FALSE);
94 $params['label_type_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Core_DAO_PrintLabel', 'label_type_id', 'Event Badge');
96 // check if new layout is create, if so set the created_id (if not set)
97 if (empty($params['id'])) {
98 if (empty($params['created_id'])) {
99 $session = CRM_Core_Session
::singleton();
100 $params['created_id'] = $session->get('userID');
104 if (!isset($params['id']) && !isset($params['name'])) {
105 $params['name'] = CRM_Utils_String
::munge($params['title'], '_', 64);
108 // action is taken depending upon the mode
109 $printLabel = new CRM_Core_DAO_PrintLabel();
110 $printLabel->copyValues($params);
112 if ($params['is_default']) {
113 $query = "UPDATE civicrm_print_label SET is_default = 0";
114 CRM_Core_DAO
::executeQuery($query);
122 * Delete name labels.
124 * @param int $printLabelId
125 * ID of the name label to be deleted.
128 public static function del($printLabelId) {
129 $printLabel = new CRM_Core_DAO_PrintLabel();
130 $printLabel->id
= $printLabelId;
131 $printLabel->delete();
135 * get the list of print labels.
140 public static function getList() {
141 $printLabel = new CRM_Core_DAO_PrintLabel();
145 while ($printLabel->fetch()) {
146 $labels[$printLabel->id
] = $printLabel->title
;
152 * Build layout structure.
154 * @param array $params
155 * Associated array of submitted values.
158 * array formatted array
160 public static function buildLayout(&$params) {
161 $layoutParams = array('id' => $params['badge_id']);
162 CRM_Badge_BAO_Layout
::retrieve($layoutParams, $layoutInfo);
164 $formatProperties = CRM_Core_PseudoConstant
::getKey('CRM_Core_DAO_PrintLabel', 'label_format_name', $layoutInfo['label_format_name']);
166 $layoutInfo['format'] = json_decode($formatProperties, TRUE);
167 $layoutInfo['data'] = CRM_Badge_BAO_Layout
::getDecodedData($layoutInfo['data']);
172 * Decode encoded data and return as an array.
174 * @param json $jsonData
178 * associated array of decoded elements
180 static public function getDecodedData($jsonData) {
181 return json_decode($jsonData, TRUE);