3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * @copyright CiviCRM LLC (c) 2004-2017
31 * Generated from xml/schema/CRM/Dedupe/Rule.xml
32 * DO NOT EDIT. Generated by CRM_Core_CodeGen
33 * (GenCodeChecksum:d4069481ff6f6925ed299206f67ab01e)
35 require_once 'CRM/Core/DAO.php';
36 require_once 'CRM/Utils/Type.php';
38 * CRM_Dedupe_DAO_Rule constructor.
40 class CRM_Dedupe_DAO_Rule
extends CRM_Core_DAO
{
42 * Static instance to hold the table name.
46 static $_tableName = 'civicrm_dedupe_rule';
48 * Should CiviCRM log any modifications to this table in the civicrm_log table.
54 * Unique dedupe rule id
60 * The id of the rule group this rule belongs to
64 public $dedupe_rule_group_id;
66 * The name of the table this rule is about
72 * The name of the field of the table referenced in rule_table
78 * The length of the matching substring
84 * The weight of the rule
92 function __construct() {
93 $this->__table
= 'civicrm_dedupe_rule';
94 parent
::__construct();
97 * Returns foreign keys and entity references.
100 * [CRM_Core_Reference_Interface]
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() , 'dedupe_rule_group_id', 'civicrm_dedupe_rule_group', 'id');
106 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
108 return Civi
::$statics[__CLASS__
]['links'];
111 * Returns all the column names of this table
115 static function &fields() {
116 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
117 Civi
::$statics[__CLASS__
]['fields'] = array(
120 'type' => CRM_Utils_Type
::T_INT
,
121 'title' => ts('Dedupe Rule ID') ,
122 'description' => 'Unique dedupe rule id',
124 'table_name' => 'civicrm_dedupe_rule',
126 'bao' => 'CRM_Dedupe_BAO_Rule',
129 'dedupe_rule_group_id' => array(
130 'name' => 'dedupe_rule_group_id',
131 'type' => CRM_Utils_Type
::T_INT
,
132 'title' => ts('Dedupe Rule Group') ,
133 'description' => 'The id of the rule group this rule belongs to',
135 'table_name' => 'civicrm_dedupe_rule',
137 'bao' => 'CRM_Dedupe_BAO_Rule',
139 'FKClassName' => 'CRM_Dedupe_DAO_RuleGroup',
141 'rule_table' => array(
142 'name' => 'rule_table',
143 'type' => CRM_Utils_Type
::T_STRING
,
144 'title' => ts('Rule Table') ,
145 'description' => 'The name of the table this rule is about',
148 'size' => CRM_Utils_Type
::BIG
,
149 'table_name' => 'civicrm_dedupe_rule',
151 'bao' => 'CRM_Dedupe_BAO_Rule',
154 'rule_field' => array(
155 'name' => 'rule_field',
156 'type' => CRM_Utils_Type
::T_STRING
,
157 'title' => ts('Rule Field') ,
158 'description' => 'The name of the field of the table referenced in rule_table',
161 'size' => CRM_Utils_Type
::BIG
,
162 'table_name' => 'civicrm_dedupe_rule',
164 'bao' => 'CRM_Dedupe_BAO_Rule',
167 'rule_length' => array(
168 'name' => 'rule_length',
169 'type' => CRM_Utils_Type
::T_INT
,
170 'title' => ts('Rule Length') ,
171 'description' => 'The length of the matching substring',
172 'table_name' => 'civicrm_dedupe_rule',
174 'bao' => 'CRM_Dedupe_BAO_Rule',
180 'rule_weight' => array(
181 'name' => 'rule_weight',
182 'type' => CRM_Utils_Type
::T_INT
,
183 'title' => ts('Order') ,
184 'description' => 'The weight of the rule',
186 'table_name' => 'civicrm_dedupe_rule',
188 'bao' => 'CRM_Dedupe_BAO_Rule',
195 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
197 return Civi
::$statics[__CLASS__
]['fields'];
200 * Return a mapping from field-name to the corresponding key (as used in fields()).
203 * Array(string $name => string $uniqueName).
205 static function &fieldKeys() {
206 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
207 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
209 return Civi
::$statics[__CLASS__
]['fieldKeys'];
212 * Returns the names of this table
216 static function getTableName() {
217 return self
::$_tableName;
220 * Returns if this table needs to be logged
228 * Returns the list of fields that can be imported
230 * @param bool $prefix
234 static function &import($prefix = false) {
235 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'dedupe_rule', $prefix, array());
239 * Returns the list of fields that can be exported
241 * @param bool $prefix
245 static function &export($prefix = false) {
246 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'dedupe_rule', $prefix, array());
250 * Returns the list of indices
252 public static function indices($localize = TRUE) {
254 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;