CRM/Core/DAO/Note.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC (c) 2004-2017
   6  *
   7  * Generated from xml/schema/CRM/Core/Note.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:9f5e4f2a7e73840743efc268ffb4dbfd)
  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   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   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' => 'Note ID',
 124           'required' => TRUE,
 125           'table_name' => 'civicrm_note',
 126           'entity' => 'Note',
 127           'bao' => 'CRM_Core_BAO_Note',
 128           'localizable' => 0,
 129         ],
 130         'entity_table' => [
 131           'name' => 'entity_table',
 132           'type' => CRM_Utils_Type::T_STRING,
 133           'title' => ts('Note Entity'),
 134           'description' => 'Name of table where item being referenced is stored.',
 135           'required' => TRUE,
 136           'maxlength' => 64,
 137           'size' => CRM_Utils_Type::BIG,
 138           'table_name' => 'civicrm_note',
 139           'entity' => 'Note',
 140           'bao' => 'CRM_Core_BAO_Note',
 141           'localizable' => 0,
 142           'pseudoconstant' => [
 143             'callback' => 'CRM_Core_BAO_Note::entityTables',
 144           ]
 145         ],
 146         'entity_id' => [
 147           'name' => 'entity_id',
 148           'type' => CRM_Utils_Type::T_INT,
 149           'title' => ts('Note Entity ID'),
 150           'description' => 'Foreign key to the referenced item.',
 151           'required' => TRUE,
 152           'table_name' => 'civicrm_note',
 153           'entity' => 'Note',
 154           'bao' => 'CRM_Core_BAO_Note',
 155           'localizable' => 0,
 156         ],
 157         'note' => [
 158           'name' => 'note',
 159           'type' => CRM_Utils_Type::T_TEXT,
 160           'title' => ts('Note'),
 161           'description' => 'Note and/or Comment.',
 162           'rows' => 4,
 163           'cols' => 60,
 164           'import' => TRUE,
 165           'where' => 'civicrm_note.note',
 166           'headerPattern' => '/Note|Comment/i',
 167           'dataPattern' => '//',
 168           'export' => TRUE,
 169           'table_name' => 'civicrm_note',
 170           'entity' => 'Note',
 171           'bao' => 'CRM_Core_BAO_Note',
 172           'localizable' => 0,
 173           'html' => [
 174             'type' => 'TextArea',
 175           ],
 176         ],
 177         'contact_id' => [
 178           'name' => 'contact_id',
 179           'type' => CRM_Utils_Type::T_INT,
 180           'title' => ts('Note Created By'),
 181           'description' => 'FK to Contact ID creator',
 182           'table_name' => 'civicrm_note',
 183           'entity' => 'Note',
 184           'bao' => 'CRM_Core_BAO_Note',
 185           'localizable' => 0,
 186           'FKClassName' => 'CRM_Contact_DAO_Contact',
 187         ],
 188         'modified_date' => [
 189           'name' => 'modified_date',
 190           'type' => CRM_Utils_Type::T_DATE,
 191           'title' => ts('Note Modified By'),
 192           'description' => 'When was this note last modified/edited',
 193           'table_name' => 'civicrm_note',
 194           'entity' => 'Note',
 195           'bao' => 'CRM_Core_BAO_Note',
 196           'localizable' => 0,
 197         ],
 198         'subject' => [
 199           'name' => 'subject',
 200           'type' => CRM_Utils_Type::T_STRING,
 201           'title' => ts('Subject'),
 202           'description' => 'subject of note description',
 203           'maxlength' => 255,
 204           'size' => 60,
 205           'table_name' => 'civicrm_note',
 206           'entity' => 'Note',
 207           'bao' => 'CRM_Core_BAO_Note',
 208           'localizable' => 0,
 209           'html' => [
 210             'type' => 'Text',
 211           ],
 212         ],
 213         'privacy' => [
 214           'name' => 'privacy',
 215           'type' => CRM_Utils_Type::T_STRING,
 216           'title' => ts('Privacy'),
 217           'description' => 'Foreign Key to Note Privacy Level (which is an option value pair and hence an implicit FK)',
 218           'maxlength' => 255,
 219           'size' => CRM_Utils_Type::HUGE,
 220           'table_name' => 'civicrm_note',
 221           'entity' => 'Note',
 222           'bao' => 'CRM_Core_BAO_Note',
 223           'localizable' => 0,
 224           'pseudoconstant' => [
 225             'optionGroupName' => 'note_privacy',
 226             'optionEditPath' => 'civicrm/admin/options/note_privacy',
 227           ]
 228         ],
 229       ];
 230       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 231     }
 232     return Civi::$statics[__CLASS__]['fields'];
 233   }
 234
 235   /**
 236    * Return a mapping from field-name to the corresponding key (as used in fields()).
 237    *
 238    * @return array
 239    *   Array(string $name => string $uniqueName).
 240    */
 241   public static function &fieldKeys() {
 242     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 243       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 244     }
 245     return Civi::$statics[__CLASS__]['fieldKeys'];
 246   }
 247
 248   /**
 249    * Returns the names of this table
 250    *
 251    * @return string
 252    */
 253   public static function getTableName() {
 254     return self::$_tableName;
 255   }
 256
 257   /**
 258    * Returns if this table needs to be logged
 259    *
 260    * @return bool
 261    */
 262   public function getLog() {
 263     return self::$_log;
 264   }
 265
 266   /**
 267    * Returns the list of fields that can be imported
 268    *
 269    * @param bool $prefix
 270    *
 271    * @return array
 272    */
 273   public static function &import($prefix = FALSE) {
 274     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'note', $prefix, []);
 275     return $r;
 276   }
 277
 278   /**
 279    * Returns the list of fields that can be exported
 280    *
 281    * @param bool $prefix
 282    *
 283    * @return array
 284    */
 285   public static function &export($prefix = FALSE) {
 286     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'note', $prefix, []);
 287     return $r;
 288   }
 289
 290   /**
 291    * Returns the list of indices
 292    *
 293    * @param bool $localize
 294    *
 295    * @return array
 296    */
 297   public static function indices($localize = TRUE) {
 298     $indices = [
 299       'index_entity' => [
 300         'name' => 'index_entity',
 301         'field' => [
 302           0 => 'entity_table',
 303           1 => 'entity_id',
 304         ],
 305         'localizable' => FALSE,
 306         'sig' => 'civicrm_note::0::entity_table::entity_id',
 307       ],
 308     ];
 309     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 310   }
 311
 312 }