CRM/Contribute/DAO/ContributionPage.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC (c) 2004-2019
   6  *
   7  * Generated from xml/schema/CRM/Contribute/ContributionPage.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:476aca3020ef286e4ba5208fa231eb58)
  10  */
  11
  12 /**
  13  * Database access object for the ContributionPage entity.
  14  */
  15 class CRM_Contribute_DAO_ContributionPage extends CRM_Core_DAO {
  16
  17   /**
  18    * Static instance to hold the table name.
  19    *
  20    * @var string
  21    */
  22   public static $_tableName = 'civicrm_contribution_page';
  23
  24   /**
  25    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  26    *
  27    * @var bool
  28    */
  29   public static $_log = TRUE;
  30
  31   /**
  32    * Contribution Id
  33    *
  34    * @var int
  35    */
  36   public $id;
  37
  38   /**
  39    * Contribution Page title. For top of page display
  40    *
  41    * @var string
  42    */
  43   public $title;
  44
  45   /**
  46    * Text and html allowed. Displayed below title.
  47    *
  48    * @var text
  49    */
  50   public $intro_text;
  51
  52   /**
  53    * default financial type assigned to contributions submitted via this page, e.g. Contribution, Campaign Contribution
  54    *
  55    * @var int
  56    */
  57   public $financial_type_id;
  58
  59   /**
  60    * Payment Processors configured for this contribution Page
  61    *
  62    * @var string
  63    */
  64   public $payment_processor;
  65
  66   /**
  67    * if true - processing logic must reject transaction at confirmation stage if pay method != credit card
  68    *
  69    * @var bool
  70    */
  71   public $is_credit_card_only;
  72
  73   /**
  74    * if true - allows real-time monetary transactions otherwise non-monetary transactions
  75    *
  76    * @var bool
  77    */
  78   public $is_monetary;
  79
  80   /**
  81    * if true - allows recurring contributions, valid only for PayPal_Standard
  82    *
  83    * @var bool
  84    */
  85   public $is_recur;
  86
  87   /**
  88    * if false, the confirm page in contribution pages gets skipped
  89    *
  90    * @var bool
  91    */
  92   public $is_confirm_enabled;
  93
  94   /**
  95    * Supported recurring frequency units.
  96    *
  97    * @var string
  98    */
  99   public $recur_frequency_unit;
 100
 101   /**
 102    * if true - supports recurring intervals
 103    *
 104    * @var bool
 105    */
 106   public $is_recur_interval;
 107
 108   /**
 109    * if true - asks user for recurring installments
 110    *
 111    * @var bool
 112    */
 113   public $is_recur_installments;
 114
 115   /**
 116    * if true - user is able to adjust payment start date
 117    *
 118    * @var bool
 119    */
 120   public $adjust_recur_start_date;
 121
 122   /**
 123    * if true - allows the user to send payment directly to the org later
 124    *
 125    * @var bool
 126    */
 127   public $is_pay_later;
 128
 129   /**
 130    * The text displayed to the user in the main form
 131    *
 132    * @var text
 133    */
 134   public $pay_later_text;
 135
 136   /**
 137    * The receipt sent to the user instead of the normal receipt text
 138    *
 139    * @var text
 140    */
 141   public $pay_later_receipt;
 142
 143   /**
 144    * is partial payment enabled for this online contribution page
 145    *
 146    * @var bool
 147    */
 148   public $is_partial_payment;
 149
 150   /**
 151    * Initial amount label for partial payment
 152    *
 153    * @var string
 154    */
 155   public $initial_amount_label;
 156
 157   /**
 158    * Initial amount help text for partial payment
 159    *
 160    * @var text
 161    */
 162   public $initial_amount_help_text;
 163
 164   /**
 165    * Minimum initial amount for partial payment
 166    *
 167    * @var float
 168    */
 169   public $min_initial_amount;
 170
 171   /**
 172    * if true, page will include an input text field where user can enter their own amount
 173    *
 174    * @var bool
 175    */
 176   public $is_allow_other_amount;
 177
 178   /**
 179    * FK to civicrm_option_value.
 180    *
 181    * @var int
 182    */
 183   public $default_amount_id;
 184
 185   /**
 186    * if other amounts allowed, user can configure minimum allowed.
 187    *
 188    * @var float
 189    */
 190   public $min_amount;
 191
 192   /**
 193    * if other amounts allowed, user can configure maximum allowed.
 194    *
 195    * @var float
 196    */
 197   public $max_amount;
 198
 199   /**
 200    * The target goal for this page, allows people to build a goal meter
 201    *
 202    * @var float
 203    */
 204   public $goal_amount;
 205
 206   /**
 207    * Title for Thank-you page (header title tag, and display at the top of the page).
 208    *
 209    * @var string
 210    */
 211   public $thankyou_title;
 212
 213   /**
 214    * text and html allowed. displayed above result on success page
 215    *
 216    * @var text
 217    */
 218   public $thankyou_text;
 219
 220   /**
 221    * Text and html allowed. displayed at the bottom of the success page. Common usage is to include link(s) to other pages such as tell-a-friend, etc.
 222    *
 223    * @var text
 224    */
 225   public $thankyou_footer;
 226
 227   /**
 228    * if true, receipt is automatically emailed to contact on success
 229    *
 230    * @var bool
 231    */
 232   public $is_email_receipt;
 233
 234   /**
 235    * FROM email name used for receipts generated by contributions to this contribution page.
 236    *
 237    * @var string
 238    */
 239   public $receipt_from_name;
 240
 241   /**
 242    * FROM email address used for receipts generated by contributions to this contribution page.
 243    *
 244    * @var string
 245    */
 246   public $receipt_from_email;
 247
 248   /**
 249    * comma-separated list of email addresses to cc each time a receipt is sent
 250    *
 251    * @var string
 252    */
 253   public $cc_receipt;
 254
 255   /**
 256    * comma-separated list of email addresses to bcc each time a receipt is sent
 257    *
 258    * @var string
 259    */
 260   public $bcc_receipt;
 261
 262   /**
 263    * text to include above standard receipt info on receipt email. emails are text-only, so do not allow html for now
 264    *
 265    * @var text
 266    */
 267   public $receipt_text;
 268
 269   /**
 270    * Is this property active?
 271    *
 272    * @var bool
 273    */
 274   public $is_active;
 275
 276   /**
 277    * Text and html allowed. Displayed at the bottom of the first page of the contribution wizard.
 278    *
 279    * @var text
 280    */
 281   public $footer_text;
 282
 283   /**
 284    * Is this property active?
 285    *
 286    * @var bool
 287    */
 288   public $amount_block_is_active;
 289
 290   /**
 291    * Date and time that this page starts.
 292    *
 293    * @var datetime
 294    */
 295   public $start_date;
 296
 297   /**
 298    * Date and time that this page ends. May be NULL if no defined end date/time
 299    *
 300    * @var datetime
 301    */
 302   public $end_date;
 303
 304   /**
 305    * FK to civicrm_contact, who created this contribution page
 306    *
 307    * @var int
 308    */
 309   public $created_id;
 310
 311   /**
 312    * Date and time that contribution page was created.
 313    *
 314    * @var datetime
 315    */
 316   public $created_date;
 317
 318   /**
 319    * 3 character string, value from config setting or input via user.
 320    *
 321    * @var string
 322    */
 323   public $currency;
 324
 325   /**
 326    * The campaign for which we are collecting contributions with this page.
 327    *
 328    * @var int
 329    */
 330   public $campaign_id;
 331
 332   /**
 333    * Can people share the contribution page through social media?
 334    *
 335    * @var bool
 336    */
 337   public $is_share;
 338
 339   /**
 340    * if true - billing block is required for online contribution page
 341    *
 342    * @var bool
 343    */
 344   public $is_billing_required;
 345
 346   /**
 347    * Class constructor.
 348    */
 349   public function __construct() {
 350     $this->__table = 'civicrm_contribution_page';
 351     parent::__construct();
 352   }
 353
 354   /**
 355    * Returns foreign keys and entity references.
 356    *
 357    * @return array
 358    *   [CRM_Core_Reference_Interface]
 359    */
 360   public static function getReferenceColumns() {
 361     if (!isset(Civi::$statics[__CLASS__]['links'])) {
 362       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
 363       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'financial_type_id', 'civicrm_financial_type', 'id');
 364       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'created_id', 'civicrm_contact', 'id');
 365       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'campaign_id', 'civicrm_campaign', 'id');
 366       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 367     }
 368     return Civi::$statics[__CLASS__]['links'];
 369   }
 370
 371   /**
 372    * Returns all the column names of this table
 373    *
 374    * @return array
 375    */
 376   public static function &fields() {
 377     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 378       Civi::$statics[__CLASS__]['fields'] = [
 379         'id' => [
 380           'name' => 'id',
 381           'type' => CRM_Utils_Type::T_INT,
 382           'title' => ts('Contribution Page ID'),
 383           'description' => ts('Contribution Id'),
 384           'required' => TRUE,
 385           'where' => 'civicrm_contribution_page.id',
 386           'table_name' => 'civicrm_contribution_page',
 387           'entity' => 'ContributionPage',
 388           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 389           'localizable' => 0,
 390         ],
 391         'title' => [
 392           'name' => 'title',
 393           'type' => CRM_Utils_Type::T_STRING,
 394           'title' => ts('Contribution Page Title'),
 395           'description' => ts('Contribution Page title. For top of page display'),
 396           'maxlength' => 255,
 397           'size' => CRM_Utils_Type::HUGE,
 398           'where' => 'civicrm_contribution_page.title',
 399           'table_name' => 'civicrm_contribution_page',
 400           'entity' => 'ContributionPage',
 401           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 402           'localizable' => 1,
 403         ],
 404         'intro_text' => [
 405           'name' => 'intro_text',
 406           'type' => CRM_Utils_Type::T_TEXT,
 407           'title' => ts('Contribution Page Introduction Text'),
 408           'description' => ts('Text and html allowed. Displayed below title.'),
 409           'rows' => 6,
 410           'cols' => 50,
 411           'where' => 'civicrm_contribution_page.intro_text',
 412           'table_name' => 'civicrm_contribution_page',
 413           'entity' => 'ContributionPage',
 414           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 415           'localizable' => 1,
 416           'html' => [
 417             'type' => 'RichTextEditor',
 418           ],
 419         ],
 420         'financial_type_id' => [
 421           'name' => 'financial_type_id',
 422           'type' => CRM_Utils_Type::T_INT,
 423           'title' => ts('Financial Type'),
 424           'description' => ts('default financial type assigned to contributions submitted via this page, e.g. Contribution, Campaign Contribution'),
 425           'where' => 'civicrm_contribution_page.financial_type_id',
 426           'table_name' => 'civicrm_contribution_page',
 427           'entity' => 'ContributionPage',
 428           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 429           'localizable' => 0,
 430           'FKClassName' => 'CRM_Financial_DAO_FinancialType',
 431           'html' => [
 432             'type' => 'Select',
 433           ],
 434           'pseudoconstant' => [
 435             'table' => 'civicrm_financial_type',
 436             'keyColumn' => 'id',
 437             'labelColumn' => 'name',
 438           ],
 439         ],
 440         'payment_processor' => [
 441           'name' => 'payment_processor',
 442           'type' => CRM_Utils_Type::T_STRING,
 443           'title' => ts('Payment Processor'),
 444           'description' => ts('Payment Processors configured for this contribution Page'),
 445           'maxlength' => 128,
 446           'size' => CRM_Utils_Type::HUGE,
 447           'where' => 'civicrm_contribution_page.payment_processor',
 448           'table_name' => 'civicrm_contribution_page',
 449           'entity' => 'ContributionPage',
 450           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 451           'localizable' => 0,
 452           'html' => [
 453             'type' => 'Select',
 454           ],
 455           'pseudoconstant' => [
 456             'table' => 'civicrm_payment_processor',
 457             'keyColumn' => 'id',
 458             'labelColumn' => 'name',
 459           ],
 460         ],
 461         'is_credit_card_only' => [
 462           'name' => 'is_credit_card_only',
 463           'type' => CRM_Utils_Type::T_BOOLEAN,
 464           'title' => ts('Is Credit Card Only?'),
 465           'description' => ts('if true - processing logic must reject transaction at confirmation stage if pay method != credit card'),
 466           'where' => 'civicrm_contribution_page.is_credit_card_only',
 467           'default' => '0',
 468           'table_name' => 'civicrm_contribution_page',
 469           'entity' => 'ContributionPage',
 470           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 471           'localizable' => 0,
 472         ],
 473         'is_monetary' => [
 474           'name' => 'is_monetary',
 475           'type' => CRM_Utils_Type::T_BOOLEAN,
 476           'title' => ts('Is Monetary'),
 477           'description' => ts('if true - allows real-time monetary transactions otherwise non-monetary transactions'),
 478           'where' => 'civicrm_contribution_page.is_monetary',
 479           'default' => '1',
 480           'table_name' => 'civicrm_contribution_page',
 481           'entity' => 'ContributionPage',
 482           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 483           'localizable' => 0,
 484         ],
 485         'is_recur' => [
 486           'name' => 'is_recur',
 487           'type' => CRM_Utils_Type::T_BOOLEAN,
 488           'title' => ts('Is Recurring'),
 489           'description' => ts('if true - allows recurring contributions, valid only for PayPal_Standard'),
 490           'where' => 'civicrm_contribution_page.is_recur',
 491           'default' => '0',
 492           'table_name' => 'civicrm_contribution_page',
 493           'entity' => 'ContributionPage',
 494           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 495           'localizable' => 0,
 496         ],
 497         'is_confirm_enabled' => [
 498           'name' => 'is_confirm_enabled',
 499           'type' => CRM_Utils_Type::T_BOOLEAN,
 500           'title' => ts('Confirmation Page?'),
 501           'description' => ts('if false, the confirm page in contribution pages gets skipped'),
 502           'where' => 'civicrm_contribution_page.is_confirm_enabled',
 503           'default' => '1',
 504           'table_name' => 'civicrm_contribution_page',
 505           'entity' => 'ContributionPage',
 506           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 507           'localizable' => 0,
 508         ],
 509         'recur_frequency_unit' => [
 510           'name' => 'recur_frequency_unit',
 511           'type' => CRM_Utils_Type::T_STRING,
 512           'title' => ts('Recurring Frequency'),
 513           'description' => ts('Supported recurring frequency units.'),
 514           'maxlength' => 128,
 515           'size' => CRM_Utils_Type::HUGE,
 516           'where' => 'civicrm_contribution_page.recur_frequency_unit',
 517           'table_name' => 'civicrm_contribution_page',
 518           'entity' => 'ContributionPage',
 519           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 520           'localizable' => 0,
 521           'serialize' => self::SERIALIZE_SEPARATOR_TRIMMED,
 522           'html' => [
 523             'type' => 'Select',
 524           ],
 525           'pseudoconstant' => [
 526             'optionGroupName' => 'recur_frequency_units',
 527             'keyColumn' => 'name',
 528             'optionEditPath' => 'civicrm/admin/options/recur_frequency_units',
 529           ],
 530         ],
 531         'is_recur_interval' => [
 532           'name' => 'is_recur_interval',
 533           'type' => CRM_Utils_Type::T_BOOLEAN,
 534           'title' => ts('Support Recurring Intervals'),
 535           'description' => ts('if true - supports recurring intervals'),
 536           'where' => 'civicrm_contribution_page.is_recur_interval',
 537           'default' => '0',
 538           'table_name' => 'civicrm_contribution_page',
 539           'entity' => 'ContributionPage',
 540           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 541           'localizable' => 0,
 542         ],
 543         'is_recur_installments' => [
 544           'name' => 'is_recur_installments',
 545           'type' => CRM_Utils_Type::T_BOOLEAN,
 546           'title' => ts('Recurring Installments?'),
 547           'description' => ts('if true - asks user for recurring installments'),
 548           'where' => 'civicrm_contribution_page.is_recur_installments',
 549           'default' => '0',
 550           'table_name' => 'civicrm_contribution_page',
 551           'entity' => 'ContributionPage',
 552           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 553           'localizable' => 0,
 554         ],
 555         'adjust_recur_start_date' => [
 556           'name' => 'adjust_recur_start_date',
 557           'type' => CRM_Utils_Type::T_BOOLEAN,
 558           'title' => ts('Adjust Recurring Start Date'),
 559           'description' => ts('if true - user is able to adjust payment start date'),
 560           'where' => 'civicrm_contribution_page.adjust_recur_start_date',
 561           'default' => '0',
 562           'table_name' => 'civicrm_contribution_page',
 563           'entity' => 'ContributionPage',
 564           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 565           'localizable' => 0,
 566         ],
 567         'is_pay_later' => [
 568           'name' => 'is_pay_later',
 569           'type' => CRM_Utils_Type::T_BOOLEAN,
 570           'title' => ts('Pay Later'),
 571           'description' => ts('if true - allows the user to send payment directly to the org later'),
 572           'where' => 'civicrm_contribution_page.is_pay_later',
 573           'default' => '0',
 574           'table_name' => 'civicrm_contribution_page',
 575           'entity' => 'ContributionPage',
 576           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 577           'localizable' => 0,
 578         ],
 579         'pay_later_text' => [
 580           'name' => 'pay_later_text',
 581           'type' => CRM_Utils_Type::T_TEXT,
 582           'title' => ts('Pay Later Text'),
 583           'description' => ts('The text displayed to the user in the main form'),
 584           'where' => 'civicrm_contribution_page.pay_later_text',
 585           'table_name' => 'civicrm_contribution_page',
 586           'entity' => 'ContributionPage',
 587           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 588           'localizable' => 1,
 589         ],
 590         'pay_later_receipt' => [
 591           'name' => 'pay_later_receipt',
 592           'type' => CRM_Utils_Type::T_TEXT,
 593           'title' => ts('Pay Later Receipt'),
 594           'description' => ts('The receipt sent to the user instead of the normal receipt text'),
 595           'where' => 'civicrm_contribution_page.pay_later_receipt',
 596           'table_name' => 'civicrm_contribution_page',
 597           'entity' => 'ContributionPage',
 598           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 599           'localizable' => 1,
 600         ],
 601         'is_partial_payment' => [
 602           'name' => 'is_partial_payment',
 603           'type' => CRM_Utils_Type::T_BOOLEAN,
 604           'title' => ts('Allow Partial Payment'),
 605           'description' => ts('is partial payment enabled for this online contribution page'),
 606           'where' => 'civicrm_contribution_page.is_partial_payment',
 607           'default' => '0',
 608           'table_name' => 'civicrm_contribution_page',
 609           'entity' => 'ContributionPage',
 610           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 611           'localizable' => 0,
 612         ],
 613         'initial_amount_label' => [
 614           'name' => 'initial_amount_label',
 615           'type' => CRM_Utils_Type::T_STRING,
 616           'title' => ts('Initial Amount Label'),
 617           'description' => ts('Initial amount label for partial payment'),
 618           'maxlength' => 255,
 619           'size' => CRM_Utils_Type::HUGE,
 620           'where' => 'civicrm_contribution_page.initial_amount_label',
 621           'table_name' => 'civicrm_contribution_page',
 622           'entity' => 'ContributionPage',
 623           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 624           'localizable' => 1,
 625         ],
 626         'initial_amount_help_text' => [
 627           'name' => 'initial_amount_help_text',
 628           'type' => CRM_Utils_Type::T_TEXT,
 629           'title' => ts('Initial Amount Help Text'),
 630           'description' => ts('Initial amount help text for partial payment'),
 631           'where' => 'civicrm_contribution_page.initial_amount_help_text',
 632           'table_name' => 'civicrm_contribution_page',
 633           'entity' => 'ContributionPage',
 634           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 635           'localizable' => 1,
 636         ],
 637         'min_initial_amount' => [
 638           'name' => 'min_initial_amount',
 639           'type' => CRM_Utils_Type::T_MONEY,
 640           'title' => ts('Min Initial Amount'),
 641           'description' => ts('Minimum initial amount for partial payment'),
 642           'precision' => [
 643             20,
 644             2,
 645           ],
 646           'where' => 'civicrm_contribution_page.min_initial_amount',
 647           'table_name' => 'civicrm_contribution_page',
 648           'entity' => 'ContributionPage',
 649           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 650           'localizable' => 0,
 651         ],
 652         'is_allow_other_amount' => [
 653           'name' => 'is_allow_other_amount',
 654           'type' => CRM_Utils_Type::T_BOOLEAN,
 655           'title' => ts('Allow Other Amounts'),
 656           'description' => ts('if true, page will include an input text field where user can enter their own amount'),
 657           'where' => 'civicrm_contribution_page.is_allow_other_amount',
 658           'default' => '0',
 659           'table_name' => 'civicrm_contribution_page',
 660           'entity' => 'ContributionPage',
 661           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 662           'localizable' => 0,
 663         ],
 664         'default_amount_id' => [
 665           'name' => 'default_amount_id',
 666           'type' => CRM_Utils_Type::T_INT,
 667           'title' => ts('Default Amount'),
 668           'description' => ts('FK to civicrm_option_value.'),
 669           'where' => 'civicrm_contribution_page.default_amount_id',
 670           'table_name' => 'civicrm_contribution_page',
 671           'entity' => 'ContributionPage',
 672           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 673           'localizable' => 0,
 674         ],
 675         'min_amount' => [
 676           'name' => 'min_amount',
 677           'type' => CRM_Utils_Type::T_MONEY,
 678           'title' => ts('Minimum Amount'),
 679           'description' => ts('if other amounts allowed, user can configure minimum allowed.'),
 680           'precision' => [
 681             20,
 682             2,
 683           ],
 684           'where' => 'civicrm_contribution_page.min_amount',
 685           'table_name' => 'civicrm_contribution_page',
 686           'entity' => 'ContributionPage',
 687           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 688           'localizable' => 0,
 689         ],
 690         'max_amount' => [
 691           'name' => 'max_amount',
 692           'type' => CRM_Utils_Type::T_MONEY,
 693           'title' => ts('Maximum Amount'),
 694           'description' => ts('if other amounts allowed, user can configure maximum allowed.'),
 695           'precision' => [
 696             20,
 697             2,
 698           ],
 699           'where' => 'civicrm_contribution_page.max_amount',
 700           'table_name' => 'civicrm_contribution_page',
 701           'entity' => 'ContributionPage',
 702           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 703           'localizable' => 0,
 704         ],
 705         'goal_amount' => [
 706           'name' => 'goal_amount',
 707           'type' => CRM_Utils_Type::T_MONEY,
 708           'title' => ts('Goal Amount'),
 709           'description' => ts('The target goal for this page, allows people to build a goal meter'),
 710           'precision' => [
 711             20,
 712             2,
 713           ],
 714           'where' => 'civicrm_contribution_page.goal_amount',
 715           'table_name' => 'civicrm_contribution_page',
 716           'entity' => 'ContributionPage',
 717           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 718           'localizable' => 0,
 719         ],
 720         'thankyou_title' => [
 721           'name' => 'thankyou_title',
 722           'type' => CRM_Utils_Type::T_STRING,
 723           'title' => ts('Thank-you Title'),
 724           'description' => ts('Title for Thank-you page (header title tag, and display at the top of the page).'),
 725           'maxlength' => 255,
 726           'size' => CRM_Utils_Type::HUGE,
 727           'where' => 'civicrm_contribution_page.thankyou_title',
 728           'table_name' => 'civicrm_contribution_page',
 729           'entity' => 'ContributionPage',
 730           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 731           'localizable' => 1,
 732         ],
 733         'thankyou_text' => [
 734           'name' => 'thankyou_text',
 735           'type' => CRM_Utils_Type::T_TEXT,
 736           'title' => ts('Thank-you Text'),
 737           'description' => ts('text and html allowed. displayed above result on success page'),
 738           'rows' => 8,
 739           'cols' => 60,
 740           'where' => 'civicrm_contribution_page.thankyou_text',
 741           'table_name' => 'civicrm_contribution_page',
 742           'entity' => 'ContributionPage',
 743           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 744           'localizable' => 1,
 745           'html' => [
 746             'type' => 'RichTextEditor',
 747           ],
 748         ],
 749         'thankyou_footer' => [
 750           'name' => 'thankyou_footer',
 751           'type' => CRM_Utils_Type::T_TEXT,
 752           'title' => ts('Thank-you Footer'),
 753           'description' => ts('Text and html allowed. displayed at the bottom of the success page. Common usage is to include link(s) to other pages such as tell-a-friend, etc.'),
 754           'rows' => 8,
 755           'cols' => 60,
 756           'where' => 'civicrm_contribution_page.thankyou_footer',
 757           'table_name' => 'civicrm_contribution_page',
 758           'entity' => 'ContributionPage',
 759           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 760           'localizable' => 1,
 761           'html' => [
 762             'type' => 'RichTextEditor',
 763           ],
 764         ],
 765         'is_email_receipt' => [
 766           'name' => 'is_email_receipt',
 767           'type' => CRM_Utils_Type::T_BOOLEAN,
 768           'title' => ts('Send email Receipt'),
 769           'description' => ts('if true, receipt is automatically emailed to contact on success'),
 770           'where' => 'civicrm_contribution_page.is_email_receipt',
 771           'default' => '0',
 772           'table_name' => 'civicrm_contribution_page',
 773           'entity' => 'ContributionPage',
 774           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 775           'localizable' => 0,
 776         ],
 777         'receipt_from_name' => [
 778           'name' => 'receipt_from_name',
 779           'type' => CRM_Utils_Type::T_STRING,
 780           'title' => ts('Receipt From'),
 781           'description' => ts('FROM email name used for receipts generated by contributions to this contribution page.'),
 782           'maxlength' => 255,
 783           'size' => CRM_Utils_Type::HUGE,
 784           'where' => 'civicrm_contribution_page.receipt_from_name',
 785           'table_name' => 'civicrm_contribution_page',
 786           'entity' => 'ContributionPage',
 787           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 788           'localizable' => 1,
 789         ],
 790         'receipt_from_email' => [
 791           'name' => 'receipt_from_email',
 792           'type' => CRM_Utils_Type::T_STRING,
 793           'title' => ts('Receipt From email'),
 794           'description' => ts('FROM email address used for receipts generated by contributions to this contribution page.'),
 795           'maxlength' => 255,
 796           'size' => CRM_Utils_Type::HUGE,
 797           'where' => 'civicrm_contribution_page.receipt_from_email',
 798           'table_name' => 'civicrm_contribution_page',
 799           'entity' => 'ContributionPage',
 800           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 801           'localizable' => 0,
 802         ],
 803         'cc_receipt' => [
 804           'name' => 'cc_receipt',
 805           'type' => CRM_Utils_Type::T_STRING,
 806           'title' => ts('Receipt cc'),
 807           'description' => ts('comma-separated list of email addresses to cc each time a receipt is sent'),
 808           'maxlength' => 255,
 809           'size' => CRM_Utils_Type::HUGE,
 810           'where' => 'civicrm_contribution_page.cc_receipt',
 811           'table_name' => 'civicrm_contribution_page',
 812           'entity' => 'ContributionPage',
 813           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 814           'localizable' => 0,
 815         ],
 816         'bcc_receipt' => [
 817           'name' => 'bcc_receipt',
 818           'type' => CRM_Utils_Type::T_STRING,
 819           'title' => ts('Receipt bcc'),
 820           'description' => ts('comma-separated list of email addresses to bcc each time a receipt is sent'),
 821           'maxlength' => 255,
 822           'size' => CRM_Utils_Type::HUGE,
 823           'where' => 'civicrm_contribution_page.bcc_receipt',
 824           'table_name' => 'civicrm_contribution_page',
 825           'entity' => 'ContributionPage',
 826           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 827           'localizable' => 0,
 828         ],
 829         'receipt_text' => [
 830           'name' => 'receipt_text',
 831           'type' => CRM_Utils_Type::T_TEXT,
 832           'title' => ts('Receipt Text'),
 833           'description' => ts('text to include above standard receipt info on receipt email. emails are text-only, so do not allow html for now'),
 834           'rows' => 6,
 835           'cols' => 50,
 836           'where' => 'civicrm_contribution_page.receipt_text',
 837           'table_name' => 'civicrm_contribution_page',
 838           'entity' => 'ContributionPage',
 839           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 840           'localizable' => 1,
 841           'html' => [
 842             'type' => 'TextArea',
 843           ],
 844         ],
 845         'is_active' => [
 846           'name' => 'is_active',
 847           'type' => CRM_Utils_Type::T_BOOLEAN,
 848           'title' => ts('Is Page Active?'),
 849           'description' => ts('Is this property active?'),
 850           'where' => 'civicrm_contribution_page.is_active',
 851           'table_name' => 'civicrm_contribution_page',
 852           'entity' => 'ContributionPage',
 853           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 854           'localizable' => 0,
 855         ],
 856         'footer_text' => [
 857           'name' => 'footer_text',
 858           'type' => CRM_Utils_Type::T_TEXT,
 859           'title' => ts('Footer Text'),
 860           'description' => ts('Text and html allowed. Displayed at the bottom of the first page of the contribution wizard.'),
 861           'rows' => 6,
 862           'cols' => 50,
 863           'where' => 'civicrm_contribution_page.footer_text',
 864           'table_name' => 'civicrm_contribution_page',
 865           'entity' => 'ContributionPage',
 866           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 867           'localizable' => 1,
 868           'html' => [
 869             'type' => 'RichTextEditor',
 870           ],
 871         ],
 872         'amount_block_is_active' => [
 873           'name' => 'amount_block_is_active',
 874           'type' => CRM_Utils_Type::T_BOOLEAN,
 875           'title' => ts('Is Amount Block Active?'),
 876           'description' => ts('Is this property active?'),
 877           'where' => 'civicrm_contribution_page.amount_block_is_active',
 878           'default' => '1',
 879           'table_name' => 'civicrm_contribution_page',
 880           'entity' => 'ContributionPage',
 881           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 882           'localizable' => 0,
 883         ],
 884         'start_date' => [
 885           'name' => 'start_date',
 886           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 887           'title' => ts('Contribution Page Start Date'),
 888           'description' => ts('Date and time that this page starts.'),
 889           'where' => 'civicrm_contribution_page.start_date',
 890           'table_name' => 'civicrm_contribution_page',
 891           'entity' => 'ContributionPage',
 892           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 893           'localizable' => 0,
 894         ],
 895         'end_date' => [
 896           'name' => 'end_date',
 897           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 898           'title' => ts('Contribution Page End Date'),
 899           'description' => ts('Date and time that this page ends. May be NULL if no defined end date/time'),
 900           'where' => 'civicrm_contribution_page.end_date',
 901           'table_name' => 'civicrm_contribution_page',
 902           'entity' => 'ContributionPage',
 903           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 904           'localizable' => 0,
 905         ],
 906         'created_id' => [
 907           'name' => 'created_id',
 908           'type' => CRM_Utils_Type::T_INT,
 909           'title' => ts('Contribution Page Created By'),
 910           'description' => ts('FK to civicrm_contact, who created this contribution page'),
 911           'where' => 'civicrm_contribution_page.created_id',
 912           'table_name' => 'civicrm_contribution_page',
 913           'entity' => 'ContributionPage',
 914           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 915           'localizable' => 0,
 916           'FKClassName' => 'CRM_Contact_DAO_Contact',
 917         ],
 918         'created_date' => [
 919           'name' => 'created_date',
 920           'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
 921           'title' => ts('Contribution Page Created Date'),
 922           'description' => ts('Date and time that contribution page was created.'),
 923           'where' => 'civicrm_contribution_page.created_date',
 924           'table_name' => 'civicrm_contribution_page',
 925           'entity' => 'ContributionPage',
 926           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 927           'localizable' => 0,
 928         ],
 929         'currency' => [
 930           'name' => 'currency',
 931           'type' => CRM_Utils_Type::T_STRING,
 932           'title' => ts('Contribution Page Currency'),
 933           'description' => ts('3 character string, value from config setting or input via user.'),
 934           'maxlength' => 3,
 935           'size' => CRM_Utils_Type::FOUR,
 936           'where' => 'civicrm_contribution_page.currency',
 937           'headerPattern' => '/cur(rency)?/i',
 938           'dataPattern' => '/^[A-Z]{3}$/i',
 939           'default' => 'NULL',
 940           'table_name' => 'civicrm_contribution_page',
 941           'entity' => 'ContributionPage',
 942           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 943           'localizable' => 0,
 944           'html' => [
 945             'type' => 'Select',
 946           ],
 947           'pseudoconstant' => [
 948             'table' => 'civicrm_currency',
 949             'keyColumn' => 'name',
 950             'labelColumn' => 'full_name',
 951             'nameColumn' => 'name',
 952           ],
 953         ],
 954         'campaign_id' => [
 955           'name' => 'campaign_id',
 956           'type' => CRM_Utils_Type::T_INT,
 957           'title' => ts('Contribution Page Campaign ID'),
 958           'description' => ts('The campaign for which we are collecting contributions with this page.'),
 959           'where' => 'civicrm_contribution_page.campaign_id',
 960           'table_name' => 'civicrm_contribution_page',
 961           'entity' => 'ContributionPage',
 962           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 963           'localizable' => 0,
 964           'FKClassName' => 'CRM_Campaign_DAO_Campaign',
 965           'pseudoconstant' => [
 966             'table' => 'civicrm_campaign',
 967             'keyColumn' => 'id',
 968             'labelColumn' => 'title',
 969           ],
 970         ],
 971         'is_share' => [
 972           'name' => 'is_share',
 973           'type' => CRM_Utils_Type::T_BOOLEAN,
 974           'title' => ts('Is Contribution Page Shared?'),
 975           'description' => ts('Can people share the contribution page through social media?'),
 976           'where' => 'civicrm_contribution_page.is_share',
 977           'default' => '1',
 978           'table_name' => 'civicrm_contribution_page',
 979           'entity' => 'ContributionPage',
 980           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 981           'localizable' => 0,
 982         ],
 983         'is_billing_required' => [
 984           'name' => 'is_billing_required',
 985           'type' => CRM_Utils_Type::T_BOOLEAN,
 986           'title' => ts('Is billing block required'),
 987           'description' => ts('if true - billing block is required for online contribution page'),
 988           'where' => 'civicrm_contribution_page.is_billing_required',
 989           'default' => '0',
 990           'table_name' => 'civicrm_contribution_page',
 991           'entity' => 'ContributionPage',
 992           'bao' => 'CRM_Contribute_BAO_ContributionPage',
 993           'localizable' => 0,
 994         ],
 995       ];
 996       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 997     }
 998     return Civi::$statics[__CLASS__]['fields'];
 999   }
1000
1001   /**
1002    * Return a mapping from field-name to the corresponding key (as used in fields()).
1003    *
1004    * @return array
1005    *   Array(string $name => string $uniqueName).
1006    */
1007   public static function &fieldKeys() {
1008     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
1009       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
1010     }
1011     return Civi::$statics[__CLASS__]['fieldKeys'];
1012   }
1013
1014   /**
1015    * Returns the names of this table
1016    *
1017    * @return string
1018    */
1019   public static function getTableName() {
1020     return CRM_Core_DAO::getLocaleTableName(self::$_tableName);
1021   }
1022
1023   /**
1024    * Returns if this table needs to be logged
1025    *
1026    * @return bool
1027    */
1028   public function getLog() {
1029     return self::$_log;
1030   }
1031
1032   /**
1033    * Returns the list of fields that can be imported
1034    *
1035    * @param bool $prefix
1036    *
1037    * @return array
1038    */
1039   public static function &import($prefix = FALSE) {
1040     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'contribution_page', $prefix, []);
1041     return $r;
1042   }
1043
1044   /**
1045    * Returns the list of fields that can be exported
1046    *
1047    * @param bool $prefix
1048    *
1049    * @return array
1050    */
1051   public static function &export($prefix = FALSE) {
1052     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'contribution_page', $prefix, []);
1053     return $r;
1054   }
1055
1056   /**
1057    * Returns the list of indices
1058    *
1059    * @param bool $localize
1060    *
1061    * @return array
1062    */
1063   public static function indices($localize = TRUE) {
1064     $indices = [];
1065     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
1066   }
1067
1068 }