CRM/Case/DAO/Case.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC (c) 2004-2019
   6  *
   7  * Generated from xml/schema/CRM/Case/Case.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:a9960d56bc697d6cbc5347f9bc6a78bc)
  10  */
  11
  12 /**
  13  * Database access object for the Case entity.
  14  */
  15 class CRM_Case_DAO_Case extends CRM_Core_DAO {
  16
  17   /**
  18    * Static instance to hold the table name.
  19    *
  20    * @var string
  21    */
  22   public static $_tableName = 'civicrm_case';
  23
  24   /**
  25    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  26    *
  27    * @var bool
  28    */
  29   public static $_log = TRUE;
  30
  31   /**
  32    * Unique Case ID
  33    *
  34    * @var int unsigned
  35    */
  36   public $id;
  37
  38   /**
  39    * FK to civicrm_case_type.id
  40    *
  41    * @var int unsigned
  42    */
  43   public $case_type_id;
  44
  45   /**
  46    * Short name of the case.
  47    *
  48    * @var string
  49    */
  50   public $subject;
  51
  52   /**
  53    * Date on which given case starts.
  54    *
  55    * @var date
  56    */
  57   public $start_date;
  58
  59   /**
  60    * Date on which given case ends.
  61    *
  62    * @var date
  63    */
  64   public $end_date;
  65
  66   /**
  67    * Details about the meeting (agenda, notes, etc).
  68    *
  69    * @var text
  70    */
  71   public $details;
  72
  73   /**
  74    * Id of case status.
  75    *
  76    * @var int unsigned
  77    */
  78   public $status_id;
  79
  80   /**
  81    * @var boolean
  82    */
  83   public $is_deleted;
  84
  85   /**
  86    * When was the case was created.
  87    *
  88    * @var timestamp
  89    */
  90   public $created_date;
  91
  92   /**
  93    * When was the case (or closely related entity) was created or modified or deleted.
  94    *
  95    * @var timestamp
  96    */
  97   public $modified_date;
  98
  99   /**
 100    * Class constructor.
 101    */
 102   public function __construct() {
 103     $this->__table = 'civicrm_case';
 104     parent::__construct();
 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(), 'case_type_id', 'civicrm_case_type', '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         'case_id' => [
 131           'name' => 'id',
 132           'type' => CRM_Utils_Type::T_INT,
 133           'title' => ts('Case ID'),
 134           'description' => ts('Unique Case ID'),
 135           'required' => TRUE,
 136           'import' => TRUE,
 137           'where' => 'civicrm_case.id',
 138           'headerPattern' => '',
 139           'dataPattern' => '',
 140           'export' => TRUE,
 141           'table_name' => 'civicrm_case',
 142           'entity' => 'Case',
 143           'bao' => 'CRM_Case_BAO_Case',
 144           'localizable' => 0,
 145         ],
 146         'case_type_id' => [
 147           'name' => 'case_type_id',
 148           'type' => CRM_Utils_Type::T_INT,
 149           'title' => ts('Case Type'),
 150           'description' => ts('FK to civicrm_case_type.id'),
 151           'required' => TRUE,
 152           'import' => TRUE,
 153           'where' => 'civicrm_case.case_type_id',
 154           'headerPattern' => '',
 155           'dataPattern' => '',
 156           'export' => FALSE,
 157           'table_name' => 'civicrm_case',
 158           'entity' => 'Case',
 159           'bao' => 'CRM_Case_BAO_Case',
 160           'localizable' => 0,
 161           'FKClassName' => 'CRM_Case_DAO_CaseType',
 162           'html' => [
 163             'type' => 'Select',
 164           ],
 165           'pseudoconstant' => [
 166             'table' => 'civicrm_case_type',
 167             'keyColumn' => 'id',
 168             'labelColumn' => 'title',
 169           ]
 170         ],
 171         'case_subject' => [
 172           'name' => 'subject',
 173           'type' => CRM_Utils_Type::T_STRING,
 174           'title' => ts('Case Subject'),
 175           'description' => ts('Short name of the case.'),
 176           'maxlength' => 128,
 177           'size' => CRM_Utils_Type::HUGE,
 178           'import' => TRUE,
 179           'where' => 'civicrm_case.subject',
 180           'headerPattern' => '',
 181           'dataPattern' => '',
 182           'export' => TRUE,
 183           'table_name' => 'civicrm_case',
 184           'entity' => 'Case',
 185           'bao' => 'CRM_Case_BAO_Case',
 186           'localizable' => 0,
 187           'html' => [
 188             'type' => 'Text',
 189           ],
 190         ],
 191         'case_start_date' => [
 192           'name' => 'start_date',
 193           'type' => CRM_Utils_Type::T_DATE,
 194           'title' => ts('Case Start Date'),
 195           'description' => ts('Date on which given case starts.'),
 196           'import' => TRUE,
 197           'where' => 'civicrm_case.start_date',
 198           'headerPattern' => '',
 199           'dataPattern' => '',
 200           'export' => TRUE,
 201           'table_name' => 'civicrm_case',
 202           'entity' => 'Case',
 203           'bao' => 'CRM_Case_BAO_Case',
 204           'localizable' => 0,
 205           'html' => [
 206             'type' => 'Select Date',
 207             'formatType' => 'activityDateTime',
 208           ],
 209         ],
 210         'case_end_date' => [
 211           'name' => 'end_date',
 212           'type' => CRM_Utils_Type::T_DATE,
 213           'title' => ts('Case End Date'),
 214           'description' => ts('Date on which given case ends.'),
 215           'import' => TRUE,
 216           'where' => 'civicrm_case.end_date',
 217           'headerPattern' => '',
 218           'dataPattern' => '',
 219           'export' => TRUE,
 220           'table_name' => 'civicrm_case',
 221           'entity' => 'Case',
 222           'bao' => 'CRM_Case_BAO_Case',
 223           'localizable' => 0,
 224           'html' => [
 225             'type' => 'Select Date',
 226             'formatType' => 'activityDateTime',
 227           ],
 228         ],
 229         'details' => [
 230           'name' => 'details',
 231           'type' => CRM_Utils_Type::T_TEXT,
 232           'title' => ts('Details'),
 233           'description' => ts('Details about the meeting (agenda, notes, etc).'),
 234           'rows' => 8,
 235           'cols' => 60,
 236           'table_name' => 'civicrm_case',
 237           'entity' => 'Case',
 238           'bao' => 'CRM_Case_BAO_Case',
 239           'localizable' => 0,
 240           'html' => [
 241             'type' => 'TextArea',
 242           ],
 243         ],
 244         'case_status_id' => [
 245           'name' => 'status_id',
 246           'type' => CRM_Utils_Type::T_INT,
 247           'title' => ts('Case Status'),
 248           'description' => ts('Id of case status.'),
 249           'required' => TRUE,
 250           'import' => TRUE,
 251           'where' => 'civicrm_case.status_id',
 252           'headerPattern' => '',
 253           'dataPattern' => '',
 254           'export' => FALSE,
 255           'table_name' => 'civicrm_case',
 256           'entity' => 'Case',
 257           'bao' => 'CRM_Case_BAO_Case',
 258           'localizable' => 0,
 259           'html' => [
 260             'type' => 'Select',
 261           ],
 262           'pseudoconstant' => [
 263             'optionGroupName' => 'case_status',
 264             'optionEditPath' => 'civicrm/admin/options/case_status',
 265           ]
 266         ],
 267         'case_deleted' => [
 268           'name' => 'is_deleted',
 269           'type' => CRM_Utils_Type::T_BOOLEAN,
 270           'title' => ts('Case is in the Trash'),
 271           'import' => TRUE,
 272           'where' => 'civicrm_case.is_deleted',
 273           'headerPattern' => '',
 274           'dataPattern' => '',
 275           'export' => TRUE,
 276           'default' => '0',
 277           'table_name' => 'civicrm_case',
 278           'entity' => 'Case',
 279           'bao' => 'CRM_Case_BAO_Case',
 280           'localizable' => 0,
 281         ],
 282         'case_created_date' => [
 283           'name' => 'created_date',
 284           'type' => CRM_Utils_Type::T_TIMESTAMP,
 285           'title' => ts('Created Date'),
 286           'description' => ts('When was the case was created.'),
 287           'required' => FALSE,
 288           'export' => TRUE,
 289           'where' => 'civicrm_case.created_date',
 290           'headerPattern' => '',
 291           'dataPattern' => '',
 292           'default' => 'NULL',
 293           'table_name' => 'civicrm_case',
 294           'entity' => 'Case',
 295           'bao' => 'CRM_Case_BAO_Case',
 296           'localizable' => 0,
 297         ],
 298         'case_modified_date' => [
 299           'name' => 'modified_date',
 300           'type' => CRM_Utils_Type::T_TIMESTAMP,
 301           'title' => ts('Modified Date'),
 302           'description' => ts('When was the case (or closely related entity) was created or modified or deleted.'),
 303           'required' => FALSE,
 304           'export' => TRUE,
 305           'where' => 'civicrm_case.modified_date',
 306           'headerPattern' => '',
 307           'dataPattern' => '',
 308           'default' => 'CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP',
 309           'table_name' => 'civicrm_case',
 310           'entity' => 'Case',
 311           'bao' => 'CRM_Case_BAO_Case',
 312           'localizable' => 0,
 313         ],
 314       ];
 315       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 316     }
 317     return Civi::$statics[__CLASS__]['fields'];
 318   }
 319
 320   /**
 321    * Return a mapping from field-name to the corresponding key (as used in fields()).
 322    *
 323    * @return array
 324    *   Array(string $name => string $uniqueName).
 325    */
 326   public static function &fieldKeys() {
 327     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 328       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 329     }
 330     return Civi::$statics[__CLASS__]['fieldKeys'];
 331   }
 332
 333   /**
 334    * Returns the names of this table
 335    *
 336    * @return string
 337    */
 338   public static function getTableName() {
 339     return self::$_tableName;
 340   }
 341
 342   /**
 343    * Returns if this table needs to be logged
 344    *
 345    * @return bool
 346    */
 347   public function getLog() {
 348     return self::$_log;
 349   }
 350
 351   /**
 352    * Returns the list of fields that can be imported
 353    *
 354    * @param bool $prefix
 355    *
 356    * @return array
 357    */
 358   public static function &import($prefix = FALSE) {
 359     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'case', $prefix, []);
 360     return $r;
 361   }
 362
 363   /**
 364    * Returns the list of fields that can be exported
 365    *
 366    * @param bool $prefix
 367    *
 368    * @return array
 369    */
 370   public static function &export($prefix = FALSE) {
 371     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'case', $prefix, []);
 372     return $r;
 373   }
 374
 375   /**
 376    * Returns the list of indices
 377    *
 378    * @param bool $localize
 379    *
 380    * @return array
 381    */
 382   public static function indices($localize = TRUE) {
 383     $indices = [
 384       'index_case_type_id' => [
 385         'name' => 'index_case_type_id',
 386         'field' => [
 387           0 => 'case_type_id',
 388         ],
 389         'localizable' => FALSE,
 390         'sig' => 'civicrm_case::0::case_type_id',
 391       ],
 392       'index_is_deleted' => [
 393         'name' => 'index_is_deleted',
 394         'field' => [
 395           0 => 'is_deleted',
 396         ],
 397         'localizable' => FALSE,
 398         'sig' => 'civicrm_case::0::is_deleted',
 399       ],
 400     ];
 401     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 402   }
 403
 404 }