3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
32 * @copyright CiviCRM LLC (c) 2004-2017
36 class CRM_Core_ClassLoader
{
39 * We only need one instance of this object. So we use the singleton
40 * pattern and cache the instance in this variable
43 private static $_singleton = NULL;
46 * The classes in CiviTest have ucky, non-standard naming.
49 * Array(string $className => string $filePath).
51 private $civiTestClasses;
58 public static function &singleton($force = FALSE) {
59 if ($force || self
::$_singleton === NULL) {
60 self
::$_singleton = new CRM_Core_ClassLoader();
62 return self
::$_singleton;
66 * @var bool TRUE if previously registered
68 protected $_registered;
72 protected function __construct() {
73 $this->_registered
= FALSE;
74 $this->civiTestClasses
= array(
79 'CiviSeleniumTestCase',
82 'CiviEndToEndTestCase',
94 * Requires the autoload.php generated by composer
98 protected function requireComposerAutoload() {
99 // We are trying to locate 'vendor/autoload.php'. When installing CiviCRM
100 // manually from the built tarball, that will be two directories up in the
101 // civicrm-core directory. However, if civicrm-core was installed via
102 // composer as a library, that'll be 5 directories up where composer was
103 // run (ex. the Drupal root on a Drupal 8 site).
104 $civicrm_base_path = dirname(dirname(__DIR__
));
105 $top_path = dirname(dirname(dirname(dirname(dirname(__DIR__
)))));
107 if (file_exists($civicrm_base_path . '/vendor/autoload.php')) {
108 require_once $civicrm_base_path . '/vendor/autoload.php';
110 elseif (file_exists($top_path . '/vendor/autoload.php')) {
111 require_once $top_path . '/vendor/autoload.php';
116 * Registers this instance as an autoloader.
118 * @param bool $prepend
119 * Whether to prepend the autoloader or not.
123 public function register($prepend = FALSE) {
124 if ($this->_registered
) {
127 $civicrm_base_path = dirname(dirname(__DIR__
));
129 $this->requireComposerAutoload();
131 // we do this to prevent a autoloader errors with joomla / 3rd party packages
132 // use absolute path since we dont know the content of include_path as yet
134 // TODO Remove this autoloader. For civicrm-core and civicrm-packages, the composer autoloader works fine.
135 // Extensions rely on include_path-based autoloading
136 spl_autoload_register(array($this, 'loadClass'), TRUE, $prepend);
137 $this->initHtmlPurifier($prepend);
139 $this->_registered
= TRUE;
140 $packages_path = implode(DIRECTORY_SEPARATOR
, array($civicrm_base_path, 'packages'));
141 $include_paths = array(
146 $include_paths = implode(PATH_SEPARATOR
, $include_paths);
147 set_include_path($include_paths . PATH_SEPARATOR
. get_include_path());
148 // @todo Why do we need to load this again?
149 $this->requireComposerAutoload();
153 * Initialize HTML purifier class.
155 * @param string $prepend
157 public function initHtmlPurifier($prepend) {
158 if (class_exists('HTMLPurifier_Bootstrap')) {
159 // HTMLPurifier is already initialized, e.g. by the Drupal module.
163 $htmlPurifierPath = $this->getHtmlPurifierPath();
165 if (FALSE === $htmlPurifierPath) {
166 // No HTMLPurifier available, e.g. during installation.
169 require_once $htmlPurifierPath;
170 spl_autoload_register(array('HTMLPurifier_Bootstrap', 'autoload'), TRUE, $prepend);
174 * @return string|false
175 * Path to the file where the class HTMLPurifier_Bootstrap is defined, or
176 * FALSE, if such a file does not exist.
178 private function getHtmlPurifierPath() {
179 if (function_exists('libraries_get_path')
180 && ($path = libraries_get_path('htmlpurifier'))
181 && file_exists($file = $path . '/library/HTMLPurifier/Bootstrap.php')
183 // We are in Drupal 7, and the HTMLPurifier module is installed.
184 // Use Drupal's HTMLPurifier path, to avoid conflicts.
185 // @todo Verify that we are really in Drupal 7, and not in some other
186 // environment that happens to provide a 'libraries_get_path()' function.
190 // we do this to prevent a autoloader errors with joomla / 3rd party packages
191 // Use absolute path, since we don't know the content of include_path yet.
193 $file = dirname(__FILE__
) . '/../../packages/IDS/vendors/htmlpurifier/HTMLPurifier/Bootstrap.php';
194 if (file_exists($file)) {
204 public function loadClass($class) {
206 // Only load classes that clearly belong to CiviCRM.
207 // Note: api/v3 does not use classes, but api_v3's test-suite does
208 (0 === strncmp($class, 'CRM_', 4) ||
0 === strncmp($class, 'api_v3_', 7) ||
0 === strncmp($class, 'WebTest_', 8) ||
0 === strncmp($class, 'E2E_', 4)) &&
209 // Do not load PHP 5.3 namespaced classes.
210 // (in a future version, maybe)
211 FALSE === strpos($class, '\\')
213 $file = strtr($class, '_', '/') . '.php';
214 // There is some question about the best way to do this.
215 // "require_once" is nice because it's simple and throws
216 // intelligible errors.
217 if (FALSE != stream_resolve_include_path($file)) {
221 elseif (in_array($class, $this->civiTestClasses
)) {
222 $file = "tests/phpunit/CiviTest/{$class}.php";
223 if (FALSE != stream_resolve_include_path($file)) {
227 elseif ($class === 'CiviSeleniumSettings') {
228 if (!empty($GLOBALS['_CV'])) {
229 require_once 'tests/phpunit/CiviTest/CiviSeleniumSettings.auto.php';
231 elseif (CRM_Utils_File
::isIncludable('tests/phpunit/CiviTest/CiviSeleniumSettings.php')) {
232 require_once 'tests/phpunit/CiviTest/CiviSeleniumSettings.php';