3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2017
35 * This class holds all the Pseudo constants that are specific to Contributions.
37 * This avoids polluting the core class and isolates the mass mailer class.
39 class CRM_Contribute_PseudoConstant
extends CRM_Core_PseudoConstant
{
45 private static $financialType;
51 private static $financialAccount;
57 private static $contributionPageActive = NULL;
63 private static $contributionPageAll = NULL;
70 private static $paymentInstrument;
77 private static $contributionStatus;
80 * Personal campaign pages
83 private static $pcPage;
86 * Status of personal campaign page
89 private static $pcpStatus;
92 * Contribution / financial batches
95 private static $batch;
98 * DEPRECATED. Please use the buildOptions() method in the appropriate BAO object.
100 * Get all the financial types
106 * array reference of all financial types if any
108 public static function &financialType($id = NULL) {
109 if (!self
::$financialType) {
110 $condition = " is_active = 1 ";
111 CRM_Core_PseudoConstant
::populate(
112 self
::$financialType,
113 'CRM_Financial_DAO_FinancialType',
122 $result = CRM_Utils_Array
::value($id, self
::$financialType);
125 return self
::$financialType;
129 * DEPRECATED. Please use the buildOptions() method in the appropriate BAO object.
131 * Get all the financial Accounts
135 * @param int $financialAccountTypeId
136 * @param string $retrieveColumn
140 * array reference of all financial accounts if any
142 public static function &financialAccount($id = NULL, $financialAccountTypeId = NULL, $retrieveColumn = 'name', $key = 'id') {
144 if ($financialAccountTypeId) {
145 $condition = " financial_account_type_id = " . $financialAccountTypeId;
147 $cacheKey = "{$id}_{$financialAccountTypeId}_{$retrieveColumn}_{$key}";
148 if (!isset(self
::$financialAccount[$cacheKey])) {
149 CRM_Core_PseudoConstant
::populate(
150 self
::$financialAccount[$cacheKey],
151 'CRM_Financial_DAO_FinancialAccount',
162 $result = CRM_Utils_Array
::value($id, self
::$financialAccount[$cacheKey]);
165 return self
::$financialAccount[$cacheKey];
169 * Flush given pseudoconstant so it can be reread from db
170 * nex time it's requested.
173 * @param bool|string $name pseudoconstant to be flushed
175 public static function flush($name = 'cache') {
176 if (isset(self
::$
$name)) {
182 * DEPRECATED. Please use the buildOptions() method in the appropriate BAO object.
184 * Get all the contribution pages
187 * Id of the contribution page.
189 * Do we want all pages or only active pages.
193 * array reference of all contribution pages if any
195 public static function &contributionPage($id = NULL, $all = FALSE) {
197 $cacheVarToUse = &self
::$contributionPageAll;
200 $cacheVarToUse = &self
::$contributionPageActive;
203 if (!$cacheVarToUse) {
204 CRM_Core_PseudoConstant
::populate($cacheVarToUse,
205 'CRM_Contribute_DAO_ContributionPage',
210 $pageTitle = CRM_Utils_Array
::value($id, $cacheVarToUse);
213 return $cacheVarToUse;
217 * DEPRECATED. Please use the buildOptions() method in the appropriate BAO object.
219 * Get all the payment instruments
222 * @param string $columnName
225 * array reference of all payment instruments if any
227 public static function &paymentInstrument($columnName = 'label') {
228 if (!isset(self
::$paymentInstrument[$columnName])) {
229 self
::$paymentInstrument[$columnName] = CRM_Core_OptionGroup
::values('payment_instrument',
230 FALSE, FALSE, FALSE, NULL, $columnName
234 return self
::$paymentInstrument[$columnName];
238 * Get all the valid accepted credit cards.
242 * array reference of all payment instruments if any
244 public static function &creditCard() {
245 return CRM_Core_OptionGroup
::values('accept_creditcard', FALSE, FALSE, FALSE, NULL, 'label', TRUE, FALSE, 'name');
254 * array of all Premiums if any
256 public static function products($pageID = NULL) {
258 $dao = new CRM_Contribute_DAO_Product();
263 while ($dao->fetch()) {
264 $products[$dao->id
] = $dao->name
;
267 $dao = new CRM_Contribute_DAO_Premium();
268 $dao->entity_table
= 'civicrm_contribution_page';
269 $dao->entity_id
= $pageID;
271 $premiumID = $dao->id
;
273 $productID = array();
275 $dao = new CRM_Contribute_DAO_PremiumsProduct();
276 $dao->premiums_id
= $premiumID;
278 while ($dao->fetch()) {
279 $productID[$dao->product_id
] = $dao->product_id
;
282 $tempProduct = array();
283 foreach ($products as $key => $value) {
284 if (!array_key_exists($key, $productID)) {
285 $tempProduct[$key] = $value;
296 * Get all the contribution statuses.
300 * @param string $columnName
302 * array reference of all contribution statuses
304 public static function &contributionStatus($id = NULL, $columnName = 'label') {
305 $cacheKey = $columnName;
306 if (!isset(self
::$contributionStatus[$cacheKey])) {
307 self
::$contributionStatus[$cacheKey] = CRM_Core_OptionGroup
::values('contribution_status',
308 FALSE, FALSE, FALSE, NULL, $columnName
311 $result = self
::$contributionStatus[$cacheKey];
313 $result = CRM_Utils_Array
::value($id, $result);
320 * Get all the Personal campaign pages.
323 * @param null $pageType
327 * array reference of all pcp if any
329 public static function &pcPage($pageType = NULL, $id = NULL) {
330 if (!isset(self
::$pcPage[$pageType])) {
332 $params = "page_type='{$pageType}'";
337 CRM_Core_PseudoConstant
::populate(self
::$pcPage[$pageType],
339 FALSE, 'title', 'is_active', $params
342 $result = self
::$pcPage[$pageType];
344 return $result = CRM_Utils_Array
::value($id, $result);
351 * Get all PCP Statuses.
353 * The static array pcpStatus is returned
356 * @param string $column
358 * array reference of all PCP activity statuses
360 public static function &pcpStatus($column = 'label') {
361 if (NULL === self
::$pcpStatus) {
362 self
::$pcpStatus = array();
364 if (!array_key_exists($column, self
::$pcpStatus)) {
365 self
::$pcpStatus[$column] = array();
367 self
::$pcpStatus[$column] = CRM_Core_OptionGroup
::values('pcp_status', FALSE,
368 FALSE, FALSE, NULL, $column
371 return self
::$pcpStatus[$column];
375 * Get financial account for a Financial type.
378 * @param int $entityId
379 * @param string $accountRelationType
380 * @param string $entityTable
381 * @param string $returnField
384 public static function getRelationalFinancialAccount($entityId, $accountRelationType, $entityTable = 'civicrm_financial_type', $returnField = 'financial_account_id') {
386 'return' => array($returnField),
387 'entity_table' => $entityTable,
388 'entity_id' => $entityId,
390 if ($accountRelationType) {
391 $params['account_relationship.name'] = $accountRelationType;
393 $result = civicrm_api3('EntityFinancialAccount', 'get', $params);
394 if (!$result['count']) {
397 return $result['values'][$result['id']][$returnField];
406 * array reference of all batches if any
408 public static function &batch($id = NULL) {
410 $orderBy = " id DESC ";
411 CRM_Core_PseudoConstant
::populate(
413 'CRM_Batch_DAO_Batch',
423 $result = CRM_Utils_Array
::value($id, self
::$batch);