crm.fsf.org/20131203/files/sites/all/modules-new/civicrm/CRM/Core/DAO/UFMatch.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.6                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  30  *
  31  * Generated from xml/schema/CRM/Core/UFMatch.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  */
  34 require_once 'CRM/Core/DAO.php';
  35 require_once 'CRM/Utils/Type.php';
  36 class CRM_Core_DAO_UFMatch extends CRM_Core_DAO {
  37   /**
  38    * static instance to hold the table name
  39    *
  40    * @var string
  41    */
  42   static $_tableName = 'civicrm_uf_match';
  43   /**
  44    * static instance to hold the field values
  45    *
  46    * @var array
  47    */
  48   static $_fields = null;
  49   /**
  50    * static instance to hold the keys used in $_fields for each field.
  51    *
  52    * @var array
  53    */
  54   static $_fieldKeys = null;
  55   /**
  56    * static instance to hold the FK relationships
  57    *
  58    * @var string
  59    */
  60   static $_links = null;
  61   /**
  62    * static instance to hold the values that can
  63    * be imported
  64    *
  65    * @var array
  66    */
  67   static $_import = null;
  68   /**
  69    * static instance to hold the values that can
  70    * be exported
  71    *
  72    * @var array
  73    */
  74   static $_export = null;
  75   /**
  76    * static value to see if we should log any modifications to
  77    * this table in the civicrm_log table
  78    *
  79    * @var boolean
  80    */
  81   static $_log = true;
  82   /**
  83    * System generated ID.
  84    *
  85    * @var int unsigned
  86    */
  87   public $id;
  88   /**
  89    * Which Domain is this match entry for
  90    *
  91    * @var int unsigned
  92    */
  93   public $domain_id;
  94   /**
  95    * UF ID
  96    *
  97    * @var int unsigned
  98    */
  99   public $uf_id;
 100   /**
 101    * UF Name
 102    *
 103    * @var string
 104    */
 105   public $uf_name;
 106   /**
 107    * FK to Contact ID
 108    *
 109    * @var int unsigned
 110    */
 111   public $contact_id;
 112   /**
 113    * UI language preferred by the given user/contact
 114    *
 115    * @var string
 116    */
 117   public $language;
 118   /**
 119    * class constructor
 120    *
 121    * @return civicrm_uf_match
 122    */
 123   function __construct() {
 124     $this->__table = 'civicrm_uf_match';
 125     parent::__construct();
 126   }
 127   /**
 128    * Returns foreign keys and entity references
 129    *
 130    * @return array
 131    *   [CRM_Core_Reference_Interface]
 132    */
 133   static function getReferenceColumns() {
 134     if (!self::$_links) {
 135       self::$_links = static ::createReferenceColumns(__CLASS__);
 136       self::$_links[] = new CRM_Core_Reference_Basic(self::getTableName() , 'domain_id', 'civicrm_domain', 'id');
 137       self::$_links[] = new CRM_Core_Reference_Basic(self::getTableName() , 'contact_id', 'civicrm_contact', 'id');
 138     }
 139     return self::$_links;
 140   }
 141   /**
 142    * Returns all the column names of this table
 143    *
 144    * @return array
 145    */
 146   static function &fields() {
 147     if (!(self::$_fields)) {
 148       self::$_fields = array(
 149         'id' => array(
 150           'name' => 'id',
 151           'type' => CRM_Utils_Type::T_INT,
 152           'title' => ts('UF Match ID') ,
 153           'description' => 'System generated ID.',
 154           'required' => true,
 155         ) ,
 156         'domain_id' => array(
 157           'name' => 'domain_id',
 158           'type' => CRM_Utils_Type::T_INT,
 159           'title' => ts('UF Match Domain ID') ,
 160           'description' => 'Which Domain is this match entry for',
 161           'required' => true,
 162           'FKClassName' => 'CRM_Core_DAO_Domain',
 163           'pseudoconstant' => array(
 164             'table' => 'civicrm_domain',
 165             'keyColumn' => 'id',
 166             'labelColumn' => 'name',
 167           )
 168         ) ,
 169         'uf_id' => array(
 170           'name' => 'uf_id',
 171           'type' => CRM_Utils_Type::T_INT,
 172           'title' => ts('CMS ID') ,
 173           'description' => 'UF ID',
 174           'required' => true,
 175         ) ,
 176         'uf_name' => array(
 177           'name' => 'uf_name',
 178           'type' => CRM_Utils_Type::T_STRING,
 179           'title' => ts('CMS Unique Identifier') ,
 180           'description' => 'UF Name',
 181           'maxlength' => 128,
 182           'size' => CRM_Utils_Type::HUGE,
 183         ) ,
 184         'contact_id' => array(
 185           'name' => 'contact_id',
 186           'type' => CRM_Utils_Type::T_INT,
 187           'title' => ts('CiviCRM Contact ID') ,
 188           'description' => 'FK to Contact ID',
 189           'FKClassName' => 'CRM_Contact_DAO_Contact',
 190         ) ,
 191         'language' => array(
 192           'name' => 'language',
 193           'type' => CRM_Utils_Type::T_STRING,
 194           'title' => ts('Preferred Language') ,
 195           'description' => 'UI language preferred by the given user/contact',
 196           'maxlength' => 5,
 197           'size' => CRM_Utils_Type::SIX,
 198         ) ,
 199       );
 200     }
 201     return self::$_fields;
 202   }
 203   /**
 204    * Returns an array containing, for each field, the arary key used for that
 205    * field in self::$_fields.
 206    *
 207    * @return array
 208    */
 209   static function &fieldKeys() {
 210     if (!(self::$_fieldKeys)) {
 211       self::$_fieldKeys = array(
 212         'id' => 'id',
 213         'domain_id' => 'domain_id',
 214         'uf_id' => 'uf_id',
 215         'uf_name' => 'uf_name',
 216         'contact_id' => 'contact_id',
 217         'language' => 'language',
 218       );
 219     }
 220     return self::$_fieldKeys;
 221   }
 222   /**
 223    * Returns the names of this table
 224    *
 225    * @return string
 226    */
 227   static function getTableName() {
 228     return self::$_tableName;
 229   }
 230   /**
 231    * Returns if this table needs to be logged
 232    *
 233    * @return boolean
 234    */
 235   function getLog() {
 236     return self::$_log;
 237   }
 238   /**
 239    * Returns the list of fields that can be imported
 240    *
 241    * @param bool $prefix
 242    *
 243    * @return array
 244    */
 245   static function &import($prefix = false) {
 246     if (!(self::$_import)) {
 247       self::$_import = array();
 248       $fields = self::fields();
 249       foreach($fields as $name => $field) {
 250         if (CRM_Utils_Array::value('import', $field)) {
 251           if ($prefix) {
 252             self::$_import['uf_match'] = & $fields[$name];
 253           } else {
 254             self::$_import[$name] = & $fields[$name];
 255           }
 256         }
 257       }
 258     }
 259     return self::$_import;
 260   }
 261   /**
 262    * Returns the list of fields that can be exported
 263    *
 264    * @param bool $prefix
 265    *
 266    * @return array
 267    */
 268   static function &export($prefix = false) {
 269     if (!(self::$_export)) {
 270       self::$_export = array();
 271       $fields = self::fields();
 272       foreach($fields as $name => $field) {
 273         if (CRM_Utils_Array::value('export', $field)) {
 274           if ($prefix) {
 275             self::$_export['uf_match'] = & $fields[$name];
 276           } else {
 277             self::$_export[$name] = & $fields[$name];
 278           }
 279         }
 280       }
 281     }
 282     return self::$_export;
 283   }
 284 }