CRM/Core/DAO/Tag.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/Core/Tag.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:68e222188dd1d031d2219aa1617e15af)
  10  */
  11
  12 /**
  13  * Database access object for the Tag entity.
  14  */
  15 class CRM_Core_DAO_Tag 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_tag';
  25
  26   /**
  27    * Icon associated with this entity.
  28    *
  29    * @var string
  30    */
  31   public static $_icon = 'fa-tag';
  32
  33   /**
  34    * Field to show when displaying a record.
  35    *
  36    * @var string
  37    */
  38   public static $_labelField = 'name';
  39
  40   /**
  41    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  42    *
  43    * @var bool
  44    */
  45   public static $_log = TRUE;
  46
  47   /**
  48    * Tag ID
  49    *
  50    * @var int|string|null
  51    *   (SQL type: int unsigned)
  52    *   Note that values will be retrieved from the database as a string.
  53    */
  54   public $id;
  55
  56   /**
  57    * Name of Tag.
  58    *
  59    * @var string
  60    *   (SQL type: varchar(64))
  61    *   Note that values will be retrieved from the database as a string.
  62    */
  63   public $name;
  64
  65   /**
  66    * Optional verbose description of the tag.
  67    *
  68    * @var string|null
  69    *   (SQL type: varchar(255))
  70    *   Note that values will be retrieved from the database as a string.
  71    */
  72   public $description;
  73
  74   /**
  75    * Optional parent id for this tag.
  76    *
  77    * @var int|string|null
  78    *   (SQL type: int unsigned)
  79    *   Note that values will be retrieved from the database as a string.
  80    */
  81   public $parent_id;
  82
  83   /**
  84    * Is this tag selectable / displayed
  85    *
  86    * @var bool|string
  87    *   (SQL type: tinyint)
  88    *   Note that values will be retrieved from the database as a string.
  89    */
  90   public $is_selectable;
  91
  92   /**
  93    * @var bool|string
  94    *   (SQL type: tinyint)
  95    *   Note that values will be retrieved from the database as a string.
  96    */
  97   public $is_reserved;
  98
  99   /**
 100    * @var bool|string
 101    *   (SQL type: tinyint)
 102    *   Note that values will be retrieved from the database as a string.
 103    */
 104   public $is_tagset;
 105
 106   /**
 107    * @var string|null
 108    *   (SQL type: varchar(64))
 109    *   Note that values will be retrieved from the database as a string.
 110    */
 111   public $used_for;
 112
 113   /**
 114    * FK to civicrm_contact, who created this tag
 115    *
 116    * @var int|string|null
 117    *   (SQL type: int unsigned)
 118    *   Note that values will be retrieved from the database as a string.
 119    */
 120   public $created_id;
 121
 122   /**
 123    * Hex color value e.g. #ffffff
 124    *
 125    * @var string|null
 126    *   (SQL type: varchar(255))
 127    *   Note that values will be retrieved from the database as a string.
 128    */
 129   public $color;
 130
 131   /**
 132    * Date and time that tag was created.
 133    *
 134    * @var string|null
 135    *   (SQL type: datetime)
 136    *   Note that values will be retrieved from the database as a string.
 137    */
 138   public $created_date;
 139
 140   /**
 141    * Class constructor.
 142    */
 143   public function __construct() {
 144     $this->__table = 'civicrm_tag';
 145     parent::__construct();
 146   }
 147
 148   /**
 149    * Returns localized title of this entity.
 150    *
 151    * @param bool $plural
 152    *   Whether to return the plural version of the title.
 153    */
 154   public static function getEntityTitle($plural = FALSE) {
 155     return $plural ? ts('Tags') : ts('Tag');
 156   }
 157
 158   /**
 159    * Returns foreign keys and entity references.
 160    *
 161    * @return array
 162    *   [CRM_Core_Reference_Interface]
 163    */
 164   public static function getReferenceColumns() {
 165     if (!isset(Civi::$statics[__CLASS__]['links'])) {
 166       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
 167       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'parent_id', 'civicrm_tag', 'id');
 168       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'created_id', 'civicrm_contact', 'id');
 169       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 170     }
 171     return Civi::$statics[__CLASS__]['links'];
 172   }
 173
 174   /**
 175    * Returns all the column names of this table
 176    *
 177    * @return array
 178    */
 179   public static function &fields() {
 180     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 181       Civi::$statics[__CLASS__]['fields'] = [
 182         'id' => [
 183           'name' => 'id',
 184           'type' => CRM_Utils_Type::T_INT,
 185           'title' => ts('Tag ID'),
 186           'description' => ts('Tag ID'),
 187           'required' => TRUE,
 188           'where' => 'civicrm_tag.id',
 189           'table_name' => 'civicrm_tag',
 190           'entity' => 'Tag',
 191           'bao' => 'CRM_Core_BAO_Tag',
 192           'localizable' => 0,
 193           'html' => [
 194             'type' => 'Number',
 195           ],
 196           'readonly' => TRUE,
 197           'add' => '1.1',
 198         ],
 199         'name' => [
 200           'name' => 'name',
 201           'type' => CRM_Utils_Type::T_STRING,
 202           'title' => ts('Tag Name'),
 203           'description' => ts('Name of Tag.'),
 204           'required' => TRUE,
 205           'maxlength' => 64,
 206           'size' => CRM_Utils_Type::BIG,
 207           'where' => 'civicrm_tag.name',
 208           'table_name' => 'civicrm_tag',
 209           'entity' => 'Tag',
 210           'bao' => 'CRM_Core_BAO_Tag',
 211           'localizable' => 0,
 212           'add' => '1.1',
 213         ],
 214         'description' => [
 215           'name' => 'description',
 216           'type' => CRM_Utils_Type::T_STRING,
 217           'title' => ts('Description'),
 218           'description' => ts('Optional verbose description of the tag.'),
 219           'maxlength' => 255,
 220           'size' => CRM_Utils_Type::HUGE,
 221           'where' => 'civicrm_tag.description',
 222           'table_name' => 'civicrm_tag',
 223           'entity' => 'Tag',
 224           'bao' => 'CRM_Core_BAO_Tag',
 225           'localizable' => 0,
 226           'add' => '1.1',
 227         ],
 228         'parent_id' => [
 229           'name' => 'parent_id',
 230           'type' => CRM_Utils_Type::T_INT,
 231           'title' => ts('Parent Tag ID'),
 232           'description' => ts('Optional parent id for this tag.'),
 233           'where' => 'civicrm_tag.parent_id',
 234           'default' => NULL,
 235           'table_name' => 'civicrm_tag',
 236           'entity' => 'Tag',
 237           'bao' => 'CRM_Core_BAO_Tag',
 238           'localizable' => 0,
 239           'FKClassName' => 'CRM_Core_DAO_Tag',
 240           'html' => [
 241             'label' => ts("Parent Tag"),
 242           ],
 243           'pseudoconstant' => [
 244             'table' => 'civicrm_tag',
 245             'keyColumn' => 'id',
 246             'labelColumn' => 'name',
 247           ],
 248           'add' => '1.1',
 249         ],
 250         'is_selectable' => [
 251           'name' => 'is_selectable',
 252           'type' => CRM_Utils_Type::T_BOOLEAN,
 253           'title' => ts('Display Tag?'),
 254           'description' => ts('Is this tag selectable / displayed'),
 255           'required' => TRUE,
 256           'where' => 'civicrm_tag.is_selectable',
 257           'default' => '1',
 258           'table_name' => 'civicrm_tag',
 259           'entity' => 'Tag',
 260           'bao' => 'CRM_Core_BAO_Tag',
 261           'localizable' => 0,
 262           'add' => '2.1',
 263         ],
 264         'is_reserved' => [
 265           'name' => 'is_reserved',
 266           'type' => CRM_Utils_Type::T_BOOLEAN,
 267           'title' => ts('Reserved'),
 268           'required' => TRUE,
 269           'where' => 'civicrm_tag.is_reserved',
 270           'default' => '0',
 271           'table_name' => 'civicrm_tag',
 272           'entity' => 'Tag',
 273           'bao' => 'CRM_Core_BAO_Tag',
 274           'localizable' => 0,
 275           'add' => '3.2',
 276         ],
 277         'is_tagset' => [
 278           'name' => 'is_tagset',
 279           'type' => CRM_Utils_Type::T_BOOLEAN,
 280           'title' => ts('Tagset'),
 281           'required' => TRUE,
 282           'where' => 'civicrm_tag.is_tagset',
 283           'default' => '0',
 284           'table_name' => 'civicrm_tag',
 285           'entity' => 'Tag',
 286           'bao' => 'CRM_Core_BAO_Tag',
 287           'localizable' => 0,
 288           'add' => '3.2',
 289         ],
 290         'used_for' => [
 291           'name' => 'used_for',
 292           'type' => CRM_Utils_Type::T_STRING,
 293           'title' => ts('Used For'),
 294           'maxlength' => 64,
 295           'size' => CRM_Utils_Type::BIG,
 296           'where' => 'civicrm_tag.used_for',
 297           'default' => NULL,
 298           'table_name' => 'civicrm_tag',
 299           'entity' => 'Tag',
 300           'bao' => 'CRM_Core_BAO_Tag',
 301           'localizable' => 0,
 302           'serialize' => self::SERIALIZE_COMMA,
 303           'html' => [
 304             'type' => 'Select',
 305           ],
 306           'pseudoconstant' => [
 307             'optionGroupName' => 'tag_used_for',
 308             'optionEditPath' => 'civicrm/admin/options/tag_used_for',
 309           ],
 310           'add' => '3.2',
 311         ],
 312         'created_id' => [
 313           'name' => 'created_id',
 314           'type' => CRM_Utils_Type::T_INT,
 315           'title' => ts('Created By Contact ID'),
 316           'description' => ts('FK to civicrm_contact, who created this tag'),
 317           'where' => 'civicrm_tag.created_id',
 318           'table_name' => 'civicrm_tag',
 319           'entity' => 'Tag',
 320           'bao' => 'CRM_Core_BAO_Tag',
 321           'localizable' => 0,
 322           'FKClassName' => 'CRM_Contact_DAO_Contact',
 323           'html' => [
 324             'label' => ts("Created By"),
 325           ],
 326           'add' => '3.4',
 327         ],
 328         'color' => [
 329           'name' => 'color',
 330           'type' => CRM_Utils_Type::T_STRING,
 331           'title' => ts('Color'),
 332           'description' => ts('Hex color value e.g. #ffffff'),
 333           'maxlength' => 255,
 334           'size' => CRM_Utils_Type::HUGE,
 335           'where' => 'civicrm_tag.color',
 336           'default' => NULL,
 337           'table_name' => 'civicrm_tag',
 338           'entity' => 'Tag',
 339           'bao' => 'CRM_Core_BAO_Tag',
 340           'localizable' => 0,
 341           'add' => '4.7',
 342         ],
 343         'created_date' => [
 344           'name' => 'created_date',
 345           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 346           'title' => ts('Tag Created Date'),
 347           'description' => ts('Date and time that tag was created.'),
 348           'where' => 'civicrm_tag.created_date',
 349           'table_name' => 'civicrm_tag',
 350           'entity' => 'Tag',
 351           'bao' => 'CRM_Core_BAO_Tag',
 352           'localizable' => 0,
 353           'add' => '3.4',
 354         ],
 355       ];
 356       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 357     }
 358     return Civi::$statics[__CLASS__]['fields'];
 359   }
 360
 361   /**
 362    * Return a mapping from field-name to the corresponding key (as used in fields()).
 363    *
 364    * @return array
 365    *   Array(string $name => string $uniqueName).
 366    */
 367   public static function &fieldKeys() {
 368     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 369       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 370     }
 371     return Civi::$statics[__CLASS__]['fieldKeys'];
 372   }
 373
 374   /**
 375    * Returns the names of this table
 376    *
 377    * @return string
 378    */
 379   public static function getTableName() {
 380     return self::$_tableName;
 381   }
 382
 383   /**
 384    * Returns if this table needs to be logged
 385    *
 386    * @return bool
 387    */
 388   public function getLog() {
 389     return self::$_log;
 390   }
 391
 392   /**
 393    * Returns the list of fields that can be imported
 394    *
 395    * @param bool $prefix
 396    *
 397    * @return array
 398    */
 399   public static function &import($prefix = FALSE) {
 400     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'tag', $prefix, []);
 401     return $r;
 402   }
 403
 404   /**
 405    * Returns the list of fields that can be exported
 406    *
 407    * @param bool $prefix
 408    *
 409    * @return array
 410    */
 411   public static function &export($prefix = FALSE) {
 412     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'tag', $prefix, []);
 413     return $r;
 414   }
 415
 416   /**
 417    * Returns the list of indices
 418    *
 419    * @param bool $localize
 420    *
 421    * @return array
 422    */
 423   public static function indices($localize = TRUE) {
 424     $indices = [
 425       'UI_name' => [
 426         'name' => 'UI_name',
 427         'field' => [
 428           0 => 'name',
 429         ],
 430         'localizable' => FALSE,
 431         'unique' => TRUE,
 432         'sig' => 'civicrm_tag::1::name',
 433       ],
 434     ];
 435     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 436   }
 437
 438 }