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