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:1e606c951b384dc261c2980784a04891)
  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(), 'contribution_id', 'civicrm_contribution', 'id');
 122       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'financial_type_id', 'civicrm_financial_type', 'id');
 123       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 124     }
 125     return Civi::$statics[__CLASS__]['links'];
 126   }
 127
 128   /**
 129    * Returns all the column names of this table
 130    *
 131    * @return array
 132    */
 133   public static function &fields() {
 134     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 135       Civi::$statics[__CLASS__]['fields'] = [
 136         'id' => [
 137           'name' => 'id',
 138           'type' => CRM_Utils_Type::T_INT,
 139           'title' => ts('Contribution Product ID'),
 140           'required' => TRUE,
 141           'where' => 'civicrm_contribution_product.id',
 142           'table_name' => 'civicrm_contribution_product',
 143           'entity' => 'ContributionProduct',
 144           'bao' => 'CRM_Contribute_DAO_ContributionProduct',
 145           'localizable' => 0,
 146           'html' => [
 147             'type' => 'Number',
 148           ],
 149           'readonly' => TRUE,
 150           'add' => '1.4',
 151         ],
 152         'product_id' => [
 153           'name' => 'product_id',
 154           'type' => CRM_Utils_Type::T_INT,
 155           'title' => ts('Product ID'),
 156           'required' => TRUE,
 157           'where' => 'civicrm_contribution_product.product_id',
 158           'table_name' => 'civicrm_contribution_product',
 159           'entity' => 'ContributionProduct',
 160           'bao' => 'CRM_Contribute_DAO_ContributionProduct',
 161           'localizable' => 0,
 162           'add' => '1.4',
 163         ],
 164         'contribution_id' => [
 165           'name' => 'contribution_id',
 166           'type' => CRM_Utils_Type::T_INT,
 167           'title' => ts('Contribution ID'),
 168           'required' => TRUE,
 169           'where' => 'civicrm_contribution_product.contribution_id',
 170           'table_name' => 'civicrm_contribution_product',
 171           'entity' => 'ContributionProduct',
 172           'bao' => 'CRM_Contribute_DAO_ContributionProduct',
 173           'localizable' => 0,
 174           'FKClassName' => 'CRM_Contribute_DAO_Contribution',
 175           'html' => [
 176             'label' => ts("Contribution"),
 177           ],
 178           'add' => '1.4',
 179         ],
 180         'product_option' => [
 181           'name' => 'product_option',
 182           'type' => CRM_Utils_Type::T_STRING,
 183           'title' => ts('Product Option'),
 184           'description' => ts('Option value selected if applicable - e.g. color, size etc.'),
 185           'maxlength' => 255,
 186           'size' => CRM_Utils_Type::HUGE,
 187           'where' => 'civicrm_contribution_product.product_option',
 188           'export' => TRUE,
 189           'table_name' => 'civicrm_contribution_product',
 190           'entity' => 'ContributionProduct',
 191           'bao' => 'CRM_Contribute_DAO_ContributionProduct',
 192           'localizable' => 0,
 193           'add' => '1.4',
 194         ],
 195         'quantity' => [
 196           'name' => 'quantity',
 197           'type' => CRM_Utils_Type::T_INT,
 198           'title' => ts('Quantity'),
 199           'where' => 'civicrm_contribution_product.quantity',
 200           'export' => TRUE,
 201           'table_name' => 'civicrm_contribution_product',
 202           'entity' => 'ContributionProduct',
 203           'bao' => 'CRM_Contribute_DAO_ContributionProduct',
 204           'localizable' => 0,
 205           'add' => '1.4',
 206         ],
 207         'fulfilled_date' => [
 208           'name' => 'fulfilled_date',
 209           'type' => CRM_Utils_Type::T_DATE,
 210           'title' => ts('Fulfilled Date'),
 211           'description' => ts('Optional. Can be used to record the date this product was fulfilled or shipped.'),
 212           'where' => 'civicrm_contribution_product.fulfilled_date',
 213           'export' => TRUE,
 214           'table_name' => 'civicrm_contribution_product',
 215           'entity' => 'ContributionProduct',
 216           'bao' => 'CRM_Contribute_DAO_ContributionProduct',
 217           'localizable' => 0,
 218           'html' => [
 219             'type' => 'Select Date',
 220             'formatType' => 'activityDate',
 221           ],
 222           'add' => '1.4',
 223         ],
 224         'contribution_start_date' => [
 225           'name' => 'start_date',
 226           'type' => CRM_Utils_Type::T_DATE,
 227           'title' => ts('Start date for premium'),
 228           'description' => ts('Actual start date for a time-delimited premium (subscription, service or membership)'),
 229           'where' => 'civicrm_contribution_product.start_date',
 230           'export' => TRUE,
 231           'table_name' => 'civicrm_contribution_product',
 232           'entity' => 'ContributionProduct',
 233           'bao' => 'CRM_Contribute_DAO_ContributionProduct',
 234           'localizable' => 0,
 235           'add' => '1.4',
 236         ],
 237         'contribution_end_date' => [
 238           'name' => 'end_date',
 239           'type' => CRM_Utils_Type::T_DATE,
 240           'title' => ts('End date for premium'),
 241           'description' => ts('Actual end date for a time-delimited premium (subscription, service or membership)'),
 242           'where' => 'civicrm_contribution_product.end_date',
 243           'export' => TRUE,
 244           'table_name' => 'civicrm_contribution_product',
 245           'entity' => 'ContributionProduct',
 246           'bao' => 'CRM_Contribute_DAO_ContributionProduct',
 247           'localizable' => 0,
 248           'add' => '1.4',
 249         ],
 250         'comment' => [
 251           'name' => 'comment',
 252           'type' => CRM_Utils_Type::T_TEXT,
 253           'title' => ts('Premium comment'),
 254           'where' => 'civicrm_contribution_product.comment',
 255           'table_name' => 'civicrm_contribution_product',
 256           'entity' => 'ContributionProduct',
 257           'bao' => 'CRM_Contribute_DAO_ContributionProduct',
 258           'localizable' => 0,
 259           'add' => '1.4',
 260         ],
 261         'financial_type_id' => [
 262           'name' => 'financial_type_id',
 263           'type' => CRM_Utils_Type::T_INT,
 264           'title' => ts('Financial Type ID'),
 265           'description' => ts('FK to Financial Type(for membership price sets only).'),
 266           'where' => 'civicrm_contribution_product.financial_type_id',
 267           'default' => 'NULL',
 268           'table_name' => 'civicrm_contribution_product',
 269           'entity' => 'ContributionProduct',
 270           'bao' => 'CRM_Contribute_DAO_ContributionProduct',
 271           'localizable' => 0,
 272           'FKClassName' => 'CRM_Financial_DAO_FinancialType',
 273           'html' => [
 274             'label' => ts("Financial Type"),
 275           ],
 276           'pseudoconstant' => [
 277             'table' => 'civicrm_financial_type',
 278             'keyColumn' => 'id',
 279             'labelColumn' => 'name',
 280           ],
 281           'add' => '4.3',
 282         ],
 283       ];
 284       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 285     }
 286     return Civi::$statics[__CLASS__]['fields'];
 287   }
 288
 289   /**
 290    * Return a mapping from field-name to the corresponding key (as used in fields()).
 291    *
 292    * @return array
 293    *   Array(string $name => string $uniqueName).
 294    */
 295   public static function &fieldKeys() {
 296     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 297       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 298     }
 299     return Civi::$statics[__CLASS__]['fieldKeys'];
 300   }
 301
 302   /**
 303    * Returns the names of this table
 304    *
 305    * @return string
 306    */
 307   public static function getTableName() {
 308     return self::$_tableName;
 309   }
 310
 311   /**
 312    * Returns if this table needs to be logged
 313    *
 314    * @return bool
 315    */
 316   public function getLog() {
 317     return self::$_log;
 318   }
 319
 320   /**
 321    * Returns the list of fields that can be imported
 322    *
 323    * @param bool $prefix
 324    *
 325    * @return array
 326    */
 327   public static function &import($prefix = FALSE) {
 328     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'contribution_product', $prefix, []);
 329     return $r;
 330   }
 331
 332   /**
 333    * Returns the list of fields that can be exported
 334    *
 335    * @param bool $prefix
 336    *
 337    * @return array
 338    */
 339   public static function &export($prefix = FALSE) {
 340     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'contribution_product', $prefix, []);
 341     return $r;
 342   }
 343
 344   /**
 345    * Returns the list of indices
 346    *
 347    * @param bool $localize
 348    *
 349    * @return array
 350    */
 351   public static function indices($localize = TRUE) {
 352     $indices = [];
 353     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 354   }
 355
 356 }