5 * @copyright CiviCRM LLC https://civicrm.org/licensing
7 * Generated from xml/schema/CRM/Contribute/PremiumsProduct.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:444f1def563a1e986ddf0ac56f5b2e84)
13 * Database access object for the PremiumsProduct entity.
15 class CRM_Contribute_DAO_PremiumsProduct
extends CRM_Core_DAO
{
18 * Static instance to hold the table name.
22 public static $_tableName = 'civicrm_premiums_product';
25 * Should CiviCRM log any modifications to this table in the civicrm_log table.
29 public static $_log = TRUE;
39 * Foreign key to premiums settings record.
46 * Foreign key to each product object.
58 * FK to Financial Type.
62 public $financial_type_id;
67 public function __construct() {
68 $this->__table
= 'civicrm_premiums_product';
69 parent
::__construct();
73 * Returns foreign keys and entity references.
76 * [CRM_Core_Reference_Interface]
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']);
86 return Civi
::$statics[__CLASS__
]['links'];
90 * Returns all the column names of this table
94 public static function &fields() {
95 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
96 Civi
::$statics[__CLASS__
]['fields'] = [
99 'type' => CRM_Utils_Type
::T_INT
,
100 'title' => ts('Premium Product ID'),
101 'description' => ts('Contribution ID'),
103 'where' => 'civicrm_premiums_product.id',
104 'table_name' => 'civicrm_premiums_product',
105 'entity' => 'PremiumsProduct',
106 'bao' => 'CRM_Contribute_DAO_PremiumsProduct',
110 'name' => 'premiums_id',
111 'type' => CRM_Utils_Type
::T_INT
,
112 'title' => ts('Premium'),
113 'description' => ts('Foreign key to premiums settings record.'),
115 'where' => 'civicrm_premiums_product.premiums_id',
116 'table_name' => 'civicrm_premiums_product',
117 'entity' => 'PremiumsProduct',
118 'bao' => 'CRM_Contribute_DAO_PremiumsProduct',
120 'FKClassName' => 'CRM_Contribute_DAO_Premium',
123 'name' => 'product_id',
124 'type' => CRM_Utils_Type
::T_INT
,
125 'title' => ts('Product'),
126 'description' => ts('Foreign key to each product object.'),
128 'where' => 'civicrm_premiums_product.product_id',
129 'table_name' => 'civicrm_premiums_product',
130 'entity' => 'PremiumsProduct',
131 'bao' => 'CRM_Contribute_DAO_PremiumsProduct',
133 'FKClassName' => 'CRM_Contribute_DAO_Product',
137 'type' => CRM_Utils_Type
::T_INT
,
138 'title' => ts('Order'),
140 'where' => 'civicrm_premiums_product.weight',
141 'table_name' => 'civicrm_premiums_product',
142 'entity' => 'PremiumsProduct',
143 'bao' => 'CRM_Contribute_DAO_PremiumsProduct',
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',
153 'table_name' => 'civicrm_premiums_product',
154 'entity' => 'PremiumsProduct',
155 'bao' => 'CRM_Contribute_DAO_PremiumsProduct',
157 'FKClassName' => 'CRM_Financial_DAO_FinancialType',
158 'pseudoconstant' => [
159 'table' => 'civicrm_financial_type',
161 'labelColumn' => 'name',
165 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
167 return Civi
::$statics[__CLASS__
]['fields'];
171 * Return a mapping from field-name to the corresponding key (as used in fields()).
174 * Array(string $name => string $uniqueName).
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()));
180 return Civi
::$statics[__CLASS__
]['fieldKeys'];
184 * Returns the names of this table
188 public static function getTableName() {
189 return self
::$_tableName;
193 * Returns if this table needs to be logged
197 public function getLog() {
202 * Returns the list of fields that can be imported
204 * @param bool $prefix
208 public static function &import($prefix = FALSE) {
209 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'premiums_product', $prefix, []);
214 * Returns the list of fields that can be exported
216 * @param bool $prefix
220 public static function &export($prefix = FALSE) {
221 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'premiums_product', $prefix, []);
226 * Returns the list of indices
228 * @param bool $localize
232 public static function indices($localize = TRUE) {
234 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;