CRM/Contribute/DAO/Premium.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC (c) 2004-2019
   6  *
   7  * Generated from xml/schema/CRM/Contribute/Premium.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:58eb4aacd3084c54c8c6847bdc7c0b0e)
  10  */
  11
  12 /**
  13  * Database access object for the Premium entity.
  14  */
  15 class CRM_Contribute_DAO_Premium extends CRM_Core_DAO {
  16
  17   /**
  18    * Static instance to hold the table name.
  19    *
  20    * @var string
  21    */
  22   public static $_tableName = 'civicrm_premiums';
  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    * @var int
  33    */
  34   public $id;
  35
  36   /**
  37    * Joins these premium settings to another object. Always civicrm_contribution_page for now.
  38    *
  39    * @var string
  40    */
  41   public $entity_table;
  42
  43   /**
  44    * @var int
  45    */
  46   public $entity_id;
  47
  48   /**
  49    * Is the Premiums feature enabled for this page?
  50    *
  51    * @var bool
  52    */
  53   public $premiums_active;
  54
  55   /**
  56    * Title for Premiums section.
  57    *
  58    * @var string
  59    */
  60   public $premiums_intro_title;
  61
  62   /**
  63    * Displayed in <div> at top of Premiums section of page. Text and HTML allowed.
  64    *
  65    * @var text
  66    */
  67   public $premiums_intro_text;
  68
  69   /**
  70    * This email address is included in receipts if it is populated and a premium has been selected.
  71    *
  72    * @var string
  73    */
  74   public $premiums_contact_email;
  75
  76   /**
  77    * This phone number is included in receipts if it is populated and a premium has been selected.
  78    *
  79    * @var string
  80    */
  81   public $premiums_contact_phone;
  82
  83   /**
  84    * Boolean. Should we automatically display minimum contribution amount text after the premium descriptions.
  85    *
  86    * @var bool
  87    */
  88   public $premiums_display_min_contribution;
  89
  90   /**
  91    * Label displayed for No Thank-you option in premiums block (e.g. No thank you)
  92    *
  93    * @var string
  94    */
  95   public $premiums_nothankyou_label;
  96
  97   /**
  98    * @var int
  99    */
 100   public $premiums_nothankyou_position;
 101
 102   /**
 103    * Class constructor.
 104    */
 105   public function __construct() {
 106     $this->__table = 'civicrm_premiums';
 107     parent::__construct();
 108   }
 109
 110   /**
 111    * Returns foreign keys and entity references.
 112    *
 113    * @return array
 114    *   [CRM_Core_Reference_Interface]
 115    */
 116   public static function getReferenceColumns() {
 117     if (!isset(Civi::$statics[__CLASS__]['links'])) {
 118       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
 119       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName(), 'entity_id', NULL, 'id', 'entity_table');
 120       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 121     }
 122     return Civi::$statics[__CLASS__]['links'];
 123   }
 124
 125   /**
 126    * Returns all the column names of this table
 127    *
 128    * @return array
 129    */
 130   public static function &fields() {
 131     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 132       Civi::$statics[__CLASS__]['fields'] = [
 133         'id' => [
 134           'name' => 'id',
 135           'type' => CRM_Utils_Type::T_INT,
 136           'title' => ts('Premium ID'),
 137           'required' => TRUE,
 138           'where' => 'civicrm_premiums.id',
 139           'table_name' => 'civicrm_premiums',
 140           'entity' => 'Premium',
 141           'bao' => 'CRM_Contribute_BAO_Premium',
 142           'localizable' => 0,
 143         ],
 144         'entity_table' => [
 145           'name' => 'entity_table',
 146           'type' => CRM_Utils_Type::T_STRING,
 147           'title' => ts('Premium Entity'),
 148           'description' => ts('Joins these premium settings to another object. Always civicrm_contribution_page for now.'),
 149           'required' => TRUE,
 150           'maxlength' => 64,
 151           'size' => CRM_Utils_Type::BIG,
 152           'where' => 'civicrm_premiums.entity_table',
 153           'table_name' => 'civicrm_premiums',
 154           'entity' => 'Premium',
 155           'bao' => 'CRM_Contribute_BAO_Premium',
 156           'localizable' => 0,
 157         ],
 158         'entity_id' => [
 159           'name' => 'entity_id',
 160           'type' => CRM_Utils_Type::T_INT,
 161           'title' => ts('Premium entity ID'),
 162           'required' => TRUE,
 163           'where' => 'civicrm_premiums.entity_id',
 164           'table_name' => 'civicrm_premiums',
 165           'entity' => 'Premium',
 166           'bao' => 'CRM_Contribute_BAO_Premium',
 167           'localizable' => 0,
 168         ],
 169         'premiums_active' => [
 170           'name' => 'premiums_active',
 171           'type' => CRM_Utils_Type::T_BOOLEAN,
 172           'title' => ts('Is Premium Active?'),
 173           'description' => ts('Is the Premiums feature enabled for this page?'),
 174           'required' => TRUE,
 175           'where' => 'civicrm_premiums.premiums_active',
 176           'default' => '0',
 177           'table_name' => 'civicrm_premiums',
 178           'entity' => 'Premium',
 179           'bao' => 'CRM_Contribute_BAO_Premium',
 180           'localizable' => 0,
 181         ],
 182         'premiums_intro_title' => [
 183           'name' => 'premiums_intro_title',
 184           'type' => CRM_Utils_Type::T_STRING,
 185           'title' => ts('Title for Premiums section'),
 186           'description' => ts('Title for Premiums section.'),
 187           'maxlength' => 255,
 188           'size' => CRM_Utils_Type::HUGE,
 189           'where' => 'civicrm_premiums.premiums_intro_title',
 190           'table_name' => 'civicrm_premiums',
 191           'entity' => 'Premium',
 192           'bao' => 'CRM_Contribute_BAO_Premium',
 193           'localizable' => 1,
 194         ],
 195         'premiums_intro_text' => [
 196           'name' => 'premiums_intro_text',
 197           'type' => CRM_Utils_Type::T_TEXT,
 198           'title' => ts('Premium Introductory Text'),
 199           'description' => ts('Displayed in <div> at top of Premiums section of page. Text and HTML allowed.'),
 200           'where' => 'civicrm_premiums.premiums_intro_text',
 201           'table_name' => 'civicrm_premiums',
 202           'entity' => 'Premium',
 203           'bao' => 'CRM_Contribute_BAO_Premium',
 204           'localizable' => 1,
 205         ],
 206         'premiums_contact_email' => [
 207           'name' => 'premiums_contact_email',
 208           'type' => CRM_Utils_Type::T_STRING,
 209           'title' => ts('Premium Contact Email'),
 210           'description' => ts('This email address is included in receipts if it is populated and a premium has been selected.'),
 211           'maxlength' => 100,
 212           'size' => CRM_Utils_Type::HUGE,
 213           'where' => 'civicrm_premiums.premiums_contact_email',
 214           'table_name' => 'civicrm_premiums',
 215           'entity' => 'Premium',
 216           'bao' => 'CRM_Contribute_BAO_Premium',
 217           'localizable' => 0,
 218         ],
 219         'premiums_contact_phone' => [
 220           'name' => 'premiums_contact_phone',
 221           'type' => CRM_Utils_Type::T_STRING,
 222           'title' => ts('Premiums Contact Phone'),
 223           'description' => ts('This phone number is included in receipts if it is populated and a premium has been selected.'),
 224           'maxlength' => 50,
 225           'size' => CRM_Utils_Type::BIG,
 226           'where' => 'civicrm_premiums.premiums_contact_phone',
 227           'table_name' => 'civicrm_premiums',
 228           'entity' => 'Premium',
 229           'bao' => 'CRM_Contribute_BAO_Premium',
 230           'localizable' => 0,
 231         ],
 232         'premiums_display_min_contribution' => [
 233           'name' => 'premiums_display_min_contribution',
 234           'type' => CRM_Utils_Type::T_BOOLEAN,
 235           'title' => ts('Display Minimum Contribution?'),
 236           'description' => ts('Boolean. Should we automatically display minimum contribution amount text after the premium descriptions.'),
 237           'required' => TRUE,
 238           'where' => 'civicrm_premiums.premiums_display_min_contribution',
 239           'table_name' => 'civicrm_premiums',
 240           'entity' => 'Premium',
 241           'bao' => 'CRM_Contribute_BAO_Premium',
 242           'localizable' => 0,
 243         ],
 244         'premiums_nothankyou_label' => [
 245           'name' => 'premiums_nothankyou_label',
 246           'type' => CRM_Utils_Type::T_STRING,
 247           'title' => ts('No Thank-you Text'),
 248           'description' => ts('Label displayed for No Thank-you option in premiums block (e.g. No thank you)'),
 249           'maxlength' => 255,
 250           'size' => CRM_Utils_Type::HUGE,
 251           'where' => 'civicrm_premiums.premiums_nothankyou_label',
 252           'table_name' => 'civicrm_premiums',
 253           'entity' => 'Premium',
 254           'bao' => 'CRM_Contribute_BAO_Premium',
 255           'localizable' => 1,
 256         ],
 257         'premiums_nothankyou_position' => [
 258           'name' => 'premiums_nothankyou_position',
 259           'type' => CRM_Utils_Type::T_INT,
 260           'title' => ts('No Thank-you Position'),
 261           'where' => 'civicrm_premiums.premiums_nothankyou_position',
 262           'default' => '1',
 263           'table_name' => 'civicrm_premiums',
 264           'entity' => 'Premium',
 265           'bao' => 'CRM_Contribute_BAO_Premium',
 266           'localizable' => 0,
 267         ],
 268       ];
 269       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 270     }
 271     return Civi::$statics[__CLASS__]['fields'];
 272   }
 273
 274   /**
 275    * Return a mapping from field-name to the corresponding key (as used in fields()).
 276    *
 277    * @return array
 278    *   Array(string $name => string $uniqueName).
 279    */
 280   public static function &fieldKeys() {
 281     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 282       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 283     }
 284     return Civi::$statics[__CLASS__]['fieldKeys'];
 285   }
 286
 287   /**
 288    * Returns the names of this table
 289    *
 290    * @return string
 291    */
 292   public static function getTableName() {
 293     return CRM_Core_DAO::getLocaleTableName(self::$_tableName);
 294   }
 295
 296   /**
 297    * Returns if this table needs to be logged
 298    *
 299    * @return bool
 300    */
 301   public function getLog() {
 302     return self::$_log;
 303   }
 304
 305   /**
 306    * Returns the list of fields that can be imported
 307    *
 308    * @param bool $prefix
 309    *
 310    * @return array
 311    */
 312   public static function &import($prefix = FALSE) {
 313     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'premiums', $prefix, []);
 314     return $r;
 315   }
 316
 317   /**
 318    * Returns the list of fields that can be exported
 319    *
 320    * @param bool $prefix
 321    *
 322    * @return array
 323    */
 324   public static function &export($prefix = FALSE) {
 325     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'premiums', $prefix, []);
 326     return $r;
 327   }
 328
 329   /**
 330    * Returns the list of indices
 331    *
 332    * @param bool $localize
 333    *
 334    * @return array
 335    */
 336   public static function indices($localize = TRUE) {
 337     $indices = [];
 338     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 339   }
 340
 341 }