Merge pull request #14003 from seamuslee001/sl_fix_4_7_31_upgrade
[civicrm-core.git] / CRM / Financial / DAO / PaymentProcessorType.php
CommitLineData
e501603b 1<?php
c3fc2621 2
e501603b
TO
3/**
4 * @package CRM
6b83d5bd 5 * @copyright CiviCRM LLC (c) 2004-2019
e501603b
TO
6 *
7 * Generated from xml/schema/CRM/Financial/PaymentProcessorType.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
e380ee3b 9 * (GenCodeChecksum:b8290611e8abcbd771b1006fd34e3ec5)
e501603b 10 */
c3fc2621 11
f41f0342 12/**
c3fc2621 13 * Database access object for the PaymentProcessorType entity.
f41f0342 14 */
e501603b 15class CRM_Financial_DAO_PaymentProcessorType 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_payment_processor_type';
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 = FALSE;
c3fc2621 30
e501603b
TO
31 /**
32 * Payment Processor Type ID
33 *
34 * @var int unsigned
35 */
36 public $id;
c3fc2621 37
e501603b
TO
38 /**
39 * Payment Processor Name.
40 *
41 * @var string
42 */
43 public $name;
c3fc2621 44
e501603b
TO
45 /**
46 * Payment Processor Name.
47 *
48 * @var string
49 */
50 public $title;
c3fc2621 51
e501603b
TO
52 /**
53 * Payment Processor Description.
54 *
55 * @var string
56 */
57 public $description;
c3fc2621 58
e501603b
TO
59 /**
60 * Is this processor active?
61 *
62 * @var boolean
63 */
64 public $is_active;
c3fc2621 65
e501603b
TO
66 /**
67 * Is this processor the default?
68 *
69 * @var boolean
70 */
71 public $is_default;
c3fc2621 72
e501603b 73 /**
e501603b
TO
74 * @var string
75 */
76 public $user_name_label;
c3fc2621 77
e501603b 78 /**
e501603b
TO
79 * @var string
80 */
81 public $password_label;
c3fc2621 82
e501603b 83 /**
e501603b
TO
84 * @var string
85 */
86 public $signature_label;
c3fc2621 87
e501603b 88 /**
e501603b
TO
89 * @var string
90 */
91 public $subject_label;
c3fc2621 92
e501603b 93 /**
e501603b
TO
94 * @var string
95 */
96 public $class_name;
c3fc2621 97
e501603b 98 /**
e501603b
TO
99 * @var string
100 */
101 public $url_site_default;
c3fc2621 102
e501603b 103 /**
e501603b
TO
104 * @var string
105 */
106 public $url_api_default;
c3fc2621 107
e501603b 108 /**
e501603b
TO
109 * @var string
110 */
111 public $url_recur_default;
c3fc2621 112
e501603b 113 /**
e501603b
TO
114 * @var string
115 */
116 public $url_button_default;
c3fc2621 117
e501603b 118 /**
e501603b
TO
119 * @var string
120 */
121 public $url_site_test_default;
c3fc2621 122
e501603b 123 /**
e501603b
TO
124 * @var string
125 */
126 public $url_api_test_default;
c3fc2621 127
e501603b 128 /**
e501603b
TO
129 * @var string
130 */
131 public $url_recur_test_default;
c3fc2621 132
e501603b 133 /**
e501603b
TO
134 * @var string
135 */
136 public $url_button_test_default;
c3fc2621 137
e501603b
TO
138 /**
139 * Billing Mode (deprecated)
140 *
141 * @var int unsigned
142 */
143 public $billing_mode;
c3fc2621 144
e501603b
TO
145 /**
146 * Can process recurring contributions
147 *
148 * @var boolean
149 */
150 public $is_recur;
c3fc2621 151
e501603b
TO
152 /**
153 * Payment Type: Credit or Debit (deprecated)
154 *
155 * @var int unsigned
156 */
157 public $payment_type;
c3fc2621 158
e501603b
TO
159 /**
160 * Payment Instrument ID
161 *
162 * @var int unsigned
163 */
164 public $payment_instrument_id;
c3fc2621 165
e501603b 166 /**
f41f0342 167 * Class constructor.
e501603b 168 */
c3fc2621 169 public function __construct() {
e501603b
TO
170 $this->__table = 'civicrm_payment_processor_type';
171 parent::__construct();
172 }
c3fc2621 173
e501603b
TO
174 /**
175 * Returns all the column names of this table
176 *
177 * @return array
178 */
c3fc2621 179 public static function &fields() {
346aaaba 180 if (!isset(Civi::$statics[__CLASS__]['fields'])) {
c3fc2621
CW
181 Civi::$statics[__CLASS__]['fields'] = [
182 'id' => [
e501603b
TO
183 'name' => 'id',
184 'type' => CRM_Utils_Type::T_INT,
c3fc2621 185 'title' => ts('Payment Processor Type ID'),
215b423e 186 'description' => ts('Payment Processor Type ID'),
c3fc2621 187 'required' => TRUE,
522a26c9 188 'table_name' => 'civicrm_payment_processor_type',
189 'entity' => 'PaymentProcessorType',
190 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
6a7e5e5d 191 'localizable' => 0,
c3fc2621
CW
192 ],
193 'name' => [
e501603b
TO
194 'name' => 'name',
195 'type' => CRM_Utils_Type::T_STRING,
c3fc2621 196 'title' => ts('Payment Processor variable name to be used in code'),
215b423e 197 'description' => ts('Payment Processor Name.'),
e501603b
TO
198 'maxlength' => 64,
199 'size' => CRM_Utils_Type::BIG,
522a26c9 200 'table_name' => 'civicrm_payment_processor_type',
201 'entity' => 'PaymentProcessorType',
202 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
6a7e5e5d 203 'localizable' => 0,
c3fc2621
CW
204 ],
205 'title' => [
e501603b
TO
206 'name' => 'title',
207 'type' => CRM_Utils_Type::T_STRING,
c3fc2621 208 'title' => ts('Payment Processor Title'),
215b423e 209 'description' => ts('Payment Processor Name.'),
e501603b
TO
210 'maxlength' => 127,
211 'size' => CRM_Utils_Type::HUGE,
522a26c9 212 'table_name' => 'civicrm_payment_processor_type',
213 'entity' => 'PaymentProcessorType',
214 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
6a7e5e5d 215 'localizable' => 0,
c3fc2621
CW
216 ],
217 'description' => [
e501603b
TO
218 'name' => 'description',
219 'type' => CRM_Utils_Type::T_STRING,
c3fc2621 220 'title' => ts('Processor Type Description'),
215b423e 221 'description' => ts('Payment Processor Description.'),
e501603b
TO
222 'maxlength' => 255,
223 'size' => CRM_Utils_Type::HUGE,
522a26c9 224 'table_name' => 'civicrm_payment_processor_type',
225 'entity' => 'PaymentProcessorType',
226 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
6a7e5e5d 227 'localizable' => 0,
c3fc2621
CW
228 ],
229 'is_active' => [
e501603b
TO
230 'name' => 'is_active',
231 'type' => CRM_Utils_Type::T_BOOLEAN,
c3fc2621 232 'title' => ts('Processor Type Is Active?'),
215b423e 233 'description' => ts('Is this processor active?'),
522a26c9 234 'table_name' => 'civicrm_payment_processor_type',
235 'entity' => 'PaymentProcessorType',
236 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
6a7e5e5d 237 'localizable' => 0,
c3fc2621
CW
238 ],
239 'is_default' => [
e501603b
TO
240 'name' => 'is_default',
241 'type' => CRM_Utils_Type::T_BOOLEAN,
c3fc2621 242 'title' => ts('Processor Type is Default?'),
215b423e 243 'description' => ts('Is this processor the default?'),
522a26c9 244 'table_name' => 'civicrm_payment_processor_type',
245 'entity' => 'PaymentProcessorType',
246 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
6a7e5e5d 247 'localizable' => 0,
c3fc2621
CW
248 ],
249 'user_name_label' => [
e501603b
TO
250 'name' => 'user_name_label',
251 'type' => CRM_Utils_Type::T_STRING,
c3fc2621 252 'title' => ts('Label for User Name if used'),
e501603b
TO
253 'maxlength' => 255,
254 'size' => CRM_Utils_Type::HUGE,
522a26c9 255 'table_name' => 'civicrm_payment_processor_type',
256 'entity' => 'PaymentProcessorType',
257 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
6a7e5e5d 258 'localizable' => 0,
c3fc2621
CW
259 ],
260 'password_label' => [
e501603b
TO
261 'name' => 'password_label',
262 'type' => CRM_Utils_Type::T_STRING,
c3fc2621 263 'title' => ts('Label for password'),
e501603b
TO
264 'maxlength' => 255,
265 'size' => CRM_Utils_Type::HUGE,
522a26c9 266 'table_name' => 'civicrm_payment_processor_type',
267 'entity' => 'PaymentProcessorType',
268 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
6a7e5e5d 269 'localizable' => 0,
c3fc2621
CW
270 ],
271 'signature_label' => [
e501603b
TO
272 'name' => 'signature_label',
273 'type' => CRM_Utils_Type::T_STRING,
c3fc2621 274 'title' => ts('Label for Signature'),
e501603b
TO
275 'maxlength' => 255,
276 'size' => CRM_Utils_Type::HUGE,
522a26c9 277 'table_name' => 'civicrm_payment_processor_type',
278 'entity' => 'PaymentProcessorType',
279 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
6a7e5e5d 280 'localizable' => 0,
c3fc2621
CW
281 ],
282 'subject_label' => [
e501603b
TO
283 'name' => 'subject_label',
284 'type' => CRM_Utils_Type::T_STRING,
c3fc2621 285 'title' => ts('Label for Subject'),
e501603b
TO
286 'maxlength' => 255,
287 'size' => CRM_Utils_Type::HUGE,
522a26c9 288 'table_name' => 'civicrm_payment_processor_type',
289 'entity' => 'PaymentProcessorType',
290 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
6a7e5e5d 291 'localizable' => 0,
c3fc2621
CW
292 ],
293 'class_name' => [
e501603b
TO
294 'name' => 'class_name',
295 'type' => CRM_Utils_Type::T_STRING,
c3fc2621 296 'title' => ts('Suffix for PHP class name implementation'),
e501603b
TO
297 'maxlength' => 255,
298 'size' => CRM_Utils_Type::HUGE,
522a26c9 299 'table_name' => 'civicrm_payment_processor_type',
300 'entity' => 'PaymentProcessorType',
301 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
6a7e5e5d 302 'localizable' => 0,
c3fc2621
CW
303 ],
304 'url_site_default' => [
e501603b
TO
305 'name' => 'url_site_default',
306 'type' => CRM_Utils_Type::T_STRING,
c3fc2621 307 'title' => ts('Default Live Site URL'),
e501603b
TO
308 'maxlength' => 255,
309 'size' => CRM_Utils_Type::HUGE,
522a26c9 310 'table_name' => 'civicrm_payment_processor_type',
311 'entity' => 'PaymentProcessorType',
312 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
6a7e5e5d 313 'localizable' => 0,
c3fc2621
CW
314 ],
315 'url_api_default' => [
e501603b
TO
316 'name' => 'url_api_default',
317 'type' => CRM_Utils_Type::T_STRING,
c3fc2621 318 'title' => ts('Default API Site URL'),
e501603b
TO
319 'maxlength' => 255,
320 'size' => CRM_Utils_Type::HUGE,
522a26c9 321 'table_name' => 'civicrm_payment_processor_type',
322 'entity' => 'PaymentProcessorType',
323 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
6a7e5e5d 324 'localizable' => 0,
c3fc2621
CW
325 ],
326 'url_recur_default' => [
e501603b
TO
327 'name' => 'url_recur_default',
328 'type' => CRM_Utils_Type::T_STRING,
c3fc2621 329 'title' => ts('Default Live Recurring Payments URL'),
e501603b
TO
330 'maxlength' => 255,
331 'size' => CRM_Utils_Type::HUGE,
522a26c9 332 'table_name' => 'civicrm_payment_processor_type',
333 'entity' => 'PaymentProcessorType',
334 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
6a7e5e5d 335 'localizable' => 0,
c3fc2621
CW
336 ],
337 'url_button_default' => [
e501603b
TO
338 'name' => 'url_button_default',
339 'type' => CRM_Utils_Type::T_STRING,
c3fc2621 340 'title' => ts('Default Live Button URL'),
e501603b
TO
341 'maxlength' => 255,
342 'size' => CRM_Utils_Type::HUGE,
522a26c9 343 'table_name' => 'civicrm_payment_processor_type',
344 'entity' => 'PaymentProcessorType',
345 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
6a7e5e5d 346 'localizable' => 0,
c3fc2621
CW
347 ],
348 'url_site_test_default' => [
e501603b
TO
349 'name' => 'url_site_test_default',
350 'type' => CRM_Utils_Type::T_STRING,
c3fc2621 351 'title' => ts('Default Test Site URL'),
e501603b
TO
352 'maxlength' => 255,
353 'size' => CRM_Utils_Type::HUGE,
522a26c9 354 'table_name' => 'civicrm_payment_processor_type',
355 'entity' => 'PaymentProcessorType',
356 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
6a7e5e5d 357 'localizable' => 0,
c3fc2621
CW
358 ],
359 'url_api_test_default' => [
e501603b
TO
360 'name' => 'url_api_test_default',
361 'type' => CRM_Utils_Type::T_STRING,
c3fc2621 362 'title' => ts('Default Test API URL'),
e501603b
TO
363 'maxlength' => 255,
364 'size' => CRM_Utils_Type::HUGE,
522a26c9 365 'table_name' => 'civicrm_payment_processor_type',
366 'entity' => 'PaymentProcessorType',
367 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
6a7e5e5d 368 'localizable' => 0,
c3fc2621
CW
369 ],
370 'url_recur_test_default' => [
e501603b
TO
371 'name' => 'url_recur_test_default',
372 'type' => CRM_Utils_Type::T_STRING,
c3fc2621 373 'title' => ts('Default Test Recurring Payment URL'),
e501603b
TO
374 'maxlength' => 255,
375 'size' => CRM_Utils_Type::HUGE,
522a26c9 376 'table_name' => 'civicrm_payment_processor_type',
377 'entity' => 'PaymentProcessorType',
378 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
6a7e5e5d 379 'localizable' => 0,
c3fc2621
CW
380 ],
381 'url_button_test_default' => [
e501603b
TO
382 'name' => 'url_button_test_default',
383 'type' => CRM_Utils_Type::T_STRING,
c3fc2621 384 'title' => ts('Default Test Button URL'),
e501603b
TO
385 'maxlength' => 255,
386 'size' => CRM_Utils_Type::HUGE,
522a26c9 387 'table_name' => 'civicrm_payment_processor_type',
388 'entity' => 'PaymentProcessorType',
389 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
6a7e5e5d 390 'localizable' => 0,
c3fc2621
CW
391 ],
392 'billing_mode' => [
e501603b
TO
393 'name' => 'billing_mode',
394 'type' => CRM_Utils_Type::T_INT,
c3fc2621 395 'title' => ts('Billing Mode'),
215b423e 396 'description' => ts('Billing Mode (deprecated)'),
c3fc2621 397 'required' => TRUE,
522a26c9 398 'table_name' => 'civicrm_payment_processor_type',
399 'entity' => 'PaymentProcessorType',
400 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
6a7e5e5d 401 'localizable' => 0,
c3fc2621 402 'html' => [
e501603b 403 'type' => 'Select',
c3fc2621
CW
404 ],
405 'pseudoconstant' => [
e501603b 406 'callback' => 'CRM_Core_SelectValues::billingMode',
c3fc2621
CW
407 ]
408 ],
409 'is_recur' => [
e501603b
TO
410 'name' => 'is_recur',
411 'type' => CRM_Utils_Type::T_BOOLEAN,
c3fc2621 412 'title' => ts('Processor Type Supports Recurring?'),
215b423e 413 'description' => ts('Can process recurring contributions'),
522a26c9 414 'table_name' => 'civicrm_payment_processor_type',
415 'entity' => 'PaymentProcessorType',
416 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
6a7e5e5d 417 'localizable' => 0,
c3fc2621
CW
418 ],
419 'payment_type' => [
e501603b
TO
420 'name' => 'payment_type',
421 'type' => CRM_Utils_Type::T_INT,
c3fc2621 422 'title' => ts('Processor Type Payment Type'),
215b423e 423 'description' => ts('Payment Type: Credit or Debit (deprecated)'),
e501603b 424 'default' => '1',
522a26c9 425 'table_name' => 'civicrm_payment_processor_type',
426 'entity' => 'PaymentProcessorType',
427 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
6a7e5e5d 428 'localizable' => 0,
c3fc2621
CW
429 ],
430 'payment_instrument_id' => [
e501603b
TO
431 'name' => 'payment_instrument_id',
432 'type' => CRM_Utils_Type::T_INT,
c3fc2621 433 'title' => ts('Payment Method'),
215b423e 434 'description' => ts('Payment Instrument ID'),
e501603b 435 'default' => '1',
522a26c9 436 'table_name' => 'civicrm_payment_processor_type',
437 'entity' => 'PaymentProcessorType',
438 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
6a7e5e5d 439 'localizable' => 0,
c3fc2621 440 'pseudoconstant' => [
e501603b
TO
441 'optionGroupName' => 'payment_instrument',
442 'optionEditPath' => 'civicrm/admin/options/payment_instrument',
c3fc2621
CW
443 ]
444 ],
445 ];
346aaaba 446 CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
e501603b 447 }
346aaaba 448 return Civi::$statics[__CLASS__]['fields'];
e501603b 449 }
c3fc2621 450
e501603b 451 /**
bd8e0b14 452 * Return a mapping from field-name to the corresponding key (as used in fields()).
e501603b
TO
453 *
454 * @return array
bd8e0b14 455 * Array(string $name => string $uniqueName).
e501603b 456 */
c3fc2621 457 public static function &fieldKeys() {
bd8e0b14
TO
458 if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
459 Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
e501603b 460 }
bd8e0b14 461 return Civi::$statics[__CLASS__]['fieldKeys'];
e501603b 462 }
c3fc2621 463
e501603b
TO
464 /**
465 * Returns the names of this table
466 *
467 * @return string
468 */
c3fc2621 469 public static function getTableName() {
e501603b
TO
470 return self::$_tableName;
471 }
c3fc2621 472
e501603b
TO
473 /**
474 * Returns if this table needs to be logged
475 *
c3fc2621 476 * @return bool
e501603b 477 */
c3fc2621 478 public function getLog() {
e501603b
TO
479 return self::$_log;
480 }
c3fc2621 481
e501603b
TO
482 /**
483 * Returns the list of fields that can be imported
484 *
485 * @param bool $prefix
486 *
487 * @return array
488 */
c3fc2621
CW
489 public static function &import($prefix = FALSE) {
490 $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'payment_processor_type', $prefix, []);
60808919 491 return $r;
e501603b 492 }
c3fc2621 493
e501603b
TO
494 /**
495 * Returns the list of fields that can be exported
496 *
497 * @param bool $prefix
498 *
499 * @return array
500 */
c3fc2621
CW
501 public static function &export($prefix = FALSE) {
502 $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'payment_processor_type', $prefix, []);
60808919 503 return $r;
e501603b 504 }
c3fc2621 505
e7a6b91a
AS
506 /**
507 * Returns the list of indices
c3fc2621
CW
508 *
509 * @param bool $localize
510 *
511 * @return array
e7a6b91a
AS
512 */
513 public static function indices($localize = TRUE) {
c3fc2621
CW
514 $indices = [
515 'UI_name' => [
e7a6b91a 516 'name' => 'UI_name',
c3fc2621 517 'field' => [
e7a6b91a 518 0 => 'name',
c3fc2621
CW
519 ],
520 'localizable' => FALSE,
521 'unique' => TRUE,
e7a6b91a 522 'sig' => 'civicrm_payment_processor_type::1::name',
c3fc2621
CW
523 ],
524 ];
e7a6b91a
AS
525 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
526 }
c3fc2621 527
e501603b 528}