CRM/Core/DAO/OptionGroup.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.7                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2017                                |
   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  * @package CRM
  29  * @copyright CiviCRM LLC (c) 2004-2017
  30  *
  31  * Generated from xml/schema/CRM/Core/OptionGroup.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:5b506b744806a9089160f2f99714a26a)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_Core_DAO_OptionGroup constructor.
  39  */
  40 class CRM_Core_DAO_OptionGroup extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_option_group';
  47   /**
  48    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  49    *
  50    * @var boolean
  51    */
  52   static $_log = true;
  53   /**
  54    * Option Group ID
  55    *
  56    * @var int unsigned
  57    */
  58   public $id;
  59   /**
  60    * Option group name. Used as selection key by class properties which lookup options in civicrm_option_value.
  61    *
  62    * @var string
  63    */
  64   public $name;
  65   /**
  66    * Option Group title.
  67    *
  68    * @var string
  69    */
  70   public $title;
  71   /**
  72    * Option group description.
  73    *
  74    * @var string
  75    */
  76   public $description;
  77   /**
  78    * Option group description.
  79    *
  80    * @var string
  81    */
  82   public $data_type;
  83   /**
  84    * Is this a predefined system option group (i.e. it can not be deleted)?
  85    *
  86    * @var boolean
  87    */
  88   public $is_reserved;
  89   /**
  90    * Is this option group active?
  91    *
  92    * @var boolean
  93    */
  94   public $is_active;
  95   /**
  96    * A lock to remove the ability to add new options via the UI.
  97    *
  98    * @var boolean
  99    */
 100   public $is_locked;
 101   /**
 102    * Class constructor.
 103    */
 104   function __construct() {
 105     $this->__table = 'civicrm_option_group';
 106     parent::__construct();
 107   }
 108   /**
 109    * Returns all the column names of this table
 110    *
 111    * @return array
 112    */
 113   static function &fields() {
 114     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 115       Civi::$statics[__CLASS__]['fields'] = array(
 116         'id' => array(
 117           'name' => 'id',
 118           'type' => CRM_Utils_Type::T_INT,
 119           'title' => ts('Option Group ID') ,
 120           'description' => 'Option Group ID',
 121           'required' => true,
 122         ) ,
 123         'name' => array(
 124           'name' => 'name',
 125           'type' => CRM_Utils_Type::T_STRING,
 126           'title' => ts('Option Group Name') ,
 127           'description' => 'Option group name. Used as selection key by class properties which lookup options in civicrm_option_value.',
 128           'required' => true,
 129           'maxlength' => 64,
 130           'size' => CRM_Utils_Type::BIG,
 131         ) ,
 132         'title' => array(
 133           'name' => 'title',
 134           'type' => CRM_Utils_Type::T_STRING,
 135           'title' => ts('Option Group title') ,
 136           'description' => 'Option Group title.',
 137           'maxlength' => 255,
 138           'size' => CRM_Utils_Type::HUGE,
 139         ) ,
 140         'description' => array(
 141           'name' => 'description',
 142           'type' => CRM_Utils_Type::T_STRING,
 143           'title' => ts('Option Group Description') ,
 144           'description' => 'Option group description.',
 145           'maxlength' => 255,
 146           'size' => CRM_Utils_Type::HUGE,
 147         ) ,
 148         'data_type' => array(
 149           'name' => 'data_type',
 150           'type' => CRM_Utils_Type::T_STRING,
 151           'title' => ts('Data Type for this option group') ,
 152           'description' => 'Option group description.',
 153           'maxlength' => 128,
 154           'size' => CRM_Utils_Type::HUGE,
 155           'pseudoconstant' => array(
 156             'callback' => 'CRM_Utils_Type::dataTypes',
 157           )
 158         ) ,
 159         'is_reserved' => array(
 160           'name' => 'is_reserved',
 161           'type' => CRM_Utils_Type::T_BOOLEAN,
 162           'title' => ts('Option Group Is Reserved?') ,
 163           'description' => 'Is this a predefined system option group (i.e. it can not be deleted)?',
 164           'default' => '1',
 165         ) ,
 166         'is_active' => array(
 167           'name' => 'is_active',
 168           'type' => CRM_Utils_Type::T_BOOLEAN,
 169           'title' => ts('Option Group Is Active?') ,
 170           'description' => 'Is this option group active?',
 171         ) ,
 172         'is_locked' => array(
 173           'name' => 'is_locked',
 174           'type' => CRM_Utils_Type::T_BOOLEAN,
 175           'title' => ts('Option Group Is Locked') ,
 176           'description' => 'A lock to remove the ability to add new options via the UI.',
 177         ) ,
 178       );
 179       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 180     }
 181     return Civi::$statics[__CLASS__]['fields'];
 182   }
 183   /**
 184    * Return a mapping from field-name to the corresponding key (as used in fields()).
 185    *
 186    * @return array
 187    *   Array(string $name => string $uniqueName).
 188    */
 189   static function &fieldKeys() {
 190     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 191       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 192     }
 193     return Civi::$statics[__CLASS__]['fieldKeys'];
 194   }
 195   /**
 196    * Returns the names of this table
 197    *
 198    * @return string
 199    */
 200   static function getTableName() {
 201     return CRM_Core_DAO::getLocaleTableName(self::$_tableName);
 202   }
 203   /**
 204    * Returns if this table needs to be logged
 205    *
 206    * @return boolean
 207    */
 208   function getLog() {
 209     return self::$_log;
 210   }
 211   /**
 212    * Returns the list of fields that can be imported
 213    *
 214    * @param bool $prefix
 215    *
 216    * @return array
 217    */
 218   static function &import($prefix = false) {
 219     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'option_group', $prefix, array());
 220     return $r;
 221   }
 222   /**
 223    * Returns the list of fields that can be exported
 224    *
 225    * @param bool $prefix
 226    *
 227    * @return array
 228    */
 229   static function &export($prefix = false) {
 230     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'option_group', $prefix, array());
 231     return $r;
 232   }
 233 }