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