CRM/Financial/DAO/PaymentProcessorType.php

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