CRM/Core/BAO/OptionGroup.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   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_Core_BAO_OptionGroup extends CRM_Core_DAO_OptionGroup {
  36
  37   /**
  38    * Class constructor
  39    */
  40   public function __construct() {
  41     parent::__construct();
  42   }
  43
  44   /**
  45    * Fetch object based on array of properties
  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_BAO_OptionGroup
  53    * @static
  54    */
  55   public static function retrieve(&$params, &$defaults) {
  56     $optionGroup = new CRM_Core_DAO_OptionGroup();
  57     $optionGroup->copyValues($params);
  58     if ($optionGroup->find(TRUE)) {
  59       CRM_Core_DAO::storeValues($optionGroup, $defaults);
  60       return $optionGroup;
  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 Object
  74    *   DAO object on sucess, null otherwise
  75    * @static
  76    */
  77   public static function setIsActive($id, $is_active) {
  78     return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_OptionGroup', $id, 'is_active', $is_active);
  79   }
  80
  81   /**
  82    * Add the Option Group
  83    *
  84    * @param array $params
  85    *   Reference array contains the values submitted by the form.
  86    * @param array $ids
  87    *   Reference array contains the id.
  88    *
  89    * @static
  90    *
  91    * @return object
  92    */
  93   public static function add(&$params, $ids = array()) {
  94     if (empty($params['id'])) {
  95       $params['id'] = CRM_Utils_Array::value('optionGroup', $ids);
  96     }
  97
  98     $params['is_active'] = CRM_Utils_Array::value('is_active', $params, FALSE);
  99     $params['is_default'] = CRM_Utils_Array::value('is_default', $params, FALSE);
 100
 101     // action is taken depending upon the mode
 102     $optionGroup = new CRM_Core_DAO_OptionGroup();
 103     $optionGroup->copyValues($params);;
 104
 105     if ($params['is_default']) {
 106       $query = "UPDATE civicrm_option_group SET is_default = 0";
 107       CRM_Core_DAO::executeQuery($query);
 108     }
 109
 110     $optionGroup->save();
 111     return $optionGroup;
 112   }
 113
 114   /**
 115    * Delete Option Group
 116    *
 117    * @param int $optionGroupId
 118    *   Id of the Option Group to be deleted.
 119    *
 120    * @return void
 121    *
 122    * @static
 123    */
 124   public static function del($optionGroupId) {
 125     // need to delete all option value field before deleting group
 126     $optionValue = new CRM_Core_DAO_OptionValue();
 127     $optionValue->option_group_id = $optionGroupId;
 128     $optionValue->delete();
 129
 130     $optionGroup = new CRM_Core_DAO_OptionGroup();
 131     $optionGroup->id = $optionGroupId;
 132     $optionGroup->delete();
 133   }
 134
 135   /**
 136    * Get title of the option group
 137    *
 138    * @param int $optionGroupId
 139    *   Id of the Option Group.
 140    *
 141    * @return String
 142    *   title
 143    *
 144    * @static
 145    */
 146   public static function getTitle($optionGroupId) {
 147     $optionGroup = new CRM_Core_DAO_OptionGroup();
 148     $optionGroup->id = $optionGroupId;
 149     $optionGroup->find(TRUE);
 150     return $optionGroup->name;
 151   }
 152 }