CRM/Activity/DAO/ActivityContact.php

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