Merge pull request #10037 from JMAConsulting/CRM-20331
[civicrm-core.git] / CRM / Dedupe / DAO / Exception.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/Dedupe/Exception.xml
32 * DO NOT EDIT. Generated by CRM_Core_CodeGen
33 * (GenCodeChecksum:5ab409ab490ba266b8cff7ba387624fa)
34 */
35 require_once 'CRM/Core/DAO.php';
36 require_once 'CRM/Utils/Type.php';
37 /**
38 * CRM_Dedupe_DAO_Exception constructor.
39 */
40 class CRM_Dedupe_DAO_Exception extends CRM_Core_DAO {
41 /**
42 * Static instance to hold the table name.
43 *
44 * @var string
45 */
46 static $_tableName = 'civicrm_dedupe_exception';
47 /**
48 * Should CiviCRM log any modifications to this table in the civicrm_log table.
49 *
50 * @var boolean
51 */
52 static $_log = false;
53 /**
54 * Unique dedupe exception id
55 *
56 * @var int unsigned
57 */
58 public $id;
59 /**
60 * FK to Contact ID
61 *
62 * @var int unsigned
63 */
64 public $contact_id1;
65 /**
66 * FK to Contact ID
67 *
68 * @var int unsigned
69 */
70 public $contact_id2;
71 /**
72 * Class constructor.
73 */
74 function __construct() {
75 $this->__table = 'civicrm_dedupe_exception';
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() , 'contact_id1', 'civicrm_contact', 'id');
88 Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'contact_id2', '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('Dedupe Exception ID') ,
105 'description' => 'Unique dedupe exception id',
106 'required' => true,
107 'table_name' => 'civicrm_dedupe_exception',
108 'entity' => 'Exception',
109 'bao' => 'CRM_Dedupe_DAO_Exception',
110 ) ,
111 'contact_id1' => array(
112 'name' => 'contact_id1',
113 'type' => CRM_Utils_Type::T_INT,
114 'title' => ts('First Dupe Contact ID') ,
115 'description' => 'FK to Contact ID',
116 'table_name' => 'civicrm_dedupe_exception',
117 'entity' => 'Exception',
118 'bao' => 'CRM_Dedupe_DAO_Exception',
119 'FKClassName' => 'CRM_Contact_DAO_Contact',
120 ) ,
121 'contact_id2' => array(
122 'name' => 'contact_id2',
123 'type' => CRM_Utils_Type::T_INT,
124 'title' => ts('Second Dupe Contact ID') ,
125 'description' => 'FK to Contact ID',
126 'table_name' => 'civicrm_dedupe_exception',
127 'entity' => 'Exception',
128 'bao' => 'CRM_Dedupe_DAO_Exception',
129 'FKClassName' => 'CRM_Contact_DAO_Contact',
130 ) ,
131 );
132 CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
133 }
134 return Civi::$statics[__CLASS__]['fields'];
135 }
136 /**
137 * Return a mapping from field-name to the corresponding key (as used in fields()).
138 *
139 * @return array
140 * Array(string $name => string $uniqueName).
141 */
142 static function &fieldKeys() {
143 if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
144 Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
145 }
146 return Civi::$statics[__CLASS__]['fieldKeys'];
147 }
148 /**
149 * Returns the names of this table
150 *
151 * @return string
152 */
153 static function getTableName() {
154 return self::$_tableName;
155 }
156 /**
157 * Returns if this table needs to be logged
158 *
159 * @return boolean
160 */
161 function getLog() {
162 return self::$_log;
163 }
164 /**
165 * Returns the list of fields that can be imported
166 *
167 * @param bool $prefix
168 *
169 * @return array
170 */
171 static function &import($prefix = false) {
172 $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'dedupe_exception', $prefix, array());
173 return $r;
174 }
175 /**
176 * Returns the list of fields that can be exported
177 *
178 * @param bool $prefix
179 *
180 * @return array
181 */
182 static function &export($prefix = false) {
183 $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'dedupe_exception', $prefix, array());
184 return $r;
185 }
186 }