CRM/Core/DAO/Discount.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC (c) 2004-2019
   6  *
   7  * Generated from xml/schema/CRM/Core/Discount.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:74c8162f321ac50b965c1416951fe93a)
  10  */
  11
  12 /**
  13  * Database access object for the Discount entity.
  14  */
  15 class CRM_Core_DAO_Discount extends CRM_Core_DAO {
  16
  17   /**
  18    * Static instance to hold the table name.
  19    *
  20    * @var string
  21    */
  22   static $_tableName = 'civicrm_discount';
  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    * primary key
  33    *
  34    * @var int unsigned
  35    */
  36   public $id;
  37
  38   /**
  39    * physical tablename for entity being joined to discount, e.g. civicrm_event
  40    *
  41    * @var string
  42    */
  43   public $entity_table;
  44
  45   /**
  46    * FK to entity table specified in entity_table column.
  47    *
  48    * @var int unsigned
  49    */
  50   public $entity_id;
  51
  52   /**
  53    * FK to civicrm_price_set
  54    *
  55    * @var int unsigned
  56    */
  57   public $price_set_id;
  58
  59   /**
  60    * Date when discount starts.
  61    *
  62    * @var date
  63    */
  64   public $start_date;
  65
  66   /**
  67    * Date when discount ends.
  68    *
  69    * @var date
  70    */
  71   public $end_date;
  72
  73   /**
  74    * Class constructor.
  75    */
  76   public function __construct() {
  77     $this->__table = 'civicrm_discount';
  78     parent::__construct();
  79   }
  80
  81   /**
  82    * Returns foreign keys and entity references.
  83    *
  84    * @return array
  85    *   [CRM_Core_Reference_Interface]
  86    */
  87   public static function getReferenceColumns() {
  88     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  89       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
  90       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'price_set_id', 'civicrm_price_set', 'id');
  91       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName(), 'entity_id', NULL, 'id', 'entity_table');
  92       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  93     }
  94     return Civi::$statics[__CLASS__]['links'];
  95   }
  96
  97   /**
  98    * Returns all the column names of this table
  99    *
 100    * @return array
 101    */
 102   public static function &fields() {
 103     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 104       Civi::$statics[__CLASS__]['fields'] = [
 105         'id' => [
 106           'name' => 'id',
 107           'type' => CRM_Utils_Type::T_INT,
 108           'title' => ts('Discount ID'),
 109           'description' => ts('primary key'),
 110           'required' => TRUE,
 111           'table_name' => 'civicrm_discount',
 112           'entity' => 'Discount',
 113           'bao' => 'CRM_Core_BAO_Discount',
 114           'localizable' => 0,
 115         ],
 116         'entity_table' => [
 117           'name' => 'entity_table',
 118           'type' => CRM_Utils_Type::T_STRING,
 119           'title' => ts('Entity Table'),
 120           'description' => ts('physical tablename for entity being joined to discount, e.g. civicrm_event'),
 121           'maxlength' => 64,
 122           'size' => CRM_Utils_Type::BIG,
 123           'table_name' => 'civicrm_discount',
 124           'entity' => 'Discount',
 125           'bao' => 'CRM_Core_BAO_Discount',
 126           'localizable' => 0,
 127         ],
 128         'entity_id' => [
 129           'name' => 'entity_id',
 130           'type' => CRM_Utils_Type::T_INT,
 131           'title' => ts('Entity ID'),
 132           'description' => ts('FK to entity table specified in entity_table column.'),
 133           'required' => TRUE,
 134           'table_name' => 'civicrm_discount',
 135           'entity' => 'Discount',
 136           'bao' => 'CRM_Core_BAO_Discount',
 137           'localizable' => 0,
 138         ],
 139         'participant_discount_name' => [
 140           'name' => 'price_set_id',
 141           'type' => CRM_Utils_Type::T_INT,
 142           'title' => ts('Discount Name'),
 143           'description' => ts('FK to civicrm_price_set'),
 144           'required' => TRUE,
 145           'export' => TRUE,
 146           'where' => 'civicrm_discount.price_set_id',
 147           'headerPattern' => '',
 148           'dataPattern' => '',
 149           'table_name' => 'civicrm_discount',
 150           'entity' => 'Discount',
 151           'bao' => 'CRM_Core_BAO_Discount',
 152           'localizable' => 0,
 153           'FKClassName' => 'CRM_Price_DAO_PriceSet',
 154         ],
 155         'start_date' => [
 156           'name' => 'start_date',
 157           'type' => CRM_Utils_Type::T_DATE,
 158           'title' => ts('Discount Start Date'),
 159           'description' => ts('Date when discount starts.'),
 160           'table_name' => 'civicrm_discount',
 161           'entity' => 'Discount',
 162           'bao' => 'CRM_Core_BAO_Discount',
 163           'localizable' => 0,
 164         ],
 165         'end_date' => [
 166           'name' => 'end_date',
 167           'type' => CRM_Utils_Type::T_DATE,
 168           'title' => ts('Discount End Date'),
 169           'description' => ts('Date when discount ends.'),
 170           'table_name' => 'civicrm_discount',
 171           'entity' => 'Discount',
 172           'bao' => 'CRM_Core_BAO_Discount',
 173           'localizable' => 0,
 174         ],
 175       ];
 176       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 177     }
 178     return Civi::$statics[__CLASS__]['fields'];
 179   }
 180
 181   /**
 182    * Return a mapping from field-name to the corresponding key (as used in fields()).
 183    *
 184    * @return array
 185    *   Array(string $name => string $uniqueName).
 186    */
 187   public static function &fieldKeys() {
 188     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 189       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 190     }
 191     return Civi::$statics[__CLASS__]['fieldKeys'];
 192   }
 193
 194   /**
 195    * Returns the names of this table
 196    *
 197    * @return string
 198    */
 199   public static function getTableName() {
 200     return self::$_tableName;
 201   }
 202
 203   /**
 204    * Returns if this table needs to be logged
 205    *
 206    * @return bool
 207    */
 208   public function getLog() {
 209     return self::$_log;
 210   }
 211
 212   /**
 213    * Returns the list of fields that can be imported
 214    *
 215    * @param bool $prefix
 216    *
 217    * @return array
 218    */
 219   public static function &import($prefix = FALSE) {
 220     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'discount', $prefix, []);
 221     return $r;
 222   }
 223
 224   /**
 225    * Returns the list of fields that can be exported
 226    *
 227    * @param bool $prefix
 228    *
 229    * @return array
 230    */
 231   public static function &export($prefix = FALSE) {
 232     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'discount', $prefix, []);
 233     return $r;
 234   }
 235
 236   /**
 237    * Returns the list of indices
 238    *
 239    * @param bool $localize
 240    *
 241    * @return array
 242    */
 243   public static function indices($localize = TRUE) {
 244     $indices = [
 245       'index_entity' => [
 246         'name' => 'index_entity',
 247         'field' => [
 248           0 => 'entity_table',
 249           1 => 'entity_id',
 250         ],
 251         'localizable' => FALSE,
 252         'sig' => 'civicrm_discount::0::entity_table::entity_id',
 253       ],
 254       'index_entity_option_id' => [
 255         'name' => 'index_entity_option_id',
 256         'field' => [
 257           0 => 'entity_table',
 258           1 => 'entity_id',
 259           2 => 'price_set_id',
 260         ],
 261         'localizable' => FALSE,
 262         'sig' => 'civicrm_discount::0::entity_table::entity_id::price_set_id',
 263       ],
 264     ];
 265     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 266   }
 267
 268 }