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