CRM/Contribute/DAO/PremiumsProduct.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.7                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2016                                |
   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-2016
  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 instance to hold the field values
  46    *
  47    * @var array
  48    */
  49   static $_fields = null;
  50   /**
  51    * static instance to hold the FK relationships
  52    *
  53    * @var string
  54    */
  55   static $_links = null;
  56   /**
  57    * static value to see if we should log any modifications to
  58    * this table in the civicrm_log table
  59    *
  60    * @var boolean
  61    */
  62   static $_log = true;
  63   /**
  64    * Contribution ID
  65    *
  66    * @var int unsigned
  67    */
  68   public $id;
  69   /**
  70    * Foreign key to premiums settings record.
  71    *
  72    * @var int unsigned
  73    */
  74   public $premiums_id;
  75   /**
  76    * Foreign key to each product object.
  77    *
  78    * @var int unsigned
  79    */
  80   public $product_id;
  81   /**
  82    *
  83    * @var int unsigned
  84    */
  85   public $weight;
  86   /**
  87    * FK to Financial Type.
  88    *
  89    * @var int unsigned
  90    */
  91   public $financial_type_id;
  92   /**
  93    * class constructor
  94    *
  95    * @return civicrm_premiums_product
  96    */
  97   function __construct() {
  98     $this->__table = 'civicrm_premiums_product';
  99     parent::__construct();
 100   }
 101   /**
 102    * Returns foreign keys and entity references
 103    *
 104    * @return array
 105    *   [CRM_Core_Reference_Interface]
 106    */
 107   static function getReferenceColumns() {
 108     if (!self::$_links) {
 109       self::$_links = static ::createReferenceColumns(__CLASS__);
 110       self::$_links[] = new CRM_Core_Reference_Basic(self::getTableName() , 'premiums_id', 'civicrm_premiums', 'id');
 111       self::$_links[] = new CRM_Core_Reference_Basic(self::getTableName() , 'product_id', 'civicrm_product', 'id');
 112       self::$_links[] = new CRM_Core_Reference_Basic(self::getTableName() , 'financial_type_id', 'civicrm_financial_type', 'id');
 113     }
 114     return self::$_links;
 115   }
 116   /**
 117    * Returns all the column names of this table
 118    *
 119    * @return array
 120    */
 121   static function &fields() {
 122     if (!(self::$_fields)) {
 123       self::$_fields = array(
 124         'id' => array(
 125           'name' => 'id',
 126           'type' => CRM_Utils_Type::T_INT,
 127           'title' => ts('Premium Product ID') ,
 128           'description' => 'Contribution ID',
 129           'required' => true,
 130         ) ,
 131         'premiums_id' => array(
 132           'name' => 'premiums_id',
 133           'type' => CRM_Utils_Type::T_INT,
 134           'title' => ts('Premium') ,
 135           'description' => 'Foreign key to premiums settings record.',
 136           'required' => true,
 137           'FKClassName' => 'CRM_Contribute_DAO_Premium',
 138         ) ,
 139         'product_id' => array(
 140           'name' => 'product_id',
 141           'type' => CRM_Utils_Type::T_INT,
 142           'title' => ts('Product') ,
 143           'description' => 'Foreign key to each product object.',
 144           'required' => true,
 145           'FKClassName' => 'CRM_Contribute_DAO_Product',
 146         ) ,
 147         'weight' => array(
 148           'name' => 'weight',
 149           'type' => CRM_Utils_Type::T_INT,
 150           'title' => ts('Order') ,
 151           'required' => true,
 152         ) ,
 153         'financial_type_id' => array(
 154           'name' => 'financial_type_id',
 155           'type' => CRM_Utils_Type::T_INT,
 156           'title' => ts('Financial Type') ,
 157           'description' => 'FK to Financial Type.',
 158           'default' => 'NULL',
 159           'FKClassName' => 'CRM_Financial_DAO_FinancialType',
 160           'pseudoconstant' => array(
 161             'table' => 'civicrm_financial_type',
 162             'keyColumn' => 'id',
 163             'labelColumn' => 'name',
 164           )
 165         ) ,
 166       );
 167     }
 168     return self::$_fields;
 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   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    * Returns the names of this table
 184    *
 185    * @return string
 186    */
 187   static function getTableName() {
 188     return self::$_tableName;
 189   }
 190   /**
 191    * Returns if this table needs to be logged
 192    *
 193    * @return boolean
 194    */
 195   function getLog() {
 196     return self::$_log;
 197   }
 198   /**
 199    * Returns the list of fields that can be imported
 200    *
 201    * @param bool $prefix
 202    *
 203    * @return array
 204    */
 205   static function &import($prefix = false) {
 206     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'premiums_product', $prefix, array());
 207     return $r;
 208   }
 209   /**
 210    * Returns the list of fields that can be exported
 211    *
 212    * @param bool $prefix
 213    *
 214    * @return array
 215    */
 216   static function &export($prefix = false) {
 217     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'premiums_product', $prefix, array());
 218     return $r;
 219   }
 220 }