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   (reference ) an assoc array of name/value pairs
  48    * @param array $defaults (reference ) an assoc array to hold the flattened values
  49    *
  50    * @return CRM_Core_BAO_OptionGroup object
  51    * @static
  52    */
  53   public static function retrieve(&$params, &$defaults) {
  54     $optionGroup = new CRM_Core_DAO_OptionGroup();
  55     $optionGroup->copyValues($params);
  56     if ($optionGroup->find(TRUE)) {
  57       CRM_Core_DAO::storeValues($optionGroup, $defaults);
  58       return $optionGroup;
  59     }
  60     return NULL;
  61   }
  62
  63   /**
  64    * Update the is_active flag in the db
  65    *
  66    * @param int      $id        id of the database record
  67    * @param boolean  $is_active value we want to set the is_active field
  68    *
  69    * @return Object             DAO object on sucess, null otherwise
  70    * @static
  71    */
  72   public static function setIsActive($id, $is_active) {
  73     return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_OptionGroup', $id, 'is_active', $is_active);
  74   }
  75
  76   /**
  77    * Add the Option Group
  78    *
  79    * @param array $params reference array contains the values submitted by the form
  80    * @param array $ids    reference array contains the id
  81    *
  82    * @static
  83    *
  84    * @return object
  85    */
  86   public static function add(&$params, $ids = array()) {
  87     if(empty($params['id'])){
  88       $params['id'] = CRM_Utils_Array::value('optionGroup', $ids);
  89     }
  90
  91     $params['is_active'] = CRM_Utils_Array::value('is_active', $params, FALSE);
  92     $params['is_default'] = CRM_Utils_Array::value('is_default', $params, FALSE);
  93
  94     // action is taken depending upon the mode
  95     $optionGroup = new CRM_Core_DAO_OptionGroup();
  96     $optionGroup->copyValues($params);;
  97
  98     if ($params['is_default']) {
  99       $query = "UPDATE civicrm_option_group SET is_default = 0";
 100       CRM_Core_DAO::executeQuery($query);
 101     }
 102
 103     $optionGroup->save();
 104     return $optionGroup;
 105   }
 106
 107   /**
 108    * Delete Option Group
 109    *
 110    * @param  int  $optionGroupId     Id of the Option Group to be deleted.
 111    *
 112    * @return void
 113    *
 114    * @static
 115    */
 116   public static function del($optionGroupId) {
 117     // need to delete all option value field before deleting group
 118     $optionValue = new CRM_Core_DAO_OptionValue();
 119     $optionValue->option_group_id = $optionGroupId;
 120     $optionValue->delete();
 121
 122     $optionGroup = new CRM_Core_DAO_OptionGroup();
 123     $optionGroup->id = $optionGroupId;
 124     $optionGroup->delete();
 125   }
 126
 127   /**
 128    * Get title of the option group
 129    *
 130    * @param  int  $optionGroupId     Id of the Option Group.
 131    *
 132    * @return String title
 133    *
 134    * @static
 135    */
 136   public static function getTitle($optionGroupId) {
 137     $optionGroup = new CRM_Core_DAO_OptionGroup();
 138     $optionGroup->id = $optionGroupId;
 139     $optionGroup->find(TRUE);
 140     return $optionGroup->name;
 141   }
 142 }