CRM/Case/DAO/CaseContact.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.7                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2017                                |
   7 +--------------------------------------------------------------------+
   8 | This file is a part of CiviCRM.                                    |
   9 |                                                                    |
  10 | CiviCRM is free software; you can copy, modify, and distribute it  |
  11 | under the terms of the GNU Affero General Public License           |
  12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13 |                                                                    |
  14 | CiviCRM is distributed in the hope that it will be useful, but     |
  15 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17 | See the GNU Affero General Public License for more details.        |
  18 |                                                                    |
  19 | You should have received a copy of the GNU Affero General Public   |
  20 | License and the CiviCRM Licensing Exception along                  |
  21 | with this program; if not, contact CiviCRM LLC                     |
  22 | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23 | GNU Affero General Public License or the licensing of CiviCRM,     |
  24 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25 +--------------------------------------------------------------------+
  26 */
  27 /**
  28  * @package CRM
  29  * @copyright CiviCRM LLC (c) 2004-2017
  30  *
  31  * Generated from xml/schema/CRM/Case/CaseContact.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:def2443e49db4d131c39c07e2045fbb3)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_Case_DAO_CaseContact constructor.
  39  */
  40 class CRM_Case_DAO_CaseContact extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_case_contact';
  47   /**
  48    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  49    *
  50    * @var boolean
  51    */
  52   static $_log = true;
  53   /**
  54    * Unique case-contact association id
  55    *
  56    * @var int unsigned
  57    */
  58   public $id;
  59   /**
  60    * Case ID of case-contact association.
  61    *
  62    * @var int unsigned
  63    */
  64   public $case_id;
  65   /**
  66    * Contact ID of contact record given case belongs to.
  67    *
  68    * @var int unsigned
  69    */
  70   public $contact_id;
  71   /**
  72    * Class constructor.
  73    */
  74   function __construct() {
  75     $this->__table = 'civicrm_case_contact';
  76     parent::__construct();
  77   }
  78   /**
  79    * Returns foreign keys and entity references.
  80    *
  81    * @return array
  82    *   [CRM_Core_Reference_Interface]
  83    */
  84   static function getReferenceColumns() {
  85     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  86       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
  87       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'case_id', 'civicrm_case', 'id');
  88       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'contact_id', 'civicrm_contact', 'id');
  89       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  90     }
  91     return Civi::$statics[__CLASS__]['links'];
  92   }
  93   /**
  94    * Returns all the column names of this table
  95    *
  96    * @return array
  97    */
  98   static function &fields() {
  99     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 100       Civi::$statics[__CLASS__]['fields'] = array(
 101         'id' => array(
 102           'name' => 'id',
 103           'type' => CRM_Utils_Type::T_INT,
 104           'title' => ts('Case Contact ID') ,
 105           'description' => 'Unique case-contact association id',
 106           'required' => true,
 107           'table_name' => 'civicrm_case_contact',
 108           'entity' => 'CaseContact',
 109           'bao' => 'CRM_Case_BAO_CaseContact',
 110           'localizable' => 0,
 111         ) ,
 112         'case_id' => array(
 113           'name' => 'case_id',
 114           'type' => CRM_Utils_Type::T_INT,
 115           'title' => ts('Case') ,
 116           'description' => 'Case ID of case-contact association.',
 117           'required' => true,
 118           'table_name' => 'civicrm_case_contact',
 119           'entity' => 'CaseContact',
 120           'bao' => 'CRM_Case_BAO_CaseContact',
 121           'localizable' => 0,
 122           'FKClassName' => 'CRM_Case_DAO_Case',
 123         ) ,
 124         'contact_id' => array(
 125           'name' => 'contact_id',
 126           'type' => CRM_Utils_Type::T_INT,
 127           'title' => ts('Contact ID') ,
 128           'description' => 'Contact ID of contact record given case belongs to.',
 129           'required' => true,
 130           'table_name' => 'civicrm_case_contact',
 131           'entity' => 'CaseContact',
 132           'bao' => 'CRM_Case_BAO_CaseContact',
 133           'localizable' => 0,
 134           'FKClassName' => 'CRM_Contact_DAO_Contact',
 135           'html' => array(
 136             'type' => 'EntityRef',
 137           ) ,
 138         ) ,
 139       );
 140       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 141     }
 142     return Civi::$statics[__CLASS__]['fields'];
 143   }
 144   /**
 145    * Return a mapping from field-name to the corresponding key (as used in fields()).
 146    *
 147    * @return array
 148    *   Array(string $name => string $uniqueName).
 149    */
 150   static function &fieldKeys() {
 151     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 152       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 153     }
 154     return Civi::$statics[__CLASS__]['fieldKeys'];
 155   }
 156   /**
 157    * Returns the names of this table
 158    *
 159    * @return string
 160    */
 161   static function getTableName() {
 162     return self::$_tableName;
 163   }
 164   /**
 165    * Returns if this table needs to be logged
 166    *
 167    * @return boolean
 168    */
 169   function getLog() {
 170     return self::$_log;
 171   }
 172   /**
 173    * Returns the list of fields that can be imported
 174    *
 175    * @param bool $prefix
 176    *
 177    * @return array
 178    */
 179   static function &import($prefix = false) {
 180     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'case_contact', $prefix, array());
 181     return $r;
 182   }
 183   /**
 184    * Returns the list of fields that can be exported
 185    *
 186    * @param bool $prefix
 187    *
 188    * @return array
 189    */
 190   static function &export($prefix = false) {
 191     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'case_contact', $prefix, array());
 192     return $r;
 193   }
 194   /**
 195    * Returns the list of indices
 196    */
 197   public static function indices($localize = TRUE) {
 198     $indices = array(
 199       'UI_case_contact_id' => array(
 200         'name' => 'UI_case_contact_id',
 201         'field' => array(
 202           0 => 'case_id',
 203           1 => 'contact_id',
 204         ) ,
 205         'localizable' => false,
 206         'unique' => true,
 207         'sig' => 'civicrm_case_contact::1::case_id::contact_id',
 208       ) ,
 209     );
 210     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 211   }
 212 }