CRM/Core/DAO/Discount.php

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