CRM/Activity/DAO/ActivityContact.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/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 /**
  38  * CRM_Activity_DAO_ActivityContact constructor.
  39  */
  40 class CRM_Activity_DAO_ActivityContact extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_activity_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    * Activity contact id
  55    *
  56    * @var int unsigned
  57    */
  58   public $id;
  59   /**
  60    * Foreign key to the activity for this record.
  61    *
  62    * @var int unsigned
  63    */
  64   public $activity_id;
  65   /**
  66    * Foreign key to the contact for this record.
  67    *
  68    * @var int unsigned
  69    */
  70   public $contact_id;
  71   /**
  72    * Nature of this contact's role in the activity: 1 assignee, 2 creator, 3 focus or target.
  73    *
  74    * @var int unsigned
  75    */
  76   public $record_type_id;
  77   /**
  78    * Class constructor.
  79    */
  80   function __construct() {
  81     $this->__table = 'civicrm_activity_contact';
  82     parent::__construct();
  83   }
  84   /**
  85    * Returns foreign keys and entity references.
  86    *
  87    * @return array
  88    *   [CRM_Core_Reference_Interface]
  89    */
  90   static function getReferenceColumns() {
  91     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  92       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
  93       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'activity_id', 'civicrm_activity', 'id');
  94       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'contact_id', 'civicrm_contact', 'id');
  95       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  96     }
  97     return Civi::$statics[__CLASS__]['links'];
  98   }
  99   /**
 100    * Returns all the column names of this table
 101    *
 102    * @return array
 103    */
 104   static function &fields() {
 105     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 106       Civi::$statics[__CLASS__]['fields'] = array(
 107         'id' => array(
 108           'name' => 'id',
 109           'type' => CRM_Utils_Type::T_INT,
 110           'title' => ts('Activity Contact ID') ,
 111           'description' => 'Activity contact id',
 112           'required' => true,
 113         ) ,
 114         'activity_id' => array(
 115           'name' => 'activity_id',
 116           'type' => CRM_Utils_Type::T_INT,
 117           'title' => ts('Activity ID') ,
 118           'description' => 'Foreign key to the activity for this record.',
 119           'required' => true,
 120           'FKClassName' => 'CRM_Activity_DAO_Activity',
 121         ) ,
 122         'contact_id' => array(
 123           'name' => 'contact_id',
 124           'type' => CRM_Utils_Type::T_INT,
 125           'title' => ts('Contact ID (match to contact)') ,
 126           'description' => 'Foreign key to the contact for this record.',
 127           'required' => true,
 128           'import' => true,
 129           'where' => 'civicrm_activity_contact.contact_id',
 130           'headerPattern' => '',
 131           'dataPattern' => '',
 132           'export' => true,
 133           'FKClassName' => 'CRM_Contact_DAO_Contact',
 134         ) ,
 135         'record_type_id' => array(
 136           'name' => 'record_type_id',
 137           'type' => CRM_Utils_Type::T_INT,
 138           'title' => ts('Record Type ID') ,
 139           'description' => 'Nature of this contact\'s role in the activity: 1 assignee, 2 creator, 3 focus or target.',
 140           'html' => array(
 141             'type' => 'Select',
 142           ) ,
 143           'pseudoconstant' => array(
 144             'optionGroupName' => 'activity_contacts',
 145             'optionEditPath' => 'civicrm/admin/options/activity_contacts',
 146           )
 147         ) ,
 148       );
 149       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 150     }
 151     return Civi::$statics[__CLASS__]['fields'];
 152   }
 153   /**
 154    * Return a mapping from field-name to the corresponding key (as used in fields()).
 155    *
 156    * @return array
 157    *   Array(string $name => string $uniqueName).
 158    */
 159   static function &fieldKeys() {
 160     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 161       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 162     }
 163     return Civi::$statics[__CLASS__]['fieldKeys'];
 164   }
 165   /**
 166    * Returns the names of this table
 167    *
 168    * @return string
 169    */
 170   static function getTableName() {
 171     return self::$_tableName;
 172   }
 173   /**
 174    * Returns if this table needs to be logged
 175    *
 176    * @return boolean
 177    */
 178   function getLog() {
 179     return self::$_log;
 180   }
 181   /**
 182    * Returns the list of fields that can be imported
 183    *
 184    * @param bool $prefix
 185    *
 186    * @return array
 187    */
 188   static function &import($prefix = false) {
 189     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'activity_contact', $prefix, array());
 190     return $r;
 191   }
 192   /**
 193    * Returns the list of fields that can be exported
 194    *
 195    * @param bool $prefix
 196    *
 197    * @return array
 198    */
 199   static function &export($prefix = false) {
 200     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'activity_contact', $prefix, array());
 201     return $r;
 202   }
 203 }