3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
37 * This class holds all the Pseudo constants that are specific to Contributions. This avoids
38 * polluting the core class and isolates the mass mailer class
40 class CRM_Contribute_PseudoConstant
extends CRM_Core_PseudoConstant
{
47 private static $financialType;
54 private static $financialTypeAccount;
62 private static $financialAccount;
69 private static $contributionPageActive = NULL;
76 private static $contributionPageAll = NULL;
84 private static $paymentInstrument;
92 private static $contributionStatus;
95 * Personal campaign pages
99 private static $pcPage;
102 * Status of personal campaign page
106 private static $pcpStatus;
109 * Contribution / financial batches
113 private static $batch;
116 * DEPRECATED. Please use the buildOptions() method in the appropriate BAO object.
118 * Get all the financial types
123 * @return array - array reference of all financial types if any
126 public static function &financialType($id = NULL) {
127 if (!self
::$financialType) {
128 $condition = " is_active = 1 ";
129 CRM_Core_PseudoConstant
::populate(
130 self
::$financialType,
131 'CRM_Financial_DAO_FinancialType',
140 $result = CRM_Utils_Array
::value($id, self
::$financialType);
143 return self
::$financialType;
147 * DEPRECATED. Please use the buildOptions() method in the appropriate BAO object.
149 * Get all the financial Accounts
153 * @param int $financialAccountTypeId
154 * @param string $retrieveColumn
157 * @return array - array reference of all financial accounts if any
160 public static function &financialAccount($id = NULL, $financialAccountTypeId = NULL, $retrieveColumn = 'name', $key = 'id') {
162 if ($financialAccountTypeId) {
163 $condition = " financial_account_type_id = ". $financialAccountTypeId;
165 $cacheKey = "{$id}_{$financialAccountTypeId}_{$retrieveColumn}_{$key}";
166 if (!isset(self
::$financialAccount[$cacheKey])) {
167 CRM_Core_PseudoConstant
::populate(
168 self
::$financialAccount[$cacheKey],
169 'CRM_Financial_DAO_FinancialAccount',
180 $result = CRM_Utils_Array
::value($id, self
::$financialAccount[$cacheKey]);
183 return self
::$financialAccount[$cacheKey];
187 * Flush given pseudoconstant so it can be reread from db
188 * nex time it's requested.
192 * @param bool|string $name pseudoconstant to be flushed
194 public static function flush($name = 'cache') {
195 if (isset(self
::$
$name)) {
201 * DEPRECATED. Please use the buildOptions() method in the appropriate BAO object.
203 * Get all the contribution pages
206 * Id of the contribution page.
208 * Do we want all pages or only active pages.
211 * @return array - array reference of all contribution pages if any
214 public static function &contributionPage($id = NULL, $all = FALSE) {
216 $cacheVarToUse = &self
::$contributionPageAll;
219 $cacheVarToUse = &self
::$contributionPageActive;
222 if (!$cacheVarToUse) {
223 CRM_Core_PseudoConstant
::populate($cacheVarToUse,
224 'CRM_Contribute_DAO_ContributionPage',
229 $pageTitle = CRM_Utils_Array
::value($id, $cacheVarToUse);
232 return $cacheVarToUse;
236 * DEPRECATED. Please use the buildOptions() method in the appropriate BAO object.
238 * Get all the payment instruments
241 * @param string $columnName
243 * @return array - array reference of all payment instruments if any
246 public static function &paymentInstrument($columnName = 'label') {
247 if (!isset(self
::$paymentInstrument[$columnName])) {
248 self
::$paymentInstrument[$columnName] = CRM_Core_OptionGroup
::values('payment_instrument',
249 FALSE, FALSE, FALSE, NULL, $columnName
253 return self
::$paymentInstrument[$columnName];
257 * Get all the valid accepted credit cards
260 * @return array - array reference of all payment instruments if any
263 public static function &creditCard() {
264 return CRM_Core_OptionGroup
::values('accept_creditcard', FALSE, FALSE, FALSE, NULL, 'label', TRUE, FALSE, 'name');
272 * @return array - array of all Premiums if any
275 public static function products($pageID = NULL) {
277 $dao = new CRM_Contribute_DAO_Product();
282 while ($dao->fetch()) {
283 $products[$dao->id
] = $dao->name
;
286 $dao = new CRM_Contribute_DAO_Premium();
287 $dao->entity_table
= 'civicrm_contribution_page';
288 $dao->entity_id
= $pageID;
290 $premiumID = $dao->id
;
292 $productID = array();
294 $dao = new CRM_Contribute_DAO_PremiumsProduct();
295 $dao->premiums_id
= $premiumID;
297 while ($dao->fetch()) {
298 $productID[$dao->product_id
] = $dao->product_id
;
301 $tempProduct = array();
302 foreach ($products as $key => $value) {
303 if (!array_key_exists($key, $productID)) {
304 $tempProduct[$key] = $value;
315 * Get all the contribution statuses
319 * @param string $columnName
320 * @return array - array reference of all contribution statuses
323 public static function &contributionStatus($id = NULL, $columnName = 'label') {
324 $cacheKey = $columnName;
325 if (!isset(self
::$contributionStatus[$cacheKey])) {
326 self
::$contributionStatus[$cacheKey] = CRM_Core_OptionGroup
::values('contribution_status',
327 FALSE, FALSE, FALSE, NULL, $columnName
330 $result = self
::$contributionStatus[$cacheKey];
332 $result = CRM_Utils_Array
::value($id, $result);
339 * Get all the Personal campaign pages
342 * @param null $pageType
345 * @return array - array reference of all pcp if any
348 public static function &pcPage($pageType = NULL, $id = NULL) {
349 if (!isset(self
::$pcPage[$pageType])) {
351 $params = "page_type='{$pageType}'";
356 CRM_Core_PseudoConstant
::populate(self
::$pcPage[$pageType],
358 FALSE, 'title', 'is_active', $params
361 $result = self
::$pcPage[$pageType];
363 return $result = CRM_Utils_Array
::value($id, $result);
370 * Get all PCP Statuses.
372 * The static array pcpStatus is returned
376 * @param string $column
377 * @return array - array reference of all PCP activity statuses
379 public static function &pcpStatus($column = 'label') {
380 if (NULL === self
::$pcpStatus) {
381 self
::$pcpStatus = array();
383 if (!array_key_exists($column, self
::$pcpStatus)) {
384 self
::$pcpStatus[$column] = array();
386 self
::$pcpStatus[$column] = CRM_Core_OptionGroup
::values('pcp_status', FALSE,
387 FALSE, FALSE, NULL, $column
390 return self
::$pcpStatus[$column];
394 * Get all financial accounts for a Financial type.
396 * The static array $financialTypeAccount is returned
400 * @param int $financialTypeId
401 * @param int $relationTypeId
402 * @return array - array reference of all financial accounts for a Financial type
404 public static function financialAccountType($financialTypeId, $relationTypeId = NULL) {
405 if (!CRM_Utils_Array
::value($financialTypeId, self
::$financialTypeAccount)) {
406 $condition = " entity_id = $financialTypeId ";
407 CRM_Core_PseudoConstant
::populate(
408 self
::$financialTypeAccount[$financialTypeId],
409 'CRM_Financial_DAO_EntityFinancialAccount',
411 $retrieve = 'financial_account_id',
415 'account_relationship'
419 if ($relationTypeId) {
420 return CRM_Utils_Array
::value($relationTypeId, self
::$financialTypeAccount[$financialTypeId]);
423 return self
::$financialTypeAccount[$financialTypeId];
431 * @return array - array reference of all batches if any
434 public static function &batch($id = NULL) {
436 $orderBy = " id DESC ";
437 CRM_Core_PseudoConstant
::populate(
439 'CRM_Batch_DAO_Batch',
449 $result = CRM_Utils_Array
::value($id, self
::$batch);