crm.fsf.org/20131203/files/sites/all/modules-old/civicrm/CRM/Case/DAO/CaseContact.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.6                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  30  *
  31  * Generated from xml/schema/CRM/Case/CaseContact.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  */
  34 require_once 'CRM/Core/DAO.php';
  35 require_once 'CRM/Utils/Type.php';
  36 class CRM_Case_DAO_CaseContact extends CRM_Core_DAO {
  37   /**
  38    * static instance to hold the table name
  39    *
  40    * @var string
  41    */
  42   static $_tableName = 'civicrm_case_contact';
  43   /**
  44    * static instance to hold the field values
  45    *
  46    * @var array
  47    */
  48   static $_fields = null;
  49   /**
  50    * static instance to hold the keys used in $_fields for each field.
  51    *
  52    * @var array
  53    */
  54   static $_fieldKeys = null;
  55   /**
  56    * static instance to hold the FK relationships
  57    *
  58    * @var string
  59    */
  60   static $_links = null;
  61   /**
  62    * static instance to hold the values that can
  63    * be imported
  64    *
  65    * @var array
  66    */
  67   static $_import = null;
  68   /**
  69    * static instance to hold the values that can
  70    * be exported
  71    *
  72    * @var array
  73    */
  74   static $_export = null;
  75   /**
  76    * static value to see if we should log any modifications to
  77    * this table in the civicrm_log table
  78    *
  79    * @var boolean
  80    */
  81   static $_log = true;
  82   /**
  83    * Unique case-contact association id
  84    *
  85    * @var int unsigned
  86    */
  87   public $id;
  88   /**
  89    * Case ID of case-contact association.
  90    *
  91    * @var int unsigned
  92    */
  93   public $case_id;
  94   /**
  95    * Contact ID of contact record given case belongs to.
  96    *
  97    * @var int unsigned
  98    */
  99   public $contact_id;
 100   /**
 101    * class constructor
 102    *
 103    * @return civicrm_case_contact
 104    */
 105   function __construct() {
 106     $this->__table = 'civicrm_case_contact';
 107     parent::__construct();
 108   }
 109   /**
 110    * Returns foreign keys and entity references
 111    *
 112    * @return array
 113    *   [CRM_Core_Reference_Interface]
 114    */
 115   static function getReferenceColumns() {
 116     if (!self::$_links) {
 117       self::$_links = static ::createReferenceColumns(__CLASS__);
 118       self::$_links[] = new CRM_Core_Reference_Basic(self::getTableName() , 'case_id', 'civicrm_case', 'id');
 119       self::$_links[] = new CRM_Core_Reference_Basic(self::getTableName() , 'contact_id', 'civicrm_contact', 'id');
 120     }
 121     return self::$_links;
 122   }
 123   /**
 124    * Returns all the column names of this table
 125    *
 126    * @return array
 127    */
 128   static function &fields() {
 129     if (!(self::$_fields)) {
 130       self::$_fields = array(
 131         'id' => array(
 132           'name' => 'id',
 133           'type' => CRM_Utils_Type::T_INT,
 134           'description' => 'Unique case-contact association id',
 135           'required' => true,
 136         ) ,
 137         'case_id' => array(
 138           'name' => 'case_id',
 139           'type' => CRM_Utils_Type::T_INT,
 140           'description' => 'Case ID of case-contact association.',
 141           'required' => true,
 142           'FKClassName' => 'CRM_Case_DAO_Case',
 143         ) ,
 144         'case_contact_id' => array(
 145           'name' => 'contact_id',
 146           'type' => CRM_Utils_Type::T_INT,
 147           'description' => 'Contact ID of contact record given case belongs to.',
 148           'required' => true,
 149           'FKClassName' => 'CRM_Contact_DAO_Contact',
 150           'html' => array(
 151             'type' => 'Autocomplete-Select',
 152           ) ,
 153         ) ,
 154       );
 155     }
 156     return self::$_fields;
 157   }
 158   /**
 159    * Returns an array containing, for each field, the arary key used for that
 160    * field in self::$_fields.
 161    *
 162    * @return array
 163    */
 164   static function &fieldKeys() {
 165     if (!(self::$_fieldKeys)) {
 166       self::$_fieldKeys = array(
 167         'id' => 'id',
 168         'case_id' => 'case_id',
 169         'contact_id' => 'case_contact_id',
 170       );
 171     }
 172     return self::$_fieldKeys;
 173   }
 174   /**
 175    * Returns the names of this table
 176    *
 177    * @return string
 178    */
 179   static function getTableName() {
 180     return self::$_tableName;
 181   }
 182   /**
 183    * Returns if this table needs to be logged
 184    *
 185    * @return boolean
 186    */
 187   function getLog() {
 188     return self::$_log;
 189   }
 190   /**
 191    * Returns the list of fields that can be imported
 192    *
 193    * @param bool $prefix
 194    *
 195    * @return array
 196    */
 197   static function &import($prefix = false) {
 198     if (!(self::$_import)) {
 199       self::$_import = array();
 200       $fields = self::fields();
 201       foreach($fields as $name => $field) {
 202         if (CRM_Utils_Array::value('import', $field)) {
 203           if ($prefix) {
 204             self::$_import['case_contact'] = & $fields[$name];
 205           } else {
 206             self::$_import[$name] = & $fields[$name];
 207           }
 208         }
 209       }
 210     }
 211     return self::$_import;
 212   }
 213   /**
 214    * Returns the list of fields that can be exported
 215    *
 216    * @param bool $prefix
 217    *
 218    * @return array
 219    */
 220   static function &export($prefix = false) {
 221     if (!(self::$_export)) {
 222       self::$_export = array();
 223       $fields = self::fields();
 224       foreach($fields as $name => $field) {
 225         if (CRM_Utils_Array::value('export', $field)) {
 226           if ($prefix) {
 227             self::$_export['case_contact'] = & $fields[$name];
 228           } else {
 229             self::$_export[$name] = & $fields[$name];
 230           }
 231         }
 232       }
 233     }
 234     return self::$_export;
 235   }
 236 }