Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
06b69b18 | 4 | | CiviCRM version 4.5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
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 | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
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 | * @static | |
46 | */ | |
47 | private static $membershipType; | |
48 | ||
49 | /** | |
50 | * membership types | |
51 | * @var array | |
52 | * @static | |
53 | */ | |
54 | private static $membershipStatus; | |
55 | ||
56 | /** | |
57 | * Get all the membership types | |
58 | * | |
59 | * @access public | |
60 | * | |
6c8f6e67 EM |
61 | * @param null $id |
62 | * @param bool $force | |
63 | * | |
6a488035 TO |
64 | * @return array - array reference of all membership types if any |
65 | * @static | |
66 | */ | |
67 | public static function &membershipType($id = NULL, $force = FALSE) { | |
68 | if (!self::$membershipType || $force) { | |
69 | CRM_Core_PseudoConstant::populate(self::$membershipType, | |
70 | 'CRM_Member_DAO_MembershipType', | |
71 | FALSE, 'name', 'is_active', NULL, 'weight', 'id', TRUE | |
72 | ); | |
73 | } | |
74 | if ($id) { | |
75 | if (array_key_exists($id, self::$membershipType)) { | |
76 | return self::$membershipType[$id]; | |
77 | } | |
78 | else { | |
79 | $result = NULL; | |
80 | return $result; | |
81 | } | |
82 | } | |
83 | return self::$membershipType; | |
84 | } | |
85 | ||
86 | /** | |
87 | * Get all the membership statuss | |
88 | * | |
89 | * @access public | |
90 | * | |
6c8f6e67 EM |
91 | * @param null $id |
92 | * @param null $cond | |
93 | * @param string $column | |
94 | * @param bool $force | |
95 | * | |
6a488035 TO |
96 | * @return array - array reference of all membership statuss if any |
97 | * @static | |
98 | */ | |
99 | public static function &membershipStatus($id = NULL, $cond = NULL, $column = 'name', $force = FALSE) { | |
100 | if (self::$membershipStatus === NULL) { | |
101 | self::$membershipStatus = array(); | |
102 | } | |
103 | ||
104 | $cacheKey = $column; | |
105 | if ($cond) { | |
106 | $cacheKey .= "_{$cond}"; | |
107 | } | |
108 | if (!isset(self::$membershipStatus[$cacheKey]) || $force) { | |
109 | CRM_Core_PseudoConstant::populate(self::$membershipStatus[$cacheKey], | |
110 | 'CRM_Member_DAO_MembershipStatus', | |
111 | FALSE, $column, 'is_active', $cond, 'weight' | |
112 | ); | |
113 | } | |
114 | ||
115 | $value = NULL; | |
116 | if ($id) { | |
117 | $value = CRM_Utils_Array::value($id, self::$membershipStatus[$cacheKey]); | |
118 | } | |
119 | else { | |
120 | $value = self::$membershipStatus[$cacheKey]; | |
121 | } | |
122 | ||
123 | return $value; | |
124 | } | |
125 | ||
126 | /** | |
127 | * Flush given pseudoconstant so it can be reread from db | |
128 | * next time it's requested. | |
129 | * | |
130 | * @access public | |
131 | * @static | |
132 | * | |
da6b46f4 | 133 | * @param bool|string $name pseudoconstant to be flushed |
6a488035 | 134 | */ |
3fb36592 | 135 | public static function flush($name = 'cache') { |
fa56270d CW |
136 | if (isset(self::$$name)) { |
137 | self::$$name = NULL; | |
138 | } | |
6a488035 TO |
139 | } |
140 | } | |
141 |