From: Tim Otten <totten@civicrm.org>
Date: Wed, 19 Aug 2015 06:14:27 +0000 (-0700)
Subject: \Civi - Add facade accessing system services
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=711aa5d7445d830543249aae16f338d7f4004a94;p=civicrm-core.git

\Civi - Add facade accessing system services
---

diff --git a/Civi.php b/Civi.php
new file mode 100644
index 0000000000..0d899a65f4
--- /dev/null
+++ b/Civi.php
@@ -0,0 +1,57 @@
+<?php
+
+/**
+ * Class Civi
+ *
+ * The "Civi" class provides a facade for accessing major subsystems,
+ * such as the service-container and settings manager. It serves as a
+ * bridge which allows procedural code to access important objects.
+ *
+ * General principles:
+ *  - Each function provides access to a major subsystem.
+ *  - Each function performs a simple lookup.
+ *  - Each function returns an interface.
+ *  - Whenever possible, interfaces should be well-known (e.g. based
+ *    on a standard or well-regarded provider).
+ */
+class Civi {
+
+  /**
+   * A central location for static variable storage.
+   *
+   * @code
+   * `Civi::$statics[__CLASS__]['foo'] = 'bar';
+   * @endcode
+   */
+  public static $statics = array();
+
+  /**
+   * Get the service container.
+   *
+   * @return \Symfony\Component\DependencyInjection\ContainerInterface
+   */
+  public static function container() {
+    return Civi\Core\Container::singleton();
+  }
+
+  /**
+   * Fetch a service from the container.
+   *
+   * @param string $id
+   *   The service ID.
+   * @return mixed
+   */
+  public static function service($id) {
+    return \Civi\Core\Container::singleton()->get($id);
+  }
+
+  /**
+   * Reset all ephemeral system state, e.g. statics,
+   * singletons, containers.
+   */
+  public static function reset() {
+    Civi\Core\Container::singleton(TRUE);
+    self::$statics = array();
+  }
+
+}
diff --git a/composer.json b/composer.json
index 2866db1b7d..39232d7fad 100644
--- a/composer.json
+++ b/composer.json
@@ -2,6 +2,7 @@
   "autoload": {
     "psr-0": {
       "PHPUnit_": ["packages/"],
+      "Civi": "",
       "Civi\\": [".", "tests/phpunit/"]
     }
   },