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:3580529cebca0659c28e8d4f55015c22)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 class CRM_Contribute_DAO_PremiumsProduct extends CRM_Core_DAO {
  38   /**
  39    * static instance to hold the table name
  40    *
  41    * @var string
  42    */
  43   static $_tableName = 'civicrm_premiums_product';
  44   /**
  45    * static value to see if we should log any modifications to
  46    * this table in the civicrm_log table
  47    *
  48    * @var boolean
  49    */
  50   static $_log = true;
  51   /**
  52    * Contribution ID
  53    *
  54    * @var int unsigned
  55    */
  56   public $id;
  57   /**
  58    * Foreign key to premiums settings record.
  59    *
  60    * @var int unsigned
  61    */
  62   public $premiums_id;
  63   /**
  64    * Foreign key to each product object.
  65    *
  66    * @var int unsigned
  67    */
  68   public $product_id;
  69   /**
  70    *
  71    * @var int unsigned
  72    */
  73   public $weight;
  74   /**
  75    * FK to Financial Type.
  76    *
  77    * @var int unsigned
  78    */
  79   public $financial_type_id;
  80   /**
  81    * class constructor
  82    *
  83    * @return civicrm_premiums_product
  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         ) ,
 120         'premiums_id' => array(
 121           'name' => 'premiums_id',
 122           'type' => CRM_Utils_Type::T_INT,
 123           'title' => ts('Premium') ,
 124           'description' => 'Foreign key to premiums settings record.',
 125           'required' => true,
 126           'FKClassName' => 'CRM_Contribute_DAO_Premium',
 127         ) ,
 128         'product_id' => array(
 129           'name' => 'product_id',
 130           'type' => CRM_Utils_Type::T_INT,
 131           'title' => ts('Product') ,
 132           'description' => 'Foreign key to each product object.',
 133           'required' => true,
 134           'FKClassName' => 'CRM_Contribute_DAO_Product',
 135         ) ,
 136         'weight' => array(
 137           'name' => 'weight',
 138           'type' => CRM_Utils_Type::T_INT,
 139           'title' => ts('Order') ,
 140           'required' => true,
 141         ) ,
 142         'financial_type_id' => array(
 143           'name' => 'financial_type_id',
 144           'type' => CRM_Utils_Type::T_INT,
 145           'title' => ts('Financial Type') ,
 146           'description' => 'FK to Financial Type.',
 147           'default' => 'NULL',
 148           'FKClassName' => 'CRM_Financial_DAO_FinancialType',
 149           'pseudoconstant' => array(
 150             'table' => 'civicrm_financial_type',
 151             'keyColumn' => 'id',
 152             'labelColumn' => 'name',
 153           )
 154         ) ,
 155       );
 156       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 157     }
 158     return Civi::$statics[__CLASS__]['fields'];
 159   }
 160   /**
 161    * Return a mapping from field-name to the corresponding key (as used in fields()).
 162    *
 163    * @return array
 164    *   Array(string $name => string $uniqueName).
 165    */
 166   static function &fieldKeys() {
 167     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 168       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 169     }
 170     return Civi::$statics[__CLASS__]['fieldKeys'];
 171   }
 172   /**
 173    * Returns the names of this table
 174    *
 175    * @return string
 176    */
 177   static function getTableName() {
 178     return self::$_tableName;
 179   }
 180   /**
 181    * Returns if this table needs to be logged
 182    *
 183    * @return boolean
 184    */
 185   function getLog() {
 186     return self::$_log;
 187   }
 188   /**
 189    * Returns the list of fields that can be imported
 190    *
 191    * @param bool $prefix
 192    *
 193    * @return array
 194    */
 195   static function &import($prefix = false) {
 196     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'premiums_product', $prefix, array());
 197     return $r;
 198   }
 199   /**
 200    * Returns the list of fields that can be exported
 201    *
 202    * @param bool $prefix
 203    *
 204    * @return array
 205    */
 206   static function &export($prefix = false) {
 207     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'premiums_product', $prefix, array());
 208     return $r;
 209   }
 210 }