CRM/Core/DAO/EntityTag.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC (c) 2004-2019
   6  *
   7  * Generated from xml/schema/CRM/Core/EntityTag.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:721b045d10e22535a86c5e927e489477)
  10  */
  11
  12 /**
  13  * Database access object for the EntityTag entity.
  14  */
  15 class CRM_Core_DAO_EntityTag extends CRM_Core_DAO {
  16
  17   /**
  18    * Static instance to hold the table name.
  19    *
  20    * @var string
  21    */
  22   public static $_tableName = 'civicrm_entity_tag';
  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    * primary key
  33    *
  34    * @var int unsigned
  35    */
  36   public $id;
  37
  38   /**
  39    * physical tablename for entity being joined to file, e.g. civicrm_contact
  40    *
  41    * @var string
  42    */
  43   public $entity_table;
  44
  45   /**
  46    * FK to entity table specified in entity_table column.
  47    *
  48    * @var int unsigned
  49    */
  50   public $entity_id;
  51
  52   /**
  53    * FK to civicrm_tag
  54    *
  55    * @var int unsigned
  56    */
  57   public $tag_id;
  58
  59   /**
  60    * Class constructor.
  61    */
  62   public function __construct() {
  63     $this->__table = 'civicrm_entity_tag';
  64     parent::__construct();
  65   }
  66
  67   /**
  68    * Returns foreign keys and entity references.
  69    *
  70    * @return array
  71    *   [CRM_Core_Reference_Interface]
  72    */
  73   public static function getReferenceColumns() {
  74     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  75       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
  76       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'tag_id', 'civicrm_tag', 'id');
  77       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName(), 'entity_id', NULL, 'id', 'entity_table');
  78       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  79     }
  80     return Civi::$statics[__CLASS__]['links'];
  81   }
  82
  83   /**
  84    * Returns all the column names of this table
  85    *
  86    * @return array
  87    */
  88   public static function &fields() {
  89     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
  90       Civi::$statics[__CLASS__]['fields'] = [
  91         'id' => [
  92           'name' => 'id',
  93           'type' => CRM_Utils_Type::T_INT,
  94           'title' => ts('Entity Tag ID'),
  95           'description' => ts('primary key'),
  96           'required' => TRUE,
  97           'table_name' => 'civicrm_entity_tag',
  98           'entity' => 'EntityTag',
  99           'bao' => 'CRM_Core_BAO_EntityTag',
 100           'localizable' => 0,
 101         ],
 102         'entity_table' => [
 103           'name' => 'entity_table',
 104           'type' => CRM_Utils_Type::T_STRING,
 105           'title' => ts('Entity Table'),
 106           'description' => ts('physical tablename for entity being joined to file, e.g. civicrm_contact'),
 107           'maxlength' => 64,
 108           'size' => CRM_Utils_Type::BIG,
 109           'table_name' => 'civicrm_entity_tag',
 110           'entity' => 'EntityTag',
 111           'bao' => 'CRM_Core_BAO_EntityTag',
 112           'localizable' => 0,
 113           'pseudoconstant' => [
 114             'optionGroupName' => 'tag_used_for',
 115             'optionEditPath' => 'civicrm/admin/options/tag_used_for',
 116           ]
 117         ],
 118         'entity_id' => [
 119           'name' => 'entity_id',
 120           'type' => CRM_Utils_Type::T_INT,
 121           'title' => ts('Entity ID'),
 122           'description' => ts('FK to entity table specified in entity_table column.'),
 123           'required' => TRUE,
 124           'table_name' => 'civicrm_entity_tag',
 125           'entity' => 'EntityTag',
 126           'bao' => 'CRM_Core_BAO_EntityTag',
 127           'localizable' => 0,
 128         ],
 129         'tag_id' => [
 130           'name' => 'tag_id',
 131           'type' => CRM_Utils_Type::T_INT,
 132           'title' => ts('Tag'),
 133           'description' => ts('FK to civicrm_tag'),
 134           'required' => TRUE,
 135           'table_name' => 'civicrm_entity_tag',
 136           'entity' => 'EntityTag',
 137           'bao' => 'CRM_Core_BAO_EntityTag',
 138           'localizable' => 0,
 139           'FKClassName' => 'CRM_Core_DAO_Tag',
 140           'html' => [
 141             'type' => 'Select',
 142           ],
 143           'pseudoconstant' => [
 144             'table' => 'civicrm_tag',
 145             'keyColumn' => 'id',
 146             'labelColumn' => 'name',
 147           ]
 148         ],
 149       ];
 150       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 151     }
 152     return Civi::$statics[__CLASS__]['fields'];
 153   }
 154
 155   /**
 156    * Return a mapping from field-name to the corresponding key (as used in fields()).
 157    *
 158    * @return array
 159    *   Array(string $name => string $uniqueName).
 160    */
 161   public static function &fieldKeys() {
 162     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 163       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 164     }
 165     return Civi::$statics[__CLASS__]['fieldKeys'];
 166   }
 167
 168   /**
 169    * Returns the names of this table
 170    *
 171    * @return string
 172    */
 173   public static function getTableName() {
 174     return self::$_tableName;
 175   }
 176
 177   /**
 178    * Returns if this table needs to be logged
 179    *
 180    * @return bool
 181    */
 182   public function getLog() {
 183     return self::$_log;
 184   }
 185
 186   /**
 187    * Returns the list of fields that can be imported
 188    *
 189    * @param bool $prefix
 190    *
 191    * @return array
 192    */
 193   public static function &import($prefix = FALSE) {
 194     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'entity_tag', $prefix, []);
 195     return $r;
 196   }
 197
 198   /**
 199    * Returns the list of fields that can be exported
 200    *
 201    * @param bool $prefix
 202    *
 203    * @return array
 204    */
 205   public static function &export($prefix = FALSE) {
 206     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'entity_tag', $prefix, []);
 207     return $r;
 208   }
 209
 210   /**
 211    * Returns the list of indices
 212    *
 213    * @param bool $localize
 214    *
 215    * @return array
 216    */
 217   public static function indices($localize = TRUE) {
 218     $indices = [
 219       'UI_entity_id_entity_table_tag_id' => [
 220         'name' => 'UI_entity_id_entity_table_tag_id',
 221         'field' => [
 222           0 => 'entity_id',
 223           1 => 'entity_table',
 224           2 => 'tag_id',
 225         ],
 226         'localizable' => FALSE,
 227         'unique' => TRUE,
 228         'sig' => 'civicrm_entity_tag::1::entity_id::entity_table::tag_id',
 229       ],
 230     ];
 231     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 232   }
 233
 234 }