CRM/Contact/DAO/GroupContactCache.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/Contact/GroupContactCache.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:023a51d74e195284645b47368b5d0ba5)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 class CRM_Contact_DAO_GroupContactCache extends CRM_Core_DAO {
  38   /**
  39    * static instance to hold the table name
  40    *
  41    * @var string
  42    */
  43   static $_tableName = 'civicrm_group_contact_cache';
  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 = false;
  51   /**
  52    * primary key
  53    *
  54    * @var int unsigned
  55    */
  56   public $id;
  57   /**
  58    * FK to civicrm_group
  59    *
  60    * @var int unsigned
  61    */
  62   public $group_id;
  63   /**
  64    * FK to civicrm_contact
  65    *
  66    * @var int unsigned
  67    */
  68   public $contact_id;
  69   /**
  70    * class constructor
  71    *
  72    * @return civicrm_group_contact_cache
  73    */
  74   function __construct() {
  75     $this->__table = 'civicrm_group_contact_cache';
  76     parent::__construct();
  77   }
  78   /**
  79    * Returns foreign keys and entity references
  80    *
  81    * @return array
  82    *   [CRM_Core_Reference_Interface]
  83    */
  84   static function getReferenceColumns() {
  85     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  86       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
  87       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'group_id', 'civicrm_group', 'id');
  88       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'contact_id', 'civicrm_contact', 'id');
  89       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  90     }
  91     return Civi::$statics[__CLASS__]['links'];
  92   }
  93   /**
  94    * Returns all the column names of this table
  95    *
  96    * @return array
  97    */
  98   static function &fields() {
  99     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 100       Civi::$statics[__CLASS__]['fields'] = array(
 101         'id' => array(
 102           'name' => 'id',
 103           'type' => CRM_Utils_Type::T_INT,
 104           'title' => ts('Group Contact Cache ID') ,
 105           'description' => 'primary key',
 106           'required' => true,
 107         ) ,
 108         'group_id' => array(
 109           'name' => 'group_id',
 110           'type' => CRM_Utils_Type::T_INT,
 111           'title' => ts('Group') ,
 112           'description' => 'FK to civicrm_group',
 113           'required' => true,
 114           'FKClassName' => 'CRM_Contact_DAO_Group',
 115           'html' => array(
 116             'type' => 'Select',
 117           ) ,
 118           'pseudoconstant' => array(
 119             'table' => 'civicrm_group',
 120             'keyColumn' => 'id',
 121             'labelColumn' => 'title',
 122           )
 123         ) ,
 124         'contact_id' => array(
 125           'name' => 'contact_id',
 126           'type' => CRM_Utils_Type::T_INT,
 127           'title' => ts('Contact ID') ,
 128           'description' => 'FK to civicrm_contact',
 129           'required' => true,
 130           'FKClassName' => 'CRM_Contact_DAO_Contact',
 131         ) ,
 132       );
 133       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 134     }
 135     return Civi::$statics[__CLASS__]['fields'];
 136   }
 137   /**
 138    * Return a mapping from field-name to the corresponding key (as used in fields()).
 139    *
 140    * @return array
 141    *   Array(string $name => string $uniqueName).
 142    */
 143   static function &fieldKeys() {
 144     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 145       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 146     }
 147     return Civi::$statics[__CLASS__]['fieldKeys'];
 148   }
 149   /**
 150    * Returns the names of this table
 151    *
 152    * @return string
 153    */
 154   static function getTableName() {
 155     return self::$_tableName;
 156   }
 157   /**
 158    * Returns if this table needs to be logged
 159    *
 160    * @return boolean
 161    */
 162   function getLog() {
 163     return self::$_log;
 164   }
 165   /**
 166    * Returns the list of fields that can be imported
 167    *
 168    * @param bool $prefix
 169    *
 170    * @return array
 171    */
 172   static function &import($prefix = false) {
 173     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'group_contact_cache', $prefix, array());
 174     return $r;
 175   }
 176   /**
 177    * Returns the list of fields that can be exported
 178    *
 179    * @param bool $prefix
 180    *
 181    * @return array
 182    */
 183   static function &export($prefix = false) {
 184     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'group_contact_cache', $prefix, array());
 185     return $r;
 186   }
 187 }