CRM/Event/DAO/ParticipantPayment.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/Event/ParticipantPayment.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:6e45de066d601172a59c64752f11558a)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 /**
  38  * CRM_Event_DAO_ParticipantPayment constructor.
  39  */
  40 class CRM_Event_DAO_ParticipantPayment extends CRM_Core_DAO {
  41   /**
  42    * Static instance to hold the table name.
  43    *
  44    * @var string
  45    */
  46   static $_tableName = 'civicrm_participant_payment';
  47   /**
  48    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  49    *
  50    * @var boolean
  51    */
  52   static $_log = true;
  53   /**
  54    * Participant Payment Id
  55    *
  56    * @var int unsigned
  57    */
  58   public $id;
  59   /**
  60    * Participant Id (FK)
  61    *
  62    * @var int unsigned
  63    */
  64   public $participant_id;
  65   /**
  66    * FK to contribution table.
  67    *
  68    * @var int unsigned
  69    */
  70   public $contribution_id;
  71   /**
  72    * Class constructor.
  73    */
  74   function __construct() {
  75     $this->__table = 'civicrm_participant_payment';
  76     parent::__construct();
  77   }
  78   /**
  79    * Returns foreign keys and entity references.
  80    *
  81    * @return array
  82    *   [CRM_Core_Reference_Interface]
  83    */
  84   static function getReferenceColumns() {
  85     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  86       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
  87       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'participant_id', 'civicrm_participant', 'id');
  88       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'contribution_id', 'civicrm_contribution', 'id');
  89       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  90     }
  91     return Civi::$statics[__CLASS__]['links'];
  92   }
  93   /**
  94    * Returns all the column names of this table
  95    *
  96    * @return array
  97    */
  98   static function &fields() {
  99     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 100       Civi::$statics[__CLASS__]['fields'] = array(
 101         'id' => array(
 102           'name' => 'id',
 103           'type' => CRM_Utils_Type::T_INT,
 104           'title' => ts('Payment ID') ,
 105           'description' => 'Participant Payment Id',
 106           'required' => true,
 107           'table_name' => 'civicrm_participant_payment',
 108           'entity' => 'ParticipantPayment',
 109           'bao' => 'CRM_Event_BAO_ParticipantPayment',
 110           'localizable' => 0,
 111         ) ,
 112         'participant_id' => array(
 113           'name' => 'participant_id',
 114           'type' => CRM_Utils_Type::T_INT,
 115           'title' => ts('Participant ID') ,
 116           'description' => 'Participant Id (FK)',
 117           'required' => true,
 118           'table_name' => 'civicrm_participant_payment',
 119           'entity' => 'ParticipantPayment',
 120           'bao' => 'CRM_Event_BAO_ParticipantPayment',
 121           'localizable' => 0,
 122           'FKClassName' => 'CRM_Event_DAO_Participant',
 123         ) ,
 124         'contribution_id' => array(
 125           'name' => 'contribution_id',
 126           'type' => CRM_Utils_Type::T_INT,
 127           'title' => ts('Contribution') ,
 128           'description' => 'FK to contribution table.',
 129           'required' => true,
 130           'table_name' => 'civicrm_participant_payment',
 131           'entity' => 'ParticipantPayment',
 132           'bao' => 'CRM_Event_BAO_ParticipantPayment',
 133           'localizable' => 0,
 134           'FKClassName' => 'CRM_Contribute_DAO_Contribution',
 135         ) ,
 136       );
 137       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 138     }
 139     return Civi::$statics[__CLASS__]['fields'];
 140   }
 141   /**
 142    * Return a mapping from field-name to the corresponding key (as used in fields()).
 143    *
 144    * @return array
 145    *   Array(string $name => string $uniqueName).
 146    */
 147   static function &fieldKeys() {
 148     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 149       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 150     }
 151     return Civi::$statics[__CLASS__]['fieldKeys'];
 152   }
 153   /**
 154    * Returns the names of this table
 155    *
 156    * @return string
 157    */
 158   static function getTableName() {
 159     return self::$_tableName;
 160   }
 161   /**
 162    * Returns if this table needs to be logged
 163    *
 164    * @return boolean
 165    */
 166   function getLog() {
 167     return self::$_log;
 168   }
 169   /**
 170    * Returns the list of fields that can be imported
 171    *
 172    * @param bool $prefix
 173    *
 174    * @return array
 175    */
 176   static function &import($prefix = false) {
 177     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'participant_payment', $prefix, array());
 178     return $r;
 179   }
 180   /**
 181    * Returns the list of fields that can be exported
 182    *
 183    * @param bool $prefix
 184    *
 185    * @return array
 186    */
 187   static function &export($prefix = false) {
 188     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'participant_payment', $prefix, array());
 189     return $r;
 190   }
 191 }