5 * @copyright CiviCRM LLC https://civicrm.org/licensing
7 * Generated from xml/schema/CRM/Activity/ActivityContact.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:60851972b9f03efb52350929e557c768)
13 * Database access object for the ActivityContact entity.
15 class CRM_Activity_DAO_ActivityContact
extends CRM_Core_DAO
{
16 const EXT
= 'civicrm';
17 const TABLE_ADDED
= '4.4';
20 * Static instance to hold the table name.
24 public static $_tableName = 'civicrm_activity_contact';
27 * Should CiviCRM log any modifications to this table in the civicrm_log table.
31 public static $_log = TRUE;
41 * Foreign key to the activity for this record.
48 * Foreign key to the contact for this record.
55 * Nature of this contact's role in the activity: 1 assignee, 2 creator, 3 focus or target.
59 public $record_type_id;
64 public function __construct() {
65 $this->__table
= 'civicrm_activity_contact';
66 parent
::__construct();
70 * Returns localized title of this entity.
73 * Whether to return the plural version of the title.
75 public static function getEntityTitle($plural = FALSE) {
76 return $plural ?
ts('Activity Contacts') : ts('Activity Contact');
80 * Returns foreign keys and entity references.
83 * [CRM_Core_Reference_Interface]
85 public static function getReferenceColumns() {
86 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
87 Civi
::$statics[__CLASS__
]['links'] = static::createReferenceColumns(__CLASS__
);
88 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'activity_id', 'civicrm_activity', 'id');
89 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'contact_id', 'civicrm_contact', 'id');
90 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
92 return Civi
::$statics[__CLASS__
]['links'];
96 * Returns all the column names of this table
100 public static function &fields() {
101 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
102 Civi
::$statics[__CLASS__
]['fields'] = [
105 'type' => CRM_Utils_Type
::T_INT
,
106 'title' => ts('Activity Contact ID'),
107 'description' => ts('Activity contact id'),
109 'where' => 'civicrm_activity_contact.id',
110 'table_name' => 'civicrm_activity_contact',
111 'entity' => 'ActivityContact',
112 'bao' => 'CRM_Activity_BAO_ActivityContact',
117 'name' => 'activity_id',
118 'type' => CRM_Utils_Type
::T_INT
,
119 'title' => ts('Activity ID'),
120 'description' => ts('Foreign key to the activity for this record.'),
122 'where' => 'civicrm_activity_contact.activity_id',
123 'table_name' => 'civicrm_activity_contact',
124 'entity' => 'ActivityContact',
125 'bao' => 'CRM_Activity_BAO_ActivityContact',
127 'FKClassName' => 'CRM_Activity_DAO_Activity',
131 'name' => 'contact_id',
132 'type' => CRM_Utils_Type
::T_INT
,
133 'title' => ts('Contact ID (match to contact)'),
134 'description' => ts('Foreign key to the contact for this record.'),
137 'where' => 'civicrm_activity_contact.contact_id',
139 'table_name' => 'civicrm_activity_contact',
140 'entity' => 'ActivityContact',
141 'bao' => 'CRM_Activity_BAO_ActivityContact',
143 'FKClassName' => 'CRM_Contact_DAO_Contact',
146 'record_type_id' => [
147 'name' => 'record_type_id',
148 'type' => CRM_Utils_Type
::T_INT
,
149 'title' => ts('Record Type ID'),
150 'description' => ts('Nature of this contact\'s role in the activity: 1 assignee, 2 creator, 3 focus or target.'),
151 'where' => 'civicrm_activity_contact.record_type_id',
152 'table_name' => 'civicrm_activity_contact',
153 'entity' => 'ActivityContact',
154 'bao' => 'CRM_Activity_BAO_ActivityContact',
159 'pseudoconstant' => [
160 'optionGroupName' => 'activity_contacts',
161 'optionEditPath' => 'civicrm/admin/options/activity_contacts',
166 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
168 return Civi
::$statics[__CLASS__
]['fields'];
172 * Return a mapping from field-name to the corresponding key (as used in fields()).
175 * Array(string $name => string $uniqueName).
177 public static function &fieldKeys() {
178 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
179 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
181 return Civi
::$statics[__CLASS__
]['fieldKeys'];
185 * Returns the names of this table
189 public static function getTableName() {
190 return self
::$_tableName;
194 * Returns if this table needs to be logged
198 public function getLog() {
203 * Returns the list of fields that can be imported
205 * @param bool $prefix
209 public static function &import($prefix = FALSE) {
210 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'activity_contact', $prefix, []);
215 * Returns the list of fields that can be exported
217 * @param bool $prefix
221 public static function &export($prefix = FALSE) {
222 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'activity_contact', $prefix, []);
227 * Returns the list of indices
229 * @param bool $localize
233 public static function indices($localize = TRUE) {
235 'UI_activity_contact' => [
236 'name' => 'UI_activity_contact',
240 2 => 'record_type_id',
242 'localizable' => FALSE,
244 'sig' => 'civicrm_activity_contact::1::contact_id::activity_id::record_type_id',
246 'index_record_type' => [
247 'name' => 'index_record_type',
250 1 => 'record_type_id',
252 'localizable' => FALSE,
253 'sig' => 'civicrm_activity_contact::0::activity_id::record_type_id',
256 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;