CRM/Contribute/DAO/ContributionProduct.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC (c) 2004-2018
   6  *
   7  * Generated from xml/schema/CRM/Contribute/ContributionProduct.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:8ef29c5c92b3ffb2a678bd4c585a3d0e)
  10  */
  11
  12 /**
  13  * Database access object for the ContributionProduct entity.
  14  */
  15 class CRM_Contribute_DAO_ContributionProduct extends CRM_Core_DAO {
  16
  17   /**
  18    * Static instance to hold the table name.
  19    *
  20    * @var string
  21    */
  22   static $_tableName = 'civicrm_contribution_product';
  23
  24   /**
  25    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  26    *
  27    * @var bool
  28    */
  29   static $_log = TRUE;
  30
  31   /**
  32    * @var int unsigned
  33    */
  34   public $id;
  35
  36   /**
  37    * @var int unsigned
  38    */
  39   public $product_id;
  40
  41   /**
  42    * @var int unsigned
  43    */
  44   public $contribution_id;
  45
  46   /**
  47    * Option value selected if applicable - e.g. color, size etc.
  48    *
  49    * @var string
  50    */
  51   public $product_option;
  52
  53   /**
  54    * @var int
  55    */
  56   public $quantity;
  57
  58   /**
  59    * Optional. Can be used to record the date this product was fulfilled or shipped.
  60    *
  61    * @var date
  62    */
  63   public $fulfilled_date;
  64
  65   /**
  66    * Actual start date for a time-delimited premium (subscription, service or membership)
  67    *
  68    * @var date
  69    */
  70   public $start_date;
  71
  72   /**
  73    * Actual end date for a time-delimited premium (subscription, service or membership)
  74    *
  75    * @var date
  76    */
  77   public $end_date;
  78
  79   /**
  80    * @var text
  81    */
  82   public $comment;
  83
  84   /**
  85    * FK to Financial Type(for membership price sets only).
  86    *
  87    * @var int unsigned
  88    */
  89   public $financial_type_id;
  90
  91   /**
  92    * Class constructor.
  93    */
  94   public function __construct() {
  95     $this->__table = 'civicrm_contribution_product';
  96     parent::__construct();
  97   }
  98
  99   /**
 100    * Returns foreign keys and entity references.
 101    *
 102    * @return array
 103    *   [CRM_Core_Reference_Interface]
 104    */
 105   public static function getReferenceColumns() {
 106     if (!isset(Civi::$statics[__CLASS__]['links'])) {
 107       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
 108       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contribution_id', 'civicrm_contribution', 'id');
 109       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'financial_type_id', 'civicrm_financial_type', 'id');
 110       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 111     }
 112     return Civi::$statics[__CLASS__]['links'];
 113   }
 114
 115   /**
 116    * Returns all the column names of this table
 117    *
 118    * @return array
 119    */
 120   public static function &fields() {
 121     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 122       Civi::$statics[__CLASS__]['fields'] = [
 123         'id' => [
 124           'name' => 'id',
 125           'type' => CRM_Utils_Type::T_INT,
 126           'title' => ts('Contribution Product ID'),
 127           'required' => TRUE,
 128           'table_name' => 'civicrm_contribution_product',
 129           'entity' => 'ContributionProduct',
 130           'bao' => 'CRM_Contribute_DAO_ContributionProduct',
 131           'localizable' => 0,
 132         ],
 133         'product_id' => [
 134           'name' => 'product_id',
 135           'type' => CRM_Utils_Type::T_INT,
 136           'title' => ts('Product ID'),
 137           'required' => TRUE,
 138           'table_name' => 'civicrm_contribution_product',
 139           'entity' => 'ContributionProduct',
 140           'bao' => 'CRM_Contribute_DAO_ContributionProduct',
 141           'localizable' => 0,
 142         ],
 143         'contribution_id' => [
 144           'name' => 'contribution_id',
 145           'type' => CRM_Utils_Type::T_INT,
 146           'title' => ts('Contribution ID'),
 147           'required' => TRUE,
 148           'table_name' => 'civicrm_contribution_product',
 149           'entity' => 'ContributionProduct',
 150           'bao' => 'CRM_Contribute_DAO_ContributionProduct',
 151           'localizable' => 0,
 152           'FKClassName' => 'CRM_Contribute_DAO_Contribution',
 153         ],
 154         'product_option' => [
 155           'name' => 'product_option',
 156           'type' => CRM_Utils_Type::T_STRING,
 157           'title' => ts('Product Option'),
 158           'description' => 'Option value selected if applicable - e.g. color, size etc.',
 159           'maxlength' => 255,
 160           'size' => CRM_Utils_Type::HUGE,
 161           'export' => TRUE,
 162           'where' => 'civicrm_contribution_product.product_option',
 163           'headerPattern' => '',
 164           'dataPattern' => '',
 165           'table_name' => 'civicrm_contribution_product',
 166           'entity' => 'ContributionProduct',
 167           'bao' => 'CRM_Contribute_DAO_ContributionProduct',
 168           'localizable' => 0,
 169         ],
 170         'quantity' => [
 171           'name' => 'quantity',
 172           'type' => CRM_Utils_Type::T_INT,
 173           'title' => ts('Quantity'),
 174           'export' => TRUE,
 175           'where' => 'civicrm_contribution_product.quantity',
 176           'headerPattern' => '',
 177           'dataPattern' => '',
 178           'table_name' => 'civicrm_contribution_product',
 179           'entity' => 'ContributionProduct',
 180           'bao' => 'CRM_Contribute_DAO_ContributionProduct',
 181           'localizable' => 0,
 182         ],
 183         'fulfilled_date' => [
 184           'name' => 'fulfilled_date',
 185           'type' => CRM_Utils_Type::T_DATE,
 186           'title' => ts('Fulfilled Date'),
 187           'description' => 'Optional. Can be used to record the date this product was fulfilled or shipped.',
 188           'export' => TRUE,
 189           'where' => 'civicrm_contribution_product.fulfilled_date',
 190           'headerPattern' => '',
 191           'dataPattern' => '',
 192           'table_name' => 'civicrm_contribution_product',
 193           'entity' => 'ContributionProduct',
 194           'bao' => 'CRM_Contribute_DAO_ContributionProduct',
 195           'localizable' => 0,
 196         ],
 197         'contribution_start_date' => [
 198           'name' => 'start_date',
 199           'type' => CRM_Utils_Type::T_DATE,
 200           'title' => ts('Start date for premium'),
 201           'description' => 'Actual start date for a time-delimited premium (subscription, service or membership)',
 202           'export' => TRUE,
 203           'where' => 'civicrm_contribution_product.start_date',
 204           'headerPattern' => '',
 205           'dataPattern' => '',
 206           'table_name' => 'civicrm_contribution_product',
 207           'entity' => 'ContributionProduct',
 208           'bao' => 'CRM_Contribute_DAO_ContributionProduct',
 209           'localizable' => 0,
 210         ],
 211         'contribution_end_date' => [
 212           'name' => 'end_date',
 213           'type' => CRM_Utils_Type::T_DATE,
 214           'title' => ts('End date for premium'),
 215           'description' => 'Actual end date for a time-delimited premium (subscription, service or membership)',
 216           'export' => TRUE,
 217           'where' => 'civicrm_contribution_product.end_date',
 218           'headerPattern' => '',
 219           'dataPattern' => '',
 220           'table_name' => 'civicrm_contribution_product',
 221           'entity' => 'ContributionProduct',
 222           'bao' => 'CRM_Contribute_DAO_ContributionProduct',
 223           'localizable' => 0,
 224         ],
 225         'comment' => [
 226           'name' => 'comment',
 227           'type' => CRM_Utils_Type::T_TEXT,
 228           'title' => ts('Premium comment'),
 229           'table_name' => 'civicrm_contribution_product',
 230           'entity' => 'ContributionProduct',
 231           'bao' => 'CRM_Contribute_DAO_ContributionProduct',
 232           'localizable' => 0,
 233         ],
 234         'financial_type_id' => [
 235           'name' => 'financial_type_id',
 236           'type' => CRM_Utils_Type::T_INT,
 237           'title' => ts('Financial Type'),
 238           'description' => 'FK to Financial Type(for membership price sets only).',
 239           'default' => 'NULL',
 240           'table_name' => 'civicrm_contribution_product',
 241           'entity' => 'ContributionProduct',
 242           'bao' => 'CRM_Contribute_DAO_ContributionProduct',
 243           'localizable' => 0,
 244           'FKClassName' => 'CRM_Financial_DAO_FinancialType',
 245           'pseudoconstant' => [
 246             'table' => 'civicrm_financial_type',
 247             'keyColumn' => 'id',
 248             'labelColumn' => 'name',
 249           ]
 250         ],
 251       ];
 252       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 253     }
 254     return Civi::$statics[__CLASS__]['fields'];
 255   }
 256
 257   /**
 258    * Return a mapping from field-name to the corresponding key (as used in fields()).
 259    *
 260    * @return array
 261    *   Array(string $name => string $uniqueName).
 262    */
 263   public static function &fieldKeys() {
 264     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 265       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 266     }
 267     return Civi::$statics[__CLASS__]['fieldKeys'];
 268   }
 269
 270   /**
 271    * Returns the names of this table
 272    *
 273    * @return string
 274    */
 275   public static function getTableName() {
 276     return self::$_tableName;
 277   }
 278
 279   /**
 280    * Returns if this table needs to be logged
 281    *
 282    * @return bool
 283    */
 284   public function getLog() {
 285     return self::$_log;
 286   }
 287
 288   /**
 289    * Returns the list of fields that can be imported
 290    *
 291    * @param bool $prefix
 292    *
 293    * @return array
 294    */
 295   public static function &import($prefix = FALSE) {
 296     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'contribution_product', $prefix, []);
 297     return $r;
 298   }
 299
 300   /**
 301    * Returns the list of fields that can be exported
 302    *
 303    * @param bool $prefix
 304    *
 305    * @return array
 306    */
 307   public static function &export($prefix = FALSE) {
 308     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'contribution_product', $prefix, []);
 309     return $r;
 310   }
 311
 312   /**
 313    * Returns the list of indices
 314    *
 315    * @param bool $localize
 316    *
 317    * @return array
 318    */
 319   public static function indices($localize = TRUE) {
 320     $indices = [];
 321     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 322   }
 323
 324 }