5 * @copyright CiviCRM LLC (c) 2004-2018
7 * Generated from xml/schema/CRM/Case/Case.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:2a046fd795b19790f45c5d9dde06a538)
13 * Database access object for the Case entity.
15 class CRM_Case_DAO_Case
extends CRM_Core_DAO
{
18 * Static instance to hold the table name.
22 static $_tableName = 'civicrm_case';
25 * Should CiviCRM log any modifications to this table in the civicrm_log table.
39 * FK to civicrm_case_type.id
46 * Short name of the case.
53 * Date on which given case starts.
60 * Date on which given case ends.
67 * Details about the meeting (agenda, notes, etc).
86 * When was the case was created.
93 * When was the case (or closely related entity) was created or modified or deleted.
97 public $modified_date;
102 public function __construct() {
103 $this->__table
= 'civicrm_case';
104 parent
::__construct();
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(), 'case_type_id', 'civicrm_case_type', '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('Case ID'),
134 'description' => 'Unique Case ID',
137 'where' => 'civicrm_case.id',
138 'headerPattern' => '',
141 'table_name' => 'civicrm_case',
143 'bao' => 'CRM_Case_BAO_Case',
147 'name' => 'case_type_id',
148 'type' => CRM_Utils_Type
::T_INT
,
149 'title' => ts('Case Type'),
150 'description' => 'FK to civicrm_case_type.id',
153 'where' => 'civicrm_case.case_type_id',
154 'headerPattern' => '',
157 'table_name' => 'civicrm_case',
159 'bao' => 'CRM_Case_BAO_Case',
161 'FKClassName' => 'CRM_Case_DAO_CaseType',
165 'pseudoconstant' => [
166 'table' => 'civicrm_case_type',
168 'labelColumn' => 'title',
173 'type' => CRM_Utils_Type
::T_STRING
,
174 'title' => ts('Case Subject'),
175 'description' => 'Short name of the case.',
177 'size' => CRM_Utils_Type
::HUGE
,
179 'where' => 'civicrm_case.subject',
180 'headerPattern' => '',
183 'table_name' => 'civicrm_case',
185 'bao' => 'CRM_Case_BAO_Case',
191 'case_start_date' => [
192 'name' => 'start_date',
193 'type' => CRM_Utils_Type
::T_DATE
,
194 'title' => ts('Case Start Date'),
195 'description' => 'Date on which given case starts.',
197 'where' => 'civicrm_case.start_date',
198 'headerPattern' => '',
201 'table_name' => 'civicrm_case',
203 'bao' => 'CRM_Case_BAO_Case',
206 'type' => 'Select Date',
210 'name' => 'end_date',
211 'type' => CRM_Utils_Type
::T_DATE
,
212 'title' => ts('Case End Date'),
213 'description' => 'Date on which given case ends.',
215 'where' => 'civicrm_case.end_date',
216 'headerPattern' => '',
219 'table_name' => 'civicrm_case',
221 'bao' => 'CRM_Case_BAO_Case',
224 'type' => 'Select Date',
229 'type' => CRM_Utils_Type
::T_TEXT
,
230 'title' => ts('Details'),
231 'description' => 'Details about the meeting (agenda, notes, etc).',
234 'table_name' => 'civicrm_case',
236 'bao' => 'CRM_Case_BAO_Case',
239 'type' => 'TextArea',
242 'case_status_id' => [
243 'name' => 'status_id',
244 'type' => CRM_Utils_Type
::T_INT
,
245 'title' => ts('Case Status'),
246 'description' => 'Id of case status.',
249 'where' => 'civicrm_case.status_id',
250 'headerPattern' => '',
253 'table_name' => 'civicrm_case',
255 'bao' => 'CRM_Case_BAO_Case',
260 'pseudoconstant' => [
261 'optionGroupName' => 'case_status',
262 'optionEditPath' => 'civicrm/admin/options/case_status',
266 'name' => 'is_deleted',
267 'type' => CRM_Utils_Type
::T_BOOLEAN
,
268 'title' => ts('Case is in the Trash'),
270 'where' => 'civicrm_case.is_deleted',
271 'headerPattern' => '',
274 'table_name' => 'civicrm_case',
276 'bao' => 'CRM_Case_BAO_Case',
279 'case_created_date' => [
280 'name' => 'created_date',
281 'type' => CRM_Utils_Type
::T_TIMESTAMP
,
282 'title' => ts('Created Date'),
283 'description' => 'When was the case was created.',
286 'where' => 'civicrm_case.created_date',
287 'headerPattern' => '',
290 'table_name' => 'civicrm_case',
292 'bao' => 'CRM_Case_BAO_Case',
295 'case_modified_date' => [
296 'name' => 'modified_date',
297 'type' => CRM_Utils_Type
::T_TIMESTAMP
,
298 'title' => ts('Modified Date'),
299 'description' => 'When was the case (or closely related entity) was created or modified or deleted.',
302 'where' => 'civicrm_case.modified_date',
303 'headerPattern' => '',
305 'default' => 'CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP',
306 'table_name' => 'civicrm_case',
308 'bao' => 'CRM_Case_BAO_Case',
312 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
314 return Civi
::$statics[__CLASS__
]['fields'];
318 * Return a mapping from field-name to the corresponding key (as used in fields()).
321 * Array(string $name => string $uniqueName).
323 public static function &fieldKeys() {
324 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
325 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
327 return Civi
::$statics[__CLASS__
]['fieldKeys'];
331 * Returns the names of this table
335 public static function getTableName() {
336 return self
::$_tableName;
340 * Returns if this table needs to be logged
344 public function getLog() {
349 * Returns the list of fields that can be imported
351 * @param bool $prefix
355 public static function &import($prefix = FALSE) {
356 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'case', $prefix, []);
361 * Returns the list of fields that can be exported
363 * @param bool $prefix
367 public static function &export($prefix = FALSE) {
368 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'case', $prefix, []);
373 * Returns the list of indices
375 * @param bool $localize
379 public static function indices($localize = TRUE) {
381 'index_case_type_id' => [
382 'name' => 'index_case_type_id',
386 'localizable' => FALSE,
387 'sig' => 'civicrm_case::0::case_type_id',
389 'index_is_deleted' => [
390 'name' => 'index_is_deleted',
394 'localizable' => FALSE,
395 'sig' => 'civicrm_case::0::is_deleted',
398 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;