CRM/Contact/DAO/DashboardContact.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/Contact/DashboardContact.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:fd3f7ea02b93c0dd3ecd46fb757bc2a3)
  10  */
  11
  12 /**
  13  * Database access object for the DashboardContact entity.
  14  */
  15 class CRM_Contact_DAO_DashboardContact extends CRM_Core_DAO {
  16   const EXT = 'civicrm';
  17   const TABLE_ADDED = '3.1';
  18
  19   /**
  20    * Static instance to hold the table name.
  21    *
  22    * @var string
  23    */
  24   public static $_tableName = 'civicrm_dashboard_contact';
  25
  26   /**
  27    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  28    *
  29    * @var bool
  30    */
  31   public static $_log = FALSE;
  32
  33   /**
  34    * @var int|string|null
  35    *   (SQL type: int unsigned)
  36    *   Note that values will be retrieved from the database as a string.
  37    */
  38   public $id;
  39
  40   /**
  41    * Dashboard ID
  42    *
  43    * @var int|string
  44    *   (SQL type: int unsigned)
  45    *   Note that values will be retrieved from the database as a string.
  46    */
  47   public $dashboard_id;
  48
  49   /**
  50    * Contact ID
  51    *
  52    * @var int|string
  53    *   (SQL type: int unsigned)
  54    *   Note that values will be retrieved from the database as a string.
  55    */
  56   public $contact_id;
  57
  58   /**
  59    * column no for this widget
  60    *
  61    * @var int|string|null
  62    *   (SQL type: int)
  63    *   Note that values will be retrieved from the database as a string.
  64    */
  65   public $column_no;
  66
  67   /**
  68    * Is this widget active?
  69    *
  70    * @var bool|string|null
  71    *   (SQL type: tinyint)
  72    *   Note that values will be retrieved from the database as a string.
  73    */
  74   public $is_active;
  75
  76   /**
  77    * Ordering of the widgets.
  78    *
  79    * @var int|string|null
  80    *   (SQL type: int)
  81    *   Note that values will be retrieved from the database as a string.
  82    */
  83   public $weight;
  84
  85   /**
  86    * Class constructor.
  87    */
  88   public function __construct() {
  89     $this->__table = 'civicrm_dashboard_contact';
  90     parent::__construct();
  91   }
  92
  93   /**
  94    * Returns localized title of this entity.
  95    *
  96    * @param bool $plural
  97    *   Whether to return the plural version of the title.
  98    */
  99   public static function getEntityTitle($plural = FALSE) {
 100     return $plural ? ts('Dashboard Contacts') : ts('Dashboard Contact');
 101   }
 102
 103   /**
 104    * Returns foreign keys and entity references.
 105    *
 106    * @return array
 107    *   [CRM_Core_Reference_Interface]
 108    */
 109   public static function getReferenceColumns() {
 110     if (!isset(Civi::$statics[__CLASS__]['links'])) {
 111       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
 112       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'dashboard_id', 'civicrm_dashboard', 'id');
 113       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contact_id', 'civicrm_contact', 'id');
 114       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 115     }
 116     return Civi::$statics[__CLASS__]['links'];
 117   }
 118
 119   /**
 120    * Returns all the column names of this table
 121    *
 122    * @return array
 123    */
 124   public static function &fields() {
 125     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 126       Civi::$statics[__CLASS__]['fields'] = [
 127         'id' => [
 128           'name' => 'id',
 129           'type' => CRM_Utils_Type::T_INT,
 130           'title' => ts('Dashboard Contact ID'),
 131           'required' => TRUE,
 132           'where' => 'civicrm_dashboard_contact.id',
 133           'table_name' => 'civicrm_dashboard_contact',
 134           'entity' => 'DashboardContact',
 135           'bao' => 'CRM_Contact_BAO_DashboardContact',
 136           'localizable' => 0,
 137           'html' => [
 138             'type' => 'Number',
 139           ],
 140           'readonly' => TRUE,
 141           'add' => '3.1',
 142         ],
 143         'dashboard_id' => [
 144           'name' => 'dashboard_id',
 145           'type' => CRM_Utils_Type::T_INT,
 146           'title' => ts('Dashboard ID'),
 147           'description' => ts('Dashboard ID'),
 148           'required' => TRUE,
 149           'where' => 'civicrm_dashboard_contact.dashboard_id',
 150           'table_name' => 'civicrm_dashboard_contact',
 151           'entity' => 'DashboardContact',
 152           'bao' => 'CRM_Contact_BAO_DashboardContact',
 153           'localizable' => 0,
 154           'FKClassName' => 'CRM_Core_DAO_Dashboard',
 155           'html' => [
 156             'label' => ts("Dashboard"),
 157           ],
 158           'add' => '3.1',
 159         ],
 160         'contact_id' => [
 161           'name' => 'contact_id',
 162           'type' => CRM_Utils_Type::T_INT,
 163           'title' => ts('Contact ID'),
 164           'description' => ts('Contact ID'),
 165           'required' => TRUE,
 166           'where' => 'civicrm_dashboard_contact.contact_id',
 167           'table_name' => 'civicrm_dashboard_contact',
 168           'entity' => 'DashboardContact',
 169           'bao' => 'CRM_Contact_BAO_DashboardContact',
 170           'localizable' => 0,
 171           'FKClassName' => 'CRM_Contact_DAO_Contact',
 172           'html' => [
 173             'label' => ts("Contact"),
 174           ],
 175           'add' => '3.1',
 176         ],
 177         'column_no' => [
 178           'name' => 'column_no',
 179           'type' => CRM_Utils_Type::T_INT,
 180           'title' => ts('Column No'),
 181           'description' => ts('column no for this widget'),
 182           'where' => 'civicrm_dashboard_contact.column_no',
 183           'default' => '0',
 184           'table_name' => 'civicrm_dashboard_contact',
 185           'entity' => 'DashboardContact',
 186           'bao' => 'CRM_Contact_BAO_DashboardContact',
 187           'localizable' => 0,
 188           'html' => [
 189             'label' => ts("Column Number"),
 190           ],
 191           'add' => '3.1',
 192         ],
 193         'is_active' => [
 194           'name' => 'is_active',
 195           'type' => CRM_Utils_Type::T_BOOLEAN,
 196           'title' => ts('Dashlet is Active?'),
 197           'description' => ts('Is this widget active?'),
 198           'where' => 'civicrm_dashboard_contact.is_active',
 199           'default' => '0',
 200           'table_name' => 'civicrm_dashboard_contact',
 201           'entity' => 'DashboardContact',
 202           'bao' => 'CRM_Contact_BAO_DashboardContact',
 203           'localizable' => 0,
 204           'add' => '3.1',
 205         ],
 206         'weight' => [
 207           'name' => 'weight',
 208           'type' => CRM_Utils_Type::T_INT,
 209           'title' => ts('Order'),
 210           'description' => ts('Ordering of the widgets.'),
 211           'where' => 'civicrm_dashboard_contact.weight',
 212           'default' => '0',
 213           'table_name' => 'civicrm_dashboard_contact',
 214           'entity' => 'DashboardContact',
 215           'bao' => 'CRM_Contact_BAO_DashboardContact',
 216           'localizable' => 0,
 217           'add' => '3.1',
 218         ],
 219       ];
 220       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 221     }
 222     return Civi::$statics[__CLASS__]['fields'];
 223   }
 224
 225   /**
 226    * Return a mapping from field-name to the corresponding key (as used in fields()).
 227    *
 228    * @return array
 229    *   Array(string $name => string $uniqueName).
 230    */
 231   public static function &fieldKeys() {
 232     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 233       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 234     }
 235     return Civi::$statics[__CLASS__]['fieldKeys'];
 236   }
 237
 238   /**
 239    * Returns the names of this table
 240    *
 241    * @return string
 242    */
 243   public static function getTableName() {
 244     return self::$_tableName;
 245   }
 246
 247   /**
 248    * Returns if this table needs to be logged
 249    *
 250    * @return bool
 251    */
 252   public function getLog() {
 253     return self::$_log;
 254   }
 255
 256   /**
 257    * Returns the list of fields that can be imported
 258    *
 259    * @param bool $prefix
 260    *
 261    * @return array
 262    */
 263   public static function &import($prefix = FALSE) {
 264     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'dashboard_contact', $prefix, []);
 265     return $r;
 266   }
 267
 268   /**
 269    * Returns the list of fields that can be exported
 270    *
 271    * @param bool $prefix
 272    *
 273    * @return array
 274    */
 275   public static function &export($prefix = FALSE) {
 276     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'dashboard_contact', $prefix, []);
 277     return $r;
 278   }
 279
 280   /**
 281    * Returns the list of indices
 282    *
 283    * @param bool $localize
 284    *
 285    * @return array
 286    */
 287   public static function indices($localize = TRUE) {
 288     $indices = [
 289       'index_dashboard_id_contact_id' => [
 290         'name' => 'index_dashboard_id_contact_id',
 291         'field' => [
 292           0 => 'dashboard_id',
 293           1 => 'contact_id',
 294         ],
 295         'localizable' => FALSE,
 296         'unique' => TRUE,
 297         'sig' => 'civicrm_dashboard_contact::1::dashboard_id::contact_id',
 298       ],
 299     ];
 300     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 301   }
 302
 303 }