3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
35 class CRM_Badge_BAO_Layout
extends CRM_Core_DAO_PrintLabel
{
40 function __construct() {
41 parent
::__construct();
45 * Takes a bunch of params that are needed to match certain criteria and
46 * retrieves the relevant objects. It also stores all the retrieved
47 * values in the default array
49 * @param array $params (reference ) an assoc array of name/value pairs
50 * @param array $defaults (reference ) an assoc array to hold the flattened values
52 * @return object CRM_Core_DAO_PrintLabel object on success, null otherwise
56 static function retrieve(&$params, &$defaults) {
57 $printLabel = new CRM_Core_DAO_PrintLabel();
58 $printLabel->copyValues($params);
59 if ($printLabel->find(TRUE)) {
60 CRM_Core_DAO
::storeValues($printLabel, $defaults);
67 * update the is_active flag in the db
69 * @param int $id id of the database record
70 * @param boolean $is_active value we want to set the is_active field
72 * @return Object DAO object on success, null otherwise
77 static function setIsActive($id, $is_active) {
78 return CRM_Core_DAO
::setFieldValue('CRM_Core_DAO_PrintLabel', $id, 'is_active', $is_active);
82 * Function to add a name label
84 * @param array $params reference array contains the values submitted by the form
86 * @internal param array $ids reference array contains the id
93 static function create(&$params) {
94 $params['is_active'] = CRM_Utils_Array
::value('is_active', $params, FALSE);
95 $params['is_default'] = CRM_Utils_Array
::value('is_default', $params, FALSE);
96 $params['is_reserved'] = CRM_Utils_Array
::value('is_reserved', $params, FALSE);
98 $params['label_type_id'] = CRM_Core_OptionGroup
::getValue('label_type', 'Event Badge', 'name');
100 // check if new layout is create, if so set the created_id (if not set)
101 if (empty($params['id'])) {
102 if (empty($params['created_id'])) {
103 $session = CRM_Core_Session
::singleton();
104 $params['created_id'] = $session->get('userID');
108 if (!isset($params['id']) && !isset($params['name'])) {
109 $params['name'] = CRM_Utils_String
::munge($params['title'], '_', 64);
112 // action is taken depending upon the mode
113 $printLabel = new CRM_Core_DAO_PrintLabel();
114 $printLabel->copyValues($params);
116 if ($params['is_default']) {
117 $query = "UPDATE civicrm_print_label SET is_default = 0";
118 CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
126 * Function to delete name labels
128 * @param int $printLabelId ID of the name label to be deleted.
133 static function del($printLabelId) {
134 $printLabel = new CRM_Core_DAO_PrintLabel();
135 $printLabel->id
= $printLabelId;
136 $printLabel->delete();
140 * get the list of print labels
142 * @return array list of labels
146 static function getList() {
147 $printLabel = new CRM_Core_DAO_PrintLabel();
151 while($printLabel->fetch()) {
152 $labels[$printLabel->id
] = $printLabel->title
;
158 * build layout structure
160 * @param array $params associated array of submitted values
162 * @return array $formattedLayout array formatted array
165 static function buildLayout(&$params) {
166 $layoutParams = array('id' => $params['badge_id']);
167 CRM_Badge_BAO_Layout
::retrieve($layoutParams, $layoutInfo);
169 $formatProperties = CRM_Core_OptionGroup
::getValue('name_badge', $layoutInfo['label_format_name'], 'name');
170 $layoutInfo['format'] = json_decode($formatProperties, true);
171 $layoutInfo['data'] = CRM_Badge_BAO_Layout
::getDecodedData($layoutInfo['data']);
176 * Function to decode encoded data and return as an array
178 * @param json $jsonData json object
180 * @return array associated array of decoded elements
183 static public function getDecodedData($jsonData) {
184 return json_decode($jsonData, true);