CRM/Utils/PseudoConstant.php

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