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:93676dfec372a2d6a700e1bb7ccd9cb9)
  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           'readonly' => TRUE,
 109           'add' => '1.5',
 110         ],
 111         'membership_id' => [
 112           'name' => 'membership_id',
 113           'type' => CRM_Utils_Type::T_INT,
 114           'title' => ts('Membership ID'),
 115           'description' => ts('FK to Membership table'),
 116           'required' => TRUE,
 117           'where' => 'civicrm_membership_payment.membership_id',
 118           'table_name' => 'civicrm_membership_payment',
 119           'entity' => 'MembershipPayment',
 120           'bao' => 'CRM_Member_BAO_MembershipPayment',
 121           'localizable' => 0,
 122           'FKClassName' => 'CRM_Member_DAO_Membership',
 123           'html' => [
 124             'label' => ts("Membership"),
 125           ],
 126           'add' => '1.5',
 127         ],
 128         'contribution_id' => [
 129           'name' => 'contribution_id',
 130           'type' => CRM_Utils_Type::T_INT,
 131           'title' => ts('Contribution ID'),
 132           'description' => ts('FK to contribution table.'),
 133           'where' => 'civicrm_membership_payment.contribution_id',
 134           'table_name' => 'civicrm_membership_payment',
 135           'entity' => 'MembershipPayment',
 136           'bao' => 'CRM_Member_BAO_MembershipPayment',
 137           'localizable' => 0,
 138           'FKClassName' => 'CRM_Contribute_DAO_Contribution',
 139           'html' => [
 140             'label' => ts("Contribution"),
 141           ],
 142           'add' => '2.0',
 143         ],
 144       ];
 145       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 146     }
 147     return Civi::$statics[__CLASS__]['fields'];
 148   }
 149
 150   /**
 151    * Return a mapping from field-name to the corresponding key (as used in fields()).
 152    *
 153    * @return array
 154    *   Array(string $name => string $uniqueName).
 155    */
 156   public static function &fieldKeys() {
 157     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 158       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 159     }
 160     return Civi::$statics[__CLASS__]['fieldKeys'];
 161   }
 162
 163   /**
 164    * Returns the names of this table
 165    *
 166    * @return string
 167    */
 168   public static function getTableName() {
 169     return self::$_tableName;
 170   }
 171
 172   /**
 173    * Returns if this table needs to be logged
 174    *
 175    * @return bool
 176    */
 177   public function getLog() {
 178     return self::$_log;
 179   }
 180
 181   /**
 182    * Returns the list of fields that can be imported
 183    *
 184    * @param bool $prefix
 185    *
 186    * @return array
 187    */
 188   public static function &import($prefix = FALSE) {
 189     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'membership_payment', $prefix, []);
 190     return $r;
 191   }
 192
 193   /**
 194    * Returns the list of fields that can be exported
 195    *
 196    * @param bool $prefix
 197    *
 198    * @return array
 199    */
 200   public static function &export($prefix = FALSE) {
 201     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'membership_payment', $prefix, []);
 202     return $r;
 203   }
 204
 205   /**
 206    * Returns the list of indices
 207    *
 208    * @param bool $localize
 209    *
 210    * @return array
 211    */
 212   public static function indices($localize = TRUE) {
 213     $indices = [
 214       'UI_contribution_membership' => [
 215         'name' => 'UI_contribution_membership',
 216         'field' => [
 217           0 => 'contribution_id',
 218           1 => 'membership_id',
 219         ],
 220         'localizable' => FALSE,
 221         'unique' => TRUE,
 222         'sig' => 'civicrm_membership_payment::1::contribution_id::membership_id',
 223       ],
 224     ];
 225     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 226   }
 227
 228 }