Merge pull request #10816 from mattwire/nfc_activity_pseudoconstant
[civicrm-core.git] / CRM / Activity / DAO / ActivityContact.php
CommitLineData
e501603b
TO
1<?php
2/*
3+--------------------------------------------------------------------+
4| CiviCRM version 4.7 |
5+--------------------------------------------------------------------+
0f03f337 6| Copyright CiviCRM LLC (c) 2004-2017 |
e501603b
TO
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
0f03f337 29 * @copyright CiviCRM LLC (c) 2004-2017
e501603b
TO
30 *
31 * Generated from xml/schema/CRM/Activity/ActivityContact.xml
32 * DO NOT EDIT. Generated by CRM_Core_CodeGen
e7a6b91a 33 * (GenCodeChecksum:7a410e20f48318deeb83f3dd1900983a)
e501603b
TO
34 */
35require_once 'CRM/Core/DAO.php';
36require_once 'CRM/Utils/Type.php';
f41f0342 37/**
38 * CRM_Activity_DAO_ActivityContact constructor.
39 */
e501603b
TO
40class CRM_Activity_DAO_ActivityContact extends CRM_Core_DAO {
41 /**
f41f0342 42 * Static instance to hold the table name.
e501603b
TO
43 *
44 * @var string
45 */
46 static $_tableName = 'civicrm_activity_contact';
e501603b 47 /**
f41f0342 48 * Should CiviCRM log any modifications to this table in the civicrm_log table.
e501603b
TO
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 /**
f41f0342 78 * Class constructor.
e501603b
TO
79 */
80 function __construct() {
81 $this->__table = 'civicrm_activity_contact';
82 parent::__construct();
83 }
84 /**
f41f0342 85 * Returns foreign keys and entity references.
e501603b
TO
86 *
87 * @return array
88 * [CRM_Core_Reference_Interface]
89 */
90 static function getReferenceColumns() {
346aaaba
TO
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']);
e501603b 96 }
346aaaba 97 return Civi::$statics[__CLASS__]['links'];
e501603b
TO
98 }
99 /**
100 * Returns all the column names of this table
101 *
102 * @return array
103 */
104 static function &fields() {
346aaaba
TO
105 if (!isset(Civi::$statics[__CLASS__]['fields'])) {
106 Civi::$statics[__CLASS__]['fields'] = array(
e501603b
TO
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,
522a26c9 113 'table_name' => 'civicrm_activity_contact',
114 'entity' => 'ActivityContact',
115 'bao' => 'CRM_Activity_BAO_ActivityContact',
6a7e5e5d 116 'localizable' => 0,
e501603b
TO
117 ) ,
118 'activity_id' => array(
119 'name' => 'activity_id',
120 'type' => CRM_Utils_Type::T_INT,
121 'title' => ts('Activity ID') ,
122 'description' => 'Foreign key to the activity for this record.',
123 'required' => true,
522a26c9 124 'table_name' => 'civicrm_activity_contact',
125 'entity' => 'ActivityContact',
126 'bao' => 'CRM_Activity_BAO_ActivityContact',
6a7e5e5d 127 'localizable' => 0,
e501603b
TO
128 'FKClassName' => 'CRM_Activity_DAO_Activity',
129 ) ,
130 'contact_id' => array(
131 'name' => 'contact_id',
132 'type' => CRM_Utils_Type::T_INT,
133 'title' => ts('Contact ID (match to contact)') ,
134 'description' => 'Foreign key to the contact for this record.',
135 'required' => true,
136 'import' => true,
137 'where' => 'civicrm_activity_contact.contact_id',
138 'headerPattern' => '',
139 'dataPattern' => '',
140 'export' => true,
522a26c9 141 'table_name' => 'civicrm_activity_contact',
142 'entity' => 'ActivityContact',
143 'bao' => 'CRM_Activity_BAO_ActivityContact',
6a7e5e5d 144 'localizable' => 0,
e501603b
TO
145 'FKClassName' => 'CRM_Contact_DAO_Contact',
146 ) ,
147 'record_type_id' => array(
148 'name' => 'record_type_id',
149 'type' => CRM_Utils_Type::T_INT,
150 'title' => ts('Record Type ID') ,
151 'description' => 'Nature of this contact\'s role in the activity: 1 assignee, 2 creator, 3 focus or target.',
522a26c9 152 'table_name' => 'civicrm_activity_contact',
153 'entity' => 'ActivityContact',
154 'bao' => 'CRM_Activity_BAO_ActivityContact',
6a7e5e5d 155 'localizable' => 0,
e501603b
TO
156 'html' => array(
157 'type' => 'Select',
158 ) ,
159 'pseudoconstant' => array(
160 'optionGroupName' => 'activity_contacts',
161 'optionEditPath' => 'civicrm/admin/options/activity_contacts',
162 )
163 ) ,
164 );
346aaaba 165 CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
e501603b 166 }
346aaaba 167 return Civi::$statics[__CLASS__]['fields'];
e501603b
TO
168 }
169 /**
bd8e0b14 170 * Return a mapping from field-name to the corresponding key (as used in fields()).
e501603b
TO
171 *
172 * @return array
bd8e0b14 173 * Array(string $name => string $uniqueName).
e501603b
TO
174 */
175 static function &fieldKeys() {
bd8e0b14
TO
176 if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
177 Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
e501603b 178 }
bd8e0b14 179 return Civi::$statics[__CLASS__]['fieldKeys'];
e501603b
TO
180 }
181 /**
182 * Returns the names of this table
183 *
184 * @return string
185 */
186 static function getTableName() {
187 return self::$_tableName;
188 }
189 /**
190 * Returns if this table needs to be logged
191 *
192 * @return boolean
193 */
194 function getLog() {
195 return self::$_log;
196 }
197 /**
198 * Returns the list of fields that can be imported
199 *
200 * @param bool $prefix
201 *
202 * @return array
203 */
204 static function &import($prefix = false) {
60808919
TO
205 $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'activity_contact', $prefix, array());
206 return $r;
e501603b
TO
207 }
208 /**
209 * Returns the list of fields that can be exported
210 *
211 * @param bool $prefix
212 *
213 * @return array
214 */
215 static function &export($prefix = false) {
60808919
TO
216 $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'activity_contact', $prefix, array());
217 return $r;
e501603b 218 }
e7a6b91a
AS
219 /**
220 * Returns the list of indices
221 */
222 public static function indices($localize = TRUE) {
223 $indices = array(
224 'UI_activity_contact' => array(
225 'name' => 'UI_activity_contact',
226 'field' => array(
227 0 => 'contact_id',
228 1 => 'activity_id',
229 2 => 'record_type_id',
230 ) ,
231 'localizable' => false,
232 'unique' => true,
233 'sig' => 'civicrm_activity_contact::1::contact_id::activity_id::record_type_id',
234 ) ,
235 'index_record_type' => array(
236 'name' => 'index_record_type',
237 'field' => array(
238 0 => 'activity_id',
239 1 => 'record_type_id',
240 ) ,
241 'localizable' => false,
242 'sig' => 'civicrm_activity_contact::0::activity_id::record_type_id',
243 ) ,
244 );
245 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
246 }
e501603b 247}