5 * @copyright CiviCRM LLC https://civicrm.org/licensing
7 * Generated from xml/schema/CRM/Financial/PaymentProcessorType.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:62dd4d3229f289de4afb3c5e3e39db66)
13 * Database access object for the PaymentProcessorType entity.
15 class CRM_Financial_DAO_PaymentProcessorType
extends CRM_Core_DAO
{
16 const EXT
= 'civicrm';
17 const TABLE_ADDED
= '1.8';
20 * Static instance to hold the table name.
24 public static $_tableName = 'civicrm_payment_processor_type';
27 * Should CiviCRM log any modifications to this table in the civicrm_log table.
31 public static $_log = FALSE;
34 * Payment Processor Type ID
41 * Payment Processor Type Name.
48 * Payment Processor Type Title.
55 * Payment Processor Description.
62 * Is this processor active?
69 * Is this processor the default?
78 public $user_name_label;
83 public $password_label;
88 public $signature_label;
93 public $subject_label;
103 public $url_site_default;
108 public $url_api_default;
113 public $url_recur_default;
118 public $url_button_default;
123 public $url_site_test_default;
128 public $url_api_test_default;
133 public $url_recur_test_default;
138 public $url_button_test_default;
141 * Billing Mode (deprecated)
145 public $billing_mode;
148 * Can process recurring contributions
155 * Payment Type: Credit or Debit (deprecated)
159 public $payment_type;
162 * Payment Instrument ID
166 public $payment_instrument_id;
171 public function __construct() {
172 $this->__table
= 'civicrm_payment_processor_type';
173 parent
::__construct();
177 * Returns localized title of this entity.
179 * @param bool $plural
180 * Whether to return the plural version of the title.
182 public static function getEntityTitle($plural = FALSE) {
183 return $plural ?
ts('Payment Processor Types') : ts('Payment Processor Type');
187 * Returns all the column names of this table
191 public static function &fields() {
192 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
193 Civi
::$statics[__CLASS__
]['fields'] = [
196 'type' => CRM_Utils_Type
::T_INT
,
197 'title' => ts('Payment Processor Type ID'),
198 'description' => ts('Payment Processor Type ID'),
200 'where' => 'civicrm_payment_processor_type.id',
201 'table_name' => 'civicrm_payment_processor_type',
202 'entity' => 'PaymentProcessorType',
203 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
209 'type' => CRM_Utils_Type
::T_STRING
,
210 'title' => ts('Payment Processor Type variable name to be used in code'),
211 'description' => ts('Payment Processor Type Name.'),
214 'size' => CRM_Utils_Type
::BIG
,
215 'where' => 'civicrm_payment_processor_type.name',
216 'table_name' => 'civicrm_payment_processor_type',
217 'entity' => 'PaymentProcessorType',
218 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
224 'type' => CRM_Utils_Type
::T_STRING
,
225 'title' => ts('Payment Processor Type Title'),
226 'description' => ts('Payment Processor Type Title.'),
229 'size' => CRM_Utils_Type
::HUGE
,
230 'where' => 'civicrm_payment_processor_type.title',
231 'table_name' => 'civicrm_payment_processor_type',
232 'entity' => 'PaymentProcessorType',
233 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
238 'name' => 'description',
239 'type' => CRM_Utils_Type
::T_STRING
,
240 'title' => ts('Processor Type Description'),
241 'description' => ts('Payment Processor Description.'),
243 'size' => CRM_Utils_Type
::HUGE
,
244 'where' => 'civicrm_payment_processor_type.description',
245 'table_name' => 'civicrm_payment_processor_type',
246 'entity' => 'PaymentProcessorType',
247 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
252 'name' => 'is_active',
253 'type' => CRM_Utils_Type
::T_BOOLEAN
,
254 'title' => ts('Processor Type Is Active?'),
255 'description' => ts('Is this processor active?'),
256 'where' => 'civicrm_payment_processor_type.is_active',
258 'table_name' => 'civicrm_payment_processor_type',
259 'entity' => 'PaymentProcessorType',
260 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
265 'name' => 'is_default',
266 'type' => CRM_Utils_Type
::T_BOOLEAN
,
267 'title' => ts('Processor Type is Default?'),
268 'description' => ts('Is this processor the default?'),
269 'where' => 'civicrm_payment_processor_type.is_default',
271 'table_name' => 'civicrm_payment_processor_type',
272 'entity' => 'PaymentProcessorType',
273 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
277 'user_name_label' => [
278 'name' => 'user_name_label',
279 'type' => CRM_Utils_Type
::T_STRING
,
280 'title' => ts('Label for User Name if used'),
282 'size' => CRM_Utils_Type
::HUGE
,
283 'where' => 'civicrm_payment_processor_type.user_name_label',
284 'table_name' => 'civicrm_payment_processor_type',
285 'entity' => 'PaymentProcessorType',
286 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
290 'password_label' => [
291 'name' => 'password_label',
292 'type' => CRM_Utils_Type
::T_STRING
,
293 'title' => ts('Label for password'),
295 'size' => CRM_Utils_Type
::HUGE
,
296 'where' => 'civicrm_payment_processor_type.password_label',
297 'table_name' => 'civicrm_payment_processor_type',
298 'entity' => 'PaymentProcessorType',
299 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
303 'signature_label' => [
304 'name' => 'signature_label',
305 'type' => CRM_Utils_Type
::T_STRING
,
306 'title' => ts('Label for Signature'),
308 'size' => CRM_Utils_Type
::HUGE
,
309 'where' => 'civicrm_payment_processor_type.signature_label',
310 'table_name' => 'civicrm_payment_processor_type',
311 'entity' => 'PaymentProcessorType',
312 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
317 'name' => 'subject_label',
318 'type' => CRM_Utils_Type
::T_STRING
,
319 'title' => ts('Label for Subject'),
321 'size' => CRM_Utils_Type
::HUGE
,
322 'where' => 'civicrm_payment_processor_type.subject_label',
323 'table_name' => 'civicrm_payment_processor_type',
324 'entity' => 'PaymentProcessorType',
325 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
330 'name' => 'class_name',
331 'type' => CRM_Utils_Type
::T_STRING
,
332 'title' => ts('Suffix for PHP class name implementation'),
335 'size' => CRM_Utils_Type
::HUGE
,
336 'where' => 'civicrm_payment_processor_type.class_name',
337 'table_name' => 'civicrm_payment_processor_type',
338 'entity' => 'PaymentProcessorType',
339 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
343 'url_site_default' => [
344 'name' => 'url_site_default',
345 'type' => CRM_Utils_Type
::T_STRING
,
346 'title' => ts('Default Live Site URL'),
348 'size' => CRM_Utils_Type
::HUGE
,
349 'where' => 'civicrm_payment_processor_type.url_site_default',
350 'table_name' => 'civicrm_payment_processor_type',
351 'entity' => 'PaymentProcessorType',
352 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
356 'url_api_default' => [
357 'name' => 'url_api_default',
358 'type' => CRM_Utils_Type
::T_STRING
,
359 'title' => ts('Default API Site URL'),
361 'size' => CRM_Utils_Type
::HUGE
,
362 'where' => 'civicrm_payment_processor_type.url_api_default',
363 'table_name' => 'civicrm_payment_processor_type',
364 'entity' => 'PaymentProcessorType',
365 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
369 'url_recur_default' => [
370 'name' => 'url_recur_default',
371 'type' => CRM_Utils_Type
::T_STRING
,
372 'title' => ts('Default Live Recurring Payments URL'),
374 'size' => CRM_Utils_Type
::HUGE
,
375 'where' => 'civicrm_payment_processor_type.url_recur_default',
376 'table_name' => 'civicrm_payment_processor_type',
377 'entity' => 'PaymentProcessorType',
378 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
382 'url_button_default' => [
383 'name' => 'url_button_default',
384 'type' => CRM_Utils_Type
::T_STRING
,
385 'title' => ts('Default Live Button URL'),
387 'size' => CRM_Utils_Type
::HUGE
,
388 'where' => 'civicrm_payment_processor_type.url_button_default',
389 'table_name' => 'civicrm_payment_processor_type',
390 'entity' => 'PaymentProcessorType',
391 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
395 'url_site_test_default' => [
396 'name' => 'url_site_test_default',
397 'type' => CRM_Utils_Type
::T_STRING
,
398 'title' => ts('Default Test Site URL'),
400 'size' => CRM_Utils_Type
::HUGE
,
401 'where' => 'civicrm_payment_processor_type.url_site_test_default',
402 'table_name' => 'civicrm_payment_processor_type',
403 'entity' => 'PaymentProcessorType',
404 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
408 'url_api_test_default' => [
409 'name' => 'url_api_test_default',
410 'type' => CRM_Utils_Type
::T_STRING
,
411 'title' => ts('Default Test API URL'),
413 'size' => CRM_Utils_Type
::HUGE
,
414 'where' => 'civicrm_payment_processor_type.url_api_test_default',
415 'table_name' => 'civicrm_payment_processor_type',
416 'entity' => 'PaymentProcessorType',
417 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
421 'url_recur_test_default' => [
422 'name' => 'url_recur_test_default',
423 'type' => CRM_Utils_Type
::T_STRING
,
424 'title' => ts('Default Test Recurring Payment URL'),
426 'size' => CRM_Utils_Type
::HUGE
,
427 'where' => 'civicrm_payment_processor_type.url_recur_test_default',
428 'table_name' => 'civicrm_payment_processor_type',
429 'entity' => 'PaymentProcessorType',
430 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
434 'url_button_test_default' => [
435 'name' => 'url_button_test_default',
436 'type' => CRM_Utils_Type
::T_STRING
,
437 'title' => ts('Default Test Button URL'),
439 'size' => CRM_Utils_Type
::HUGE
,
440 'where' => 'civicrm_payment_processor_type.url_button_test_default',
441 'table_name' => 'civicrm_payment_processor_type',
442 'entity' => 'PaymentProcessorType',
443 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
448 'name' => 'billing_mode',
449 'type' => CRM_Utils_Type
::T_INT
,
450 'title' => ts('Billing Mode'),
451 'description' => ts('Billing Mode (deprecated)'),
453 'where' => 'civicrm_payment_processor_type.billing_mode',
454 'table_name' => 'civicrm_payment_processor_type',
455 'entity' => 'PaymentProcessorType',
456 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
461 'pseudoconstant' => [
462 'callback' => 'CRM_Core_SelectValues::billingMode',
467 'name' => 'is_recur',
468 'type' => CRM_Utils_Type
::T_BOOLEAN
,
469 'title' => ts('Processor Type Supports Recurring?'),
470 'description' => ts('Can process recurring contributions'),
471 'where' => 'civicrm_payment_processor_type.is_recur',
472 'table_name' => 'civicrm_payment_processor_type',
473 'entity' => 'PaymentProcessorType',
474 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
479 'name' => 'payment_type',
480 'type' => CRM_Utils_Type
::T_INT
,
481 'title' => ts('Processor Type Payment Type'),
482 'description' => ts('Payment Type: Credit or Debit (deprecated)'),
483 'where' => 'civicrm_payment_processor_type.payment_type',
485 'table_name' => 'civicrm_payment_processor_type',
486 'entity' => 'PaymentProcessorType',
487 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
491 'payment_instrument_id' => [
492 'name' => 'payment_instrument_id',
493 'type' => CRM_Utils_Type
::T_INT
,
494 'title' => ts('Payment Method'),
495 'description' => ts('Payment Instrument ID'),
496 'where' => 'civicrm_payment_processor_type.payment_instrument_id',
498 'table_name' => 'civicrm_payment_processor_type',
499 'entity' => 'PaymentProcessorType',
500 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
502 'pseudoconstant' => [
503 'optionGroupName' => 'payment_instrument',
504 'optionEditPath' => 'civicrm/admin/options/payment_instrument',
509 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
511 return Civi
::$statics[__CLASS__
]['fields'];
515 * Return a mapping from field-name to the corresponding key (as used in fields()).
518 * Array(string $name => string $uniqueName).
520 public static function &fieldKeys() {
521 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
522 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
524 return Civi
::$statics[__CLASS__
]['fieldKeys'];
528 * Returns the names of this table
532 public static function getTableName() {
533 return self
::$_tableName;
537 * Returns if this table needs to be logged
541 public function getLog() {
546 * Returns the list of fields that can be imported
548 * @param bool $prefix
552 public static function &import($prefix = FALSE) {
553 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'payment_processor_type', $prefix, []);
558 * Returns the list of fields that can be exported
560 * @param bool $prefix
564 public static function &export($prefix = FALSE) {
565 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'payment_processor_type', $prefix, []);
570 * Returns the list of indices
572 * @param bool $localize
576 public static function indices($localize = TRUE) {
583 'localizable' => FALSE,
585 'sig' => 'civicrm_payment_processor_type::1::name',
588 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;