CRM/Badge/BAO/Layout.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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-2019
  32  */
  33 class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel {
  34
  35   /**
  36    * Class constructor.
  37    */
  38   public function __construct() {
  39     parent::__construct();
  40   }
  41
  42   /**
  43    * Retrieve DB object based on input parameters.
  44    *
  45    * It also stores all the retrieved values in the default array.
  46    *
  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.
  51    *
  52    * @return CRM_Core_DAO_PrintLabel|null
  53    *   object on success, null otherwise
  54    */
  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);
  60       return $printLabel;
  61     }
  62     return NULL;
  63   }
  64
  65   /**
  66    * Update the is_active flag in the db.
  67    *
  68    * @param int $id
  69    *   Id of the database record.
  70    * @param bool $is_active
  71    *   Value we want to set the is_active field.
  72    *
  73    * @return bool
  74    *   true if we found and updated the object, else false
  75    */
  76   public static function setIsActive($id, $is_active) {
  77     return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_PrintLabel', $id, 'is_active', $is_active);
  78   }
  79
  80   /**
  81    * Add a name label.
  82    *
  83    * @param array $params
  84    *   Reference array contains the values submitted by the form.
  85    *
  86    *
  87    * @return object
  88    */
  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);
  93
  94     $params['label_type_id'] = CRM_Core_PseudoConstant::getKey('CRM_Core_DAO_PrintLabel', 'label_type_id', 'Event Badge');
  95
  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');
 101       }
 102     }
 103
 104     if (!isset($params['id']) && !isset($params['name'])) {
 105       $params['name'] = CRM_Utils_String::munge($params['title'], '_', 64);
 106     }
 107
 108     // action is taken depending upon the mode
 109     $printLabel = new CRM_Core_DAO_PrintLabel();
 110     $printLabel->copyValues($params);
 111
 112     if ($params['is_default']) {
 113       $query = "UPDATE civicrm_print_label SET is_default = 0";
 114       CRM_Core_DAO::executeQuery($query);
 115     }
 116
 117     $printLabel->save();
 118     return $printLabel;
 119   }
 120
 121   /**
 122    * Delete name labels.
 123    *
 124    * @param int $printLabelId
 125    *   ID of the name label to be deleted.
 126    *
 127    */
 128   public static function del($printLabelId) {
 129     $printLabel = new CRM_Core_DAO_PrintLabel();
 130     $printLabel->id = $printLabelId;
 131     $printLabel->delete();
 132   }
 133
 134   /**
 135    *  get the list of print labels.
 136    *
 137    * @return array
 138    *   list of labels
 139    */
 140   public static function getList() {
 141     $printLabel = new CRM_Core_DAO_PrintLabel();
 142     $printLabel->find();
 143
 144     $labels = array();
 145     while ($printLabel->fetch()) {
 146       $labels[$printLabel->id] = $printLabel->title;
 147     }
 148     return $labels;
 149   }
 150
 151   /**
 152    * Build layout structure.
 153    *
 154    * @param array $params
 155    *   Associated array of submitted values.
 156    *
 157    * @return array
 158    *   array formatted array
 159    */
 160   public static function buildLayout(&$params) {
 161     $layoutParams = array('id' => $params['badge_id']);
 162     CRM_Badge_BAO_Layout::retrieve($layoutParams, $layoutInfo);
 163
 164     $formatProperties = CRM_Core_PseudoConstant::getKey('CRM_Core_DAO_PrintLabel', 'label_format_name', $layoutInfo['label_format_name']);
 165
 166     $layoutInfo['format'] = json_decode($formatProperties, TRUE);
 167     $layoutInfo['data'] = CRM_Badge_BAO_Layout::getDecodedData($layoutInfo['data']);
 168     return $layoutInfo;
 169   }
 170
 171   /**
 172    * Decode encoded data and return as an array.
 173    *
 174    * @param json $jsonData
 175    *   Json object.
 176    *
 177    * @return array
 178    *   associated array of decoded elements
 179    */
 180   static public function getDecodedData($jsonData) {
 181     return json_decode($jsonData, TRUE);
 182   }
 183
 184 }