CRM/Core/DAO/EntityTag.php

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