CRM/Core/DAO/UFMatch.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/UFMatch.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:7a4ca7be149cba37dc9cfb8c2885989c)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_Core_DAO_UFMatch constructor.
  39  */
  40 class CRM_Core_DAO_UFMatch extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_uf_match';
  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    * System generated ID.
  55    *
  56    * @var int unsigned
  57    */
  58   public $id;
  59   /**
  60    * Which Domain is this match entry for
  61    *
  62    * @var int unsigned
  63    */
  64   public $domain_id;
  65   /**
  66    * UF ID
  67    *
  68    * @var int unsigned
  69    */
  70   public $uf_id;
  71   /**
  72    * UF Name
  73    *
  74    * @var string
  75    */
  76   public $uf_name;
  77   /**
  78    * FK to Contact ID
  79    *
  80    * @var int unsigned
  81    */
  82   public $contact_id;
  83   /**
  84    * UI language preferred by the given user/contact
  85    *
  86    * @var string
  87    */
  88   public $language;
  89   /**
  90    * Class constructor.
  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           'table_name' => 'civicrm_uf_match',
 126           'entity' => 'UFMatch',
 127           'bao' => 'CRM_Core_BAO_UFMatch',
 128         ) ,
 129         'domain_id' => array(
 130           'name' => 'domain_id',
 131           'type' => CRM_Utils_Type::T_INT,
 132           'title' => ts('UF Match Domain ID') ,
 133           'description' => 'Which Domain is this match entry for',
 134           'required' => true,
 135           'table_name' => 'civicrm_uf_match',
 136           'entity' => 'UFMatch',
 137           'bao' => 'CRM_Core_BAO_UFMatch',
 138           'FKClassName' => 'CRM_Core_DAO_Domain',
 139           'pseudoconstant' => array(
 140             'table' => 'civicrm_domain',
 141             'keyColumn' => 'id',
 142             'labelColumn' => 'name',
 143           )
 144         ) ,
 145         'uf_id' => array(
 146           'name' => 'uf_id',
 147           'type' => CRM_Utils_Type::T_INT,
 148           'title' => ts('CMS ID') ,
 149           'description' => 'UF ID',
 150           'required' => true,
 151           'table_name' => 'civicrm_uf_match',
 152           'entity' => 'UFMatch',
 153           'bao' => 'CRM_Core_BAO_UFMatch',
 154         ) ,
 155         'uf_name' => array(
 156           'name' => 'uf_name',
 157           'type' => CRM_Utils_Type::T_STRING,
 158           'title' => ts('CMS Unique Identifier') ,
 159           'description' => 'UF Name',
 160           'maxlength' => 128,
 161           'size' => CRM_Utils_Type::HUGE,
 162           'table_name' => 'civicrm_uf_match',
 163           'entity' => 'UFMatch',
 164           'bao' => 'CRM_Core_BAO_UFMatch',
 165         ) ,
 166         'contact_id' => array(
 167           'name' => 'contact_id',
 168           'type' => CRM_Utils_Type::T_INT,
 169           'title' => ts('CiviCRM Contact ID') ,
 170           'description' => 'FK to Contact ID',
 171           'table_name' => 'civicrm_uf_match',
 172           'entity' => 'UFMatch',
 173           'bao' => 'CRM_Core_BAO_UFMatch',
 174           'FKClassName' => 'CRM_Contact_DAO_Contact',
 175         ) ,
 176         'language' => array(
 177           'name' => 'language',
 178           'type' => CRM_Utils_Type::T_STRING,
 179           'title' => ts('Preferred Language') ,
 180           'description' => 'UI language preferred by the given user/contact',
 181           'maxlength' => 5,
 182           'size' => CRM_Utils_Type::SIX,
 183           'table_name' => 'civicrm_uf_match',
 184           'entity' => 'UFMatch',
 185           'bao' => 'CRM_Core_BAO_UFMatch',
 186         ) ,
 187       );
 188       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 189     }
 190     return Civi::$statics[__CLASS__]['fields'];
 191   }
 192   /**
 193    * Return a mapping from field-name to the corresponding key (as used in fields()).
 194    *
 195    * @return array
 196    *   Array(string $name => string $uniqueName).
 197    */
 198   static function &fieldKeys() {
 199     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 200       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 201     }
 202     return Civi::$statics[__CLASS__]['fieldKeys'];
 203   }
 204   /**
 205    * Returns the names of this table
 206    *
 207    * @return string
 208    */
 209   static function getTableName() {
 210     return self::$_tableName;
 211   }
 212   /**
 213    * Returns if this table needs to be logged
 214    *
 215    * @return boolean
 216    */
 217   function getLog() {
 218     return self::$_log;
 219   }
 220   /**
 221    * Returns the list of fields that can be imported
 222    *
 223    * @param bool $prefix
 224    *
 225    * @return array
 226    */
 227   static function &import($prefix = false) {
 228     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'uf_match', $prefix, array());
 229     return $r;
 230   }
 231   /**
 232    * Returns the list of fields that can be exported
 233    *
 234    * @param bool $prefix
 235    *
 236    * @return array
 237    */
 238   static function &export($prefix = false) {
 239     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'uf_match', $prefix, array());
 240     return $r;
 241   }
 242 }