| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 5 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
| 7 | +--------------------------------------------------------------------+ |
| 8 | | This file is a part of CiviCRM. | |
| 9 | | | |
| 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. | |
| 13 | | | |
| 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. | |
| 18 | | | |
| 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 | +--------------------------------------------------------------------+ |
| 26 | */ |
| 27 | |
| 28 | /** |
| 29 | * |
| 30 | * @package CRM |
| 31 | * @copyright CiviCRM LLC (c) 2004-2019 |
| 32 | * $Id$ |
| 33 | * |
| 34 | */ |
| 35 | |
| 36 | /** |
| 37 | * This class holds all the Pseudo constants that are specific to the civimember component. This avoids |
| 38 | * polluting the core class and isolates the mass mailer class |
| 39 | */ |
| 40 | class CRM_Member_PseudoConstant extends CRM_Core_PseudoConstant { |
| 41 | |
| 42 | /** |
| 43 | * Membership types. |
| 44 | * @var array |
| 45 | */ |
| 46 | private static $membershipType; |
| 47 | |
| 48 | /** |
| 49 | * Membership types. |
| 50 | * @var array |
| 51 | */ |
| 52 | private static $membershipStatus; |
| 53 | |
| 54 | /** |
| 55 | * Get all the membership types. |
| 56 | * |
| 57 | * |
| 58 | * @param int $id |
| 59 | * @param bool $force |
| 60 | * |
| 61 | * @return array |
| 62 | * array reference of all membership types if any |
| 63 | */ |
| 64 | public static function membershipType($id = NULL, $force = TRUE) { |
| 65 | if (!self::$membershipType || $force) { |
| 66 | CRM_Core_PseudoConstant::populate(self::$membershipType, |
| 67 | 'CRM_Member_DAO_MembershipType', |
| 68 | FALSE, 'name', 'is_active', NULL, 'weight', 'id' |
| 69 | ); |
| 70 | } |
| 71 | if ($id) { |
| 72 | if (array_key_exists($id, self::$membershipType)) { |
| 73 | return self::$membershipType[$id]; |
| 74 | } |
| 75 | else { |
| 76 | $result = NULL; |
| 77 | return $result; |
| 78 | } |
| 79 | } |
| 80 | return self::$membershipType; |
| 81 | } |
| 82 | |
| 83 | /** |
| 84 | * Get all the membership statuss. |
| 85 | * |
| 86 | * |
| 87 | * @param int $id |
| 88 | * @param null $cond |
| 89 | * @param string $column |
| 90 | * @param bool $force |
| 91 | * |
| 92 | * @param bool $allStatus |
| 93 | * |
| 94 | * @return array |
| 95 | * array reference of all membership statuses if any |
| 96 | */ |
| 97 | public static function &membershipStatus($id = NULL, $cond = NULL, $column = 'name', $force = FALSE, $allStatus = FALSE) { |
| 98 | if (self::$membershipStatus === NULL) { |
| 99 | self::$membershipStatus = []; |
| 100 | } |
| 101 | |
| 102 | $cacheKey = $column; |
| 103 | if ($cond) { |
| 104 | $cacheKey .= "_{$cond}"; |
| 105 | } |
| 106 | if (!isset(self::$membershipStatus[$cacheKey]) || $force) { |
| 107 | CRM_Core_PseudoConstant::populate(self::$membershipStatus[$cacheKey], |
| 108 | 'CRM_Member_DAO_MembershipStatus', |
| 109 | $allStatus, $column, 'is_active', $cond, 'weight' |
| 110 | ); |
| 111 | } |
| 112 | |
| 113 | $value = NULL; |
| 114 | if ($id) { |
| 115 | $value = CRM_Utils_Array::value($id, self::$membershipStatus[$cacheKey]); |
| 116 | } |
| 117 | else { |
| 118 | $value = self::$membershipStatus[$cacheKey]; |
| 119 | } |
| 120 | |
| 121 | return $value; |
| 122 | } |
| 123 | |
| 124 | /** |
| 125 | * Flush given pseudoconstant so it can be reread from db |
| 126 | * next time it's requested. |
| 127 | * |
| 128 | * |
| 129 | * @param bool|string $name pseudoconstant to be flushed |
| 130 | */ |
| 131 | public static function flush($name = 'cache') { |
| 132 | if (isset(self::$$name)) { |
| 133 | self::$$name = NULL; |
| 134 | } |
| 135 | } |
| 136 | |
| 137 | } |