CRM/Core/DAO/UFMatch.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/UFMatch.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:3753b535177e56dd00e57a1acb5d85a1)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 class CRM_Core_DAO_UFMatch extends CRM_Core_DAO {
  38   /**
  39    * static instance to hold the table name
  40    *
  41    * @var string
  42    */
  43   static $_tableName = 'civicrm_uf_match';
  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    * System generated ID.
  53    *
  54    * @var int unsigned
  55    */
  56   public $id;
  57   /**
  58    * Which Domain is this match entry for
  59    *
  60    * @var int unsigned
  61    */
  62   public $domain_id;
  63   /**
  64    * UF ID
  65    *
  66    * @var int unsigned
  67    */
  68   public $uf_id;
  69   /**
  70    * UF Name
  71    *
  72    * @var string
  73    */
  74   public $uf_name;
  75   /**
  76    * FK to Contact ID
  77    *
  78    * @var int unsigned
  79    */
  80   public $contact_id;
  81   /**
  82    * UI language preferred by the given user/contact
  83    *
  84    * @var string
  85    */
  86   public $language;
  87   /**
  88    * class constructor
  89    *
  90    * @return civicrm_uf_match
  91    */
  92   function __construct() {
  93     $this->__table = 'civicrm_uf_match';
  94     parent::__construct();
  95   }
  96   /**
  97    * Returns foreign keys and entity references
  98    *
  99    * @return array
 100    *   [CRM_Core_Reference_Interface]
 101    */
 102   static function getReferenceColumns() {
 103     if (!isset(Civi::$statics[__CLASS__]['links'])) {
 104       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
 105       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'domain_id', 'civicrm_domain', 'id');
 106       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'contact_id', 'civicrm_contact', 'id');
 107       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 108     }
 109     return Civi::$statics[__CLASS__]['links'];
 110   }
 111   /**
 112    * Returns all the column names of this table
 113    *
 114    * @return array
 115    */
 116   static function &fields() {
 117     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 118       Civi::$statics[__CLASS__]['fields'] = array(
 119         'id' => array(
 120           'name' => 'id',
 121           'type' => CRM_Utils_Type::T_INT,
 122           'title' => ts('UF Match ID') ,
 123           'description' => 'System generated ID.',
 124           'required' => true,
 125         ) ,
 126         'domain_id' => array(
 127           'name' => 'domain_id',
 128           'type' => CRM_Utils_Type::T_INT,
 129           'title' => ts('UF Match Domain ID') ,
 130           'description' => 'Which Domain is this match entry for',
 131           'required' => true,
 132           'FKClassName' => 'CRM_Core_DAO_Domain',
 133           'pseudoconstant' => array(
 134             'table' => 'civicrm_domain',
 135             'keyColumn' => 'id',
 136             'labelColumn' => 'name',
 137           )
 138         ) ,
 139         'uf_id' => array(
 140           'name' => 'uf_id',
 141           'type' => CRM_Utils_Type::T_INT,
 142           'title' => ts('CMS ID') ,
 143           'description' => 'UF ID',
 144           'required' => true,
 145         ) ,
 146         'uf_name' => array(
 147           'name' => 'uf_name',
 148           'type' => CRM_Utils_Type::T_STRING,
 149           'title' => ts('CMS Unique Identifier') ,
 150           'description' => 'UF Name',
 151           'maxlength' => 128,
 152           'size' => CRM_Utils_Type::HUGE,
 153         ) ,
 154         'contact_id' => array(
 155           'name' => 'contact_id',
 156           'type' => CRM_Utils_Type::T_INT,
 157           'title' => ts('CiviCRM Contact ID') ,
 158           'description' => 'FK to Contact ID',
 159           'FKClassName' => 'CRM_Contact_DAO_Contact',
 160         ) ,
 161         'language' => array(
 162           'name' => 'language',
 163           'type' => CRM_Utils_Type::T_STRING,
 164           'title' => ts('Preferred Language') ,
 165           'description' => 'UI language preferred by the given user/contact',
 166           'maxlength' => 5,
 167           'size' => CRM_Utils_Type::SIX,
 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    * Return a mapping from field-name to the corresponding key (as used in fields()).
 176    *
 177    * @return array
 178    *   Array(string $name => string $uniqueName).
 179    */
 180   static function &fieldKeys() {
 181     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 182       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 183     }
 184     return Civi::$statics[__CLASS__]['fieldKeys'];
 185   }
 186   /**
 187    * Returns the names of this table
 188    *
 189    * @return string
 190    */
 191   static function getTableName() {
 192     return self::$_tableName;
 193   }
 194   /**
 195    * Returns if this table needs to be logged
 196    *
 197    * @return boolean
 198    */
 199   function getLog() {
 200     return self::$_log;
 201   }
 202   /**
 203    * Returns the list of fields that can be imported
 204    *
 205    * @param bool $prefix
 206    *
 207    * @return array
 208    */
 209   static function &import($prefix = false) {
 210     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'uf_match', $prefix, array());
 211     return $r;
 212   }
 213   /**
 214    * Returns the list of fields that can be exported
 215    *
 216    * @param bool $prefix
 217    *
 218    * @return array
 219    */
 220   static function &export($prefix = false) {
 221     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'uf_match', $prefix, array());
 222     return $r;
 223   }
 224 }