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