CRM/Core/DAO/StatusPreference.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/Core/StatusPreference.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:97f98c6f510e57260d2a5e3647a00d4f)
  10  */
  11
  12 /**
  13  * Database access object for the StatusPreference entity.
  14  */
  15 class CRM_Core_DAO_StatusPreference extends CRM_Core_DAO {
  16   const EXT = 'civicrm';
  17   const TABLE_ADDED = '4.7';
  18
  19   /**
  20    * Static instance to hold the table name.
  21    *
  22    * @var string
  23    */
  24   public static $_tableName = 'civicrm_status_pref';
  25
  26   /**
  27    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  28    *
  29    * @var bool
  30    */
  31   public static $_log = FALSE;
  32
  33   /**
  34    * Unique Status Preference ID
  35    *
  36    * @var int
  37    */
  38   public $id;
  39
  40   /**
  41    * Which Domain is this Status Preference for
  42    *
  43    * @var int
  44    */
  45   public $domain_id;
  46
  47   /**
  48    * Name of the status check this preference references.
  49    *
  50    * @var string
  51    */
  52   public $name;
  53
  54   /**
  55    * expires ignore_severity.  NULL never hushes.
  56    *
  57    * @var date
  58    */
  59   public $hush_until;
  60
  61   /**
  62    * Hush messages up to and including this severity.
  63    *
  64    * @var int
  65    */
  66   public $ignore_severity;
  67
  68   /**
  69    * These settings are per-check, and can't be compared across checks.
  70    *
  71    * @var string
  72    */
  73   public $prefs;
  74
  75   /**
  76    * These values are per-check, and can't be compared across checks.
  77    *
  78    * @var string
  79    */
  80   public $check_info;
  81
  82   /**
  83    * Is this status check active?
  84    *
  85    * @var bool
  86    */
  87   public $is_active;
  88
  89   /**
  90    * Class constructor.
  91    */
  92   public function __construct() {
  93     $this->__table = 'civicrm_status_pref';
  94     parent::__construct();
  95   }
  96
  97   /**
  98    * Returns localized title of this entity.
  99    *
 100    * @param bool $plural
 101    *   Whether to return the plural version of the title.
 102    */
 103   public static function getEntityTitle($plural = FALSE) {
 104     return $plural ? ts('Status Preferences') : ts('Status Preference');
 105   }
 106
 107   /**
 108    * Returns foreign keys and entity references.
 109    *
 110    * @return array
 111    *   [CRM_Core_Reference_Interface]
 112    */
 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']);
 118     }
 119     return Civi::$statics[__CLASS__]['links'];
 120   }
 121
 122   /**
 123    * Returns all the column names of this table
 124    *
 125    * @return array
 126    */
 127   public static function &fields() {
 128     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 129       Civi::$statics[__CLASS__]['fields'] = [
 130         'id' => [
 131           'name' => 'id',
 132           'type' => CRM_Utils_Type::T_INT,
 133           'title' => ts('Status Preference ID'),
 134           'description' => ts('Unique Status Preference ID'),
 135           'required' => TRUE,
 136           'where' => 'civicrm_status_pref.id',
 137           'table_name' => 'civicrm_status_pref',
 138           'entity' => 'StatusPreference',
 139           'bao' => 'CRM_Core_BAO_StatusPreference',
 140           'localizable' => 0,
 141           'html' => [
 142             'type' => 'Number',
 143           ],
 144           'readonly' => TRUE,
 145           'add' => '4.7',
 146         ],
 147         'domain_id' => [
 148           'name' => 'domain_id',
 149           'type' => CRM_Utils_Type::T_INT,
 150           'title' => ts('Domain ID'),
 151           'description' => ts('Which Domain is this Status Preference for'),
 152           'required' => TRUE,
 153           'where' => 'civicrm_status_pref.domain_id',
 154           'table_name' => 'civicrm_status_pref',
 155           'entity' => 'StatusPreference',
 156           'bao' => 'CRM_Core_BAO_StatusPreference',
 157           'localizable' => 0,
 158           'FKClassName' => 'CRM_Core_DAO_Domain',
 159           'html' => [
 160             'label' => ts("Domain"),
 161           ],
 162           'pseudoconstant' => [
 163             'table' => 'civicrm_domain',
 164             'keyColumn' => 'id',
 165             'labelColumn' => 'name',
 166           ],
 167           'add' => '4.7',
 168         ],
 169         'name' => [
 170           'name' => 'name',
 171           'type' => CRM_Utils_Type::T_STRING,
 172           'title' => ts('Status Check Name'),
 173           'description' => ts('Name of the status check this preference references.'),
 174           'required' => TRUE,
 175           'maxlength' => 255,
 176           'size' => CRM_Utils_Type::HUGE,
 177           'import' => TRUE,
 178           'where' => 'civicrm_status_pref.name',
 179           'export' => TRUE,
 180           'table_name' => 'civicrm_status_pref',
 181           'entity' => 'StatusPreference',
 182           'bao' => 'CRM_Core_BAO_StatusPreference',
 183           'localizable' => 0,
 184           'add' => '4.7',
 185         ],
 186         'hush_until' => [
 187           'name' => 'hush_until',
 188           'type' => CRM_Utils_Type::T_DATE,
 189           'title' => ts('Snooze Status Notifications Until'),
 190           'description' => ts('expires ignore_severity.  NULL never hushes.'),
 191           'import' => TRUE,
 192           'where' => 'civicrm_status_pref.hush_until',
 193           'export' => TRUE,
 194           'default' => NULL,
 195           'table_name' => 'civicrm_status_pref',
 196           'entity' => 'StatusPreference',
 197           'bao' => 'CRM_Core_BAO_StatusPreference',
 198           'localizable' => 0,
 199           'add' => '4.7',
 200         ],
 201         'ignore_severity' => [
 202           'name' => 'ignore_severity',
 203           'type' => CRM_Utils_Type::T_INT,
 204           'title' => ts('Ignore Severity'),
 205           'description' => ts('Hush messages up to and including this severity.'),
 206           'import' => TRUE,
 207           'where' => 'civicrm_status_pref.ignore_severity',
 208           'export' => TRUE,
 209           'default' => '1',
 210           'table_name' => 'civicrm_status_pref',
 211           'entity' => 'StatusPreference',
 212           'bao' => 'CRM_Core_BAO_StatusPreference',
 213           'localizable' => 0,
 214           'pseudoconstant' => [
 215             'callback' => 'CRM_Utils_Check::getSeverityList',
 216           ],
 217           'add' => '4.7',
 218         ],
 219         'prefs' => [
 220           'name' => 'prefs',
 221           'type' => CRM_Utils_Type::T_STRING,
 222           'title' => ts('Status Preferences'),
 223           'description' => ts('These settings are per-check, and can\'t be compared across checks.'),
 224           'maxlength' => 255,
 225           'size' => CRM_Utils_Type::HUGE,
 226           'where' => 'civicrm_status_pref.prefs',
 227           'table_name' => 'civicrm_status_pref',
 228           'entity' => 'StatusPreference',
 229           'bao' => 'CRM_Core_BAO_StatusPreference',
 230           'localizable' => 0,
 231           'add' => '4.7',
 232         ],
 233         'check_info' => [
 234           'name' => 'check_info',
 235           'type' => CRM_Utils_Type::T_STRING,
 236           'title' => ts('Check Info'),
 237           'description' => ts('These values are per-check, and can\'t be compared across checks.'),
 238           'maxlength' => 255,
 239           'size' => CRM_Utils_Type::HUGE,
 240           'where' => 'civicrm_status_pref.check_info',
 241           'table_name' => 'civicrm_status_pref',
 242           'entity' => 'StatusPreference',
 243           'bao' => 'CRM_Core_BAO_StatusPreference',
 244           'localizable' => 0,
 245           'add' => '4.7',
 246         ],
 247         'is_active' => [
 248           'name' => 'is_active',
 249           'type' => CRM_Utils_Type::T_BOOLEAN,
 250           'title' => ts('Check Is Active'),
 251           'description' => ts('Is this status check active?'),
 252           'where' => 'civicrm_status_pref.is_active',
 253           'default' => '1',
 254           'table_name' => 'civicrm_status_pref',
 255           'entity' => 'StatusPreference',
 256           'bao' => 'CRM_Core_BAO_StatusPreference',
 257           'localizable' => 0,
 258           'add' => '5.19',
 259         ],
 260       ];
 261       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 262     }
 263     return Civi::$statics[__CLASS__]['fields'];
 264   }
 265
 266   /**
 267    * Return a mapping from field-name to the corresponding key (as used in fields()).
 268    *
 269    * @return array
 270    *   Array(string $name => string $uniqueName).
 271    */
 272   public static function &fieldKeys() {
 273     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 274       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 275     }
 276     return Civi::$statics[__CLASS__]['fieldKeys'];
 277   }
 278
 279   /**
 280    * Returns the names of this table
 281    *
 282    * @return string
 283    */
 284   public static function getTableName() {
 285     return self::$_tableName;
 286   }
 287
 288   /**
 289    * Returns if this table needs to be logged
 290    *
 291    * @return bool
 292    */
 293   public function getLog() {
 294     return self::$_log;
 295   }
 296
 297   /**
 298    * Returns the list of fields that can be imported
 299    *
 300    * @param bool $prefix
 301    *
 302    * @return array
 303    */
 304   public static function &import($prefix = FALSE) {
 305     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'status_pref', $prefix, []);
 306     return $r;
 307   }
 308
 309   /**
 310    * Returns the list of fields that can be exported
 311    *
 312    * @param bool $prefix
 313    *
 314    * @return array
 315    */
 316   public static function &export($prefix = FALSE) {
 317     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'status_pref', $prefix, []);
 318     return $r;
 319   }
 320
 321   /**
 322    * Returns the list of indices
 323    *
 324    * @param bool $localize
 325    *
 326    * @return array
 327    */
 328   public static function indices($localize = TRUE) {
 329     $indices = [
 330       'UI_status_pref_name' => [
 331         'name' => 'UI_status_pref_name',
 332         'field' => [
 333           0 => 'name',
 334         ],
 335         'localizable' => FALSE,
 336         'sig' => 'civicrm_status_pref::0::name',
 337       ],
 338     ];
 339     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 340   }
 341
 342 }