CRM/Utils/PseudoConstant.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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',
  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    * @param $constant
  58    *
  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    *
  78    * @param $constant
  79    *
  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    *
 100    * @param string $constant constant-name
 101    *
 102    * @return string|NULL class-name
 103    */
 104   public static function findConstantClass($constant) {
 105     if (self::$constants !== NULL && isset(self::$constants[$constant])) {
 106       return self::$constants[$constant];
 107     }
 108     foreach (self::$constantClasses as $class) {
 109       if (method_exists($class, lcfirst($constant))) {
 110         return $class;
 111       }
 112     }
 113     return NULL;
 114   }
 115
 116   /**
 117    * Scan for a list of pseudo-constants. A pseudo-constant is recognized by listing
 118    * any static properties which have corresponding static methods.
 119    *
 120    * This may be inefficient and should generally be avoided.
 121    *
 122    * @return array of string, constant names
 123    */
 124   public static function findConstants() {
 125     if (self::$constants === NULL) {
 126       self::$constants = array();
 127       foreach (self::$constantClasses as $class) {
 128         foreach (self::findConstantsByClass($class) as $constant) {
 129           self::$constants[$constant] = $class;
 130         }
 131       }
 132     }
 133     return array_keys(self::$constants);
 134   }
 135
 136   /**
 137    * Scan for a list of pseudo-constants. A pseudo-constant is recognized by listing
 138    * any static properties which have corresponding static methods.
 139    *
 140    * This may be inefficient and should generally be avoided.
 141    *
 142    * @param $class
 143    *
 144    * @return array of string, constant names
 145    */
 146   public static function findConstantsByClass($class) {
 147     $clazz = new ReflectionClass($class);
 148     $classConstants = array_intersect(
 149       CRM_Utils_Array::collect('name', $clazz->getProperties(ReflectionProperty::IS_STATIC)),
 150       CRM_Utils_Array::collect('name', $clazz->getMethods(ReflectionMethod::IS_STATIC))
 151     );
 152     return $classConstants;
 153   }
 154
 155   /**
 156    * Flush all caches related to pseudo-constants. This may be inefficient
 157    * and should generally be avoided.
 158    *
 159    * @return void
 160    */
 161   public static function flushAll() {
 162     foreach (self::findConstants() as $constant) {
 163       self::flushConstant($constant);
 164     }
 165     CRM_Core_PseudoConstant::flush();
 166   }
 167 }