5 * @copyright CiviCRM LLC https://civicrm.org/licensing
7 * Generated from xml/schema/CRM/Core/Setting.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:24ec63102452f5cdff8424b5caf8b679)
13 * Database access object for the Setting entity.
15 class CRM_Core_DAO_Setting
extends CRM_Core_DAO
{
16 const EXT
= 'civicrm';
17 const TABLE_ADDED
= '4.1';
20 * Static instance to hold the table name.
24 public static $_tableName = 'civicrm_setting';
27 * Should CiviCRM log any modifications to this table in the civicrm_log table.
31 public static $_log = FALSE;
39 * Unique name for setting
46 * data associated with this group / name combo
53 * Which Domain is this menu item for
60 * FK to Contact ID if the setting is localized to a contact
67 * Is this setting a contact specific or site wide setting?
74 * Component that this menu item belongs to
81 * When was the setting created
88 * FK to civicrm_contact, who created this setting
97 public function __construct() {
98 $this->__table
= 'civicrm_setting';
99 parent
::__construct();
103 * Returns localized title of this entity.
105 * @param bool $plural
106 * Whether to return the plural version of the title.
108 public static function getEntityTitle($plural = FALSE) {
109 return $plural ?
ts('Settings') : ts('Setting');
113 * Returns foreign keys and entity references.
116 * [CRM_Core_Reference_Interface]
118 public static function getReferenceColumns() {
119 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
120 Civi
::$statics[__CLASS__
]['links'] = static::createReferenceColumns(__CLASS__
);
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');
125 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
127 return Civi
::$statics[__CLASS__
]['links'];
131 * Returns all the column names of this table
135 public static function &fields() {
136 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
137 Civi
::$statics[__CLASS__
]['fields'] = [
140 'type' => CRM_Utils_Type
::T_INT
,
141 'title' => ts('Setting ID'),
143 'where' => 'civicrm_setting.id',
144 'table_name' => 'civicrm_setting',
145 'entity' => 'Setting',
146 'bao' => 'CRM_Core_BAO_Setting',
152 'type' => CRM_Utils_Type
::T_STRING
,
153 'title' => ts('Setting Name'),
154 'description' => ts('Unique name for setting'),
156 'size' => CRM_Utils_Type
::HUGE
,
157 'where' => 'civicrm_setting.name',
158 'table_name' => 'civicrm_setting',
159 'entity' => 'Setting',
160 'bao' => 'CRM_Core_BAO_Setting',
166 'type' => CRM_Utils_Type
::T_TEXT
,
167 'title' => ts('Value'),
168 'description' => ts('data associated with this group / name combo'),
169 'where' => 'civicrm_setting.value',
170 'table_name' => 'civicrm_setting',
171 'entity' => 'Setting',
172 'bao' => 'CRM_Core_BAO_Setting',
174 'serialize' => self
::SERIALIZE_PHP
,
178 'name' => 'domain_id',
179 'type' => CRM_Utils_Type
::T_INT
,
180 'title' => ts('Setting Domain'),
181 'description' => ts('Which Domain is this menu item for'),
183 'where' => 'civicrm_setting.domain_id',
184 'table_name' => 'civicrm_setting',
185 'entity' => 'Setting',
186 'bao' => 'CRM_Core_BAO_Setting',
188 'FKClassName' => 'CRM_Core_DAO_Domain',
189 'pseudoconstant' => [
190 'table' => 'civicrm_domain',
192 'labelColumn' => 'name',
197 'name' => 'contact_id',
198 'type' => CRM_Utils_Type
::T_INT
,
199 'title' => ts('Setting Contact'),
200 'description' => ts('FK to Contact ID if the setting is localized to a contact'),
201 'where' => 'civicrm_setting.contact_id',
202 'table_name' => 'civicrm_setting',
203 'entity' => 'Setting',
204 'bao' => 'CRM_Core_BAO_Setting',
206 'FKClassName' => 'CRM_Contact_DAO_Contact',
210 'name' => 'is_domain',
211 'type' => CRM_Utils_Type
::T_BOOLEAN
,
212 'title' => ts('Is Domain Setting?'),
213 'description' => ts('Is this setting a contact specific or site wide setting?'),
214 'where' => 'civicrm_setting.is_domain',
215 'table_name' => 'civicrm_setting',
216 'entity' => 'Setting',
217 'bao' => 'CRM_Core_BAO_Setting',
222 'name' => 'component_id',
223 'type' => CRM_Utils_Type
::T_INT
,
224 'title' => ts('Setting Component'),
225 'description' => ts('Component that this menu item belongs to'),
226 'where' => 'civicrm_setting.component_id',
227 'table_name' => 'civicrm_setting',
228 'entity' => 'Setting',
229 'bao' => 'CRM_Core_BAO_Setting',
231 'FKClassName' => 'CRM_Core_DAO_Component',
235 'pseudoconstant' => [
236 'table' => 'civicrm_component',
238 'labelColumn' => 'name',
243 'name' => 'created_date',
244 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
245 'title' => ts('Setting Created Date'),
246 'description' => ts('When was the setting created'),
247 'where' => 'civicrm_setting.created_date',
248 'table_name' => 'civicrm_setting',
249 'entity' => 'Setting',
250 'bao' => 'CRM_Core_BAO_Setting',
255 'name' => 'created_id',
256 'type' => CRM_Utils_Type
::T_INT
,
257 'title' => ts('Setting Created By'),
258 'description' => ts('FK to civicrm_contact, who created this setting'),
259 'where' => 'civicrm_setting.created_id',
260 'table_name' => 'civicrm_setting',
261 'entity' => 'Setting',
262 'bao' => 'CRM_Core_BAO_Setting',
264 'FKClassName' => 'CRM_Contact_DAO_Contact',
268 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
270 return Civi
::$statics[__CLASS__
]['fields'];
274 * Return a mapping from field-name to the corresponding key (as used in fields()).
277 * Array(string $name => string $uniqueName).
279 public static function &fieldKeys() {
280 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
281 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
283 return Civi
::$statics[__CLASS__
]['fieldKeys'];
287 * Returns the names of this table
291 public static function getTableName() {
292 return self
::$_tableName;
296 * Returns if this table needs to be logged
300 public function getLog() {
305 * Returns the list of fields that can be imported
307 * @param bool $prefix
311 public static function &import($prefix = FALSE) {
312 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'setting', $prefix, []);
317 * Returns the list of fields that can be exported
319 * @param bool $prefix
323 public static function &export($prefix = FALSE) {
324 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'setting', $prefix, []);
329 * Returns the list of indices
331 * @param bool $localize
335 public static function indices($localize = TRUE) {
337 'index_domain_contact_name' => [
338 'name' => 'index_domain_contact_name',
344 'localizable' => FALSE,
346 'sig' => 'civicrm_setting::1::domain_id::contact_id::name',
349 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;