5 * @copyright CiviCRM LLC https://civicrm.org/licensing
7 * Generated from xml/schema/CRM/Core/StatusPreference.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:7c7deea1bd07dccee5a5bae0b1d6c4c7)
13 * Database access object for the StatusPreference entity.
15 class CRM_Core_DAO_StatusPreference
extends CRM_Core_DAO
{
16 const EXT
= 'civicrm';
17 const TABLE_ADDED
= '4.7';
20 * Static instance to hold the table name.
24 public static $_tableName = 'civicrm_status_pref';
27 * Should CiviCRM log any modifications to this table in the civicrm_log table.
31 public static $_log = FALSE;
34 * Unique Status Preference ID
41 * Which Domain is this Status Preference for
48 * Name of the status check this preference references.
55 * expires ignore_severity. NULL never hushes.
62 * Hush messages up to and including this severity.
66 public $ignore_severity;
69 * These settings are per-check, and can't be compared across checks.
76 * These values are per-check, and can't be compared across checks.
83 * Is this status check active?
92 public function __construct() {
93 $this->__table
= 'civicrm_status_pref';
94 parent
::__construct();
98 * Returns localized title of this entity.
100 * @param bool $plural
101 * Whether to return the plural version of the title.
103 public static function getEntityTitle($plural = FALSE) {
104 return $plural ?
ts('Status Preferences') : ts('Status Preference');
108 * Returns foreign keys and entity references.
111 * [CRM_Core_Reference_Interface]
113 public static function getReferenceColumns() {
114 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
115 Civi
::$statics[__CLASS__
]['links'] = static::createReferenceColumns(__CLASS__
);
116 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'domain_id', 'civicrm_domain', 'id');
117 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
119 return Civi
::$statics[__CLASS__
]['links'];
123 * Returns all the column names of this table
127 public static function &fields() {
128 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
129 Civi
::$statics[__CLASS__
]['fields'] = [
132 'type' => CRM_Utils_Type
::T_INT
,
133 'title' => ts('Status Preference ID'),
134 'description' => ts('Unique Status Preference ID'),
136 'where' => 'civicrm_status_pref.id',
137 'table_name' => 'civicrm_status_pref',
138 'entity' => 'StatusPreference',
139 'bao' => 'CRM_Core_BAO_StatusPreference',
144 'name' => 'domain_id',
145 'type' => CRM_Utils_Type
::T_INT
,
146 'title' => ts('Setting Domain'),
147 'description' => ts('Which Domain is this Status Preference for'),
149 'where' => 'civicrm_status_pref.domain_id',
150 'table_name' => 'civicrm_status_pref',
151 'entity' => 'StatusPreference',
152 'bao' => 'CRM_Core_BAO_StatusPreference',
154 'FKClassName' => 'CRM_Core_DAO_Domain',
155 'pseudoconstant' => [
156 'table' => 'civicrm_domain',
158 'labelColumn' => 'name',
164 'type' => CRM_Utils_Type
::T_STRING
,
165 'title' => ts('Status Check Name'),
166 'description' => ts('Name of the status check this preference references.'),
169 'size' => CRM_Utils_Type
::HUGE
,
171 'where' => 'civicrm_status_pref.name',
173 'table_name' => 'civicrm_status_pref',
174 'entity' => 'StatusPreference',
175 'bao' => 'CRM_Core_BAO_StatusPreference',
180 'name' => 'hush_until',
181 'type' => CRM_Utils_Type
::T_DATE
,
182 'title' => ts('Snooze Status Notifications Until'),
183 'description' => ts('expires ignore_severity. NULL never hushes.'),
185 'where' => 'civicrm_status_pref.hush_until',
188 'table_name' => 'civicrm_status_pref',
189 'entity' => 'StatusPreference',
190 'bao' => 'CRM_Core_BAO_StatusPreference',
194 'ignore_severity' => [
195 'name' => 'ignore_severity',
196 'type' => CRM_Utils_Type
::T_INT
,
197 'title' => ts('Ignore Severity'),
198 'description' => ts('Hush messages up to and including this severity.'),
200 'where' => 'civicrm_status_pref.ignore_severity',
203 'table_name' => 'civicrm_status_pref',
204 'entity' => 'StatusPreference',
205 'bao' => 'CRM_Core_BAO_StatusPreference',
207 'pseudoconstant' => [
208 'callback' => 'CRM_Utils_Check::getSeverityList',
214 'type' => CRM_Utils_Type
::T_STRING
,
215 'title' => ts('Status Preferences'),
216 'description' => ts('These settings are per-check, and can\'t be compared across checks.'),
218 'size' => CRM_Utils_Type
::HUGE
,
219 'where' => 'civicrm_status_pref.prefs',
220 'table_name' => 'civicrm_status_pref',
221 'entity' => 'StatusPreference',
222 'bao' => 'CRM_Core_BAO_StatusPreference',
227 'name' => 'check_info',
228 'type' => CRM_Utils_Type
::T_STRING
,
229 'title' => ts('Check Info'),
230 'description' => ts('These values are per-check, and can\'t be compared across checks.'),
232 'size' => CRM_Utils_Type
::HUGE
,
233 'where' => 'civicrm_status_pref.check_info',
234 'table_name' => 'civicrm_status_pref',
235 'entity' => 'StatusPreference',
236 'bao' => 'CRM_Core_BAO_StatusPreference',
241 'name' => 'is_active',
242 'type' => CRM_Utils_Type
::T_BOOLEAN
,
243 'title' => ts('Check Is Active'),
244 'description' => ts('Is this status check active?'),
245 'where' => 'civicrm_status_pref.is_active',
247 'table_name' => 'civicrm_status_pref',
248 'entity' => 'StatusPreference',
249 'bao' => 'CRM_Core_BAO_StatusPreference',
254 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
256 return Civi
::$statics[__CLASS__
]['fields'];
260 * Return a mapping from field-name to the corresponding key (as used in fields()).
263 * Array(string $name => string $uniqueName).
265 public static function &fieldKeys() {
266 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
267 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
269 return Civi
::$statics[__CLASS__
]['fieldKeys'];
273 * Returns the names of this table
277 public static function getTableName() {
278 return self
::$_tableName;
282 * Returns if this table needs to be logged
286 public function getLog() {
291 * Returns the list of fields that can be imported
293 * @param bool $prefix
297 public static function &import($prefix = FALSE) {
298 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'status_pref', $prefix, []);
303 * Returns the list of fields that can be exported
305 * @param bool $prefix
309 public static function &export($prefix = FALSE) {
310 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'status_pref', $prefix, []);
315 * Returns the list of indices
317 * @param bool $localize
321 public static function indices($localize = TRUE) {
323 'UI_status_pref_name' => [
324 'name' => 'UI_status_pref_name',
328 'localizable' => FALSE,
329 'sig' => 'civicrm_status_pref::0::name',
332 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;