CRM/Dedupe/DAO/RuleGroup.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/RuleGroup.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:8abbb6f14d0c67212a271bc1a08b57c2)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_Dedupe_DAO_RuleGroup constructor.
  39  */
  40 class CRM_Dedupe_DAO_RuleGroup extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_dedupe_rule_group';
  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 rule group id
  55    *
  56    * @var int unsigned
  57    */
  58   public $id;
  59   /**
  60    * The type of contacts this group applies to
  61    *
  62    * @var string
  63    */
  64   public $contact_type;
  65   /**
  66    * The weight threshold the sum of the rule weights has to cross to consider two contacts the same
  67    *
  68    * @var int
  69    */
  70   public $threshold;
  71   /**
  72    * Whether the rule should be used for cases where usage is Unsupervised, Supervised OR General(programatically)
  73    *
  74    * @var string
  75    */
  76   public $used;
  77   /**
  78    * Name of the rule group
  79    *
  80    * @var string
  81    */
  82   public $name;
  83   /**
  84    * Label of the rule group
  85    *
  86    * @var string
  87    */
  88   public $title;
  89   /**
  90    * Is this a reserved rule - a rule group that has been optimized and cannot be changed by the admin
  91    *
  92    * @var boolean
  93    */
  94   public $is_reserved;
  95   /**
  96    * Class constructor.
  97    */
  98   function __construct() {
  99     $this->__table = 'civicrm_dedupe_rule_group';
 100     parent::__construct();
 101   }
 102   /**
 103    * Returns all the column names of this table
 104    *
 105    * @return array
 106    */
 107   static function &fields() {
 108     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 109       Civi::$statics[__CLASS__]['fields'] = array(
 110         'id' => array(
 111           'name' => 'id',
 112           'type' => CRM_Utils_Type::T_INT,
 113           'title' => ts('Rule Group ID') ,
 114           'description' => 'Unique dedupe rule group id',
 115           'required' => true,
 116         ) ,
 117         'contact_type' => array(
 118           'name' => 'contact_type',
 119           'type' => CRM_Utils_Type::T_STRING,
 120           'title' => ts('Contact Type') ,
 121           'description' => 'The type of contacts this group applies to',
 122           'maxlength' => 12,
 123           'size' => CRM_Utils_Type::TWELVE,
 124           'html' => array(
 125             'type' => 'Select',
 126           ) ,
 127           'pseudoconstant' => array(
 128             'table' => 'civicrm_contact_type',
 129             'keyColumn' => 'name',
 130             'labelColumn' => 'label',
 131             'condition' => 'parent_id IS NULL',
 132           )
 133         ) ,
 134         'threshold' => array(
 135           'name' => 'threshold',
 136           'type' => CRM_Utils_Type::T_INT,
 137           'title' => ts('Threshold') ,
 138           'description' => 'The weight threshold the sum of the rule weights has to cross to consider two contacts the same',
 139           'required' => true,
 140           'html' => array(
 141             'type' => 'Text',
 142           ) ,
 143         ) ,
 144         'used' => array(
 145           'name' => 'used',
 146           'type' => CRM_Utils_Type::T_STRING,
 147           'title' => ts('Length') ,
 148           'description' => 'Whether the rule should be used for cases where usage is Unsupervised, Supervised OR General(programatically)',
 149           'required' => true,
 150           'maxlength' => 12,
 151           'size' => CRM_Utils_Type::TWELVE,
 152           'html' => array(
 153             'type' => 'Radio',
 154           ) ,
 155           'pseudoconstant' => array(
 156             'callback' => 'CRM_Core_SelectValues::getDedupeRuleTypes',
 157           )
 158         ) ,
 159         'name' => array(
 160           'name' => 'name',
 161           'type' => CRM_Utils_Type::T_STRING,
 162           'title' => ts('Name') ,
 163           'description' => 'Name of the rule group',
 164           'maxlength' => 64,
 165           'size' => CRM_Utils_Type::BIG,
 166         ) ,
 167         'title' => array(
 168           'name' => 'title',
 169           'type' => CRM_Utils_Type::T_STRING,
 170           'title' => ts('Title') ,
 171           'description' => 'Label of the rule group',
 172           'maxlength' => 255,
 173           'size' => CRM_Utils_Type::HUGE,
 174           'html' => array(
 175             'type' => 'Text',
 176           ) ,
 177         ) ,
 178         'is_reserved' => array(
 179           'name' => 'is_reserved',
 180           'type' => CRM_Utils_Type::T_BOOLEAN,
 181           'title' => ts('Reserved?') ,
 182           'description' => 'Is this a reserved rule - a rule group that has been optimized and cannot be changed by the admin',
 183           'html' => array(
 184             'type' => 'CheckBox',
 185           ) ,
 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__, 'dedupe_rule_group', $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__, 'dedupe_rule_group', $prefix, array());
 240     return $r;
 241   }
 242 }