561 lines
18 KiB
PHP
561 lines
18 KiB
PHP
<?php
|
|
/*
|
|
+--------------------------------------------------------------------+
|
|
| CiviCRM version 4.7 |
|
|
+--------------------------------------------------------------------+
|
|
| Copyright CiviCRM LLC (c) 2004-2017 |
|
|
+--------------------------------------------------------------------+
|
|
| This file is a part of CiviCRM. |
|
|
| |
|
|
| CiviCRM is free software; you can copy, modify, and distribute it |
|
|
| under the terms of the GNU Affero General Public License |
|
|
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
|
|
| |
|
|
| CiviCRM is distributed in the hope that it will be useful, but |
|
|
| WITHOUT ANY WARRANTY; without even the implied warranty of |
|
|
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
|
|
| See the GNU Affero General Public License for more details. |
|
|
| |
|
|
| You should have received a copy of the GNU Affero General Public |
|
|
| License and the CiviCRM Licensing Exception along |
|
|
| with this program; if not, contact CiviCRM LLC |
|
|
| at info[AT]civicrm[DOT]org. If you have questions about the |
|
|
| GNU Affero General Public License or the licensing of CiviCRM, |
|
|
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
|
|
+--------------------------------------------------------------------+
|
|
*/
|
|
/**
|
|
* @package CRM
|
|
* @copyright CiviCRM LLC (c) 2004-2017
|
|
*
|
|
* Generated from xml/schema/CRM/Financial/PaymentProcessor.xml
|
|
* DO NOT EDIT. Generated by CRM_Core_CodeGen
|
|
* (GenCodeChecksum:223b44e4b9e2994f724d2dbd79f575e4)
|
|
*/
|
|
require_once 'CRM/Core/DAO.php';
|
|
require_once 'CRM/Utils/Type.php';
|
|
/**
|
|
* CRM_Financial_DAO_PaymentProcessor constructor.
|
|
*/
|
|
class CRM_Financial_DAO_PaymentProcessor extends CRM_Core_DAO {
|
|
/**
|
|
* Static instance to hold the table name.
|
|
*
|
|
* @var string
|
|
*/
|
|
static $_tableName = 'civicrm_payment_processor';
|
|
/**
|
|
* Should CiviCRM log any modifications to this table in the civicrm_log table.
|
|
*
|
|
* @var boolean
|
|
*/
|
|
static $_log = false;
|
|
/**
|
|
* Payment Processor ID
|
|
*
|
|
* @var int unsigned
|
|
*/
|
|
public $id;
|
|
/**
|
|
* Which Domain is this match entry for
|
|
*
|
|
* @var int unsigned
|
|
*/
|
|
public $domain_id;
|
|
/**
|
|
* Payment Processor Name.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $name;
|
|
/**
|
|
* Payment Processor Description.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $description;
|
|
/**
|
|
*
|
|
* @var int unsigned
|
|
*/
|
|
public $payment_processor_type_id;
|
|
/**
|
|
* Is this processor active?
|
|
*
|
|
* @var boolean
|
|
*/
|
|
public $is_active;
|
|
/**
|
|
* Is this processor the default?
|
|
*
|
|
* @var boolean
|
|
*/
|
|
public $is_default;
|
|
/**
|
|
* Is this processor for a test site?
|
|
*
|
|
* @var boolean
|
|
*/
|
|
public $is_test;
|
|
/**
|
|
*
|
|
* @var string
|
|
*/
|
|
public $user_name;
|
|
/**
|
|
*
|
|
* @var string
|
|
*/
|
|
public $password;
|
|
/**
|
|
*
|
|
* @var text
|
|
*/
|
|
public $signature;
|
|
/**
|
|
*
|
|
* @var string
|
|
*/
|
|
public $url_site;
|
|
/**
|
|
*
|
|
* @var string
|
|
*/
|
|
public $url_api;
|
|
/**
|
|
*
|
|
* @var string
|
|
*/
|
|
public $url_recur;
|
|
/**
|
|
*
|
|
* @var string
|
|
*/
|
|
public $url_button;
|
|
/**
|
|
*
|
|
* @var string
|
|
*/
|
|
public $subject;
|
|
/**
|
|
*
|
|
* @var string
|
|
*/
|
|
public $class_name;
|
|
/**
|
|
* Billing Mode (deprecated)
|
|
*
|
|
* @var int unsigned
|
|
*/
|
|
public $billing_mode;
|
|
/**
|
|
* Can process recurring contributions
|
|
*
|
|
* @var boolean
|
|
*/
|
|
public $is_recur;
|
|
/**
|
|
* Payment Type: Credit or Debit (deprecated)
|
|
*
|
|
* @var int unsigned
|
|
*/
|
|
public $payment_type;
|
|
/**
|
|
* Payment Instrument ID
|
|
*
|
|
* @var int unsigned
|
|
*/
|
|
public $payment_instrument_id;
|
|
/**
|
|
* array of accepted credit card types
|
|
*
|
|
* @var text
|
|
*/
|
|
public $accepted_credit_cards;
|
|
/**
|
|
* Class constructor.
|
|
*/
|
|
function __construct() {
|
|
$this->__table = 'civicrm_payment_processor';
|
|
parent::__construct();
|
|
}
|
|
/**
|
|
* Returns foreign keys and entity references.
|
|
*
|
|
* @return array
|
|
* [CRM_Core_Reference_Interface]
|
|
*/
|
|
static function getReferenceColumns() {
|
|
if (!isset(Civi::$statics[__CLASS__]['links'])) {
|
|
Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
|
|
Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'domain_id', 'civicrm_domain', 'id');
|
|
Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'payment_processor_type_id', 'civicrm_payment_processor_type', 'id');
|
|
CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
|
|
}
|
|
return Civi::$statics[__CLASS__]['links'];
|
|
}
|
|
/**
|
|
* Returns all the column names of this table
|
|
*
|
|
* @return array
|
|
*/
|
|
static function &fields() {
|
|
if (!isset(Civi::$statics[__CLASS__]['fields'])) {
|
|
Civi::$statics[__CLASS__]['fields'] = array(
|
|
'id' => array(
|
|
'name' => 'id',
|
|
'type' => CRM_Utils_Type::T_INT,
|
|
'title' => ts('Payment Processor ID') ,
|
|
'description' => 'Payment Processor ID',
|
|
'required' => true,
|
|
'table_name' => 'civicrm_payment_processor',
|
|
'entity' => 'PaymentProcessor',
|
|
'bao' => 'CRM_Financial_BAO_PaymentProcessor',
|
|
'localizable' => 0,
|
|
) ,
|
|
'domain_id' => array(
|
|
'name' => 'domain_id',
|
|
'type' => CRM_Utils_Type::T_INT,
|
|
'title' => ts('Payment Processor Domain') ,
|
|
'description' => 'Which Domain is this match entry for',
|
|
'required' => true,
|
|
'table_name' => 'civicrm_payment_processor',
|
|
'entity' => 'PaymentProcessor',
|
|
'bao' => 'CRM_Financial_BAO_PaymentProcessor',
|
|
'localizable' => 0,
|
|
'FKClassName' => 'CRM_Core_DAO_Domain',
|
|
'pseudoconstant' => array(
|
|
'table' => 'civicrm_domain',
|
|
'keyColumn' => 'id',
|
|
'labelColumn' => 'name',
|
|
)
|
|
) ,
|
|
'name' => array(
|
|
'name' => 'name',
|
|
'type' => CRM_Utils_Type::T_STRING,
|
|
'title' => ts('Payment Processor') ,
|
|
'description' => 'Payment Processor Name.',
|
|
'maxlength' => 64,
|
|
'size' => CRM_Utils_Type::BIG,
|
|
'table_name' => 'civicrm_payment_processor',
|
|
'entity' => 'PaymentProcessor',
|
|
'bao' => 'CRM_Financial_BAO_PaymentProcessor',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Text',
|
|
) ,
|
|
) ,
|
|
'description' => array(
|
|
'name' => 'description',
|
|
'type' => CRM_Utils_Type::T_STRING,
|
|
'title' => ts('Processor Description') ,
|
|
'description' => 'Payment Processor Description.',
|
|
'maxlength' => 255,
|
|
'size' => CRM_Utils_Type::HUGE,
|
|
'table_name' => 'civicrm_payment_processor',
|
|
'entity' => 'PaymentProcessor',
|
|
'bao' => 'CRM_Financial_BAO_PaymentProcessor',
|
|
'localizable' => 0,
|
|
) ,
|
|
'payment_processor_type_id' => array(
|
|
'name' => 'payment_processor_type_id',
|
|
'type' => CRM_Utils_Type::T_INT,
|
|
'title' => ts('Payment Processor Type ID') ,
|
|
'table_name' => 'civicrm_payment_processor',
|
|
'entity' => 'PaymentProcessor',
|
|
'bao' => 'CRM_Financial_BAO_PaymentProcessor',
|
|
'localizable' => 0,
|
|
'FKClassName' => 'CRM_Financial_DAO_PaymentProcessorType',
|
|
'pseudoconstant' => array(
|
|
'table' => 'civicrm_payment_processor_type',
|
|
'keyColumn' => 'id',
|
|
'labelColumn' => 'title',
|
|
)
|
|
) ,
|
|
'is_active' => array(
|
|
'name' => 'is_active',
|
|
'type' => CRM_Utils_Type::T_BOOLEAN,
|
|
'title' => ts('Processor is Active?') ,
|
|
'description' => 'Is this processor active?',
|
|
'table_name' => 'civicrm_payment_processor',
|
|
'entity' => 'PaymentProcessor',
|
|
'bao' => 'CRM_Financial_BAO_PaymentProcessor',
|
|
'localizable' => 0,
|
|
) ,
|
|
'is_default' => array(
|
|
'name' => 'is_default',
|
|
'type' => CRM_Utils_Type::T_BOOLEAN,
|
|
'title' => ts('Processor Is Default?') ,
|
|
'description' => 'Is this processor the default?',
|
|
'table_name' => 'civicrm_payment_processor',
|
|
'entity' => 'PaymentProcessor',
|
|
'bao' => 'CRM_Financial_BAO_PaymentProcessor',
|
|
'localizable' => 0,
|
|
) ,
|
|
'is_test' => array(
|
|
'name' => 'is_test',
|
|
'type' => CRM_Utils_Type::T_BOOLEAN,
|
|
'title' => ts('Is Test Processor?') ,
|
|
'description' => 'Is this processor for a test site?',
|
|
'table_name' => 'civicrm_payment_processor',
|
|
'entity' => 'PaymentProcessor',
|
|
'bao' => 'CRM_Financial_BAO_PaymentProcessor',
|
|
'localizable' => 0,
|
|
) ,
|
|
'user_name' => array(
|
|
'name' => 'user_name',
|
|
'type' => CRM_Utils_Type::T_STRING,
|
|
'title' => ts('User Name') ,
|
|
'maxlength' => 255,
|
|
'size' => CRM_Utils_Type::HUGE,
|
|
'table_name' => 'civicrm_payment_processor',
|
|
'entity' => 'PaymentProcessor',
|
|
'bao' => 'CRM_Financial_BAO_PaymentProcessor',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Text',
|
|
) ,
|
|
) ,
|
|
'password' => array(
|
|
'name' => 'password',
|
|
'type' => CRM_Utils_Type::T_STRING,
|
|
'title' => ts('Password') ,
|
|
'maxlength' => 255,
|
|
'size' => CRM_Utils_Type::HUGE,
|
|
'table_name' => 'civicrm_payment_processor',
|
|
'entity' => 'PaymentProcessor',
|
|
'bao' => 'CRM_Financial_BAO_PaymentProcessor',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Password',
|
|
) ,
|
|
) ,
|
|
'signature' => array(
|
|
'name' => 'signature',
|
|
'type' => CRM_Utils_Type::T_TEXT,
|
|
'title' => ts('Signature') ,
|
|
'rows' => 4,
|
|
'cols' => 40,
|
|
'table_name' => 'civicrm_payment_processor',
|
|
'entity' => 'PaymentProcessor',
|
|
'bao' => 'CRM_Financial_BAO_PaymentProcessor',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'TextArea',
|
|
) ,
|
|
) ,
|
|
'url_site' => array(
|
|
'name' => 'url_site',
|
|
'type' => CRM_Utils_Type::T_STRING,
|
|
'title' => ts('Site URL') ,
|
|
'maxlength' => 255,
|
|
'size' => CRM_Utils_Type::HUGE,
|
|
'table_name' => 'civicrm_payment_processor',
|
|
'entity' => 'PaymentProcessor',
|
|
'bao' => 'CRM_Financial_BAO_PaymentProcessor',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Text',
|
|
) ,
|
|
) ,
|
|
'url_api' => array(
|
|
'name' => 'url_api',
|
|
'type' => CRM_Utils_Type::T_STRING,
|
|
'title' => ts('API URL') ,
|
|
'maxlength' => 255,
|
|
'size' => CRM_Utils_Type::HUGE,
|
|
'table_name' => 'civicrm_payment_processor',
|
|
'entity' => 'PaymentProcessor',
|
|
'bao' => 'CRM_Financial_BAO_PaymentProcessor',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Text',
|
|
) ,
|
|
) ,
|
|
'url_recur' => array(
|
|
'name' => 'url_recur',
|
|
'type' => CRM_Utils_Type::T_STRING,
|
|
'title' => ts('Recurring Payments URL') ,
|
|
'maxlength' => 255,
|
|
'size' => CRM_Utils_Type::HUGE,
|
|
'table_name' => 'civicrm_payment_processor',
|
|
'entity' => 'PaymentProcessor',
|
|
'bao' => 'CRM_Financial_BAO_PaymentProcessor',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Text',
|
|
) ,
|
|
) ,
|
|
'url_button' => array(
|
|
'name' => 'url_button',
|
|
'type' => CRM_Utils_Type::T_STRING,
|
|
'title' => ts('Button URL') ,
|
|
'maxlength' => 255,
|
|
'size' => CRM_Utils_Type::HUGE,
|
|
'table_name' => 'civicrm_payment_processor',
|
|
'entity' => 'PaymentProcessor',
|
|
'bao' => 'CRM_Financial_BAO_PaymentProcessor',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Text',
|
|
) ,
|
|
) ,
|
|
'subject' => array(
|
|
'name' => 'subject',
|
|
'type' => CRM_Utils_Type::T_STRING,
|
|
'title' => ts('Subject') ,
|
|
'maxlength' => 255,
|
|
'size' => CRM_Utils_Type::HUGE,
|
|
'table_name' => 'civicrm_payment_processor',
|
|
'entity' => 'PaymentProcessor',
|
|
'bao' => 'CRM_Financial_BAO_PaymentProcessor',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Text',
|
|
) ,
|
|
) ,
|
|
'class_name' => array(
|
|
'name' => 'class_name',
|
|
'type' => CRM_Utils_Type::T_STRING,
|
|
'title' => ts('Suffix for PHP class name implementation') ,
|
|
'maxlength' => 255,
|
|
'size' => CRM_Utils_Type::HUGE,
|
|
'table_name' => 'civicrm_payment_processor',
|
|
'entity' => 'PaymentProcessor',
|
|
'bao' => 'CRM_Financial_BAO_PaymentProcessor',
|
|
'localizable' => 0,
|
|
) ,
|
|
'billing_mode' => array(
|
|
'name' => 'billing_mode',
|
|
'type' => CRM_Utils_Type::T_INT,
|
|
'title' => ts('Processor Billing Mode') ,
|
|
'description' => 'Billing Mode (deprecated)',
|
|
'required' => true,
|
|
'table_name' => 'civicrm_payment_processor',
|
|
'entity' => 'PaymentProcessor',
|
|
'bao' => 'CRM_Financial_BAO_PaymentProcessor',
|
|
'localizable' => 0,
|
|
) ,
|
|
'is_recur' => array(
|
|
'name' => 'is_recur',
|
|
'type' => CRM_Utils_Type::T_BOOLEAN,
|
|
'title' => ts('Processor Supports Recurring?') ,
|
|
'description' => 'Can process recurring contributions',
|
|
'table_name' => 'civicrm_payment_processor',
|
|
'entity' => 'PaymentProcessor',
|
|
'bao' => 'CRM_Financial_BAO_PaymentProcessor',
|
|
'localizable' => 0,
|
|
) ,
|
|
'payment_type' => array(
|
|
'name' => 'payment_type',
|
|
'type' => CRM_Utils_Type::T_INT,
|
|
'title' => ts('Payment Type') ,
|
|
'description' => 'Payment Type: Credit or Debit (deprecated)',
|
|
'default' => '1',
|
|
'table_name' => 'civicrm_payment_processor',
|
|
'entity' => 'PaymentProcessor',
|
|
'bao' => 'CRM_Financial_BAO_PaymentProcessor',
|
|
'localizable' => 0,
|
|
) ,
|
|
'payment_instrument_id' => array(
|
|
'name' => 'payment_instrument_id',
|
|
'type' => CRM_Utils_Type::T_INT,
|
|
'title' => ts('Payment Method') ,
|
|
'description' => 'Payment Instrument ID',
|
|
'default' => '1',
|
|
'table_name' => 'civicrm_payment_processor',
|
|
'entity' => 'PaymentProcessor',
|
|
'bao' => 'CRM_Financial_BAO_PaymentProcessor',
|
|
'localizable' => 0,
|
|
'pseudoconstant' => array(
|
|
'optionGroupName' => 'payment_instrument',
|
|
'optionEditPath' => 'civicrm/admin/options/payment_instrument',
|
|
)
|
|
) ,
|
|
'accepted_credit_cards' => array(
|
|
'name' => 'accepted_credit_cards',
|
|
'type' => CRM_Utils_Type::T_TEXT,
|
|
'title' => ts('Accepted Credit Cards') ,
|
|
'description' => 'array of accepted credit card types',
|
|
'default' => 'NULL',
|
|
'table_name' => 'civicrm_payment_processor',
|
|
'entity' => 'PaymentProcessor',
|
|
'bao' => 'CRM_Financial_BAO_PaymentProcessor',
|
|
'localizable' => 0,
|
|
) ,
|
|
);
|
|
CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
|
|
}
|
|
return Civi::$statics[__CLASS__]['fields'];
|
|
}
|
|
/**
|
|
* Return a mapping from field-name to the corresponding key (as used in fields()).
|
|
*
|
|
* @return array
|
|
* Array(string $name => string $uniqueName).
|
|
*/
|
|
static function &fieldKeys() {
|
|
if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
|
|
Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
|
|
}
|
|
return Civi::$statics[__CLASS__]['fieldKeys'];
|
|
}
|
|
/**
|
|
* Returns the names of this table
|
|
*
|
|
* @return string
|
|
*/
|
|
static function getTableName() {
|
|
return self::$_tableName;
|
|
}
|
|
/**
|
|
* Returns if this table needs to be logged
|
|
*
|
|
* @return boolean
|
|
*/
|
|
function getLog() {
|
|
return self::$_log;
|
|
}
|
|
/**
|
|
* Returns the list of fields that can be imported
|
|
*
|
|
* @param bool $prefix
|
|
*
|
|
* @return array
|
|
*/
|
|
static function &import($prefix = false) {
|
|
$r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'payment_processor', $prefix, array());
|
|
return $r;
|
|
}
|
|
/**
|
|
* Returns the list of fields that can be exported
|
|
*
|
|
* @param bool $prefix
|
|
*
|
|
* @return array
|
|
*/
|
|
static function &export($prefix = false) {
|
|
$r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'payment_processor', $prefix, array());
|
|
return $r;
|
|
}
|
|
/**
|
|
* Returns the list of indices
|
|
*/
|
|
public static function indices($localize = TRUE) {
|
|
$indices = array(
|
|
'UI_name_test_domain_id' => array(
|
|
'name' => 'UI_name_test_domain_id',
|
|
'field' => array(
|
|
0 => 'name',
|
|
1 => 'is_test',
|
|
2 => 'domain_id',
|
|
) ,
|
|
'localizable' => false,
|
|
'unique' => true,
|
|
'sig' => 'civicrm_payment_processor::1::name::is_test::domain_id',
|
|
) ,
|
|
);
|
|
return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
|
|
}
|
|
}
|