5 * @copyright CiviCRM LLC https://civicrm.org/licensing
7 * Generated from xml/schema/CRM/Member/MembershipPayment.xml
8 * DO NOT EDIT. Generated by CRM_Core_CodeGen
9 * (GenCodeChecksum:93676dfec372a2d6a700e1bb7ccd9cb9)
13 * Database access object for the MembershipPayment entity.
15 class CRM_Member_DAO_MembershipPayment
extends CRM_Core_DAO
{
16 const EXT
= 'civicrm';
17 const TABLE_ADDED
= '1.5';
18 const COMPONENT
= 'CiviMember';
21 * Static instance to hold the table name.
25 public static $_tableName = 'civicrm_membership_payment';
28 * Should CiviCRM log any modifications to this table in the civicrm_log table.
32 public static $_log = TRUE;
40 * FK to Membership table
44 public $membership_id;
47 * FK to contribution table.
51 public $contribution_id;
56 public function __construct() {
57 $this->__table
= 'civicrm_membership_payment';
58 parent
::__construct();
62 * Returns localized title of this entity.
65 * Whether to return the plural version of the title.
67 public static function getEntityTitle($plural = FALSE) {
68 return $plural ?
ts('Membership Payments') : ts('Membership Payment');
72 * Returns foreign keys and entity references.
75 * [CRM_Core_Reference_Interface]
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']);
84 return Civi
::$statics[__CLASS__
]['links'];
88 * Returns all the column names of this table
92 public static function &fields() {
93 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
94 Civi
::$statics[__CLASS__
]['fields'] = [
97 'type' => CRM_Utils_Type
::T_INT
,
98 'title' => ts('Membership Payment ID'),
100 'where' => 'civicrm_membership_payment.id',
101 'table_name' => 'civicrm_membership_payment',
102 'entity' => 'MembershipPayment',
103 'bao' => 'CRM_Member_BAO_MembershipPayment',
112 'name' => 'membership_id',
113 'type' => CRM_Utils_Type
::T_INT
,
114 'title' => ts('Membership ID'),
115 'description' => ts('FK to Membership table'),
117 'where' => 'civicrm_membership_payment.membership_id',
118 'table_name' => 'civicrm_membership_payment',
119 'entity' => 'MembershipPayment',
120 'bao' => 'CRM_Member_BAO_MembershipPayment',
122 'FKClassName' => 'CRM_Member_DAO_Membership',
124 'label' => ts("Membership"),
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',
138 'FKClassName' => 'CRM_Contribute_DAO_Contribution',
140 'label' => ts("Contribution"),
145 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
147 return Civi
::$statics[__CLASS__
]['fields'];
151 * Return a mapping from field-name to the corresponding key (as used in fields()).
154 * Array(string $name => string $uniqueName).
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()));
160 return Civi
::$statics[__CLASS__
]['fieldKeys'];
164 * Returns the names of this table
168 public static function getTableName() {
169 return self
::$_tableName;
173 * Returns if this table needs to be logged
177 public function getLog() {
182 * Returns the list of fields that can be imported
184 * @param bool $prefix
188 public static function &import($prefix = FALSE) {
189 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'membership_payment', $prefix, []);
194 * Returns the list of fields that can be exported
196 * @param bool $prefix
200 public static function &export($prefix = FALSE) {
201 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'membership_payment', $prefix, []);
206 * Returns the list of indices
208 * @param bool $localize
212 public static function indices($localize = TRUE) {
214 'UI_contribution_membership' => [
215 'name' => 'UI_contribution_membership',
217 0 => 'contribution_id',
218 1 => 'membership_id',
220 'localizable' => FALSE,
222 'sig' => 'civicrm_membership_payment::1::contribution_id::membership_id',
225 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;