Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
232624b1 | 4 | | CiviCRM version 4.4 | |
6a488035 TO |
5 | +--------------------------------------------------------------------+ |
6 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
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 | * | |
57 | * @return array - array reference of all relevant constant | |
58 | */ | |
59 | public static function getConstant($constant) { | |
60 | $class = self::findConstantClass($constant); | |
61 | if ($class) { | |
62 | return $class::$constant(); | |
63 | } | |
64 | } | |
65 | ||
66 | /** | |
67 | * Flush constant | |
68 | * | |
69 | * Wrapper for Pseudoconstant methods. We use this so the calling function | |
70 | * doesn't need to know which class the Pseudoconstant is on | |
71 | * (some are on the Contribute_Pseudoconsant Class etc | |
72 | * | |
73 | * @access public | |
74 | * @static | |
75 | * | |
76 | * @return array - array reference of all relevant constant | |
77 | */ | |
78 | public static function flushConstant($constant) { | |
79 | $class = self::findConstantClass($constant); | |
80 | if ($class) { | |
81 | $class::flush(lcfirst($constant)); | |
82 | //@todo the rule is api functions should only be called from within the api - we | |
83 | // should move this function to a Core class | |
84 | $name = _civicrm_api_get_entity_name_from_camel($constant); | |
85 | CRM_Core_OptionGroup::flush($name); | |
86 | return TRUE; | |
87 | } | |
88 | } | |
89 | ||
90 | /** | |
91 | * Determine where a constant lives | |
92 | * | |
93 | * If there's a full, preloaded map, use it. Otherwise, use search | |
94 | * class space. | |
95 | * | |
96 | * @param string $name constant-name | |
97 | * @return string|NULL class-name | |
98 | */ | |
99 | public static function findConstantClass($constant) { | |
100 | if (self::$constants !== NULL && isset(self::$constants[$constant])) { | |
101 | return self::$constants[$constant]; | |
102 | } | |
103 | foreach (self::$constantClasses as $class) { | |
104 | if (method_exists($class, lcfirst($constant))) { | |
105 | return $class; | |
106 | } | |
107 | } | |
108 | return NULL; | |
109 | } | |
110 | ||
111 | /** | |
112 | * Scan for a list of pseudo-constants. A pseudo-constant is recognized by listing | |
113 | * any static properties which have corresponding static methods. | |
114 | * | |
115 | * This may be inefficient and should generally be avoided. | |
116 | * | |
117 | * @return array of string, constant names | |
118 | */ | |
119 | public static function findConstants() { | |
120 | if (self::$constants === NULL) { | |
121 | self::$constants = array(); | |
122 | foreach (self::$constantClasses as $class) { | |
123 | foreach (self::findConstantsByClass($class) as $constant) { | |
124 | self::$constants[$constant] = $class; | |
125 | } | |
126 | } | |
127 | } | |
128 | return array_keys(self::$constants); | |
129 | } | |
130 | ||
131 | /** | |
132 | * Scan for a list of pseudo-constants. A pseudo-constant is recognized by listing | |
133 | * any static properties which have corresponding static methods. | |
134 | * | |
135 | * This may be inefficient and should generally be avoided. | |
136 | * | |
137 | * @return array of string, constant names | |
138 | */ | |
139 | public static function findConstantsByClass($class) { | |
140 | $clazz = new ReflectionClass($class); | |
141 | $classConstants = array_intersect( | |
142 | CRM_Utils_Array::collect('name', $clazz->getProperties(ReflectionProperty::IS_STATIC)), | |
143 | CRM_Utils_Array::collect('name', $clazz->getMethods(ReflectionMethod::IS_STATIC)) | |
144 | ); | |
145 | return $classConstants; | |
146 | } | |
147 | ||
148 | /** | |
149 | * Flush all caches related to pseudo-constants. This may be inefficient | |
150 | * and should generally be avoided. | |
151 | * | |
152 | * @return void | |
153 | */ | |
154 | public static function flushAll() { | |
155 | foreach (self::findConstants() as $constant) { | |
156 | self::flushConstant($constant); | |
157 | } | |
4770c356 | 158 | CRM_Core_PseudoConstant::flush(); |
6a488035 TO |
159 | } |
160 | } |