CRM/Core/DAO/EntityTag.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.7                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2016                                |
   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-2016
  30  *
  31  * Generated from xml/schema/CRM/Core/EntityTag.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:b20b74dc25d45ec2053e8aa064530c1e)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 class CRM_Core_DAO_EntityTag extends CRM_Core_DAO {
  38   /**
  39    * static instance to hold the table name
  40    *
  41    * @var string
  42    */
  43   static $_tableName = 'civicrm_entity_tag';
  44   /**
  45    * static value to see if we should log any modifications to
  46    * this table in the civicrm_log table
  47    *
  48    * @var boolean
  49    */
  50   static $_log = true;
  51   /**
  52    * primary key
  53    *
  54    * @var int unsigned
  55    */
  56   public $id;
  57   /**
  58    * physical tablename for entity being joined to file, e.g. civicrm_contact
  59    *
  60    * @var string
  61    */
  62   public $entity_table;
  63   /**
  64    * FK to entity table specified in entity_table column.
  65    *
  66    * @var int unsigned
  67    */
  68   public $entity_id;
  69   /**
  70    * FK to civicrm_tag
  71    *
  72    * @var int unsigned
  73    */
  74   public $tag_id;
  75   /**
  76    * class constructor
  77    *
  78    * @return civicrm_entity_tag
  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         ) ,
 114         'entity_table' => array(
 115           'name' => 'entity_table',
 116           'type' => CRM_Utils_Type::T_STRING,
 117           'title' => ts('Entity Table') ,
 118           'description' => 'physical tablename for entity being joined to file, e.g. civicrm_contact',
 119           'maxlength' => 64,
 120           'size' => CRM_Utils_Type::BIG,
 121           'pseudoconstant' => array(
 122             'optionGroupName' => 'tag_used_for',
 123             'optionEditPath' => 'civicrm/admin/options/tag_used_for',
 124           )
 125         ) ,
 126         'entity_id' => array(
 127           'name' => 'entity_id',
 128           'type' => CRM_Utils_Type::T_INT,
 129           'title' => ts('Entity ID') ,
 130           'description' => 'FK to entity table specified in entity_table column.',
 131           'required' => true,
 132         ) ,
 133         'tag_id' => array(
 134           'name' => 'tag_id',
 135           'type' => CRM_Utils_Type::T_INT,
 136           'title' => ts('Tag') ,
 137           'description' => 'FK to civicrm_tag',
 138           'required' => true,
 139           'FKClassName' => 'CRM_Core_DAO_Tag',
 140           'html' => array(
 141             'type' => 'Select',
 142           ) ,
 143           'pseudoconstant' => array(
 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    * Return a mapping from field-name to the corresponding key (as used in fields()).
 156    *
 157    * @return array
 158    *   Array(string $name => string $uniqueName).
 159    */
 160   static function &fieldKeys() {
 161     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 162       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 163     }
 164     return Civi::$statics[__CLASS__]['fieldKeys'];
 165   }
 166   /**
 167    * Returns the names of this table
 168    *
 169    * @return string
 170    */
 171   static function getTableName() {
 172     return self::$_tableName;
 173   }
 174   /**
 175    * Returns if this table needs to be logged
 176    *
 177    * @return boolean
 178    */
 179   function getLog() {
 180     return self::$_log;
 181   }
 182   /**
 183    * Returns the list of fields that can be imported
 184    *
 185    * @param bool $prefix
 186    *
 187    * @return array
 188    */
 189   static function &import($prefix = false) {
 190     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'entity_tag', $prefix, array());
 191     return $r;
 192   }
 193   /**
 194    * Returns the list of fields that can be exported
 195    *
 196    * @param bool $prefix
 197    *
 198    * @return array
 199    */
 200   static function &export($prefix = false) {
 201     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'entity_tag', $prefix, array());
 202     return $r;
 203   }
 204 }