Commit | Line | Data |
---|---|---|
e501603b | 1 | <?php |
c3fc2621 | 2 | |
e501603b TO |
3 | /** |
4 | * @package CRM | |
ca5cec67 | 5 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
e501603b TO |
6 | * |
7 | * Generated from xml/schema/CRM/Core/Setting.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
d31fb4e3 | 9 | * (GenCodeChecksum:2eb3a69876a76a1aca598e6bfb7031a4) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the Setting entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Core_DAO_Setting extends CRM_Core_DAO { |
929a1c14 CW |
16 | const EXT = 'civicrm'; |
17 | const TABLE_ADDED = '4.1'; | |
c3fc2621 | 18 | |
e501603b | 19 | /** |
f41f0342 | 20 | * Static instance to hold the table name. |
e501603b TO |
21 | * |
22 | * @var string | |
23 | */ | |
fa45b5b9 | 24 | public static $_tableName = 'civicrm_setting'; |
c3fc2621 | 25 | |
e501603b | 26 | /** |
f41f0342 | 27 | * Should CiviCRM log any modifications to this table in the civicrm_log table. |
e501603b | 28 | * |
c3fc2621 | 29 | * @var bool |
e501603b | 30 | */ |
fa45b5b9 | 31 | public static $_log = FALSE; |
c3fc2621 | 32 | |
e501603b | 33 | /** |
e6ca0a57 | 34 | * @var int |
e501603b TO |
35 | */ |
36 | public $id; | |
c3fc2621 | 37 | |
e501603b TO |
38 | /** |
39 | * Unique name for setting | |
40 | * | |
41 | * @var string | |
42 | */ | |
43 | public $name; | |
c3fc2621 | 44 | |
e501603b TO |
45 | /** |
46 | * data associated with this group / name combo | |
47 | * | |
48 | * @var text | |
49 | */ | |
50 | public $value; | |
c3fc2621 | 51 | |
e501603b TO |
52 | /** |
53 | * Which Domain is this menu item for | |
54 | * | |
e6ca0a57 | 55 | * @var int |
e501603b TO |
56 | */ |
57 | public $domain_id; | |
c3fc2621 | 58 | |
e501603b TO |
59 | /** |
60 | * FK to Contact ID if the setting is localized to a contact | |
61 | * | |
e6ca0a57 | 62 | * @var int |
e501603b TO |
63 | */ |
64 | public $contact_id; | |
c3fc2621 | 65 | |
e501603b TO |
66 | /** |
67 | * Is this setting a contact specific or site wide setting? | |
68 | * | |
e6ca0a57 | 69 | * @var bool |
e501603b TO |
70 | */ |
71 | public $is_domain; | |
c3fc2621 | 72 | |
e501603b TO |
73 | /** |
74 | * Component that this menu item belongs to | |
75 | * | |
e6ca0a57 | 76 | * @var int |
e501603b TO |
77 | */ |
78 | public $component_id; | |
c3fc2621 | 79 | |
e501603b TO |
80 | /** |
81 | * When was the setting created | |
82 | * | |
83 | * @var datetime | |
84 | */ | |
85 | public $created_date; | |
c3fc2621 | 86 | |
e501603b TO |
87 | /** |
88 | * FK to civicrm_contact, who created this setting | |
89 | * | |
e6ca0a57 | 90 | * @var int |
e501603b TO |
91 | */ |
92 | public $created_id; | |
c3fc2621 | 93 | |
e501603b | 94 | /** |
f41f0342 | 95 | * Class constructor. |
e501603b | 96 | */ |
c3fc2621 | 97 | public function __construct() { |
e501603b TO |
98 | $this->__table = 'civicrm_setting'; |
99 | parent::__construct(); | |
100 | } | |
c3fc2621 | 101 | |
449c4e6b CW |
102 | /** |
103 | * Returns localized title of this entity. | |
7b66c3b5 AH |
104 | * |
105 | * @param bool $plural | |
106 | * Whether to return the plural version of the title. | |
449c4e6b | 107 | */ |
7b66c3b5 AH |
108 | public static function getEntityTitle($plural = FALSE) { |
109 | return $plural ? ts('Settings') : ts('Setting'); | |
449c4e6b CW |
110 | } |
111 | ||
e501603b | 112 | /** |
f41f0342 | 113 | * Returns foreign keys and entity references. |
e501603b TO |
114 | * |
115 | * @return array | |
116 | * [CRM_Core_Reference_Interface] | |
117 | */ | |
c3fc2621 | 118 | public static function getReferenceColumns() { |
346aaaba | 119 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
fa45b5b9 | 120 | Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); |
c3fc2621 CW |
121 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'domain_id', 'civicrm_domain', 'id'); |
122 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contact_id', 'civicrm_contact', 'id'); | |
123 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'component_id', 'civicrm_component', 'id'); | |
124 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'created_id', 'civicrm_contact', 'id'); | |
346aaaba | 125 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 126 | } |
346aaaba | 127 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 128 | } |
c3fc2621 | 129 | |
e501603b TO |
130 | /** |
131 | * Returns all the column names of this table | |
132 | * | |
133 | * @return array | |
134 | */ | |
c3fc2621 | 135 | public static function &fields() { |
346aaaba | 136 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
137 | Civi::$statics[__CLASS__]['fields'] = [ |
138 | 'id' => [ | |
e501603b TO |
139 | 'name' => 'id', |
140 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 CW |
141 | 'title' => ts('Setting ID'), |
142 | 'required' => TRUE, | |
a36434b9 | 143 | 'where' => 'civicrm_setting.id', |
522a26c9 | 144 | 'table_name' => 'civicrm_setting', |
145 | 'entity' => 'Setting', | |
146 | 'bao' => 'CRM_Core_BAO_Setting', | |
6a7e5e5d | 147 | 'localizable' => 0, |
a9d0587b | 148 | 'add' => '4.1', |
c3fc2621 CW |
149 | ], |
150 | 'name' => [ | |
e501603b TO |
151 | 'name' => 'name', |
152 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 153 | 'title' => ts('Setting Name'), |
215b423e | 154 | 'description' => ts('Unique name for setting'), |
e501603b TO |
155 | 'maxlength' => 255, |
156 | 'size' => CRM_Utils_Type::HUGE, | |
a36434b9 | 157 | 'where' => 'civicrm_setting.name', |
522a26c9 | 158 | 'table_name' => 'civicrm_setting', |
159 | 'entity' => 'Setting', | |
160 | 'bao' => 'CRM_Core_BAO_Setting', | |
6a7e5e5d | 161 | 'localizable' => 0, |
a9d0587b | 162 | 'add' => '4.1', |
c3fc2621 CW |
163 | ], |
164 | 'value' => [ | |
e501603b TO |
165 | 'name' => 'value', |
166 | 'type' => CRM_Utils_Type::T_TEXT, | |
c3fc2621 | 167 | 'title' => ts('Value'), |
215b423e | 168 | 'description' => ts('data associated with this group / name combo'), |
a36434b9 | 169 | 'where' => 'civicrm_setting.value', |
522a26c9 | 170 | 'table_name' => 'civicrm_setting', |
171 | 'entity' => 'Setting', | |
172 | 'bao' => 'CRM_Core_BAO_Setting', | |
6a7e5e5d | 173 | 'localizable' => 0, |
2a5c9b4d | 174 | 'serialize' => self::SERIALIZE_PHP, |
a9d0587b | 175 | 'add' => '4.1', |
c3fc2621 CW |
176 | ], |
177 | 'domain_id' => [ | |
e501603b TO |
178 | 'name' => 'domain_id', |
179 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 180 | 'title' => ts('Setting Domain'), |
215b423e | 181 | 'description' => ts('Which Domain is this menu item for'), |
c3fc2621 | 182 | 'required' => TRUE, |
a36434b9 | 183 | 'where' => 'civicrm_setting.domain_id', |
522a26c9 | 184 | 'table_name' => 'civicrm_setting', |
185 | 'entity' => 'Setting', | |
186 | 'bao' => 'CRM_Core_BAO_Setting', | |
6a7e5e5d | 187 | 'localizable' => 0, |
e501603b | 188 | 'FKClassName' => 'CRM_Core_DAO_Domain', |
c3fc2621 | 189 | 'pseudoconstant' => [ |
e501603b TO |
190 | 'table' => 'civicrm_domain', |
191 | 'keyColumn' => 'id', | |
192 | 'labelColumn' => 'name', | |
e6ca0a57 | 193 | ], |
a9d0587b | 194 | 'add' => '4.1', |
c3fc2621 CW |
195 | ], |
196 | 'contact_id' => [ | |
e501603b TO |
197 | 'name' => 'contact_id', |
198 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 199 | 'title' => ts('Setting Contact'), |
215b423e | 200 | 'description' => ts('FK to Contact ID if the setting is localized to a contact'), |
a36434b9 | 201 | 'where' => 'civicrm_setting.contact_id', |
522a26c9 | 202 | 'table_name' => 'civicrm_setting', |
203 | 'entity' => 'Setting', | |
204 | 'bao' => 'CRM_Core_BAO_Setting', | |
6a7e5e5d | 205 | 'localizable' => 0, |
e501603b | 206 | 'FKClassName' => 'CRM_Contact_DAO_Contact', |
a9d0587b | 207 | 'add' => '4.1', |
c3fc2621 CW |
208 | ], |
209 | 'is_domain' => [ | |
e501603b TO |
210 | 'name' => 'is_domain', |
211 | 'type' => CRM_Utils_Type::T_BOOLEAN, | |
c3fc2621 | 212 | 'title' => ts('Is Domain Setting?'), |
215b423e | 213 | 'description' => ts('Is this setting a contact specific or site wide setting?'), |
a36434b9 | 214 | 'where' => 'civicrm_setting.is_domain', |
522a26c9 | 215 | 'table_name' => 'civicrm_setting', |
216 | 'entity' => 'Setting', | |
217 | 'bao' => 'CRM_Core_BAO_Setting', | |
6a7e5e5d | 218 | 'localizable' => 0, |
a9d0587b | 219 | 'add' => '4.1', |
c3fc2621 CW |
220 | ], |
221 | 'component_id' => [ | |
e501603b TO |
222 | 'name' => 'component_id', |
223 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 224 | 'title' => ts('Setting Component'), |
215b423e | 225 | 'description' => ts('Component that this menu item belongs to'), |
a36434b9 | 226 | 'where' => 'civicrm_setting.component_id', |
522a26c9 | 227 | 'table_name' => 'civicrm_setting', |
228 | 'entity' => 'Setting', | |
229 | 'bao' => 'CRM_Core_BAO_Setting', | |
6a7e5e5d | 230 | 'localizable' => 0, |
e501603b | 231 | 'FKClassName' => 'CRM_Core_DAO_Component', |
c3fc2621 | 232 | 'html' => [ |
e501603b | 233 | 'type' => 'Select', |
c3fc2621 CW |
234 | ], |
235 | 'pseudoconstant' => [ | |
e501603b TO |
236 | 'table' => 'civicrm_component', |
237 | 'keyColumn' => 'id', | |
238 | 'labelColumn' => 'name', | |
e6ca0a57 | 239 | ], |
a9d0587b | 240 | 'add' => '4.1', |
c3fc2621 CW |
241 | ], |
242 | 'created_date' => [ | |
e501603b TO |
243 | 'name' => 'created_date', |
244 | 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME, | |
c3fc2621 | 245 | 'title' => ts('Setting Created Date'), |
215b423e | 246 | 'description' => ts('When was the setting created'), |
a36434b9 | 247 | 'where' => 'civicrm_setting.created_date', |
522a26c9 | 248 | 'table_name' => 'civicrm_setting', |
249 | 'entity' => 'Setting', | |
250 | 'bao' => 'CRM_Core_BAO_Setting', | |
6a7e5e5d | 251 | 'localizable' => 0, |
a9d0587b | 252 | 'add' => '4.1', |
c3fc2621 CW |
253 | ], |
254 | 'created_id' => [ | |
e501603b TO |
255 | 'name' => 'created_id', |
256 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 257 | 'title' => ts('Setting Created By'), |
215b423e | 258 | 'description' => ts('FK to civicrm_contact, who created this setting'), |
a36434b9 | 259 | 'where' => 'civicrm_setting.created_id', |
522a26c9 | 260 | 'table_name' => 'civicrm_setting', |
261 | 'entity' => 'Setting', | |
262 | 'bao' => 'CRM_Core_BAO_Setting', | |
6a7e5e5d | 263 | 'localizable' => 0, |
e501603b | 264 | 'FKClassName' => 'CRM_Contact_DAO_Contact', |
a9d0587b | 265 | 'add' => '4.1', |
c3fc2621 CW |
266 | ], |
267 | ]; | |
346aaaba | 268 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 269 | } |
346aaaba | 270 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 271 | } |
c3fc2621 | 272 | |
e501603b | 273 | /** |
bd8e0b14 | 274 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
275 | * |
276 | * @return array | |
bd8e0b14 | 277 | * Array(string $name => string $uniqueName). |
e501603b | 278 | */ |
c3fc2621 | 279 | public static function &fieldKeys() { |
bd8e0b14 TO |
280 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
281 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 282 | } |
bd8e0b14 | 283 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 284 | } |
c3fc2621 | 285 | |
e501603b TO |
286 | /** |
287 | * Returns the names of this table | |
288 | * | |
289 | * @return string | |
290 | */ | |
c3fc2621 | 291 | public static function getTableName() { |
e501603b TO |
292 | return self::$_tableName; |
293 | } | |
c3fc2621 | 294 | |
e501603b TO |
295 | /** |
296 | * Returns if this table needs to be logged | |
297 | * | |
c3fc2621 | 298 | * @return bool |
e501603b | 299 | */ |
c3fc2621 | 300 | public function getLog() { |
e501603b TO |
301 | return self::$_log; |
302 | } | |
c3fc2621 | 303 | |
e501603b TO |
304 | /** |
305 | * Returns the list of fields that can be imported | |
306 | * | |
307 | * @param bool $prefix | |
308 | * | |
309 | * @return array | |
310 | */ | |
c3fc2621 CW |
311 | public static function &import($prefix = FALSE) { |
312 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'setting', $prefix, []); | |
60808919 | 313 | return $r; |
e501603b | 314 | } |
c3fc2621 | 315 | |
e501603b TO |
316 | /** |
317 | * Returns the list of fields that can be exported | |
318 | * | |
319 | * @param bool $prefix | |
320 | * | |
321 | * @return array | |
322 | */ | |
c3fc2621 CW |
323 | public static function &export($prefix = FALSE) { |
324 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'setting', $prefix, []); | |
60808919 | 325 | return $r; |
e501603b | 326 | } |
c3fc2621 | 327 | |
e7a6b91a AS |
328 | /** |
329 | * Returns the list of indices | |
c3fc2621 CW |
330 | * |
331 | * @param bool $localize | |
332 | * | |
333 | * @return array | |
e7a6b91a AS |
334 | */ |
335 | public static function indices($localize = TRUE) { | |
c3fc2621 CW |
336 | $indices = [ |
337 | 'index_domain_contact_name' => [ | |
e7a6b91a | 338 | 'name' => 'index_domain_contact_name', |
c3fc2621 | 339 | 'field' => [ |
e7a6b91a AS |
340 | 0 => 'domain_id', |
341 | 1 => 'contact_id', | |
342 | 2 => 'name', | |
c3fc2621 CW |
343 | ], |
344 | 'localizable' => FALSE, | |
345 | 'unique' => TRUE, | |
e7a6b91a | 346 | 'sig' => 'civicrm_setting::1::domain_id::contact_id::name', |
c3fc2621 CW |
347 | ], |
348 | ]; | |
e7a6b91a AS |
349 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
350 | } | |
c3fc2621 | 351 | |
e501603b | 352 | } |