Commit | Line | Data |
---|---|---|
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/Core/Note.xml | |
32 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
522a26c9 | 33 | * (GenCodeChecksum:ad394e9a106ae70fd38afdbe29030fae) |
e501603b TO |
34 | */ |
35 | require_once 'CRM/Core/DAO.php'; | |
36 | require_once 'CRM/Utils/Type.php'; | |
f41f0342 | 37 | /** |
38 | * CRM_Core_DAO_Note constructor. | |
39 | */ | |
e501603b TO |
40 | class CRM_Core_DAO_Note 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_note'; | |
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 | * Note ID | |
55 | * | |
56 | * @var int unsigned | |
57 | */ | |
58 | public $id; | |
59 | /** | |
60 | * Name of table where item being referenced is stored. | |
61 | * | |
62 | * @var string | |
63 | */ | |
64 | public $entity_table; | |
65 | /** | |
66 | * Foreign key to the referenced item. | |
67 | * | |
68 | * @var int unsigned | |
69 | */ | |
70 | public $entity_id; | |
71 | /** | |
72 | * Note and/or Comment. | |
73 | * | |
74 | * @var text | |
75 | */ | |
76 | public $note; | |
77 | /** | |
78 | * FK to Contact ID creator | |
79 | * | |
80 | * @var int unsigned | |
81 | */ | |
82 | public $contact_id; | |
83 | /** | |
84 | * When was this note last modified/edited | |
85 | * | |
86 | * @var date | |
87 | */ | |
88 | public $modified_date; | |
89 | /** | |
90 | * subject of note description | |
91 | * | |
92 | * @var string | |
93 | */ | |
94 | public $subject; | |
95 | /** | |
96 | * Foreign Key to Note Privacy Level (which is an option value pair and hence an implicit FK) | |
97 | * | |
98 | * @var string | |
99 | */ | |
100 | public $privacy; | |
101 | /** | |
f41f0342 | 102 | * Class constructor. |
e501603b TO |
103 | */ |
104 | function __construct() { | |
105 | $this->__table = 'civicrm_note'; | |
106 | parent::__construct(); | |
107 | } | |
108 | /** | |
f41f0342 | 109 | * Returns foreign keys and entity references. |
e501603b TO |
110 | * |
111 | * @return array | |
112 | * [CRM_Core_Reference_Interface] | |
113 | */ | |
114 | static function getReferenceColumns() { | |
346aaaba TO |
115 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
116 | Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__); | |
117 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'contact_id', 'civicrm_contact', 'id'); | |
118 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName() , 'entity_id', NULL, 'id', 'entity_table'); | |
119 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); | |
e501603b | 120 | } |
346aaaba | 121 | return Civi::$statics[__CLASS__]['links']; |
e501603b TO |
122 | } |
123 | /** | |
124 | * Returns all the column names of this table | |
125 | * | |
126 | * @return array | |
127 | */ | |
128 | static function &fields() { | |
346aaaba TO |
129 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
130 | Civi::$statics[__CLASS__]['fields'] = array( | |
e501603b TO |
131 | 'id' => array( |
132 | 'name' => 'id', | |
133 | 'type' => CRM_Utils_Type::T_INT, | |
134 | 'title' => ts('Note ID') , | |
135 | 'description' => 'Note ID', | |
136 | 'required' => true, | |
522a26c9 | 137 | 'table_name' => 'civicrm_note', |
138 | 'entity' => 'Note', | |
139 | 'bao' => 'CRM_Core_BAO_Note', | |
e501603b TO |
140 | ) , |
141 | 'entity_table' => array( | |
142 | 'name' => 'entity_table', | |
143 | 'type' => CRM_Utils_Type::T_STRING, | |
144 | 'title' => ts('Note Entity') , | |
145 | 'description' => 'Name of table where item being referenced is stored.', | |
146 | 'required' => true, | |
147 | 'maxlength' => 64, | |
148 | 'size' => CRM_Utils_Type::BIG, | |
522a26c9 | 149 | 'table_name' => 'civicrm_note', |
150 | 'entity' => 'Note', | |
151 | 'bao' => 'CRM_Core_BAO_Note', | |
e501603b TO |
152 | 'pseudoconstant' => array( |
153 | 'callback' => 'CRM_Core_BAO_Note::entityTables', | |
154 | ) | |
155 | ) , | |
156 | 'entity_id' => array( | |
157 | 'name' => 'entity_id', | |
158 | 'type' => CRM_Utils_Type::T_INT, | |
159 | 'title' => ts('Note Entity ID') , | |
160 | 'description' => 'Foreign key to the referenced item.', | |
161 | 'required' => true, | |
522a26c9 | 162 | 'table_name' => 'civicrm_note', |
163 | 'entity' => 'Note', | |
164 | 'bao' => 'CRM_Core_BAO_Note', | |
e501603b TO |
165 | ) , |
166 | 'note' => array( | |
167 | 'name' => 'note', | |
168 | 'type' => CRM_Utils_Type::T_TEXT, | |
169 | 'title' => ts('Note') , | |
170 | 'description' => 'Note and/or Comment.', | |
171 | 'rows' => 4, | |
172 | 'cols' => 60, | |
173 | 'import' => true, | |
174 | 'where' => 'civicrm_note.note', | |
175 | 'headerPattern' => '/Note|Comment/i', | |
176 | 'dataPattern' => '//', | |
177 | 'export' => true, | |
522a26c9 | 178 | 'table_name' => 'civicrm_note', |
179 | 'entity' => 'Note', | |
180 | 'bao' => 'CRM_Core_BAO_Note', | |
e501603b TO |
181 | 'html' => array( |
182 | 'type' => 'TextArea', | |
183 | ) , | |
184 | ) , | |
185 | 'contact_id' => array( | |
186 | 'name' => 'contact_id', | |
187 | 'type' => CRM_Utils_Type::T_INT, | |
188 | 'title' => ts('Note Created By') , | |
189 | 'description' => 'FK to Contact ID creator', | |
522a26c9 | 190 | 'table_name' => 'civicrm_note', |
191 | 'entity' => 'Note', | |
192 | 'bao' => 'CRM_Core_BAO_Note', | |
e501603b TO |
193 | 'FKClassName' => 'CRM_Contact_DAO_Contact', |
194 | ) , | |
195 | 'modified_date' => array( | |
196 | 'name' => 'modified_date', | |
197 | 'type' => CRM_Utils_Type::T_DATE, | |
198 | 'title' => ts('Note Modified By') , | |
199 | 'description' => 'When was this note last modified/edited', | |
522a26c9 | 200 | 'table_name' => 'civicrm_note', |
201 | 'entity' => 'Note', | |
202 | 'bao' => 'CRM_Core_BAO_Note', | |
e501603b TO |
203 | ) , |
204 | 'subject' => array( | |
205 | 'name' => 'subject', | |
206 | 'type' => CRM_Utils_Type::T_STRING, | |
207 | 'title' => ts('Subject') , | |
208 | 'description' => 'subject of note description', | |
209 | 'maxlength' => 255, | |
210 | 'size' => 60, | |
522a26c9 | 211 | 'table_name' => 'civicrm_note', |
212 | 'entity' => 'Note', | |
213 | 'bao' => 'CRM_Core_BAO_Note', | |
e501603b TO |
214 | 'html' => array( |
215 | 'type' => 'Text', | |
216 | ) , | |
217 | ) , | |
218 | 'privacy' => array( | |
219 | 'name' => 'privacy', | |
220 | 'type' => CRM_Utils_Type::T_STRING, | |
221 | 'title' => ts('Privacy') , | |
222 | 'description' => 'Foreign Key to Note Privacy Level (which is an option value pair and hence an implicit FK)', | |
223 | 'maxlength' => 255, | |
224 | 'size' => CRM_Utils_Type::HUGE, | |
522a26c9 | 225 | 'table_name' => 'civicrm_note', |
226 | 'entity' => 'Note', | |
227 | 'bao' => 'CRM_Core_BAO_Note', | |
e501603b TO |
228 | 'pseudoconstant' => array( |
229 | 'optionGroupName' => 'note_privacy', | |
230 | 'optionEditPath' => 'civicrm/admin/options/note_privacy', | |
231 | ) | |
232 | ) , | |
233 | ); | |
346aaaba | 234 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 235 | } |
346aaaba | 236 | return Civi::$statics[__CLASS__]['fields']; |
e501603b TO |
237 | } |
238 | /** | |
bd8e0b14 | 239 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
240 | * |
241 | * @return array | |
bd8e0b14 | 242 | * Array(string $name => string $uniqueName). |
e501603b TO |
243 | */ |
244 | static function &fieldKeys() { | |
bd8e0b14 TO |
245 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
246 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 247 | } |
bd8e0b14 | 248 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b TO |
249 | } |
250 | /** | |
251 | * Returns the names of this table | |
252 | * | |
253 | * @return string | |
254 | */ | |
255 | static function getTableName() { | |
256 | return self::$_tableName; | |
257 | } | |
258 | /** | |
259 | * Returns if this table needs to be logged | |
260 | * | |
261 | * @return boolean | |
262 | */ | |
263 | function getLog() { | |
264 | return self::$_log; | |
265 | } | |
266 | /** | |
267 | * Returns the list of fields that can be imported | |
268 | * | |
269 | * @param bool $prefix | |
270 | * | |
271 | * @return array | |
272 | */ | |
273 | static function &import($prefix = false) { | |
60808919 TO |
274 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'note', $prefix, array()); |
275 | return $r; | |
e501603b TO |
276 | } |
277 | /** | |
278 | * Returns the list of fields that can be exported | |
279 | * | |
280 | * @param bool $prefix | |
281 | * | |
282 | * @return array | |
283 | */ | |
284 | static function &export($prefix = false) { | |
60808919 TO |
285 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'note', $prefix, array()); |
286 | return $r; | |
e501603b TO |
287 | } |
288 | } |