CRM/Contribute/DAO/Premium.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC (c) 2004-2018
   6  *
   7  * Generated from xml/schema/CRM/Contribute/Premium.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:86a5118380bd35cee851da735f699ac2)
  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' => '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' => 'Is the Premiums feature enabled for this page?',
 171           'required' => TRUE,
 172           'table_name' => 'civicrm_premiums',
 173           'entity' => 'Premium',
 174           'bao' => 'CRM_Contribute_BAO_Premium',
 175           'localizable' => 0,
 176         ],
 177         'premiums_intro_title' => [
 178           'name' => 'premiums_intro_title',
 179           'type' => CRM_Utils_Type::T_STRING,
 180           'title' => ts('Title for Premiums section'),
 181           'description' => 'Title for Premiums section.',
 182           'maxlength' => 255,
 183           'size' => CRM_Utils_Type::HUGE,
 184           'table_name' => 'civicrm_premiums',
 185           'entity' => 'Premium',
 186           'bao' => 'CRM_Contribute_BAO_Premium',
 187           'localizable' => 1,
 188         ],
 189         'premiums_intro_text' => [
 190           'name' => 'premiums_intro_text',
 191           'type' => CRM_Utils_Type::T_TEXT,
 192           'title' => ts('Premium Introductory Text'),
 193           'description' => 'Displayed in <div> at top of Premiums section of page. Text and HTML allowed.',
 194           'table_name' => 'civicrm_premiums',
 195           'entity' => 'Premium',
 196           'bao' => 'CRM_Contribute_BAO_Premium',
 197           'localizable' => 1,
 198         ],
 199         'premiums_contact_email' => [
 200           'name' => 'premiums_contact_email',
 201           'type' => CRM_Utils_Type::T_STRING,
 202           'title' => ts('Premium Contact Email'),
 203           'description' => 'This email address is included in receipts if it is populated and a premium has been selected.',
 204           'maxlength' => 100,
 205           'size' => CRM_Utils_Type::HUGE,
 206           'table_name' => 'civicrm_premiums',
 207           'entity' => 'Premium',
 208           'bao' => 'CRM_Contribute_BAO_Premium',
 209           'localizable' => 0,
 210         ],
 211         'premiums_contact_phone' => [
 212           'name' => 'premiums_contact_phone',
 213           'type' => CRM_Utils_Type::T_STRING,
 214           'title' => ts('Premiums Contact Phone'),
 215           'description' => 'This phone number is included in receipts if it is populated and a premium has been selected.',
 216           'maxlength' => 50,
 217           'size' => CRM_Utils_Type::BIG,
 218           'table_name' => 'civicrm_premiums',
 219           'entity' => 'Premium',
 220           'bao' => 'CRM_Contribute_BAO_Premium',
 221           'localizable' => 0,
 222         ],
 223         'premiums_display_min_contribution' => [
 224           'name' => 'premiums_display_min_contribution',
 225           'type' => CRM_Utils_Type::T_BOOLEAN,
 226           'title' => ts('Display Minimum Contribution?'),
 227           'description' => 'Boolean. Should we automatically display minimum contribution amount text after the premium descriptions.',
 228           'required' => TRUE,
 229           'table_name' => 'civicrm_premiums',
 230           'entity' => 'Premium',
 231           'bao' => 'CRM_Contribute_BAO_Premium',
 232           'localizable' => 0,
 233         ],
 234         'premiums_nothankyou_label' => [
 235           'name' => 'premiums_nothankyou_label',
 236           'type' => CRM_Utils_Type::T_STRING,
 237           'title' => ts('No Thank-you Text'),
 238           'description' => 'Label displayed for No Thank-you option in premiums block (e.g. No thank you)',
 239           'maxlength' => 255,
 240           'size' => CRM_Utils_Type::HUGE,
 241           'table_name' => 'civicrm_premiums',
 242           'entity' => 'Premium',
 243           'bao' => 'CRM_Contribute_BAO_Premium',
 244           'localizable' => 1,
 245         ],
 246         'premiums_nothankyou_position' => [
 247           'name' => 'premiums_nothankyou_position',
 248           'type' => CRM_Utils_Type::T_INT,
 249           'title' => ts('No Thank-you Position'),
 250           'default' => '1',
 251           'table_name' => 'civicrm_premiums',
 252           'entity' => 'Premium',
 253           'bao' => 'CRM_Contribute_BAO_Premium',
 254           'localizable' => 0,
 255         ],
 256       ];
 257       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 258     }
 259     return Civi::$statics[__CLASS__]['fields'];
 260   }
 261
 262   /**
 263    * Return a mapping from field-name to the corresponding key (as used in fields()).
 264    *
 265    * @return array
 266    *   Array(string $name => string $uniqueName).
 267    */
 268   public static function &fieldKeys() {
 269     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 270       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 271     }
 272     return Civi::$statics[__CLASS__]['fieldKeys'];
 273   }
 274
 275   /**
 276    * Returns the names of this table
 277    *
 278    * @return string
 279    */
 280   public static function getTableName() {
 281     return CRM_Core_DAO::getLocaleTableName(self::$_tableName);
 282   }
 283
 284   /**
 285    * Returns if this table needs to be logged
 286    *
 287    * @return bool
 288    */
 289   public function getLog() {
 290     return self::$_log;
 291   }
 292
 293   /**
 294    * Returns the list of fields that can be imported
 295    *
 296    * @param bool $prefix
 297    *
 298    * @return array
 299    */
 300   public static function &import($prefix = FALSE) {
 301     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'premiums', $prefix, []);
 302     return $r;
 303   }
 304
 305   /**
 306    * Returns the list of fields that can be exported
 307    *
 308    * @param bool $prefix
 309    *
 310    * @return array
 311    */
 312   public static function &export($prefix = FALSE) {
 313     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'premiums', $prefix, []);
 314     return $r;
 315   }
 316
 317   /**
 318    * Returns the list of indices
 319    *
 320    * @param bool $localize
 321    *
 322    * @return array
 323    */
 324   public static function indices($localize = TRUE) {
 325     $indices = [];
 326     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 327   }
 328
 329 }