5 * @copyright CiviCRM LLC (c) 2004-2019
7 * Generated from xml/schema/CRM/Case/Case.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:f7d3f0df9ce94aec00f5eb0e20cedd1e)
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 public static $_tableName = 'civicrm_case';
25 * Should CiviCRM log any modifications to this table in the civicrm_log table.
29 public static $_log = TRUE;
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' => ts('Unique Case ID'),
137 'where' => 'civicrm_case.id',
139 'table_name' => 'civicrm_case',
141 'bao' => 'CRM_Case_BAO_Case',
145 'name' => 'case_type_id',
146 'type' => CRM_Utils_Type
::T_INT
,
147 'title' => ts('Case Type'),
148 'description' => ts('FK to civicrm_case_type.id'),
151 'where' => 'civicrm_case.case_type_id',
153 'table_name' => 'civicrm_case',
155 'bao' => 'CRM_Case_BAO_Case',
157 'FKClassName' => 'CRM_Case_DAO_CaseType',
161 'pseudoconstant' => [
162 'table' => 'civicrm_case_type',
164 'labelColumn' => 'title',
169 'type' => CRM_Utils_Type
::T_STRING
,
170 'title' => ts('Case Subject'),
171 'description' => ts('Short name of the case.'),
173 'size' => CRM_Utils_Type
::HUGE
,
175 'where' => 'civicrm_case.subject',
177 'table_name' => 'civicrm_case',
179 'bao' => 'CRM_Case_BAO_Case',
185 'case_start_date' => [
186 'name' => 'start_date',
187 'type' => CRM_Utils_Type
::T_DATE
,
188 'title' => ts('Case Start Date'),
189 'description' => ts('Date on which given case starts.'),
191 'where' => 'civicrm_case.start_date',
193 'table_name' => 'civicrm_case',
195 'bao' => 'CRM_Case_BAO_Case',
198 'type' => 'Select Date',
199 'formatType' => 'activityDateTime',
203 'name' => 'end_date',
204 'type' => CRM_Utils_Type
::T_DATE
,
205 'title' => ts('Case End Date'),
206 'description' => ts('Date on which given case ends.'),
208 'where' => 'civicrm_case.end_date',
210 'table_name' => 'civicrm_case',
212 'bao' => 'CRM_Case_BAO_Case',
215 'type' => 'Select Date',
216 'formatType' => 'activityDateTime',
221 'type' => CRM_Utils_Type
::T_TEXT
,
222 'title' => ts('Details'),
223 'description' => ts('Details about the meeting (agenda, notes, etc).'),
226 'where' => 'civicrm_case.details',
227 'table_name' => 'civicrm_case',
229 'bao' => 'CRM_Case_BAO_Case',
232 'type' => 'TextArea',
235 'case_status_id' => [
236 'name' => 'status_id',
237 'type' => CRM_Utils_Type
::T_INT
,
238 'title' => ts('Case Status'),
239 'description' => ts('Id of case status.'),
242 'where' => 'civicrm_case.status_id',
244 'table_name' => 'civicrm_case',
246 'bao' => 'CRM_Case_BAO_Case',
251 'pseudoconstant' => [
252 'optionGroupName' => 'case_status',
253 'optionEditPath' => 'civicrm/admin/options/case_status',
257 'name' => 'is_deleted',
258 'type' => CRM_Utils_Type
::T_BOOLEAN
,
259 'title' => ts('Case is in the Trash'),
261 'where' => 'civicrm_case.is_deleted',
264 'table_name' => 'civicrm_case',
266 'bao' => 'CRM_Case_BAO_Case',
269 'case_created_date' => [
270 'name' => 'created_date',
271 'type' => CRM_Utils_Type
::T_TIMESTAMP
,
272 'title' => ts('Created Date'),
273 'description' => ts('When was the case was created.'),
275 'where' => 'civicrm_case.created_date',
278 'table_name' => 'civicrm_case',
280 'bao' => 'CRM_Case_BAO_Case',
283 'case_modified_date' => [
284 'name' => 'modified_date',
285 'type' => CRM_Utils_Type
::T_TIMESTAMP
,
286 'title' => ts('Modified Date'),
287 'description' => ts('When was the case (or closely related entity) was created or modified or deleted.'),
289 'where' => 'civicrm_case.modified_date',
291 'default' => 'CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP',
292 'table_name' => 'civicrm_case',
294 'bao' => 'CRM_Case_BAO_Case',
298 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
300 return Civi
::$statics[__CLASS__
]['fields'];
304 * Return a mapping from field-name to the corresponding key (as used in fields()).
307 * Array(string $name => string $uniqueName).
309 public static function &fieldKeys() {
310 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
311 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
313 return Civi
::$statics[__CLASS__
]['fieldKeys'];
317 * Returns the names of this table
321 public static function getTableName() {
322 return self
::$_tableName;
326 * Returns if this table needs to be logged
330 public function getLog() {
335 * Returns the list of fields that can be imported
337 * @param bool $prefix
341 public static function &import($prefix = FALSE) {
342 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'case', $prefix, []);
347 * Returns the list of fields that can be exported
349 * @param bool $prefix
353 public static function &export($prefix = FALSE) {
354 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'case', $prefix, []);
359 * Returns the list of indices
361 * @param bool $localize
365 public static function indices($localize = TRUE) {
367 'index_case_type_id' => [
368 'name' => 'index_case_type_id',
372 'localizable' => FALSE,
373 'sig' => 'civicrm_case::0::case_type_id',
375 'index_is_deleted' => [
376 'name' => 'index_is_deleted',
380 'localizable' => FALSE,
381 'sig' => 'civicrm_case::0::is_deleted',
384 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;