CRM/Member/DAO/MembershipPayment.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/Member/MembershipPayment.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:e9764dc46ae261f8cad8ef1383063d61)
  10  */
  11
  12 /**
  13  * Database access object for the MembershipPayment entity.
  14  */
  15 class CRM_Member_DAO_MembershipPayment extends CRM_Core_DAO {
  16   const EXT = 'civicrm';
  17   const TABLE_ADDED = '1.5';
  18
  19   /**
  20    * Static instance to hold the table name.
  21    *
  22    * @var string
  23    */
  24   public static $_tableName = 'civicrm_membership_payment';
  25
  26   /**
  27    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  28    *
  29    * @var bool
  30    */
  31   public static $_log = TRUE;
  32
  33   /**
  34    * @var int
  35    */
  36   public $id;
  37
  38   /**
  39    * FK to Membership table
  40    *
  41    * @var int
  42    */
  43   public $membership_id;
  44
  45   /**
  46    * FK to contribution table.
  47    *
  48    * @var int
  49    */
  50   public $contribution_id;
  51
  52   /**
  53    * Class constructor.
  54    */
  55   public function __construct() {
  56     $this->__table = 'civicrm_membership_payment';
  57     parent::__construct();
  58   }
  59
  60   /**
  61    * Returns localized title of this entity.
  62    *
  63    * @param bool $plural
  64    *   Whether to return the plural version of the title.
  65    */
  66   public static function getEntityTitle($plural = FALSE) {
  67     return $plural ? ts('Membership Payments') : ts('Membership Payment');
  68   }
  69
  70   /**
  71    * Returns foreign keys and entity references.
  72    *
  73    * @return array
  74    *   [CRM_Core_Reference_Interface]
  75    */
  76   public static function getReferenceColumns() {
  77     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  78       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
  79       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'membership_id', 'civicrm_membership', 'id');
  80       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contribution_id', 'civicrm_contribution', 'id');
  81       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  82     }
  83     return Civi::$statics[__CLASS__]['links'];
  84   }
  85
  86   /**
  87    * Returns all the column names of this table
  88    *
  89    * @return array
  90    */
  91   public static function &fields() {
  92     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
  93       Civi::$statics[__CLASS__]['fields'] = [
  94         'id' => [
  95           'name' => 'id',
  96           'type' => CRM_Utils_Type::T_INT,
  97           'title' => ts('Membership Payment ID'),
  98           'required' => TRUE,
  99           'where' => 'civicrm_membership_payment.id',
 100           'table_name' => 'civicrm_membership_payment',
 101           'entity' => 'MembershipPayment',
 102           'bao' => 'CRM_Member_BAO_MembershipPayment',
 103           'localizable' => 0,
 104           'add' => '1.5',
 105         ],
 106         'membership_id' => [
 107           'name' => 'membership_id',
 108           'type' => CRM_Utils_Type::T_INT,
 109           'title' => ts('Membership'),
 110           'description' => ts('FK to Membership table'),
 111           'required' => TRUE,
 112           'where' => 'civicrm_membership_payment.membership_id',
 113           'table_name' => 'civicrm_membership_payment',
 114           'entity' => 'MembershipPayment',
 115           'bao' => 'CRM_Member_BAO_MembershipPayment',
 116           'localizable' => 0,
 117           'FKClassName' => 'CRM_Member_DAO_Membership',
 118           'add' => '1.5',
 119         ],
 120         'contribution_id' => [
 121           'name' => 'contribution_id',
 122           'type' => CRM_Utils_Type::T_INT,
 123           'title' => ts('Contribution'),
 124           'description' => ts('FK to contribution table.'),
 125           'where' => 'civicrm_membership_payment.contribution_id',
 126           'table_name' => 'civicrm_membership_payment',
 127           'entity' => 'MembershipPayment',
 128           'bao' => 'CRM_Member_BAO_MembershipPayment',
 129           'localizable' => 0,
 130           'FKClassName' => 'CRM_Contribute_DAO_Contribution',
 131           'add' => '2.0',
 132         ],
 133       ];
 134       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 135     }
 136     return Civi::$statics[__CLASS__]['fields'];
 137   }
 138
 139   /**
 140    * Return a mapping from field-name to the corresponding key (as used in fields()).
 141    *
 142    * @return array
 143    *   Array(string $name => string $uniqueName).
 144    */
 145   public static function &fieldKeys() {
 146     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 147       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 148     }
 149     return Civi::$statics[__CLASS__]['fieldKeys'];
 150   }
 151
 152   /**
 153    * Returns the names of this table
 154    *
 155    * @return string
 156    */
 157   public static function getTableName() {
 158     return self::$_tableName;
 159   }
 160
 161   /**
 162    * Returns if this table needs to be logged
 163    *
 164    * @return bool
 165    */
 166   public function getLog() {
 167     return self::$_log;
 168   }
 169
 170   /**
 171    * Returns the list of fields that can be imported
 172    *
 173    * @param bool $prefix
 174    *
 175    * @return array
 176    */
 177   public static function &import($prefix = FALSE) {
 178     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'membership_payment', $prefix, []);
 179     return $r;
 180   }
 181
 182   /**
 183    * Returns the list of fields that can be exported
 184    *
 185    * @param bool $prefix
 186    *
 187    * @return array
 188    */
 189   public static function &export($prefix = FALSE) {
 190     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'membership_payment', $prefix, []);
 191     return $r;
 192   }
 193
 194   /**
 195    * Returns the list of indices
 196    *
 197    * @param bool $localize
 198    *
 199    * @return array
 200    */
 201   public static function indices($localize = TRUE) {
 202     $indices = [
 203       'UI_contribution_membership' => [
 204         'name' => 'UI_contribution_membership',
 205         'field' => [
 206           0 => 'contribution_id',
 207           1 => 'membership_id',
 208         ],
 209         'localizable' => FALSE,
 210         'unique' => TRUE,
 211         'sig' => 'civicrm_membership_payment::1::contribution_id::membership_id',
 212       ],
 213     ];
 214     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 215   }
 216
 217 }