CRM/Core/DAO/EntityTag.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.7                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2017                                |
   7 +--------------------------------------------------------------------+
   8 | This file is a part of CiviCRM.                                    |
   9 |                                                                    |
  10 | CiviCRM is free software; you can copy, modify, and distribute it  |
  11 | under the terms of the GNU Affero General Public License           |
  12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13 |                                                                    |
  14 | CiviCRM is distributed in the hope that it will be useful, but     |
  15 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17 | See the GNU Affero General Public License for more details.        |
  18 |                                                                    |
  19 | You should have received a copy of the GNU Affero General Public   |
  20 | License and the CiviCRM Licensing Exception along                  |
  21 | with this program; if not, contact CiviCRM LLC                     |
  22 | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23 | GNU Affero General Public License or the licensing of CiviCRM,     |
  24 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25 +--------------------------------------------------------------------+
  26 */
  27 /**
  28  * @package CRM
  29  * @copyright CiviCRM LLC (c) 2004-2017
  30  *
  31  * Generated from xml/schema/CRM/Core/EntityTag.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:cb9ae7d6e83dd7423a431498f8dee5c8)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_Core_DAO_EntityTag constructor.
  39  */
  40 class CRM_Core_DAO_EntityTag extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_entity_tag';
  47   /**
  48    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  49    *
  50    * @var boolean
  51    */
  52   static $_log = true;
  53   /**
  54    * primary key
  55    *
  56    * @var int unsigned
  57    */
  58   public $id;
  59   /**
  60    * physical tablename for entity being joined to file, e.g. civicrm_contact
  61    *
  62    * @var string
  63    */
  64   public $entity_table;
  65   /**
  66    * FK to entity table specified in entity_table column.
  67    *
  68    * @var int unsigned
  69    */
  70   public $entity_id;
  71   /**
  72    * FK to civicrm_tag
  73    *
  74    * @var int unsigned
  75    */
  76   public $tag_id;
  77   /**
  78    * Class constructor.
  79    */
  80   function __construct() {
  81     $this->__table = 'civicrm_entity_tag';
  82     parent::__construct();
  83   }
  84   /**
  85    * Returns foreign keys and entity references.
  86    *
  87    * @return array
  88    *   [CRM_Core_Reference_Interface]
  89    */
  90   static function getReferenceColumns() {
  91     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  92       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
  93       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'tag_id', 'civicrm_tag', 'id');
  94       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName() , 'entity_id', NULL, 'id', 'entity_table');
  95       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  96     }
  97     return Civi::$statics[__CLASS__]['links'];
  98   }
  99   /**
 100    * Returns all the column names of this table
 101    *
 102    * @return array
 103    */
 104   static function &fields() {
 105     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 106       Civi::$statics[__CLASS__]['fields'] = array(
 107         'id' => array(
 108           'name' => 'id',
 109           'type' => CRM_Utils_Type::T_INT,
 110           'title' => ts('Entity Tag ID') ,
 111           'description' => 'primary key',
 112           'required' => true,
 113           'table_name' => 'civicrm_entity_tag',
 114           'entity' => 'EntityTag',
 115           'bao' => 'CRM_Core_BAO_EntityTag',
 116           'localizable' => 0,
 117         ) ,
 118         'entity_table' => array(
 119           'name' => 'entity_table',
 120           'type' => CRM_Utils_Type::T_STRING,
 121           'title' => ts('Entity Table') ,
 122           'description' => 'physical tablename for entity being joined to file, e.g. civicrm_contact',
 123           'maxlength' => 64,
 124           'size' => CRM_Utils_Type::BIG,
 125           'table_name' => 'civicrm_entity_tag',
 126           'entity' => 'EntityTag',
 127           'bao' => 'CRM_Core_BAO_EntityTag',
 128           'localizable' => 0,
 129           'pseudoconstant' => array(
 130             'optionGroupName' => 'tag_used_for',
 131             'optionEditPath' => 'civicrm/admin/options/tag_used_for',
 132           )
 133         ) ,
 134         'entity_id' => array(
 135           'name' => 'entity_id',
 136           'type' => CRM_Utils_Type::T_INT,
 137           'title' => ts('Entity ID') ,
 138           'description' => 'FK to entity table specified in entity_table column.',
 139           'required' => true,
 140           'table_name' => 'civicrm_entity_tag',
 141           'entity' => 'EntityTag',
 142           'bao' => 'CRM_Core_BAO_EntityTag',
 143           'localizable' => 0,
 144         ) ,
 145         'tag_id' => array(
 146           'name' => 'tag_id',
 147           'type' => CRM_Utils_Type::T_INT,
 148           'title' => ts('Tag') ,
 149           'description' => 'FK to civicrm_tag',
 150           'required' => true,
 151           'table_name' => 'civicrm_entity_tag',
 152           'entity' => 'EntityTag',
 153           'bao' => 'CRM_Core_BAO_EntityTag',
 154           'localizable' => 0,
 155           'FKClassName' => 'CRM_Core_DAO_Tag',
 156           'html' => array(
 157             'type' => 'Select',
 158           ) ,
 159           'pseudoconstant' => array(
 160             'table' => 'civicrm_tag',
 161             'keyColumn' => 'id',
 162             'labelColumn' => 'name',
 163           )
 164         ) ,
 165       );
 166       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 167     }
 168     return Civi::$statics[__CLASS__]['fields'];
 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   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    * Returns the names of this table
 184    *
 185    * @return string
 186    */
 187   static function getTableName() {
 188     return self::$_tableName;
 189   }
 190   /**
 191    * Returns if this table needs to be logged
 192    *
 193    * @return boolean
 194    */
 195   function getLog() {
 196     return self::$_log;
 197   }
 198   /**
 199    * Returns the list of fields that can be imported
 200    *
 201    * @param bool $prefix
 202    *
 203    * @return array
 204    */
 205   static function &import($prefix = false) {
 206     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'entity_tag', $prefix, array());
 207     return $r;
 208   }
 209   /**
 210    * Returns the list of fields that can be exported
 211    *
 212    * @param bool $prefix
 213    *
 214    * @return array
 215    */
 216   static function &export($prefix = false) {
 217     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'entity_tag', $prefix, array());
 218     return $r;
 219   }
 220   /**
 221    * Returns the list of indices
 222    */
 223   public static function indices($localize = TRUE) {
 224     $indices = array(
 225       'UI_entity_id_entity_table_tag_id' => array(
 226         'name' => 'UI_entity_id_entity_table_tag_id',
 227         'field' => array(
 228           0 => 'entity_id',
 229           1 => 'entity_table',
 230           2 => 'tag_id',
 231         ) ,
 232         'localizable' => false,
 233         'unique' => true,
 234         'sig' => 'civicrm_entity_tag::1::entity_id::entity_table::tag_id',
 235       ) ,
 236     );
 237     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 238   }
 239 }