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:09b04d3dd373d7dc64bc873b56b5e171)
  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   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   static $_log = TRUE;
  30
  31   /**
  32    * @var int unsigned
  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 unsigned
  45    */
  46   public $entity_id;
  47
  48   /**
  49    * Is the Premiums feature enabled for this page?
  50    *
  51    * @var boolean
  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 boolean
  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 unsigned
  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           'table_name' => 'civicrm_premiums',
 139           'entity' => 'Premium',
 140           'bao' => 'CRM_Contribute_BAO_Premium',
 141           'localizable' => 0,
 142         ],
 143         'entity_table' => [
 144           'name' => 'entity_table',
 145           'type' => CRM_Utils_Type::T_STRING,
 146           'title' => ts('Premium Entity'),
 147           'description' => ts('Joins these premium settings to another object. Always civicrm_contribution_page for now.'),
 148           'required' => TRUE,
 149           'maxlength' => 64,
 150           'size' => CRM_Utils_Type::BIG,
 151           'table_name' => 'civicrm_premiums',
 152           'entity' => 'Premium',
 153           'bao' => 'CRM_Contribute_BAO_Premium',
 154           'localizable' => 0,
 155         ],
 156         'entity_id' => [
 157           'name' => 'entity_id',
 158           'type' => CRM_Utils_Type::T_INT,
 159           'title' => ts('Premium entity ID'),
 160           'required' => TRUE,
 161           'table_name' => 'civicrm_premiums',
 162           'entity' => 'Premium',
 163           'bao' => 'CRM_Contribute_BAO_Premium',
 164           'localizable' => 0,
 165         ],
 166         'premiums_active' => [
 167           'name' => 'premiums_active',
 168           'type' => CRM_Utils_Type::T_BOOLEAN,
 169           'title' => ts('Is Premium Active?'),
 170           'description' => ts('Is the Premiums feature enabled for this page?'),
 171           'required' => TRUE,
 172           'default' => '0',
 173           'table_name' => 'civicrm_premiums',
 174           'entity' => 'Premium',
 175           'bao' => 'CRM_Contribute_BAO_Premium',
 176           'localizable' => 0,
 177         ],
 178         'premiums_intro_title' => [
 179           'name' => 'premiums_intro_title',
 180           'type' => CRM_Utils_Type::T_STRING,
 181           'title' => ts('Title for Premiums section'),
 182           'description' => ts('Title for Premiums section.'),
 183           'maxlength' => 255,
 184           'size' => CRM_Utils_Type::HUGE,
 185           'table_name' => 'civicrm_premiums',
 186           'entity' => 'Premium',
 187           'bao' => 'CRM_Contribute_BAO_Premium',
 188           'localizable' => 1,
 189         ],
 190         'premiums_intro_text' => [
 191           'name' => 'premiums_intro_text',
 192           'type' => CRM_Utils_Type::T_TEXT,
 193           'title' => ts('Premium Introductory Text'),
 194           'description' => ts('Displayed in <div> at top of Premiums section of page. Text and HTML allowed.'),
 195           'table_name' => 'civicrm_premiums',
 196           'entity' => 'Premium',
 197           'bao' => 'CRM_Contribute_BAO_Premium',
 198           'localizable' => 1,
 199         ],
 200         'premiums_contact_email' => [
 201           'name' => 'premiums_contact_email',
 202           'type' => CRM_Utils_Type::T_STRING,
 203           'title' => ts('Premium Contact Email'),
 204           'description' => ts('This email address is included in receipts if it is populated and a premium has been selected.'),
 205           'maxlength' => 100,
 206           'size' => CRM_Utils_Type::HUGE,
 207           'table_name' => 'civicrm_premiums',
 208           'entity' => 'Premium',
 209           'bao' => 'CRM_Contribute_BAO_Premium',
 210           'localizable' => 0,
 211         ],
 212         'premiums_contact_phone' => [
 213           'name' => 'premiums_contact_phone',
 214           'type' => CRM_Utils_Type::T_STRING,
 215           'title' => ts('Premiums Contact Phone'),
 216           'description' => ts('This phone number is included in receipts if it is populated and a premium has been selected.'),
 217           'maxlength' => 50,
 218           'size' => CRM_Utils_Type::BIG,
 219           'table_name' => 'civicrm_premiums',
 220           'entity' => 'Premium',
 221           'bao' => 'CRM_Contribute_BAO_Premium',
 222           'localizable' => 0,
 223         ],
 224         'premiums_display_min_contribution' => [
 225           'name' => 'premiums_display_min_contribution',
 226           'type' => CRM_Utils_Type::T_BOOLEAN,
 227           'title' => ts('Display Minimum Contribution?'),
 228           'description' => ts('Boolean. Should we automatically display minimum contribution amount text after the premium descriptions.'),
 229           'required' => TRUE,
 230           'table_name' => 'civicrm_premiums',
 231           'entity' => 'Premium',
 232           'bao' => 'CRM_Contribute_BAO_Premium',
 233           'localizable' => 0,
 234         ],
 235         'premiums_nothankyou_label' => [
 236           'name' => 'premiums_nothankyou_label',
 237           'type' => CRM_Utils_Type::T_STRING,
 238           'title' => ts('No Thank-you Text'),
 239           'description' => ts('Label displayed for No Thank-you option in premiums block (e.g. No thank you)'),
 240           'maxlength' => 255,
 241           'size' => CRM_Utils_Type::HUGE,
 242           'table_name' => 'civicrm_premiums',
 243           'entity' => 'Premium',
 244           'bao' => 'CRM_Contribute_BAO_Premium',
 245           'localizable' => 1,
 246         ],
 247         'premiums_nothankyou_position' => [
 248           'name' => 'premiums_nothankyou_position',
 249           'type' => CRM_Utils_Type::T_INT,
 250           'title' => ts('No Thank-you Position'),
 251           'default' => '1',
 252           'table_name' => 'civicrm_premiums',
 253           'entity' => 'Premium',
 254           'bao' => 'CRM_Contribute_BAO_Premium',
 255           'localizable' => 0,
 256         ],
 257       ];
 258       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 259     }
 260     return Civi::$statics[__CLASS__]['fields'];
 261   }
 262
 263   /**
 264    * Return a mapping from field-name to the corresponding key (as used in fields()).
 265    *
 266    * @return array
 267    *   Array(string $name => string $uniqueName).
 268    */
 269   public static function &fieldKeys() {
 270     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 271       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 272     }
 273     return Civi::$statics[__CLASS__]['fieldKeys'];
 274   }
 275
 276   /**
 277    * Returns the names of this table
 278    *
 279    * @return string
 280    */
 281   public static function getTableName() {
 282     return CRM_Core_DAO::getLocaleTableName(self::$_tableName);
 283   }
 284
 285   /**
 286    * Returns if this table needs to be logged
 287    *
 288    * @return bool
 289    */
 290   public function getLog() {
 291     return self::$_log;
 292   }
 293
 294   /**
 295    * Returns the list of fields that can be imported
 296    *
 297    * @param bool $prefix
 298    *
 299    * @return array
 300    */
 301   public static function &import($prefix = FALSE) {
 302     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'premiums', $prefix, []);
 303     return $r;
 304   }
 305
 306   /**
 307    * Returns the list of fields that can be exported
 308    *
 309    * @param bool $prefix
 310    *
 311    * @return array
 312    */
 313   public static function &export($prefix = FALSE) {
 314     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'premiums', $prefix, []);
 315     return $r;
 316   }
 317
 318   /**
 319    * Returns the list of indices
 320    *
 321    * @param bool $localize
 322    *
 323    * @return array
 324    */
 325   public static function indices($localize = TRUE) {
 326     $indices = [];
 327     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 328   }
 329
 330 }