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 | * Utilities for manipulating/inspecting CRM_*_PseudoConstant classes | |
30 | */ | |
31 | class CRM_Utils_PseudoConstant { | |
32 | /* | |
33 | * CiviCRM pseudoconstant classes for wrapper functions | |
34 | */ | |
35 | private static $constantClasses = array( | |
36 | 'CRM_Core_PseudoConstant', | |
37 | 'CRM_Event_PseudoConstant', | |
38 | 'CRM_Contribute_PseudoConstant', | |
39 | 'CRM_Member_PseudoConstant', | |
6a488035 TO |
40 | ); |
41 | ||
42 | /** | |
43 | * @var array ($name => $className) | |
44 | */ | |
45 | private static $constants = NULL; | |
46 | ||
47 | /** | |
48 | * Get constant | |
49 | * | |
50 | * Wrapper for Pseudoconstant methods. We use this so the calling function | |
51 | * doesn't need to know which class the Pseudoconstant is on | |
52 | * (some are on the Contribute_Pseudoconsant Class etc | |
53 | * | |
54 | * @access public | |
55 | * @static | |
56 | * | |
f4aaa82a EM |
57 | * @param $constant |
58 | * | |
6a488035 TO |
59 | * @return array - array reference of all relevant constant |
60 | */ | |
61 | public static function getConstant($constant) { | |
62 | $class = self::findConstantClass($constant); | |
63 | if ($class) { | |
64 | return $class::$constant(); | |
65 | } | |
66 | } | |
67 | ||
68 | /** | |
69 | * Flush constant | |
70 | * | |
71 | * Wrapper for Pseudoconstant methods. We use this so the calling function | |
72 | * doesn't need to know which class the Pseudoconstant is on | |
73 | * (some are on the Contribute_Pseudoconsant Class etc | |
74 | * | |
75 | * @access public | |
76 | * @static | |
77 | * | |
f4aaa82a EM |
78 | * @param $constant |
79 | * | |
6a488035 TO |
80 | * @return array - array reference of all relevant constant |
81 | */ | |
82 | public static function flushConstant($constant) { | |
83 | $class = self::findConstantClass($constant); | |
84 | if ($class) { | |
85 | $class::flush(lcfirst($constant)); | |
86 | //@todo the rule is api functions should only be called from within the api - we | |
87 | // should move this function to a Core class | |
88 | $name = _civicrm_api_get_entity_name_from_camel($constant); | |
89 | CRM_Core_OptionGroup::flush($name); | |
90 | return TRUE; | |
91 | } | |
92 | } | |
93 | ||
94 | /** | |
95 | * Determine where a constant lives | |
96 | * | |
97 | * If there's a full, preloaded map, use it. Otherwise, use search | |
98 | * class space. | |
99 | * | |
f4aaa82a EM |
100 | * @param $constant |
101 | * | |
102 | * @internal param string $name constant-name | |
6a488035 TO |
103 | * @return string|NULL class-name |
104 | */ | |
105 | public static function findConstantClass($constant) { | |
106 | if (self::$constants !== NULL && isset(self::$constants[$constant])) { | |
107 | return self::$constants[$constant]; | |
108 | } | |
109 | foreach (self::$constantClasses as $class) { | |
110 | if (method_exists($class, lcfirst($constant))) { | |
111 | return $class; | |
112 | } | |
113 | } | |
114 | return NULL; | |
115 | } | |
116 | ||
117 | /** | |
118 | * Scan for a list of pseudo-constants. A pseudo-constant is recognized by listing | |
119 | * any static properties which have corresponding static methods. | |
120 | * | |
121 | * This may be inefficient and should generally be avoided. | |
122 | * | |
123 | * @return array of string, constant names | |
124 | */ | |
125 | public static function findConstants() { | |
126 | if (self::$constants === NULL) { | |
127 | self::$constants = array(); | |
128 | foreach (self::$constantClasses as $class) { | |
129 | foreach (self::findConstantsByClass($class) as $constant) { | |
130 | self::$constants[$constant] = $class; | |
131 | } | |
132 | } | |
133 | } | |
134 | return array_keys(self::$constants); | |
135 | } | |
136 | ||
137 | /** | |
138 | * Scan for a list of pseudo-constants. A pseudo-constant is recognized by listing | |
139 | * any static properties which have corresponding static methods. | |
140 | * | |
141 | * This may be inefficient and should generally be avoided. | |
142 | * | |
f4aaa82a EM |
143 | * @param $class |
144 | * | |
6a488035 TO |
145 | * @return array of string, constant names |
146 | */ | |
147 | public static function findConstantsByClass($class) { | |
148 | $clazz = new ReflectionClass($class); | |
149 | $classConstants = array_intersect( | |
150 | CRM_Utils_Array::collect('name', $clazz->getProperties(ReflectionProperty::IS_STATIC)), | |
151 | CRM_Utils_Array::collect('name', $clazz->getMethods(ReflectionMethod::IS_STATIC)) | |
152 | ); | |
153 | return $classConstants; | |
154 | } | |
155 | ||
156 | /** | |
157 | * Flush all caches related to pseudo-constants. This may be inefficient | |
158 | * and should generally be avoided. | |
159 | * | |
160 | * @return void | |
161 | */ | |
162 | public static function flushAll() { | |
163 | foreach (self::findConstants() as $constant) { | |
164 | self::flushConstant($constant); | |
165 | } | |
4770c356 | 166 | CRM_Core_PseudoConstant::flush(); |
6a488035 TO |
167 | } |
168 | } |