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