5 * @copyright CiviCRM LLC (c) 2004-2019
7 * Generated from xml/schema/CRM/Core/Note.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:daafebd13390de67d82735263e9fa886)
13 * Database access object for the Note entity.
15 class CRM_Core_DAO_Note
extends CRM_Core_DAO
{
18 * Static instance to hold the table name.
22 static $_tableName = 'civicrm_note';
25 * Should CiviCRM log any modifications to this table in the civicrm_log table.
39 * Name of table where item being referenced is stored.
46 * Foreign key to the referenced item.
53 * Note and/or Comment.
60 * FK to Contact ID creator
67 * When was this note last modified/edited
71 public $modified_date;
74 * subject of note description
81 * Foreign Key to Note Privacy Level (which is an option value pair and hence an implicit FK)
90 public function __construct() {
91 $this->__table
= 'civicrm_note';
92 parent
::__construct();
96 * Returns foreign keys and entity references.
99 * [CRM_Core_Reference_Interface]
101 public static function getReferenceColumns() {
102 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
103 Civi
::$statics[__CLASS__
]['links'] = static ::createReferenceColumns(__CLASS__
);
104 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName(), 'contact_id', 'civicrm_contact', 'id');
105 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Dynamic(self
::getTableName(), 'entity_id', NULL, 'id', 'entity_table');
106 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
108 return Civi
::$statics[__CLASS__
]['links'];
112 * Returns all the column names of this table
116 public static function &fields() {
117 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
118 Civi
::$statics[__CLASS__
]['fields'] = [
121 'type' => CRM_Utils_Type
::T_INT
,
122 'title' => ts('Note ID'),
123 'description' => ts('Note ID'),
125 'table_name' => 'civicrm_note',
127 'bao' => 'CRM_Core_BAO_Note',
131 'name' => 'entity_table',
132 'type' => CRM_Utils_Type
::T_STRING
,
133 'title' => ts('Note Entity'),
134 'description' => ts('Name of table where item being referenced is stored.'),
137 'size' => CRM_Utils_Type
::BIG
,
138 'table_name' => 'civicrm_note',
140 'bao' => 'CRM_Core_BAO_Note',
142 'pseudoconstant' => [
143 'callback' => 'CRM_Core_BAO_Note::entityTables',
147 'name' => 'entity_id',
148 'type' => CRM_Utils_Type
::T_INT
,
149 'title' => ts('Note Entity ID'),
150 'description' => ts('Foreign key to the referenced item.'),
152 'table_name' => 'civicrm_note',
154 'bao' => 'CRM_Core_BAO_Note',
159 'type' => CRM_Utils_Type
::T_TEXT
,
160 'title' => ts('Note'),
161 'description' => ts('Note and/or Comment.'),
165 'where' => 'civicrm_note.note',
166 'headerPattern' => '/Note|Comment/i',
167 'dataPattern' => '//',
169 'table_name' => 'civicrm_note',
171 'bao' => 'CRM_Core_BAO_Note',
174 'type' => 'TextArea',
178 'name' => 'contact_id',
179 'type' => CRM_Utils_Type
::T_INT
,
180 'title' => ts('Note Created By'),
181 'description' => ts('FK to Contact ID creator'),
182 'table_name' => 'civicrm_note',
184 'bao' => 'CRM_Core_BAO_Note',
186 'FKClassName' => 'CRM_Contact_DAO_Contact',
189 'name' => 'modified_date',
190 'type' => CRM_Utils_Type
::T_DATE
,
191 'title' => ts('Note Modified By'),
192 'description' => ts('When was this note last modified/edited'),
193 'table_name' => 'civicrm_note',
195 'bao' => 'CRM_Core_BAO_Note',
200 'type' => CRM_Utils_Type
::T_STRING
,
201 'title' => ts('Subject'),
202 'description' => ts('subject of note description'),
205 'table_name' => 'civicrm_note',
207 'bao' => 'CRM_Core_BAO_Note',
215 'type' => CRM_Utils_Type
::T_STRING
,
216 'title' => ts('Privacy'),
217 'description' => ts('Foreign Key to Note Privacy Level (which is an option value pair and hence an implicit FK)'),
219 'size' => CRM_Utils_Type
::HUGE
,
220 'table_name' => 'civicrm_note',
222 'bao' => 'CRM_Core_BAO_Note',
227 'pseudoconstant' => [
228 'optionGroupName' => 'note_privacy',
229 'optionEditPath' => 'civicrm/admin/options/note_privacy',
233 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
235 return Civi
::$statics[__CLASS__
]['fields'];
239 * Return a mapping from field-name to the corresponding key (as used in fields()).
242 * Array(string $name => string $uniqueName).
244 public static function &fieldKeys() {
245 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
246 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
248 return Civi
::$statics[__CLASS__
]['fieldKeys'];
252 * Returns the names of this table
256 public static function getTableName() {
257 return self
::$_tableName;
261 * Returns if this table needs to be logged
265 public function getLog() {
270 * Returns the list of fields that can be imported
272 * @param bool $prefix
276 public static function &import($prefix = FALSE) {
277 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'note', $prefix, []);
282 * Returns the list of fields that can be exported
284 * @param bool $prefix
288 public static function &export($prefix = FALSE) {
289 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'note', $prefix, []);
294 * Returns the list of indices
296 * @param bool $localize
300 public static function indices($localize = TRUE) {
303 'name' => 'index_entity',
308 'localizable' => FALSE,
309 'sig' => 'civicrm_note::0::entity_table::entity_id',
312 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;