CRM/Core/DAO/Setting.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/Setting.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:03045a230d0ba9aa60bf9dd4818cb12e)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_Core_DAO_Setting constructor.
  39  */
  40 class CRM_Core_DAO_Setting extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_setting';
  47   /**
  48    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  49    *
  50    * @var boolean
  51    */
  52   static $_log = false;
  53   /**
  54    *
  55    * @var int unsigned
  56    */
  57   public $id;
  58   /**
  59    * Unique name for setting
  60    *
  61    * @var string
  62    */
  63   public $name;
  64   /**
  65    * data associated with this group / name combo
  66    *
  67    * @var text
  68    */
  69   public $value;
  70   /**
  71    * Which Domain is this menu item for
  72    *
  73    * @var int unsigned
  74    */
  75   public $domain_id;
  76   /**
  77    * FK to Contact ID if the setting is localized to a contact
  78    *
  79    * @var int unsigned
  80    */
  81   public $contact_id;
  82   /**
  83    * Is this setting a contact specific or site wide setting?
  84    *
  85    * @var boolean
  86    */
  87   public $is_domain;
  88   /**
  89    * Component that this menu item belongs to
  90    *
  91    * @var int unsigned
  92    */
  93   public $component_id;
  94   /**
  95    * When was the setting created
  96    *
  97    * @var datetime
  98    */
  99   public $created_date;
 100   /**
 101    * FK to civicrm_contact, who created this setting
 102    *
 103    * @var int unsigned
 104    */
 105   public $created_id;
 106   /**
 107    * Class constructor.
 108    */
 109   function __construct() {
 110     $this->__table = 'civicrm_setting';
 111     parent::__construct();
 112   }
 113   /**
 114    * Returns foreign keys and entity references.
 115    *
 116    * @return array
 117    *   [CRM_Core_Reference_Interface]
 118    */
 119   static function getReferenceColumns() {
 120     if (!isset(Civi::$statics[__CLASS__]['links'])) {
 121       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
 122       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'domain_id', 'civicrm_domain', 'id');
 123       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'contact_id', 'civicrm_contact', 'id');
 124       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'component_id', 'civicrm_component', 'id');
 125       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'created_id', 'civicrm_contact', 'id');
 126       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 127     }
 128     return Civi::$statics[__CLASS__]['links'];
 129   }
 130   /**
 131    * Returns all the column names of this table
 132    *
 133    * @return array
 134    */
 135   static function &fields() {
 136     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 137       Civi::$statics[__CLASS__]['fields'] = array(
 138         'id' => array(
 139           'name' => 'id',
 140           'type' => CRM_Utils_Type::T_INT,
 141           'title' => ts('Setting ID') ,
 142           'required' => true,
 143           'table_name' => 'civicrm_setting',
 144           'entity' => 'Setting',
 145           'bao' => 'CRM_Core_BAO_Setting',
 146         ) ,
 147         'name' => array(
 148           'name' => 'name',
 149           'type' => CRM_Utils_Type::T_STRING,
 150           'title' => ts('Setting Name') ,
 151           'description' => 'Unique name for setting',
 152           'maxlength' => 255,
 153           'size' => CRM_Utils_Type::HUGE,
 154           'table_name' => 'civicrm_setting',
 155           'entity' => 'Setting',
 156           'bao' => 'CRM_Core_BAO_Setting',
 157         ) ,
 158         'value' => array(
 159           'name' => 'value',
 160           'type' => CRM_Utils_Type::T_TEXT,
 161           'title' => ts('Value') ,
 162           'description' => 'data associated with this group / name combo',
 163           'table_name' => 'civicrm_setting',
 164           'entity' => 'Setting',
 165           'bao' => 'CRM_Core_BAO_Setting',
 166         ) ,
 167         'domain_id' => array(
 168           'name' => 'domain_id',
 169           'type' => CRM_Utils_Type::T_INT,
 170           'title' => ts('Setting Domain') ,
 171           'description' => 'Which Domain is this menu item for',
 172           'required' => true,
 173           'table_name' => 'civicrm_setting',
 174           'entity' => 'Setting',
 175           'bao' => 'CRM_Core_BAO_Setting',
 176           'FKClassName' => 'CRM_Core_DAO_Domain',
 177           'pseudoconstant' => array(
 178             'table' => 'civicrm_domain',
 179             'keyColumn' => 'id',
 180             'labelColumn' => 'name',
 181           )
 182         ) ,
 183         'contact_id' => array(
 184           'name' => 'contact_id',
 185           'type' => CRM_Utils_Type::T_INT,
 186           'title' => ts('Setting Contact') ,
 187           'description' => 'FK to Contact ID if the setting is localized to a contact',
 188           'table_name' => 'civicrm_setting',
 189           'entity' => 'Setting',
 190           'bao' => 'CRM_Core_BAO_Setting',
 191           'FKClassName' => 'CRM_Contact_DAO_Contact',
 192         ) ,
 193         'is_domain' => array(
 194           'name' => 'is_domain',
 195           'type' => CRM_Utils_Type::T_BOOLEAN,
 196           'title' => ts('Is Domain Setting?') ,
 197           'description' => 'Is this setting a contact specific or site wide setting?',
 198           'table_name' => 'civicrm_setting',
 199           'entity' => 'Setting',
 200           'bao' => 'CRM_Core_BAO_Setting',
 201         ) ,
 202         'component_id' => array(
 203           'name' => 'component_id',
 204           'type' => CRM_Utils_Type::T_INT,
 205           'title' => ts('Setting Component') ,
 206           'description' => 'Component that this menu item belongs to',
 207           'table_name' => 'civicrm_setting',
 208           'entity' => 'Setting',
 209           'bao' => 'CRM_Core_BAO_Setting',
 210           'FKClassName' => 'CRM_Core_DAO_Component',
 211           'html' => array(
 212             'type' => 'Select',
 213           ) ,
 214           'pseudoconstant' => array(
 215             'table' => 'civicrm_component',
 216             'keyColumn' => 'id',
 217             'labelColumn' => 'name',
 218           )
 219         ) ,
 220         'created_date' => array(
 221           'name' => 'created_date',
 222           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 223           'title' => ts('Setting Created Date') ,
 224           'description' => 'When was the setting created',
 225           'table_name' => 'civicrm_setting',
 226           'entity' => 'Setting',
 227           'bao' => 'CRM_Core_BAO_Setting',
 228         ) ,
 229         'created_id' => array(
 230           'name' => 'created_id',
 231           'type' => CRM_Utils_Type::T_INT,
 232           'title' => ts('Setting Created By') ,
 233           'description' => 'FK to civicrm_contact, who created this setting',
 234           'table_name' => 'civicrm_setting',
 235           'entity' => 'Setting',
 236           'bao' => 'CRM_Core_BAO_Setting',
 237           'FKClassName' => 'CRM_Contact_DAO_Contact',
 238         ) ,
 239       );
 240       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 241     }
 242     return Civi::$statics[__CLASS__]['fields'];
 243   }
 244   /**
 245    * Return a mapping from field-name to the corresponding key (as used in fields()).
 246    *
 247    * @return array
 248    *   Array(string $name => string $uniqueName).
 249    */
 250   static function &fieldKeys() {
 251     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 252       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 253     }
 254     return Civi::$statics[__CLASS__]['fieldKeys'];
 255   }
 256   /**
 257    * Returns the names of this table
 258    *
 259    * @return string
 260    */
 261   static function getTableName() {
 262     return self::$_tableName;
 263   }
 264   /**
 265    * Returns if this table needs to be logged
 266    *
 267    * @return boolean
 268    */
 269   function getLog() {
 270     return self::$_log;
 271   }
 272   /**
 273    * Returns the list of fields that can be imported
 274    *
 275    * @param bool $prefix
 276    *
 277    * @return array
 278    */
 279   static function &import($prefix = false) {
 280     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'setting', $prefix, array());
 281     return $r;
 282   }
 283   /**
 284    * Returns the list of fields that can be exported
 285    *
 286    * @param bool $prefix
 287    *
 288    * @return array
 289    */
 290   static function &export($prefix = false) {
 291     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'setting', $prefix, array());
 292     return $r;
 293   }
 294 }