Merge pull request #11268 from mattwire/CRM-21421_allow_updating_existing_casecontact
[civicrm-core.git] / CRM / Core / DAO / Discount.php
CommitLineData
e501603b
TO
1<?php
2/*
3+--------------------------------------------------------------------+
4| CiviCRM version 4.7 |
5+--------------------------------------------------------------------+
0f03f337 6| Copyright CiviCRM LLC (c) 2004-2017 |
e501603b
TO
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
0f03f337 29 * @copyright CiviCRM LLC (c) 2004-2017
e501603b
TO
30 *
31 * Generated from xml/schema/CRM/Core/Discount.xml
32 * DO NOT EDIT. Generated by CRM_Core_CodeGen
e7a6b91a 33 * (GenCodeChecksum:1ce69428f948066567e95645cb86254a)
e501603b
TO
34 */
35require_once 'CRM/Core/DAO.php';
36require_once 'CRM/Utils/Type.php';
f41f0342 37/**
38 * CRM_Core_DAO_Discount constructor.
39 */
e501603b
TO
40class CRM_Core_DAO_Discount extends CRM_Core_DAO {
41 /**
f41f0342 42 * Static instance to hold the table name.
e501603b
TO
43 *
44 * @var string
45 */
46 static $_tableName = 'civicrm_discount';
e501603b 47 /**
f41f0342 48 * Should CiviCRM log any modifications to this table in the civicrm_log table.
e501603b
TO
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 /**
f41f0342 90 * Class constructor.
e501603b
TO
91 */
92 function __construct() {
93 $this->__table = 'civicrm_discount';
94 parent::__construct();
95 }
96 /**
f41f0342 97 * Returns foreign keys and entity references.
e501603b
TO
98 *
99 * @return array
100 * [CRM_Core_Reference_Interface]
101 */
102 static function getReferenceColumns() {
346aaaba
TO
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']);
e501603b 108 }
346aaaba 109 return Civi::$statics[__CLASS__]['links'];
e501603b
TO
110 }
111 /**
112 * Returns all the column names of this table
113 *
114 * @return array
115 */
116 static function &fields() {
346aaaba
TO
117 if (!isset(Civi::$statics[__CLASS__]['fields'])) {
118 Civi::$statics[__CLASS__]['fields'] = array(
e501603b
TO
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,
522a26c9 125 'table_name' => 'civicrm_discount',
126 'entity' => 'Discount',
127 'bao' => 'CRM_Core_BAO_Discount',
6a7e5e5d 128 'localizable' => 0,
e501603b
TO
129 ) ,
130 'entity_table' => array(
131 'name' => 'entity_table',
132 'type' => CRM_Utils_Type::T_STRING,
133 'title' => ts('Entity Table') ,
134 'description' => 'physical tablename for entity being joined to discount, e.g. civicrm_event',
135 'maxlength' => 64,
136 'size' => CRM_Utils_Type::BIG,
522a26c9 137 'table_name' => 'civicrm_discount',
138 'entity' => 'Discount',
139 'bao' => 'CRM_Core_BAO_Discount',
6a7e5e5d 140 'localizable' => 0,
e501603b
TO
141 ) ,
142 'entity_id' => array(
143 'name' => 'entity_id',
144 'type' => CRM_Utils_Type::T_INT,
145 'title' => ts('Entity ID') ,
146 'description' => 'FK to entity table specified in entity_table column.',
147 'required' => true,
522a26c9 148 'table_name' => 'civicrm_discount',
149 'entity' => 'Discount',
150 'bao' => 'CRM_Core_BAO_Discount',
6a7e5e5d 151 'localizable' => 0,
e501603b
TO
152 ) ,
153 'participant_discount_name' => array(
154 'name' => 'price_set_id',
155 'type' => CRM_Utils_Type::T_INT,
156 'title' => ts('Discount Name') ,
157 'description' => 'FK to civicrm_price_set',
158 'required' => true,
159 'export' => true,
160 'where' => 'civicrm_discount.price_set_id',
161 'headerPattern' => '',
162 'dataPattern' => '',
522a26c9 163 'table_name' => 'civicrm_discount',
164 'entity' => 'Discount',
165 'bao' => 'CRM_Core_BAO_Discount',
6a7e5e5d 166 'localizable' => 0,
e501603b
TO
167 'FKClassName' => 'CRM_Price_DAO_PriceSet',
168 ) ,
169 'start_date' => array(
170 'name' => 'start_date',
171 'type' => CRM_Utils_Type::T_DATE,
172 'title' => ts('Discount Start Date') ,
173 'description' => 'Date when discount starts.',
522a26c9 174 'table_name' => 'civicrm_discount',
175 'entity' => 'Discount',
176 'bao' => 'CRM_Core_BAO_Discount',
6a7e5e5d 177 'localizable' => 0,
e501603b
TO
178 ) ,
179 'end_date' => array(
180 'name' => 'end_date',
181 'type' => CRM_Utils_Type::T_DATE,
182 'title' => ts('Discount End Date') ,
183 'description' => 'Date when discount ends.',
522a26c9 184 'table_name' => 'civicrm_discount',
185 'entity' => 'Discount',
186 'bao' => 'CRM_Core_BAO_Discount',
6a7e5e5d 187 'localizable' => 0,
e501603b
TO
188 ) ,
189 );
346aaaba 190 CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
e501603b 191 }
346aaaba 192 return Civi::$statics[__CLASS__]['fields'];
e501603b
TO
193 }
194 /**
bd8e0b14 195 * Return a mapping from field-name to the corresponding key (as used in fields()).
e501603b
TO
196 *
197 * @return array
bd8e0b14 198 * Array(string $name => string $uniqueName).
e501603b
TO
199 */
200 static function &fieldKeys() {
bd8e0b14
TO
201 if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
202 Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
e501603b 203 }
bd8e0b14 204 return Civi::$statics[__CLASS__]['fieldKeys'];
e501603b
TO
205 }
206 /**
207 * Returns the names of this table
208 *
209 * @return string
210 */
211 static function getTableName() {
212 return self::$_tableName;
213 }
214 /**
215 * Returns if this table needs to be logged
216 *
217 * @return boolean
218 */
219 function getLog() {
220 return self::$_log;
221 }
222 /**
223 * Returns the list of fields that can be imported
224 *
225 * @param bool $prefix
226 *
227 * @return array
228 */
229 static function &import($prefix = false) {
60808919
TO
230 $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'discount', $prefix, array());
231 return $r;
e501603b
TO
232 }
233 /**
234 * Returns the list of fields that can be exported
235 *
236 * @param bool $prefix
237 *
238 * @return array
239 */
240 static function &export($prefix = false) {
60808919
TO
241 $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'discount', $prefix, array());
242 return $r;
e501603b 243 }
e7a6b91a
AS
244 /**
245 * Returns the list of indices
246 */
247 public static function indices($localize = TRUE) {
248 $indices = array(
249 'index_entity' => array(
250 'name' => 'index_entity',
251 'field' => array(
252 0 => 'entity_table',
253 1 => 'entity_id',
254 ) ,
255 'localizable' => false,
256 'sig' => 'civicrm_discount::0::entity_table::entity_id',
257 ) ,
258 'index_entity_option_id' => array(
259 'name' => 'index_entity_option_id',
260 'field' => array(
261 0 => 'entity_table',
262 1 => 'entity_id',
263 2 => 'price_set_id',
264 ) ,
265 'localizable' => false,
266 'sig' => 'civicrm_discount::0::entity_table::entity_id::price_set_id',
267 ) ,
268 );
269 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
270 }
e501603b 271}