CRM/Core/DAO/Note.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC (c) 2004-2019
   6  *
   7  * Generated from xml/schema/CRM/Core/Note.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:daafebd13390de67d82735263e9fa886)
  10  */
  11
  12 /**
  13  * Database access object for the Note entity.
  14  */
  15 class CRM_Core_DAO_Note extends CRM_Core_DAO {
  16
  17   /**
  18    * Static instance to hold the table name.
  19    *
  20    * @var string
  21    */
  22   public static $_tableName = 'civicrm_note';
  23
  24   /**
  25    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  26    *
  27    * @var bool
  28    */
  29   public static $_log = TRUE;
  30
  31   /**
  32    * Note ID
  33    *
  34    * @var int unsigned
  35    */
  36   public $id;
  37
  38   /**
  39    * Name of table where item being referenced is stored.
  40    *
  41    * @var string
  42    */
  43   public $entity_table;
  44
  45   /**
  46    * Foreign key to the referenced item.
  47    *
  48    * @var int unsigned
  49    */
  50   public $entity_id;
  51
  52   /**
  53    * Note and/or Comment.
  54    *
  55    * @var text
  56    */
  57   public $note;
  58
  59   /**
  60    * FK to Contact ID creator
  61    *
  62    * @var int unsigned
  63    */
  64   public $contact_id;
  65
  66   /**
  67    * When was this note last modified/edited
  68    *
  69    * @var date
  70    */
  71   public $modified_date;
  72
  73   /**
  74    * subject of note description
  75    *
  76    * @var string
  77    */
  78   public $subject;
  79
  80   /**
  81    * Foreign Key to Note Privacy Level (which is an option value pair and hence an implicit FK)
  82    *
  83    * @var string
  84    */
  85   public $privacy;
  86
  87   /**
  88    * Class constructor.
  89    */
  90   public function __construct() {
  91     $this->__table = 'civicrm_note';
  92     parent::__construct();
  93   }
  94
  95   /**
  96    * Returns foreign keys and entity references.
  97    *
  98    * @return array
  99    *   [CRM_Core_Reference_Interface]
 100    */
 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']);
 107     }
 108     return Civi::$statics[__CLASS__]['links'];
 109   }
 110
 111   /**
 112    * Returns all the column names of this table
 113    *
 114    * @return array
 115    */
 116   public static function &fields() {
 117     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 118       Civi::$statics[__CLASS__]['fields'] = [
 119         'id' => [
 120           'name' => 'id',
 121           'type' => CRM_Utils_Type::T_INT,
 122           'title' => ts('Note ID'),
 123           'description' => ts('Note ID'),
 124           'required' => TRUE,
 125           'where' => 'civicrm_note.id',
 126           'table_name' => 'civicrm_note',
 127           'entity' => 'Note',
 128           'bao' => 'CRM_Core_BAO_Note',
 129           'localizable' => 0,
 130         ],
 131         'entity_table' => [
 132           'name' => 'entity_table',
 133           'type' => CRM_Utils_Type::T_STRING,
 134           'title' => ts('Note Entity'),
 135           'description' => ts('Name of table where item being referenced is stored.'),
 136           'required' => TRUE,
 137           'maxlength' => 64,
 138           'size' => CRM_Utils_Type::BIG,
 139           'where' => 'civicrm_note.entity_table',
 140           'table_name' => 'civicrm_note',
 141           'entity' => 'Note',
 142           'bao' => 'CRM_Core_BAO_Note',
 143           'localizable' => 0,
 144           'pseudoconstant' => [
 145             'callback' => 'CRM_Core_BAO_Note::entityTables',
 146           ]
 147         ],
 148         'entity_id' => [
 149           'name' => 'entity_id',
 150           'type' => CRM_Utils_Type::T_INT,
 151           'title' => ts('Note Entity ID'),
 152           'description' => ts('Foreign key to the referenced item.'),
 153           'required' => TRUE,
 154           'where' => 'civicrm_note.entity_id',
 155           'table_name' => 'civicrm_note',
 156           'entity' => 'Note',
 157           'bao' => 'CRM_Core_BAO_Note',
 158           'localizable' => 0,
 159         ],
 160         'note' => [
 161           'name' => 'note',
 162           'type' => CRM_Utils_Type::T_TEXT,
 163           'title' => ts('Note'),
 164           'description' => ts('Note and/or Comment.'),
 165           'rows' => 4,
 166           'cols' => 60,
 167           'import' => TRUE,
 168           'where' => 'civicrm_note.note',
 169           'headerPattern' => '/Note|Comment/i',
 170           'dataPattern' => '//',
 171           'export' => TRUE,
 172           'table_name' => 'civicrm_note',
 173           'entity' => 'Note',
 174           'bao' => 'CRM_Core_BAO_Note',
 175           'localizable' => 0,
 176           'html' => [
 177             'type' => 'TextArea',
 178           ],
 179         ],
 180         'contact_id' => [
 181           'name' => 'contact_id',
 182           'type' => CRM_Utils_Type::T_INT,
 183           'title' => ts('Note Created By'),
 184           'description' => ts('FK to Contact ID creator'),
 185           'where' => 'civicrm_note.contact_id',
 186           'table_name' => 'civicrm_note',
 187           'entity' => 'Note',
 188           'bao' => 'CRM_Core_BAO_Note',
 189           'localizable' => 0,
 190           'FKClassName' => 'CRM_Contact_DAO_Contact',
 191         ],
 192         'modified_date' => [
 193           'name' => 'modified_date',
 194           'type' => CRM_Utils_Type::T_DATE,
 195           'title' => ts('Note Modified By'),
 196           'description' => ts('When was this note last modified/edited'),
 197           'where' => 'civicrm_note.modified_date',
 198           'table_name' => 'civicrm_note',
 199           'entity' => 'Note',
 200           'bao' => 'CRM_Core_BAO_Note',
 201           'localizable' => 0,
 202         ],
 203         'subject' => [
 204           'name' => 'subject',
 205           'type' => CRM_Utils_Type::T_STRING,
 206           'title' => ts('Subject'),
 207           'description' => ts('subject of note description'),
 208           'maxlength' => 255,
 209           'size' => 60,
 210           'where' => 'civicrm_note.subject',
 211           'table_name' => 'civicrm_note',
 212           'entity' => 'Note',
 213           'bao' => 'CRM_Core_BAO_Note',
 214           'localizable' => 0,
 215           'html' => [
 216             'type' => 'Text',
 217           ],
 218         ],
 219         'privacy' => [
 220           'name' => 'privacy',
 221           'type' => CRM_Utils_Type::T_STRING,
 222           'title' => ts('Privacy'),
 223           'description' => ts('Foreign Key to Note Privacy Level (which is an option value pair and hence an implicit FK)'),
 224           'maxlength' => 255,
 225           'size' => CRM_Utils_Type::HUGE,
 226           'where' => 'civicrm_note.privacy',
 227           'table_name' => 'civicrm_note',
 228           'entity' => 'Note',
 229           'bao' => 'CRM_Core_BAO_Note',
 230           'localizable' => 0,
 231           'html' => [
 232             'type' => 'Select',
 233           ],
 234           'pseudoconstant' => [
 235             'optionGroupName' => 'note_privacy',
 236             'optionEditPath' => 'civicrm/admin/options/note_privacy',
 237           ]
 238         ],
 239       ];
 240       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 241     }
 242     return Civi::$statics[__CLASS__]['fields'];
 243   }
 244
 245   /**
 246    * Return a mapping from field-name to the corresponding key (as used in fields()).
 247    *
 248    * @return array
 249    *   Array(string $name => string $uniqueName).
 250    */
 251   public static function &fieldKeys() {
 252     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 253       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 254     }
 255     return Civi::$statics[__CLASS__]['fieldKeys'];
 256   }
 257
 258   /**
 259    * Returns the names of this table
 260    *
 261    * @return string
 262    */
 263   public static function getTableName() {
 264     return self::$_tableName;
 265   }
 266
 267   /**
 268    * Returns if this table needs to be logged
 269    *
 270    * @return bool
 271    */
 272   public function getLog() {
 273     return self::$_log;
 274   }
 275
 276   /**
 277    * Returns the list of fields that can be imported
 278    *
 279    * @param bool $prefix
 280    *
 281    * @return array
 282    */
 283   public static function &import($prefix = FALSE) {
 284     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'note', $prefix, []);
 285     return $r;
 286   }
 287
 288   /**
 289    * Returns the list of fields that can be exported
 290    *
 291    * @param bool $prefix
 292    *
 293    * @return array
 294    */
 295   public static function &export($prefix = FALSE) {
 296     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'note', $prefix, []);
 297     return $r;
 298   }
 299
 300   /**
 301    * Returns the list of indices
 302    *
 303    * @param bool $localize
 304    *
 305    * @return array
 306    */
 307   public static function indices($localize = TRUE) {
 308     $indices = [
 309       'index_entity' => [
 310         'name' => 'index_entity',
 311         'field' => [
 312           0 => 'entity_table',
 313           1 => 'entity_id',
 314         ],
 315         'localizable' => FALSE,
 316         'sig' => 'civicrm_note::0::entity_table::entity_id',
 317       ],
 318     ];
 319     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 320   }
 321
 322 }