5 * @copyright CiviCRM LLC (c) 2004-2019
7 * Generated from xml/schema/CRM/Financial/PaymentProcessorType.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:b8290611e8abcbd771b1006fd34e3ec5)
13 * Database access object for the PaymentProcessorType entity.
15 class CRM_Financial_DAO_PaymentProcessorType
extends CRM_Core_DAO
{
18 * Static instance to hold the table name.
22 static $_tableName = 'civicrm_payment_processor_type';
25 * Should CiviCRM log any modifications to this table in the civicrm_log table.
32 * Payment Processor Type ID
39 * Payment Processor Name.
46 * Payment Processor Name.
53 * Payment Processor Description.
60 * Is this processor active?
67 * Is this processor the default?
76 public $user_name_label;
81 public $password_label;
86 public $signature_label;
91 public $subject_label;
101 public $url_site_default;
106 public $url_api_default;
111 public $url_recur_default;
116 public $url_button_default;
121 public $url_site_test_default;
126 public $url_api_test_default;
131 public $url_recur_test_default;
136 public $url_button_test_default;
139 * Billing Mode (deprecated)
143 public $billing_mode;
146 * Can process recurring contributions
153 * Payment Type: Credit or Debit (deprecated)
157 public $payment_type;
160 * Payment Instrument ID
164 public $payment_instrument_id;
169 public function __construct() {
170 $this->__table
= 'civicrm_payment_processor_type';
171 parent
::__construct();
175 * Returns all the column names of this table
179 public static function &fields() {
180 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
181 Civi
::$statics[__CLASS__
]['fields'] = [
184 'type' => CRM_Utils_Type
::T_INT
,
185 'title' => ts('Payment Processor Type ID'),
186 'description' => ts('Payment Processor Type ID'),
188 'table_name' => 'civicrm_payment_processor_type',
189 'entity' => 'PaymentProcessorType',
190 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
195 'type' => CRM_Utils_Type
::T_STRING
,
196 'title' => ts('Payment Processor variable name to be used in code'),
197 'description' => ts('Payment Processor Name.'),
199 'size' => CRM_Utils_Type
::BIG
,
200 'table_name' => 'civicrm_payment_processor_type',
201 'entity' => 'PaymentProcessorType',
202 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
207 'type' => CRM_Utils_Type
::T_STRING
,
208 'title' => ts('Payment Processor Title'),
209 'description' => ts('Payment Processor Name.'),
211 'size' => CRM_Utils_Type
::HUGE
,
212 'table_name' => 'civicrm_payment_processor_type',
213 'entity' => 'PaymentProcessorType',
214 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
218 'name' => 'description',
219 'type' => CRM_Utils_Type
::T_STRING
,
220 'title' => ts('Processor Type Description'),
221 'description' => ts('Payment Processor Description.'),
223 'size' => CRM_Utils_Type
::HUGE
,
224 'table_name' => 'civicrm_payment_processor_type',
225 'entity' => 'PaymentProcessorType',
226 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
230 'name' => 'is_active',
231 'type' => CRM_Utils_Type
::T_BOOLEAN
,
232 'title' => ts('Processor Type Is Active?'),
233 'description' => ts('Is this processor active?'),
234 'table_name' => 'civicrm_payment_processor_type',
235 'entity' => 'PaymentProcessorType',
236 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
240 'name' => 'is_default',
241 'type' => CRM_Utils_Type
::T_BOOLEAN
,
242 'title' => ts('Processor Type is Default?'),
243 'description' => ts('Is this processor the default?'),
244 'table_name' => 'civicrm_payment_processor_type',
245 'entity' => 'PaymentProcessorType',
246 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
249 'user_name_label' => [
250 'name' => 'user_name_label',
251 'type' => CRM_Utils_Type
::T_STRING
,
252 'title' => ts('Label for User Name if used'),
254 'size' => CRM_Utils_Type
::HUGE
,
255 'table_name' => 'civicrm_payment_processor_type',
256 'entity' => 'PaymentProcessorType',
257 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
260 'password_label' => [
261 'name' => 'password_label',
262 'type' => CRM_Utils_Type
::T_STRING
,
263 'title' => ts('Label for password'),
265 'size' => CRM_Utils_Type
::HUGE
,
266 'table_name' => 'civicrm_payment_processor_type',
267 'entity' => 'PaymentProcessorType',
268 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
271 'signature_label' => [
272 'name' => 'signature_label',
273 'type' => CRM_Utils_Type
::T_STRING
,
274 'title' => ts('Label for Signature'),
276 'size' => CRM_Utils_Type
::HUGE
,
277 'table_name' => 'civicrm_payment_processor_type',
278 'entity' => 'PaymentProcessorType',
279 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
283 'name' => 'subject_label',
284 'type' => CRM_Utils_Type
::T_STRING
,
285 'title' => ts('Label for Subject'),
287 'size' => CRM_Utils_Type
::HUGE
,
288 'table_name' => 'civicrm_payment_processor_type',
289 'entity' => 'PaymentProcessorType',
290 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
294 'name' => 'class_name',
295 'type' => CRM_Utils_Type
::T_STRING
,
296 'title' => ts('Suffix for PHP class name implementation'),
298 'size' => CRM_Utils_Type
::HUGE
,
299 'table_name' => 'civicrm_payment_processor_type',
300 'entity' => 'PaymentProcessorType',
301 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
304 'url_site_default' => [
305 'name' => 'url_site_default',
306 'type' => CRM_Utils_Type
::T_STRING
,
307 'title' => ts('Default Live Site URL'),
309 'size' => CRM_Utils_Type
::HUGE
,
310 'table_name' => 'civicrm_payment_processor_type',
311 'entity' => 'PaymentProcessorType',
312 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
315 'url_api_default' => [
316 'name' => 'url_api_default',
317 'type' => CRM_Utils_Type
::T_STRING
,
318 'title' => ts('Default API Site URL'),
320 'size' => CRM_Utils_Type
::HUGE
,
321 'table_name' => 'civicrm_payment_processor_type',
322 'entity' => 'PaymentProcessorType',
323 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
326 'url_recur_default' => [
327 'name' => 'url_recur_default',
328 'type' => CRM_Utils_Type
::T_STRING
,
329 'title' => ts('Default Live Recurring Payments URL'),
331 'size' => CRM_Utils_Type
::HUGE
,
332 'table_name' => 'civicrm_payment_processor_type',
333 'entity' => 'PaymentProcessorType',
334 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
337 'url_button_default' => [
338 'name' => 'url_button_default',
339 'type' => CRM_Utils_Type
::T_STRING
,
340 'title' => ts('Default Live Button URL'),
342 'size' => CRM_Utils_Type
::HUGE
,
343 'table_name' => 'civicrm_payment_processor_type',
344 'entity' => 'PaymentProcessorType',
345 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
348 'url_site_test_default' => [
349 'name' => 'url_site_test_default',
350 'type' => CRM_Utils_Type
::T_STRING
,
351 'title' => ts('Default Test Site URL'),
353 'size' => CRM_Utils_Type
::HUGE
,
354 'table_name' => 'civicrm_payment_processor_type',
355 'entity' => 'PaymentProcessorType',
356 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
359 'url_api_test_default' => [
360 'name' => 'url_api_test_default',
361 'type' => CRM_Utils_Type
::T_STRING
,
362 'title' => ts('Default Test API URL'),
364 'size' => CRM_Utils_Type
::HUGE
,
365 'table_name' => 'civicrm_payment_processor_type',
366 'entity' => 'PaymentProcessorType',
367 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
370 'url_recur_test_default' => [
371 'name' => 'url_recur_test_default',
372 'type' => CRM_Utils_Type
::T_STRING
,
373 'title' => ts('Default Test Recurring Payment URL'),
375 'size' => CRM_Utils_Type
::HUGE
,
376 'table_name' => 'civicrm_payment_processor_type',
377 'entity' => 'PaymentProcessorType',
378 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
381 'url_button_test_default' => [
382 'name' => 'url_button_test_default',
383 'type' => CRM_Utils_Type
::T_STRING
,
384 'title' => ts('Default Test Button URL'),
386 'size' => CRM_Utils_Type
::HUGE
,
387 'table_name' => 'civicrm_payment_processor_type',
388 'entity' => 'PaymentProcessorType',
389 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
393 'name' => 'billing_mode',
394 'type' => CRM_Utils_Type
::T_INT
,
395 'title' => ts('Billing Mode'),
396 'description' => ts('Billing Mode (deprecated)'),
398 'table_name' => 'civicrm_payment_processor_type',
399 'entity' => 'PaymentProcessorType',
400 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
405 'pseudoconstant' => [
406 'callback' => 'CRM_Core_SelectValues::billingMode',
410 'name' => 'is_recur',
411 'type' => CRM_Utils_Type
::T_BOOLEAN
,
412 'title' => ts('Processor Type Supports Recurring?'),
413 'description' => ts('Can process recurring contributions'),
414 'table_name' => 'civicrm_payment_processor_type',
415 'entity' => 'PaymentProcessorType',
416 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
420 'name' => 'payment_type',
421 'type' => CRM_Utils_Type
::T_INT
,
422 'title' => ts('Processor Type Payment Type'),
423 'description' => ts('Payment Type: Credit or Debit (deprecated)'),
425 'table_name' => 'civicrm_payment_processor_type',
426 'entity' => 'PaymentProcessorType',
427 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
430 'payment_instrument_id' => [
431 'name' => 'payment_instrument_id',
432 'type' => CRM_Utils_Type
::T_INT
,
433 'title' => ts('Payment Method'),
434 'description' => ts('Payment Instrument ID'),
436 'table_name' => 'civicrm_payment_processor_type',
437 'entity' => 'PaymentProcessorType',
438 'bao' => 'CRM_Financial_BAO_PaymentProcessorType',
440 'pseudoconstant' => [
441 'optionGroupName' => 'payment_instrument',
442 'optionEditPath' => 'civicrm/admin/options/payment_instrument',
446 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
448 return Civi
::$statics[__CLASS__
]['fields'];
452 * Return a mapping from field-name to the corresponding key (as used in fields()).
455 * Array(string $name => string $uniqueName).
457 public static function &fieldKeys() {
458 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
459 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
461 return Civi
::$statics[__CLASS__
]['fieldKeys'];
465 * Returns the names of this table
469 public static function getTableName() {
470 return self
::$_tableName;
474 * Returns if this table needs to be logged
478 public function getLog() {
483 * Returns the list of fields that can be imported
485 * @param bool $prefix
489 public static function &import($prefix = FALSE) {
490 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'payment_processor_type', $prefix, []);
495 * Returns the list of fields that can be exported
497 * @param bool $prefix
501 public static function &export($prefix = FALSE) {
502 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'payment_processor_type', $prefix, []);
507 * Returns the list of indices
509 * @param bool $localize
513 public static function indices($localize = TRUE) {
520 'localizable' => FALSE,
522 'sig' => 'civicrm_payment_processor_type::1::name',
525 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;