Merge pull request #22255 from MegaphoneJon/membership-14-2021
[civicrm-core.git] / CRM / Contribute / DAO / Contribution.php
index b9093b4986bbc43a836a91af6e01e823236a5b83..a53aeea42ab573f2631abbe8463156df0b4142ea 100644 (file)
@@ -6,7 +6,7 @@
  *
  * Generated from xml/schema/CRM/Contribute/Contribution.xml
  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:b14fa847767daf3723033f41dbca9612)
+ * (GenCodeChecksum:204947e70942c2db4fb9b84398818aa1)
  */
 
 /**
@@ -53,205 +53,267 @@ class CRM_Contribute_DAO_Contribution extends CRM_Core_DAO {
   /**
    * Contribution ID
    *
-   * @var int
+   * @var int|string|null
+   *   (SQL type: int unsigned)
+   *   Note that values will be retrieved from the database as a string.
    */
   public $id;
 
   /**
    * FK to Contact ID
    *
-   * @var int
+   * @var int|string
+   *   (SQL type: int unsigned)
+   *   Note that values will be retrieved from the database as a string.
    */
   public $contact_id;
 
   /**
    * FK to Financial Type for (total_amount - non_deductible_amount).
    *
-   * @var int
+   * @var int|string|null
+   *   (SQL type: int unsigned)
+   *   Note that values will be retrieved from the database as a string.
    */
   public $financial_type_id;
 
   /**
    * The Contribution Page which triggered this contribution
    *
-   * @var int
+   * @var int|string|null
+   *   (SQL type: int unsigned)
+   *   Note that values will be retrieved from the database as a string.
    */
   public $contribution_page_id;
 
   /**
    * FK to Payment Instrument
    *
-   * @var int
+   * @var int|string|null
+   *   (SQL type: int unsigned)
+   *   Note that values will be retrieved from the database as a string.
    */
   public $payment_instrument_id;
 
   /**
    * Date contribution was received - not necessarily the creation date of the record
    *
-   * @var datetime
+   * @var string|null
+   *   (SQL type: datetime)
+   *   Note that values will be retrieved from the database as a string.
    */
   public $receive_date;
 
   /**
    * Portion of total amount which is NOT tax deductible. Equal to total_amount for non-deductible financial types.
    *
-   * @var float
+   * @var float|string|null
+   *   (SQL type: decimal(20,2))
+   *   Note that values will be retrieved from the database as a string.
    */
   public $non_deductible_amount;
 
   /**
    * Total amount of this contribution. Use market value for non-monetary gifts.
    *
-   * @var float
+   * @var float|string
+   *   (SQL type: decimal(20,2))
+   *   Note that values will be retrieved from the database as a string.
    */
   public $total_amount;
 
   /**
    * actual processor fee if known - may be 0.
    *
-   * @var float
+   * @var float|string|null
+   *   (SQL type: decimal(20,2))
+   *   Note that values will be retrieved from the database as a string.
    */
   public $fee_amount;
 
   /**
    * actual funds transfer amount. total less fees. if processor does not report actual fee during transaction, this is set to total_amount.
    *
-   * @var float
+   * @var float|string|null
+   *   (SQL type: decimal(20,2))
+   *   Note that values will be retrieved from the database as a string.
    */
   public $net_amount;
 
   /**
    * unique transaction id. may be processor id, bank id + trans id, or account number + check number... depending on payment_method
    *
-   * @var string
+   * @var string|null
+   *   (SQL type: varchar(255))
+   *   Note that values will be retrieved from the database as a string.
    */
   public $trxn_id;
 
   /**
    * unique invoice id, system generated or passed in
    *
-   * @var string
+   * @var string|null
+   *   (SQL type: varchar(255))
+   *   Note that values will be retrieved from the database as a string.
    */
   public $invoice_id;
 
   /**
    * Human readable invoice number
    *
-   * @var string
+   * @var string|null
+   *   (SQL type: varchar(255))
+   *   Note that values will be retrieved from the database as a string.
    */
   public $invoice_number;
 
   /**
    * 3 character string, value from config setting or input via user.
    *
-   * @var string
+   * @var string|null
+   *   (SQL type: varchar(3))
+   *   Note that values will be retrieved from the database as a string.
    */
   public $currency;
 
   /**
    * when was gift cancelled
    *
-   * @var datetime
+   * @var string|null
+   *   (SQL type: datetime)
+   *   Note that values will be retrieved from the database as a string.
    */
   public $cancel_date;
 
   /**
-   * @var text
+   * @var string|null
+   *   (SQL type: text)
+   *   Note that values will be retrieved from the database as a string.
    */
   public $cancel_reason;
 
   /**
    * when (if) receipt was sent. populated automatically for online donations w/ automatic receipting
    *
-   * @var datetime
+   * @var string|null
+   *   (SQL type: datetime)
+   *   Note that values will be retrieved from the database as a string.
    */
   public $receipt_date;
 
   /**
    * when (if) was donor thanked
    *
-   * @var datetime
+   * @var string|null
+   *   (SQL type: datetime)
+   *   Note that values will be retrieved from the database as a string.
    */
   public $thankyou_date;
 
   /**
    * Origin of this Contribution.
    *
-   * @var string
+   * @var string|null
+   *   (SQL type: varchar(255))
+   *   Note that values will be retrieved from the database as a string.
    */
   public $source;
 
   /**
-   * @var text
+   * @var string|null
+   *   (SQL type: text)
+   *   Note that values will be retrieved from the database as a string.
    */
   public $amount_level;
 
   /**
    * Conditional foreign key to civicrm_contribution_recur id. Each contribution made in connection with a recurring contribution carries a foreign key to the recurring contribution record. This assumes we can track these processor initiated events.
    *
-   * @var int
+   * @var int|string|null
+   *   (SQL type: int unsigned)
+   *   Note that values will be retrieved from the database as a string.
    */
   public $contribution_recur_id;
 
   /**
-   * @var bool
+   * @var bool|string|null
+   *   (SQL type: tinyint)
+   *   Note that values will be retrieved from the database as a string.
    */
   public $is_test;
 
   /**
-   * @var bool
+   * @var bool|string|null
+   *   (SQL type: tinyint)
+   *   Note that values will be retrieved from the database as a string.
    */
   public $is_pay_later;
 
   /**
-   * @var int
+   * @var int|string|null
+   *   (SQL type: int unsigned)
+   *   Note that values will be retrieved from the database as a string.
    */
   public $contribution_status_id;
 
   /**
    * Conditional foreign key to civicrm_address.id. We insert an address record for each contribution when we have associated billing name and address data.
    *
-   * @var int
+   * @var int|string|null
+   *   (SQL type: int unsigned)
+   *   Note that values will be retrieved from the database as a string.
    */
   public $address_id;
 
   /**
-   * @var string
+   * @var string|null
+   *   (SQL type: varchar(255))
+   *   Note that values will be retrieved from the database as a string.
    */
   public $check_number;
 
   /**
    * The campaign for which this contribution has been triggered.
    *
-   * @var int
+   * @var int|string|null
+   *   (SQL type: int unsigned)
+   *   Note that values will be retrieved from the database as a string.
    */
   public $campaign_id;
 
   /**
    * unique credit note id, system generated or passed in
    *
-   * @var string
+   * @var string|null
+   *   (SQL type: varchar(255))
+   *   Note that values will be retrieved from the database as a string.
    */
   public $creditnote_id;
 
   /**
    * Total tax amount of this contribution.
    *
-   * @var float
+   * @var float|string|null
+   *   (SQL type: decimal(20,2))
+   *   Note that values will be retrieved from the database as a string.
    */
   public $tax_amount;
 
   /**
    * Stores the date when revenue should be recognized.
    *
-   * @var datetime
+   * @var string|null
+   *   (SQL type: datetime)
+   *   Note that values will be retrieved from the database as a string.
    */
   public $revenue_recognition_date;
 
   /**
    * Shows this is a template for recurring contributions.
    *
-   * @var bool
+   * @var bool|string|null
+   *   (SQL type: tinyint)
+   *   Note that values will be retrieved from the database as a string.
    */
   public $is_template;