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