CRM/Contribute/DAO/ContributionProduct.php

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