CRM/Contribute/DAO/PremiumsProduct.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC (c) 2004-2019
   6  *
   7  * Generated from xml/schema/CRM/Contribute/PremiumsProduct.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:1e7a968a1d7448211b025026d2c716d3)
  10  */
  11
  12 /**
  13  * Database access object for the PremiumsProduct entity.
  14  */
  15 class CRM_Contribute_DAO_PremiumsProduct 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_product';
  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    * Contribution ID
  33    *
  34    * @var int
  35    */
  36   public $id;
  37
  38   /**
  39    * Foreign key to premiums settings record.
  40    *
  41    * @var int
  42    */
  43   public $premiums_id;
  44
  45   /**
  46    * Foreign key to each product object.
  47    *
  48    * @var int
  49    */
  50   public $product_id;
  51
  52   /**
  53    * @var int
  54    */
  55   public $weight;
  56
  57   /**
  58    * FK to Financial Type.
  59    *
  60    * @var int
  61    */
  62   public $financial_type_id;
  63
  64   /**
  65    * Class constructor.
  66    */
  67   public function __construct() {
  68     $this->__table = 'civicrm_premiums_product';
  69     parent::__construct();
  70   }
  71
  72   /**
  73    * Returns foreign keys and entity references.
  74    *
  75    * @return array
  76    *   [CRM_Core_Reference_Interface]
  77    */
  78   public static function getReferenceColumns() {
  79     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  80       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
  81       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'premiums_id', 'civicrm_premiums', 'id');
  82       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'product_id', 'civicrm_product', 'id');
  83       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'financial_type_id', 'civicrm_financial_type', 'id');
  84       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  85     }
  86     return Civi::$statics[__CLASS__]['links'];
  87   }
  88
  89   /**
  90    * Returns all the column names of this table
  91    *
  92    * @return array
  93    */
  94   public static function &fields() {
  95     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
  96       Civi::$statics[__CLASS__]['fields'] = [
  97         'id' => [
  98           'name' => 'id',
  99           'type' => CRM_Utils_Type::T_INT,
 100           'title' => ts('Premium Product ID'),
 101           'description' => ts('Contribution ID'),
 102           'required' => TRUE,
 103           'where' => 'civicrm_premiums_product.id',
 104           'table_name' => 'civicrm_premiums_product',
 105           'entity' => 'PremiumsProduct',
 106           'bao' => 'CRM_Contribute_DAO_PremiumsProduct',
 107           'localizable' => 0,
 108         ],
 109         'premiums_id' => [
 110           'name' => 'premiums_id',
 111           'type' => CRM_Utils_Type::T_INT,
 112           'title' => ts('Premium'),
 113           'description' => ts('Foreign key to premiums settings record.'),
 114           'required' => TRUE,
 115           'where' => 'civicrm_premiums_product.premiums_id',
 116           'table_name' => 'civicrm_premiums_product',
 117           'entity' => 'PremiumsProduct',
 118           'bao' => 'CRM_Contribute_DAO_PremiumsProduct',
 119           'localizable' => 0,
 120           'FKClassName' => 'CRM_Contribute_DAO_Premium',
 121         ],
 122         'product_id' => [
 123           'name' => 'product_id',
 124           'type' => CRM_Utils_Type::T_INT,
 125           'title' => ts('Product'),
 126           'description' => ts('Foreign key to each product object.'),
 127           'required' => TRUE,
 128           'where' => 'civicrm_premiums_product.product_id',
 129           'table_name' => 'civicrm_premiums_product',
 130           'entity' => 'PremiumsProduct',
 131           'bao' => 'CRM_Contribute_DAO_PremiumsProduct',
 132           'localizable' => 0,
 133           'FKClassName' => 'CRM_Contribute_DAO_Product',
 134         ],
 135         'weight' => [
 136           'name' => 'weight',
 137           'type' => CRM_Utils_Type::T_INT,
 138           'title' => ts('Order'),
 139           'required' => TRUE,
 140           'where' => 'civicrm_premiums_product.weight',
 141           'table_name' => 'civicrm_premiums_product',
 142           'entity' => 'PremiumsProduct',
 143           'bao' => 'CRM_Contribute_DAO_PremiumsProduct',
 144           'localizable' => 0,
 145         ],
 146         'financial_type_id' => [
 147           'name' => 'financial_type_id',
 148           'type' => CRM_Utils_Type::T_INT,
 149           'title' => ts('Financial Type'),
 150           'description' => ts('FK to Financial Type.'),
 151           'where' => 'civicrm_premiums_product.financial_type_id',
 152           'default' => 'NULL',
 153           'table_name' => 'civicrm_premiums_product',
 154           'entity' => 'PremiumsProduct',
 155           'bao' => 'CRM_Contribute_DAO_PremiumsProduct',
 156           'localizable' => 0,
 157           'FKClassName' => 'CRM_Financial_DAO_FinancialType',
 158           'pseudoconstant' => [
 159             'table' => 'civicrm_financial_type',
 160             'keyColumn' => 'id',
 161             'labelColumn' => 'name',
 162           ],
 163         ],
 164       ];
 165       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 166     }
 167     return Civi::$statics[__CLASS__]['fields'];
 168   }
 169
 170   /**
 171    * Return a mapping from field-name to the corresponding key (as used in fields()).
 172    *
 173    * @return array
 174    *   Array(string $name => string $uniqueName).
 175    */
 176   public static function &fieldKeys() {
 177     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 178       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 179     }
 180     return Civi::$statics[__CLASS__]['fieldKeys'];
 181   }
 182
 183   /**
 184    * Returns the names of this table
 185    *
 186    * @return string
 187    */
 188   public static function getTableName() {
 189     return self::$_tableName;
 190   }
 191
 192   /**
 193    * Returns if this table needs to be logged
 194    *
 195    * @return bool
 196    */
 197   public function getLog() {
 198     return self::$_log;
 199   }
 200
 201   /**
 202    * Returns the list of fields that can be imported
 203    *
 204    * @param bool $prefix
 205    *
 206    * @return array
 207    */
 208   public static function &import($prefix = FALSE) {
 209     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'premiums_product', $prefix, []);
 210     return $r;
 211   }
 212
 213   /**
 214    * Returns the list of fields that can be exported
 215    *
 216    * @param bool $prefix
 217    *
 218    * @return array
 219    */
 220   public static function &export($prefix = FALSE) {
 221     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'premiums_product', $prefix, []);
 222     return $r;
 223   }
 224
 225   /**
 226    * Returns the list of indices
 227    *
 228    * @param bool $localize
 229    *
 230    * @return array
 231    */
 232   public static function indices($localize = TRUE) {
 233     $indices = [];
 234     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 235   }
 236
 237 }