CRM/Contribute/DAO/ContributionSoft.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC (c) 2004-2019
   6  *
   7  * Generated from xml/schema/CRM/Contribute/ContributionSoft.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:b9a4bdee130cdaf934a53e456cd0e3e8)
  10  */
  11
  12 /**
  13  * Database access object for the ContributionSoft entity.
  14  */
  15 class CRM_Contribute_DAO_ContributionSoft extends CRM_Core_DAO {
  16
  17   /**
  18    * Static instance to hold the table name.
  19    *
  20    * @var string
  21    */
  22   public static $_tableName = 'civicrm_contribution_soft';
  23
  24   /**
  25    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  26    *
  27    * @var bool
  28    */
  29   public static $_log = TRUE;
  30
  31   /**
  32    * Soft Contribution ID
  33    *
  34    * @var int unsigned
  35    */
  36   public $id;
  37
  38   /**
  39    * FK to contribution table.
  40    *
  41    * @var int unsigned
  42    */
  43   public $contribution_id;
  44
  45   /**
  46    * FK to Contact ID
  47    *
  48    * @var int unsigned
  49    */
  50   public $contact_id;
  51
  52   /**
  53    * Amount of this soft contribution.
  54    *
  55    * @var float
  56    */
  57   public $amount;
  58
  59   /**
  60    * 3 character string, value from config setting or input via user.
  61    *
  62    * @var string
  63    */
  64   public $currency;
  65
  66   /**
  67    * FK to civicrm_pcp.id
  68    *
  69    * @var int unsigned
  70    */
  71   public $pcp_id;
  72
  73   /**
  74    * @var boolean
  75    */
  76   public $pcp_display_in_roll;
  77
  78   /**
  79    * @var string
  80    */
  81   public $pcp_roll_nickname;
  82
  83   /**
  84    * @var string
  85    */
  86   public $pcp_personal_note;
  87
  88   /**
  89    * Soft Credit Type ID.Implicit FK to civicrm_option_value where option_group = soft_credit_type.
  90    *
  91    * @var int unsigned
  92    */
  93   public $soft_credit_type_id;
  94
  95   /**
  96    * Class constructor.
  97    */
  98   public function __construct() {
  99     $this->__table = 'civicrm_contribution_soft';
 100     parent::__construct();
 101   }
 102
 103   /**
 104    * Returns foreign keys and entity references.
 105    *
 106    * @return array
 107    *   [CRM_Core_Reference_Interface]
 108    */
 109   public static function getReferenceColumns() {
 110     if (!isset(Civi::$statics[__CLASS__]['links'])) {
 111       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
 112       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contribution_id', 'civicrm_contribution', 'id');
 113       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contact_id', 'civicrm_contact', 'id');
 114       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'pcp_id', 'civicrm_pcp', 'id');
 115       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 116     }
 117     return Civi::$statics[__CLASS__]['links'];
 118   }
 119
 120   /**
 121    * Returns all the column names of this table
 122    *
 123    * @return array
 124    */
 125   public static function &fields() {
 126     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 127       Civi::$statics[__CLASS__]['fields'] = [
 128         'contribution_soft_id' => [
 129           'name' => 'id',
 130           'type' => CRM_Utils_Type::T_INT,
 131           'title' => ts('Soft Contribution ID'),
 132           'description' => ts('Soft Contribution ID'),
 133           'required' => TRUE,
 134           'import' => TRUE,
 135           'where' => 'civicrm_contribution_soft.id',
 136           'export' => TRUE,
 137           'table_name' => 'civicrm_contribution_soft',
 138           'entity' => 'ContributionSoft',
 139           'bao' => 'CRM_Contribute_BAO_ContributionSoft',
 140           'localizable' => 0,
 141         ],
 142         'contribution_id' => [
 143           'name' => 'contribution_id',
 144           'type' => CRM_Utils_Type::T_INT,
 145           'title' => ts('Soft Contribution - Contribution'),
 146           'description' => ts('FK to contribution table.'),
 147           'required' => TRUE,
 148           'where' => 'civicrm_contribution_soft.contribution_id',
 149           'table_name' => 'civicrm_contribution_soft',
 150           'entity' => 'ContributionSoft',
 151           'bao' => 'CRM_Contribute_BAO_ContributionSoft',
 152           'localizable' => 0,
 153           'FKClassName' => 'CRM_Contribute_DAO_Contribution',
 154         ],
 155         'contribution_soft_contact_id' => [
 156           'name' => 'contact_id',
 157           'type' => CRM_Utils_Type::T_INT,
 158           'title' => ts('Contact ID'),
 159           'description' => ts('FK to Contact ID'),
 160           'required' => TRUE,
 161           'import' => TRUE,
 162           'where' => 'civicrm_contribution_soft.contact_id',
 163           'headerPattern' => '/contact(.?id)?/i',
 164           'dataPattern' => '/^\d+$/',
 165           'export' => TRUE,
 166           'table_name' => 'civicrm_contribution_soft',
 167           'entity' => 'ContributionSoft',
 168           'bao' => 'CRM_Contribute_BAO_ContributionSoft',
 169           'localizable' => 0,
 170           'FKClassName' => 'CRM_Contact_DAO_Contact',
 171         ],
 172         'amount' => [
 173           'name' => 'amount',
 174           'type' => CRM_Utils_Type::T_MONEY,
 175           'title' => ts('Soft Contribution Amount'),
 176           'description' => ts('Amount of this soft contribution.'),
 177           'required' => TRUE,
 178           'precision' => [
 179             20,
 180             2
 181           ],
 182           'import' => TRUE,
 183           'where' => 'civicrm_contribution_soft.amount',
 184           'headerPattern' => '/total(.?am(ou)?nt)?/i',
 185           'dataPattern' => '/^\d+(\.\d{2})?$/',
 186           'export' => TRUE,
 187           'table_name' => 'civicrm_contribution_soft',
 188           'entity' => 'ContributionSoft',
 189           'bao' => 'CRM_Contribute_BAO_ContributionSoft',
 190           'localizable' => 0,
 191         ],
 192         'currency' => [
 193           'name' => 'currency',
 194           'type' => CRM_Utils_Type::T_STRING,
 195           'title' => ts('Soft Contribution Currency'),
 196           'description' => ts('3 character string, value from config setting or input via user.'),
 197           'maxlength' => 3,
 198           'size' => CRM_Utils_Type::FOUR,
 199           'where' => 'civicrm_contribution_soft.currency',
 200           'default' => 'NULL',
 201           'table_name' => 'civicrm_contribution_soft',
 202           'entity' => 'ContributionSoft',
 203           'bao' => 'CRM_Contribute_BAO_ContributionSoft',
 204           'localizable' => 0,
 205           'html' => [
 206             'type' => 'Select',
 207           ],
 208           'pseudoconstant' => [
 209             'table' => 'civicrm_currency',
 210             'keyColumn' => 'name',
 211             'labelColumn' => 'full_name',
 212             'nameColumn' => 'name',
 213           ]
 214         ],
 215         'pcp_id' => [
 216           'name' => 'pcp_id',
 217           'type' => CRM_Utils_Type::T_INT,
 218           'title' => ts('Soft Contribution PCP'),
 219           'description' => ts('FK to civicrm_pcp.id'),
 220           'where' => 'civicrm_contribution_soft.pcp_id',
 221           'default' => 'NULL',
 222           'table_name' => 'civicrm_contribution_soft',
 223           'entity' => 'ContributionSoft',
 224           'bao' => 'CRM_Contribute_BAO_ContributionSoft',
 225           'localizable' => 0,
 226           'FKClassName' => 'CRM_PCP_DAO_PCP',
 227           'pseudoconstant' => [
 228             'table' => 'civicrm_pcp',
 229             'keyColumn' => 'id',
 230             'labelColumn' => 'title',
 231           ]
 232         ],
 233         'pcp_display_in_roll' => [
 234           'name' => 'pcp_display_in_roll',
 235           'type' => CRM_Utils_Type::T_BOOLEAN,
 236           'title' => ts('Soft Contribution Display on PCP'),
 237           'where' => 'civicrm_contribution_soft.pcp_display_in_roll',
 238           'default' => '0',
 239           'table_name' => 'civicrm_contribution_soft',
 240           'entity' => 'ContributionSoft',
 241           'bao' => 'CRM_Contribute_BAO_ContributionSoft',
 242           'localizable' => 0,
 243         ],
 244         'pcp_roll_nickname' => [
 245           'name' => 'pcp_roll_nickname',
 246           'type' => CRM_Utils_Type::T_STRING,
 247           'title' => ts('Soft Contribution PCP Nickname'),
 248           'maxlength' => 255,
 249           'size' => CRM_Utils_Type::HUGE,
 250           'where' => 'civicrm_contribution_soft.pcp_roll_nickname',
 251           'default' => 'NULL',
 252           'table_name' => 'civicrm_contribution_soft',
 253           'entity' => 'ContributionSoft',
 254           'bao' => 'CRM_Contribute_BAO_ContributionSoft',
 255           'localizable' => 0,
 256         ],
 257         'pcp_personal_note' => [
 258           'name' => 'pcp_personal_note',
 259           'type' => CRM_Utils_Type::T_STRING,
 260           'title' => ts('Soft Contribution PCP Note'),
 261           'maxlength' => 255,
 262           'size' => CRM_Utils_Type::HUGE,
 263           'where' => 'civicrm_contribution_soft.pcp_personal_note',
 264           'default' => 'NULL',
 265           'table_name' => 'civicrm_contribution_soft',
 266           'entity' => 'ContributionSoft',
 267           'bao' => 'CRM_Contribute_BAO_ContributionSoft',
 268           'localizable' => 0,
 269           'html' => [
 270             'type' => 'TextArea',
 271           ],
 272         ],
 273         'soft_credit_type_id' => [
 274           'name' => 'soft_credit_type_id',
 275           'type' => CRM_Utils_Type::T_INT,
 276           'title' => ts('Soft Credit Type'),
 277           'description' => ts('Soft Credit Type ID.Implicit FK to civicrm_option_value where option_group = soft_credit_type.'),
 278           'where' => 'civicrm_contribution_soft.soft_credit_type_id',
 279           'default' => 'NULL',
 280           'table_name' => 'civicrm_contribution_soft',
 281           'entity' => 'ContributionSoft',
 282           'bao' => 'CRM_Contribute_BAO_ContributionSoft',
 283           'localizable' => 0,
 284           'pseudoconstant' => [
 285             'optionGroupName' => 'soft_credit_type',
 286             'optionEditPath' => 'civicrm/admin/options/soft_credit_type',
 287           ]
 288         ],
 289       ];
 290       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 291     }
 292     return Civi::$statics[__CLASS__]['fields'];
 293   }
 294
 295   /**
 296    * Return a mapping from field-name to the corresponding key (as used in fields()).
 297    *
 298    * @return array
 299    *   Array(string $name => string $uniqueName).
 300    */
 301   public static function &fieldKeys() {
 302     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 303       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 304     }
 305     return Civi::$statics[__CLASS__]['fieldKeys'];
 306   }
 307
 308   /**
 309    * Returns the names of this table
 310    *
 311    * @return string
 312    */
 313   public static function getTableName() {
 314     return self::$_tableName;
 315   }
 316
 317   /**
 318    * Returns if this table needs to be logged
 319    *
 320    * @return bool
 321    */
 322   public function getLog() {
 323     return self::$_log;
 324   }
 325
 326   /**
 327    * Returns the list of fields that can be imported
 328    *
 329    * @param bool $prefix
 330    *
 331    * @return array
 332    */
 333   public static function &import($prefix = FALSE) {
 334     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'contribution_soft', $prefix, []);
 335     return $r;
 336   }
 337
 338   /**
 339    * Returns the list of fields that can be exported
 340    *
 341    * @param bool $prefix
 342    *
 343    * @return array
 344    */
 345   public static function &export($prefix = FALSE) {
 346     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'contribution_soft', $prefix, []);
 347     return $r;
 348   }
 349
 350   /**
 351    * Returns the list of indices
 352    *
 353    * @param bool $localize
 354    *
 355    * @return array
 356    */
 357   public static function indices($localize = TRUE) {
 358     $indices = [
 359       'index_id' => [
 360         'name' => 'index_id',
 361         'field' => [
 362           0 => 'pcp_id',
 363         ],
 364         'localizable' => FALSE,
 365         'sig' => 'civicrm_contribution_soft::0::pcp_id',
 366       ],
 367     ];
 368     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 369   }
 370
 371 }