CRM/Contribute/DAO/PremiumsProduct.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.7                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2017                                |
   7 +--------------------------------------------------------------------+
   8 | This file is a part of CiviCRM.                                    |
   9 |                                                                    |
  10 | CiviCRM is free software; you can copy, modify, and distribute it  |
  11 | under the terms of the GNU Affero General Public License           |
  12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13 |                                                                    |
  14 | CiviCRM is distributed in the hope that it will be useful, but     |
  15 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17 | See the GNU Affero General Public License for more details.        |
  18 |                                                                    |
  19 | You should have received a copy of the GNU Affero General Public   |
  20 | License and the CiviCRM Licensing Exception along                  |
  21 | with this program; if not, contact CiviCRM LLC                     |
  22 | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23 | GNU Affero General Public License or the licensing of CiviCRM,     |
  24 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25 +--------------------------------------------------------------------+
  26 */
  27 /**
  28  * @package CRM
  29  * @copyright CiviCRM LLC (c) 2004-2017
  30  *
  31  * Generated from xml/schema/CRM/Contribute/PremiumsProduct.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:6c90561115f3fbe406af545ef055f79c)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_Contribute_DAO_PremiumsProduct constructor.
  39  */
  40 class CRM_Contribute_DAO_PremiumsProduct extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_premiums_product';
  47   /**
  48    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  49    *
  50    * @var boolean
  51    */
  52   static $_log = true;
  53   /**
  54    * Contribution ID
  55    *
  56    * @var int unsigned
  57    */
  58   public $id;
  59   /**
  60    * Foreign key to premiums settings record.
  61    *
  62    * @var int unsigned
  63    */
  64   public $premiums_id;
  65   /**
  66    * Foreign key to each product object.
  67    *
  68    * @var int unsigned
  69    */
  70   public $product_id;
  71   /**
  72    *
  73    * @var int unsigned
  74    */
  75   public $weight;
  76   /**
  77    * FK to Financial Type.
  78    *
  79    * @var int unsigned
  80    */
  81   public $financial_type_id;
  82   /**
  83    * Class constructor.
  84    */
  85   function __construct() {
  86     $this->__table = 'civicrm_premiums_product';
  87     parent::__construct();
  88   }
  89   /**
  90    * Returns foreign keys and entity references.
  91    *
  92    * @return array
  93    *   [CRM_Core_Reference_Interface]
  94    */
  95   static function getReferenceColumns() {
  96     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  97       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
  98       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'premiums_id', 'civicrm_premiums', 'id');
  99       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'product_id', 'civicrm_product', 'id');
 100       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'financial_type_id', 'civicrm_financial_type', 'id');
 101       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 102     }
 103     return Civi::$statics[__CLASS__]['links'];
 104   }
 105   /**
 106    * Returns all the column names of this table
 107    *
 108    * @return array
 109    */
 110   static function &fields() {
 111     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 112       Civi::$statics[__CLASS__]['fields'] = array(
 113         'id' => array(
 114           'name' => 'id',
 115           'type' => CRM_Utils_Type::T_INT,
 116           'title' => ts('Premium Product ID') ,
 117           'description' => 'Contribution ID',
 118           'required' => true,
 119           'table_name' => 'civicrm_premiums_product',
 120           'entity' => 'PremiumsProduct',
 121           'bao' => 'CRM_Contribute_DAO_PremiumsProduct',
 122           'localizable' => 0,
 123         ) ,
 124         'premiums_id' => array(
 125           'name' => 'premiums_id',
 126           'type' => CRM_Utils_Type::T_INT,
 127           'title' => ts('Premium') ,
 128           'description' => 'Foreign key to premiums settings record.',
 129           'required' => true,
 130           'table_name' => 'civicrm_premiums_product',
 131           'entity' => 'PremiumsProduct',
 132           'bao' => 'CRM_Contribute_DAO_PremiumsProduct',
 133           'localizable' => 0,
 134           'FKClassName' => 'CRM_Contribute_DAO_Premium',
 135         ) ,
 136         'product_id' => array(
 137           'name' => 'product_id',
 138           'type' => CRM_Utils_Type::T_INT,
 139           'title' => ts('Product') ,
 140           'description' => 'Foreign key to each product object.',
 141           'required' => true,
 142           'table_name' => 'civicrm_premiums_product',
 143           'entity' => 'PremiumsProduct',
 144           'bao' => 'CRM_Contribute_DAO_PremiumsProduct',
 145           'localizable' => 0,
 146           'FKClassName' => 'CRM_Contribute_DAO_Product',
 147         ) ,
 148         'weight' => array(
 149           'name' => 'weight',
 150           'type' => CRM_Utils_Type::T_INT,
 151           'title' => ts('Order') ,
 152           'required' => true,
 153           'table_name' => 'civicrm_premiums_product',
 154           'entity' => 'PremiumsProduct',
 155           'bao' => 'CRM_Contribute_DAO_PremiumsProduct',
 156           'localizable' => 0,
 157         ) ,
 158         'financial_type_id' => array(
 159           'name' => 'financial_type_id',
 160           'type' => CRM_Utils_Type::T_INT,
 161           'title' => ts('Financial Type') ,
 162           'description' => 'FK to Financial Type.',
 163           'default' => 'NULL',
 164           'table_name' => 'civicrm_premiums_product',
 165           'entity' => 'PremiumsProduct',
 166           'bao' => 'CRM_Contribute_DAO_PremiumsProduct',
 167           'localizable' => 0,
 168           'FKClassName' => 'CRM_Financial_DAO_FinancialType',
 169           'pseudoconstant' => array(
 170             'table' => 'civicrm_financial_type',
 171             'keyColumn' => 'id',
 172             'labelColumn' => 'name',
 173           )
 174         ) ,
 175       );
 176       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 177     }
 178     return Civi::$statics[__CLASS__]['fields'];
 179   }
 180   /**
 181    * Return a mapping from field-name to the corresponding key (as used in fields()).
 182    *
 183    * @return array
 184    *   Array(string $name => string $uniqueName).
 185    */
 186   static function &fieldKeys() {
 187     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 188       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 189     }
 190     return Civi::$statics[__CLASS__]['fieldKeys'];
 191   }
 192   /**
 193    * Returns the names of this table
 194    *
 195    * @return string
 196    */
 197   static function getTableName() {
 198     return self::$_tableName;
 199   }
 200   /**
 201    * Returns if this table needs to be logged
 202    *
 203    * @return boolean
 204    */
 205   function getLog() {
 206     return self::$_log;
 207   }
 208   /**
 209    * Returns the list of fields that can be imported
 210    *
 211    * @param bool $prefix
 212    *
 213    * @return array
 214    */
 215   static function &import($prefix = false) {
 216     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'premiums_product', $prefix, array());
 217     return $r;
 218   }
 219   /**
 220    * Returns the list of fields that can be exported
 221    *
 222    * @param bool $prefix
 223    *
 224    * @return array
 225    */
 226   static function &export($prefix = false) {
 227     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'premiums_product', $prefix, array());
 228     return $r;
 229   }
 230 }