CRM/Badge/BAO/Layout.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35 class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel {
  36
  37   /**
  38    * class constructor
  39    */
  40   function __construct() {
  41     parent::__construct();
  42   }
  43
  44   /**
  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
  48    *
  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
  51    *
  52    * @return object CRM_Core_DAO_PrintLabel object on success, null otherwise
  53    * @access public
  54    * @static
  55    */
  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);
  61       return $printLabel;
  62     }
  63     return NULL;
  64   }
  65
  66   /**
  67    * update the is_active flag in the db
  68    *
  69    * @param int $id        id of the database record
  70    * @param boolean $is_active value we want to set the is_active field
  71    *
  72    * @return Object             DAO object on success, null otherwise
  73    *
  74    * @access public
  75    * @static
  76    */
  77   static function setIsActive($id, $is_active) {
  78     return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_PrintLabel', $id, 'is_active', $is_active);
  79   }
  80
  81   /**
  82    * Function to add a name label
  83    *
  84    * @param array $params reference array contains the values submitted by the form
  85    *
  86    * @internal param array $ids reference array contains the id
  87    *
  88    * @access public
  89    * @static
  90    *
  91    * @return object
  92    */
  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);
  97
  98     $params['label_type_id'] = CRM_Core_OptionGroup::getValue('label_type', 'Event Badge', 'name');
  99
 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');
 105       }
 106     }
 107
 108     if (!isset($params['id']) && !isset($params['name'])) {
 109       $params['name'] = CRM_Utils_String::munge($params['title'], '_', 64);
 110     }
 111
 112     // action is taken depending upon the mode
 113     $printLabel = new CRM_Core_DAO_PrintLabel();
 114     $printLabel->copyValues($params);
 115
 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);
 119     }
 120
 121     $printLabel->save();
 122     return $printLabel;
 123   }
 124
 125   /**
 126    * Function to delete name labels
 127    *
 128    * @param  int $printLabelId ID of the name label to be deleted.
 129    *
 130    * @access public
 131    * @static
 132    */
 133   static function del($printLabelId) {
 134     $printLabel = new CRM_Core_DAO_PrintLabel();
 135     $printLabel->id = $printLabelId;
 136     $printLabel->delete();
 137   }
 138
 139   /**
 140    *  get the list of print labels
 141    *
 142    * @return array list of labels
 143    * @access public
 144    * @static
 145    */
 146   static function getList() {
 147     $printLabel = new CRM_Core_DAO_PrintLabel();
 148     $printLabel->find();
 149
 150     $labels = array();
 151     while($printLabel->fetch()) {
 152       $labels[$printLabel->id] = $printLabel->title;
 153     }
 154     return $labels;
 155   }
 156
 157   /**
 158    * build layout structure
 159    *
 160    * @param array $params associated array of submitted values
 161    *
 162    * @return array $formattedLayout array formatted array
 163    * @access public
 164    */
 165   static function buildLayout(&$params) {
 166     $layoutParams = array('id' => $params['badge_id']);
 167     CRM_Badge_BAO_Layout::retrieve($layoutParams, $layoutInfo);
 168
 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']);
 172     return $layoutInfo;
 173   }
 174
 175   /**
 176    * Function to decode encoded data and return as an array
 177    *
 178    * @param json $jsonData json object
 179    *
 180    * @return array associated array of decoded elements
 181    * @static
 182    */
 183   static public function getDecodedData($jsonData) {
 184     return json_decode($jsonData, true);
 185   }
 186 }
 187