Civi.php

   1 <?php
   2
   3 /**
   4  * Class Civi
   5  *
   6  * The "Civi" class provides a facade for accessing major subsystems,
   7  * such as the service-container and settings manager. It serves as a
   8  * bridge which allows procedural code to access important objects.
   9  *
  10  * General principles:
  11  *  - Each function provides access to a major subsystem.
  12  *  - Each function performs a simple lookup.
  13  *  - Each function returns an interface.
  14  *  - Whenever possible, interfaces should be well-known (e.g. based
  15  *    on a standard or well-regarded provider).
  16  */
  17 class Civi {
  18
  19   /**
  20    * A central location for static variable storage.
  21    *
  22    * @code
  23    * `Civi::$statics[__CLASS__]['foo'] = 'bar';
  24    * @endcode
  25    */
  26   public static $statics = array();
  27
  28   /**
  29    * EXPERIMENTAL. Retrieve a named cache instance.
  30    *
  31    * This interface is flagged as experimental due to political
  32    * ambiguity in PHP community -- PHP-FIG has an open but
  33    * somewhat controversial draft standard for caching. Based on
  34    * the current draft, it's expected that this function could
  35    * simultaneously support both CRM_Utils_Cache_Interface and
  36    * PSR-6, but that depends on whether PSR-6 changes any more.
  37    *
  38    * @param string $name
  39    *   The name of the cache. The 'default' cache is biased toward
  40    *   high-performance caches (eg memcache/redis/apc) when
  41    *   available and falls back to single-request (static) caching.
  42    * @return CRM_Utils_Cache_Interface
  43    */
  44   public static function cache($name = 'default') {
  45     return \Civi\Core\Container::singleton()->get('cache.' . $name);
  46   }
  47
  48   /**
  49    * Get the service container.
  50    *
  51    * @return \Symfony\Component\DependencyInjection\ContainerInterface
  52    */
  53   public static function container() {
  54     return Civi\Core\Container::singleton();
  55   }
  56
  57   /**
  58    * Fetch a service from the container.
  59    *
  60    * @param string $id
  61    *   The service ID.
  62    * @return mixed
  63    */
  64   public static function service($id) {
  65     return \Civi\Core\Container::singleton()->get($id);
  66   }
  67
  68   /**
  69    * Reset all ephemeral system state, e.g. statics,
  70    * singletons, containers.
  71    */
  72   public static function reset() {
  73     Civi\Core\Container::singleton(TRUE);
  74     self::$statics = array();
  75   }
  76
  77 }